File Coverage

blib/lib/Devel/Tinderbox/Reporter.pm
Criterion Covered Total %
statement 9 27 33.3
branch 0 4 0.0
condition n/a
subroutine 3 6 50.0
pod 2 2 100.0
total 14 39 35.9


line stmt bran cond sub pod time code
1             package Devel::Tinderbox::Reporter;
2              
3 1     1   663 use strict;
  1         2  
  1         39  
4 1     1   5 use vars qw($VERSION @ISA);
  1         2  
  1         185  
5             $VERSION = '0.10';
6              
7             require Class::Accessor::Fast;
8             @ISA = qw(Class::Accessor::Fast);
9              
10             my $CLASS = __PACKAGE__;
11              
12              
13             =head1 NAME
14              
15             Devel::Tinderbox::Reporter - Client to send reports to Tinderbox
16              
17             =head1 SYNOPSIS
18              
19             use Devel::Tinderbox::Reporter;
20              
21             my $report = Devel::Tinderbox::Reporter->new;
22              
23             $report->from('your@mail.address.com');
24             $report->to('tinderbox@their.address.com');
25             $report->project('the_project');
26             $report->boxname('your.machine.name');
27             $report->style('unix');
28             $report->start;
29              
30             ...go and test your project...
31              
32             $report->log($build_log);
33             $report->end($status);
34              
35             =head1 DESCRIPTION
36              
37             Tinderbox collects and summaries build and test reports from many
38             developers on many machines. This is a simple client for testers to
39             make reports to Tinderbox servers.
40              
41              
42             =head2 Starting off
43              
44             First thing, you need a Devel::Tinderbox::Reporter object.
45              
46             =over 4
47              
48             =item B
49              
50             my $report = Devel::Tinderbox::Reporter->new;
51              
52             Creates a new reporter representing this testing session.
53              
54             =cut
55              
56             # Inherited from Class::Accessor
57              
58             =back
59              
60              
61             =head2 Tell us a little about yourself
62              
63             You then have to tell it about yourself and what you're testing. Fill
64             in each of these blanks. You can either call these methods
65             individually or pass each to new().
66              
67             =item B
68              
69             $report->from($my_email);
70              
71             Email address you wish to report as.
72              
73             =item B
74              
75             $report->to($their_email);
76              
77             Email address you're sending reports to.
78              
79             =item B
80              
81             $report->project($project_name);
82              
83             Name of the Tinderbox project you're reporting about.
84              
85             =item B
86              
87             $report->boxname($box_name);
88              
89             Name of the machine this is being built on. This is a unique id for
90             your build. Maybe something like your machine's name, your name and
91             OS. "Schwern blackrider Debian-Linux/PowerPC-testing"
92              
93             =item B