[[ Tests ]] Centralise common test teardown

montegoulding · montegoulding · commit d14936b60246 · 2017-07-26T09:06:48.000+10:00
This pathc resets the state of the environment for common
teardown tasks to what it was prior to a test at the end
of the test to reduce the need for test teardown code.
diff --git a/docs/development/testing.md b/docs/development/testing.md
@@ -115,8 +115,17 @@ on TestSetup
 end TestSetup
 ````
 
+
 Tests may need to clean up temporary files or other resources after running.  If a script test contains a handler called `TestTeardown`, this will be run after running each test command -- even if the test failed.  N.b. `TestTeardown` won't be run if running the test command causes an engine crash.
 
+Any new objects created on the test stack, `mainstacks`, `sockets`,
+`open processes` and `open files` are automatically cleared after each
+test and do not need to be included in the `TestTeardown` handler or
+teardown included in the test. Other global properties and variables
+should be reset in the test teardown. The test stack is deleted from
+memory and reloaded for the next test if multiple tests are being run
+within the same process as in the standalone test runner.
+
 Crashes or uncaught errors from a test command cause the test to immediately fail.
 
 ### LiveCode Builder
diff --git a/tests/_testrunnerbehavior.livecodescript b/tests/_testrunnerbehavior.livecodescript
@@ -160,7 +160,24 @@ end TestRunnerInvokeLoadLibraries
 
 -- Execute a test
 command TestRunnerInvokeTestCommand pScriptFile, pCommand
-   local tStackName, tResult
+   local tStackName, tResult, tState
+   
+   put the mainstacks into tState["mainstacks"]
+   put the openSockets into tState["opensockets"]
+   put the openProcesses into tState["openprocesses"]
+   put the openFiles into tState["openfiles"]
+   
+   reset the templateStack
+   reset the templateCard
+   reset the templateGroup
+   reset the templateButton
+   reset the templateField
+   reset the templateImage
+   reset the templateGraphic
+   reset the templatePlayer
+   
+   set the tool to "browse"
+   
    -- This should auto-load the test script
    put the name of stack pScriptFile into tStackName
    
@@ -183,36 +200,77 @@ command TestRunnerInvokeTestCommand pScriptFile, pCommand
       dispatch "TestSetup" to tStackName
       put the result into tResult
    catch tError
-      TestAssert "setup test", false
-      TestDiagnostic tError   
-   end try   
+      if word 1 of tError is "SKIP" then
+         put tError into tResult
+      else
+         TestAssert "setup test", false
+         TestDiagnostic tError   
+      end if
+   end try 
    
    if word 1 of tResult is "SKIP" then
       TestSkip pCommand, word 2 to -1 of tResult
    else
       -- Run the actual test itself
       try
          dispatch pCommand to tStackName
-      catch tError      
-         TestAssert "execute test:" && line 1 of tError, false
-         TestDiagnostic tError   
-         -- don't exit here as test cleanup may still be useful
+      catch tError
+         if word 1 of tError is "SKIP" then
+            TestSkip pCommand, word 2 to -1 of tError
+         else
+            TestAssert "execute test:" && line 1 of tError, false
+            TestDiagnostic tError   
+            -- don't exit here as test cleanup may still be useful
+         end if
       end try
-   end if
-   
-   -- Do common cleanup tasks
-   try
-      dispatch "TestTearDown" to tStackName
-   catch tError
-      TestAssert "tear down test", false
-      TestDiagnostic tError  
-   end try
-   
+      
+      -- Do common cleanup tasks
+      try
+         dispatch "TestTearDown" to tStackName
+         
+         -- cleanup
+         delete tStackName
+         
+         local tNewState
+         put the opensockets into tNewState
+         repeat for each line tLine in tNewState
+            if tLine is not among the lines of tState["opensockets"] then
+               close socket tLine
+            end if
+         end repeat
+         
+         put the openprocesses into tNewState
+         repeat for each line tLine in tNewState
+            if tLine is not among the lines of tState["openprocesses"] then
+               close process tLine
+            end if
+         end repeat
+         
+         put the openfiles into tNewState
+         repeat for each line tLine in tNewState
+            if tLine is not among the lines of tState["openfiles"] then
+               close file tLine
+            end if
+         end repeat
+         
+         put the mainstacks into tNewState
+         repeat for each line tLine in tNewState
+            if tLine is not among the lines of tState["mainstacks"] then
+               delete stack tLine
+            end if
+         end repeat
+      catch tError
+         TestAssert "tear down test", false
+         TestDiagnostic tError  
+      end try
+      
       -- Check for uncaught errors
-   put TestGetUncaughtErrorDialog() into tError
-   if tError is not empty then
-      TestAssert "uncaught error dialog", line 1 of tError
-      TestDiagnostic tError
+      put TestGetUncaughtErrorDialog() into tError
+      if tError is not empty then
+         TestAssert "uncaught error dialog", line 1 of tError
+         TestDiagnostic tError
+      end if
+
    end if
 end TestRunnerInvokeTestCommand
 
