schranz / test-generator
A cli tool which generates unit tests.
Fund package maintenance!
alexander-schranz
Installs: 18 563
Dependents: 1
Suggesters: 0
Security: 0
Stars: 8
Watchers: 4
Forks: 1
Open Issues: 2
Requires
- php: ^8.1
- nikic/php-parser: ^4.18 || ^5.0
- symfony/filesystem: ^5.4 || ^6.0 || ^7.0
- symfony/process: ^5.4 || ^6.0 || ^7.0
- symfony/string: ^5.4 || ^6.0 || ^7.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.6
- phpstan/phpstan: ^1.4
- phpstan/phpstan-phpunit: ^1.0
- phpstan/phpstan-webmozart-assert: ^1.0
- phpunit/phpunit: ^10.4
- rector/rector: ^0.19
- symfony/finder: ^5.4 || ^6.0 || ^7.0
- symfony/var-dumper: ^5.4 || ^6.0 || ^7.0
- thecodingmachine/phpstan-strict-rules: ^1.0
README
This project make usages of PHPStan (WIP) and PHPParser to generate test cases for a given PHP File by parsing its AST.
Why?
With static code analyzer it is possible to generate tests which where mostly forgotten. The target of the project is not to generate a whole test cases instead it should generate the most boilerplate code of the test case and tell which method for the class methods should be implemented.
So example if we have a method like the following:
public function setTitle(?string $title): void { $this->title = $title; } public function getTitle(): void { $this->title = $title; }
If you are using code coverage you will get 100% when you are testing:
public function testSetTitle(): void { $model = $this->createInstance(); $model->setTitle('Test'); $this->assertSame('Test', $model->getTitle()); }
But as ?string
can be seen as an union type of string|null
the testcase for null
type is missing:
public function testSetTitleNull(): void { $model = $this->createInstance(); $model->setTitle(null); $this->assertNull($model->getTitle()); }
The project target is to already generate also the boilerplate for that test case.
Installation
composer require --dev schranz/test-generator
Config
Create a new tests/generator-config.php
file:
<?php use Schranz\TestGenerator\Domain\Model\Config; $config = new Config(); // add following hooks if you want to use `rector` or `php-cs-fixer` directly on the created test files // $config->hooks[] = 'vendor/bin/rector process %s'; // $config->hooks[] = 'vendor/bin/php-cs-fixer fix %s'; return $config;
See Config.php for all options.
It is recommended to also configure in the projects phpunit.xml
the failOnIncomplete
to true:
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd" ... + failOnIncomplete="true" >
So generated tests fail automatically and require adjustments and review by the developer.
Usage
vendor/bin/test-generator src/YourNameSpace/YourFile.php