codecept unittest generator Télécharger - codecept unittest generator Téléchargement du code source

codecept unittest generator

Python

Version 1.0.1

Télécharger

Générateur de tests unitaires Codecept

Ce package vous permet de générer des tests PHPUnit à partir d'annotations, que vous pouvez écrire dans la documentation de vos méthodes.

L'utilisation de base de ce package consiste à générer votre squelette de tests et vos tests de base.
Vous devez vérifier et terminer tous les tests que vous générez, y compris les méthodes les plus élémentaires.
Les fichiers à analyser doivent déclarer une classe, une classe abstraite, un trait ou une interface pour être acceptés.

capture d'écran_2017-12-08_17-12-32-github

Installation

La méthode préférée pour installer cette extension est via composer.

Soit courir

composer require hyperia/codecept-unittest-generator: " ^1.0 "

ou ajouter

 "hyperia/codecept-unittest-generator": "^1.0"

à la section require de votre composer.json.

Configuration

activez l'extension UnitGenerator dans le fichier de configuration de base /codeception.yml :

 extensions :
    enabled :
        - CodeceptionExtensionRunFailed
    commands :
        - CodeceptionCommandUnitGenerator
unitgenerator :
    config : 
        # erase old target files with new one
        overwrite : true 
        # if you want to generate tests for Interface too
        interface : false
        # automaticaly generate tests for getter / setter method
        auto : true
        # ignore errors that can be ignored
        ignore : true
        # regex (/.*config.php/ for example) that files must not match to have a tests generation
        exclude : ' /.*Trait.*/ '
        # regex (/.*.php/ for example) that files should match to have a tests generation
        include : ' /.*.php/ '
    dirs :
        # source directory => target directory
        - common/models : tests/unit/unitgen/common/models/
        - console/models : tests/unit/unitgen/console/models/

Usage

./vendor/bin/codecept generate:unit

Annotations

 /**
 * @PHPUnitGen<phpunit_assertion_method>(<expectation>:{<parameters...>}) 
 */

Cette annotation utilise certains paramètres :

phpunit_assertion_method : C'est la méthode d'assertion PHPUnit que vous souhaitez utiliser (comme assertEquals , assertInstanceOf , assertTrue ...).
attente : La méthode renvoie la valeur attendue. Certaines méthodes PHPUnit n'en ont pas besoin (comme assertTrue ), donc dans ces cas, cela peut être nul.
paramètres : Les paramètres de la méthode.

Voir cet exemple, nous souhaitons générer automatiquement un test simple pour cette méthode :

 <?php
// The class to test content

/** @PHPUnitGenAssertEquals('expected string':{1, 2, 'a string'}) */
/** @PHPUnitGenAssertTrue(:{4, 5, 'another'}) */
/** @PHPUnitGenAssertEquals(null) */
/** @PHPUnitGenAssertNull() */
public function method ( int $ arg1 = 0 , int $ arg2 = 0 , string $ arg3 = ' default ' ) {}

Ces annotations créeront des tests PHPUnit de base :

 <?php
// The generated test for "method" in tests class

$ this -> assertEquals ( ' expectation string ' , $ this -> method ( 1 , 2 , ' a string ' ));
$ this -> assertTrue ( $ this -> method ( 4 , 5 , ' another ' ));
$ this -> AssertEquals ( null , $ this -> method ());
$ this -> assertNull ( $ this -> method ());

Annotation getter et setter

 <?php
// The class to test content

/** @PHPUnitGenGet() */
/** @PHPUnitGenSet() */

Ces deux annotations vous permettront de générer automatiquement des tests pour un simple getter/setter. Votre getter/setter doit être nommé comme suit :

 get<MyProperty>() {}
set<MyProperty>() {}

PHPUnit Generator possède une option "auto" : Si vous l'activez, il recherchera la propriété lorsqu'il trouvera une méthode commençant par "get" ou "set", et si la propriété existe, il générera des tests.