/ 
Test-Simple-1.301001_109
River stage five • 24171 direct dependents • 33703 total dependents
/ Test::Stream::Event::Ok

NAME

Test::Stream::Event::Ok - Ok event type

DESCRIPTION

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

SYNOPSIS

use Test::Stream::Context qw/context/;
use Test::Stream::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,
    diag => \@diag
);

ACCESSORS

$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.

$diag = $e->diag

An arrayref with all the Test::Stream::Event::Diag events reduced down to just the messages. Some coaxing has beeen done to combine all the messages into a single string.

$b = $e->effective_pass

This is the true/false value of the test after TODO, SKIP, and similar modifiers are taken into account.

$l = $e->level

For legacy Test::Builder support. Do not use this, it can go away, or change behavior at any time.

METHODS

$le = $e->to_legacy

Returns a hashref that matches some legacy details about ok's. You should probably not use this for anything new.

$e->add_diag($diag_event, "diag message" ...)

Add a diag to the event. The diag may be a diag event, or a simple string.

$diag = $e->clear_diag

Remove all diag events, then return them in an arrayref.

SUMMARY FIELDS

diag

A single string with all the messages from the diags linked to the event.

name

Name of the test.

pass

True/False passed into the test.

effective_pass

True/False value accounting for TODO and SKIP.

SOURCE

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

MAINTAINER

Chad Granum <exodist@cpan.org>

AUTHORS

The following people have all contributed to the Test-More dist (sorted using VIM's sort function).

Chad Granum <exodist@cpan.org>
Fergal Daly <fergal@esatclear.ie>>
Mark Fowler <mark@twoshortplanks.com>
Michael G Schwern <schwern@pobox.com>
唐鳳

COPYRIGHT

There has been a lot of code migration between modules, here are all the original copyrights together:

Test::Stream
Test::Stream::Tester

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

Test::Simple
Test::More
Test::Builder

Originally authored by Michael G Schwern <schwern@pobox.com> with much inspiration from Joshua Pritikin's Test module and lots of help from Barrie Slaymaker, Tony Bowden, blackstar.co.uk, chromatic, Fergal Daly and the perl-qa gang.

Idea by Tony Bowden and Paul Johnson, code by Michael G Schwern <schwern@pobox.com>, wardrobe by Calvin Klein.

Copyright 2001-2008 by Michael G Schwern <schwern@pobox.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

Test::use::ok

To the extent possible under law, 唐鳳 has waived all copyright and related or neighboring rights to Test-use-ok.

This work is published from Taiwan.

http://creativecommons.org/publicdomain/zero/1.0

Test::Tester

This module is copyright 2005 Fergal Daly <fergal@esatclear.ie>, some parts are based on other people's work.

Under the same license as Perl itself

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

Test::Builder::Tester

Copyright Mark Fowler <mark@twoshortplanks.com> 2002, 2004.

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