Fixtures are important part of testing. Their main purpose is to populate you with data that needed by testing
Fixtures are important part of testing. Their main purpose is to populate you with data that needed by testing
different cases. With this data using your tests becoming more efficient and useful.
different cases. With this data using your tests becoming more efficient and useful.
Yii supports database fixtures via the `yii fixture` command line tool. This tool supports:
Yii supports fixtures via the `yii fixture` command line tool. This tool supports:
*Applying new fixtures to database tables;
*Loading new fixtures to different storages like: database, nosql, etc;
*Clearing, database tables (with sequences);
*Unloading fixtures in different ways (usually it is clearing storage);
* Auto-generating fixtures and populating it with random data.
* Auto-generating fixtures and populating it with random data.
Fixtures format
Fixtures format
---------------
---------------
Fixtures are just plain php files returning array. These files are usually stored under `@tests/unit/fixtures` path, but it
Fixtures are objects with different methods and configurations, refer to official [documentation](https://github.com/yiisoft/yii2/blob/master/docs/guide/test-fixture.md) on them.
can be [configured](#configure-command-globally) in other way. Example of fixture file:
Lets assume we have fixtures data to load:
```
```
#users.php file under fixtures path
#users.php file under fixtures data path, by default @tests\unit\fixtures\data
return [
return [
[
[
...
@@ -36,31 +36,34 @@ return [
...
@@ -36,31 +36,34 @@ return [
],
],
];
];
```
```
If we are using fixture that loads data to database then this rows will be applied to `users` table. If we are using nosql fixtures, for example `mongodb`
This data will be loaded to the `users`, but before it will be loaded table `users` will be cleared: all data deleted, sequence reset.
fixture, then this data will be applied to `users` mongodb collection. You can implement different loading strategies and other needed things, for that refer to official [documentation](https://github.com/yiisoft/yii2/blob/master/docs/guide/test-fixture.md).
Above fixture example was auto-generated by `yii2-faker` extension, read more about it in these [section](#auto-generating-fixtures).
Above fixture example was auto-generated by `yii2-faker` extension, read more about it in these [section](#auto-generating-fixtures).
Applying fixtures
Loading fixtures
-----------------
----------------
Fixtures classes should be suffixed by `Fixture` class. By default fixtures will be searched under `tests\unit\fixtures` namespace, you can
change this behavior with config or command options.
To apply fixture to the table, run the following command:
To apply fixture, run the following command:
```
```
yii fixture/apply <tbl_name>
yii fixture/apply <fixture_name>
```
```
The required `tbl_name` parameter specifies a database table to which data will be loaded. You can load data to several tables at once.
The required `fixture_name` parameter specifies a fixture name which data will be loaded. You can load several fixtures at once.
Below are correct formats of this command:
Below are correct formats of this command:
```
```
// apply fixtures to the "users" table of database
// apply `users` fixture
yii fixture/apply users
yii fixture/apply Users
// same as above, because default action of "fixture" command is "apply"
// same as above, because default action of "fixture" command is "apply"
yii fixture users
yii fixture Users
// apply several fixtures to several tables. Note that there should not be any whitespace between ",", it should be one string.
// apply several fixtures. Note that there should not be any whitespace between ",", it should be one string.
yii fixture users,users_profiles
yii fixture Users,UsersProfiles
// apply all fixtures
// apply all fixtures
yii fixture/apply all
yii fixture/apply all
...
@@ -68,29 +71,37 @@ yii fixture/apply all
...
@@ -68,29 +71,37 @@ yii fixture/apply all
// same as above
// same as above
yii fixture all
yii fixture all
// apply fixtures to the table users, but fixtures will be taken from different path.
// apply Users fixture, but fixture will be taken from different path.