man pages section 3: Library Interfaces and Headers

Test2::Event::Ok (3)

Name

Test2::Event::Ok - Ok event type

Synopsis

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,
);

Description

Perl Programmers Reference Guide                           Test2::Event::Ok(3)



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()".

SYNOPSIS
           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,
           );

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.

       $b = $e->effective_pass
           This is the true/false value of the test after TODO and similar
           modifiers are taken into account.

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

MAINTAINERS
       Chad Granum <exodist@cpan.org>

AUTHORS
       Chad Granum <exodist@cpan.org>

COPYRIGHT
       Copyright 2019 Chad Granum <exodist@cpan.org>.

       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/



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14               Test2::Event::Ok(3)