From 4e78593395ed240c4ef029260be0b02b30dc4a0b Mon Sep 17 00:00:00 2001
From: Colin Kuskie <colink@perldreamer.com>
Date: Mon, 30 Mar 2009 20:41:02 +0000
Subject: [PATCH] Change tests to use the automatic backup of Settings in END
 blocks.

---
 t/Asset/Asset.t                             | 4 ----
 t/Asset/AssetMetaData.t                     | 2 --
 t/Asset/Event/edit.t                        | 7 -------
 t/Asset/File/GalleryFile/Photo/edit.t       | 6 ------
 t/Asset/Redirect/mech.t                     | 7 -------
 t/Asset/Wobject/GalleryAlbum/edit.t         | 7 -------
 t/Asset/Wobject/GalleryAlbum/rss.t          | 6 ------
 t/Auth/mech.t                               | 7 -------
 t/Group.t                                   | 2 +-
 t/Macro/L_loginBox.t                        | 3 ---
 t/Macro/PageUrl.t                           | 5 +----
 t/Macro/Slash_gatewayUrl.t                  | 9 +--------
 t/Macro/c_companyName.t                     | 1 -
 t/Mail/Send.t                               | 6 +-----
 t/PassiveProfiling.t                        | 2 --
 t/Session/ErrorHandler.t                    | 8 --------
 t/Session/Http.t                            | 2 --
 t/Session/Privilege.t                       | 2 --
 t/Session/Style.t                           | 2 --
 t/Session/Url.t                             | 5 +----
 t/Storage/Image.t                           | 3 ---
 t/Workflow/Activity/DeleteExpiredSessions.t | 1 -
 t/lib/WebGUI/Test.pm                        | 9 ++++++++-
 23 files changed, 13 insertions(+), 93 deletions(-)

diff --git a/t/Asset/Asset.t b/t/Asset/Asset.t
index e3669ddd1..c7f939cbc 100644
--- a/t/Asset/Asset.t
+++ b/t/Asset/Asset.t
@@ -810,10 +810,6 @@ END {
         if defined $origExtras;
     $session->config->set( 'uploadsURL',   $origUploads)
         if defined $origUploads;
-    $session->setting->set('urlExtension', $origUrlExtension)
-        if defined $origUrlExtension;
-    $session->setting->set('notFoundPage', $origNotFoundPage)
-        if defined $origNotFoundPage;
     if (defined $originalAssetOverrides) {
         $session->config->set('assets', $originalAssetOverrides);
     }
diff --git a/t/Asset/AssetMetaData.t b/t/Asset/AssetMetaData.t
index 1ab4920f4..05fb0c648 100644
--- a/t/Asset/AssetMetaData.t
+++ b/t/Asset/AssetMetaData.t
@@ -195,7 +195,6 @@ cmp_deeply(
 #
 ####################################################
 
-my $origMetaEnabled = $session->setting->get("metaDataEnabled");
 $session->setting->set("metaDataEnabled", 1);
 
 # add another field for comparison
@@ -236,6 +235,5 @@ END {
             $tag->rollback;
         }
     }
-    $session->setting->set("metaDataEnabled", $origMetaEnabled);
 
 }
diff --git a/t/Asset/Event/edit.t b/t/Asset/Event/edit.t
index afb9aaea6..be21874e9 100644
--- a/t/Asset/Event/edit.t
+++ b/t/Asset/Event/edit.t
@@ -30,11 +30,8 @@ my $node            = WebGUI::Asset->getImportNode( $session );
 my @versionTags     = ( WebGUI::VersionTag->getWorking( $session ) );
 
 # Override some settings to make things easier to test
-my %oldSettings;
 # userFunctionStyleId 
-$oldSettings{ userFunctionStyleId } = $session->setting->get( 'userFunctionStyleId' );
 $session->setting->set( 'userFunctionStyleId', 'PBtmpl0000000000000132' );
-$oldSettings{ defaultVersionTagWorkflow } = $session->setting->get( 'defaultVersionTagWorkflow' );
 $session->setting->set( 'defaultVersionTagWorkflow', 'pbworkflow000000000003' );
 
 # Create a user for testing purposes
@@ -173,10 +170,6 @@ END {
     }
 
     $user->delete;
-
-    for my $key ( keys %oldSettings ) {
-        $session->setting->set( $key, $oldSettings{ $key } );
-    }
 }
 
 #----------------------------------------------------------------------------
diff --git a/t/Asset/File/GalleryFile/Photo/edit.t b/t/Asset/File/GalleryFile/Photo/edit.t
index 480f06e15..53d15fb24 100644
--- a/t/Asset/File/GalleryFile/Photo/edit.t
+++ b/t/Asset/File/GalleryFile/Photo/edit.t
@@ -27,12 +27,9 @@ my $node            = WebGUI::Asset->getImportNode( $session );
 my @versionTags     = ( WebGUI::VersionTag->getWorking( $session ) );
 
 # Override some settings to make things easier to test
-my %oldSettings;
 # userFunctionStyleId 
-$oldSettings{ userFunctionStyleId } = $session->setting->get( 'userFunctionStyleId' );
 $session->setting->set( 'userFunctionStyleId', 'PBtmpl0000000000000132' );
 # specialState
-$oldSettings{ specialState  } = $session->setting->get( 'specialState' );
 $session->setting->set( 'specialState', '' );
 
 # Create a user for testing purposes
@@ -141,9 +138,6 @@ END {
 
     $user->delete;
 
-    for my $key ( keys %oldSettings ) {
-        $session->setting->set( $key, $oldSettings{ $key } );
-    }
 }
 
 #----------------------------------------------------------------------------
diff --git a/t/Asset/Redirect/mech.t b/t/Asset/Redirect/mech.t
index b5a914430..b23af0c81 100644
--- a/t/Asset/Redirect/mech.t
+++ b/t/Asset/Redirect/mech.t
@@ -29,12 +29,9 @@ my $node            = WebGUI::Asset->getImportNode( $session );
 my @versionTags     = ( WebGUI::VersionTag->getWorking( $session ) );
 
 # Override some settings to make things easier to test
-my %oldSettings;
 # userFunctionStyleId 
-$oldSettings{ userFunctionStyleId } = $session->setting->get( 'userFunctionStyleId' );
 $session->setting->set( 'userFunctionStyleId', 'PBtmpl0000000000000132' );
 # specialState
-$oldSettings{ specialState  } = $session->setting->get( 'specialState' );
 $session->setting->set( 'specialState', '' );
 
 # Create a user for testing purposes
@@ -180,8 +177,4 @@ END {
     }
 
     $user->delete;
-
-    for my $key ( keys %oldSettings ) {
-        $session->setting->set( $key, $oldSettings{ $key } );
-    }
 }
diff --git a/t/Asset/Wobject/GalleryAlbum/edit.t b/t/Asset/Wobject/GalleryAlbum/edit.t
index 807d61691..11d76a337 100644
--- a/t/Asset/Wobject/GalleryAlbum/edit.t
+++ b/t/Asset/Wobject/GalleryAlbum/edit.t
@@ -28,12 +28,9 @@ my $node            = WebGUI::Asset->getImportNode( $session );
 my @versionTags     = ( WebGUI::VersionTag->getWorking( $session ) );
 
 # Override some settings to make things easier to test
-my %oldSettings;
 # userFunctionStyleId 
-$oldSettings{ userFunctionStyleId } = $session->setting->get( 'userFunctionStyleId' );
 $session->setting->set( 'userFunctionStyleId', 'PBtmpl0000000000000132' );
 # specialState
-$oldSettings{ specialState  } = $session->setting->get( 'specialState' );
 $session->setting->set( 'specialState', '' );
 
 # Create a user for testing purposes
@@ -120,10 +117,6 @@ END {
     }
 
     $user->delete;
-
-    for my $key ( keys %oldSettings ) {
-        $session->setting->set( $key, $oldSettings{ $key } );
-    }
 }
 
 #----------------------------------------------------------------------------
diff --git a/t/Asset/Wobject/GalleryAlbum/rss.t b/t/Asset/Wobject/GalleryAlbum/rss.t
index 6b720bf25..66d80c31a 100644
--- a/t/Asset/Wobject/GalleryAlbum/rss.t
+++ b/t/Asset/Wobject/GalleryAlbum/rss.t
@@ -65,12 +65,9 @@ for my $i ( 0 .. 5 ) {
 $versionTag->commit;
 
 # Override some settings to make things easier to test
-my %oldSettings;
 # userFunctionStyleId 
-$oldSettings{ userFunctionStyleId } = $session->setting->get( 'userFunctionStyleId' );
 $session->setting->set( 'userFunctionStyleId', 'PBtmpl0000000000000132' );
 # specialState
-$oldSettings{ specialState  } = $session->setting->get( 'specialState' );
 $session->setting->set( 'specialState', '' );
 
 my ( $mech );
@@ -122,7 +119,4 @@ cmp_deeply(
 # Cleanup
 END {
     $versionTag->rollback();
-    for my $key ( keys %oldSettings ) {
-        $session->setting->set( $key, $oldSettings{ $key } );
-    }
 }
diff --git a/t/Auth/mech.t b/t/Auth/mech.t
index ea990256c..6a38b7bdc 100644
--- a/t/Auth/mech.t
+++ b/t/Auth/mech.t
@@ -34,12 +34,9 @@ my $node            = WebGUI::Asset->getImportNode( $session );
 my @versionTags     = ( WebGUI::VersionTag->getWorking( $session ) );
 
 # Override some settings to make things easier to test
-my %oldSettings;
 # userFunctionStyleId 
-$oldSettings{ userFunctionStyleId } = $session->setting->get( 'userFunctionStyleId' );
 $session->setting->set( 'userFunctionStyleId', 'PBtmpl0000000000000132' );
 # specialState
-$oldSettings{ specialState  } = $session->setting->get( 'specialState' );
 $session->setting->set( 'specialState', '' );
 
 # Create a user for testing purposes
@@ -280,8 +277,4 @@ $mech->base_is( $assetUrl, "We don't get redirected" );
 # Cleanup
 END {
     $user->delete;
-
-    for my $key ( keys %oldSettings ) {
-        $session->setting->set( $key, $oldSettings{ $key } );
-    }
 }
diff --git a/t/Group.t b/t/Group.t
index 30cc99bc1..5672cc790 100644
--- a/t/Group.t
+++ b/t/Group.t
@@ -452,7 +452,7 @@ is_deeply(
 
 my $defaultKarmaSetting = $session->setting->get('useKarma');
 
-$session->setting->set('useKarma', 0) if $defaultKarmaSetting;
+$session->setting->set('useKarma', 0);
 
 is_deeply(
 	[ (map { $_->isInGroup($gK->getId) }  @chameleons) ],
diff --git a/t/Macro/L_loginBox.t b/t/Macro/L_loginBox.t
index 5d4be0c84..17b533806 100644
--- a/t/Macro/L_loginBox.t
+++ b/t/Macro/L_loginBox.t
@@ -45,8 +45,6 @@ plan tests => $numTests;
 my $macro = 'WebGUI::Macro::L_loginBox';
 my $loaded = use_ok($macro);
 
-my $originalEncryptLogin = $session->setting->get('encryptLogin');
-
 SKIP: {
 
 skip "Unable to load $macro", $numTests-1 unless $loaded;
@@ -245,5 +243,4 @@ END { ##Clean-up after yourself, always
 	if (defined $versionTag and ref $versionTag eq 'WebGUI::VersionTag') {
 		$versionTag->rollback;
 	}
-	$session->setting->set("encryptLogin", $originalEncryptLogin);
 }
diff --git a/t/Macro/PageUrl.t b/t/Macro/PageUrl.t
index 1a9a43d0b..dd6853b64 100644
--- a/t/Macro/PageUrl.t
+++ b/t/Macro/PageUrl.t
@@ -25,8 +25,6 @@ $numTests += 1; #For the use_ok
 
 plan tests => $numTests;
 
-my $preventProxyCache = $session->setting->get('preventProxyCache');
-
 my $macro = 'WebGUI::Macro::PageUrl';
 my $loaded = use_ok($macro);
 
@@ -34,7 +32,7 @@ SKIP: {
 
 skip "Unable to load $macro", $numTests-1 unless $loaded;
 
-$session->setting->set('preventProxyCache', 0) if ($preventProxyCache);
+$session->setting->set('preventProxyCache', 0);
 
 my $homeAsset = WebGUI::Asset->getDefault($session);
 
@@ -70,5 +68,4 @@ like($output, qr{/sub/page\?noCache=\d+:\d+;query=this$}, 'checking that the que
 
 END {
 	# See note in the Slash_gateway macro test about this.
-	$session->setting->set("preventProxyCache", $preventProxyCache);
 }
diff --git a/t/Macro/Slash_gatewayUrl.t b/t/Macro/Slash_gatewayUrl.t
index 6c51bc9b1..596bcf6a0 100644
--- a/t/Macro/Slash_gatewayUrl.t
+++ b/t/Macro/Slash_gatewayUrl.t
@@ -29,8 +29,6 @@ $numTests += 1; #For the use_ok
 
 plan tests => $numTests;
 
-my $preventProxyCache = $session->setting->get('preventProxyCache');
-
 my $macro = 'WebGUI::Macro::Slash_gatewayUrl';
 my $loaded = use_ok($macro);
 
@@ -38,7 +36,7 @@ SKIP: {
 
 skip "Unable to load $macro", $numTests-1 unless $loaded;
 
-$session->setting->set('preventProxyCache', 0) if ($preventProxyCache);
+$session->setting->set('preventProxyCache', 0);
 
 my $output;
 
@@ -61,9 +59,4 @@ $session->setting->set('preventProxyCache', 0);
 }
 
 END {
-	# 
-	# Not sure we should be doing this.  I understand we want to leave things as we found them, however if this is set, a lot of tests after this one will fail.
-	# Perhaps we should set it to 0 always, regardless of their setting?
-	#
-	$session->setting->set('preventProxyCache', $preventProxyCache);
 }
diff --git a/t/Macro/c_companyName.t b/t/Macro/c_companyName.t
index ff0174f53..b50a883f0 100644
--- a/t/Macro/c_companyName.t
+++ b/t/Macro/c_companyName.t
@@ -43,5 +43,4 @@ is($output, q|Gooey&#39;s Consulting&#44; LLC|, "Testing companyName with embedd
 }
 
 END {
-	$session->setting->set('companyName', $originalCompanyName);
 }
diff --git a/t/Mail/Send.t b/t/Mail/Send.t
index d48539563..922b12e0e 100644
--- a/t/Mail/Send.t
+++ b/t/Mail/Send.t
@@ -37,11 +37,10 @@ BEGIN {
 }
 
 # See if we have an SMTP server to use
-my ( $smtpd, %oldSettings );
+my ( $smtpd );
 my $SMTP_HOST        = 'localhost';
 my $SMTP_PORT        = '54921';
 if ($hasServer) {
-    $oldSettings{ smtpServer } = $session->setting->get('smtpServer');
     $session->setting->set( 'smtpServer', $SMTP_HOST . ':' . $SMTP_PORT );
     
 }
@@ -174,9 +173,6 @@ SKIP: {
 #----------------------------------------------------------------------------
 # Cleanup
 END {
-    for my $name ( keys %oldSettings ) {
-        $session->setting->set( $name, $oldSettings{ $name } );
-    }
 }
 
 #----------------------------------------------------------------------------
diff --git a/t/PassiveProfiling.t b/t/PassiveProfiling.t
index e618f4a1b..4ff7820d1 100644
--- a/t/PassiveProfiling.t
+++ b/t/PassiveProfiling.t
@@ -28,7 +28,6 @@ my $startingTime = $session->datetime->time();
 my $numTests = 5; # increment this value for each test you create
 plan tests => 1 + $numTests;
 
-my $origPassiveProfiling = $session->setting->get('passiveProfilingEnabled');
 my $loaded = use_ok('WebGUI::PassiveProfiling');
 
 my $versionTag = WebGUI::VersionTag->getWorking($session);
@@ -122,7 +121,6 @@ cmp_bag(
 }
 
 END {
-    $session->setting->set('passiveProfilingEnabled', $origPassiveProfiling);
     $session->db->write('delete from passiveProfileLog where dateOfEntry >= ?',[$startingTime-1]);
     $versionTag->rollback;
 }
diff --git a/t/Session/ErrorHandler.t b/t/Session/ErrorHandler.t
index 0d9da8e39..c0f5453d3 100644
--- a/t/Session/ErrorHandler.t
+++ b/t/Session/ErrorHandler.t
@@ -149,8 +149,6 @@ is($eh->canShowBasedOnIP(''), 0, 'canShowBasedOnIP: must send IP setting');
 #
 ####################################################
 
-my $origDebugIp   = $session->setting->get('debugIp');
-my $origShowDebug = $session->setting->get('showDebug');
 
 $session->setting->set('showDebug', 0);
 delete $eh->{_canShowDebug};
@@ -183,8 +181,6 @@ ok($eh->canShowDebug, 'canShowDebug: returns 1 if debugIp is set and IP address
 #
 ####################################################
 
-my $origShowPerf = $session->setting->get('showPerformanceIndicators');
-
 $session->setting->set('showPerformanceIndicators', 0);
 is($eh->canShowPerformanceIndicators, 0, 'canShowPerformanceIndicators: returns 0 if not enabled');
 
@@ -243,8 +239,4 @@ TODO: {
 }
 
 END {
-	$session->setting->set('debugIp',   $origDebugIp);
-	$session->setting->set('showDebug', $origShowDebug);
-
-	$session->setting->set('showPerformanceIndicators', $origShowPerf);
 }
diff --git a/t/Session/Http.t b/t/Session/Http.t
index 8ac64f6c0..f38cbbb51 100644
--- a/t/Session/Http.t
+++ b/t/Session/Http.t
@@ -199,7 +199,6 @@ $session->{_asset} = $sessionAsset;
 ####################################################
 
 ##Force settings
-my $origPreventProxyCache = $session->setting->get('preventProxyCache');
 $session->setting->set('preventProxyCache', 0);
 
 ##Clear request object for next two tests
@@ -432,5 +431,4 @@ sub deltaHttpTimes {
 
 
 END {
-	$session->setting->set('preventProxyCache', $origPreventProxyCache);
 }
diff --git a/t/Session/Privilege.t b/t/Session/Privilege.t
index 9868f853a..0d5ddbcb0 100644
--- a/t/Session/Privilege.t
+++ b/t/Session/Privilege.t
@@ -77,7 +77,6 @@ my ($versionTag, $userTemplate) = setup_assets($session);
 isa_ok($privilege, 'WebGUI::Session::Privilege', 'session has correct object type');
 
 ##Override the original user style template to make verification easier
-my $origUserStyle = $session->setting->get('userFunctionStyleId');
 $session->setting->set('userFunctionStyleId', $userTemplate->getId);
 
 #One of the tests has different behavior depending on how it is called.
@@ -147,7 +146,6 @@ sub setup_assets {
 
 
 END {
-	$session->setting->set('userFunctionStyleId', $origUserStyle);
 	if (defined $versionTag and ref $versionTag eq 'WebGUI::VersionTag') {
 		$versionTag->rollback;
 	}
diff --git a/t/Session/Style.t b/t/Session/Style.t
index b23eeb617..51a134372 100644
--- a/t/Session/Style.t
+++ b/t/Session/Style.t
@@ -558,8 +558,6 @@ sub setup_assets {
 }
 
 END {
-	$session->setting->set('preventProxyCache', $origPreventProxyCache);
-	$session->setting->set('userFunctionStyleId', $origUserStyle);
 	if (defined $versionTag and ref $versionTag eq 'WebGUI::VersionTag') {
 		$versionTag->rollback;
 	}
diff --git a/t/Session/Url.t b/t/Session/Url.t
index 437debc84..e1e5d64cb 100644
--- a/t/Session/Url.t
+++ b/t/Session/Url.t
@@ -62,7 +62,7 @@ $session->{_request} = $pseudoRequest;
 #disable caching
 my $preventProxyCache = $session->setting->get('preventProxyCache');
 
-$session->setting->set('preventProxyCache', 0) if ($preventProxyCache);
+$session->setting->set('preventProxyCache', 0);
 
 #######################################
 #
@@ -462,9 +462,6 @@ END {  ##Always clean-up
     $session->config->set('extrasURL',          $origExtras);
     $session->config->set('sslEnabled',         $origSSLEnabled) if defined $origSSLEnabled;
 
-	$session->setting->set('hostToUse',         $setting_hostToUse);
-	$session->setting->set('preventProxyCache', $preventProxyCache);
-
 	if ($config_port) {
 		$session->config->set($config_port);
 	}
diff --git a/t/Storage/Image.t b/t/Storage/Image.t
index 32748ad3e..166ef9d3d 100644
--- a/t/Storage/Image.t
+++ b/t/Storage/Image.t
@@ -259,8 +259,6 @@ foreach my $testImage (@testImages) {
     );
 }
 
-use Data::Dumper;
-
 $session->setting->set('maxImageSize', $resizeTarget );
 foreach my $testImage (@testImages) {
     my $filename = $testImage->{ filename };
@@ -286,5 +284,4 @@ END {
     ) {
 		ref $stor eq "WebGUI::Storage" and $stor->delete;
 	}
-    $session->setting->set('maxImageSize', $origMaxImageSize );
 }
diff --git a/t/Workflow/Activity/DeleteExpiredSessions.t b/t/Workflow/Activity/DeleteExpiredSessions.t
index d71c69b5a..1ebd0a98f 100644
--- a/t/Workflow/Activity/DeleteExpiredSessions.t
+++ b/t/Workflow/Activity/DeleteExpiredSessions.t
@@ -115,5 +115,4 @@ foreach my $testSession (@sessions) {
 
 END {
     $workflow->delete;
-    $session->setting->set('sessionTimeout', $origSessionTimeout );
 }
diff --git a/t/lib/WebGUI/Test.pm b/t/lib/WebGUI/Test.pm
index c826f1fb1..87c51f1c7 100644
--- a/t/lib/WebGUI/Test.pm
+++ b/t/lib/WebGUI/Test.pm
@@ -48,7 +48,8 @@ our $logger_debug;
 our $logger_info;
 our $logger_error;
 
-my %originalConfig = ();
+my %originalConfig;
+my $originalSetting;
 
 BEGIN {
 
@@ -128,6 +129,8 @@ BEGIN {
     $SESSION = WebGUI::Session->open( $WEBGUI_ROOT, $CONFIG_FILE );
     $SESSION->{_request} = $pseudoRequest;
 
+    $originalSetting = clone $SESSION->setting;
+
 }
 
 END {
@@ -146,6 +149,10 @@ END {
             $SESSION->config->delete($key);
         }
     }
+    my $settings = $originalSetting->get();
+    while (my ($param, $value) = each %{ $settings }) {
+        $SESSION->setting->set($param, $value);
+    }
     $SESSION->var->end;
     $SESSION->close if defined $SESSION;
 }