Factory States For Clean And Fluent Laravel Testing

In my previous article, I had explained why should we use Laravel factories. You can check the article at Factories To Speed Up Test-Driven Development In Laravel.

In this article let's see how we can use Factory states to write fluent test cases.

---

Without Factory States

First, let's see how does our test cases looks like without any factory states.

Basically, we are writing a test to check that the user cannot view any unpublished blog posts.

tests / Feature / PostsTest.php

/**
* @test
*/
public function user_cannot_view_unpublished_post()
{
    $post = factory(Post::class)->create([
        'published_at'  => null
    ]);
    $resource = $this->get("/posts/" . $post->slug);

    $resource->assertStatus(404);
}

database / factories / PostFactory.php

use App\Post;
use App\User;
use Carbon\Carbon;
use Illuminate\Support\Str;
use Faker\Generator as Faker;

$factory->define(Post::class, function (Faker $faker) {
    return [
        'title'         => 'My first blog',
        'slug'          => Str::slug('My first blog'),
        'summary'       => 'First blog summary',
        'body'          => 'First blog body',
        'author_id'     => function () {
            return factory(User::class)->create()->id;
        },
    ];
});

---

With Factory States

Basically there is no problem with the above approach. Since we can write more cleaner we can use this approach.

From the above code snippet we can write the code

From

$post = factory(Post::class)->create([
    'published_at'  => null
]);

To

$post = factory(Post::class)->states(['unpublished'])->create();

Now your test case will look like the following very lean, clean & fluent

tests / Feature / PostsTest.php

/**
* @test
*/
public function user_cannot_view_unpublished_post()
{
    $post = factory(Post::class)->states(['unpublished'])->create();
    $resource = $this->get("/posts/" . $post->slug);
    $resource->assertStatus(404);
}

database / factories / PostFactory.php

use App\Post;
use App\User;
use Carbon\Carbon;
use Illuminate\Support\Str;
use Faker\Generator as Faker;

$factory->define(Post::class, function (Faker $faker) {
    return [
        'title'         => 'My first blog',
        'slug'          => Str::slug('My first blog'),
        'summary'       => 'First blog summary',
        'body'          => 'First blog body',
        'author_id'     => function () {
            return factory(User::class)->create()->id;
        },
    ];
});

$factory->state(Post::class, 'unpublished', function (Faker $faker) {
    return [
        'published_at' => null
    ];
});

/** Similarly you can have published state too */

$factory->state(Post::class, 'published', function (Faker $faker) {
    return [
        'published_at' => Carbon::parse('-1 week')
    ];
});

---

Conclusion

I hope this article helped you. Please share it with your friends.

Random Articles For You

Upload File From Frontend Server {GuzzleHttp} To REST API Server In PHP {Laravel}

Basic Server Security Setup For Ubuntu / Linux

Comment And Like System Using Disqus

Why namespace And use Keywords Used In PHP

Route Model Binding In Laravel & Change Default Column id To Another Column

Accessors And Mutators In PHP Laravel

Send Email In PHP With PHPMailer

Add Google ADS In AMP (Accelerated Mobile Pages) Website

Automate Repeating Tasks In Linux Server With Cronjobs

Proper Way To Validate MIME Type Of Files While Handling File Uploads In PHP

Firebase Cloud Messaging (FCM) Browser Web Push Notifications Using Javascript And PHP

Securely Connect Server MYSQL DB From Sequel Pro / MYSQL Workbench

Laravel 7.x Multiple Database Connections, Migrations, Relationships & Querying

Client-Side Form Validation With Javascript

Generate SSH Key with ssh-keygen In Linux / Unix