Les tests dans une application Symfony

Transcript

Les tests dans une
application Symfony
Alexandre Salomé

Notre cas pratique
Name:
Email:
Alice
[email protected]
Register
Register

Notre cas pratique
Hello Alice,
Thank you for registering! To conﬁrm your
registration, please click on the link below:
Happy conferences,
The speaker
Click here to activate your account
From: The App
Subject: Finish your registration

View Slide

Application
Exemple
Request Response

View Slide

Application
Service
Exemple
User
Repository
Request Response
User

View Slide

Application
Service
Exemple
User
Repository
Service
Mailer
Request Response
User

View Slide

Application
Service
Exemple
User
Repository
Service
Mailer
Service
User
Manager
Request Response
User

View Slide

Les différents types de tests
3 types de test déﬁnis par Symfony :
1. Les test unitaires
2. Les tests d’intégration
3. Les tests applicatifs
Tests
applicatifs
Tests
d’intégration
Tests
unitaires

View Slide

Les tests
unitaires

View Slide

Un test unitaire garantit le fonctionnement d’une unité logicielle
(une classe, une méthode).

View Slide

Application
Service
Les tests unitaires
User
Repository
Service
Mailer
Service
User
Manager
Request Response
User

View Slide

Les tests unitaires
use PHPUnit\Framework\TestCase;
class UserTest extends TestCase
{
public function testActivate(): void
{
$user = new User();
$this→assertFalse($user→isActivated());
$user→activate();
$this→assertTrue($user→isActivated());
}
}

View Slide

Les tests unitaires
{
{
$user = new User();
$user→activate();
}
}

View Slide

Les tests unitaires
{
{
$user = new User();
$user→activate();
}
}

View Slide

Les tests unitaires
{
{
$user = new User();
$user→activate();
}
}

View Slide

Les tests unitaires
{
public function testActivateTwice(): void
public function testActivateWhenLocked(): void
}

View Slide

Les tests unitaires
Avantages
- Rapides à exécuter
- Simples et fondamental
Inconvénients
- Bouchons pour les dépendances
17

View Slide

Les tests
d’intégration

View Slide

Les tests d’intégration testent le bon fonctionnement
d’une combinaison de services.

View Slide

Application
Service
Les tests d’intégration
User
Repository
Service
Mailer
Service
User
Manager
Request Response
User

View Slide

Application
Service
User
Repository
Service
Mailer
Service
User
Manager
Request Response
User

View Slide

use App\Entity\User;
use App\Manager\UserManager;
use App\Test\UserActionsTrait ;
use Symfony\Bundle\FrameworkBundle \Test\KernelTestCase ;
class RegistrationManagerTest extends KernelTestCase
{
use UserActionsTrait ; // Helper methods used below
public function testRegisterExistingUser (): void
{
$this->createUser('alice');
$user = new User();
$user->setEmail('[email protected] ');
$user->setName('Alice');
$manager = self::getContainer()->get(UserManager::class);
$manager->register($user);
$this->assertAlreadyRegisteredMailSent ();
}
}

View Slide

{
{
$user = new User();
}
}

View Slide

{
{
$user = new User();
}
}

View Slide

{
{
$user = new User();
}
}

View Slide

{
{
$user = new User();
}
}

View Slide

{
{
$user = new User();
}
}

View Slide

{
{
$user = new User();
}
}

View Slide

Avantages
- Permet de tester n’importe quel service
- Conditions réelles du service
Inconvénients
- Couplage du service non visible
29

View Slide

Les tests
applicatifs

View Slide

Les tests applicatifs testent le bon fonctionnement
des différentes couches de l’application
combinées ensemble.

View Slide

Application
Service
Les tests applicatifs
User
Repository
Service
Mailer
Service
User
Manager
Request Response
User

View Slide

use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
class RegisterControllerTest extends WebTestCase
{
public function testValid(): void
{
$client = self::createClient();
$crawler = $client→request('GET', '/register');
$form = $crawler→ﬁlter('main form')→form([
'register[name]' => 'Test User',
'register[email]' => '[email protected]',
]);
$client→submit($form);
$this→assertResponseStatusCodeSame(302);
$this→assertResponseRedirects('/register/conﬁrmation');
}
}

{
{
]);
}
}

{
{
]);
}
}

{
{
]);
}
}

WebTestCase - BrowserKitAssertionsTrait

View Slide

PHPUnit 9.5.28 by Sebastian Bergmann and contributors.
Testing App\Tests\Manager\User\RegistrationManagerTest
F 1 / 1 (100%)
Time: 00:00.413, Memory: 32.00 MB
There was 1 failure:
1) App\Tests\Manager\User\RegistrationManagerTest::testRegister
Failed asserting that Symfony\Component\HttpFoundation\RedirectResponse
Object ... (
# ...
'targetUrl' => '/register/actual'
) is redirected and has header "Location" with value "/register/expected".

View Slide

WebTestCase - DomCrawlerAssertionsTrait

View Slide

PHPUnit 9.5.28 by Sebastian Bergmann and contributors.
Testing App\Tests\Manager\User\RegistrationManagerTest
F 1 / 1 (100%)
Time: 00:00.413, Memory: 32.00 MB
There was 1 failure:
1) App\Tests\Manager\User\RegistrationManagerTest::testRegister
Failed asserting that Symfony\Component\DomCrawler\Crawler Object ... (
) matches selector "h1" and the text "register.title" of the node matching
selector "body" contains "Register".

View Slide

Les tests applicatifs
Avantages
- Tests de l’extérieur de l’application
- Utilitaires de WebTestCase
Inconvénients
- Tests gourmands en ressources
41

View Slide

Les outils de Symfony

View Slide

Installer PHPUnit
Utilisez le pack de test de Symfony :
composer require --dev symfony/test-pack
Cela installe PHPUnit ainsi que les outils que nous allons voir.

View Slide

Tester l’envoi
d’emails

View Slide

Tester l’envoi d’emails
public function testRegister(): void
{
// Fill and submit the form
$crawler = $this→client→request('GET', '/register');
$form = $crawler→ﬁlter('form')→form([
'register[name]' => 'Alice',
]);
$this→client→submit($form);
$this→assertResponseIsSuccessful();
}

View Slide

Hello Alice,
Happy conferences,
The speaker
From: The App

View Slide

// Verify that the registration mail has been sent
$this→assertQueuedEmailCount(1);
// Get the email
$email = $this→getMailerMessage();
// Assertions on the mail
$this→assertEmailHeaderSame(
$email,
'Subject',
'Finish your registration'
);
$this→assertEmailHtmlBodyContains(
$email,
'Click here to activate your account'
);

View Slide

// Get the email
$email,
'Subject',
);
$email,
);

View Slide

// Get the email
$email,
'Subject',
);
$email,
);

View Slide

// Get the email
$email,
'Subject',
);
$email,
);

View Slide

// Get the email
$email,
'Subject',
);
$email,
);

View Slide

Tester l’envoi d’emails - MailerAssertionsTrait

View Slide

Hello Alice,
Happy conferences,
The speaker
From: The App

View Slide

{
// ...
// Extract the link
$link = (new Crawler($email->getHtmlBody()))
->filter('a:contains("Click here to activate your account")' )
;
$href = $link->attr('href');
// Browse the link
$response = $this->client->request('GET', $href);
$this->assertResponseIsSuccessful ();
}

View Slide

{
// ...
// Extract the link
;
// Browse the link
}

View Slide

{
// ...
// Extract the link
;
// Browse the link
}

View Slide

{
// ...
// Extract the link
;
// Browse the link
}

View Slide

{
// ...
// Extract the link
;
// Browse the link
}

View Slide

Tests Messenger

View Slide

Tests Messenger
Supposons que notre UserManager a la méthode suivante :
public function register(User $user): void
{
$this→repository→save($user);
$this→sendRegistrationMail($user);
$this→messageBus→dispatch(
new RegistrationMessage($user→getId()),
);
}

View Slide

Tests Messenger
Supposons que notre UserManager a la méthode suivante :
public function register(User $user): void
{
$this→repository→save($user);
$this→sendRegistrationMail($user);
$this→messageBus→dispatch(
new RegistrationMessage($user→getId()),
);
}

View Slide

Tests Messenger
# app/conﬁg/messenger.yaml
framework:
messenger:
transports:
async: '%env(MESSENGER_TRANSPORT_DSN)%'
[email protected]:
framework:
messenger:
transports:
async: 'in-memory://'

View Slide

Tests Messenger
On peut vériﬁer l’envoi d’un événement via le transport “in-memory”:
$transport = self::getContainer()->get('messenger.transport.async' );
$this->assertCount(1, $transport->getSent());
$message = $transport->getSent()[0]->getMessage();
$this->assertInstanceOf (RegistrationMessage ::class, $message);

Tests Messenger

Tests Messenger

Tests Messenger

Clock mocking

Clock mocking
Supposons qu’on veuille faire le test suivant:
public function testIsActivationKeyValid (): void
{
$user = new User();
$key = $user->getActivationKey ();
$this->assertTrue($user->isActivationKeyValid ($key));
sleep(2 * 24 * 60 * 60); // 2 days
$this->assertFalse($user->isActivationKeyValid ($key));
}

View Slide

Clock mocking
{
$user = new User();
sleep(2 * 24 * 60 * 60); // 2 days
}

View Slide

Clock mocking
{
$user = new User();
sleep(2 * 24 * 60 * 60); // 2 days
}

View Slide

Clock mocking
{
$user = new User();
sleep(2 * 24 * 60 * 60); // 2 days
}

View Slide

Clock mocking
{
$user = new User();
sleep(2 * 24 * 60 * 60); // 2 days
}

View Slide

Clock mocking
Grâce au test-pack de Symfony, nous n’avons qu’à mettre une annotation:
/**
* @group time-sensitive
*/
{
$user = new User();
sleep(2 * 24 * 60 * 60); // 2 days
}

View Slide

Cette annotation va déclarer des bouchons pour time(), sleep(), usleep()
et date() dans les namespaces de la classe testée :
- App\Entity\
- App\Tests\Entity\
Ainsi les appels de fonction dans User & UserTest utiliseront les déclarations de ce
namespace.
Clock mocking

View Slide

Clock mocking
Mais…
Il faut utiliser les fonctions : time(), sleep(), usleep() et date()
Par exemple, pour DateTime et DateTimeImmutable:
\DateTimeImmutable ::createFromFormat('U', time());
\DateTimeImmutable ::createFromFormat('U', time())
->add(new \DateInterval('P2D'))
;

View Slide

Test unitaire de
formulaire

View Slide

Bonjour SetPasswordType
Un FormType de Symfony qui s’occupe du changement de mot de passe :
$form = $this->createForm(SetPasswordType ::class, $user);
$form->handleRequest($request);
if ($form->isSubmitted() && $form->isValid()) {
$userManager->saveUser($user);
}

View Slide

Bonjour SetPasswordType
Un FormType de Symfony qui s’occupe du changement de mot de passe:
->addEventListener (FormEvents::POST_SUBMIT, function (PostSubmitEvent $e) {
if (!$e->getForm()->isValid()) {
Return;
}
$user = $e->getData();
$password = $e->getForm()->get('password')->getData();
$hashed = $this->userPasswordHasher ->hashPassword($user, $password);
$user->setPassword($hashed);
})

View Slide

use Symfony\Component\Form\Test\TypeTestCase;
class SetPasswordTypeTest extends TypeTestCase
{
{
$user = new User();
$user→setPassword('foo');
$form = $this→factory→create(SetPasswordType::class, $user);
$form→submit(['password' => [
'ﬁrst' => 'bar',
'second' => 'bar',
]]);
$this→assertEquals('fooHashed', $user→getPassword());
}

View Slide

{
{
$user = new User();
$user→setPassword('fooHashed');
'ﬁrst' => 'bar',
'second' => 'bar',
]]);
$this→assertEquals('barHashed', $user→getPassword());
}

View Slide

{
{
$user = new User();
'ﬁrst' => 'bar',
'second' => 'bar',
]]);
}

View Slide

{
{
$user = new User();
'ﬁrst' => 'bar',
'second' => 'bar',
]]);
}

View Slide

{
{
$user = new User();
'ﬁrst' => 'bar',
'second' => 'bar',
]]);
}

View Slide

{
private UserPasswordHasherInterface|MockObject $passwordHasher;
protected function getExtensions(): array
{
$this→passwordHasher =
$this→createMock(UserPasswordHasherInterface::class)
;
$type = new SetPasswordType($this→passwordHasher);
return [
new PreloadedExtension([
$type
], []),
];
}

View Slide

{
{
;
return [
$type
], []),
];
}

View Slide

{
{
;
return [
$type
], []),
];
}

View Slide

{
{
;
return [
$type
], []),
];
}

View Slide

On ajoute ﬁnalement les attentes sur le bouchon dans le test :
{
$user = new User();
$this→passwordHasher
→expects($this→once())
→method('hashPassword')
→with($user, 'bar')
→willReturn('barHashed')
;
# ...
Test unitaire de formulaire

View Slide

$user = new User();
;
'ﬁrst' => 'bar',
'second' => 'bar',
]]);
$this→assertTrue($form→isSynchronized());

View Slide

$user = new User();
;
'ﬁrst' => 'bar',
'second' => 'bar',
]]);

View Slide

$user = new User();
;
'ﬁrst' => 'bar',
'second' => 'bar',
]]);

View Slide

$user = new User();
;
'ﬁrst' => 'bar',
'second' => 'bar',
]]);

View Slide

$user = new User();
;
'ﬁrst' => 'bar',
'second' => 'bar',
]]);

View Slide

Tester les
commandes

View Slide

Bonjour UserActivateCommand
On imagine une commande bin/console user:activate [email protected]
- [ERROR] No user found with email
"[email protected]".
- [INFO] The user with email "[email protected]" is
already activated.
- [OK] The user with email "[email protected]" has
been activated.

View Slide

class ActivateCommandTest extends KernelTestCase
{
public function testAlreadyActivated(): void
{
// Prepare the data
$this→user→activate();
$this→manager→saveUser($this→user);
$app = new Application(self::bootKernel());
$command = $app→ﬁnd('user:activate');
$tester = new CommandTester($command);
$tester→execute(['email' => '[email protected]']);
$tester→assertCommandIsSuccessful();
$this→assertStringContainsString(
'already activated',
$tester→getDisplay(),
);
}

View Slide

{
{
// Prepare the data
);
}

View Slide

{
{
// Prepare the data
);
}

View Slide

{
{
// Prepare the data
);
}

View Slide

{
{
// Prepare the data
);
}

View Slide

{
{
// Prepare the data
);
}

View Slide

CommandTester

View Slide

Testing Stimulus

View Slide

Symfony UX Stimulus testing est considéré actuellement comme expérimental.
Symfony UX Stimulus testing

View Slide

import { Application } from '@hotwired/stimulus';
import { clearDOM, mountDOM } from '@symfony/stimulus-testing';
import HelloController from '../controllers/hello_controller.js';
const startStimulus = () => {
const application = Application.start();
application.register('hello', HelloController);
};
describe('HelloController', () => {
let container;
beforeEach(() => {
startStimulus();
container = mountDOM('');
});
afterEach(() => {
clearDOM();
});
// Test here
});

View Slide

import { Application } from '@hotwired/stimulus';
import { clearDOM, mountDOM } from '@symfony/stimulus-testing';
import HelloController from '../controllers/hello_controller.js';
const startStimulus = () => {
const application = Application.start();
application.register('hello', HelloController);
};
let container;
beforeEach(() => {
startStimulus();
container = mountDOM('');
});
afterEach(() => {
clearDOM();
});
// Test here
});

View Slide

// ...
it('connect', async () => {
expect(container.textContent).toContain("Hello world");
});
});

View Slide

Le client HTTP

View Slide

Un CRM vers lequel nous synchronisons les utilisateurs par un appel HTTP.
class SalesPower
{
public function __construct(
private readonly HttpClientInterface $client,
) { }
public function createUser(User $user): void
{
$this→client→request('PUT', '/users', ...);
}
}
Bonjour SalesPower

View Slide

use Symfony\Component\HttpClient\MockHttpClient;
$mock = new MockHttpClient(new MockResponse('OK'));
$crm = new SalesPower($mock);
$crm→createUser($alice);
Méthode simple

View Slide

$count = 0;
$mock = new MockHttpClient(
function (string $method, string $path) use (&$count) {
$this→assertSame(0, $count++);
$this→assertSame('PUT', $method);
$this→assertSame('/users', $path);
return new MockResponse('OK');
}
);
$this→assertSame(1, $count, 'Effective call to the HTTP client');
Méthode avancée

View Slide

$count = 0;
}
);
Méthode avancée

View Slide

$count = 0;
}
);
Méthode avancée

View Slide

Aller plus loin

View Slide

Bouchonner les
services

View Slide

$repository = $this→getMockBuilder(UserRepository::class)
→disableOriginalConstructor()
→getMock()
;
$repository
→method('ﬁndOneBy')
→with(['email' => '[email protected]'])
→willReturn($alice)
;
self::getContainer()→set(UserRepository::class, $repository);
$manager = self::getContainer()→get(UserManager::class);
$manager→recoverPassword('[email protected]');

View Slide

→getMock()
;
$repository
;

View Slide

→getMock()
;
$repository
;

View Slide

→getMock()
;
$repository
;

View Slide

Proﬁler
collectors

View Slide

Profiler collectors
La magie des tests est rendue possible grâce aux collectors:
$this→client→enableProfiler();
$this→client→request('GET', '/');
$collectors = $this→client→getProfile()→getCollectors();

View Slide

- Request
- Time
- Memory
- Validator
- Ajax
- Form
- Exception
- Logger
- Events
Les collectors disponibles
- Router
- Cache
- Security
- Twig
- Http Client
- Database
- Messenger
- Mailer
- Conﬁg

View Slide

On vériﬁe qu’aucune requête HTTP n’a été générée:
$collectors = $client→getProﬁle()→getCollectors();
/** @var HttpClientDataCollector $httpClientCollector */
$httpClientCollector = $collectors['http_client'];
$this→assertEquals(0, $httpClientCollector→getRequestCount());
Exemple avec “http_client”

View Slide

Données de test
aka “ﬁxtures”

View Slide

Fixtures
- Utile pour le développement

View Slide

Fixtures
- Risqué pour les tests automatisés (modiﬁcation des données)

View Slide

Fixtures
- Risqué pour les tests automatisés (modiﬁcation des données)
- Préférez les tests auto-suffisants en données

View Slide

Test auto-suffisant supprimant des données
public function setUp(): void
{
$this→client = static::createClient();
$userManager = self::getContainer()→get(UserManager::class);
try {
$user = $userManager→ﬁndOneByEmail('[email protected]');
$userManager→deleteUser($user);
} catch (\InvalidArgumentException) {
// Ignore
}
}

View Slide

Dépendances
externes

View Slide

Abstraire les services externes
Exemple industrialisé : Symfony Mailer

View Slide

Abstraire les services externes
Exemple industrialisé : Symfony Mailer
Exemple minimaliste: une API tierce de CRM :
- PUT /user quand un utilisateur est créé
- DELETE /user/ quand un utilisateur est supprimé

View Slide

namespace App\Crm;
interface CrmInterface
{
/** @throws ApiException */
public function createUser(User $user): void;
/** @throws ApiException */
public function deleteUser(string $id): void;
}
Créez le contrat d’interface

View Slide

namespace App\Crm;
class SalesPower implements CrmInterface
{
) {
}
{
# PUT /user
}
public function deleteUser(string $id): void
{
# DELETE /user/
}
}

View Slide

namespace App\Crm;
{
) {
}
{
# PUT /user
}
{
# DELETE /user/
}
}

View Slide

namespace App\Crm;
{
) {
}
{
# PUT /user
}
{
# DELETE /user/
}
}

View Slide

namespace App\Crm;
{
) {
}
{
# PUT /user
}
{
# DELETE /user/
}
}

View Slide

Test unitaire de cette classe:
- Cette implémentation utilise le client HTTP de Symfony
- Le client HTTP de Symfony peut être bouchonné
SalesPowerTest

View Slide

namespace App\Crm;
class InMemoryCrm implements CrmInterface
{
public array $createdUsers = [];
public array $deletedUserIds = [];
{
$this→createdUsers[] = $user;
}
{
$this→deletedUserIds[] = $id;
}
}

View Slide

namespace App\Crm;
class InMemoryCrm implements CrmInterface
{
public array $createdUsers = [];
public array $deletedUserIds = [];
{
$this→createdUsers[] = $user;
}
{
$this→deletedUserIds[] = $id;
}
}

View Slide

# conﬁg/services.yaml
services:
App\Crm\CrmInterface:
alias: App\Crm\SalesPower
[email protected]:
Services:
alias: App\Crm\InMemoryCrm

View Slide

# conﬁg/services.yaml
services:
alias: App\Crm\SalesPower
[email protected]:
Services:
alias: App\Crm\InMemoryCrm

View Slide

class RegisterTest extends WebTestCase
{
{
/** @var InMemoryCrm $crm */
$crm = self::getContainer()→get(CrmInterface::class);
# ...
$this→assertCount(1, $crm→createdUsers);
}
}

View Slide

class RegisterTest extends WebTestCase
{
{
/** @var InMemoryCrm $crm */
$crm = self::getContainer()→get(CrmInterface::class);
# ...
$this→assertCount(1, $crm→createdUsers);
}
}

View Slide

Ecosystème

View Slide

Playwright
Exécute les tests dans un navigateur.

View Slide

Blackﬁre
Permet de réaliser des tests de performance
sur votre application Symfony du développement à la production.

Les tests dans une application Symfony

Les tests dans une application Symfony

Alexandre Salomé

More Decks by Alexandre Salomé

Other Decks in Programming

Featured

Transcript