manageitwa / laravel-fixtures
Loads fake data sets into Laravel for testing.
Requires
- php: 7.4.*|^8.0
- illuminate/database: ~5.5|^6.0|^7.0|^8.0|^9.0|^10.0
- illuminate/support: ~5.5|^6.0|^7.0|^8.0|^9.0|^10.0
Requires (Dev)
- dms/phpunit-arraysubset-asserts: ^0.5.0
- friendsofphp/php-cs-fixer: ^2.0|^3.0
- orchestra/testbench: ~3.5.0|^4.0|^5.0|^6.0|^7.0|^8.0
- phpunit/phpunit: ~9.0
This package is auto-updated.
Last update: 2024-10-17 03:34:36 UTC
README
Laravel Fixtures Package
Fixtures are used to load a "fake" set of data into a database that can then be used for testing or to help give you some interesting data while you're developing your application.
A fixture may depend on other fixtures, specified via its CorpSoft\Fixture\Fixture::$depends
property. When a fixture is being loaded, the fixtures it depends on will be automatically loaded BEFORE the fixture; and when the fixture is being unloaded, the dependent fixtures will be unloaded AFTER the fixture.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist manageitwa/laravel-fixtures "*"
or add
"manageitwa/laravel-fixtures": "*"
to the require section of your composer.json
file.
Defining a Fixture
To define a fixture, create a new class by extending CorpSoft\Fixture\ActiveFixture
.
The following code defines a fixture about the User
Illuminate\Database\Eloquent\Model and the corresponding users table.
<?php namespace Fixtures; use CorpSoft\Fixture\ActiveFixture; use App\Models\User; class UserFixture extends ActiveFixture { /** * @var string */ public $dataFile = 'fixtures/users.php'; /** * @var string */ public $modelClass = User::class; }
Tip: Each ActiveFixture is about preparing a DB table for testing purpose. You may specify the table by setting either the CorpSoft\Fixture\ActiveFixture::$table property or the CorpSoft\Fixture\ActiveFixture::$modelClass property. If the latter, the table name will be taken from the Illuminate\Database\Eloquent\Model class specified by modelClass.
The fixture data for an ActiveFixture
fixture is usually provided in a file located at public/storage/fixtures/table_name.php
.
The data file should return an array of data rows to be inserted into the user table. For example:
<?php // public/storage/fixtures/users.php return [ [ 'name' => 'user1', 'email' => 'user1@example.org', 'password' => bcrypt('secret'), ], [ 'name' => 'user2', 'email' => 'user2@example.org', 'password' => bcrypt('secret'), ], ];
As we described earlier, a fixture may depend on other fixtures. For example, a UserProfileFixture
may need to depends on UserFixture
because the user profile table contains a foreign key pointing to the user table. The dependency is specified via the CorpSoft\Fixture\Fixture::$depends
property, like the following:
<?php namespace Fixtures; use CorpSoft\Fixture\ActiveFixture; use App\Models\UserProfile; class UserProfileFixture extends ActiveFixture { /** * @var string */ public $dataFile = 'fixtures/user_profile.php'; /** * @var string */ public $modelClass = UserProfile::class; /** * @var array */ public $depends = [UserFixture::class]; }
The dependency also ensures, that the fixtures are loaded and unloaded in a well defined order. In the above example UserFixture
will always be loaded before UserProfileFixture
to ensure all foreign key references exist and will be unloaded after UserProfileFixture
has been unloaded for the same reason.
Using Fixtures
- If you are using
phpunit
to test your code, then you need to addCorpSoft\Fixture\Traits\FixtureTrait
to abstract classTestCase
in thetests
folder as follows:
<?php namespace Tests; use CorpSoft\Fixture\Traits\FixtureTrait; use Illuminate\Foundation\Testing\TestCase as BaseTestCase; abstract class TestCase extends BaseTestCase { use CreatesApplication, FixtureTrait; /** * @inheritdoc */ protected function setUp() { parent::setUp(); $this->initFixtures(); } }
- If you are using
Laravel Dusk
to test your code, then you need to addCorpSoft\Fixture\Traits\FixtureTrait
to abstract classDuskTestCase
in thetests
folder as follows:
<?php namespace Tests; use CorpSoft\Fixture\Traits\FixtureTrait; use Laravel\Dusk\TestCase as BaseTestCase; abstract class DuskTestCase extends BaseTestCase { use CreatesApplication, FixtureTrait; /** * @inheritdoc */ protected function setUp() { parent::setUp(); $this->initFixtures(); } // other methods }
After this steps you can define fixtures in your test classes as follows:
<?php namespace Tests\Unit; use Tests\TestCase; use Fixtures\UserProfileFixture; class ExampleTest extends TestCase { /** * Declares the fixtures that are needed by the current test case. * * @return array the fixtures needed by the current test case */ public function fixtures(): array { return [ 'profiles' => UserProfileFixture::class, ]; } /** * A basic test example. * * @return void */ public function testBasicTest() { $this->assertTrue(true); } }
The fixtures listed in the fixtures()
method will be automatically loaded before a test is executed.
And as we described before, when a fixture is being loaded, all its dependent fixtures will be automatically loaded first. In the above example, because UserProfileFixture
depends on UserFixture
, when running any test method in the test class, two fixtures will be loaded sequentially: UserFixture
and UserProfileFixture
.