Added checks for loggers and repr + updated setup.py test commands

Author: Philippe Theroux

setup.py

@@ -20,8 +20,10 @@
 import io
 import os
 import re
-from setuptools import Command, find_packages, setup
 import shutil
+import sys
+
+from setuptools import Command, find_packages, setup
 
 
 class PyCleanBuild(Command):
@@ -63,7 +65,7 @@ def run(self):
                 os.remove('../{}'.format(file_))
 
 
-class PyTest(Command):
+class Unittest(Command):
     user_options = []
 
     def initialize_options(self):
@@ -74,7 +76,8 @@ def finalize_options(self):
 
     def run(self):
         import subprocess
-        errno = subprocess.call(['pytest'])
+        errno = subprocess.call([sys.executable,
+                                 '-m', 'unittest', 'discover'])
         raise SystemExit(errno)
 
 
@@ -91,10 +94,9 @@ def run(self):
         import subprocess
 
         errno = subprocess.call(['coverage', 'run',
-                                 '--source=geomet_data_registry',
-                                 '-m', 'unittest',
-                                 'geomet_data_registry.tests.run_tests'])
-        errno = subprocess.call(['coverage', 'report', '-m'])
+                                 '-m', 'unittest', 'discover'])
+        errno = subprocess.call(['coverage', 'report', '-m',
+                                 '--include=geomet_data_registry/layer/*.py'])
         raise SystemExit(errno)
 
 
@@ -156,7 +158,7 @@ def get_package_version():
         'Programming Language :: Python'
     ],
     cmdclass={
-        'test': PyTest,
+        'test': Unittest,
         'coverage': PyCoverage,
         'cleanbuild': PyCleanBuild
     }

tests/test_base.py

@@ -175,6 +175,12 @@ def test_is_valid_interval(self):
 
         self.assertListEqual(return_list, [True, True, False])
 
+    def test_repr(self):
+        self.assertEqual(
+            repr(self.base_layer),
+            '<BaseLayer> model_gem_global'
+        )
+
 
 class TestRegister(unittest.TestCase, Setup):
     def setUp(self):
@@ -191,10 +197,15 @@ def tearDown(self):
     def test_register_no_items(self):
         """
         Test that when no items are identified
-        geomet_data_registry.layer.base.register() returns False.
+        geomet_data_registry.layer.base.register()
+        returns False and an error is logged.
         """
-
-        self.assertFalse(self.base_layer.register())
+        with self.assertLogs(
+            'geomet_data_registry.layer.base', level='ERROR'
+        ) as err:
+            self.assertFalse(self.base_layer.register())
+            # assert a single LOGGER.error was called
+            self.assertEqual(len(err.records), 1)
 
     def test_register_one_item(self):
         """
@@ -354,7 +365,7 @@ def test_update_count_expected_81(self):
     def test_update_count_incomplete_mr(self):
         """
         Test that the appropriate model run count is reset when an imcomplete
-        model run is identified.
+        model run is identified and an error is logged.
         """
 
         # store.get_key() will return these values in sequence like a generator
@@ -372,7 +383,12 @@ def test_update_count_incomplete_mr(self):
             call('model_gem_global_TMP_TGL_2_12Z_count', 0),
         ]
 
-        self.base_layer.update_count(self.item, 201)
+        with self.assertLogs(
+            'geomet_data_registry.layer.base', level='ERROR'
+        ) as err:
+            self.base_layer.update_count(self.item, 201)
+            # assert a single LOGGER.error was called
+            self.assertEqual(len(err.records), 1)
 
         self.mocked_load_plugin.return_value.set_key.assert_has_calls(calls)
 

tests/test_cansips.py

@@ -73,6 +73,12 @@ def test_super_init(self):
         # assert super().__init__() was called with the correct provider def
         self.mocked_base_init.assert_called_with({'name': 'cansips'})
 
+    def test_repr(self):
+        self.assertEqual(
+            repr(self.layer_handler['cansips']),
+            '<ModelCanSIPSLayer> cansips'
+        )
+
 
 class TestIdentify(unittest.TestCase, Setup):
     def setUp(self):
@@ -161,9 +167,17 @@ def test_items_identify(self):
         )
 
     def test_unsuccessful_identify(self):
-        # assert identify returns False when the wx_variable isn't correct
+        # assert identify returns False when the wx_variable
+        # isn't correct and a warning is logged.
         self.filepath = self.filepath.replace('PRATE_SFC_0', 'Not_wx_variable')
-        self.assertFalse(self.layer_handler['cansips'].identify(self.filepath))
+        with self.assertLogs(
+            'geomet_data_registry.layer.cansips', level='WARNING'
+        ) as warn:
+            self.assertFalse(
+                self.layer_handler['cansips'].identify(self.filepath)
+            )
+            # assert a single LOGGER.warning was called
+            self.assertEqual(len(warn.records), 1)
 
 
 class TestAddTimeKey(unittest.TestCase, Setup):

tests/test_cgsl.py

@@ -69,6 +69,12 @@ def test_super_init(self):
         # assert super().__init__() was called with the correct provider def
         self.mocked_base_init.assert_called_with({'name': 'cgsl'})
 
+    def test_repr(self):
+        self.assertEqual(
+            repr(self.layer_handler['cgsl']),
+            '<ModelCgslGlobalLayer> cgsl'
+        )
+
 
 class TestIdentify(unittest.TestCase, Setup):
     def setUp(self):
@@ -174,9 +180,17 @@ def test_invalid_interval_identify(self):
         )
 
     def test_unsuccessful_identify(self):
-        # assert identify returns False when the wx_variable isn't correct
+        # assert identify returns False when the wx_variable
+        # isn't correct and a warning is logged.
         self.filepath = self.filepath.replace('ocean', 'Not_wx_variable')
-        self.assertFalse(self.layer_handler['cgsl'].identify(self.filepath))
+        with self.assertLogs(
+            'geomet_data_registry.layer.cgsl', level='WARNING'
+        ) as warn:
+            self.assertFalse(
+                self.layer_handler['cgsl'].identify(self.filepath)
+            )
+            # assert a single LOGGER.warning was called
+            self.assertEqual(len(warn.records), 1)
 
 
 if __name__ == '__main__':

tests/test_gdwps.py

@@ -69,6 +69,12 @@ def test_super_init(self):
         # assert super().__init__() was called with the correct provider def
         self.mocked_base_init.assert_called_with({'name': 'gdwps'})
 
+    def test_repr(self):
+        self.assertEqual(
+            repr(self.layer_handler['gdwps']),
+            '<ModelGdwpsLayer> gdwps'
+        )
+
 
 class TestIdentify(unittest.TestCase, Setup):
     def setUp(self):
@@ -258,9 +264,17 @@ def test_invalid_interval_identify(self):
         )
 
     def test_unsuccessful_identify(self):
-        # assert identify returns False when the wx_variable isn't correct
+        # assert identify returns False when the wx_variable
+        # isn't correct and a warning is logged.
         self.filepath = self.filepath.replace('HTSGW_Sfc', 'Not_wx_variable')
-        self.assertFalse(self.layer_handler['gdwps'].identify(self.filepath))
+        with self.assertLogs(
+            'geomet_data_registry.layer.gdwps', level='WARNING'
+        ) as warn:
+            self.assertFalse(
+                self.layer_handler['gdwps'].identify(self.filepath)
+            )
+            # assert a single LOGGER.warning was called
+            self.assertEqual(len(warn.records), 1)
 
 
 if __name__ == '__main__':

tests/test_geps.py

@@ -71,6 +71,12 @@ def test_super_init(self):
         # assert super().__init__() was called with the correct provider def
         self.mocked_base_init.assert_called_with({'name': 'geps'})
 
+    def test_repr(self):
+        self.assertEqual(
+            repr(self.layer_handler['geps']),
+            '<ModelGEPSLayer> geps'
+        )
+
 
 class TestIdentify(unittest.TestCase, Setup):
     def setUp(self):
@@ -226,11 +232,19 @@ def test_invalid_interval_identify(self):
         )
 
     def test_unsuccessful_identify(self):
-        # assert identify returns False when the wx_variable isn't correct
+        # assert identify returns False when the wx_variable
+        # isn't correct and a warning is logged.
         self.filepath = self.filepath.replace(
             'HEATX_TGL_2m', 'Not_wx_variable'
         )
-        self.assertFalse(self.layer_handler['geps'].identify(self.filepath))
+        with self.assertLogs(
+            'geomet_data_registry.layer.geps', level='WARNING'
+        ) as warn:
+            self.assertFalse(
+                self.layer_handler['geps'].identify(self.filepath)
+            )
+            # assert a single LOGGER.warning was called
+            self.assertEqual(len(warn.records), 1)
 
 
 if __name__ == '__main__':

tests/test_hrdpa.py

@@ -71,6 +71,12 @@ def test_super_init(self):
         # assert super().__init__() was called with the correct provider def
         self.mocked_base_init.assert_called_with({'name': 'hrdpa'})
 
+    def test_repr(self):
+        self.assertEqual(
+            repr(self.layer_handler['hrdpa']),
+            '<HrdpaLayer> hrdpa'
+        )
+
 
 class TestIdentify(unittest.TestCase, Setup):
     def setUp(self):
@@ -154,11 +160,19 @@ def test_items_identify(self):
         self.assertListEqual(expected_items, self.layer_handler['hrdpa'].items)
 
     def test_unsuccessful_identify(self):
-        # assert identify returns False when the wx_variable isn't correct
+        # assert identify returns False when the wx_variable
+        # isn't correct and a warning is logged.
         self.filepath = self.filepath.replace(
             'APCP-006-0100cutoff_SFC_0', 'Not_wx_variable'
         )
-        self.assertFalse(self.layer_handler['hrdpa'].identify(self.filepath))
+        with self.assertLogs(
+            'geomet_data_registry.layer.hrdpa', level='WARNING'
+        ) as warn:
+            self.assertFalse(
+                self.layer_handler['hrdpa'].identify(self.filepath)
+            )
+            # assert a single LOGGER.warning was called
+            self.assertEqual(len(warn.records), 1)
 
 
 class TestAddTimeKey(unittest.TestCase, Setup):

tests/test_model_gem_global.py

@@ -73,6 +73,12 @@ def test_super_init(self):
         # assert super().__init__() was called with the correct provider def
         self.mocked_base_init.assert_called_with({'name': 'model_gem_global'})
 
+    def test_repr(self):
+        self.assertEqual(
+            repr(self.layer_handler['model_gem_global']),
+            '<ModelGemGlobalLayer> model_gem_global'
+        )
+
 
 class TestIdentify(unittest.TestCase, Setup):
     def setUp(self):
@@ -253,11 +259,17 @@ def test_invalid_interval_identify(self):
         )
 
     def test_unsuccessful_identify(self):
-        # assert identify returns False when the wx_variable isn't correct
+        # assert identify returns False when the wx_variable
+        # isn't correct and a warning is logged.
         self.filepath = self.filepath.replace('UGRD_ISBL_1015', 'Not wx_var')
-        self.assertFalse(
-            self.layer_handler['model_gem_global'].identify(self.filepath)
-        )
+        with self.assertLogs(
+            'geomet_data_registry.layer.model_gem_global', level='WARNING'
+        ) as warn:
+            self.assertFalse(
+                self.layer_handler['model_gem_global'].identify(self.filepath)
+            )
+            # assert a single LOGGER.warning was called
+            self.assertEqual(len(warn.records), 1)
 
 
 if __name__ == '__main__':

tests/test_model_gem_regional.py

@@ -75,6 +75,12 @@ def test_super_init(self):
             {'name': 'model_gem_regional'}
         )
 
+    def test_repr(self):
+        self.assertEqual(
+            repr(self.layer_handler['model_gem_regional']),
+            '<ModelGemRegionalLayer> model_gem_regional'
+        )
+
 
 class TestIdentify(unittest.TestCase, Setup):
     def setUp(self):
@@ -253,13 +259,20 @@ def test_invalid_interval_identify(self):
         )
 
     def test_unsuccessful_identify(self):
-        # assert identify returns False when the wx_variable isn't correct
+        # assert identify returns False when the wx_variable
+        # isn't correct and a warning is logged.
         self.filepath = self.filepath.replace(
             'ABSV_ISBL_250', 'Not_wx_variable'
         )
-        self.assertFalse(
-            self.layer_handler['model_gem_regional'].identify(self.filepath)
-        )
+        with self.assertLogs(
+            'geomet_data_registry.layer.model_gem_regional', level='WARNING'
+        ) as warn:
+            self.assertFalse(
+                self.layer_handler['model_gem_regional']
+                .identify(self.filepath)
+            )
+            # assert a single LOGGER.warning was called
+            self.assertEqual(len(warn.records), 1)
 
 
 if __name__ == '__main__':