diff options
Diffstat (limited to 'upstream/mageia-cauldron/man3pm/TAP::Formatter::Base.3pm')
| -rw-r--r-- | upstream/mageia-cauldron/man3pm/TAP::Formatter::Base.3pm | 197 |
1 files changed, 197 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man3pm/TAP::Formatter::Base.3pm b/upstream/mageia-cauldron/man3pm/TAP::Formatter::Base.3pm new file mode 100644 index 00000000..e386355c --- /dev/null +++ b/upstream/mageia-cauldron/man3pm/TAP::Formatter::Base.3pm @@ -0,0 +1,197 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "TAP::Formatter::Base 3pm" +.TH TAP::Formatter::Base 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH NAME +TAP::Formatter::Base \- Base class for harness output delegates +.SH VERSION +.IX Header "VERSION" +Version 3.44 +.SH DESCRIPTION +.IX Header "DESCRIPTION" +This provides console orientated output formatting for TAP::Harness. +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 2 +\& use TAP::Formatter::Console; +\& my $harness = TAP::Formatter::Console\->new( \e%args ); +.Ve +.SH METHODS +.IX Header "METHODS" +.SS "Class Methods" +.IX Subsection "Class Methods" +\fR\f(CI\*(C`new\*(C'\fR\fI\fR +.IX Subsection "new" +.PP +.Vb 4 +\& my %args = ( +\& verbose => 1, +\& ) +\& my $harness = TAP::Formatter::Console\->new( \e%args ); +.Ve +.PP +The constructor returns a new \f(CW\*(C`TAP::Formatter::Console\*(C'\fR object. If +a TAP::Harness is created with no \f(CW\*(C`formatter\*(C'\fR a +\&\f(CW\*(C`TAP::Formatter::Console\*(C'\fR is automatically created. If any of the +following options were given to TAP::Harness\->new they well be passed to +this constructor which accepts an optional hashref whose allowed keys are: +.IP \(bu 4 +\&\f(CW\*(C`verbosity\*(C'\fR +.Sp +Set the verbosity level. +.IP \(bu 4 +\&\f(CW\*(C`verbose\*(C'\fR +.Sp +Printing individual test results to STDOUT. +.IP \(bu 4 +\&\f(CW\*(C`timer\*(C'\fR +.Sp +Append run time for each test to output. Uses Time::HiRes if available. +.IP \(bu 4 +\&\f(CW\*(C`failures\*(C'\fR +.Sp +Show test failures (this is a no-op if \f(CW\*(C`verbose\*(C'\fR is selected). +.IP \(bu 4 +\&\f(CW\*(C`comments\*(C'\fR +.Sp +Show test comments (this is a no-op if \f(CW\*(C`verbose\*(C'\fR is selected). +.IP \(bu 4 +\&\f(CW\*(C`quiet\*(C'\fR +.Sp +Suppressing some test output (mostly failures while tests are running). +.IP \(bu 4 +\&\f(CW\*(C`really_quiet\*(C'\fR +.Sp +Suppressing everything but the tests summary. +.IP \(bu 4 +\&\f(CW\*(C`silent\*(C'\fR +.Sp +Suppressing all output. +.IP \(bu 4 +\&\f(CW\*(C`errors\*(C'\fR +.Sp +If parse errors are found in the TAP output, a note of this will be made +in the summary report. To see all of the parse errors, set this argument to +true: +.Sp +.Vb 1 +\& errors => 1 +.Ve +.IP \(bu 4 +\&\f(CW\*(C`directives\*(C'\fR +.Sp +If set to a true value, only test results with directives will be displayed. +This overrides other settings such as \f(CW\*(C`verbose\*(C'\fR, \f(CW\*(C`failures\*(C'\fR, or \f(CW\*(C`comments\*(C'\fR. +.IP \(bu 4 +\&\f(CW\*(C`stdout\*(C'\fR +.Sp +A filehandle for catching standard output. +.IP \(bu 4 +\&\f(CW\*(C`color\*(C'\fR +.Sp +If defined specifies whether color output is desired. If \f(CW\*(C`color\*(C'\fR is not +defined it will default to color output if color support is available on +the current platform and output is not being redirected. +.IP \(bu 4 +\&\f(CW\*(C`jobs\*(C'\fR +.Sp +The number of concurrent jobs this formatter will handle. +.IP \(bu 4 +\&\f(CW\*(C`show_count\*(C'\fR +.Sp +Boolean value. If false, disables the \f(CW\*(C`X/Y\*(C'\fR test count which shows up while +tests are running. +.PP +Any keys for which the value is \f(CW\*(C`undef\*(C'\fR will be ignored. +.PP +\fR\f(CI\*(C`prepare\*(C'\fR\fI\fR +.IX Subsection "prepare" +.PP +Called by Test::Harness before any test output is generated. +.PP +This is an advisory and may not be called in the case where tests are +being supplied to Test::Harness by an iterator. +.PP +\fR\f(CI\*(C`open_test\*(C'\fR\fI\fR +.IX Subsection "open_test" +.PP +Called to create a new test session. A test session looks like this: +.PP +.Vb 6 +\& my $session = $formatter\->open_test( $test, $parser ); +\& while ( defined( my $result = $parser\->next ) ) { +\& $session\->result($result); +\& exit 1 if $result\->is_bailout; +\& } +\& $session\->close_test; +.Ve +.PP +\fR\f(CI\*(C`summary\*(C'\fR\fI\fR +.IX Subsection "summary" +.PP +.Vb 1 +\& $harness\->summary( $aggregate ); +.Ve +.PP +\&\f(CW\*(C`summary\*(C'\fR prints the summary report after all tests are run. The first +argument is an aggregate to summarise. An optional second argument may +be set to a true value to indicate that the summary is being output as a +result of an interrupted test run. |