NAME

Test::Reporter - sends test results to cpan-testers@perl.org

VERSION

version 1.57

SYNOPSIS

use Test::Reporter;

my $reporter = Test::Reporter->new();

      $reporter->grade('pass');
      $reporter->distribution('Mail-Freshmeat-1.20');
      $reporter->send() || die $reporter->errstr();

      # or

      my $reporter = Test::Reporter->new();

      $reporter->grade('fail');
      $reporter->distribution('Mail-Freshmeat-1.20');
      $reporter->comments('output of a failed make test goes here...');
      $reporter->edit_comments(); # if you want to edit comments in an editor
      $reporter->send() || die $reporter->errstr();

      # or

      my $reporter = Test::Reporter->new(
          grade => 'fail',
          distribution => 'Mail-Freshmeat-1.20',
          from => 'whoever@wherever.net (Whoever Wherever)',
          comments => 'output of a failed make test goes here...',
          via => 'CPANPLUS X.Y.Z',
      );
      $reporter->send() || die $reporter->errstr();

DESCRIPTION

Test::Reporter reports the test results of any given distribution to the CPAN Testers project. Test::Reporter has wide support for various perl5's and platforms.

METHODS

          grade     meaning
          -----     -------
          pass      all tests passed
          fail      one or more tests failed
          na        distribution will not work on this platform
          unknown   tests did not exist or could not be run
         $reporter->transport( 
             'Net::SMTP::TLS', Username => 'jdoe', Password => '123' 
         );

        If the 'HTTP' transport is used, two additional arguments are
        required: a URL to a Test::Reporter::HTTPGateway compatible server
        and an (optional) API key.

         $reporter->transport( 
             'HTTP', 'http://example.com/reporter-gateway/', '123456' 
         );

        This is not designed to be an extensible platform upon which to
        build transport plugins. That functionality is planned for the
        next-generation release of Test::Reporter, which will reside in the
        CPAN::Testers namespace.
          my $reporter = Test::Reporter->new
          (
            grade => 'pass',
            distribution => 'Test-Reporter-1.16',
          )->write();

        On the machine you are submitting from:

          # wrap in an opendir if you've a lot to submit
          my $reporter;
          $reporter = Test::Reporter->new()->read(
            'pass.Test-Reporter-1.16.i686-linux.2.2.16.1046685296.14961.rpt'
          )->send() || die $reporter->errstr();

        write() also accepts an optional filehandle argument:

          my $fh; open $fh, '>-';  # create a STDOUT filehandle object
          $reporter->write($fh);   # prints the report to STDOUT

CAVEATS

If you experience a long delay sending mail with Test::Reporter, you may be experiencing a wait as Test::Reporter attempts to determine your email domain. Setting the MAILDOMAIN environment variable will avoid this delay.

SEE ALSO

For more about CPAN Testers:

Test::Reporter itself--as a project--also has several links for your visiting enjoyment:

Related Perl modules:

AUTHORS

      Adam J. Foxson <afoxson@pobox.com>
      David Golden <dagolden@cpan.org>
      Kirrily "Skud" Robert <skud@cpan.org>
      Ricardo Signes <rjbs@cpan.org>
      Richard Soderberg <rsod@cpan.org>
      Kurt Starsinic <Kurt.Starsinic@isinet.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Authors and Contributors.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.