source: other-projects/nightly-tasks/diffcol/trunk/task.pl@ 27962

Last change on this file since 27962 was 27962, checked in by ak19, 11 years ago

For darwin, need to get the imagemagick binaries that Max had pre-built, rather than compile up the imagemagick src as we do for linux.

  • Property svn:executable set to *
File size: 28.3 KB
Line 
1#!/usr/bin/perl -w
2
3# This program is meant to run the nightly diffcol
4# It is meant to be an equivalent for the existing task bash script
5# But it is intended to be expanded to work for Windows and GS3
6# For windows, need to REMEMBER to set the correct shebangs at the top
7
8
9# TODO:
10# Have a caveat mode and a stable mode (as in snapshot/task.pl)
11#
12#} elsif ( $ENV{'TASK_NAME'} =~ "gs2-diffcol-(caveat|stable)" ) {
13# $major_version = 2;
14# $prefix="2t";
15# $rk="tk2"; # test kit
16#} elsif ( $ENV{'TASK_NAME'} =~ "gs3-diffcol-(caveat|stable)" ) {
17# $major_version = 3;
18# $prefix="3t";
19# $rk="tk3"; # test kit
20
21package diffcoltask;
22
23use Cwd;
24use Switch; # for switch(val) { case: ; ...}
25use File::Path; # for rmdir and mkdir type functions
26use File::Copy; # for recursive copying of folders but skipping .svn
27use File::Basename;
28
29use strict;
30no strict 'subs'; # allow barewords (eg STDERR) as function arguments
31
32
33my $isWin = ($^O =~ m/mswin/i) ? 1 : 0;
34my $isMac = ($^O =~ m/macos|darwin/i) ? 1 : 0;
35my $sep = $isWin ? "\\" : "/";
36my $pathsep = $isWin ? ";" : ":";
37#my $script_ext = $isWin ? ".bat" : ".bash";
38my $setup_script = "setup"; # needs to become gs3-setup for GS3
39my $use_blat = 0; # if we ever get blat to send mail/attachments on Windows working, set this to 1
40
41
42# TASK_HOME should be the toplevel diffcol folder
43$ENV{'TASK_HOME'} = getcwd unless defined $ENV{'TASK_HOME'};
44if($isWin) {
45 $ENV{'TASK_HOME'} =~ s@\/@\\@g;
46 # need to convert TASK_HOME path name to resolve very subtle bug when running task.pl via
47 # run-gs2-diffcol.bat which uses environment.pl's TASK_HOME setting via envi
48 # At that point TASK_HOME is already defined but ends up lowercase, so that entries in archiveinf-doc
49 # end up sorted differently when db2txt -sort is applied compared to if TASK_HOME had kept its case.
50 require Win32; # for working out Windows Long Filenames from Win 8.3 short filenames
51 $ENV{'TASK_HOME'} = &Win32::GetLongPathName($ENV{'TASK_HOME'});
52}
53## print STDERR "@@@ TASK_HOME: ".$ENV{'TASK_HOME'}."\n";
54
55
56$ENV{'BIN_DIR'} = &filename_concat($ENV{'TASK_HOME'}, "bin");
57
58# we'll be using BLAT to send mail attachments on Windows
59my $blat = $use_blat ? &filename_concat($ENV{'BIN_DIR'}, "blat", "full", "blat.exe") : 0;
60if($isWin && $use_blat && ! -e $blat) {
61 print STDERR "\n***********************************\n";
62 print STDERR "No blat.exe found in $blat.\n";
63 print STDERR "Blat needed to send mail with attachments on Windows.\n";
64 print STDERR "Extract the blat zip file found in $ENV{'BIN_DIR'}\n";
65 print STDERR "for your bit architecture and name the folder 'blat'\n";
66 print STDERR "***********************************\n\n";
67 $blat = 0;
68}
69
70
71$ENV{'DATA_DIR'} = &filename_concat($ENV{'TASK_HOME'}, "diffcol-data");
72$ENV{'UPLOAD_DIR'} = &filename_concat($ENV{'TASK_HOME'}, "diffcol-reports");
73$ENV{'MONITOR_EMAIL'} = "greenstone_team\@cs.waikato.ac.nz"; # need to escape @ sign
74$ENV{'GSDL_SMTP'} = ""; #"smtp.gmail.com";
75##print STDERR "@@@ email: ".$ENV{'MONITOR_EMAIL'}."\n";
76
77# control if an existing compiled greenstone is used
78# or, if one should be checked out, which revision to checkout from svn
79$ENV{'SVN_OPT_REV'} = "-r head";
80#$ENV{'GSDLHOME'}=
81#$ENV{'GSDL3SRCHOME'}=
82
83
84# if the first arg is a digit, it's the new envi verbosity param. Take it off the array
85my $envi_verbose = shift(@ARGV) if(exists $ARGV[0] && $ARGV[0] =~ m/^\d+$/);
86
87#parse arguments
88my $action = "all";
89if(scalar(@ARGV) > 1) {
90 &printusage();
91 exit 0;
92}
93
94if(scalar(@ARGV) == 0) {
95 $action="all";
96}
97else {
98 switch ($ARGV[0]) {
99 case qr/^(-h|-help|help)$/i { &printusage; exit 0; }
100 case qr/^(setup_greenstone|run_test|summarise|upload|all)$/ { $action=$ARGV[0]; }
101 else {
102 print STDERR "Bad subcommand.\n";
103 &printusage;
104 exit -1;
105 }
106 }
107}
108
109#check key environment vars are set
110if(!defined $ENV{'UPLOAD_DIR'}) {
111 print STDERR "Please set a UPLOAD_DIR for the test in an environment.sh file\n";
112 #return 1;
113}
114if(!defined $ENV{'DATA_DIR'}) {
115 print STDERR "Please set a DATA_DIR for the test in an environment.sh file\n";
116 #return 1;
117}
118if(!defined $ENV{'MONITOR_EMAIL'}) {
119 print STDERR "Please set a MONITOR_EMAIL for the test in an environment.sh file\n";
120 #return 1;
121}
122
123if($ENV{'DATA_DIR'} eq "/") {
124 print STDERR "DATA_DIR should not be the fs root\n";
125 #return 1;
126}
127
128print STDERR "DATA_DIR: ".$ENV{'DATA_DIR'}."\n";
129print STDERR "UPLOAD_DIR: ".$ENV{'UPLOAD_DIR'}."\n";
130
131#create an id for this test
132my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
133$year += 1900;
134$mon += 1;
135$mon = "0$mon" if ($mon < 10);
136$mday = "0$mday" if ($mday < 10);
137my $dateid="$year.$mon.$mday"; #my $dateid=($year+1900)."-".($mon+1)."-$mday";
138
139print STDERR "Starting test '$dateid'\n";
140
141
142# http://stackoverflow.com/questions/2149368/how-can-i-loop-through-files-in-a-directory-in-perl
143$ENV{'CLASSPATH'} = "";
144my $jar_lib_path = $ENV{'TASK_HOME'}.$sep."lib";
145my @files = <$jar_lib_path/*.jar>; # /full/path/to/diffcol/lib/*jar
146foreach my $file (@files) {
147 $file =~ s@\/@\\@g if $isWin;
148 $ENV{'CLASSPATH'}=$file.$pathsep.$ENV{'CLASSPATH'};
149}
150##print STDERR "**** classpath: ".$ENV{'CLASSPATH'}."\n";
151
152
153#set the location of the full report
154my $xmlout=filename_concat($ENV{'DATA_DIR'}, "full-report-$dateid.xml");
155##print STDERR "XML: $xmlout\n";
156
157# the toplevel folder of the greenstone installation being used
158my $greenstone_home="";
159# gsdl is the checkout folder and can be greenstone2 or greenstone3
160my $gsdl="greenstone2";
161
162
163# Check if using existing compiled-up greenstone installation
164# and set the greenstone_home location accordingly
165
166if(defined $ENV{'GSDL3SRCHOME'} || defined $ENV{'GSDLHOME'}) {
167 print STDERR "Found existing Greenstone home, will use that instead\n";
168 $greenstone_home=$ENV{'GSDLHOME'};
169} else {
170 $greenstone_home=filename_concat($ENV{'DATA_DIR'}, $gsdl);
171}
172##print STDERR "GSHOME: $greenstone_home\n";
173
174#do the requested action
175if($action eq "setup_greenstone") {
176 &setup_greenstone;
177}
178elsif ($action eq "run_test") {
179 &run_test;
180}
181elsif ($action eq "summarise") {
182 &summarise;
183}
184elsif ($action eq "upload") {
185 &upload;
186 &mail_with_report_attached;
187}
188elsif ($action eq "all") {
189 &setup_greenstone;
190 &run_test;
191 &summarise;
192 &upload;
193 &mail_with_report_attached;
194}
195
196##********************************
197
198sub printusage
199{
200 print STDERR "Run as: $0 (help|setup_greenstone|run_test|summarise|upload|all)\n";
201}
202
203#http://stackoverflow.com/questions/7427262/read-a-file-and-save-it-in-variable-using-shell-script
204
205sub setup_greenstone
206{
207 #clean up from previous tests
208 print STDERR "about to clean up any old tests (Ctrl-C to cancel)"; # no newline
209 for my $i ( 1..5 ) {
210 sleep 1; # 1 second
211 print STDERR ".";
212 }
213 print STDERR "\n";
214
215 # http://perldoc.perl.org/File/Path.html
216 print STDERR "cleaning up previous tests\n";
217 &File::Path::remove_tree($ENV{'DATA_DIR'});
218
219 print STDERR "creating the data dir\n";
220 &File::Path::make_path($ENV{'DATA_DIR'}); # works like mkdir -p
221
222 chdir($ENV{'DATA_DIR'});
223
224 # use existing compiled-up greenstone installation, if a GSDLHOME set
225 if(defined $ENV{'GSDL3SRCHOME'} || defined $ENV{'GSDLHOME'}) {
226 print STDERR "Found existing Greenstone home, will use that instead\n";
227 return;
228 }
229
230 # Else checkout a GS from svn into DATA_DIR
231
232 #svn checkout of main gsdl directory
233 print STDERR "checkout $gsdl:\n";
234 my $cmd = "svn co ".$ENV{'SVN_OPT_REV'}." http://svn.greenstone.org/main/trunk/greenstone2 $gsdl";
235 ##print STDERR "Checkout CMD: $cmd\n";
236
237 # # unlike backticks operator, system() will print the output of the command to the screen as it executes
238 # http://stackoverflow.com/questions/758611/how-to-flush-output-in-backticks-in-perl?rq=1
239 my $status = system "$cmd"; #my $status = `$cmd`;
240 if($status != 0) {
241 print STDERR "@@@ SVN checkout of $gsdl failed\n";
242 exit -1;
243 }
244 print STDERR "done\n";
245
246 ##print STDERR "$ENV{'DATA_DIR'}$sep$gsdl\n";
247
248 chdir("$ENV{'DATA_DIR'}$sep$gsdl");
249
250 ##print STDERR "@@@ OS: $^O.|".$Config{'archname64'}."|\n";
251
252 if($isWin) {
253 print STDERR "Compiling $gsdl using makegs2.bat running in auto (silent) mode\n";
254
255 # we're now in the GS2 folder, call makegs2 with silent param
256 $cmd = "makegs2.bat silent 2>> $ENV{'DATA_DIR'}/compilation-errors"; # STDERR is sent to compilation-errors file
257 $status = system $cmd;
258
259 } else { # if we're on linux/darwin, need gnome-lib for the correct architecture. And need imagemagick to build imgs in collections
260
261 my $bit_arch=`uname -m`;
262
263 # imagmagick binary
264 print STDERR "Getting imagemagick binary\n";
265
266 my $os = $isMac ? "darwin" : "linux";
267 my $imagickzip = "imagemagick-$os";
268
269 if($isMac) {
270# $imagickzip .= "-10.5.tar.gz";
271 # at present, only the Imagemagick binaries created by Max for darwin work on the Macs
272 &File::Path::make_path($ENV{'DATA_DIR'}."$sep$gsdl$sep$os"); # need to ensure gsdl/bin/darwin exists
273 $cmd = "svn export http://svn.greenstone.org/main/trunk/binaries/mac/intel/imagemagick bin/darwin/imagemagick";
274 $status = system($cmd);
275 } else { # linux
276 my $extension64 = ($bit_arch =~ m/64$/) ? "-x64" : "";
277 $imagickzip .= "$extension64.tar.gz";
278
279 # now these next imagemagick steps (and those near the end of this sub) are just for linux, no longer also for mac
280 $cmd = "svn export http://svn.greenstone.org/gs2-extensions/imagemagick/trunk/$imagickzip ext/$imagickzip";
281 $status = system ($cmd);
282 system("cd ext && tar -xvzf $imagickzip");
283 }
284
285 # gnomelib binary
286 print STDERR "setting up gnome-lib-minimal for compilation\n";
287
288 # To get gnome-lib, need to determine bit architecture of the linux/darwin
289 # http://stackoverflow.com/questions/8963400/the-correct-way-to-read-a-data-file-into-an-array
290 # $Config{'archname64'} doesn't work on the Ubuntu and the Sys::Info package seems to not be supported
291 # well on ActivePerl.
292 # But since we know we're on a Linux/Darwin machine at this point, wecan just run `uname -m` and other linux cmds
293
294 my $gnome_lib_file = $isMac ? "darwin-intel" : "linux"; # assuming all darwin is intel, not ppc!!
295
296 $gnome_lib_file .= "-x64" if($bit_arch =~ m/64$/);
297
298 #svn checkout gnome-lib for this linux/darwin
299 chdir("$ENV{'DATA_DIR'}$sep$gsdl$sep"."ext"); #cd $DATA_DIR/$gsdl/ext
300
301 ##print STDERR "**** gnomelib: $gnome_lib_file\n";
302
303 # checkout and unpack gnome-lib-minimal
304
305 #svn export http://svn.greenstone.org/gs2-extensions/gnome-lib/trunk/gnome-lib-minimal-linux-x64.tar.gz gl.tar.gz
306 $cmd = "svn export http://svn.greenstone.org/gs2-extensions/gnome-lib/trunk/gnome-lib-minimal-".$gnome_lib_file.".tar.gz gl.tar.gz";
307 system $cmd;
308 system ("tar -xvzf gl.tar.gz");
309
310 chdir("gnome-lib-minimal");
311 ##print STDERR "*** ARCH: $bit_arch\n";
312
313 # need to run source devel.bash on gnome-lib followed by configure, make, make install
314 # in one go, in order to preserve the compile environment set up by sourcing devel.bash
315
316 # http://stackoverflow.com/questions/7369145/activating-a-virtualenv-using-a-shell-script-doesnt-seem-to-work
317 # http://ubuntuforums.org/showthread.php?t=1932504 linking /bin/sh to bash instead of dash
318
319# $cmd = "bash -c \"source ./devel.bash && cd ../.. && ./configure --enable-apache-httpd && make && make install\"";
320 $cmd = "bash -c \"";
321
322 $cmd .= "source ./devel.bash";
323 $cmd .= " && cd ../..";
324
325 #configure
326 # $cmd .= " && ./configure";
327 $cmd .= " && echo 'configure $gsdl: ' ";
328 $cmd .= " && echo '<configure>' >> $xmlout";
329 $cmd .= " && ./configure 2>> $ENV{'DATA_DIR'}/compilation-errors"; # configure
330 $cmd .= " && echo '</configure>' >> $xmlout";
331 $cmd .= " && echo 'done'";
332
333 #make
334 $cmd .= " && echo 'make $gsdl: '";
335 $cmd .= " && echo '<make>' >> $xmlout";
336 $cmd .= " && make 2>> $ENV{'DATA_DIR'}/compilation-errors"; # make
337 $cmd .= " && echo '</make>' >> $xmlout";
338 $cmd .= " && echo 'done'";
339
340 #make install
341 $cmd .= " && echo 'make install $gsdl: '";
342 $cmd .= " && echo '<make-install>' >> $xmlout";
343 $cmd .= " && make install 2>> $ENV{'DATA_DIR'}/compilation-errors"; # make install
344 $cmd .= " && echo '</make-install>' >> $xmlout";
345 $cmd .= " && echo 'done'";
346
347 $cmd .= "\""; # close off cmd to bash and run it
348 $status = system $cmd;
349
350 if(!$isMac) { # Linux
351 # Moving imagemagick after instead of before compilation, since bin/darwin gets overwritten during compilation
352 move("$ENV{'DATA_DIR'}$sep$gsdl$sep"."ext/imagemagick/$os", "$ENV{'DATA_DIR'}$sep$gsdl$sep"."bin/$os/imagemagick"); # http://www.perlmonks.org/?node_id=586537
353 unlink "$ENV{'DATA_DIR'}/$gsdl"."/ext/$imagickzip" or warn "Could not unlink ext/$imagickzip: $!";
354 &File::Path::remove_tree("$ENV{'DATA_DIR'}$sep$gsdl$sep"."ext/imagemagick"); # the untarred parent folder
355 }
356
357 }
358
359 if($status != 0) {
360 print STDERR "@@@ Compile failed\n";
361 exit -1;
362 }
363
364 # set the path to the greenstone_home variable
365 $greenstone_home="$ENV{'DATA_DIR'}$sep$gsdl";
366
367}
368
369sub getPDFBox
370{
371 # current revision is 27763, but using "head" works
372 my $PDFBOX_TRAC_URL="http://trac.greenstone.org/export/head/gs2-extensions/pdf-box/trunk/pdf-box-java"; # both for .zip and .tar.gz extension
373 #"http://trac.greenstone.org/export/".$ENV{'SVN_OPT_REV'}."/gs2-extensions/pdf-box/trunk/pdf-box-java";
374
375 # now get the PDFBox extension for PDFBox tutorial
376 print STDERR "Getting pdfbox from $PDFBOX_TRAC_URL:\n";
377
378 chdir($greenstone_home);
379 my $cmd = "";
380 if ($isWin) {
381 $cmd = "setup.bat && cd ext && wget $PDFBOX_TRAC_URL.zip && unzip pdf-box-java.zip";
382
383 } elsif ($isMac) { # need to use curl not wget
384 $cmd = "cd ext && curl $PDFBOX_TRAC_URL.tar.gz > pdf-box-java.tar.gz && tar -xzf pdf-box-java.tar.gz";
385 }
386 else { # linux
387 $cmd = "bash -c \"export GSDLHOME=&& source setup.bash && cd ext && wget $PDFBOX_TRAC_URL.tar.gz && tar -xzf pdf-box-java.tar.gz\"";
388 }
389 my $status = system $cmd;
390 if($status != 0) {
391 print STDERR "@@@ Failed to set up PDFBox\n";
392 exit -1; # or proceed to testing other tutorials?
393 }
394}
395
396# http://stackoverflow.com/questions/3377879/how-do-i-receive-command-output-immediately
397sub run_test
398{
399 my $pdfbox = &filename_concat($greenstone_home, "ext", "pdf-box");
400 if(!-d $pdfbox) {
401 &getPDFBox();
402 }
403
404 open (my $xml_fh, '>'.$xmlout) || die "Could not open xml file $xmlout for appending: $!\n";
405
406 # perform the requested subcommands, outputting xml information
407 print $xml_fh "<test time=\"$dateid\" id=\"$dateid\">\n";
408
409 # make sure that diffcol/model-collect is up to date before copying it over to greenstone-home
410
411 print $xml_fh "Updating $ENV{'TASK_HOME'}/model-collect:\n";
412 my $cmd = "svn up $ENV{'TASK_HOME'}/model-collect"; #chdir("$ENV{'TASK_HOME'}/model-collect");
413 my $status = system "$cmd";
414
415 # go to whichever greenstone_home we're using
416 chdir($greenstone_home);
417
418 # get svn info
419 print STDERR "getting svn info: $xmlout\n";
420 print $xml_fh "<svn-info>\n";
421 &run_and_print_cmd("svn info", $xml_fh);
422 print $xml_fh "</svn-info>\n";
423 print STDERR "done\n";
424
425 #make two copies of the model-collect directory in gsdl
426 #one to be rebuilt and one as the basis for comparison
427 #strip both of all .svn directories
428
429 #copy the model collections to the collect folder to be rebuilt
430 print STDERR "installing test collections and model collections to new $gsdl installation... ";
431
432 #clean up
433 if(-d "collect") {
434 &File::Path::remove_tree("collect") || die "Error could not delete collect: $!";
435 }
436 &File::Path::remove_tree("model-collect");
437
438 #copy to collect and strip .svn subfolders
439 &File::Path::make_path("collect"); # create the folder and copy contents across
440 &copy_recursively(&filename_concat("$ENV{'TASK_HOME'}","model-collect"), "collect", ".svn");
441
442 #make the model copy
443 &File::Path::make_path("model-collect");
444 &copy_recursively("collect", "model-collect"); # copy contents across
445
446 print STDERR "done\n";
447
448
449 #for each collection, import, build and diff with its model counterpart
450 opendir my($collect_handle), "collect" or die "Could not open dir $greenstone_home/collect: $!";
451 for my $collection (readdir $collect_handle) {
452 next if ($collection eq "." || $collection eq "..");
453# next if ($collection ne "Word-PDF-Basic"); ## TEMPORARY, FOR TESTING THIS SCRIPT
454
455 #escape the filename (in case of space)
456 $collection =~ s@ @\\ @g;
457 #getting just the basename of the collection would have been necessary had we not cd-ed into $gsdl
458
459 print STDERR "*** Found collection $collection\n";
460 print $xml_fh "<collection-test name=\"$collection\">\n";
461
462 #import
463# Ensure the OIDtype for importing is hash_on_full_filename
464# "to make document identifiers more stable across upgrades of the software,
465# although it means that duplicate documents contained in the collection are
466# no longer detected automatically."
467 print STDERR "$collection - Importing:\n";
468 print $xml_fh "<import>\n";
469 &run_build_script("import.pl -removeold $collection"); #-OIDtype hash_on_full_filename
470 print $xml_fh "</import>\n";
471 print STDERR "done\n";
472
473 #build
474 print STDERR "$collection - Building:\n";
475 print $xml_fh "<build>\n";
476 &run_build_script("buildcol.pl -removeold $collection");
477 print $xml_fh "</build>\n";
478 print STDERR "done\n";
479
480 #rename the intermediate 'building' directory 'index'
481 print STDERR "$collection - Move \"building\" to \"index\"... ";
482 my $index = &filename_concat("collect", $collection, "index");
483 my $building = &filename_concat("collect", $collection, "building");
484 &File::Path::remove_tree($index);
485 # Renaming Directories, http://www.perlmonks.org/?node_id=177421
486 move($building, $index) or die "copy failed: $!"; # File::Copy::move
487 print STDERR "done\n";
488
489 #diffcol
490 print STDERR "$collection - Diffing:\n";
491 my $diffcol_dir = &filename_concat($ENV{'TASK_HOME'},"diffcol");
492 $cmd = "diffcol.pl -output xml -verbosity 10 $collection"; # need to run with ./diffcol.pl if bash script
493 &run_diff_script($cmd, $xml_fh, $diffcol_dir);
494
495 chdir($greenstone_home); # this is actually where we are
496 print STDERR "done\n";
497 print $xml_fh "</collection-test>\n";
498 }
499 closedir $collect_handle; # close handle to collect dir
500
501 print $xml_fh "</test>\n";
502 close($xml_fh);
503
504 print STDERR "done\n";
505}
506
507##***************************************************************
508# runs setup in greenstone_home before running the diff command
509sub run_diff_script {
510 my ($cmd, $fh, $diffcol_dir) = @_;
511
512 # we're in greenstone_home now
513 if(!$isWin) {
514 $cmd = "bash -c \"export GSDLHOME=&& source $setup_script.bash && cd $diffcol_dir && ./$cmd\"";
515
516 } else { # Need to prefix cmd -c/-k as necessary
517 $cmd = "cmd /c \"set GSDLHOME=&& $setup_script.bat && cd $diffcol_dir && perl -S $cmd\"";
518## print STDERR "@@@@ Going to call command: $cmd\n";
519 }
520
521 return &run_and_print_cmd($cmd, $fh);
522}
523
524# runs setup in greenstone_home before running the given build command
525sub run_build_script {
526 my ($cmd, $fh) = @_;
527
528# chdir($greenstone_home);
529 # we are in $greenstone_home already, can directly run the build cmd on the collection
530 if(!$isWin) {
531 $cmd = "bash -c \"export GSDLHOME=&& source $setup_script.bash && $cmd\"";
532
533 } else { # Need to prefix cmd -c/-k as necessary
534 $cmd = "cmd /c \"set GSDLHOME=&& $setup_script.bat && perl -S $cmd\"";
535 }
536## print STDERR "@@@@ Going to call command: $cmd\n";
537
538 return system($cmd);
539 #return &run_and_print_cmd($cmd, $fh); # doesn't work on cmds chained with bash -c
540}
541
542
543# http://stackoverflow.com/questions/758611/how-to-flush-output-in-backticks-in-perl?rq=1activeperl%20sys::info
544# http://stackoverflow.com/questions/1477500/how-do-i-get-the-output-of-an-external-command-in-perl
545sub run_and_print_cmd {
546 my ($cmd, $fh) = @_;
547
548 open my $pin, "$cmd|" or die "unable to run cmd $cmd: $!"; # open(my $fh, '-|', 'powercfg -l') or die $!;
549
550 if(defined $fh) { # print cmd output both to the filehandle and to stdout
551 while (my $line = <$pin>) {
552 print $fh $line;
553# print STDOUT $line; # if also printing cmd output to STDOUT
554 }
555 }
556 else { # no filehandle, so just need to print to stdout
557
558 # unlike backticks operator, system() will print the output of the command to the screen as it executes
559 # http://stackoverflow.com/questions/758611/how-to-flush-output-in-backticks-in-perl?rq=1
560
561 my $status = system $cmd;
562 if($status != 0) {
563 print STDERR "ERROR ($status) running $cmd: $!\n";
564 }
565 }
566 close($pin);
567}
568
569sub filename_concat {
570 my $first_file = shift(@_);
571 my (@filenames) = @_;
572
573 # If first_file is not null or empty, then add it back into the list
574 if (defined $first_file && $first_file =~ /\S/)
575 {
576 unshift(@filenames, $first_file);
577 }
578
579 my $filename = join($sep, @filenames);
580 $filename =~ s/[\\\/]$//; # remove trailing slashes if any
581 return $filename;
582}
583
584
585# The following code is from
586# http://stackoverflow.com/questions/227613/how-can-i-copy-a-directory-recursively-and-filter-filenames-in-perl
587# It also states that "Perl's File::Copy is a bit broken (it doesn't copy permissions on Unix systems, for example)"
588sub copy_recursively {
589 my ($from_dir, $to_dir, $regex) = @_;
590 opendir my($dh), $from_dir or die "Could not open dir '$from_dir': $!";
591
592# if(-d !$to_dir) {
593# mkdir $to_dir or die "mkdir '$to_dir' failed: $!" if not -e $to_dir;
594# }
595
596 for my $entry (readdir $dh) {
597 next if ($entry eq "." || $entry eq "..");
598 next if (defined $regex && $entry =~ /$regex/);
599 my $source = "$from_dir/$entry";
600 my $destination = "$to_dir/$entry";
601 if (-d $source) {
602 mkdir $destination or die "mkdir '$destination' failed: $!" if not -e $destination;
603 copy_recursively($source, $destination, $regex);
604 } else {
605 copy($source, $destination) or die "copy failed: $!";
606 }
607 }
608 closedir $dh;
609 return;
610}
611
612sub summarise {
613
614 # make a summarised Xml report
615 print STDERR "Summarizing the xml report... ";
616 my $cmd = "java org.apache.xalan.xslt.Process -IN $xmlout -XSL $ENV{'TASK_HOME'}/xsl/xml-report.xsl -OUT $ENV{'DATA_DIR'}/report-$dateid.xml";
617 my $status = system($cmd);
618 print STDERR "done\n";
619
620 # make a summarised HTMl report
621 print STDERR "Creating an html summary report... ";
622 $cmd = "java org.apache.xalan.xslt.Process -IN $ENV{'DATA_DIR'}/report-$dateid.xml -XSL $ENV{'TASK_HOME'}/xsl/html-report.xsl -OUT $ENV{'DATA_DIR'}/report-$dateid.html";
623 $status = system($cmd);
624 print STDERR "done\n";
625}
626
627sub upload {
628 # if the upload dir already existed, clear it of contents
629 if (-d $ENV{'UPLOAD_DIR'}) { #else rm $UPLOAD_DIR/*
630 # don't want to keep previous days reports
631 # else we will have to manually clear them at some point
632 # just generate the set of reports for this run of task.pl upload
633 # and
634 &File::Path::remove_tree($ENV{'UPLOAD_DIR'});
635 }
636 # recreate the upload directory
637 &File::Path::make_path($ENV{'UPLOAD_DIR'});
638
639 # copy all *.xml and *.html files across to UPLOAD_DIR
640 opendir my($dh), $ENV{'DATA_DIR'} or die "Could not open DATA_DIR: $!";
641 for my $entry (readdir $dh) {
642 next if ($entry !~ m/(\.xml|\.html?)$/);
643
644 # copy the reports across with different names: with OS prefixed to them. And for the HTML file on Win, rename to HTM
645 # html files uploaded from windows to nzdl are empty for no reason. Uploading as htm seems to work
646 my $os_entry = $entry;
647 $os_entry =~ s@\[email protected]@ if $isWin;
648 $os_entry = $^O."-diffcol-$os_entry";
649
650 # get the absolute path to the original files before copying them over
651 $entry = &filename_concat($ENV{'DATA_DIR'}, $entry);
652
653 # copy them over with their new names
654## print STDERR "@@@@ copying across $entry to $ENV{'UPLOAD_DIR'} as $os_entry\n";
655 copy($entry, "$ENV{'UPLOAD_DIR'}$sep$os_entry"); #copy($entry, "$ENV{'UPLOAD_DIR'}");
656 }
657 closedir $dh;
658
659
660 # Upload the html file to puka
661 #default identity dir
662 if ( ! exists $ENV{'IDENTITY_DIR'} ) {
663 $ENV{'IDENTITY_DIR'} = "$ENV{'HOME'}${sep}.ssh"; # "C:\\Research\\Nightly\\tools\\keys" on windows, see environment.pl
664 }
665 if (! exists $ENV{'SNAPSHOT_MODE'} ) {
666 $ENV{'SNAPSHOT_MODE'} = "caveat";
667 }
668
669 #use the correct key for uploading
670 $ENV{'IDENTITY_FILE'} = "$ENV{'IDENTITY_DIR'}${sep}upload-" . $ENV{'SNAPSHOT_MODE'} . ($^O eq "MSWin32" ? ".ppk" : "");
671 if(-f $ENV{'IDENTITY_FILE'}) {
672 # if you need to touch the file on windows: http://stackoverflow.com/questions/51435/windows-version-of-the-unix-touch-command
673
674 # the report we want to upload is actually just os-diffcol-report-$dateid.html
675 my $command = "cd \"$ENV{'UPLOAD_DIR'}\" && tar -c *.htm* | "; #&& cat *.html | "; # && tar -c * |
676 $command .= ($^O eq "MSWin32" ? "plink" : "ssh");
677 $command .= " -T -i \"$ENV{'IDENTITY_FILE'}\" nzdl\@puka.cs.waikato.ac.nz";
678 #print "$command\n";
679 my $status = system("$command");
680 if($status != 0) {
681 print STDERR "*** Failed to upload test report to nzdl $status\n";
682 }
683 } else {
684 print STDERR "*** Cannot upload the test report to nzdl from this machine\n";
685 }
686
687 print STDERR "Finished uploading\n";
688}
689
690# Sending emails with perl: http://learn.perl.org/examples/email.html
691# Sending email attachments with perl: http://www.perlmonks.org/?node_id=19430
692# Sadly none of the packages are installed by default and use of MIME::Lite is discouraged
693sub mail_with_report_attached
694{
695 # email out with report attached, if the tests failed
696 print STDERR "Checking if successful... \n";
697 my $cmd = "java org.apache.xalan.xslt.Process -IN $xmlout -XSL $ENV{'TASK_HOME'}/xsl/passed-or-not.xsl";
698 #my $result = system($cmd);
699 my $result = `$cmd`;
700
701 print STDERR "result: $result\n";
702
703 if($result ne "yes") {
704 my $msg = "$gsdl regression test for $dateid failed";
705 my $subject = "Regression Test Failed"; #"$gsdl regression test for $dateid failed\n";
706 my $attach_file = &filename_concat($ENV{'DATA_DIR'}, "report-$dateid.html");
707
708 if($isWin) {
709 if($use_blat && $blat && $ENV{'GSDL_SMTP'}) {
710 # http://stackoverflow.com/questions/709635/sending-mail-from-batch-file
711 #blat -to [email protected] -server smtp.example.com -f [email protected] -subject "subject" -body "body"
712
713 # need to install blat on windows
714 $cmd = "$blat -to $ENV{'MONITOR_EMAIL'} -server $ENV{'GSDL_SMTP'} -f $ENV{'MONITOR_EMAIL'} -attach $attach_file -subject \"$subject\" -body \"$msg\"";
715 $result = system($cmd);
716 }
717 else {
718 $result = 1; # status from running mail command is 0 if success, 1 if fail
719 print STDERR "********************************************\n";
720 if ($use_blat) {
721 print STDERR "Need blat and SMTP set to send mail attachment\n" ;
722 } else {
723 print STDERR "Not set up to send mail on Windows\n";
724 }
725 print STDERR "Inspect report at: $attach_file\n";
726 print STDERR "********************************************\n";
727 }
728 } else { # linux
729 my $status = system("command -v mutt > /dev/null 2>&1;"); #better way of doing "which mutt"
730
731 if($status != 0) { # mutt doesn't exist, can't send attachments, so send simple email
732 $cmd="echo '$gsdl regression test for $dateid failed.' | mail -s 'Regression Test Failed' $ENV{'MONITOR_EMAIL'}";
733
734 print STDERR "********************************************\n";
735 print STDERR "No mutt installed, unable to mail attachment\n";
736 print STDERR "Inspect report at: $attach_file\n";
737 print STDERR "********************************************\n";
738 } else {
739 #$cmd = "bash -c \"echo '$gsdl regression test for $dateid failed' | mutt -a $attach_file -s 'Regression Test Failed' -- $ENV{'MONITOR_EMAIL'}\"";
740 $cmd = "echo '$gsdl regression test for $dateid failed' | mutt -a $attach_file -s 'Regression Test Failed' -- $ENV{'MONITOR_EMAIL'}";
741 }
742
743 # run the mail command
744 $result = system($cmd); #&run_and_print_cmd($cmd);
745 }
746
747
748 if($result != 0) {
749 print STDERR "*** Unable to send email: $?\n";
750 }
751 else {
752 print STDERR "Sent mail with report attached.\n";
753 }
754 } else {
755 print STDERR "********************************************\n";
756 print STDERR "Tests were successful. Not sending mail.\n";
757 print STDERR "********************************************\n";
758 }
759}
760
761# The old version of this program contained the following, consisting of 1 line of active code:
762
763 # Invoke as: sjmc@br:/research/sjm84/envi/bin$ ./envi diffcol summarise
764 # Doing so will call this pl file and pass in "summarise" in ARGV
765 # This pl file will in turn call the task executable in this folder
766 # passing in "summarise" as a parameter.
767#system("/bin/bash -c \"../etc/tasks/diffcol/task @ARGV\"");
768
769 ##system("/bin/bash -c \"./task @ARGV\"");
770 ##print STDERR "/bin/bash -c ../etc/tasks/diffcol/task @ARGV"
771
Note: See TracBrowser for help on using the repository browser.