NAME

Test::TAP::Model::File - an object representing the TAP results of a single test script's output.

SYNOPSIS

        my $f = ( $t->test_files )[0];
        
        if ($f->ok){ # et cetera
                print "happy happy joy joy!";
        }

DESCRIPTION

This is a convenience object, which is more of a library of questions you can ask about the hash structure described in Test::TAP::Model.

It's purpose is to help you query status concisely, probably from a templating kit.

METHODS

Miscelleneous

new

This constructor accepts a hash like you can find in the return value of "structure" in Test::TAP::Model.

It does not bless that structure to stay friendly with others. Instead it blesses a scalar reference to it.

subtest_class

This returns the name of the class used to construct subtest objects using methods like ok_tests.

Predicates About the File

ok

passed

Whether the file as a whole passed

nok

failed

Or failed

skipped

Whether skip_all was done at some point

bailed_out

Whether test bailed out

Misc info

name

The name of the test file.

Methods for Extracting Subtests

cases

subtests

test_cases

seen_tests

seen

In scalar context, a number, in list context, a list of Test::TAP::Model::Subtest objects

This value is somewhat massaged, with stubs created for planned tests which were never reached.

actual_cases

This method returns the same thing as cases and friends, but without the stubs.

max

planned

Just a number, of the expected test count.

ok_tests

passed_tests

Subtests which passed

nok_tests

failed_tests

Duh. Same list/scalar context sensitivity applies.

todo_tests

Subtests marked TODO.

skipped_tests

Test which are vegeterian.

unexpectedly_succeeded_tests

Please tell me you're not really reading these decriptions. The're really only to get the =items sepeared in whatever POD viewer you are using.

Statistical goodness

ratio

OK/(max seen, planned)

percentage

Pretty printed ratio in percentage, with two decimal points and a percent sign.

pre_diag

Any diagnosis output seen in TAP that came before a subtest.