File Coverage

blib/lib/Test/Chimps/Client.pm

Criterion	Covered	Total	%
statement	35	45	77.7
branch	0	4	0.0
condition			n/a
subroutine	11	12	91.6
pod	2	2	100.0
total	48	63	76.1

package Test::Chimps::Client;

use 5.008;
use warnings;
use strict;

our $VERSION = '0.11_01';

use Carp;
use Params::Validate qw/:all/;
use HTTP::Request::Common;
use LWP::UserAgent;

use constant PROTO_VERSION => 1.0;

=head1 NAME

Test::Chimps::Client - Send smoke test results to a server

=head1 SYNOPSIS

This module simplifies the process of sending smoke test results
(in the form of Cs) to a smoke server.

    use File::Temp;
    my $tmpfile = File::Temp->new( SUFFIX => ".tar.gz" );

    use TAP::Harness::Archive;
    chdir "some/module/directory";
    my $harness = TAP::Harness::Archive->new( {
        archive          => $tmpfile,
        extra_properties => {
            project   => 'my project',
            revision  => 'some revision',
            committer => 'me',
            osname    => $Config{osname},
            osvers    => $Config{osvers},
            archname  => $Config{archname},
        },
        ....
    } );
    $harness->runtests(glob('t/*.t'));

    use Test::Chimps::Client;
    my $client = Test::Chimps::Client->new(
        archive => $tmpfile,
        server  => "http://...",
    );

    print "Sending smoke report for $server\n";
    my ($status, $msg) = $client->send;
    die "Error: the server responded: $msg\n"
        unless $status;

=head1 INSTALLATION

To install this module, run the following commands:

    perl Makefile.PL
    make
    make test
    make install

=head1 DESCRIPTION

Chimps is the Collaborative Heterogeneous Infinite Monkey
Perfectionification Service.  It is a framework for storing,
viewing, generating, and uploading smoke reports.

This distribution provides client-side modules and binaries
for Chimps.

=head1 METHODS

=head2 new ARGS

Creates a new Client object.  ARGS is a hash whose valid keys are:

=over 4

=item * file

Mandatory.  The value must be a C.  These are the
test results that will be submitted to the server.

=item * report_variables

Optional.  A hashref of report variables and values to send to the
server.

=item * server

Mandatory.  The URI of the server script to upload the model to.

=back

=cut

use base qw/Class::Accessor/;

__PACKAGE__->mk_ro_accessors(qw/archive server/);

sub new {
  my $class = shift;
  my $obj = bless {}, $class;
  $obj->_init(@_);
  return $obj;
}

sub _init {
  my $self = shift;
  my %args = validate_with(
    params => \@_,
    called => 'The Test::Chimps::Client constructor',
    spec   => {
      archive          => { isa => 'File::Temp' },
      server           => 1,
      report_variables => {
        optional => 1,
        type     => HASHREF,
        default  => {}
      }
    }
  );

  foreach my $key (keys %args) {
    $self->{$key} = $args{$key};
  }

}

=head2 send

Submit the specified model to the server.  This function's return
value is a list, the first of which indicates success or failure,
and the second of which is an error string.

=cut

sub send {
    my $self = shift;

    my $ua = LWP::UserAgent->new;
    $ua->agent( "Test-Chimps-Client/" . PROTO_VERSION );
    $ua->env_proxy;

    my $resp = $ua->post(
        $self->server,
        Content_Type => 'form-data',
        Content      => [
            upload  => 1,
            archive => [ "$self->{archive}" ],
            version => PROTO_VERSION
        ],
    );

    if ( $resp->is_success ) {
        if ( $resp->content =~ /^ok/ ) {
            return ( 1, '' );
        } else {
            return ( 0, $resp->content );
        }
    } else {
        return ( 0, $resp->status_line );
    }
}

=head1 ACCESSORS

There are read-only accessors for model, report_variables, and server.

=head1 AUTHOR

Zev Benjamin, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to
C, or through the web interface at
L.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.

=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Test::Chimps::Client

You can also look for information at:

=over 4

=item * Mailing list

Chimps has a mailman mailing list at
L.  You can subscribe via the web
interface at
L.

=item * Repository

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * RT: CPAN's request tracker

L

=item * Search CPAN

L

=back

=head1 ACKNOWLEDGEMENTS

Some code in this module is based on smokeserv-client.pl from the
Pugs distribution.

=head1 COPYRIGHT & LICENSE

Copyright 2006-2009 Best Practical Solutions.
Portions copyright 2005-2006 the Pugs project.

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

=cut

1;