codecept unittest generator

Codecept 单元测试生成器

该包允许您从注释生成 PHPUnit 测试，您可以将其写入方法文档中。

• 该包的基本用法是生成测试框架和基本测试。
• 您必须检查并完成您生成的所有测试，包括最基本的方法。
• 要解析的文件必须声明一个要接受的类、抽象类、特征或接口。

安装

安装此扩展的首选方法是通过 Composer。

要么运行

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

或添加

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

到你的composer.json的require部分。

配置

在基本/codeception.yml配置文件中启用UnitGenerator扩展：

 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...>}) 
 */

该注释使用一些参数：

• phpunit_assertion_method ：这是您想要使用的 PHPUnit 断言方法（如assertEquals 、 assertInstanceOf 、 assertTrue ...）。

• Expectation ：该方法返回期望值。某些 PHPUnit 方法不需要它（例如assertTrue ），因此在这些情况下，它可以为 null。

• 参数：方法参数。

看这个例子，我们想为此方法自动生成一些简单的测试：

 <?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 ' ) {}

这些注释将创建基本的 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 ());

getter 和 setter 注解

 <?php
// The class to test content

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

这两个注释将允许您自动生成简单 getter / setter 的测试。您的 getter / setter 需要命名如下：

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

PHPUnit Generator 有一个“auto”选项：如果激活它，当它找到以“get”或“set”开头的方法时，它将搜索该属性，如果该属性存在，它将生成测试。

私有或受保护的方法

如果要测试的方法是私有的或受保护的，PHPUnit 生成器将使用 PHP ReflectionClass 访问该方法。

要求

UnitGenerator 需要以下组件才能运行：

• Codeception UnitGenerator 是Codeception的一个模块。它将需要该工具的运行版本。
• Phpunit 生成器包。