unitgen/unitgen

Unitgen generates a basic framework for writing unit tests.

Unitgen

, _(*1)

The generator of the basic structure for the unit tests. The generated classes are based on tests phpunit version >= 5.4.*. Unitgen is is a command line tool that recursively(optional) analyze the specified path and generates unit test files. The directory structure is reproduced according to the original structure., _(*2)

Installation

Installation via Composer. Add to your composer.json file., _(*3)

{
    "require-dev": {
        "phpunit/phpunit": "5.4.*",
        "unitgen/unitgen": "dev-master"
    }
}

Examlpe of created test

For source class "SourceClass":, _(*4)

namespace source\class\path;

class SourceClass
{
    /**
     * @throws \Exception
     */
    public function bar()
    {
        ...
    }
}

Will be generated next structure within "SourceClassTest":, _(*5)

use PHPUnit\Framework\TestCase;

class SourceClassTest extends TestCase
{
    private $sourceClass;
    
    public function setUp()
    {
        $this->sourceClass = new \source\class\path\SourceClass();
    }
    
    public function testBar()
    {
        "//TODO Implement test for bar method\n";
        $this->assertTrue(false);
    }
    
    public function testBarException()
    {
        "//TODO Implement test for bar method\n";
        $this->expectException(\Exception::class);
    }
    
    public function tearDown()
    {
        "//TODO Implement tearDown method";
    }
}

Unitgen generates test method for public method only. Also it looks for annotation exception data and generates appropriate test methods., _(*6)

NOTE: Unitgen does not affect existing files., _(*7)

Configuration

For use unitgen you should specify a configuration file., _(*8)

Here is an exaple of configuration file with all available options:, _(*9)

return [
    'source'        => [
        'path'    => [], // required
        'exclude' => []
    ],
    'savePath'      => '', // required
    'classExclude'  => [
        'name'      => [], // array of full class names
        'regexp'    => [], // array of reqular expressions
        'parent'    => [], // array of parent classes
        'implement' => [], // array of interfaces
    ],
];

Example of usage

$ cd "vendor/.../unitget/bin"

$ ./unitgen run "config-path"

Start test generation.
======================

Generation completed successful.
-------------------------
Number of files in source path: 9
Number of generated test classes: 3
-------------------------
Generated in:0.12969493865967