wwpdb.utils.testing 0.18__tar.gz → 0.19__tar.gz

{wwpdb_utils_testing-0.18/wwpdb.utils.testing.egg-info → wwpdb_utils_testing-0.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wwpdb.utils.testing
-Version: 0.18
+Version: 0.19
 Summary: wwPDB Python DB Schema Utilities
 Author-email: Ezra Peisach <ezra.peisach@rcsb.org>
 License: Apache 2.0
@@ -9,10 +9,10 @@ Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE

{wwpdb_utils_testing-0.18 → wwpdb_utils_testing-0.19}/pyproject.toml

@@ -16,10 +16,10 @@ classifiers = [
         "Natural Language :: English",
         "License :: OSI Approved :: Apache Software License",
         "Programming Language :: Python",
-        "Programming Language :: Python :: 2.7",
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",	
 ]
 dependencies = []
 dynamic = ["version"]
@@ -29,7 +29,7 @@ dynamic = ["version"]
 
 [tool.setuptools.packages.find]
 where = ["."]
-exclude = ["wwpdb.utils.tests-*"]
+exclude = ["wwpdb.utils.tests_*"]
 namespaces = true
 
 [tool.setuptools.dynamic]
@@ -40,5 +40,8 @@ version = {attr = "wwpdb.utils.testing.__version__"}
 # MANIFEST.in files in wheel - but keep in sdist
 include-package-data = false
 
+[tool.setuptools.package-data]
+mypkg = ["*.pyi", "*.rst", "py.typed"]
+
 [tool.distutils.bdist_wheel]
 universal = true

{wwpdb_utils_testing-0.18 → wwpdb_utils_testing-0.19}/tox.ini

@@ -7,20 +7,22 @@
 test_pattern = "*Test.py"
 #
 # Source pathls (unquoted and space separated list of files/directories) for linting and format checks
-source_paths = wwpdb/utils/testing wwpdb/utils/tests-testing
+source_paths = wwpdb/utils/testing wwpdb/utils/tests_testing
 #
 # Start directory path for test discovery
 # Each path must reference valid directory that is searchable by python3.9 (i.e. contains __init__.py)
 #  ** It is harmless to point to paths containing no tests.
 #
-test_path_1 = "wwpdb/utils/tests-testing"
+test_path_1 = "wwpdb/utils/tests_testing"
 # These are placeholders valid source directories without tests files
 test_path_2 = "wwpdb/utils/testing"
 test_path_3 = "wwpdb/utils/testing"
 test_path_4 = "wwpdb/utils/testing"
 #
+mypy_path = "wwpdb"
+#
 # Comma separate list of directories/patterns for which test coverage will be evaluated
-coverage_source_paths = "wwpdb/utils/testing,wwpdb/utils/tests-testing"
+coverage_source_paths = "wwpdb/utils/testing,wwpdb/utils/tests_testing"
 # SiteConfig can only be tested when wwpdb.utils.config available
 coverage_exclude_paths = "wwpdb/__init__.py,wwpdb/utils/testing/SiteConfigSetup.py"
 coverage_cutoff = 65
@@ -35,7 +37,7 @@ coverage_cutoff = 65
 ##
 [tox]
 # The complete list of supported test environments to setup and invoke
-envlist = format_pep8-{py39}, lint_pylint-{py39}, format_black-{py39}, {py39}, test_coverage-{py39}
+envlist = format_pep8-{py39}, lint_pylint-{py39}, format_black-{py39}, {py39}, test_coverage-{py39}, mypy-{py39}
 #
 minversion = 3.4.0
 skip_missing_interpreters = true
@@ -104,6 +106,21 @@ commands =
     echo "Completed {envname}"
 
 #
+[testenv:mypy-py3{8,9,10,11,12,13}]
+description = 'Run typing compliance checks (mypy)'
+platform=
+       macos: darwin
+       linux: linux
+
+deps =
+    mypy
+    -r requirements.txt
+commands =
+    echo "Starting {envname}"
+    mypy --strict -p {[local_settings]mypy_path}
+    echo "Completed {envname}"
+
+
 [testenv:format_black-py3{9,10,11,12,13}]
 description = 'Run format compliance checks (black)'
 platform=

{wwpdb_utils_testing-0.18 → wwpdb_utils_testing-0.19}/wwpdb/utils/testing/CreateRWTree.py

@@ -20,11 +20,13 @@ import logging
 import shutil
 import os
 
+from typing import List, Any, Optional, Union
+
 logger = logging.getLogger(__name__)
 
 
 class CreateRWTree(object):
-    def __init__(self, source=None, destination=None):
+    def __init__(self, source: Optional[str] = None, destination: Optional[str] = None) -> None:
         self.__srcDir = source
         self.__dstDir = destination
         self.__reqOpts = {
@@ -37,7 +39,10 @@ class CreateRWTree(object):
             "webapps": "_copywebapps",
         }
 
-    def createtree(self, objlist=None):
+    def createtree(self, objlist: Optional[List[Any]] = None) -> None:
+        if objlist is None:
+            logger.error("createtree with no objlist - Fatal")
+            return
         for obj in objlist:
             if type(obj) is str:
                 req = obj
@@ -51,6 +56,9 @@ class CreateRWTree(object):
 
             if req in self.__reqOpts:
                 mth = getattr(self, self.__reqOpts[req], None)
+                if mth is None:
+                    logger.error("Could not locate %s - fatal", self.__reqOpts[req])
+                    return
                 if opt_arg:
                     mth(opt_arg)
                 else:
@@ -58,17 +66,23 @@ class CreateRWTree(object):
             else:
                 logger.error("%s not known", req)
 
-    def _copysiteconfig(self):
+    def _copysiteconfig(self) -> None:
         """Copies the site config tree down so that MockTopDir will be the top of the r/w tree"""
         logger.info("Creating %s", self.__dstDir)
+        if self.__srcDir is None or self.__dstDir is None:
+            logger.error("srcDir of dstDir not set --- FATAL")
+            return
         src = os.path.join(self.__srcDir, "site-config")
         dst = os.path.join(self.__dstDir, "site-config")
         if os.path.exists(dst):
             shutil.rmtree(dst)
         shutil.copytree(src, dst)
 
-    def _copyactiondata(self):
+    def _copyactiondata(self) -> None:
         """Copies the actondata definitions"""
+        if self.__srcDir is None or self.__dstDir is None:
+            logger.error("srcDir of dstDir not set --- FATAL")
+            return
         src = os.path.join(self.__srcDir, "da_top", "resources_ro", "actionData.xml")
         dst = os.path.join(self.__dstDir, "da_top", "resources_ro", "actionData.xml")
         logger.info("Copying %s to %s", src, dst)
@@ -79,39 +93,51 @@ class CreateRWTree(object):
             os.makedirs(dst_base)
         shutil.copyfile(src, dst)
 
-    def _copydepuiresources(self):
+    def _copydepuiresources(self) -> None:
         """Copies the depui resources tree so that MockTopDir will be the top of the r/w tree"""
         logger.info("Creating %s", self.__dstDir)
+        if self.__srcDir is None or self.__dstDir is None:
+            logger.error("srcDir of dstDir not set --- FATAL")
+            return
         src = os.path.join(self.__srcDir, "da_top", "resources_ro", "depui")
         dst = os.path.join(self.__dstDir, "da_top", "resources_ro", "depui")
         if os.path.exists(dst):
             shutil.rmtree(dst)
         shutil.copytree(src, dst)
 
-    def _copyemdresources(self):
+    def _copyemdresources(self) -> None:
         """Copies the emd  resources tree so that MockTopDir will be the top of the r/w tree"""
         logger.info("Creating %s", self.__dstDir)
+        if self.__srcDir is None or self.__dstDir is None:
+            logger.error("srcDir of dstDir not set --- FATAL")
+            return
         src = os.path.join(self.__srcDir, "da_top", "resources_ro", "emd")
         dst = os.path.join(self.__dstDir, "da_top", "resources_ro", "emd")
         if os.path.exists(dst):
             shutil.rmtree(dst)
         shutil.copytree(src, dst)
 
-    def _copywsresources(self):
+    def _copywsresources(self) -> None:
         """Copies the content_ws resources tree so that MockTopDir will be the top of the r/w tree"""
         logger.info("Creating %s", self.__dstDir)
+        if self.__srcDir is None or self.__dstDir is None:
+            logger.error("srcDir of dstDir not set --- FATAL")
+            return
         src = os.path.join(self.__srcDir, "da_top", "resources_ro", "content_ws")
         dst = os.path.join(self.__dstDir, "da_top", "resources_ro", "content_ws")
         if os.path.exists(dst):
             shutil.rmtree(dst)
         shutil.copytree(src, dst)
 
-    def _copywebapps(self, modules=None):
+    def _copywebapps(self, modules: Optional[Union[str, List[Any]]] = None) -> None:
         """Copies selected webapps resources tree so that MockTopDir will be the top of the r/w tree"""
         if type(modules) is str:
             modules = [modules]
 
         # Copy version number
+        if self.__srcDir is None or self.__dstDir is None:
+            logger.error("srcDir of dstDir not set --- FATAL")
+            return
         websrcdir = os.path.join(self.__srcDir, "da_top", "webapps")
         webdstdir = os.path.join(self.__dstDir, "da_top", "webapps")
         src = os.path.join(websrcdir, "version.json")
@@ -136,8 +162,12 @@ class CreateRWTree(object):
                     shutil.rmtree(dst)
                 shutil.copytree(src, dst)
 
-    def _copyarchive(self, idlist):
+    def _copyarchive(self, idlist: Union[str, List[Any]]) -> None:
         """Copies the archive directory down so that MockTopDir will be the top of the r/w tree"""
+        if self.__srcDir is None or self.__dstDir is None:
+            logger.error("srcDir of dstDir not set --- FATAL")
+            return
+
         if type(idlist) is str:
             idlist = [idlist]
 

{wwpdb_utils_testing-0.18 → wwpdb_utils_testing-0.19}/wwpdb/utils/testing/Features.py

@@ -19,42 +19,42 @@ import os
 
 
 class Features(object):
-    def haveApi(self):
+    def haveApi(self) -> bool:
         """Returns True is api services available"""
         return True
 
-    def haveMySqlTestServer(self):
+    def haveMySqlTestServer(self) -> bool:
         """Returns True if MySql server available for testing"""
         if os.getenv("MYSQLUP"):
             return True
         return False
 
-    def haveRbmqTestServer(self):
+    def haveRbmqTestServer(self) -> bool:
         """Returns True if MySql server available for testing"""
         if os.getenv("RBMQUP"):  # pragma: no cover
             return True
         return False
 
-    def haveCvsTestServer(self):
+    def haveCvsTestServer(self) -> bool:
         """Returns True if CVS server available for testing"""
         return False
 
-    def haveSvnTestServer(self):
+    def haveSvnTestServer(self) -> bool:
         """Returns True if SVN server available for testing"""
         return False
 
-    def haveSftpTestServer(self):
+    def haveSftpTestServer(self) -> bool:
         """Returns True if SFTP server available for testing"""
         return False
 
-    def haveToolsRuntime(self):
+    def haveToolsRuntime(self) -> bool:
         """Returns True if runtime tools available in environment"""
         return False
 
-    def haveCCD(self):
+    def haveCCD(self) -> bool:
         """Returns True if CCD available for use in read only tests"""
         return False
 
-    def testNever(self):
+    def testNever(self) -> bool:
         """Always returns False to confirm ability to skip in testing"""
         return False

{wwpdb_utils_testing-0.18 → wwpdb_utils_testing-0.19}/wwpdb/utils/testing/SiteConfigSetup.py

@@ -24,10 +24,10 @@ from subprocess import call
 
 # Empty class for import
 class SiteConfigSetup(object):
-    def __init__(self):
+    def __init__(self) -> None:
         pass
 
-    def setupEnvironment(self, TestOutputPath, MockDirPath):
+    def setupEnvironment(self, TestOutputPath: str, MockDirPath: str) -> None:
         if not os.path.exists(TestOutputPath):
             os.makedirs(TestOutputPath)
 

{wwpdb_utils_testing-0.18 → wwpdb_utils_testing-0.19}/wwpdb/utils/testing/__init__.py

@@ -2,4 +2,4 @@ __docformat__ = "restructuredtext en"
 __author__ = "Ezra Peisach"
 __email__ = "ezra.peisach@rcsb.org"
 __license__ = "Apache 2.0"
-__version__ = "0.18"
+__version__ = "0.19"

{wwpdb_utils_testing-0.18 → wwpdb_utils_testing-0.19/wwpdb.utils.testing.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wwpdb.utils.testing
-Version: 0.18
+Version: 0.19
 Summary: wwPDB Python DB Schema Utilities
 Author-email: Ezra Peisach <ezra.peisach@rcsb.org>
 License: Apache 2.0
@@ -9,10 +9,10 @@ Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE

{wwpdb_utils_testing-0.18 → wwpdb_utils_testing-0.19}/wwpdb.utils.testing.egg-info/SOURCES.txt

@@ -23,7 +23,4 @@ wwpdb/mock-data/site-config/rcsb-east/wwpdb_deploy_test/site.cfg
 wwpdb/utils/testing/CreateRWTree.py
 wwpdb/utils/testing/Features.py
 wwpdb/utils/testing/SiteConfigSetup.py
-wwpdb/utils/testing/__init__.py
-wwpdb/utils/tests-testing/CreateRWTreeTest.py
-wwpdb/utils/tests-testing/FeaturesTest.py
-wwpdb/utils/tests-testing/__init__.py
+wwpdb/utils/testing/__init__.py

wwpdb_utils_testing-0.18/wwpdb/utils/tests-testing/CreateRWTreeTest.py

@@ -1,84 +0,0 @@
-##
-#
-# File:    CreateRWTreeTest.py
-# Author:  E. Peisach
-# Date:    21-Dec-2019
-# Version: 0.001
-##
-"""
-Test cases for copying configurations
-
-"""
-__docformat__ = "restructuredtext en"
-__author__ = "Ezra Peisach"
-__email__ = "peisach@rcsb.rutgers.edu"
-__license__ = "Creative Commons Attribution 3.0 Unported"
-__version__ = "V0.01"
-
-import os
-import platform
-import unittest
-import shutil
-from wwpdb.utils.testing.CreateRWTree import CreateRWTree
-
-
-class CreateRWTreeTest(unittest.TestCase):
-    @classmethod
-    def setUpClass(cls):
-        cls.__here = os.path.abspath(os.path.dirname(__file__))
-        TESTOUTPUT = os.path.join(cls.__here, "test-output", platform.python_version(), "copytest")
-        cls.__testout = TESTOUTPUT
-        if os.path.exists(cls.__testout):
-            shutil.rmtree(cls.__testout)
-
-    def setUp(self):
-        TOPDIR = os.path.dirname(os.path.dirname(os.path.dirname(self.__here)))
-        if not os.path.exists(self.__testout):
-            os.makedirs(self.__testout)
-
-        mockTopPath = os.path.join(TOPDIR, "wwpdb", "mock-data")
-        self.__crw = CreateRWTree(mockTopPath, self.__testout)
-
-    def testCopySiteConfig(self):
-        """Tests creation site-config"""
-        self.__crw.createtree(["site-config"])
-        self.assertTrue(os.path.exists(os.path.join(self.__testout, "site-config")))
-
-    def testCopyActionData(self):
-        """Test creation of actiondata.xml"""
-        self.__crw.createtree(["actiondata"])
-        self.assertTrue(os.path.exists(os.path.join(self.__testout, "da_top", "resources_ro", "actionData.xml")))
-
-    def testCopyMultiData(self):
-        """Test creation of multiple items"""
-        dstdir = os.path.join(self.__testout, "da_top", "webapps")
-        if os.path.exists(dstdir):
-            shutil.rmtree(dstdir)
-        self.__crw.createtree(["depuiresources", "emdresources", "wsresources", ["webapps", "msgmodule"]])
-        self.assertTrue(os.path.exists(os.path.join(self.__testout, "da_top", "resources_ro", "depui")))
-        self.assertTrue(os.path.exists(os.path.join(self.__testout, "da_top", "resources_ro", "emd")))
-        self.assertTrue(os.path.exists(os.path.join(self.__testout, "da_top", "resources_ro", "content_ws")))
-        self.assertTrue(os.path.exists(os.path.join(self.__testout, "da_top", "webapps", "htdocs", "msgmodule")))
-        self.assertTrue(os.path.exists(os.path.join(self.__testout, "da_top", "webapps", "version.json")))
-
-    def testCopyVersionOnly(self):
-        """Test creation of version.json webapps"""
-        dstdir = os.path.join(self.__testout, "da_top", "webapps")
-        if os.path.exists(dstdir):
-            shutil.rmtree(dstdir)
-        self.__crw.createtree(["webapps"])
-        self.assertFalse(os.path.exists(os.path.join(dstdir, "htdocs", "msgmodule")))
-        self.assertTrue(os.path.exists(os.path.join(dstdir, "version.json")))
-
-    def testCopyArchiveData(self):
-        """Test creation of archive data"""
-        self.__crw.createtree([["archive", "D_000001"]])
-        self.assertTrue(os.path.exists(os.path.join(self.__testout, "da_top", "data", "archive", "D_000001")))
-
-    def testCopyUnknown(self):
-        """Test creation to log error"""
-        self.__crw.createtree(["nothing"])
-
-
-if __name__ == "__main__":  # pragma: no cover
-    unittest.main()

wwpdb_utils_testing-0.18/wwpdb/utils/tests-testing/FeaturesTest.py

@@ -1,77 +0,0 @@
-##
-#
-# File:    FeaturesTest.py
-# Author:  E. Peisach
-# Date:    08-Oct-2018
-# Version: 0.001
-#
-# Updates:
-#
-##
-"""
-Test cases for ensuring skipping of tests works.
-"""
-__docformat__ = "restructuredtext en"
-__author__ = "Ezra Peisach"
-__email__ = "peisach@rcsb.rutgers.edu"
-__license__ = "Creative Commons Attribution 3.0 Unported"
-__version__ = "V0.01"
-
-import os
-import unittest
-
-from wwpdb.utils.testing.Features import Features
-
-
-class FeaturesTests(unittest.TestCase):
-    """
-    Test cases for skipping
-    """
-
-    def setUp(self):
-        pass
-
-    def tearDown(self):
-        pass
-
-    @unittest.skipUnless(Features().haveApi(), "skipping if lack of API")
-    def testHaveApi(self):
-        """Test should be run all the time"""
-        self.assertTrue(Features().haveApi())
-
-    @unittest.skipIf(Features().haveApi(), "requires API to run")
-    def testNotHaveApi(self):
-        self.fail("Test should have been skipped")
-
-    @unittest.skipUnless(Features().testNever(), "tests for never execution")
-    def testNever(self):
-        self.fail("Test should have been skipped")
-
-    def testMySqlTestServer(self):
-        self.assertFalse(Features().haveMySqlTestServer())
-        os.environ["MYSQLUP"] = "True"
-        self.assertTrue(Features().haveMySqlTestServer())
-        del os.environ["MYSQLUP"]
-
-    def testRbmqTestServer(self):
-        # Might need to handle true case
-        self.assertFalse(Features().haveRbmqTestServer())
-
-    def testCvsTestServer(self):
-        self.assertFalse(Features().haveCvsTestServer())
-
-    def testSvnTestServer(self):
-        self.assertFalse(Features().haveSvnTestServer())
-
-    def testSftpTestServer(self):
-        self.assertFalse(Features().haveSftpTestServer())
-
-    def testToolsRuntime(self):
-        self.assertFalse(Features().haveToolsRuntime())
-
-    def testHaveCCD(self):
-        self.assertFalse(Features().haveCCD())
-
-
-if __name__ == "__main__":  # pragma: no cover
-    unittest.main()