/ 
Test-Stream-1.302007
River stage one • 1 direct dependent • 1 total dependent
/ Test::Stream::Subtest

NAME

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

EXPERIMENTAL CODE WARNING

This is an experimental release! Test-Stream, and all its components are still in an experimental phase. This dist has been released to cpan in order to allow testers and early adopters the chance to write experimental new tools with it, or to add experimental support for it into old tools.

PLEASE DO NOT COMPLETELY CONVERT OLD TOOLS YET. This experimental release is very likely to see a lot of code churn. API's may break at any time. Test-Stream should NOT be depended on by any toolchain level tools until the experimental phase is over.

DESCRIPTION

This package exports subs that let you write subtests.

SYNOPSIS

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.

STREAMED

The exported subnames are very verbose, if you are only going to use one it can be helpful to alias it to a shorter name.

use Test::Stream;
use Test::Stream::Subtest 'subtest_streamed=subtest';

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

The exported subnames are very verbose, if you are only going to use one it can be helpful to alias it to a shorter name.

use Test::Stream;
use Test::Stream::Subtest 'subtest_buffered=subtest';

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

This will produce output like this:

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

BOTH

use Test::Stream;
use Test::Stream::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 - Subtest: 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