Test2::Event::Ok

(source, CPAN)

version 1.302073

You are viewing the version of this documentation from Perl 5.26.3. View the latest version

#NAME

Test2::Event::Ok - Ok event type

#DESCRIPTION

Ok events are generated whenever you run a test that produces a result. Examples are ok(), and is().

use Test2::API qw/context/;
use Test2::Event::Ok;

my $ctx = context();
my $event = $ctx->ok($bool, $name, \@diag);

or:

my $ctx   = context();
my $event = $ctx->send_event(
    'Ok',
    pass => $bool,
    name => $name,
);

#$rb = $e->pass: The original true/false value of whatever was passed into the event (but reduced down to 1 or 0).
#$name = $e->name: Name of the test.
#$b = $e->effective_pass: This is the true/false value of the test after TODO and similar modifiers are taken into account.
#$b = $e->allow_bad_name: This relaxes the test name checks such that they allow characters that can confuse a TAP parser.

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

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

See http://dev.perl.org/licenses/