ESSENTIALS¶

tests NAME => sub { ... }

tests NAME => \%params, sub { ... }

tests($NAME, \%PARAMS, \&CODE)

it NAME => sub { ... }

it NAME => \%params, sub { ... }

it($NAME, \%PARAMS, \&CODE)

This defines a test block. Test blocks are essentially subtests. All test blocks will be run, and are expected to produce events. Test blocks can run multiple times if the case() function is also used.

it() is an alias to tests().

These ARE NOT inherited by nested describe blocks.

case NAME => sub { ... }

case NAME => \%params, sub { ... }

case($NAME, \%PARAMS, \&CODE)

This lets you specify multiple conditions in which the test blocks should be run. Every test block within the same group ("describe") will be run once per case.

These ARE NOT inherited by nested describe blocks, but nested describe blocks will be executed once per case.

before_each NAME => sub { ... }

before_each NAME => \%params, sub { ... }

before_each($NAME, \%PARAMS, \&CODE)

Specify a codeblock that should be run multiple times, once before each tests() block is run. These will run AFTER case() blocks but before tests() blocks.

These ARE inherited by nested describe blocks.

before_case NAME => sub { ... }

before_case NAME => \%params, sub { ... }

before_case($NAME, \%PARAMS, \&CODE)

Same as before_each(), except these blocks run BEFORE case() blocks.

These ARE NOT inherited by nested describe blocks.

before_all NAME => sub { ... }

before_all NAME => \%params, sub { ... }

before_all($NAME, \%PARAMS, \&CODE)

Specify a codeblock that should be run once, before all the test blocks run.

These ARE NOT inherited by nested describe blocks.

around_each NAME => sub { ... }

around_each NAME => \%params, sub { ... }

around_each($NAME, \%PARAMS, \&CODE)

Specify a codeblock that should wrap around each test block. These blocks are run AFTER case blocks, but before test blocks.

    around_each wrapit => sub {
        my $cont = shift;
        local %ENV = ( ... );
        $cont->();
        ...
    };
    

The first argument to the codeblock will be a callback that MUST be called somewhere inside the sub in order for nested items to run.

These ARE inherited by nested describe blocks.

around_case NAME => sub { ... }

around_case NAME => \%params, sub { ... }

around_case($NAME, \%PARAMS, \&CODE)

Same as "around_each" except these run BEFORE case blocks.

These ARE NOT inherited by nested describe blocks.

around_all NAME => sub { ... }

around_all NAME => \%params, sub { ... }

around_all($NAME, \%PARAMS, \&CODE)

Same as "around_each" except that it only runs once to wrap ALL test blocks.

These ARE NOT inherited by nested describe blocks.

after_each NAME => sub { ... }

after_each NAME => \%params, sub { ... }

after_each($NAME, \%PARAMS, \&CODE)

Same as "before_each" except it runs right after each test block.

These ARE inherited by nested describe blocks.

after_case NAME => sub { ... }

after_case NAME => \%params, sub { ... }

after_case($NAME, \%PARAMS, \&CODE)

Same as "after_each" except it runs right after the case block, and before the test block.

These ARE NOT inherited by nested describe blocks.

after_all NAME => sub { ... }

after_all NAME => \%params, sub { ... }

after_all($NAME, \%PARAMS, \&CODE)

Same as "before_all" except it runs after all test blocks have been run.

These ARE NOT inherited by nested describe blocks.

SHORTCUTS¶

These are shortcuts. Each of these is the same as tests() except some parameters are added for you.

These are NOT exported by default/.

mini NAME => sub { ... }

Same as:

    tests NAME => { flat => 1 }, sub { ... }
    

iso NAME => sub { ... }

Same as:

    tests NAME => { iso => 1 }, sub { ... }
    

miso NAME => sub { ... }

Same as:

    tests NAME => { mini => 1, iso => 1 }, sub { ... }
    

async NAME => sub { ... }

Same as:

    tests NAME => { async => 1 }, sub { ... }
    

Note: This conflicts with the async() exported from threads. Don't import both.

masync NAME => sub { ... }

Same as:

    tests NAME => { minit => 1, async => 1 }, sub { ... }
    

CUSTOM ATTRIBUTE DEFAULTS¶

Sometimes you want to apply default attributes to all tests() or case() blocks. This can be done, and is lexical to your describe or package root!

    use Test2::Bundle::Extended;
    use Test2::Tools::Spec ':ALL';
    # All 'tests' blocks after this declaration will have C<<iso => 1>> by default
    spec_defaults tests => (iso => 1);
    tests foo => sub { ... }; # isolated
    tests foo, {iso => 0}, sub { ... }; # Not isolated
    spec_defaults tests => (iso => 0); # Turn it off again

Defaults are inherited by nested describe blocks. You can also override the defaults for the scope of the describe:

    spec_defaults tests => (iso => 1);
    describe foo => sub {
        spec_defaults tests => (async => 1); # Scoped to this describe and any child describes
        tests bar => sub { ... }; # both iso and async
    };
    tests baz => sub { ... }; # Just iso, no async.

You can apply defaults to any type of blocks:

    spec_defaults case => (iso => 1); # All cases are 'iso';

Defaults are not inherited when a builder's return is captured.

    spec_defaults tests => (iso => 1);
    # Note we are not calling this in void context, that is the key here.
    my $d = describe foo => {
        tests bar => sub { ... }; # Not iso
    };