Test2::Formatter(3p) Perl Programmers Reference Guide Test2::Formatter(3p) #

Test2::Formatter(3p) Perl Programmers Reference Guide Test2::Formatter(3p)

NNAAMMEE #

 Test2::Formatter - Namespace for formatters.

DDEESSCCRRIIPPTTIIOONN #

 This is the namespace for formatters. This is an empty package.

CCRREEAATTIINNGG FFOORRMMAATTTTEERRSS #

 A formatter is any package or object with a "write($event, $num)" method.

     package Test2::Formatter::Foo;
     use strict;
     use warnings;

     sub write {
         my $self_or_class = shift;
         my ($event, $assert_num) = @_;
         ...
     }

     sub hide_buffered { 1 }

     sub terminate { }

     sub finalize { }

     sub supports_tables { return $BOOL }

     sub new_root {
         my $class = shift;
         ...
         $class->new(@_);
     }

     1;

 The "write" method is a method, so it either gets a class or instance.
 The two arguments are the $event object it should record, and the
 $assert_num which is the number of the current assertion (ok), or the
 last assertion if this event is not itself an assertion. The assertion
 number may be any integer 0 or greater, and may be undefined in some
 cases.

 The "hide_buffered()" method must return a boolean. This is used to tell
 buffered subtests whether or not to send it events as they are being
 buffered.  See "run_subtest(...)" in Test2::API for more information.

 The "terminate" and "finalize" methods are optional methods called that
 you can implement if the format you're generating needs to handle these
 cases, for example if you are generating XML and need close open tags.

 The "terminate" method is called when an event's "terminate" method
 returns true, for example when a Test2::Event::Plan has a 'skip_all'
 plan, or when a Test2::Event::Bail event is sent. The "terminate" method
 is passed a single argument, the Test2::Event object which triggered the
 terminate.

 The "finalize" method is always the last thing called on the formatter,
 _e_x_c_e_p_t _w_h_e_n _"_t_e_r_m_i_n_a_t_e_" _i_s _c_a_l_l_e_d _f_o_r _a _B_a_i_l _e_v_e_n_t. It is passed the
 following arguments:

 The "supports_tables" method should be true if the formatter supports
 directly rendering table data from the "info" facets. This is a newer
 feature and many older formatters may not support it. When not supported
 the formatter falls back to rendering "detail" instead of the "table"
 data.

 The "new_root" method is used when constructing a root formatter. The
 default is to just delegate to the regular "new()" method, most
 formatters can ignore this.

 •   The number of tests that were planned

 •   The number of tests actually seen

 •   The number of tests which failed

 •   A boolean indicating whether or not the test suite passed

 •   A boolean indicating whether or not this call is for a subtest

 The "new_root" method is called when "Test2::API::Stack" Initializes the
 root hub for the first time. Most formatters will simply have this call
 "$class->new", which is the default behavior. Some formatters however may
 want to take extra action during construction of the root formatter, this
 is where they can do that.

SSOOUURRCCEE #

 The source code repository for Test2 can be found at
 _h_t_t_p_:_/_/_g_i_t_h_u_b_._c_o_m_/_T_e_s_t_-_M_o_r_e_/_t_e_s_t_-_m_o_r_e_/.

MMAAIINNTTAAIINNEERRSS #

 Chad Granum <exodist@cpan.org>

AAUUTTHHOORRSS #

 Chad Granum <exodist@cpan.org>

CCOOPPYYRRIIGGHHTT #

 Copyright 2020 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 _h_t_t_p_:_/_/_d_e_v_._p_e_r_l_._o_r_g_/_l_i_c_e_n_s_e_s_/

perl v5.36.3 2023-02-15 Test2::Formatter(3p)