MANIFEST.SKIP @@ -1,6 +1,10 @@ POE::Component::CPAN::YACSmoke ============================== +1.36 Sat Jun 20 10:56:29 BST 2009 + - Makefile.PL meta fixes. + - Deprecation warnings. + 1.34 Mon Aug 4 10:29:32 BST 2008 - Forgot to add a 'use' line to minismoker Changes @@ -1,4 +1,3 @@ -bin/minismoker Changes examples/author_search.pl examples/flush.pl @@ -6,15 +5,19 @@ examples/package_search.pl examples/recent_modules.pl inc/Module/Install.pm inc/Module/Install/AuthorTests.pm +inc/Module/Install/AutoLicense.pm inc/Module/Install/Base.pm inc/Module/Install/Can.pm inc/Module/Install/Fetch.pm +inc/Module/Install/GithubMeta.pm inc/Module/Install/Makefile.pm inc/Module/Install/Metadata.pm +inc/Module/Install/ReadmeFromPod.pm +inc/Module/Install/Scripts.pm inc/Module/Install/Win32.pm +inc/Module/Install/With.pm inc/Module/Install/WriteAll.pm lib/POE/Component/CPAN/YACSmoke.pm -LICENSE Makefile.PL MANIFEST This list of files META.yml MANIFEST @@ -1,10 +1,28 @@ use strict; use inc::Module::Install; + +print <<NOTICE; + +\a-------------------------------------------------------------- +This distribution and associated tools have been deprecated. + +Please investigate POE::Component::SmokeBox and +App::SmokeBox::Mini instead. + +Thanks. +-------------------------------------------------------------- + +NOTICE + +sleep 5; + name 'POE-Component-CPAN-YACSmoke'; author 'Chris Williams <chris@bingosnet.co.uk>'; license 'perl'; +auto_license holder => 'Chris Williams'; version_from 'lib/POE/Component/CPAN/YACSmoke.pm'; abstract_from 'lib/POE/Component/CPAN/YACSmoke.pm'; +readme_from 'lib/POE/Component/CPAN/YACSmoke.pm'; perl_version '5.006'; author_tests 'xt'; install_script 'bin/minismoker'; @@ -13,13 +31,12 @@ requires 'Storable' => 0; requires 'POE' => 1.0001; requires 'POE::Wheel::Run' => 0; requires 'File::Spec' => 0; -if ( $^O eq 'MSWin32' ) { +if ( win32 ) { requires 'Win32::Process' => 0; requires 'Win32::Job' => 0; } else { - eval "require Proc::ProcessTable"; - if ( $@ ) { + unless ( can_use 'Proc::ProcessTable' ) { requires 'Proc::ProcessTable' => 0 if prompt( 'Do you want to enable optional Proc::ProcessTable support [y/N]?', 'N' ) =~ /^Y/i; @@ -28,4 +45,6 @@ else { warn "You already have optional module Proc::ProcessTable installed, skipping dialogue\n"; } } +auto_provides; +githubmeta; WriteAll(); Makefile.PL @@ -1,19 +1,19 @@ NAME - POE::Component::CPAN::YACSmoke - bringing the power of POE to CPAN smoke + POE::Component::CPAN::YACSmoke - Bringing the power of POE to CPAN smoke testing. SYNOPSIS use strict; use POE qw(Component::CPAN::YACSmoke); use Getopt::Long; - - $|=1; - - my ($perl, $jobs); - - GetOptions( 'perl=s' => \$perl, 'jobs=s' => \$jobs ); - - my @pending; + + $|=1; + + my ($perl, $jobs); + + GetOptions( 'perl=s' => \$perl, 'jobs=s' => \$jobs ); + + my @pending; if ( $jobs ) { open my $fh, "<$jobs" or die "$jobs: $!\n"; while (<$fh>) { @@ -22,38 +22,50 @@ SYNOPSIS } close($fh); } - - my $smoker = POE::Component::CPAN::YACSmoke->spawn( alias => 'smoker' ); - - POE::Session->create( + + my $smoker = POE::Component::CPAN::YACSmoke->spawn( alias => 'smoker' ); + + POE::Session->create( package_states => [ - 'main' => [ qw(_start _stop _results) ], + 'main' => [ qw(_start _stop _results _recent) ], ], heap => { perl => $perl, pending => \@pending }, ); - - $poe_kernel->run(); + + $poe_kernel->run(); exit 0; - - sub _start { + + sub _start { my ($kernel,$heap) = @_[KERNEL,HEAP]; - $kernel->post( 'smoker', 'submit', { event => '_results', perl => $heap->{perl}, module => $_ } ) + if ( @{ $heap->{pending} } ) { + $kernel->post( 'smoker', 'submit', { event => '_results', perl => $heap->{perl}, module => $_ } ) for @{ $heap->{pending} }; + } + else { + $kernel->post( 'smoker', 'recent', { event => '_recent', perl => $heap->{perl} } ) + } undef; } - - sub _stop { + + sub _stop { $poe_kernel->call( 'smoker', 'shutdown' ); undef; } - - sub _results { + + sub _results { my $job = $_[ARG0]; print STDOUT "Module: ", $job->{module}, "\n"; print STDOUT "$_\n" for @{ $job->{log} }; undef; } + sub _recent { + my ($kernel,$heap,$job) = @_[KERNEL,HEAP,ARG0]; + $kernel->post( 'smoker', 'submit', { event => '_results', perl => $heap->{perl}, module => $_ } ) + for @{ $job->{recent} }; + undef; + } + DESCRIPTION POE::Component::CPAN::YACSmoke is a POE-based framework around CPANPLUS and CPAN::YACSmoke. It receives submissions from other POE sessions, @@ -80,6 +92,10 @@ CONSTRUCTOR 'options', specify some POE::Session options; 'debug', see lots of text on your console; 'idle', adjust the job idle time ( default: 600 seconds ), before jobs get killed; + 'timeout', adjust the total job runtime ( default: 3600 seconds ), before a job is killed; + 'perl', which perl executable to use as a default, instead of S^X; + 'appdata', default path where CPANPLUS should look for it's .cpanplus folder; + 'no_grp_kill', set to a true value to disable process group kill; Returns a POE::Component::CPAN::YACSmoke object. @@ -92,11 +108,46 @@ METHODS a list context, returns a list of hashrefs which are the jobs currently waiting in the job queue. + current_job + Returns a hashref containing details of the currently executing + smoke job. Returns undef if there isn't a job currently running. + + current_log + Returns an arrayref of log output from the currently executing smoke + job. Returns undef if there isn't a job currently running. + shutdown Terminates the component. Any pending jobs are cancelled and the currently running job is allowed to complete gracefully. Requires no additional parameters. + pause_queue + Pauses processing of the jobs. The current job will finish + processing, but any pending jobs will not be processed until the + queue is resumed. This does not affect the continued submission of + jobs to the queue. + + resume_queue + Resumes the processing of the pending jobs queue if it has been + previously paused. + + paused + Returns a true value if the job queue is paused or a false value + otherwise. + + statistics + Returns some statistical that the component gathers. In a list + context returns a list of data. In a scalar context returns an + arrayref of the said data. + + The data is returned in the following order: + + The time in epoch seconds when the smoker was started; + The total number of jobs that have been processed; + The current average job run time; + The minimum job run time observed; + The maximum job run time observed; + INPUT EVENTS All the events that the component will accept (unless noted otherwise ) require one parameter, a hashref with the following keys defined ( @@ -107,6 +158,8 @@ INPUT EVENTS so whatever that requires should work (Mandatory); 'session', which session the result event should go to (Default is the sender); 'perl', which perl executable to use (Default whatever is in $^X); + 'debug', turn on or off debugging information for this particular job; + 'appdata', the path where CPANPLUS should look for it's .cpanplus folder; It is possible to pass arbitrary keys in the hash. These should be proceeded with an underscore to avoid possible future API clashes. @@ -125,6 +178,69 @@ INPUT EVENTS currently running job is allowed to complete gracefully. Requires no additional parameters. + recent + Obtain a list of recent uploads to CPAN. + + Takes one parameter, hashref with the following keys defined: + + 'event', an event name for the results to be sent to (Mandatory); + 'session', which session the result event should go to (Default is the sender); + 'perl', which perl executable to use (Default whatever is in $^X); + + It is possible to pass arbitrary keys in the hash. These should be + proceeded with an underscore to avoid possible future API clashes. + + author + Obtain a list of distributions for a given author. + + Takes one parameter, a hashref with the following keys defined: + + 'event', an event name for the results to be sent to (Mandatory); + 'session', which session the result event should go to (Default is the sender); + 'perl', which perl executable to use (Default whatever is in $^X); + 'type', specify the type of search to conduct, 'cpanid', 'author' or 'email', default is 'cpanid'; + 'search', a string representing the search criteria to use (Mandatory); + + It is possible to pass arbitrary keys in the hash. These should be + proceeded with an underscore to avoid possible future API clashes. + + package + obtain a list of distributions given criteria to search for. + + Takes one parameter, a hashref with the following keys defined: + + 'event', an event name for the results to be sent to (Mandatory); + 'session', which session the result event should go to (Default is the sender); + 'perl', which perl executable to use (Default whatever is in $^X); + 'type', specify the type of search to conduct, 'package', 'name', etc., default is 'package'; + 'search', a string representing the search criteria to use (Mandatory); + + It is possible to pass arbitrary keys in the hash. These should be + proceeded with an underscore to avoid possible future API clashes. + + check + Checks whether CPAN::YACSmoke is installed. Takes one parameter a + hashref with the following keys defined: + + 'event', an event name for the results to be sent to (Mandatory); + 'session', which session the result event should go to (Default is the sender); + 'perl', which perl executable to use (Default whatever is in $^X); + + It is possible to pass arbitrary keys in the hash. These should be + proceeded with an underscore to avoid possible future API clashes. + + indices + Forces an update of the CPANPLUS indices. Takes one parameter, a + hashref with the following keys defined: + + 'event', an event name for the results to be sent to (Mandatory); + 'session', which session the result event should go to (Default is the sender); + 'perl', which perl executable to use (Default whatever is in $^X); + 'prioritise', set to 1 to put action at the front of the job queue, default 0; + + It is possible to pass arbitrary keys in the hash. These should be + proceeded with an underscore to avoid possible future API clashes. + OUTPUT EVENTS Resultant events will have a hashref as ARG0. All the keys passed in as part of the original request will be present (including arbitrary @@ -133,21 +249,39 @@ OUTPUT EVENTS 'log', an arrayref of STDOUT and STDERR produced by the job; 'PID', the process ID of the POE::Wheel::Run; 'status', the $? of the process; + 'submitted', the time in epoch seconds when the job was submitted; 'start_time', the time in epoch seconds when the job started running; 'end_time', the time in epoch seconds when the job finished; + 'idle_kill', only present if the job was killed because of excessive idle; + 'excess_kill', only present if the job was killed due to excessive runtime; + + The results of a 'recent' request will be same as above apart from an + additional key: + + 'recent', an arrayref of recently uploaded modules; + + The results of a 'package' or 'author' search will be same as other + events apart from an additional key: + + 'results', an arrayref of the modules returned by the search; MSWin32 - On MSWin32 the technique used by this component to fork does not work - properly. This may be a limitation of POE::Wheel::Run. I am - investigating. + POE::Component::CPAN::YACSmoke now supports MSWin32 in the same manner + as other platforms. Win32::Process is used to fix the issues surrounding + POE::Wheel::Run and forking alternative copies of the perl executable. - A knock-on consequence of this, is that modules submitted will be smoked - with a fork of the currently running process and hence 'perl'. Bear this - is mind when setting up your smoking environment. + The code is still experimental though. Be warned. AUTHOR Chris 'BinGOs' Williams <chris@bingosnet.co.uk> +LICENSE + Copyright "(c)" Chris Williams and Jonathan Steinert + + This module may be used, modified, and distributed under the same terms + as Perl itself. Please see the license that came with your Perl + distribution for details. + KUDOS Many thanks to all the people who have helped me with developing this module. @@ -159,11 +293,16 @@ KUDOS And to Robert Rothenberg and Barbie for CPAN::YACSmoke. SEE ALSO + minismoker + POE CPANPLUS CPAN::YACSmoke + <http://cpantest.grango.org/cgi-bin/pages.cgi?act=wiki-page&pagename=YAC + SmokePOE> + <http://use.perl.org/~BinGOs/journal/> README @@ -6,7 +6,7 @@ use POE qw(Wheel::Run); use Storable; use vars qw($VERSION); -$VERSION = '1.34'; +$VERSION = '1.36'; my $GOT_KILLFAM; @@ -640,11 +640,18 @@ see the section of this document relating to your platform. You are responsible for installing and configuring L<CPANPLUS> and L<CPAN::YACSmoke> and setting up a suitable perl smoking environment. +=head1 DEPRECATION NOTICE + +POE::Component::CPAN::YACSmoke has been superceded by L<POE::Component::SmokeBox>. The L<minismoker> +script has been superceded by L<App::SmokeBox::Mini>. + +Consider this module deprecated. + =head1 CONSTRUCTOR =over -=item spawn +=item C<spawn> Spawns a new component session and waits for requests. Takes the following optional arguments: @@ -665,40 +672,40 @@ Returns a POE::Component::CPAN::YACSmoke object. =over -=item session_id +=item C<session_id> Returns the POE::Session ID of the component's session. -=item pending_jobs +=item C<pending_jobs> In a scalar context returns the number of currently pending jobs. In a list context, returns a list of hashrefs which are the jobs currently waiting in the job queue. -=item current_job +=item C<current_job> Returns a hashref containing details of the currently executing smoke job. Returns undef if there isn't a job currently running. -=item current_log +=item C<current_log> Returns an arrayref of log output from the currently executing smoke job. Returns undef if there isn't a job currently running. -=item shutdown +=item C<shutdown> Terminates the component. Any pending jobs are cancelled and the currently running job is allowed to complete gracefully. Requires no additional parameters. -=item pause_queue +=item C<pause_queue> Pauses processing of the jobs. The current job will finish processing, but any pending jobs will not be processed until the queue is resumed. This does not affect the continued submission of jobs to the queue. -=item resume_queue +=item C<resume_queue> Resumes the processing of the pending jobs queue if it has been previously paused. -=item paused +=item C<paused> Returns a true value if the job queue is paused or a false value otherwise. -=item statistics +=item C<statistics> Returns some statistical that the component gathers. In a list context returns a list of data. In a scalar context returns an arrayref of the said data. @@ -730,21 +737,21 @@ possible future API clashes. =over -=item submit +=item C<submit> -=item push +=item C<push> Inserts the requested job at the end of the queue ( if there is one ). -=item unshift +=item C<unshift> Inserts the requested job at the head of the queue ( if there is one ). Guarantees that that job is processed next. -=item shutdown +=item C<shutdown> Terminates the component. Any pending jobs are cancelled and the currently running job is allowed to complete gracefully. Requires no additional parameters. -=item recent +=item C<recent> Obtain a list of recent uploads to CPAN. @@ -757,7 +764,7 @@ Takes one parameter, hashref with the following keys defined: It is possible to pass arbitrary keys in the hash. These should be proceeded with an underscore to avoid possible future API clashes. -=item author +=item C<author> Obtain a list of distributions for a given author. @@ -772,7 +779,7 @@ Takes one parameter, a hashref with the following keys defined: It is possible to pass arbitrary keys in the hash. These should be proceeded with an underscore to avoid possible future API clashes. -=item package +=item C<package> obtain a list of distributions given criteria to search for. @@ -787,7 +794,7 @@ Takes one parameter, a hashref with the following keys defined: It is possible to pass arbitrary keys in the hash. These should be proceeded with an underscore to avoid possible future API clashes. -=item check +=item C<check> Checks whether L<CPAN::YACSmoke> is installed. Takes one parameter a hashref with the following keys defined: @@ -799,7 +806,7 @@ defined: It is possible to pass arbitrary keys in the hash. These should be proceeded with an underscore to avoid possible future API clashes. -=item indices +=item C<indices> Forces an update of the CPANPLUS indices. Takes one parameter, a hashref with the following keys defined: @@ -848,7 +855,7 @@ Chris 'BinGOs' Williams <chris@bingosnet.co.uk> =head1 LICENSE -Copyright C<(c)> Chris Williams and Jonathan Steinert +Copyright E<copy> Chris Williams This module may be used, modified, and distributed under the same terms as Perl itself. Please see the license that came with your Perl distribution for details. @@ -864,6 +871,10 @@ And to Robert Rothenberg and Barbie for L<CPAN::YACSmoke>. =head1 SEE ALSO +L<POE::Component::SmokeBox> + +L<App::SmokeBox::Mini> + L<minismoker> L<POE> @@ -875,3 +886,5 @@ L<CPAN::YACSmoke> L<http://cpantest.grango.org/cgi-bin/pages.cgi?act=wiki-page&pagename=YACSmokePOE> L<http://use.perl.org/~BinGOs/journal/> + +=cut lib/POE/Component/CPAN/YACSmoke.pm LICENSE 1353b36f1b4ddb6a2b7ff3fb2398f180a1f1da2d Chris Williams chris@bingosnet.co.uk http://github.com/bingos/poe-component-cpan-yacsmoke/commit/1a41133fc2f148a05562eabda390e29d07173131 1a41133fc2f148a05562eabda390e29d07173131 2009-06-20T02:59:26-07:00 2009-06-20T02:59:26-07:00 Makefile.PL meta updates. Deprecation warnings. 1e994aea4df2a5e5222bc5def3465ad785dabe40 Chris Williams chris@bingosnet.co.uk