tap::formatter::junit::session(3pm) [debian man page]

TAP::Formatter::JUnit::Session(3pm)			User Contributed Perl Documentation		       TAP::Formatter::JUnit::Session(3pm)

NAME

       TAP::Formatter::JUnit::Session - Harness output delegate for JUnit output

DESCRIPTION

       "TAP::Formatter::JUnit::Session" provides JUnit output formatting for "TAP::Harness".

METHODS

       _initialize($arg_for)
	   Over-ridden private initializer, so we can accept a new "passing_todo_ok" argument at instantiation time.

       result($result)
	   Called by the harness for each line of TAP it receives.

	   Internally, all of the TAP is added to a queue until we hit the start of the "next" test (at which point we flush the queue. This
	   allows us to capture any error output or diagnostic info that comes after a test failure.

       close_test()
	   Called to close the test session.

	   Flushes the queue if we've got anything left in it, dumps the JUnit to disk (if necessary), and adds the XML for this test suite to our
	   formatter.

       dump_junit_xml($testsuite)
	   Dumps the JUnit for the given XML $testsuite, to the directory specified by "PERL_TEST_HARNESS_DUMP_TAP".

       add_testcase($case)
	   Adds an XML test $case to the list of testcases we've run in this session.

       xml()
	   Returns a new "XML::Generator" to generate XML output. This is simply a shortcut to "$self->formatter->xml()".

AUTHOR

       Graham TerMarsch <cpan@howlingfrog.com>

COPYRIGHT

       Copyright 2008-2010, Graham TerMarsch.  All Rights Reserved.

       This is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

       TAP::Formatter::JUnit.

perl v5.14.2							    2012-03-12				       TAP::Formatter::JUnit::Session(3pm)

TAP::Formatter::Base(3pm)				 Perl Programmers Reference Guide				 TAP::Formatter::Base(3pm)

NAME

       TAP::Formatter::Base - Base class for harness output delegates

VERSION

       Version 3.23

DESCRIPTION

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

SYNOPSIS

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

METHODS

   Class Methods
       "new"

	my %args = (
	   verbose => 1,
	)
	my $harness = TAP::Formatter::Console->new( \%args );

       The constructor returns a new "TAP::Formatter::Console" object. If a TAP::Harness is created with no "formatter" a
       "TAP::Formatter::Console" 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:

       o   "verbosity"

	   Set the verbosity level.

       o   "verbose"

	   Printing individual test results to STDOUT.

       o   "timer"

	   Append run time for each test to output. Uses Time::HiRes if available.

       o   "failures"

	   Show test failures (this is a no-op if "verbose" is selected).

       o   "comments"

	   Show test comments (this is a no-op if "verbose" is selected).

       o   "quiet"

	   Suppressing some test output (mostly failures while tests are running).

       o   "really_quiet"

	   Suppressing everything but the tests summary.

       o   "silent"

	   Suppressing all output.

       o   "errors"

	   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:

	     errors => 1

       o   "directives"

	   If set to a true value, only test results with directives will be displayed.  This overrides other settings such as "verbose",
	   "failures", or "comments".

       o   "stdout"

	   A filehandle for catching standard output.

       o   "color"

	   If defined specifies whether color output is desired. If "color" is not defined it will default to color output if color support is
	   available on the current platform and output is not being redirected.

       o   "jobs"

	   The number of concurrent jobs this formatter will handle.

       o   "show_count"

	   Boolean value.  If false, disables the "X/Y" test count which shows up while tests are running.

       Any keys for which the value is "undef" will be ignored.

       "prepare"

       Called by Test::Harness before any test output is generated.

       This is an advisory and may not be called in the case where tests are being supplied to Test::Harness by an iterator.

       "open_test"

       Called to create a new test session. A test session looks like this:

	   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;

       "summary"

	 $harness->summary( $aggregate );

       "summary" 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.

perl v5.16.2							    2012-10-25						 TAP::Formatter::Base(3pm)