Adoptez le TDD sur vos projets Symfony2 existants

ADOPTEZ LE TDD SUR
VOS PROJETS
SYMFONY2 EXISTANTS

View Slide

Créer, refactoriser, corriger du code…

View Slide

Telle est la mission des développeurs

View Slide

On a tous peur d’introduire des bugs

View Slide

Si seulement il y avait eu de bons tests !

View Slide

Adoptez le TDD

View Slide

Benjamin Grandfond
Technical team manager
 benja-M-1  benjaM1
7

View Slide

LE TDD
8
Test-driven Development

View Slide

"Clean code that works"
Ron Je!ries
un des trois fondateurs de l’ «Extreme Programming» (XP)
9

View Slide

RED
REFACTOR
1. écrire un test
simple qui échoue
3. éliminer la duplication
GREEN
2. écrire le minimum de
code pour faire
passer le test
Mantra
10

View Slide

11
+ moins de debug
+ code découplé
+ plus de con!ance
- prend du temps (au début)
- plus de code (?)
Avantages
Inconvénients

View Slide

12
• patience, courage, persévérance
• intégration continue
• exécution des tests rapide
• qualité des tests (lisibilité, conventions...)
Pré requis pour le succès

View Slide

Suite de Fibonacci
class FibonacciTest extends \PHPUnit_Framework_TestCase
{
public function testFibonacci()
{
$fibonacci = new Fibonacci();
$this->assertEquals(0, $fibonacci->fib(0));
}
}
RED
13

View Slide

class Fibonacci
{
public function fib($value)
{
return 0;
}
}
Fake it!
Suite de Fibonacci
GREEN
14

View Slide

{
{
}
}
Suite de Fibonacci
RED
15
{
{
}
}
duplication

View Slide

class Fibonacci
{
{
if ($value === 0) {
return 0;
}
return 1;
}
}
Suite de Fibonacci
GREEN
16

View Slide

{
/**
* @dataProvider getValues
*/
public function testFibonacci($value, $result)
{
$this->assertEquals($result, $fibonacci->fib($value));
}
public function getValues()
{
return array(
array(0, 0),
array(1, 1),
);
}
}
Suite de Fibonacci
REFACTOR
17

View Slide

{
return array(
array(0, 0),
array(1, 1),
array(2, 1),
);
}
Suite de Fibonacci
GREEN
18

View Slide

{
return array(
array(0, 0),
array(1, 1),
array(2, 1),
array(3, 2),
);
}
RED
Triangulation
Suite de Fibonacci
19

View Slide

class Fibonacci
{
{
if ($value === 0) {
return 0;
}
if ($value <= 2) {
return 1;
}
return 2;
}
}
GREEN Suite de Fibonacci
20

View Slide

class Fibonacci
{
{
if ($value === 0) {
return 0;
}
if ($value <= 2) {
return 1;
}
return 1 + 1;
}
}
Suite de Fibonacci
REFACTOR
21

View Slide

class Fibonacci
{
{
if ($value === 0) {
return 0;
}
if ($value <= 2) {
return 1;
}
return $this->fib($value - 1) + $this->fib($value - 2);
}
}
REFACTOR Suite de Fibonacci
22

View Slide

METTRE EN PLACE LE
TDD DANS VOS
PROJETS SYMFONY2
23

View Slide

Créer une nouvelle page
24

View Slide

• récupérer les experts dans la base de données
• créer un template qui a!che la liste
• créer un contrôleur
• ajouter une nouvelle route
Ce qu’on veut :
25

View Slide

1. code retour de la page = 200
2. la réponse contient une liste
3. le nombre de li = le nombre d’experts dans la base
Ce qu’on va tester :
test list
26

View Slide

RED
27
namespace Theodo\Bundle\ExpertBundle\Tests\Controller;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
/**
* ExpertControllerTest
*
* @author Benjamin Grandfond
* @group functional
*/
class ExpertControllerTest extends WebTestCase
{
public function testShouldDisplayTheExpertsList()
{
$client = self::createClient();
$crawler = $client->request('GET', '/experts');
$this->assertEquals(200, $client->getResponse()->getStatusCode());
$this->assertGreaterThan(1, $crawler->filter('li')->count());
}
}

View Slide

RED
27
namespace Theodo\Bundle\ExpertBundle\Tests\Controller;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
/**
* ExpertControllerTest
*
* @author Benjamin Grandfond
* @group functional
*/
class ExpertControllerTest extends WebTestCase
{
{
}
}
TIP

View Slide

28
TIP

View Slide

RED
29

View Slide

1. créer la route
2. créer le contrôleur et l’action
3. créer un template avec une liste et deux éléments
Il faut que le test passe avec un minimum de code
30

View Slide

RED
namespace Theodo\Bundle\ExpertBundle\Controller;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration as Extra;
class ExpertController extends Controller
{
/**
* @Extra\Route("/experts")
* @Extra\Template()
*/
public function listAction()
{
return array();
}
}
{% extends '::base.html.twig' %}
{% block body %}

Marek
Pierre-Henri

{% endblock %}
31

View Slide

GREEN
32

View Slide

{% block body %}

{% for expert in experts %}
{{ expert }}
{% endfor %}

{% endblock %}
On fait en sorte que les experts
soient dynamiques
{
$experts = array(
'Marek',
'Pierre-Henri',
);
return array(
'experts' => $experts
);
}
REFACTOR
33

View Slide

REFACTOR
34

View Slide

✔ code retour de la page = 200
✔ la réponse contient une liste
✘ le nombre de li = le nombre d’experts dans la base
Ce qu’on a testé :
35

View Slide

Utilisation de
!xtures
36

View Slide

• DoctrineFixturesBundle
https://github.com/doctrine/DoctrineFixturesBundle
• Faker
https://github.com/fzaninotto/Faker
• Alice
https://github.com/nelmio/alice
Les outils à utiliser
37

View Slide

REFACTOR
# app/config/config_test.yml
doctrine:
dbal:
driver: pdo_sqlite
host: localhost
port: ~
dbname: symfony
user: root
password: ~
path: %kernel.root_dir%/cache/database.db
38

View Slide

/**
* Generates the schema to use on the test environment.
*
* @throws \Doctrine\DBAL\Schema\SchemaException
*/
protected static function generateSchema()
{
if (null === static::$kernel) {
static::$kernel = static::createKernel();
}
$em = static::$kernel->getContainer()->get('doctrine.orm.entity_manager');
// Get the metadata of the application to create the schema.
$metadata = $em->getMetadataFactory()->getAllMetadata();
if (!empty($metadata)) {
$tool = new \Doctrine\ORM\Tools\SchemaTool($em);
$tool->dropDatabase();
$tool->createSchema($metadata);
} else {
throw new \Doctrine\DBAL\Schema\SchemaException(
'No Metadata Classes to process.'
);
}
}
REFACTOR
39

View Slide

{
self::generateSchema();
$loader = new \Nelmio\Alice\Loader\Base();
$objects = $loader->load($this->getExperts());
$persister = new \Nelmio\Alice\ORM\Doctrine(
static::$kernel->getContainer()->get('doctrine.orm.entity_manager')
);
$persister->persist($objects);
$crawler = $client->request('GET', '/Experts');
}
private function getExperts()
{
return array(
'Theodo\Bundle\ExpertBundle\Entity\Expert' => array(
'expert{1..5}' => array(
'firstName' => '',
'lastName' => '',
'username' => ''
),
)
);
}
REFACTOR
40

View Slide

REFACTOR
{
return array(
'firstName' => '',
'lastName' => '',
'username' => ''
),
)
);
}

View Slide

REFACTOR
{
return array(
'firstName' => '',
'lastName' => '',
'username' => ''
),
)
);
}
créé 5 experts

View Slide

REFACTOR
{
return array(
'firstName' => '',
'lastName' => '',
'username' => ''
),
)
);
}
formateurs Faker
créé 5 experts

View Slide

REFACTOR
{
);
// ...
}

View Slide

REFACTOR
{
);
// ...
}
transforme les ﬁxtures
en objets

View Slide

REFACTOR
{
);
// ...
}
transforme les ﬁxtures
en objets
persiste les objets dans la base

View Slide

REFACTOR
/**
* @Extra\Route("/experts")
* @Extra\Template()
*/
{
$experts = $this->getDoctrine()
->getRepository('TheodoBundleExpertBundle:Expert')
->findAll()
;
return array(
'experts' => $experts
);
}
43

View Slide

REFACTOR
44

View Slide

✔ code retour de la page = 200
✔ la réponse contient une liste
✔ le nombre de li = le nombre d’experts dans la base
45

View Slide

Réutiliser l’existant ...
qui n’a pas de tests
46

View Slide

Réutiliser l’existant
{
->findAll()
;
$expert = new Expert();
$builder = $this->createFormBuilder($Expert);
$form = $builder
->add('firstName')
->add('lastName')
->add('username')
->getForm();
;
if ($this->getRequest()->isMethod('post')) {
$form->bind($this->getRequest());
if ($form->isValid()) {
$em = $this->getDoctrine()->getManager();
$em->persist($form->getData());
$em->flush();
// ici on envoie un email, au nouvel expert
// on créé ses comptes sur tous les services utilisés par la boite etc...
return $this->redirect($this->generateUrl('theodoexpertbundle_expert_list'));
}
}
return array('experts' => $experts, 'form’ => $form->createView());
}
47
Contrôleur

View Slide

{
->findAll()
;
$form = $builder
->add('firstName')
->add('lastName')
->add('username')
->getForm();
;
$em->flush();
}
}
}
47
Contrôleur
création du formulaire

View Slide

{
->findAll()
;
$form = $builder
->add('firstName')
->add('lastName')
->add('username')
->getForm();
;
$em->flush();
}
}
}
47
Contrôleur
création du formulaire
sauvegarde l’expert

View Slide

{% block body %}

{{ expert }}
{% endfor %}

method="post">
{{ form_errors(form) }}
{{ form_widget(form) }}
Save

{% endblock %}
48
Template

View Slide

• l’a!chage de la liste et du formulaire
• la sauvegarde d’un nouvel expert
test list
49

View Slide

• l’a!chage de la liste et du formulaire
• la sauvegarde d’un nouvel expert
test list
49
• la page d’édition
• la sauvegarde de l’édition d’un expert
new
new

View Slide

{
// load fixtures ...
$this->assertCount(1, $crawler->filter('form'));
}
Note : ceci est un nouveau test !
Tester l’existant
50
✘ l’a!chage de la liste et du formulaire

View Slide

RED GREEN
ou ?
Tester l’existant
51

View Slide

Tester l’existant
52

View Slide

53

View Slide

53
Ne faites pas con!ance aux tests
écrits après le code, testez les tests !

View Slide

{% block body %}

{% endblock %}
Tester les tests
54

View Slide

55
Tester les tests

View Slide

{% block body %}

{{ expert }}
{% endfor %}

{% endblock %}
Tester les tests
56

View Slide

57
Tester les tests

View Slide

Tester les tests
58
{% block body %}

{{ expert }}
{% endfor %}

method="post">
{{ form_errors(form) }}
{{ form_widget(form) }}
Save

{% endblock %}

View Slide

59
Tester les tests
GREEN
✔ l’a!chage de la liste et du formulaire

View Slide

Véri!ons que la sauvegarde du
formulaire fonctionne !
60

View Slide

public function testShouldSaveANewExpert()
{
$csrfToken = $client->getContainer()
->get('form.csrf_provider')
->generateCsrfToken('unknown');
$client->request('POST', '/experts', array(
'form' => array(
'firstName' => 'Benjamin',
'lastName' => 'Grandfond',
'username' => 'benjaming',
'_token' => $csrfToken,
)
));
$crawler = $client->followRedirect();
$this->assertRegExp('~Benjamin~', $crawler->filter('li')->text());
}
61
Tester l’existant
✘ sauvegarde d’un nouvel expert

View Slide

public function testShouldSaveANewExpert()
{
$csrfToken = $client->getContainer()
->get('form.csrf_provider')
->generateCsrfToken('unknown');
$client->request('POST', '/experts', array(
'form' => array(
'firstName' => 'Benjamin',
'lastName' => 'Grandfond',
'username' => 'benjaming',
'_token' => $csrfToken,
)
));
$crawler = $client->followRedirect();
$this->assertRegExp('~Benjamin~', $crawler->filter('li')->text());
}
61
Tester l’existant
TIP
✘ sauvegarde d’un nouvel expert

View Slide

# app/config/config_test.yml
parameters:
form.csrf_provider.class: 'Theodo\Bundle\ExpertBundle\Form\Extension\Csrf
\CsrfProvider\MockCsrfProvider'
Mockez les services en changeant la classe
utilisée par le container.
TIP
62
Tester l’existant

View Slide

namespace Theodo\Bundle\ExpertBundle\Form\Extension\Csrf\CsrfProvider;
use Symfony\Component\Form\Extension\Csrf\CsrfProvider\CsrfProviderInterface;
class MockCsrfProvider implements CsrfProviderInterface
{
public function generateCsrfToken($intention)
{
return $intention;
}
public function isCsrfTokenValid($intention, $token)
{
return $intention == $token;
}
}
TIP
63
Tester l’existant

View Slide

64
Tester l’existant
✔ la sauvegarde d’un nouvel expert

View Slide

Encore une fois : Ne faites pas con!ance
aux tests écrits après le code,
testez les tests !
65

View Slide

✔ l’a!chage de la liste et du formulaire
✔ la sauvegarde d’un nouvel expert
✘ la page d’édition
✘ la sauvegarde de l’édition d’un expert
test list
66

View Slide

• validité du formulaire
• retourne une
redirection
• retourne le formulaire
erroné
• bind le formulaire avec
la request
• sauvegarder l’entité du
formulaire
Refactorisation : Création d’un handler pour
sauvegarder un expert.
test list
Sauvegarde du formulaire
67

View Slide

RED
namespace Theodo\Bundle\ExpertBundle\Tests\Form\Handler;
use Theodo\Bundle\ExpertBundle\Form\Handler\ExpertFormHandler;
class ExpertFormHandlerTest extends \PHPUnit_Framework_TestCase
{
public function testShouldHandleAnUnsuccessfulFormSubmission()
{
$request = new \Symfony\Component\HttpFoundation\Request();
$form = $this
->getMockBuilder('Symfony\Component\Form\Test\FormInterface')
->disableOriginalConstructor()
->getMock()
;
$handler = new ExpertFormHandler();
$this->assertEquals($form, $handler->handle($form, $request));
}
}
Refactoriser l’existant
68
✘ retourne le formulaire erroné

View Slide

69
Mock ?!

View Slide

70
Un mock est un objet qui simule un autre objet et
permet de contrôler les interactions avec l‘objet testé.
• véri"er le nombre d’appels d’une méthode
• spéci"er le retour de la méthode
• véri"er les paramètres d’une méthode
• ...

View Slide

71
• PHPUnit Mock Object
https://github.com/sebastianbergmann/phpunit-mock-objects
• Mockery
https://github.com/padraic/mockery
• Phake
https://github.com/mlively/Phake
Les frameworks

View Slide

RED
72

View Slide

RED
namespace Theodo\Bundle\ExpertBundle\Form\Handler;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpFoundation\Request;
class ExpertFormHandler
{
public function handle(FormInterface $form, Request $request)
{
return $form;
}
}
73

View Slide

RED
{
{
return $form;
}
}
73
code minimum !

View Slide

GREEN
74
✔ retourne le formulaire erroné

View Slide

RED
public function testShouldHandleASuccessfulFormSubmission()
{
$form = $this
->getMock()
;
$form->expects($this->once())
->method('isValid')
->will($this->returnValue(true))
;
$response = $handler->handle($form, $request)
$this->assertInstanceOf(
'Symfony\Component\HttpFoundation\RedirectResponse',
$response
);
$this->assertEquals('/experts', $response->getTargetUrl());
}
75
✘ validité du formulaire
✘ retourne une redirection

View Slide

RED
{
$form = $this
->getMock()
;
->method('isValid')
;
$response
);
}
75
le formulaire est
valide

View Slide

RED
{
$form = $this
->getMock()
;
->method('isValid')
;
$response
);
}
75
le formulaire est
valide
handle() retourne une
redirection vers /experts

View Slide

RED
76

View Slide

RED
use Symfony\Component\HttpFoundation\RedirectResponse;
{
{
return new RedirectResponse("/experts");
}
return $form;
}
}
77

View Slide

GREEN
78
✔ validité du formulaire
✔ retourne une redirection

View Slide

REFACTOR
{
$form = $this
->getMock()
;
$response = $handler->handle($form, $request);
// ...
79
{
$form = $this
->getMock()
;
// ...

View Slide

REFACTOR
{
$form = $this
->getMock()
;
// ...
79
{
$form = $this
->getMock()
;
// ...
Duplication

View Slide

REFACTOR
{
protected $handler;
public function setUp()
{
$this->handler = new ExpertFormHandler();
}
//...
80

View Slide

REFACTOR
public function getFormMock()
{
return $this
->getMock();
}
81

View Slide

REFACTOR
{
$form = $this->getFromMock();
$response = $this->handler->handle($form, $request);
// ...
82
{
$form = $this->getFromMock();
// ...
// ...

View Slide

REFACTOR
83

View Slide

RED
{
// ...
->method('bind')
->with($this->identicalTo($request))
;
// ...
}
84
✘ bind le formulaire avec la request

View Slide

RED
85

View Slide

RED
use Symfony\Component\HttpFoundation\RedirectResponse;
{
{
$form->bind($request);
return new RedirectResponse("/experts");
}
return $form;
}
}
86

View Slide

✔ retourne une
redirection
✔ retourne le
formulaire erroné
✔ bind le formulaire
avec la request
✘ sauvegarder l’entité
du formulaire
test list
87

View Slide

✔ retourne une
redirection
✔ retourne le
formulaire erroné
avec la request
du formulaire
test list
87
new
✘ génère la route avec
le router

View Slide

GREEN
88
✔ bind le formulaire avec la request

View Slide

RED
89
✘ génère la route avec le router
{
protected $handler;
protected $router;
{
$this->router = $this->getMock('Symfony\Component\Routing\RouterInterface');
$this->handler = new ExpertFormHandler($this->router);
}
}

View Slide

RED
89
{
protected $handler;
protected $router;
{
}
}
mock le router

View Slide

RED
89
{
protected $handler;
protected $router;
{
}
}
mock le router
injecte le router

View Slide

RED
{
// ...
$this->router->expects($this->once())
->method('generate')
->with($this->equalTo('theodoexpertbundle_expert_list')
->will($this->returnValue('/experts'))
;
// ...
}
90

View Slide

RED
91

View Slide

RED
use ...;
use Symfony\Component\Routing\RouterInterface;
{
/**
* @var \Symfony\Component\Routing\RouterInterface
*/
protected $router;
/**
* @param RouterInterface $router
*/
public function __construct(RouterInterface $router)
{
$this->router = $router;
}
// ...
}
92

View Slide

RED
{
$url = $this->router->generate(
'theodoexpertbundle_expert_list'
);
return new RedirectResponse($url);
}
return $form;
}
93

View Slide

GREEN
94
✔ génère la route avec le router

View Slide

✔ retourne une
redirection
✔ retourne le
formulaire erroné
avec la request
✔ génère la route avec
le router
du formulaire
95
test list

View Slide

RED
protected $em;
{
$this->em = $this->getMockBuilder('Doctrine\ORM\EntityManager')
->getMock()
;
$this->handler = new ExpertFormHandler($this->router, $this->em);
}
96
✘ sauvegarder l’entité du formulaire

View Slide

RED
protected $em;
{
->getMock()
;
}
96
mock l’entity manager

View Slide

RED
protected $em;
{
->getMock()
;
}
96
mock l’entity manager
injecte l’entity manager

View Slide

RED
{
// ...
$expert = new \Theodo\Bundle\ExpertBundle\Entity\Expert();
->method('getData')
->will($this->returnValue($expert));
// ...
$this->em->expects($this->once())
->method('persist')
->with($this->identicalTo($expert))
;
->method('flush');
// ...
97

View Slide

RED
{
// ...
->method('getData')
// ...
->method('persist')
;
->method('flush');
// ...
97
getData retournera
un expert

View Slide

RED
{
// ...
->method('getData')
// ...
->method('persist')
;
->method('flush');
// ...
97
getData retournera
un expert
cet expert sera
persisté

View Slide

RED
{
// ...
->method('getData')
// ...
->method('persist')
;
->method('flush');
// ...
97
getData retournera
un expert
cet expert sera
persisté
l’em sera "ushé

View Slide

RED
98

View Slide

RED
{
/** @var \Symfony\Component\Routing\RouterInterface */
protected $router;
/** @var \Doctrine\ORM\EntityManager */
protected $manager;
/**
* @param RouterInterface $router
* @param EntityManager $manager
*/
public function __construct(RouterInterface $router, EntityManager $manager)
{
$this->router = $router;
$this->manager = $manager;
}
99

View Slide

RED
{
$this->manager->persist($form->getData());
$this->manager->flush();
$route = 'theodoexpertbundle_expert_list';
return new RedirectResponse($this->router->generate($route));
}
return $form;
}
100

View Slide

RED
{
$this->manager->persist($form->getData());
$this->manager->flush();
$route = 'theodoexpertbundle_expert_list';
return new RedirectResponse($this->router->generate($route));
}
return $form;
}
100
persiste l’expert
puis "ush

View Slide

101
GREEN
✔ sauvegarder l’entité du formulaire

View Slide

✔ retourne une
redirection
✔ retourne le
formulaire erroné
avec la request
✔ génère la route avec
le router
✔ sauvegarder l’entité
du formulaire
102
test list

View Slide

Maintenant on peut faire
l’édition d’un expert en TDD !
103

View Slide

Conclusion
• Soyez patient
• Persévérez
• (Ré)introduisez progressivement des tests
• Testez ce qui est primordial
• Refactorisez, corrigez, créez en TDD

View Slide

Questions ?
 benja-M-1  benjaM1
 [email protected]:benja-M-1/s"ive-paris-2013.git
https://speakerdeck.com/benjam1/adoptez-le-tdd-sﬂive-paris-2013
Venez me retrouvez au stand Theodo pour en savoir plus !
105

View Slide

Adoptez le TDD sur vos projets Symfony2 existants

Adoptez le TDD sur vos projets Symfony2 existants

Benjamin Grandfond

More Decks by Benjamin Grandfond

Other Decks in Programming

Featured

Transcript