codecept unittest generator

Codecept UnitTest ジェネレーター

このパッケージを使用すると、メソッドのドキュメントに記述できるアノテーションから PHPUnit テストを生成できます。

• このパッケージの基本的な使用法は、テスト スケルトンと基本テストを生成することです。
• 最も基本的なメソッドを含む、生成したすべてのテストを確認して完了する必要があります。
• 解析するファイルは、受け入れられるクラス、抽象クラス、特性、またはインターフェイスを 1 つ宣言する必要があります。

インストール

この拡張機能をインストールするには、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 ());

ゲッターとセッターのアノテーション

 <?php
// The class to test content

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

これら 2 つのアノテーションを使用すると、単純なゲッター/セッターのテストを自動生成できます。ゲッター/セッターには次のような名前を付ける必要があります。

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

PHPUnit ジェネレーターには「auto」オプションがあります。これをアクティブにすると、「get」または「set」で始まるメソッドが見つかったときにプロパティが検索され、プロパティが存在する場合はテストが生成されます。

プライベートまたは保護されたメソッド

テストするメソッドがプライベートまたは保護されている場合、PHPUnit Generator は PHP ReflectionClass を使用してメソッドにアクセスします。

要件

UnitGenerator を実行するには、次のコンポーネントが必要です。

• Codeception UnitGenerator はCodeception用のモジュールです。このツールの実行バージョンが必要になります。
• Phpunit ジェネレーター パッケージ。