khepin/yaml-fixtures-bundle

Symfony bundle for easy loading of YAML based fixtures.

Wednesday, July 26, 2017
by Khepin
Repository
6 Watchers
59 Stars
109,251 Installations

PHP
3 Dependents
0 Suggesters
42 Forks
18 Open issues
19 Versions
4 % Grown

The README.md

This bundles provides you with a way to use YAML based fixtures for Symfony2 and Doctrine2. It currently works with either Doctrine ORM or Doctrine MongoDB ODM. Other backend are not implemented yet but can be implemented very easily., _(*1)

Travic CI status: Scrutinizer CI: , _(*2)

Installation

This bundle depends on the DoctrineFixturesBundle. If you don't have configured it with Symfony2 yet, follow the setup instructions., _(*3)

Through Composer, add to composer.json:, _(*4)

"require": {
    "khepin/yaml-fixtures-bundle": "~1.0.1"
}

Then register the bundle in AppKernel.php it's better to only register it in the dev environment as it shouldn't be needed elsewhere., _(*5)

public function registerBundles()
{
    if (in_array($this->getEnvironment(), array('dev', 'test'))) {
        //...
        $bundles[] = new Khepin\YamlFixturesBundle\KhepinYamlFixturesBundle();
        //...
    }
}

Configuration

In your config.yml or config_dev.yml (recommended) add the following:, _(*6)

khepin_yaml_fixtures:
    resources:
        - MyOtherBundle/load_this_first
        - MyBundle
        - MyOtherBundle

Under 'resources' is a list of the bundles that have fixtures that you wish to load. The fixtures will be loaded in that order., _(*7)

The MyOtherBundle/load_this_first syntax means that load_this_first.yml will be loaded before The rest of the files in this bundle. This allows to set any specific order for loading fixture files., _(*8)

Define your fixture files

Setup

It is important to note that unlike in Symfony 1.x, the order in which you load your fixtures does matter. There are 2 ways you can manipulate that order:, _(*9)

Via config.yml: specify which bundles have their fixtures loaded first
Via file name: fixture files are loaded in alphabetical order inside of each bundle

By default, fixture files use the bundle hierarchy: MyBundle/DataFixtures/somefixtures.yml., _(*10)

If you want to change the hierarchy fixtures use, specify it in your configuration:, _(*11)

khepin_yaml_fixtures:
    directory: Resources/fixtures

This will cause your fixture files to use the bundle hierarchy: MyBundle/Resources/fixtures/somefixtures.yml., _(*12)

Definition

You can only define fixtures for one class per file. Fixture files are configured at the top level, and defined within the fixtures key. You can name a fixture to be referenced later by supplying a name in the fixtures array., _(*13)

model: Name\Space\MyBundle\Entity\User
tags: [ test, dev, prod ] # optional parameter
save_in_reverse: false # optional parameter
persistence: orm (default)| mongodb # lets you choose if these fixtures should be saved through the orm or through mongodb.
fixtures:
    michael:
        name: Michael
        phonenumber: 8765658
        birthday: "1989-12-12"

You can use references to previously created fixtures by supplying the name:, _(*14)

model: Name\Space\MyBundle\Entity\Car
fixtures:
    audi_a3:
        owner: michael
        since: "2010-12-12"

For MongoDB's reference many, include your references as a list under the corresponding key:, _(*15)

model: Name\Space\Bundle\Document\Car
persistence: mongodb
fixtures:
    audi_a3:
        owners:
            - michael
            - paul
            - angella

You can also define as many files as you want for the same entity. This will be useful when used together with context tags (see below)., _(*16)

Work with dates and times:

Dates need to be set inside quotes. Dates are passed to DateTime, so any string that will work will DateTime will work here. That includes the relative formats like "-1 day", "next month", "1 week ago"., _(*17)

model: Name\Space\MyBundle\Entity\Statistics
fixtures:
    stat-1:
        product: example.org
        date: "2010-12-12" #dates NEED to be set inside quotes

Mongo embedded documents

It's possible to use embedded documents in mongo (only embed_one is implemented at this time). Just keep cascading your yaml file like this:, _(*18)

model: Name\Space\Bundle\Document\Article
persistence: mongodb
fixtures:
    first_post:
        title: Ouelkom to my niew blog!
        content: I will update regularly!
        author: # This defines an embedded document
            name: khepin # this will be set on the embedded document

Usage

From the command line

php app/console khepin:yamlfixtures:load <context>

More later regarding contexts, there is no need to add a context unless you have a reason to., _(*19)

ATTENTION: the command line can only load one context at a time for now., _(*20)

From anywhere else

If you need to load the fixtures from anywhere else like say ... your functional tests in order to setup a clean database for testing, you can access the same thing through the service container with the added advantage of being able to load multiple contexts together:, _(*21)

$container->get('khepin.yaml_loader')->loadFixtures('prod', 'test', ...);

About contexts

Sometimes when setting up fixtures for testing purpose, you need to have different configurations. This is what the context aims to help solving., _(*22)

The contexts are equivalent to the tags set in the fixture file under the tag key. You can set as many tags as you want on a fixture file. Such as prod, test etc..., _(*23)

If you define fixtures in this way, then from the command line, calling:, _(*24)

php app/console khepin:yamlfixtures:load prod

All the fixture files for which you have set:, _(*25)

tags: [ ..., prod, ... ]

Will be loaded. This way you can define fixtures that are loaded whenever you use a test or dev environment but are not loaded in prod for example., _(*26)

A fixture file with no tags at all is always loaded! This way you can setup your bootstrapping fixtures in files that have absolutely no tags and then have fixtures specific for each purpose., _(*27)

And what the heck is this "save_in_reverse" thingy?

This parameter can be omitted most of the time. It's only useful so far when you have a self referencing table. For example if you had fixtures like this:, _(*28)

fixtures:
    last_level:
        next_level: none
        name: Meet the boss
    middle_level:
        next_level: last_level
        name: complete the quest
    start_level:
        next_level: middle_level
        name: introduction

In this case, we need to put last_level first in our fixtures since it's the only one that doesn't reference anything else. We could not create start_level first because it needs middle_level to already exist etc..., _(*29)

The problem with this is that when purging the database, the ORMPurger() goes through rows one by one ordered by their ids. So if we save them in this order, last_level should be the first to go away which will cause a problems with foreign keys as it is still referenced by middle_level., _(*30)

Save in reverse will create the objects in this order so the references are set properly and then save them in the opposite order so there is no exception when purging the database., _(*31)

Handling ORM One-To-Many or Many-To-Many Associations

If you want to pass an array of already created objects to a *-To-Many assocation, you can do this by first allowing your setter on the object to accept a plain PHP array (as opposed to only accepting a Doctrine\Common\ArrayCollection) and then define your YAML file as follows:, _(*32)

fixtures:
    car:
        name: foo_bar
        parts:
            - part_one
            - part_two
            - part_three

This is assuming of course that part_one, part_two, and part_three are objects you already defined in previously loaded files., _(*33)

The YAML loader will create a plain PHP array of the three objects and pass it to, for example, setParts() on the model you are defining in this file., _(*34)

Constructor

If you want to pass arguments to a constructor :, _(*35)

fixtures:
    car:
        __construct:
            - Ford
            - {type: reference , value: owner_ford}
            - {type: datetime, value: "2012-01-01"}

class Car
{
    /**
     * @param string $name
     * @param Owner $owner
     * @param DateTime $purchaseDate
     */
    public function __construct($name, Owner $owner, \DateTime $purchaseDate, )
    {
        ...
    }
}

Service calls

Some entities require being managed by a special service before they can be persisted. This is the case with FOSUserBundle for example where the right password is set by the user_manager and not directly in the user class. Therefore we need to ask this service to set our domain object in the correct state before it can be persisted. Service calls are declared this way:, _(*36)

model: My\NameSpace\User
service_calls:
    service_1:
        service: fos_user.user_manager # this is the service id in the container
        method: updateUser # the method to be called on the object
fixtures:
  dad:
    name: Francois
    plain_password: thisismypassword

Now for each user, before it is persisted, something equivalent to the following code will happen:, _(*37)

$container->get('fos_user.user_manager')->updateUser($user_francois);

Using ACLs

If you need to set ACL entries on your fixtures, it is possible. The ACLs are created after all fixtures have been saved so that there is no possible conflict., _(*38)

To set ACLs for the fixtures, you need to be using ProblematicAclManagerBundle., _(*39)

And to update your configuratin as follows:, _(*40)

khepin_yaml_fixtures:
    acl_manager: ~
    resources:
        - MyBundle
        - MyOtherBundle

The ACLs can only use the standard defined masks from the Symfony MaskBuilder. Example:, _(*41)

model: My\NameSpace\Car
tags: [ test ]
fixtures:
  dad_car:
    name: Mercedes
  mom_car:
    name: Mini Cooper

acl:
  dad_car:
    user_dad: MASK_OWNER
    user_mom: MASK_MASTER
  mom_car:
    user_mom: MASK_OWNER

Be careful that the ACLs in Symfony are not managed through Doctrine and therefore will not be purged when you re-create your fixtures. However if any conflicts, loading the ACLs will overwrite all previous ACL entries., _(*42)

The Versions

26/07 2017

dev-master

9999999-dev https://github.com/khepin/KhepinYamlFixturesBundle

Symfony bundle for easy loading of YAML based fixtures.

symfony-bundle yaml-fixtures-bundle

Symfony bundle for easy loading of YAML based fixtures.

khepin/yaml-fixtures-bundle

The README.md

Installation

Configuration

Define your fixture files

Setup

Definition

Work with dates and times:

Mongo embedded documents

Usage

From the command line

From anywhere else

About contexts

And what the heck is this "save_in_reverse" thingy?

Handling ORM One-To-Many or Many-To-Many Associations

Constructor

Service calls

Using ACLs

The Versions

dev-master

The Requires

The Development Requires

by Sébastien Armand

dev-test-branch

The Requires

The Development Requires

by Sébastien Armand

1.0.2

The Requires

The Development Requires

by Sébastien Armand

1.0.1

The Requires

The Development Requires

by Sébastien Armand

1.0.0

The Requires

The Development Requires

by Sébastien Armand

v0.8.1

The Requires

The Development Requires

by Sébastien Armand

v0.8.0

The Requires

The Development Requires

by Sébastien Armand

v0.7.1

The Requires

The Development Requires

by Sébastien Armand

v0.7

The Requires

The Development Requires

by Sébastien Armand

v0.6.2

The Requires

The Development Requires

by Sébastien Armand

v0.6.1

The Requires

The Development Requires

by Sébastien Armand

v0.6.0

The Requires

The Development Requires

by Sébastien Armand

v0.5.2

The Requires

The Development Requires

by Sébastien Armand

v0.5.1

The Requires

The Development Requires

by Sébastien Armand

v0.5.0

The Requires

The Development Requires