Curtis "Ovid" Poe > TAPx-Parser > TAPx::Harness::Compatible::Results

Download:
TAPx-Parser-0.50_07.tar.gz

Dependencies

Annotate this POD

Module Version: 0.50_07   Source  

NAME ^

TAPx::Harness::Compatible::Results - object for tracking results from a single test file

SYNOPSIS ^

One TAPx::Harness::Compatible::Results object represents the results from one test file getting analyzed.

CONSTRUCTION ^

new()

    my $results = new TAPx::Harness::Compatible::Results;

Create a test point object. Typically, however, you'll not create one yourself, but access a Results object returned to you by TAPx::Harness::Compatible::Results.

ACCESSORS ^

The following data points are defined:

  passing           true if the whole test is considered a pass 
                    (or skipped), false if its a failure

  exit              the exit code of the test run, if from a file
  wait              the wait code of the test run, if from a file

  max               total tests which should have been run
  seen              total tests actually seen
  skip_all          if the whole test was skipped, this will 
                      contain the reason.

  ok                number of tests which passed 
                      (including todo and skips)

  todo              number of todo tests seen
  bonus             number of todo tests which 
                      unexpectedly passed

  skip              number of tests skipped

So a successful test should have max == seen == ok.

There is one final item, the details.

  details           an array ref reporting the result of 
                    each test looks like this:

    $results{details}[$test_num - 1] = 
            { ok          => is the test considered ok?
              actual_ok   => did it literally say 'ok'?
              name        => name of the test (if any)
              diagnostics => test diagnostics (if any)
              type        => 'skip' or 'todo' (if any)
              reason      => reason for the above (if any)
            };

Element 0 of the details is test #1. I tried it with element 1 being #1 and 0 being empty, this is less awkward.

Each of the following fields has a getter and setter method.

TO DOCUMENT ^

bonus

TODO: Document bonus

details

TODO: Document details

inc_bonus

TODO: Document inc_bonus

inc_max

TODO: Document inc_max

inc_ok

TODO: Document inc_ok

inc_seen

TODO: Document inc_seen

inc_skip

TODO: Document inc_skip

inc_todo

TODO: Document inc_todo

max

TODO: Document max

ok

TODO: Document ok

passing

TODO: Document passing

seen

TODO: Document seen

set_details

TODO: Document set_details

set_exit

TODO: Document set_exit

set_passing

TODO: Document set_passing

set_skip_all

TODO: Document set_skip_all

set_skip_reason

TODO: Document set_skip_reason

set_wait

TODO: Document set_wait

skip

TODO: Document skip

skip_all

TODO: Document skip_all

skip_reason

TODO: Document skip_reason

todo

TODO: Document todo

syntax highlighting: