README

Yii2 commands for remote requests to Uniter1 test generation service

This package provides 2 commands: first for registration, second for test generation request.

Short instruction

composer require uniter1/uniter-yii

// edit config/console.php

'controllerMap' => [ ... 'uniter1' => [ 'class' => 'Uniter1\UniterYii\Uniter1Yii', 'config' => [ 'accessToken' => your requested token, 'basePath' => dirname(DIR), 'projectDirectory' => dirname(DIR), ], ]

// get registered token php yii uniter1/register {email} {password}

read email and put token to config/console.php

// generate test for your php class file php yii uniter1/generate path/to/file [methodToOverwrite]

result should be written to yours unitTestsDirectory (see in config/console.php)

Installation

You can install the package via composer:

composer require uniter1/uniter-yii

Testing

Usage

User registration:

php yii uniter1/register {email} {password}

User will be registered, and access token will be sent to your email. You need to put that token to yours config/console.php file as 'accessToken'. After that you can send test generation queries.

Package settings:

Other options (in uniter/config.php) you may remain as defaults. You can overwrite them in config/console.php. Check that unit tests directory (defaults storage/tests/Unit) exists and is writable.

'baseUrl' => https://uniter1.tech

This is web address for our service. Use https://uniter1.tech

'obfuscate' => true

Obfuscation option. Set it to false if you need no obfuscation for you code.

'unitTestBaseClass' => PHPUnit\Framework\TestCase

Base framework for yours test class.

'unitTestsDirectory' => tests/Unit

Base directory to save generated test classes. Check that directory exists and is writable.

'inspectorMode'       => true,

if true, private and protected methods will be tested. If false, none.

Test generation

php yii uniter1/generate {filePath} [methodToOverwrite]

Your class you want to test will be read from {filePath}, obfuscated if you did not turn obfuscation off, sent to our service. There will be created some phpunit test file to test different variants of yours class methods. The result will be deobfuscated and saved to 'unitTestsDirectory'- to some nested folder according to class namespace.

Open it, read it and use to test yours class.

Generated class, possibly, will not be completed test - read comments before each generated test method.

methodToOverwrite optional parameter allows you to replace only those methods that test one of the methods of the source class in the previously generated test class during generation. Be careful when using it - it is necessary that the previously generated test lies at the same address, and also that no changes are made to the class under test, except for the method that we specified with this option.