<Refactor>[Unit Tests]: <Unit tests should be DRY>

[Mostly DRY'ing out unit test code]

[
#44
#45
]

Author: Humberto Sanchez II

.circleci/config.yml

@@ -27,13 +27,14 @@ jobs:
             sudo apt install libgtk-3-dev
             sudo apt-get install -y  libsdl2-dev
             pip install --upgrade pip
-            pip install wheel==0.38.4
-            pip install setuptools==65.5.1
+            pip install wheel
+            pip install setuptools
             pip install six==1.16.0
             pip install html-testRunner~=1.2.1
             pip install attrdict3
             pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-22.04  wxPython
-            pip install ogl~=0.70.20
+            pip install hasiicommon~=0.2.1
+            pip install ogl~=0.70.22
             pip install untangle==1.2.1
       - run:
             name: run tests

requirements.txt

@@ -1,20 +1,21 @@
-wheel==0.38.4
-setuptools==67.4.0
+wheel==0.40.0
+setuptools==67.6.1
 twine==4.0.2
 build==0.10.0
 html-testRunner~=1.2.1
 
-mypy==1.0.1
+mypy==1.1.1
 mypy-extensions==1.0.0
-types-Deprecated==1.2.9.1
-types-setuptools==67.4.0.1
+types-Deprecated==1.2.9.2
+types-setuptools==67.6.0.6
 typing_extensions==4.5.0
 
 Deprecated~=1.2.13
 
+untangle==1.2.1
 wxPython~=4.2.0
 
-pyutmodel==1.4.0
-ogl~=0.70.20
-untangle==1.2.1
+hasiicommon~=0.2.1
+pyutmodel~=1.4.2
+ogl~=0.70.22
 

scripts/query.slg

@@ -0,0 +1,3 @@
+hasii2011/hasiicommon
+hasii2011/pyutmodel
+hasii2011/ogl

setup.py

@@ -23,5 +23,5 @@
         'untanglepyut': ['py.typed'],
     },
 
-    install_requires=['ogl==0.70.20', 'untangle==1.2.1'],
+    install_requires=['hasiicommon~=0.2.1', 'pyutmodel~=1.4.2', 'ogl==0.70.22', 'untangle==1.2.1'],
 )

tests/TestBase.py

@@ -1,73 +1,22 @@
 
-import logging
-import logging.config
-
-import json
-
-from unittest import TestCase
-
-from pkg_resources import resource_filename
-
-from miniogl.DiagramFrame import DiagramFrame
-
-from wx import App
-from wx import Frame
-from wx import ID_ANY
+from hasiicommon.ui.UnitTestBaseW import UnitTestBaseW
 
 from untanglepyut.UnTangler import DocumentTitle
 
-JSON_LOGGING_CONFIG_FILENAME: str = "testLoggingConfig.json"
-TEST_DIRECTORY:               str = 'tests'
-
 DIAGRAM_NAME_1:    DocumentTitle = DocumentTitle('Diagram-1')
 DIAGRAM_NAME_2:    DocumentTitle = DocumentTitle('Diagram-2')
 TEST_XML_FILENAME: str           = 'MultiDocumentProject.xml'
 
 
-class DummyApp(App):
-    def OnInit(self):
-        return True
-
-
-class TestBase(TestCase):
+class TestBase(UnitTestBaseW):
 
-    RESOURCES_PACKAGE_NAME:                   str = 'tests.resources'
     RESOURCES_TEST_CLASSES_PACKAGE_NAME:      str = 'tests.resources.testclass'
     RESOURCES_TEST_JAVA_CLASSES_PACKAGE_NAME: str = 'tests.resources.testclass.ozzee'
     RESOURCES_TEST_DATA_PACKAGE_NAME:         str = 'tests.resources.testdata'
     RESOURCES_TEST_IMAGES_PACKAGE_NAME:       str = 'tests.resources.testimages'
 
     def setUp(self):
-        self._app:   DummyApp = DummyApp()
-
-        #  Create frame
-        baseFrame: Frame = Frame(None, ID_ANY, "", size=(10, 10))
-        # noinspection PyTypeChecker
-        umlFrame = DiagramFrame(baseFrame)
-        umlFrame.Show(True)
+        super().setUp()
 
     def tearDown(self):
-        self._app.OnExit()
-
-    """
-    A base unit test class to initialize some logging stuff we need
-    """
-    @classmethod
-    def setUpLogging(cls):
-        """"""
-
-        loggingConfigFilename: str = cls.findLoggingConfig()
-
-        with open(loggingConfigFilename, 'r') as loggingConfigurationFile:
-            configurationDictionary = json.load(loggingConfigurationFile)
-
-        logging.config.dictConfig(configurationDictionary)
-        logging.logProcesses = False
-        logging.logThreads = False
-
-    @classmethod
-    def findLoggingConfig(cls) -> str:
-
-        fqFileName = resource_filename(TestBase.RESOURCES_PACKAGE_NAME, JSON_LOGGING_CONFIG_FILENAME)
-
-        return fqFileName
+        pass

tests/untanglepyut/TestUnTangleOglLinks.py

@@ -1,21 +1,18 @@
 
 from typing import cast
 
-from logging import Logger
-from logging import getLogger
-
 from unittest import TestSuite
 from unittest import main as unitTestMain
 
 from miniogl.SelectAnchorPoint import SelectAnchorPoint
+
 from ogl.OglAssociation import OglAssociation
 from ogl.OglAssociationLabel import OglAssociationLabel
 
 from ogl.OglClass import OglClass
 from ogl.OglInheritance import OglInheritance
 from ogl.OglInterface2 import OglInterface2
 from ogl.OglLink import OglLink
-from pkg_resources import resource_filename
 
 from pyutmodel.PyutClass import PyutClass
 from pyutmodel.PyutInterface import PyutInterface
@@ -26,6 +23,7 @@
 from tests.TestBase import DIAGRAM_NAME_2
 from tests.TestBase import TEST_XML_FILENAME
 from tests.TestBase import TestBase
+
 from untanglepyut.Types import UntangledOglLinks
 from untanglepyut.UnTangler import Document
 from untanglepyut.UnTangler import DocumentTitle
@@ -37,24 +35,17 @@ class TestUnTangleOglLinks(TestBase):
     """
     SIMPLE_DIAGRAM_NAME: DocumentTitle = DocumentTitle('Simple')
 
-    clsLogger: Logger = cast(Logger, None)
-
-    @classmethod
-    def setUpClass(cls):
-        TestBase.setUpLogging()
-        TestUnTangleOglLinks.clsLogger = getLogger(__name__)
-
     def setUp(self):
-        self.logger: Logger = TestUnTangleOglLinks.clsLogger
+
         super().setUp()
-        self._fqFileName: str = resource_filename(TestBase.RESOURCES_PACKAGE_NAME, TEST_XML_FILENAME)
+        self._fqFileName: str = TestBase.getFullyQualifiedResourceFileName(TestBase.RESOURCES_PACKAGE_NAME, TEST_XML_FILENAME)
 
     def tearDown(self):
         super().tearDown()
 
     def testNoGraphicLinks(self):
-        fqFileName = resource_filename(TestBase.RESOURCES_PACKAGE_NAME, 'ScaffoldDiagram.xml')
-        untangler: UnTangler = UnTangler()
+        fqFileName: str       = TestBase.getFullyQualifiedResourceFileName(TestBase.RESOURCES_PACKAGE_NAME, 'ScaffoldDiagram.xml')
+        untangler:  UnTangler = UnTangler()
 
         untangler.untangleFile(fqFileName)
 
@@ -70,9 +61,8 @@ def testGraphicSimpleLinks(self):
 
     def testSimpleInheritance(self):
 
-        fqFileName = resource_filename(TestBase.RESOURCES_PACKAGE_NAME, 'SimpleInheritance.xml')
-
-        untangler: UnTangler = UnTangler()
+        fqFileName: str       = TestBase.getFullyQualifiedResourceFileName(TestBase.RESOURCES_PACKAGE_NAME, 'SimpleInheritance.xml')
+        untangler:  UnTangler = UnTangler()
 
         untangler.untangleFile(fqFileName=fqFileName)
 
@@ -163,7 +153,8 @@ def testLollipopInterfaceMethodsCreated(self):
         self.assertTrue(foundMethods, 'Did not untangle the expected lollipop interface')
 
     def testGetAssociationLabelPositions(self):
-        fqFileName: str        = resource_filename(TestBase.RESOURCES_PACKAGE_NAME, 'SimpleGraphicLinkTest.xml')
+
+        fqFileName: str       = TestBase.getFullyQualifiedResourceFileName(TestBase.RESOURCES_PACKAGE_NAME, 'SimpleGraphicLinkTest.xml')
         untangler:  UnTangler = UnTangler()
 
         untangler.untangleFile(fqFileName)

tests/untanglepyut/TestUnTangleSequenceDiagram.py

@@ -2,15 +2,11 @@
 from typing import Tuple
 from typing import cast
 
-from logging import Logger
-from logging import getLogger
-
 from unittest import TestSuite
 from unittest import main as unitTestMain
 
 from ogl.OglDimensions import OglDimensions
 from ogl.preferences.OglPreferences import OglPreferences
-from pkg_resources import resource_filename
 
 from pyutmodel.PyutLinkType import PyutLinkType
 from pyutmodel.PyutSDInstance import PyutSDInstance
@@ -31,16 +27,8 @@
 class TestUnTangleSequenceDiagram(TestBase):
     """
     """
-    clsLogger: Logger = cast(Logger, None)
-
-    @classmethod
-    def setUpClass(cls):
-        TestBase.setUpLogging()
-        TestUnTangleSequenceDiagram.clsLogger = getLogger(__name__)
-
     def setUp(self):
         super().setUp()
-        self.logger: Logger = TestUnTangleSequenceDiagram.clsLogger
 
     def tearDown(self):
         super().tearDown()
@@ -57,7 +45,7 @@ def testSequenceInstances(self):
 
         expectedInstanceNames: List[str] = ['Instance1', 'Instance2']
         for oglSDInstance in oglSDInstances.values():
-            self.assertIn(oglSDInstance.instanceName.GetText(), expectedInstanceNames, 'Not an expected instance')
+            self.assertIn(oglSDInstance.instanceName.text, expectedInstanceNames, 'Not an expected instance')
 
     def testSequenceMessages(self):
         document: Document = self._retrieveSequenceDiagramDocument()
@@ -100,7 +88,7 @@ def testSDInstanceLifeLineIsCorrect(self):
 
     def _retrieveSequenceDiagramDocument(self) -> Document:
 
-        fqFileName: str       = resource_filename(TestBase.RESOURCES_PACKAGE_NAME, 'SequenceDiagram.xml')
+        fqFileName: str       = TestBase.getFullyQualifiedResourceFileName(TestBase.RESOURCES_PACKAGE_NAME, 'SequenceDiagram.xml')
         untangler:  UnTangler = UnTangler()
 
         untangler.untangleFile(fqFileName=fqFileName)