YOURLS test suite for plugins

Suite de tests YOURLS pour plugins

Un outil PHPUnit pour VOS plugins.

À propos

La suite de tests YOURLS pour plugins est un outil permettant de tester les plugins YOURLS avec des tests PHPUnit standards.

Cet outil suppose une connaissance de base des outils de ligne de commande et du framework PHPUnit.

Usage

0. Avoir un plugin avec des tests
   Consultez le court guide pratique sur l'écriture de tests unitaires pour vos plugins YOURLS.

1. Installez la suite de tests YOURLS pour les plugins
   Dans my-cool-plugin/ :

   $ git clone https://github.com/YOURLS/YOURLS-test-suite-for-plugins test-suite

2. Installez la suite de tests YOURLS et la base de données de tests

   $ bash test-suite/src/install-test-suite.sh < db-name > < db-user > < db-password > [db-host, default localhost] [YOURLS version, default master]

   Exemples :

   $ bash test-suite/src/install-test-suite.sh yourlstest root " "
   $ bash test-suite/src/install-test-suite.sh yourlstest mydbuser mydbpassword mysql.myserver.com:666 1.8.2

3. Exécutez les tests unitaires de votre plugin
   Une fois que vous avez écrit les tests unitaires, exécutez-les :

   $ phpunit -c ./test-suite/src/phpunit.xml

   Le résultat attendu serait quelque chose comme :

   $ phpunit -c ./test-suite/src/phpunit.xml
   YOURLS installed, starting PHPUnit
   
   Plugin Loaded : My cool plugin by Joe (my-cool-plugin/plugin.php)
   
   PHPUnit 9.5.2 by Sebastian Bergmann and contributors.
   
   ......                                                              3 / 3 (100%)
   
   Time: 00:00.007, Memory: 22.00 MB
   
   OK (3 tests, 6 assertions)
   $

4. Automatiser les tests
   Sur un référentiel Github, configurez les actions Github pour exécuter automatiquement des tests lorsque le code de votre plugin change ou lorsqu'une nouvelle version de YOURLS est disponible. Consultez le guide des flux de travail.

Licence

Logiciel gratuit. Faites ce que vous voulez avec. YOURLS est publié sous licence MIT.