Changeset 13689

Timestamp:

01/17/12 23:36:06 (17 months ago)

Author:

PaulHarvey

Message:

Item11431: Add finish..session, SINGLE_SINGLETONS

Location:

trunk/UnitTestContrib/test/unit

Files:

• FoswikiFnTestCase.pm (modified) (4 diffs)
• FoswikiTestCase.pm (modified) (6 diffs)

trunk/UnitTestContrib/test/unit/FoswikiFnTestCase.pm

@@ -2 +2 @@
 
 package FoswikiFnTestCase;
+use strict;
+use warnings;
 
 =begin TML
@@ -25 +27 @@
 =cut
 
-use FoswikiTestCase;
+use FoswikiTestCase();
 our @ISA = qw( FoswikiTestCase );
 
-use strict;
-
-use Foswiki;
-use Unit::Request;
-use Unit::Response;
-use Foswiki::UI::Register;
+use Foswiki();
+use Unit::Request();
+use Unit::Response();
+use Foswiki::UI::Register();
 use Error qw( :try );
 
@@ -85 +85 @@
     $query->path_info("/$this->{test_web}/$this->{test_topic}");
 
-    $this->{session}           = new Foswiki( undef, $query );
-    $this->{request}           = $query;
-    $this->{response}          = new Unit::Response();
-    $Foswiki::Plugins::SESSION = $this->{session};
-    @mails                     = ();
+    # Note: some tests are testing Foswiki::UI which also creates a session
+    $this->createNewFoswikiSession( undef, $query );
+    $this->{response} = new Unit::Response();
+    @mails = ();
     $this->{session}->net->setMailHandler( \&FoswikiFnTestCase::sentMail );
     my $webObject = Foswiki::Meta->new( $this->{session}, $this->{test_web} );
@@ -108 +107 @@
     $this->{test_user_cuid} =
       $this->{session}->{users}->getCanonicalUserID( $this->{test_user_login} );
+    $this->{test_topicObject}->finish() if $this->{test_topicObject};
     $this->{test_topicObject} = Foswiki::Meta->new(
         $this->{session},    $this->{test_web},

trunk/UnitTestContrib/test/unit/FoswikiTestCase.pm

@@ -19 +19 @@
 use strict;
 use warnings;
+
+use Assert;
 use Unit::TestCase;
 our @ISA = qw( Unit::TestCase );
@@ -30 +32 @@
 use Unit::Response;
 use Error qw( :try );
+
+sub SINGLE_SINGLETONS { 0 }
 
 BEGIN {
@@ -437 +441 @@
     close(F);
 
+    ASSERT( !defined $Foswiki::Plugins::SESSION ) if SINGLE_SINGLETONS;
+
     # Force completion of %Foswiki::cfg
     # This must be done before moving the logging.
     my $query = new Unit::Request();
     my $tmp = new Foswiki( undef, $query );
+    ASSERT( defined $Foswiki::Plugins::SESSION ) if SINGLE_SINGLETONS;
     $tmp->finish();
+    ASSERT( !defined $Foswiki::Plugins::SESSION ) if SINGLE_SINGLETONS;
 
     my %tempDirOptions = ( CLEANUP => 1 );
@@ -477 +485 @@
 sub tear_down {
     my $this = shift;
-    $this->{session}->finish() if $this->{session};
+
+    if ( $this->{session} ) {
+        ASSERT( $this->{session}->isa('Foswiki') ) if SINGLE_SINGLETONS;
+        $this->finishFoswikiSession();
+    }
     eval { File::Path::rmtree( $Foswiki::cfg{WorkingDir} ); };
     %Foswiki::cfg = eval $this->{__FoswikiSafe};
@@ -566 +578 @@
 
 sub capture {
-    my $this = shift;
-
-    my ( $stdout, $stderr, $result ) = $this->captureSTD(@_);
-    my $fn = shift;
-
+    my ( $this, $fn, $session, @args ) = @_;
+
+    # $fn may create a new Foswiki singleton, so it should take care to avoid
+    # stomping on the existing one without $this->finishFoswikiSession() or
+    # createNewFoswikiSession()
+    my ( $stdout, $stderr, $result ) =
+      $this->captureSTD( $fn, $session, @args );
+
+    ASSERT( ref($session) || ref($Foswiki::Plugins::SESSION) );
     my $response =
-      UNIVERSAL::isa( $_[0], 'Foswiki' )
-      ? $_[0]->{response}
+      UNIVERSAL::isa( $session, 'Foswiki' )
+      ? $session->{response}
       : $Foswiki::Plugins::SESSION->{response};
 
@@ -708 +724 @@
     my ( $this, $user, $query, @args ) = @_;
 
-    $this->{session}->finish() if $this->{session};
-    $this->{request}->finish()
-      if ( $this->{request} && $this->{request}->can('finish') );
-    $this->{session}           = Foswiki->new( $user, $query, @args );
-    $this->{request}           = $this->{session}{request};
-    $Foswiki::Plugins::SESSION = $this->{session};
-    $this->{test_topicObject}->finish() if $this->{test_topicObject};
+    $this->{test_topicObject}->finish()           if $this->{test_topicObject};
+    $this->{session}->finish()                    if $this->{session};
+    ASSERT( !defined $Foswiki::Plugins::SESSION ) if SINGLE_SINGLETONS;
+    $this->{session} = Foswiki->new( $user, $query, @args );
+    $this->{request} = $this->{session}{request};
+    ASSERT( defined $Foswiki::Plugins::SESSION ) if SINGLE_SINGLETONS;
     ( $this->{test_topicObject} ) =
       Foswiki::Func::readTopic( $this->{test_web}, $this->{test_topic} );
 
     return $this->{session};
+}
+
+sub finishFoswikiSession {
+    my ($this) = @_;
+
+    $this->{session}->finish() if defined $this->{session};
+    ASSERT( !$Foswiki::Plugins::SESSION ) if SINGLE_SINGLETONS;
+    $this->{session} = undef;
+
+    return;
 }