refactor: add standard exception handling to Options data manager (#431)

ReliaQualAssociates · Jan 12, 2021 · 254d4b2 · 254d4b2
1 parent c645ebf
commit 254d4b2
Show file tree

Hide file tree

Showing 106 changed files with 423 additions and 151 deletions.
diff --git a/src/ramstk/controllers/options/datamanager.py b/src/ramstk/controllers/options/datamanager.py
@@ -7,13 +7,15 @@
 """Options Package Data Model."""
 
 # Standard Library Imports
-from typing import Any, Dict
+import inspect
+from typing import Any, Dict, List
 
 # Third Party Imports
 from pubsub import pub
 
 # RAMSTK Package Imports
 from ramstk.controllers import RAMSTKDataManager
+from ramstk.exceptions import DataAccessError
 from ramstk.models.commondb import RAMSTKSiteInfo
 from ramstk.models.programdb import RAMSTKProgramInfo
 
@@ -25,20 +27,34 @@ class DataManager(RAMSTKDataManager):
     data from the Site and Program databases.
     """
 
+    # Define private dict class attributes.
+
+    # Define private list class attributes.
+
+    # Define private scalar class attributes.
     _tag = 'options'
     _root = 0
 
+    # Define public dict class attributes.
+
+    # Define public list class attributes.
+
+    # Define public scalar class attributes.
+
     def __init__(self, **kwargs) -> None:
         """Initialize a Options data manager instance."""
         RAMSTKDataManager.__init__(self, **kwargs)
 
         # Initialize private dictionary attributes.
-        self._pkey = {'siteinfo': ['site_id'], 'programinfo': ['revision_id']}
+        self._pkey: Dict[str, List[str]] = {
+            'siteinfo': ['site_id'],
+            'programinfo': ['revision_id']
+        }
 
         # Initialize private list attributes.
 
         # Initialize private scalar attributes.
-        self._parent_id = 0
+        self._parent_id: int = 0
 
         # Initialize public dictionary attributes.
 
@@ -97,7 +113,10 @@ def do_select_all(self, attributes: Dict[str, Any]) -> None:
                                   parent=self._root,
                                   data={'programinfo': _option})
 
-        pub.sendMessage('succeed_retrieve_options', tree=self.tree)
+        pub.sendMessage(
+            'succeed_retrieve_options',
+            tree=self.tree,
+        )
 
     def do_update(self, node_id: str) -> None:
         """Update the record associated with node ID in RAMSTK databases.
@@ -106,18 +125,64 @@ def do_update(self, node_id: str) -> None:
         :return: None
         :rtype: None
         """
-        if node_id == 'siteinfo':
-            # noinspection PyUnresolvedReferences
-            self.common_dao.session.add(
-                self.tree.get_node(node_id).data[node_id])
-            self.dao.do_update()
-            pub.sendMessage('succeed_update_options', node_id=node_id)
-        elif node_id == 'programinfo':
-            # noinspection PyUnresolvedReferences
-            self.dao.session.add(self.tree.get_node(node_id).data[node_id])
-            self.dao.do_update()
-            pub.sendMessage('succeed_update_options', node_id=node_id)
-        else:
-            pub.sendMessage('fail_update_options',
-                            error_message=('Error saving {0:s} Options to the '
-                                           'database.').format(node_id))
+        try:
+            if node_id == 'siteinfo':
+                # noinspection PyUnresolvedReferences
+                self.common_dao.session.add(
+                    self.tree.get_node(node_id).data[node_id])
+                self.common_dao.do_update()
+                pub.sendMessage(
+                    'succeed_update_options',
+                    node_id=node_id,
+                )
+            elif node_id == 'programinfo':
+                # noinspection PyUnresolvedReferences
+                self.dao.session.add(self.tree.get_node(node_id).data[node_id])
+                self.dao.do_update()
+                pub.sendMessage(
+                    'succeed_update_options',
+                    node_id=node_id,
+                )
+            else:
+                _method_name: str = inspect.currentframe(  # type: ignore
+                ).f_code.co_name
+                _error_msg = ('{1}: Attempted to save non-existent Option '
+                              'type {0}.').format(str(node_id), _method_name)
+                pub.sendMessage(
+                    'do_log_debug',
+                    logger_name='DEBUG',
+                    message=_error_msg,
+                )
+                pub.sendMessage(
+                    'fail_update_options',
+                    error_message=_error_msg,
+                )
+        except KeyError:
+            _method_name: str = inspect.currentframe(  # type: ignore
+            ).f_code.co_name
+            _error_msg = ('{1}: No data package found for Option {0}.').format(
+                str(node_id), _method_name)
+            pub.sendMessage(
+                'do_log_debug',
+                logger_name='DEBUG',
+                message=_error_msg,
+            )
+            pub.sendMessage(
+                'fail_update_options',
+                error_message=_error_msg,
+            )
+        except (TypeError, DataAccessError):
+            _method_name: str = inspect.currentframe(  # type: ignore
+            ).f_code.co_name
+            _error_msg = ('{1}: The value for one or more attributes for '
+                          'Options {0} was the wrong type.').format(
+                              str(node_id), _method_name)
+            pub.sendMessage(
+                'do_log_debug',
+                logger_name='DEBUG',
+                message=_error_msg,
+            )
+            pub.sendMessage(
+                'fail_update_options',
+                error_message=_error_msg,
+            )
diff --git a/src/ramstk/controllers/options/datamanager.pyi b/src/ramstk/controllers/options/datamanager.pyi
@@ -3,6 +3,7 @@ from typing import Any, Dict
 
 # RAMSTK Package Imports
 from ramstk.controllers import RAMSTKDataManager as RAMSTKDataManager
+from ramstk.exceptions import DataAccessError as DataAccessError
 from ramstk.models.commondb import RAMSTKSiteInfo as RAMSTKSiteInfo
 from ramstk.models.programdb import RAMSTKProgramInfo as RAMSTKProgramInfo
 

diff --git a/tests/analyses/milhdbk217f/models/test_capacitor.py b/tests/analyses/milhdbk217f/models/test_capacitor.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.models.test_capacitor.py is part of The

diff --git a/tests/analyses/milhdbk217f/models/test_connection.py b/tests/analyses/milhdbk217f/models/test_connection.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.models.test_connection.py is part of The

diff --git a/tests/analyses/milhdbk217f/models/test_crystal.py b/tests/analyses/milhdbk217f/models/test_crystal.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.models.test_crystal.py is part of The RAMSTK

diff --git a/tests/analyses/milhdbk217f/models/test_filter.py b/tests/analyses/milhdbk217f/models/test_filter.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.models.test_filter.py is part of The RAMSTK

diff --git a/tests/analyses/milhdbk217f/models/test_fuse.py b/tests/analyses/milhdbk217f/models/test_fuse.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.models.test_fuse.py is part of The RAMSTK

diff --git a/tests/analyses/milhdbk217f/models/test_inductor.py b/tests/analyses/milhdbk217f/models/test_inductor.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.models.test_inductor.py is part of The

diff --git a/tests/analyses/milhdbk217f/models/test_integrated_circuit.py b/tests/analyses/milhdbk217f/models/test_integrated_circuit.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.models.test_integrated_circuit.py is part of

diff --git a/tests/analyses/milhdbk217f/models/test_lamp.py b/tests/analyses/milhdbk217f/models/test_lamp.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.models.test_lamp.py is part of The RAMSTK

diff --git a/tests/analyses/milhdbk217f/models/test_meter.py b/tests/analyses/milhdbk217f/models/test_meter.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.models.test_meter.py is part of The RAMSTK

diff --git a/tests/analyses/milhdbk217f/models/test_relay.py b/tests/analyses/milhdbk217f/models/test_relay.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.models.test_relay.py is part of The RAMSTK

diff --git a/tests/analyses/milhdbk217f/models/test_resistor.py b/tests/analyses/milhdbk217f/models/test_resistor.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk271f.models.test_resistor.py is part of The

diff --git a/tests/analyses/milhdbk217f/models/test_semiconductor.py b/tests/analyses/milhdbk217f/models/test_semiconductor.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.models.test_semiconductor.py is part of The

diff --git a/tests/analyses/milhdbk217f/models/test_switch.py b/tests/analyses/milhdbk217f/models/test_switch.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.models.test_switch.py is part of The RAMSTK

diff --git a/tests/analyses/milhdbk217f/test_milhdbk217f.py b/tests/analyses/milhdbk217f/test_milhdbk217f.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.milhdbk217f.test_milhdbk217f.py is part of The RAMSTK Project

diff --git a/tests/analyses/statistics/test_bounds.py b/tests/analyses/statistics/test_bounds.py
@@ -1,4 +1,5 @@
-# pylint: disable=protected-access, no-self-use, missing-docstring
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.statistics.test_bounds.py is part of The RAMSTK Project

diff --git a/tests/analyses/test_allocation.py b/tests/analyses/test_allocation.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.test_allocation.py is part of The RAMSTK Project

diff --git a/tests/analyses/test_criticality.py b/tests/analyses/test_criticality.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.test_criticality.py is part of The RAMSTK Project

diff --git a/tests/analyses/test_derating.py b/tests/analyses/test_derating.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.test_derating.py is part of The RAMSTK Project

diff --git a/tests/analyses/test_dormancy.py b/tests/analyses/test_dormancy.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.test_dormancy.py is part of The RAMSTK Project

diff --git a/tests/analyses/test_fha.py b/tests/analyses/test_fha.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.test_fha.py is part of The RAMSTK Project

diff --git a/tests/analyses/test_improvementfactor.py b/tests/analyses/test_improvementfactor.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.test_improvementfactor.py is part of The RAMSTK Project

diff --git a/tests/analyses/test_similaritem.py b/tests/analyses/test_similaritem.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.test_similaritem.py is part of The RAMSTK Project

diff --git a/tests/analyses/test_stress.py b/tests/analyses/test_stress.py
@@ -1,4 +1,5 @@
-# pylint: disable=invalid-name, protected-access
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.analyses.test_stress.py is part of The RAMSTK Project

diff --git a/tests/controllers/test_allocations.py b/tests/controllers/test_allocations.py
@@ -1,4 +1,5 @@
-# pylint: disable=protected-access, no-self-use, missing-docstring, invalid-name
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.controllers.test_allocations.py is part of The RAMSTK

diff --git a/tests/controllers/test_failure_definition.py b/tests/controllers/test_failure_definition.py
@@ -1,4 +1,5 @@
-# pylint: disable=protected-access, no-self-use, missing-docstring
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.controllers.test_revision.py is part of The RAMSTK Project

diff --git a/tests/controllers/test_function.py b/tests/controllers/test_function.py
@@ -1,5 +1,5 @@
+# pylint: skip-file
 # type: ignore
-# pylint: disable=protected-access, no-self-use, missing-docstring
 # -*- coding: utf-8 -*-
 #
 #       tests.controllers.test_function.py is part of The RAMSTK Project

diff --git a/tests/controllers/test_hardware.py b/tests/controllers/test_hardware.py
@@ -1,4 +1,5 @@
-# pylint: disable=protected-access, no-self-use, missing-docstring, invalid-name
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.controllers.hardware.test_hardware.py is part of The RAMSTK

diff --git a/tests/controllers/test_hazards.py b/tests/controllers/test_hazards.py
@@ -1,4 +1,5 @@
-# pylint: disable=protected-access, no-self-use, missing-docstring
+# pylint: skip-file
+# type: ignore
 # -*- coding: utf-8 -*-
 #
 #       tests.controllers.test_function.py is part of The RAMSTK Project