1TAP::Formatter::Base(3pmP)erl Programmers Reference GuidTeAP::Formatter::Base(3pm)
2
3
4

NAME

6       TAP::Formatter::Console - Harness output delegate for default console
7       output
8

VERSION

10       Version 3.17
11

DESCRIPTION

13       This provides console orientated output formatting for TAP::Harness.
14

SYNOPSIS

16        use TAP::Formatter::Console;
17        my $harness = TAP::Formatter::Console->new( \%args );
18

METHODS

20   Class Methods
21       "new"
22
23        my %args = (
24           verbose => 1,
25        )
26        my $harness = TAP::Formatter::Console->new( \%args );
27
28       The constructor returns a new "TAP::Formatter::Console" object. If a
29       TAP::Harness is created with no "formatter" a "TAP::Formatter::Console"
30       is automatically created. If any of the following options were given to
31       TAP::Harness->new they well be passed to this constructor which accepts
32       an optional hashref whose allowed keys are:
33
34       ·   "verbosity"
35
36           Set the verbosity level.
37
38       ·   "verbose"
39
40           Printing individual test results to STDOUT.
41
42       ·   "timer"
43
44           Append run time for each test to output. Uses Time::HiRes if
45           available.
46
47       ·   "failures"
48
49           Show test failures (this is a no-op if "verbose" is selected).
50
51       ·   "comments"
52
53           Show test comments (this is a no-op if "verbose" is selected).
54
55       ·   "quiet"
56
57           Suppressing some test output (mostly failures while tests are
58           running).
59
60       ·   "really_quiet"
61
62           Suppressing everything but the tests summary.
63
64       ·   "silent"
65
66           Suppressing all output.
67
68       ·   "errors"
69
70           If parse errors are found in the TAP output, a note of this will be
71           made in the summary report.  To see all of the parse errors, set
72           this argument to true:
73
74             errors => 1
75
76       ·   "directives"
77
78           If set to a true value, only test results with directives will be
79           displayed.  This overrides other settings such as "verbose",
80           "failures", or "comments".
81
82       ·   "stdout"
83
84           A filehandle for catching standard output.
85
86       ·   "color"
87
88           If defined specifies whether color output is desired. If "color" is
89           not defined it will default to color output if color support is
90           available on the current platform and output is not being
91           redirected.
92
93       ·   "jobs"
94
95           The number of concurrent jobs this formatter will handle.
96
97       ·   "show_count"
98
99           Boolean value.  If false, disables the "X/Y" test count which shows
100           up while tests are running.
101
102       Any keys for which the value is "undef" will be ignored.
103
104       "prepare"
105
106       Called by Test::Harness before any test output is generated.
107
108       This is an advisory and may not be called in the case where tests are
109       being supplied to Test::Harness by an iterator.
110
111       "open_test"
112
113       Called to create a new test session. A test session looks like this:
114
115           my $session = $formatter->open_test( $test, $parser );
116           while ( defined( my $result = $parser->next ) ) {
117               $session->result($result);
118               exit 1 if $result->is_bailout;
119           }
120           $session->close_test;
121
122       "summary"
123
124         $harness->summary( $aggregate );
125
126       "summary" prints the summary report after all tests are run.  The
127       argument is an aggregate.
128
129
130
131perl v5.10.1                      2009-06-12         TAP::Formatter::Base(3pm)
Impressum