Try again (up to ten times) if main loop exits prematurely.
[irspy-moved-to-github.git] / lib / ZOOM / IRSpy.pm
index 52c586e..ff85dec 100644 (file)
@@ -1,4 +1,4 @@
-# $Id: IRSpy.pm,v 1.42 2006-10-27 15:36:04 mike Exp $
+# $Id: IRSpy.pm,v 1.55 2006-12-18 15:32:32 mike Exp $
 
 package ZOOM::IRSpy;
 
@@ -6,9 +6,6 @@ use 5.008;
 use strict;
 use warnings;
 
-use Exporter 'import';
-our @EXPORT_OK = qw(xml_encode irspy_xpath_context);
-
 use Data::Dumper;              # For debugging only
 use File::Basename;
 use XML::LibXSLT;
@@ -19,10 +16,11 @@ use Net::Z3950::ZOOM 1.13;  # For the ZOOM version-check only
 use ZOOM::IRSpy::Node;
 use ZOOM::IRSpy::Connection;
 use ZOOM::IRSpy::Record;
+use ZOOM::IRSpy::Stats;
+use ZOOM::IRSpy::Utils qw(cql_target);
 
 our @ISA = qw();
 our $VERSION = '0.02';
-our $irspy_ns = 'http://indexdata.com/irspy/1.0';
 our $irspy_to_zeerex_xsl = dirname(__FILE__) . '/../../xsl/irspy2zeerex.xsl';
 
 
@@ -32,6 +30,7 @@ sub OK { 29 }                 # No problems, task is still progressing
 sub TASK_DONE { 18 }           # Task is complete, next task should begin
 sub TEST_GOOD { 8 }            # Whole test is complete, and succeeded
 sub TEST_BAD { 31 }            # Whole test is complete, and failed
+sub TEST_SKIPPED { 12 }                # Test couldn't be run
 package ZOOM::IRSpy;
 
 
@@ -43,7 +42,9 @@ ZOOM::IRSpy - Perl extension for discovering and analysing IR services
 
  use ZOOM::IRSpy;
  $spy = new ZOOM::IRSpy("target/string/for/irspy/database");
- print $spy->report_status();
+ $spy->targets(@targets);
+ $spy->initialise();
+ $res = $spy->check("Main");
 
 =head1 DESCRIPTION
 
@@ -74,6 +75,10 @@ sub new {
        or die "$0: can't connection to IRSpy database 'dbname'";
 
     my $xslt = new XML::LibXSLT;
+
+    $xslt->register_function($ZOOM::IRSpy::Utils::IRSPY_NS, 'strcmp',
+                             \&ZOOM::IRSpy::Utils::xslt_strcmp);
+
     my $libxml = new XML::LibXML;
     my $xsl_doc = $libxml->parse_file($irspy_to_zeerex_xsl);
     my $irspy_to_zeerex_style = $xslt->parse_stylesheet($xsl_doc);
@@ -119,7 +124,7 @@ sub targets {
            $this->log("irspy_debug", "rewriting '$target' to '$newtarget'");
            $target = $newtarget; # This is written through the ref
        }
-       push @qlist, (qq[(host="$host" and port="$port" and path="$db")]);
+       push @qlist, cql_target($host, $port, $db);
     }
 
     $this->{targets} = \@targets;
@@ -243,9 +248,16 @@ sub _render_record {
 sub _irspy_to_zeerex {
     my ($this, $conn) = @_;
     my $irspy_doc = $conn->record()->{zeerex}->ownerDocument;
+    #open FH, '>/tmp/irspy_orig.xml';
+    #print FH $irspy_doc->toString();
+    #close FH;
     my %params = ();
     my $result = $this->{irspy_to_zeerex_style}->transform($irspy_doc, %params);
 
+    #open FH, '>/tmp/irspy_transformed.xml';
+    #print FH $result->toString();
+    #close FH;
+
     return $result->documentElement();
 }
 
@@ -322,6 +334,8 @@ sub check {
 
     my @conn = @{ $this->{connections} };
 
+    my $nruns = 0;
+  ROUND_AND_ROUND_WE_GO:
     while (1) {
        my @copy_conn = @conn;  # avoid alias problems after splice()
        my $nconn = scalar(@copy_conn);
@@ -345,6 +359,7 @@ sub check {
                        $conn->log("irspy", "has no more tests: removing");
                        splice @conn, $i0, 1;
                        $this->_rewrite_record($conn);
+                       $conn->option(rewrote_record => 1);
                        next;
                    }
 
@@ -449,12 +464,66 @@ sub check {
                    $nskipped += $n;
                }
            }
+
+       } elsif ($res == ZOOM::IRSpy::Status::TEST_SKIPPED) {
+           $conn->log("irspy_test", "test skipped during task $task");
+           $conn->current_task(0);
+           $conn->next_task(0);
+           # I think that's all we need to do
+
        } else {
            die "unknown callback return-value '$res'";
        }
     }
 
     $this->log("irspy", "exiting main loop");
+    # Sanity checks: none of the following should ever happen
+    my $finished = 1;
+    foreach my $conn (@{ $this->{connections} }) {
+       my $test = $conn->option("current_test_address");
+       my $next = $this->_next_test($test);
+       if (defined $next) {
+           $this->log("irspy", "$conn (in test '$test') has queued test '$next'");
+           $finished = 0;
+       }
+       if (my $task = $conn->current_task()) {
+           $this->log("irspy", "$conn still has an active task $task");
+           $finished = 0;
+       }
+       if (my $task = $conn->next_task()) {
+           $this->log("irspy", "$conn still has a queued task $task");
+           $finished = 0;
+       }
+       if (!$conn->is_idle()) {
+           $this->log("irspy", "$conn still has ZOOM-C level tasks queued: see below");
+           $finished = 0;
+       }
+       if (!$conn->option("rewrote_record")) {
+           $this->log("irspy", "$conn did not rewrite its ZeeRex record");
+           $finished = 0;
+       }
+    }
+
+    # This really shouldn't be necessary, but it's belt and braces
+    if (!$finished) {
+       if (++$nruns < 10) {
+           $this->log("irspy", "back into main loop, ${nruns}th time");
+           goto ROUND_AND_ROUND_WE_GO;
+       } else {
+           $this->log("irspy", "bailing after $nruns main-loop runs");
+       }
+    }
+
+    # This shouldn't happen emit anything either:
+    @conn = @{ $this->{connections} };
+    while (my $i1 = ZOOM::event(\@conn)) {
+       my $conn = $conn[$i1-1];
+       my $ev = $conn->last_event();
+       my $evstr = ZOOM::event_str($ev);
+       warn "$conn still has ZOOM-C level task queued: $ev ($evstr)"
+           if $ev != ZOOM::Event::ZEND;
+    }
+
     return $nskipped;
 }
 
@@ -472,13 +541,6 @@ sub _gather_tests {
     my $fullName = "ZOOM/IRSpy/Test/$slashSeperatedTname.pm";
 
     eval {
-       ### This next line shouldn't be necessary, as we should
-       #   already be running in an environment where the test
-       #   modules are available -- otherwise, how did _this_ module
-       #   get loaded?  But it seems that for reasons I don't
-       #   understand we do sometimes (not always!) need this when
-       #   running under Apache.
-       use lib '/usr/local/src/cvs/irspy/lib';
        require $fullName;
        $this->log("irspy", "successfully required '$fullName'");
     }; if ($@) {
@@ -536,8 +598,8 @@ sub _last_sibling_test {
        my $maybe = $this->_next_sibling_test($address);
        last if !defined $maybe;
        $nskipped++;
-       $this->log("irspy", "skipping $nskipped tests to '$address'");
        $address = $maybe;
+       $this->log("irspy", "skipping $nskipped tests to '$address'");
     }
 
     return ($address, $nskipped);
@@ -556,38 +618,6 @@ sub _next_sibling_test {
 }
 
 
-# Utility functions follow, exported for use of web UI
-
-# I can't -- just can't, can't, can't -- believe that this function
-# isn't provided by one of the core XML modules.  But the evidence all
-# says that it's not: among other things, XML::Generator and
-# Template::Plugin both roll their own.  So I will do likewise.  D'oh!
-#
-sub xml_encode {
-    my ($text) = @_;
-    $text =~ s/&/&amp;/g;
-    $text =~ s/</&lt;/g;
-    $text =~ s/>/&gt;/g;
-    $text =~ s/['']/&apos;/g;
-    $text =~ s/[""]/&quot;/g;
-    return $text;
-}
-
-
-sub irspy_xpath_context {
-    my($zoom_record) = @_;
-
-    my $xml = $zoom_record->render();
-    my $parser = new XML::LibXML();
-    my $doc = $parser->parse_string($xml);
-    my $root = $doc->getDocumentElement();
-    my $xc = XML::LibXML::XPathContext->new($root);
-    $xc->registerNs(e => 'http://explain.z3950.org/dtd/2.0/');
-    $xc->registerNs(i => $irspy_ns);
-    return $xc;
-}
-
-
 =head1 SEE ALSO
 
 ZOOM::IRSpy::Record,