codecept unittest generator

Gerador Codecept UnitTest

Este pacote permite gerar testes PHPUnit a partir de anotações, que você pode escrever na documentação de seus métodos.

• O uso básico deste pacote é gerar seu esqueleto de testes e testes básicos.
• Você deve verificar e concluir todos os testes gerados, incluindo os métodos mais básicos.
• Os arquivos a serem analisados ​​devem declarar uma classe, classe abstrata, característica ou interface para serem aceitos.

Instalação

A forma preferida de instalar esta extensão é através do compositor.

Ou corra

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

ou adicione

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

para a seção require do seu compositor.json.

Configuração

habilite a extensão UnitGenerator no arquivo de configuração 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/ 

Uso

./vendor/bin/codecept generate:unit

Anotações

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

Esta anotação usa alguns parâmetros:

• phpunit_assertion_method : É o método de asserção do PHPUnit que você deseja usar (como assertEquals , assertInstanceOf , assertTrue ...).

• expectativa : o método retorna o valor esperado. Alguns métodos PHPUnit não precisam dele (como assertTrue ), portanto, nesses casos, pode ser nulo.

• parâmetros : os parâmetros do método.

Veja este exemplo, queremos gerar automaticamente alguns testes simples 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 ' ) {}

Essas anotações criarão testes básicos do PHPUnit:

 <?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 ());

Anotação getter e setter

 <?php
// The class to test content

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

Essas duas anotações permitirão gerar testes automaticamente para getter/setter simples. Seu getter/setter precisa ser nomeado da seguinte forma:

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

O PHPUnit Generator possui uma opção "auto": Se você ativá-lo, ele irá procurar a propriedade quando encontrar um método começando com "get" ou "set", e se a propriedade existir, irá gerar testes.

Método privado ou protegido

Se o método a ser testado for privado ou protegido, o PHPUnit Generator acessará o método com PHP ReflectionClass.

Requisitos

UnitGenerator precisa dos seguintes componentes para funcionar:

• Codeception UnitGenerator é um módulo para Codeception . Será necessária uma versão em execução desta ferramenta.
• Pacote gerador Phpunit.