NAME

Test::Stream::Plugin::Subtest - Tools for writing subtests

DESCRIPTION

This package exports subs that let you write subtests.

There are 2 types of subtests, buffered and streamed. Streamed subtests mimick subtest from Test::More in that they render all events as soon as they are produced. Buffered subtests wait until the subtest completes before rendering any results.

The main difference is that streamed subtests are unreadable when combined with concurrency. Buffered subtests look fine with any number of concurrent threads and processes.

SYNOPSIS

    use Test::Stream qw/Subtest/;

    subtest foo => sub {
        ...
    };

STREAMED

The default option is 'buffered', use this if you want streamed, the way Test::Builder does it.

    # You can use either of the next 2 lines, they are both equivilent
    use Test::Stream Subtest => ['streamed'];
    use Test::Stream::Plugin::Subtest qw/streamed/;

    subtest my_test => sub {
        ok(1, "subtest event A");
        ok(1, "subtest event B");
    };

This will produce output like this:

    # Subtest: my_test
        ok 1 - subtest event A
        ok 2 - subtest event B
        1..2
    ok 1 - Subtest: my_test

BUFFERED

    # You can use either of the next 2 lines, they are both equivilent
    use Test::Stream Subtest => ['buffered'];
    use Test::Stream::Plugin::Subtest qw/buffered/;

    subtest my_test => sub {
        ok(1, "subtest event A");
        ok(1, "subtest event B");
    };

This will produce output like this:

    ok 1 - my_test {
        ok 1 - subtest event A
        ok 2 - subtest event B
        1..2
    }

BOTH

    use Test::Stream::Plugin::Subtest qw/subtest_streamed subtest_buffered/;

    subtest_streamed my_streamed_test => sub {
        ok(1, "subtest event A");
        ok(1, "subtest event B");
    };

    subtest_buffered my_buffered_test => sub {
        ok(1, "subtest event A");
        ok(1, "subtest event B");
    };

This will produce the following output:

    # Subtest: my_test
        ok 1 - subtest event A
        ok 2 - subtest event B
        1..2
    ok 1 - Subtest: my_test

    ok 2 - my_test {
        ok 1 - subtest event A
        ok 2 - subtest event B
        1..2
    }

IMPORTANT NOTE

You can use bail_out or skip_all in a subtest, but not in a BEGIN block or use statement. This is due to the way flow control works within a begin block. This is not normally an issue, but can happen in rare conditions using eval, or script files as subtests.

EXPORTS

subtest_streamed $name => $sub

subtest_streamed($name, $sub, @args)

Run subtest coderef, stream events as they happen.

subtest_buffered $name => $sub

subtest_buffered($name, $sub, @args)

Run subtest coderef, render events all at once when subtest is complete.

SOURCE

The source code repository for Test::Stream can be found at http://github.com/Test-More/Test-Stream/.

MAINTAINERS

Chad Granum <exodist@cpan.org>

AUTHORS

Chad Granum <exodist@cpan.org>

COPYRIGHT

Copyright 2015 Chad Granum <exodist7@gmail.com>.

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

See http://www.perl.com/perl/misc/Artistic.html

cpanm Test::Stream

perl -MCPAN -e shell
install Test::Stream