Changeset 7279

Timestamp:

04/28/10 07:58:58 (2 years ago)

Author:

MichaelTempest

Message:

Item1326: Ensure that each selenium-based test object (including the first to run) is destroyed after the test has run

File:

• trunk/UnitTestContrib/test/unit/FoswikiSeleniumTestCase.pm (modified) (6 diffs)

trunk/UnitTestContrib/test/unit/FoswikiSeleniumTestCase.pm

@@ -15 +15 @@
 use Error qw( :try );
 use Encode;
+use Scalar::Util qw( weaken );
 
 my $startWait;
@@ -41 +42 @@
 my $browsers;
 my @BrowserFixtureGroups;
+my $currentTest;
 
 my $debug = 0;
-
-my $instance_count = 0;
 
 sub new {
@@ -50 +50 @@
     my $this  = $class->SUPER::new(@_);
 
-    $instance_count++;
+    if (defined $currentTest) {
+        $this->assert(0,
+            "There may only be one FoswikiSeleniumTestCase-based test\n"
+            . "running in each test process.\n"
+            . "Cannot run the $class test \n"
+            . "because the $currentTest is still running.");
+    }
+    $currentTest = $this;
+    weaken($currentTest); # Ensure the destructor is called at the normal time
 
     $this->{selenium_timeout} = 30_000; # Same as WWW::Selenium's default value
@@ -63 +71 @@
 END {
     _shutDownSeleniumBrowsers() if $browsers;
+}
+
+sub DESTROY {
+    my $this = shift;
+    if (not defined($currentTest) or $currentTest != $this) {
+        $this->assert(0,
+            "Unexpected change of current test:"
+          . "Expected $this but found $currentTest");
+    }
+    $this->SUPER::DESTROY if $this->can('SUPER::DESTROY');
 }
 
@@ -130 +148 @@
                 $config{browser_url} ||= $Foswiki::cfg{DefaultUrlHost};
 
-                $config{error_callback} = sub { $this->assert(0, join(' ', @_)); };
+                # The error callback needs a reference to the current test
+                # object. There may be several test objects that use the
+                # selenium interface, so the error callback cannot be a 
+                # closure (anonymous sub) that uses $this (because $this
+                # in a closure would always refers to the first test
+                # to run that is derived from FoswikiSeleniumTestCase).
+                # Instead, the error callback uses a static class variable
+                # that is set (and weakened) in the constructor.
+                $config{error_callback} = \&_errorCallback;
 
                 my $selenium = Test::WWW::Selenium->new( %config );
                 if ($selenium) {
                     $browsers->{$browser} = $selenium;
+                }
+                else {
+                    $this->assert(0, "Could not create a Test::WWW::Selenium object for $browser");
                 }
             }
@@ -152 +181 @@
 
     return $browsers;
+}
+
+sub _errorCallback {
+    if ($currentTest) {
+        $currentTest->assert(0, join(' ', @_));
+    }
+    else {
+        die "A Test::WWW::Selenium class reported an error, "
+          . "but the associated test-case object has "
+          . "already been destroyed. The error is:\n"
+          . join(' ', @_);
+    }
 }