krajcik/data-builder

Data generator based on database structure of your project.

v1.0.0 2024-11-01 21:49 UTC

Requires

• php: >=8.0
• fakerphp/faker: ^1.23
• nette/database: ^2.4 || ^3.0
• nette/php-generator: ^3.6 || ^4.0
• nette/robot-loader: ^2.4 || ^3.0 || ^4.0

Requires (Dev)

• phpmd/phpmd: ^2.00
• phpstan/phpstan: ^1.11
• phpunit/phpunit: ^10.5
• squizlabs/php_codesniffer: ^3.10

BSD-3-Clause, GPL-2.0-or-later, GPL-3.0-or-later

README

Package helps to write test data for tests using data builders which package generate specifically for your project. By default, are all data filled randomly with option change one or more properties.

Installation

composer require krajcik/data-builder

Using

Configuration and generate

    use \Krajcik\DataBuilder\Dto\Configuration;
    
    $targetFolder = '../tests/generated'; // specify some path in your project where you want generate builders

    $configuration = new Configuration(
        $targetFolder,
        'localhost',
        'myTestDb',
        'root',
        'root',
    );

Define builders which want generate

Define all doctrine entities for which you want generate builder

    use \Krajcik\DataBuilder\Dto\BuilderToGenerateDto;

    $builderToGenerate = [
        BuilderToGenerateDto::createFromDoctrineEntity('Api\Contact\Entity\Contact'),
        BuilderToGenerateDto::createFromDoctrineEntity('Api\Contact\Entity\ContactData'),
    ];

Generate builders

    use \Krajcik\DataBuilder\BuilderCompiler;

    $compiler = new BuilderCompiler($configuration);
    $compiler->compile($builderToGenerate);

Using builders

    $builderFactory = new \Tests\Generated\Builder\BuilderFactory($entityManager);

    $contactData = $builderFactory->createContactDataBuilder()
        ->withFirstName('John')
        ->withLastName('Doe')
        ->buildAndSave();
    // $contactData is saved entity (Api\Contact\Entity\ContactData) from your project which you can use now in your test case