TAPx::Harness::Compatible::Results - object for tracking results from a single test file
One TAPx::Harness::Compatible::Results object represents the results from one test file getting analyzed.
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.
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.
wait
exit
TODO: Document bonus
TODO: Document details
TODO: Document inc_bonus
TODO: Document inc_max
TODO: Document inc_ok
TODO: Document inc_seen
TODO: Document inc_skip
TODO: Document inc_todo
TODO: Document max
TODO: Document ok
TODO: Document passing
TODO: Document seen
TODO: Document set_details
TODO: Document set_exit
TODO: Document set_passing
TODO: Document set_skip_all
TODO: Document set_skip_reason
TODO: Document set_wait
TODO: Document skip
TODO: Document skip_all
TODO: Document skip_reason
TODO: Document todo
To install TAPx::Parser, copy and paste the appropriate command in to your terminal.
cpanm
cpanm TAPx::Parser
CPAN shell
perl -MCPAN -e shell install TAPx::Parser
For more information on module installation, please visit the detailed CPAN module installation guide.