POE::Component::SmokeBox::Job - Object defining a SmokeBox job.
version 0.52
use POE::Component::SmokeBox::Job; my $job = POE::Component::SmokeBox::Job->new( type => 'CPANPLUS::YACSmoke', command => 'smoke', module => 'B/BI/BINGOS/Acme-POE-Acronym-Generator-1.14.tar.gz', );
POE::Component::SmokeBox::Job is a class encapsulating POE::Component::SmokeBox jobs.
new
Creates a new POE::Component::SmokeBox::Job object. Takes a number of parameters:
'idle', number of seconds before jobs are killed for idling, default 600; 'timeout', number of seconds before jobs are killed for excess runtime, default 3600; 'type', the type of backend to use, default is 'CPANPLUS::YACSmoke'; 'command', the command to run, 'check', 'index' or 'smoke', default is 'check'; 'module', the distribution to smoke, mandatory if command is 'smoke'; 'no_log', enable to not store the job output log, default is false; 'delay', the time in seconds to wait between smoker runs, default is 0; 'check_warnings', enable to check job output for common perl warning strings, default is 1;
Accessor methods are provided via Object::Accessor.
idle
Number of seconds before jobs are killed for idling, default 600.
timeout
Number of seconds before jobs are killed for excess runtime, default 3600
type
The type of backend to use, default is 'CPANPLUS::YACSmoke'.
'CPANPLUS::YACSmoke'
command
The command to run, 'check', 'index' or 'smoke', default is 'check'.
'check'
'index'
'smoke'
module
The distribution to smoke, mandatory if command is 'smoke'.
no_log
Boolean value determining whether the job will store it's STDERR/STDOUT log, default 0.
delay
Number of seconds to pause between smokers for this job. Useful to "throttle" your smokers! The default is 0.
WARNING: This option is ineffective if you have multiplicity set in SmokeBox.
check_warnings
Boolean value determining whether SmokeBox will use String::Perl::Warnings to check job output for common perl warnings.
If enabled, SmokeBox will not kill a job prematurely if it prints a lot of warnings to STDERR. It will run the additional check for the warnings and give the process more time to reach the limit. ( look at POE::Component::SmokeBox::Backend for 'excess_kill' )
dump_data
Returns all the data contained in the object as a list.
POE::Component::SmokeBox
POE::Component::SmokeBox::JobQueue
Object::Accessor
Chris Williams <chris@bingosnet.co.uk>
This software is copyright (c) 2017 by Chris Williams.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install POE::Component::SmokeBox, copy and paste the appropriate command in to your terminal.
cpanm
cpanm POE::Component::SmokeBox
CPAN shell
perl -MCPAN -e shell install POE::Component::SmokeBox
For more information on module installation, please visit the detailed CPAN module installation guide.