NAME

Parrot::Harness::Smoke - Generate smoke reports

DESCRIPTION

This package exports on request subroutines used by the root t/harness and by language implementation t/harness to generate smoke reports.

SUBROUTINES

The module currently exports three subroutines on demand.

collect_test_environment_data()

    %env_data = collect_test_environment_data();

It collects environmental data via:

• Analysis of the results of Parrot configuration (%PConfig).

• Environmental variables

• Analysis of git metadata

• Application of CPAN modules. Mail::Util and Sys::Hostname are used, if available.

You may directly affect Submitter data by setting the following environmental variable(s):

• All systems. $ENV{'SMOLDER_SUBMITTER'}.

• Win32 only. $ENV{'USERNAME'} or $ENV{'LOGNAME'}, plus $ENV{'USERDOMAIN'}.

send_archive_to_smolder()

    send_archive_to_smolder( %env_data );

At the current time, automated smoke reports are collected and displayed via the Smolder system at http://smolder.parrot.org. Such reports require the Perl 5 LWP::UserAgent module, available from CPAN.

On network problem or for offline use you may send tar reports later with that command:

  perl -Ilib -MParrot::Harness::Smoke \
    -e'Parrot::Harness::Smoke::send_archive_to_smolder(Parrot::Harness::Smoke::collect_test_environment_data())'

generate_html_smoke_report()

This subroutine generates a type of HTML-smoke report formerly collected and displayed on Parrot's smoke server. It has been superseded by Smolder reporting but is still available for other uses.

    generate_html_smoke_report (
        tests       => \@tests,
        args        => $args,
        file        => 'smoke.html',
    );

This subroutine requires CPAN modules Test::TAP::HTMLMatrix and Test::TAP::Model::Visual.