Skip to content
This repository was archived by the owner on Jan 30, 2023. It is now read-only.

Commit 2488ff2

Browse files
gbproddzc34
authored andcommitted
1 parent deecdd2 commit 2488ff2

File tree

5 files changed

+47
-214
lines changed

5 files changed

+47
-214
lines changed

src/annotations.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -737,7 +737,8 @@ dans le bloc de documentation d'une méthode pour la marquer comme méthode de t
737737
########
738738

739739
Spécifie une description alternative utilisée lors de la génération des phrases de la
740-
documentation agile (voir :ref:`other-uses-for-tests.agile-documentation`).
740+
documentation agile.
741+
741742
L'annotation ``@testdox`` peut être appliqué aux classes de tests et aux méthodes.
742743

743744
.. code-block:: php

src/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,7 @@ Table des matières :
2323
incomplete-and-skipped-tests
2424
database
2525
test-doubles
26-
testing-practices
2726
code-coverage-analysis
28-
other-uses-for-tests
2927
logging
3028
extending-phpunit
3129

src/other-uses-for-tests.rst

Lines changed: 0 additions & 90 deletions
This file was deleted.

src/testing-practices.rst

Lines changed: 0 additions & 117 deletions
This file was deleted.

src/textui.rst

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -235,8 +235,7 @@ dans le code suivant :
235235
``--testdox-html`` et ``--testdox-text``
236236
237237
Génère la documentation agile au format HTML ou texte pur pour les
238-
tests exécutés. Voir :ref:`other-uses-for-tests` pour
239-
plus de détails.
238+
tests exécutés (Voir :ref:`textui.testdox`).
240239
241240
``--filter``
242241
@@ -459,8 +458,7 @@ dans le code suivant :
459458
460459
``--testdox``
461460
462-
Rapporte l'avancement des tests sous forme de documentation agile. Voir
463-
:ref:`other-uses-for-tests` pour plus de détails.
461+
Rapporte l'avancement des tests au format TestDox (Voir :ref:`textui.testdox`).
464462
465463
``--printer``
466464
@@ -505,3 +503,46 @@ dans le code suivant :
505503
.. admonition:: Note
506504
507505
Notez qu'à partir de 4.8, les options peuvent être placées après le(s) argument(s).
506+
507+
.. _textui.testdox:
508+
509+
TestDox
510+
#######
511+
512+
La fonctionnalité TestDox de PHPUnit examine une classe de test et tous
513+
les noms de méthode de test pour les convertir les noms PHP au format Camel Case en phrases :
514+
``testBalanceIsInitiallyZero()`` (ou ``test_balance_is_initially_zero()``) devient "Balance is
515+
initially zero". S'il existe plusieurs méthodes de test dont les noms
516+
ne diffèrent que par un suffixe constitué de un ou plusieurs chiffres, telles que
517+
``testBalanceCannotBecomeNegative()`` et
518+
``testBalanceCannotBecomeNegative2()``, la phrase
519+
"Balance ne peut pas être négative" n'apparaîtra qu'une seule fois, en supposant que
520+
tous ces tests ont réussi.
521+
522+
Jetons un oeil sur la documentation agile générée pour la classe
523+
``BankAccount``
524+
525+
.. code-block:: bash
526+
527+
$ phpunit --testdox BankAccountTest
528+
PHPUnit 7.0.0 by Sebastian Bergmann and contributors.
529+
530+
BankAccount
531+
✔ Balance is initially zero
532+
✔ Balance cannot become negative
533+
534+
La documentation agile peut aussi être générée en HTML ou au
535+
format texte et écrite dans un fichier en utilisant les paramètres
536+
``--testdox-html`` et ``--testdox-text``.
537+
538+
La documentation agile peut être utilisée pour documenter les hypothèses
539+
que vous faites sur les paquets externes que vous utilisez dans votre projet.
540+
Quand vous utilisez un paquet externe, vous vous exposez au risque que le paquet
541+
ne se comportera pas comme vous le prévoyez et que les futures versions du paquet
542+
changeront de façon subtile, ce qui cassera votre code sans que vous ne le sachiez.
543+
Vous pouvez réduire ces risques en écrivant un test à chaque fois que vous faites
544+
une hypothèse. Si votre test réussit, votre hypothèse est valide. Si vous documentez
545+
toutes vos hypothèses avec des tests, les futures livraisons du paquet externe ne
546+
poseront pas de problème : si les tests réussissent, votre système doit continuer à
547+
fonctionner.
548+

0 commit comments

Comments
 (0)