NAME

VERSION

SYNOPSIS

  use Test::Reporter;

  my $reporter = Test::Reporter->new(
      transport => 'File',
      transport_args => [ '/tmp' ],
  );

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

  # or

  my $reporter = Test::Reporter->new(
      transport => 'File',
      transport_args => [ '/tmp' ],
  );

  $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(
      transport => 'File',
      transport_args => [ '/tmp' ],
      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

CPAN Testers no longer receives test reports by email, but reports still resemble an email message. This module has numerous legacy "features" left over from the days of email transport.

ATTRIBUTES

METHODS

• new

  This constructor returns a Test::Reporter object.

• perl_version

  Returns a hashref containing _archname, _osvers, and _myconfig based upon the perl that you are using. Alternatively, you may supply a different perl (path to the binary) as an argument, in which case the supplied perl will be used as the basis of the above data. Make sure you protect it from the shell in case there are spaces in the path:

    $reporter->perl_version(qq{"$^X"});
      

• subject

  Returns the subject line of a report, i.e. "PASS Mail-Freshmeat-1.20 Darwin 6.0". 'grade' and 'distribution' must first be specified before calling this method.

• report

  Returns the actual content of a report, i.e. "This distribution has been tested as part of the cpan-testers...". 'comments' must first be specified before calling this method, if you have comments to make and expect them to be included in the report.

• send

  Sends the test report to cpan-testers@perl.org via the defined "transport" mechanism. You must check errstr() on a send() in order to be guaranteed delivery.

• edit_comments

  Allows one to interactively edit the comments within a text editor. comments() doesn't have to be first specified, but it will work properly if it was. Accepts an optional hash of arguments:

• errstr

  Returns an error message describing why something failed. You must check errstr() on a send() in order to be guaranteed delivery.

• write and read

  These methods are used in situations where you wish to save reports locally rather than transmitting them to CPAN Testers immediately. You use write() on the machine that you are testing from, transfer the written test reports from the testing machine to the sending machine, and use read() on the machine that you actually want to submit the reports from. write() will write a file in an internal format that contains 'From', 'Subject', and the content of the report. The filename will be represented as: grade.distribution.archname.osvers.seconds_since_epoch.pid.rpt. write() uses the value of dir() if it was specified, else the cwd.

  On the machine you are testing from:

    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

SEE ALSO

• CPAN Testers reports <http://www.cpantesters.org/>
• CPAN Testers wiki <http://wiki.cpantesters.org/>

SUPPORT

  git clone https://github.com/cpan-testers/Test-Reporter.git

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>

CONTRIBUTORS

• Andreas Koenig <andk@cpan.org>
• Ed J <mohawk2@users.noreply.github.com>
• Tatsuhiko Miyagawa <miyagawa@bulknews.net>
• Vincent Pit <perl@profvince.com>

COPYRIGHT AND LICENSE

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