-
-
27 Jun 2014 03:53:46 UTC
- Distribution: Ukigumo-Client
- Module version: 0.36
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (3)
- Testers (865 / 30 / 0)
- Kwalitee
Bus factor: 4- 59.94% Coverage
- License: perl_5
- Perl: v5.8.1
- Activity
24 month- Tools
- Download (23.96KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
NAME
Ukigumo::Client - Client library for Ukigumo
SYNOPSIS
use Ukigumo::Client; use Ukigumo::Client::VC::Git; use Ukigumo::Client::Executor::Auto; use Ukigumo::Client::Notify::Debug; use Ukigumo::Client::Notify::Ikachan; my $app = Ukigumo::Client->new( vc => Ukigumo::Client::VC::Git->new( branch => $branch, repository => $repo, ), executor => Ukigumo::Client::Executor::Perl->new(), server_url => $server_url, project => $project, ); $app->push_notifier( Ukigumo::Client::Notify::Ikachan->new( url => $ikachan_url, channel => $ikachan_channel, ) ); $app->run();
DESCRIPTION
Ukigumo::Client is client library for Ukigumo.
ATTRIBUTES
workdir
-
Working directory for the code. It's
$ENV{HOME}/.ukigumo/work/$project/$branch
by default. project
-
Its' project name. This is a mandatory parameter.
logfh
-
Log file handle. It's read only parameter.
server_url
-
URL of the Ukigumo server. It's required.
user_agent
-
instance of LWP::UserAgent. It's have a default value.
vc
-
This is a version controller object. It's normally Ukigumo::Client::VC::*. But you can write your own class.
VC::* objects should have a following methods:
get_revision branch repository
executor
-
This is a test executor object. It's normally Ukigumo::Client::Executor::*. But you can write your own class.
notifiers
-
This is a arrayref of notifier object. It's normally Ukigumo::Client::Notify::*. But you can write your own class.
compare_url
-
URL to compare differences between range of commitments.
elapsed_time_sec
-
Elapsed time as seconds about executing tests.
METHODS
- $client->push_notifier($notifier : Ukigumo::Client::Notify)
-
push a notifier object to $client->notifiers.
- $client->run()
-
Run a test context.
- $client->send_to_server($status: Int)
-
Send a notification to the sever.
- reflect_result($status: Int)
-
Send a notification to the server and notify via registered notifier.
- $client->tee($command: Str)
-
This method runs
$command
and tee the output of the STDOUT/STDERR to thelogfh
.Return: exit code by the
$command
. - $client->logger->infof($message)
-
Print
$message
as INFO and write to thelogfh
. - $client->logger->warnf($message)
-
Print
$message
as WARN and write to thelogfh
. - $client->report_timeout()
-
This method always sends FAIL report to server and notifies to each notifiers.
CONFIGURATION
If
.ukigumo.yml
file is on the project root, Ukigumo::Client loads that file and applies the settings that are written in it.Please see also ukigumo.yml.pod.
AUTHOR
Tokuhiro Matsuno <tokuhirom AAJKLFJEF@ GMAIL COM>
SEE ALSO
LICENSE
Copyright (C) Tokuhiro Matsuno
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Module Install Instructions
To install Ukigumo::Client, copy and paste the appropriate command in to your terminal.
cpanm Ukigumo::Client
perl -MCPAN -e shell install Ukigumo::Client
For more information on module installation, please visit the detailed CPAN module installation guide.