Test harness update

.github/workflows/ci-lite.off

@@ -9,7 +9,7 @@ jobs:
   # Install & Test
   #  Set up environment
   # Test
-  #  Run tests/tests.py
+  #  Run tests
   install-test:
     name: Install/Test
     # cycle through os list
@@ -45,10 +45,10 @@ jobs:
         geom=640x480x24
         exec Xvfb $disp -screen $screen $geom 2>/tmp/Xvfb.log &
         export DISPLAY=:99
-        python ./tests/tests.py
+        python -m unittest
       if: contains(matrix.os-name, 'windows') != true
     - name: Start virtual display driver & Test (windows)
       uses: GabrielBB/xvfb-action@v1
       with:
-        run: python ./tests/tests.py
+        run: python -m unittest
       if: contains(matrix.os-name, 'windows')

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ on: [ push, pull_request ]
 #   Halt if fail
 #  Define Tests Job
 #   Calls Install Job
-#   Run tests.py
+#   Run tests
 #   Halt if fail
 #  Define Build Job
 #   Calls Install Job
@@ -44,7 +44,7 @@ jobs:
   # Install & Test
   #  Set up environment
   # Test
-  #  Run tests/tests.py
+  #  Run python -m unittest
   install-test:
     name: Install/Test
     # cycle through os list
@@ -80,12 +80,12 @@ jobs:
         geom=640x480x24
         exec Xvfb $disp -screen $screen $geom 2>/tmp/Xvfb.log &
         export DISPLAY=:99
-        python ./tests/tests.py
+        python -m unittest
       if: contains(matrix.os-name, 'windows') != true
     - name: Start virtual display driver & Test (windows)
       uses: GabrielBB/xvfb-action@v1
       with:
-        run: python ./tests/tests.py
+        run: python -m unittest
       if: contains(matrix.os-name, 'windows')
   # Install & Build
   #  Set up environment

.travis.off

@@ -51,7 +51,7 @@ jobs:
       # 6 Step
       before_script: echo "#do nothing before script"
       # 7 Step
-      script: ${PYTHON_EXECUTABLE} ./tests/tests.py
+      script: ${PYTHON_EXECUTABLE} -m unittest
 
     # 3.7 on Bionic Build/Deploy
     - &build-deploy

tests/README.md

@@ -3,3 +3,11 @@
 ## Unit Tests
 
 A battery of tests with the goal to ensure that any changes made will not hopefully pooch the entire project. These have a long way to go to test all of the things since we keep adding new toys to the interface.
+
+Legacy = Tests implemented before refactor, but have not yet been updated to the new testing framework
+
+Units = Tests of a specific class or module only
+Integration = Tests of how classes/modules work together
+System = Top level tests that simulate the user experience
+
+Resources = Files needed to help determine if the tests work (e.g. test images)

tests/__init__.py

@@ -1 +1,2 @@
-#do nothing, just exist to make "tests" package
+#this file exists to notify python to execute tests here
+#should be blank otherwise

tests/integration/__init__.py

@@ -0,0 +1,2 @@
+#this file exists to notify python to execute tests here
+#should be blank otherwise

tests/legacy/__init__.py

@@ -0,0 +1,2 @@
+#this file exists to notify python to execute tests here
+#should be blank otherwise

tests/legacy/legacy_gc.py

@@ -0,0 +1,49 @@
+#GARBAGE COLLECTION TESTS
+#this file should contain tests that probe for memory leaks and any other mismanagement of RAM
+
+from tests.legacy.common_vars import *  #contains utilities common to all tests.  Should come first before the other imports.
+
+import unittest     #for unit testing, har har
+import os           #for path.join and similar, to find the files we want to audit
+
+#this next class is inspired by a suggestion from Fry: https://www.youtube.com/watch?v=1Isjgc0oX0s
+class NoMemoryLeaks(unittest.TestCase):
+    def setUp(self):
+        import tkinter as tk
+        import weakref       #we weakref something to see if it was garbage collected
+
+        self.pseudo_root = tk.Tk()   #make a pseudo GUI environment
+
+    def test_sprites_and_games_are_destroyed(self):
+        from source.meta.gui import gui
+        #make the GUI in skeleton form (no looping)
+        pseudo_command_line_args = {"sprite": LINK_FILENAME}
+
+        self.pseudo_root.withdraw()  #make the pseudo GUI invisible
+        GUI_skeleton = gui.SpriteSomethingMainFrame(self.pseudo_root, pseudo_command_line_args)
+
+        #save a weakref to the old sprite
+        old_sprite_ref = weakref.ref(GUI_skeleton.sprite)
+        old_game_ref = weakref.ref(GUI_skeleton.game)
+        old_animation_engine_ref = weakref.ref(GUI_skeleton.animation_engine)
+
+        #try to load a new sprite
+        GUI_skeleton.load_sprite(SAMUS_FILENAME)
+
+        #see if the old classes were garbage collected
+        self.assertTrue(old_sprite_ref() is None)
+        self.assertTrue(old_game_ref() is None)
+        self.assertTrue(old_animation_engine_ref() is None)
+
+        #now go the other way around and test going to Zelda3 from Metroid3
+        old_sprite_ref = weakref.ref(GUI_skeleton.sprite)
+        old_game_ref = weakref.ref(GUI_skeleton.game)
+        old_animation_engine_ref = weakref.ref(GUI_skeleton.animation_engine)
+        GUI_skeleton.load_sprite(LINK_FILENAME)
+        self.assertTrue(old_sprite_ref() is None)
+        self.assertTrue(old_game_ref() is None)
+        self.assertTrue(old_animation_engine_ref() is None)
+
+
+if __name__ == '__main__':
+    unittest.main()

tests/test_waterfalls.py → tests/legacy/legacy_waterfalls.py

@@ -3,7 +3,7 @@
 #
 #in general, these tests should be testing the import framework
 
-from test_common import *   #contains utilities common to all tests.  Should come first before the other imports.
+from tests.legacy.common_vars import *   #contains utilities common to all tests.  Should come first before the other imports.
 
 import unittest     #for unit testing, har har
 import sys			#so that we can check to see which modules are imported at any given time

tests/test_asserts.py → tests/legacy/test_asserts.py

@@ -5,7 +5,7 @@
 #The intention is that most unit tests will go here, excepting the ones that do not play well with the others,
 # which at the time of writing this comment, are the tests for memory leaks and stray imports (test_gc.py and test_waterfalls.py)
 
-from test_common import *  #contains utilities common to all tests.  Should come first before the other imports.
+from tests.legacy.common_vars import *  #contains utilities common to all tests.  Should come first before the other imports.
 
 import unittest     #for unit testing, har har
 import json         #need to audit our json files

tests/system/__init__.py

@@ -0,0 +1,2 @@
+#this file exists to notify python to execute tests here
+#should be blank otherwise

tests/units/__init__.py

@@ -0,0 +1,2 @@
+#this file exists to notify python to execute tests here
+#should be blank otherwise