Скачать codecept unittest generator - codecept unittest generator скачать исходный код

codecept unittest generator

Питон

Version 1.0.1

Скачать

Генератор Codecept UnitTest

Этот пакет позволяет генерировать тесты PHPUnit из аннотаций, которые вы можете написать в документации по своим методам.

Основное использование этого пакета — создание скелета тестов и базовых тестов.
Вы должны проверить и выполнить все созданные вами тесты, включая самые основные методы.
Файлы для анализа должны объявлять один класс, абстрактный класс, признак или интерфейс, которые будут приняты.

скриншот_2017-12-08_17-12-32-github

Установка

Предпочтительный способ установки этого расширения — через композитор.

Либо запустить

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

или добавьте

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

в раздел require вашего композитора.json.

Конфигурация

включите расширение UnitGenerator в базовом файле конфигурации /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...>}) 
 */

В этой аннотации используются некоторые параметры:

phpunit_assertion_method : это метод утверждения PHPUnit, который вы не хотите использовать (например, AssertEquals , AssertInstanceOf , AssertTrue ...).
ожидание : метод возвращает ожидаемое значение. Некоторым методам 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() */

Эти две аннотации позволят вам автоматически генерировать тесты для простого метода получения/установки. Ваш геттер/сеттер должен называться следующим образом:

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

Генератор PHPUnit имеет опцию «авто»: если вы ее активируете, он будет искать свойство, когда найдет метод, начинающийся с «get» или «set», и если свойство существует, он будет генерировать тесты.