Este paquete le permite generar pruebas PHPUnit a partir de anotaciones, que puede escribir en la documentación de sus métodos.
La forma preferida de instalar esta extensión es a través de Composer.
Ya sea correr
composer require hyperia/codecept-unittest-generator: " ^1.0 "
o agregar
"hyperia/codecept-unittest-generator": "^1.0"
a la sección requerida de su compositor.json.
habilite la extensión UnitGenerator
en el archivo de configuración 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/
./vendor/bin/codecept generate:unit
/**
* @PHPUnitGen<phpunit_assertion_method>(<expectation>:{<parameters...>})
*/
Esta anotación utiliza algunos parámetros:
phpunit_assertion_method : es el método de afirmación de PHPUnit que desea utilizar (como afirmarEquals , afirmarInstanceOf , afirmarTrue ...).
expectativa : el método devuelve el valor esperado. Algunos métodos PHPUnit no lo necesitan (como afirmarTrue ), por lo que en esos casos puede ser nulo.
parámetros : Los parámetros del método.
Vea este ejemplo, queremos generar automáticamente una prueba simple para este método:
<?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 ' ) {}
Esas anotaciones crearán pruebas PHPUnit básicas:
<?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 ());
<?php
// The class to test content
/** @PHPUnitGenGet() */
/** @PHPUnitGenSet() */
Esas dos anotaciones le permitirán generar automáticamente pruebas para captadores/definidores simples. Su captador/definidor debe tener un nombre similar al siguiente:
get<MyProperty>() {}
set<MyProperty>() {}
PHPUnit Generator tiene una opción "auto": si la activas, buscará la propiedad cuando encuentre un método que comience con "get" o "set", y si la propiedad existe, generará pruebas.
Si el método a probar es privado o protegido, PHPUnit Generator accederá al método con PHP ReflectionClass.
UnitGenerator necesita los siguientes componentes para ejecutarse: