jeffochoa/factory-stories

Create model factory stories in Laravel 5.*

1.1 2017-09-06 19:33 UTC

This package is auto-updated.

Last update: 2021-07-11 07:50:32 UTC


README

This package allows you to create complex model factories in separate classes reusable among your tests classes.

inspired by the Model Factories podcast on twentypercent.fm

Installing

$ composer require jeffochoa/factory-stories

If you are using Laravel 5.4 or lower, add the service provider to the app.php file:

FactoryStories\Providers\StoryFactoryServiceProvider::class

On Laravel 5.5+, the provider will be discovered automatically.

The problem

Let's say you have to do some tests over articles created with certain conditions like:

// Active articles, from Active Users, with tags attached

You may end creating something like

$user = factory(User::class)->states('active');
$tags = factory(Taxonomy::class, 3)->states('tag')->create();
$article = factory(Article::class)->create([
    user_id => $user->id
]);
$article->tags()->attach($tags->pluck('id')->toArray());

... or something like that.

Of course, you can always extract this to its own method in a helper class, but sometimes you may want to have each of these kinds of "stories" in its own class, even more when you need to add some extra methods to generate more complex data.

Creating new Factory Stories

After installing this package, you'll have access to a new artisan command

$ php artisan make:factory-story SomeClassName

After you run this command you should see the new file under the "database/" directory

<?php

use App\Models\User;
use FactoryStories\FactoryStory;

class TestStory extends FactoryStory
{
    public function build($params = [])
    {
        // here you can add your complex model factories with their relationships
        return factory(User::class)->create();
    }

    // and You can add custom methods if You need to
}

Using Factory Stories

Consider this UserTestClass.php

<?php

namespace Tests\Feature;

use Tests\TestCase;
use Illuminate\Foundation\Testing\WithoutMiddleware;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;

class ManageUsersTest extends TestCase
{
    use DatabaseMigrations;

    /** @test **/
    public function your_test_method()
    {
         //
    }

}

You just need to create a new instance of the Story Class and call the create() method on it

<?php

namespace Tests\Feature;

use Tests\TestCase;
use Illuminate\Foundation\Testing\WithoutMiddleware;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;

class ManageUsersTest extends TestCase
{
    use DatabaseMigrations;

    /** @test **/
    public function your_test_method()
    {
         $article = (new ActiveUserArticleWithTags)
            ->times(5)->create();
    }
}

This will return a collection of 5 items with the object that you return in the build() method of the custom story class.

Laravel 5.4 includes "Real time facades", this allows you to use the Story Class as a facade as well just by adding the use Facades\{YourClassName} at the top of your file

<?php

namespace Tests\Feature;

use Tests\TestCase;
use Facades\ActiveUserArticleWithTags;
use Illuminate\Foundation\Testing\WithoutMiddleware;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;

class ManageUsersTest extends TestCase
{
    use DatabaseMigrations;

    /** @test **/
    public function your_test_method()
    {
         $article = ActiveUserArticleWithTags::times(5)->create();
    }
}