Beefy Boxes and Bandwidth Generously Provided by pair Networks
No such thing as a small change
 
PerlMonks  

Automated module testing with SVN::Client and Module::Build

by sintadil (Pilgrim)
on Sep 15, 2004 at 17:57 UTC ( #391251=CUFP: print w/ replies, xml ) Need Help??

Taking the Extreme Programming philosophy even further, I wrote this script before the module that I plan to test even had any real tests. What it does is fairly simple:

  1. Checks out code from an SVN repository.
  2. Changes into the directory in which the new working copy lives.
  3. Uses the M::B API to automate running the module's tests.
  4. Sends email about its results.
I had issues using modules to send email after redirecting the filehandles, so instead I decided to open a pipe directory to sendmail. Yes, it's not portable, especially not to Windows systems. But, I haven't seen the Perl SVI API ported to Windows, so Windows users would have a problem with that anyway.

Please do comment.

#!/usr/bin/perl use strict; use warnings; use SVN::Client; use Module::Build; use MIME::Lite; my $module_name = 'module_name'; my $starttime = localtime; my $endtime; my $svn_user = 'svnuser'; my $svn_passwd = q#pass#; my ($stdout, $stderr); my $to = 'mail_target'; my $from = 'mail_sender'; my $subject = "mail_subject"; my $repopath = q#repo_location#; my $copath = 'where_to_checkout_repo'; my $revision = 'revision'; my $recurse = 1; # checkout subdirectories? my $msg; # This sub handles authentication. It's needed by the SVN API. sub getauth { my $cred = shift; $cred->username($svn_user); $cred->password($svn_passwd); } my $svnclient = SVN::Client->new ( auth => [ SVN::Client::get_simple_provider(), SVN::Client::get_simple_prompt_provider ( \&getauth,2 ), SVN::Client::get_username_provider() ], ); # These six lines do a number of things. First, the two 'open OLD' # lines make copies of STDOUT and STDERR. The 'close STD' and 'open # STD' lines redirect STDOUT and STDERR to the relevant variables. # This is so that STDOUT and STDERR can be included in the custom # email message generated below. open OLDOUT, '>&STDOUT' or die "dup() of STDOUT failed: $!"; close STDOUT or die "close STDOUT: $!"; open STDOUT, '>', \$stdout or die "redirect STDOUT: $!"; open OLDERR, '>&STDERR' or die "dup() of STDERR failed: $!"; close STDERR or die "close STDERR: $!"; open STDERR, '>', \$stderr or die "redirect STDERR: $!"; # Do the actual checkout. $svnclient->checkout($repopath, $copath, $revision, $recurse) or die "Couldn't do checkout: $!"; # Change into the target directory. chdir($copath) or die "chdir(): $!"; # Set up the M::B object... my $build = Module::Build->new ( module_name => $module_name ); # ... and do the tests. M::B's dispatch() method apparently returns # like system(): i.e., "true" for failure and "false" for success. I # haven't investigated this too closely, but I know that it works this # way. $build->dispatch('build') and die "dispatch(build): $!"; $build->dispatch('test') and die "dispatch(test): $!"; # Construct the mail. $endtime = localtime; $subject .= sprintf("%s/%s", $starttime, $endtime); my $message = <<"EOF"; Checkout and building for $module_name, started $starttime. Finished $endtime. $stdout Here's any error output: $stderr EOF # These six lines undo the damage that was done earlier. :) Hereafter, # normal output to STDOUT and STDERR works again. close STDOUT or die "close STDOUT: $!"; open STDOUT, ">&", OLDOUT or die "reopen STDOUT: $!"; close OLDOUT or die "close OLDOUT: $!"; close STDERR or die "close STDERR: $!"; open STDERR, ">&OLDERR" or die "reopen STDERR: $!"; close OLDERR or die "close OLDERR: $!"; # Send mail about what has transpired. my $msg = MIME::Lite->new ( To => $to, From => $from, Subject => $subject, Data => $message ); $msg->send();

UPDATE:As per demerphq's suggestion, I tried MIME::Lite. This introduces a far better way of sending email that actually works. Thanks!

UPDATE^2:Fixed some of the code to deal with using MIME::Lite.

Comment on Automated module testing with SVN::Client and Module::Build
Download Code
Re: Automated module testing with SVN::Client and Module::Build
by FoxtrotUniform (Prior) on Sep 15, 2004 at 18:25 UTC

    Good stuff! Now all I need to do is convince my lab to install SVN so that I can play around with it....

    One thing you might consider is sending the email only on failure; successful builds succeed quietly. I've played around with a few "email-a-day" scripts (mostly of my own devising), and I find that even at such a low frequency, after a few weeks of the same (or similar) messages I tend to delete them unread. Parsing the tests' output might be more effort than it's worth; can you simply assume that the build succeeded if $stderr is empty?

    Shameless self-promotion: there's a good discussion of when to log and notify in the replies to Defensive Programming and Audit Trails.

    --
    F o x t r o t U n i f o r m
    Found a typo in this node? /msg me
    % man 3 strfry

      Now all I need to do is convince my lab to install SVN so that I can play around with it....

      Good luck with that. :)

      One thing you might consider is sending the email only on failure; successful builds succeed quietly. I've played around with a few "email-a-day" scripts (mostly of my own devising), and I find that even at such a low frequency, after a few weeks of the same (or similar) messages I tend to delete them unread. Parsing the tests' output might be more effort than it's worth; can you simply assume that the build succeeded if $stderr is empty?

      I don't know about that, but it's a very good idea to do some investigating. With Test::More at least, using the verbose flag causes output to go to $stderr even if the tests are successful. This complicates things if you want verbose testing. Of course, there's dozens of other test modules out there, so... it may be possible to use one of those instead.

      Shameless self-promotion

      I personally don't see anything wrong with these, so long as they provide useful information.

      Good stuff! Now all I need to do is convince my lab to install SVN so that I can play around with it....

      Well if they use CVS, then i suggest you do what I did. Install it on your machine first, then show/demo it to everyone who will sit still long enough to listen. I have found very few CVS users or administrators who dont immediately see the superiority of Subversion.

      Of course, I am in the workplace, not the university, so you may not have the same freedom to install software. However, if you really just want to play around with it, then just install it, its pretty painless (I have done it on Linux, Windows and OS X with little trouble) and you don't need a seperate server if you dont want to.

      -stvn

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: CUFP [id://391251]
Approved by herveus
Front-paged by Enlil
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others imbibing at the Monastery: (10)
As of 2014-08-20 13:58 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    The best computer themed movie is:











    Results (114 votes), past polls