Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

Manual Reference Pages  -  TEST2::EVENT (3)

.ds Aq ’


Test2::Event - Base class for events



This is an experimental release. Using this right now is not recommended.


Base class for all event objects that get passed through Test2.


    package Test2::Event::MyEvent;
    use strict;
    use warnings;

    # This will make our class an event subclass (required)
    use base Test2::Event;

    # Add some accessors (optional)
    # You are not obligated to use HashBase, you can use any object tool you
    # want, or roll your own accessors.
    use Test2::Util::HashBase qw/foo bar baz/;

    # Chance to initialize some defaults
    sub init {
        my $self = shift;
        # no other args in @_

        $self->set_foo(xxx) unless defined $self->foo;




$trace = $e->trace Get a snapshot of the Test2::Util::Trace as it was when this event was generated
$bool = $e->causes_fail Returns true if this event should result in a test failure. In general this should be false.
$bool = $e->increments_count Should be true if this event should result in a test count increment.
$e->callback($hub) If your event needs to have extra effects on the Test2::Hub you can override this method.

This is called <B>BEFOREB> your event is passed to the formatter.

$call = $e->created Get the caller() details from when the event was generated. This is usually inside a tools package. This is typically used for debugging.
$num = $e->nested If this event is nested inside of other events, this should be the depth of nesting. (This is mainly for subtests)
$bool = $e->global Set this to true if your event is global, that is ALL threads and processes should see it no matter when or where it is generated. This is not a common thing to want, it is used by bail-out and skip_all to end testing.
$code = $e->terminate This is called <B>AFTERB> your event has been passed to the formatter. This should normally return undef, only change this if your event should cause the test to exit immedietly.

If you want this event to cause the test to exit you should return the exit code here. Exit code of 0 means exit success, any other integer means exit with failure.

This is used by Test2::Event::Plan to exit 0 when the plan is ’skip_all’. This is also used by Test2::Event:Bail to force the test to exit with a failure.

This is called after the event has been sent to the formatter in order to ensure the event is seen and understood.

$todo = $e->todo
$e->set_todo($todo) Get/Set the todo reason on the event. Any value other than undef makes the event ’TODO’.

Not all events make use of this field, but they can all have it set/cleared.

$bool = $e->diag_todo
$e->diag_todo($todo) True if this event should be considered ’TODO’ for diagnostics purposes. This essentially means that any message that would go to STDERR will go to STDOUT instead so that a harness will hide it outside of verbose mode.


This object consumes Test2::Util::ExternalMeta which provides a consistent way for you to attach meta-data to instances of this class. This is useful for tools, plugins, and other extentions.


The source code repository for Test2 can be found at


Chad Granum <>


Chad Granum <>


Copyright 2015 Chad Granum <>.

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


Search for    or go to Top of page |  Section 3 |  Main Index

perl v5.20.3 TEST2::EVENT (3) 2016-04-01

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.