https://github.com/alexander-schranz/test-generator

A CLI tool which generates unit tests.
https://github.com/alexander-schranz/test-generator

Last synced: 2 months ago
JSON representation

A CLI tool which generates unit tests.

• Host: GitHub
• URL: https://github.com/alexander-schranz/test-generator
• Owner: alexander-schranz
• Created: 2022-02-19T16:09:58.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-11T18:36:06.000Z (12 months ago)
• Last Synced: 2024-10-03T11:15:48.218Z (3 months ago)
• Language: PHP
• Size: 105 KB
• Stars: 8
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# PHP Test Generator

This project make usages of [PHPStan](https://github.com/phpstan/phpstan) (WIP) and [PHPParser](https://github.com/nikic/PHP-Parser)

to generate test cases for a given PHP File by parsing its [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree).

## 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:

```php

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:

```php

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:

```php

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

```bash

composer require --dev schranz/test-generator

```

## Config

Create a new `tests/generator-config.php` file:

```php

hooks[] = 'vendor/bin/rector process %s';

// $config->hooks[] = 'vendor/bin/php-cs-fixer fix %s';

return $config;

```

See [Config.php](src/Domain/Model/Config.php)  for all options.

It is recommended to also configure in the projects `phpunit.xml` the `failOnIncomplete` to true:

```diff

```

So generated tests fail automatically and require adjustments and review by the developer.

## Usage

```bash

vendor/bin/test-generator src/YourNameSpace/YourFile.php

```