Alex Skud Bayley > CPAN-Test-Reporter > CPAN::Test::Reporter

Download:
CPAN-Test-Reporter-0.02.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 0.02   Source  

NAME ^

CPAN::Test::Reporter - Report test results of a package retrieved from CPAN

SYNOPSIS ^

    my $report = CPAN::Test::Reporter->new;
    $report->which_perl(path to the perl binary we tested with);
    $report->grade(pass|fail|na|unknown);
    $report->package(module name);
    $report->test_results(our build and/or make test results);
    $report->comments(other commentary on the module);
    $report->send(to whom);

DESCRIPTION ^

CPAN::Test::Reporter uniformly posts package test results in support of the cpan-testers project. See http://testers.cpan.org/ for details.

NOTE TO TESTERS: this module will currently send its output email to cpan-workers@perl.org, which might not be what you want. You can set $CPAN::Test::Reporters::CPAN_TESTERS to another email address if you prefer.

new()

Creates a new reporter object.

grade($grade)

grade($grade) indicates the success or failure of the package's builtin tests, and is one of:

    grade     meaning
    -----     -------
    pass      all tests included with the package passed
    fail      some tests failed
    na        the package does not work on this platform
    unknown   the package did not include tests

which_perl($path)

Specifies the version of perl you just used to test the module.

my $r = new CPAN::Test::Reporter; $r->which_perl('5.6.1'); is($r->{which_perl}, '5.6.1', "Set the perl version");

package($module)

Sets the name of the package you're working on, for example Foo-Bar-0.01 There are no restrictions on what you put here -- it was found that even requiring it to end in a dash and a version number was too restrictive for use in the wild.

test_results($results)

Sets the results for the test. $results is in the form of a string, presumably as provided by CPAN::Smoke.

comments($comments)

Sets your comments on the test.

send(@recipients)

Sends the email to cpan-testers and Cc's the mail to the recipients listed. Uses full email addresses.

COPYRIGHT ^

    Copyright (c) 1999 Kurt Starsinic, 2001 Kirrily Robert.
    This program is free software; you may redistribute it
    and/or modify it under the same terms as Perl itself.

SEE ALSO ^

CPAN::Smoke

AUTHOR ^

Kirrily "Skud" Robert <skud@cpan.org>, based on the cpantest script by Kurt Starsinic <Kurt.Starsinic@isinet.com>

syntax highlighting: