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

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

New variable use_local_rebuild, though not for nightly use, can speed up local testing of new tutorials to be committed.

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