local-lib5/man/man3/TAP::Formatter::Base.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "TAP::Formatter::Base 3"
 132 .TH TAP::Formatter::Base 3 "2009-05-05" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 TAP::Formatter::Console \- Harness output delegate for default console output
 135 .SH "VERSION"
 136 .IX Header "VERSION"
 137 Version 3.17
 138 .SH "DESCRIPTION"
 139 .IX Header "DESCRIPTION"
 140 This provides console orientated output formatting for TAP::Harness.
 141 .SH "SYNOPSIS"
 142 .IX Header "SYNOPSIS"
 143 .Vb 2
 144 \& use TAP::Formatter::Console;
 145 \& my $harness = TAP::Formatter::Console\->new( \e%args );
 146 .Ve
 147 .SH "METHODS"
 148 .IX Header "METHODS"
 149 .Sh "Class Methods"
 150 .IX Subsection "Class Methods"
 151 \fI\f(CI\*(C`new\*(C'\fI\fR
 152 .IX Subsection "new"
 153 .PP
 154 .Vb 4
 155 \& my %args = (
 156 \&    verbose => 1,
 157 \& )
 158 \& my $harness = TAP::Formatter::Console\->new( \e%args );
 159 .Ve
 160 .PP
 161 The constructor returns a new \f(CW\*(C`TAP::Formatter::Console\*(C'\fR object. If
 162 a TAP::Harness is created with no \f(CW\*(C`formatter\*(C'\fR a
 163 \&\f(CW\*(C`TAP::Formatter::Console\*(C'\fR is automatically created. If any of the
 164 following options were given to TAP::Harness\->new they well be passed to
 165 this constructor which accepts an optional hashref whose allowed keys are:
 166 .ie n .IP "* ""verbosity""" 4
 167 .el .IP "* \f(CWverbosity\fR" 4
 168 .IX Item "verbosity"
 169 Set the verbosity level.
 170 .ie n .IP "* ""verbose""" 4
 171 .el .IP "* \f(CWverbose\fR" 4
 172 .IX Item "verbose"
 173 Printing individual test results to \s-1STDOUT\s0.
 174 .ie n .IP "* ""timer""" 4
 175 .el .IP "* \f(CWtimer\fR" 4
 176 .IX Item "timer"
 177 Append run time for each test to output. Uses Time::HiRes if available.
 178 .ie n .IP "* ""failures""" 4
 179 .el .IP "* \f(CWfailures\fR" 4
 180 .IX Item "failures"
 181 Show test failures (this is a no-op if \f(CW\*(C`verbose\*(C'\fR is selected).
 182 .ie n .IP "* ""comments""" 4
 183 .el .IP "* \f(CWcomments\fR" 4
 184 .IX Item "comments"
 185 Show test comments (this is a no-op if \f(CW\*(C`verbose\*(C'\fR is selected).
 186 .ie n .IP "* ""quiet""" 4
 187 .el .IP "* \f(CWquiet\fR" 4
 188 .IX Item "quiet"
 189 Suppressing some test output (mostly failures while tests are running).
 190 .ie n .IP "* ""really_quiet""" 4
 191 .el .IP "* \f(CWreally_quiet\fR" 4
 192 .IX Item "really_quiet"
 193 Suppressing everything but the tests summary.
 194 .ie n .IP "* ""silent""" 4
 195 .el .IP "* \f(CWsilent\fR" 4
 196 .IX Item "silent"
 197 Suppressing all output.
 198 .ie n .IP "* ""errors""" 4
 199 .el .IP "* \f(CWerrors\fR" 4
 200 .IX Item "errors"
 201 If parse errors are found in the \s-1TAP\s0 output, a note of this will be made
 202 in the summary report.  To see all of the parse errors, set this argument to
 203 true:
 204 .Sp
 205 .Vb 1
 206 \&  errors => 1
 207 .Ve
 208 .ie n .IP "* ""directives""" 4
 209 .el .IP "* \f(CWdirectives\fR" 4
 210 .IX Item "directives"
 211 If set to a true value, only test results with directives will be displayed.
 212 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.
 213 .ie n .IP "* ""stdout""" 4
 214 .el .IP "* \f(CWstdout\fR" 4
 215 .IX Item "stdout"
 216 A filehandle for catching standard output.
 217 .ie n .IP "* ""color""" 4
 218 .el .IP "* \f(CWcolor\fR" 4
 219 .IX Item "color"
 220 If defined specifies whether color output is desired. If \f(CW\*(C`color\*(C'\fR is not
 221 defined it will default to color output if color support is available on
 222 the current platform and output is not being redirected.
 223 .ie n .IP "* ""jobs""" 4
 224 .el .IP "* \f(CWjobs\fR" 4
 225 .IX Item "jobs"
 226 The number of concurrent jobs this formatter will handle.
 227 .ie n .IP "* ""show_count""" 4
 228 .el .IP "* \f(CWshow_count\fR" 4
 229 .IX Item "show_count"
 230 Boolean value.  If false, disables the \f(CW\*(C`X/Y\*(C'\fR test count which shows up while
 231 tests are running.
 232 .PP
 233 Any keys for which the value is \f(CW\*(C`undef\*(C'\fR will be ignored.
 234 .PP
 235 \fI\f(CI\*(C`prepare\*(C'\fI\fR
 236 .IX Subsection "prepare"
 237 .PP
 238 Called by Test::Harness before any test output is generated.
 239 .PP
 240 This is an advisory and may not be called in the case where tests are
 241 being supplied to Test::Harness by an iterator.
 242 .PP
 243 \fI\f(CI\*(C`open_test\*(C'\fI\fR
 244 .IX Subsection "open_test"
 245 .PP
 246 Called to create a new test session. A test session looks like this:
 247 .PP
 248 .Vb 6
 249 \&    my $session = $formatter\->open_test( $test, $parser );
 250 \&    while ( defined( my $result = $parser\->next ) ) {
 251 \&        $session\->result($result);
 252 \&        exit 1 if $result\->is_bailout;
 253 \&    }
 254 \&    $session\->close_test;
 255 .Ve
 256 .PP
 257 \fI\f(CI\*(C`summary\*(C'\fI\fR
 258 .IX Subsection "summary"
 259 .PP
 260 .Vb 1
 261 \&  $harness\->summary( $aggregate );
 262 .Ve
 263 .PP
 264 \&\f(CW\*(C`summary\*(C'\fR prints the summary report after all tests are run.  The argument is
 265 an aggregate.