Search

DataFactory

Installation

composer require --dev codeception/module-datafactory

Description

DataFactory allows you to easily generate and create test data using FactoryMuffin. DataFactory uses an ORM of your application to define, save and cleanup data. Thus, should be used with ORM or Framework modules.

This module requires packages installed:

{
 "league/factory-muffin": "^3.0",
}

Generation rules can be defined in a factories file. Create a folder for factories files: tests/_support/factories.

Create an empty PHP file inside that folder factories.php. Follow FactoryMuffin documentation to set valid rules. Randomly generated data provided by Faker library.

Here is the sample factory file:

<?php
use League\FactoryMuffin\Faker\Facade as Faker;

$fm->define(User::class)->setDefinitions([
 'name'   => Faker::name(),

    // generate email
   'email'  => Faker::email(),
   'body'   => Faker::text(),

   // generate a profile and return its Id
   'profile_id' => 'factory|Profile'
]);

Configure this module to load factory definitions from a directory. You should also specify a module with an ORM as a dependency.

modules:
    enabled:
        - Yii2:
            configFile: path/to/config.php
        - DataFactory:
            factories: tests/_support/factories
            depends: Yii2

(you can also use Laravel and Phalcon).

In cases you want to use data from database inside your factory definitions you can define them in a Helper. For instance, if you use Doctrine, this allows you to access EntityManager inside a definition.

To proceed you should create Factories helper via generate:helper command and enable it:

modules:
    enabled:
        - DataFactory:
            depends: Doctrine2
        - \Helper\Factories

In this case you can define factories from a Helper class with _define method.

<?php
public function _beforeSuite()
{
     $factory = $this->getModule('DataFactory');
     // let us get EntityManager from Doctrine
     $em = $this->getModule('Doctrine2')->_getEntityManager();

     $factory->_define(User::class, [

         // generate random user name
         // use League\FactoryMuffin\Faker\Facade as Faker;
         'name' => Faker::name(),

         // get real company from database
         'company' => $em->getRepository(Company::class)->find(),

         // let's generate a profile for each created user
         // receive an entity and set it via `setProfile` method
         // UserProfile factory should be defined as well
         'profile' => 'entity|'.UserProfile::class
     ]);
}

Factory Definitions are described in official Factory Muffin Documentation

Related Models Generators

If your module relies on other model you can generate them both. To create a related module you can use either factory or entity prefix, depending on ORM you use.

In case your ORM expects an Id of a related record (Eloquent) to be set use factory prefix:

'user_id' => 'factory|User'

In case your ORM expects a related record itself (Doctrine) then you should use entity prefix:

'user' => 'entity|User'

Custom store

You can define a custom store for Factory Muffin using customStore parameter. It can be a simple class or a factory with create method. The instantiated object must implement \League\FactoryMuffin\Stores\StoreInterface.

Store factory example:

modules:
    enabled:
        - DataFactory:
            customStore: \common\tests\store\MyCustomStoreFactory

use League\FactoryMuffin\Stores\StoreInterface;

class MyCustomStoreFactory
{
    public function create(): StoreInterface
    {
        return CustomStore();
    }
}

class CustomStore implements StoreInterface
{
    // ...
}

Actions

have

• param string $name
• param array $extraAttrs
• return object

Generates and saves a record,.

$I->have('User'); // creates user
$I->have('User', ['is_active' => true]); // creates active user

Returns an instance of created user.

haveMultiple

• param string $name
• param int $times
• param array $extraAttrs
• return object[]

Generates and saves a record multiple times.

$I->haveMultiple('User', 10); // create 10 users
$I->haveMultiple('User', 10, ['is_active' => true]); // create 10 active users

make

• param string $name
• param array $extraAttrs
• return object

Generates a record instance.

This does not save it in the database. Use have for that.

$user = $I->make('User'); // return User instance
$activeUser = $I->make('User', ['is_active' => true]); // return active user instance

Returns an instance of created user without creating a record in database.

onReconfigure

• param $settings
• throws ModuleException