-
-
04 Mar 2022 23:08:25 UTC
- Distribution: Test-Simple
- Module version: 1.302190
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Repository
- Issues (5)
- Testers (1091 / 0 / 0)
- Kwalitee
Bus factor: 9- % Coverage
- License: perl_5
- Perl: v5.6.2
- Activity
24 month- Tools
- Download (325.69KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
NAME
Test2::Formatter - Namespace for formatters.
DESCRIPTION
This is the namespace for formatters. This is an empty package.
CREATING FORMATTERS
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
andfinalize
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'sterminate
method returns true, for example when a Test2::Event::Plan has a'skip_all'
plan, or when a Test2::Event::Bail event is sent. Theterminate
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, except whenterminate
is called for a Bail event. It is passed the following arguments:The
supports_tables
method should be true if the formatter supports directly rendering table data from theinfo
facets. This is a newer feature and many older formatters may not support it. When not supported the formatter falls back to renderingdetail
instead of thetable
data.The
new_root
method is used when constructing a root formatter. The default is to just delegate to the regularnew()
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 whenTest2::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.SOURCE
The source code repository for Test2 can be found at http://github.com/Test-More/test-more/.
MAINTAINERS
AUTHORS
COPYRIGHT
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 http://dev.perl.org/licenses/
Module Install Instructions
To install Test::Simple, copy and paste the appropriate command in to your terminal.
cpanm Test::Simple
perl -MCPAN -e shell install Test::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.