View on
Curtis "Ovid" Poe > DBIx-Class-EasyFixture > DBIx::Class::EasyFixture



Annotate this POD


View/Report Bugs
Module Version: 0.12   Source  


DBIx::Class::EasyFixture - Easy fixtures with DBIx::Class


version 0.12


    package My::Fixtures;
    use Moose;
    extends 'DBIx::Class::EasyFixture';

    sub get_fixture       { ... }
    sub all_fixture_names { ... }

And in your test code:

    my $fixtures    = My::Fixtures->new( { schema => $schema } );
    my $dbic_object = $fixtures->load('some_fixture');

    # run your tests


Note that unload will be called for you if your fixture object falls out of scope.


The latest version of this is always at

This is ALPHA code. Documentation is on its way, including a tutorial. For now, you'll have to read the tests. You can read t/lib/My/ to see how fixtures are defined.

I wanted an easier way to load fixtures for DBIx::Class code. I looked at DBIx::Class::Fixtures and it made a lot of assumptions that, while appropriate for some, is not what I wanted (such as the necessity of storing fixtures in JSON files), and had a reliance on knowing the values of primary keys, I wrote this to make it easier to define and load DBIx::Class fixtures for tests.



    my $fixtures = Subclass::Of::DBIx::Class::EasyFixture->new({
        schema => $dbix_class_schema_instance,

This creates and returns a new instance of your DBIx::Class::EasyFixture subclass. All fixture definitions are validated at this time and the constructor will croak() with a useful error message upon validation failure.


    my @fixture_names = $fixtures->all_fixture_names;

Must overridden in your subclass. Should return a list (not an array ref!) of all fixture names available. This is used internally to generate error messages if a fixture attempts to reference a non-existent fixture in its next or requires section.


    my $definition = $fixtures->get_definition($fixture_name);

Must be overridden in a subclass. Should return the fixture definition for the fixture name passed in. Should return undef if the fixture is not found.


    my $dbic_result_object = $fixtures->get_result($fixture_name);

Returns the DBIx::Class::Result object for the given fixture name. Will carp if the fixture wasn't loaded (this may become a fatal error in future versions).


    my @dbic_objects = $fixtures->load(@list_of_fixture_names);

Attempts to load all fixtures passed to it. If a transaction has not already been started, it will be started now. This method may be called multiple times and it returns the fixtures loaded. If called in scalar context, only returns the first fixture loaded.



Rolls back the transaction started with load


    if ( $fixtures->is_loaded($fixture_name) ) {

Returns a boolean value indicating whether or not the given fixture was loaded.

*Note*: Originally this method was called fixture_loaded. That was a bad name. However, fixture_loaded still works as an alias to is_loaded.


If you attempt to load a fixture, a transaction is started and it will be rolled back when you call unload() or when the fixture object falls out of scope. If, for some reason, you do not want transactions (for example, if you need to controll them manually), you can use a true value with the no_transactions argument.

    my $fixtures = My::Fixtures->new(
        schema          => $schema,
        no_transactions => 1,


If the following is unclear, see DBIx::Class::EasyFixture::Tutorial.

The get_definition($fixture_name) method must always return a fixture definition. The definition must be either a fixture group or a fixture builder.

A fixture group is an array reference containing a list of fixture names. For example, $fixture->get_definition('all_people') might return:

    [qw/ person_1 person_2 person_2 /]

A fixture builder must return a hash reference with the one or more of the following keys:

When writing a fixture builder, remember that requires are always built before the current fixture and next is also built after the current fixture.


See DBIx::Class::EasyFixture::Tutorial.


Curtis "Ovid" Poe, <ovid at>



Curtis "Ovid" Poe <>


This software is copyright (c) 2014 by Curtis "Ovid" Poe.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: