NAME

Test::Stream::Plugin::Intercept - Tool for intercepting test events.

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.

SYNOPSIS

# Load the Intercept plugin, and More since we need that one as well.
use Test::Stream qw/Intercept More/;

my $events = intercept {
    ok(1, 'foo');
    ok(0, 'bar');
};

is(@$events, 2, "intercepted 2 events.");

isa_ok($events->[0], 'Test::Stream::Event::Ok');
ok($events->[0]->pass, "first event passed");

EXPORTS

$events = intercept { ... }

This lets you intercept all events inside the codeblock. All the events will be returned in an arrayref.

my $events = intercept {
    ok(1, 'foo');
    ok(0, 'bar');
};
is(@$events, 2, "intercepted 2 events.");

There are also 2 named parameters passed in, context and hub. The context passed in is a snapshot of the context for the intercept() tool itself, referencing the parent hub. The hub parameter is the new hub created for the intercept run.

my $events = intercept {
    my %params = @_;

    my $outer_ctx = $params{context};
    my $our_hub   = $params{hub};

    ...
};

By default the hub used has no_ending set to true. This will prevent the hub from enforcing that you issued a plan and ran at least 1 test. You can turn enforcement back one like this:

my %params = @_;
$params{hub}->set_no_ending(0);

With no_ending turned off, $hub-finalize()> will run the post-test checks to enforce the plan and that tests were run. In many cases this will result in additional events in your events array.

Note: the $ENV{TS_TERM_SIZE} environment variable is set to 80 inside the intercept block. This is done to ensure consistency for the block across machines and platforms. This is essential for predictable testing of diagnostics, which may render tables or use the terminal size to change behavior.

SEE ALSO

Test::Stream::Plugin::Grab - Similar tool, but allows you to intercept events without adding stack frames.

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