Refactor: Added exceptions

* wip

* feat: added diagnostics structures

Diagnostic and DiagnosticsReport are used to construct
and communicate information about diagnostics state.

* Updated with new changes in hm-diag

* Exception Code Merge

* Bump Version for testing

* File changes

* Fix test

* Remove binaries

* Added more catches for exceptions

- Added Gateway_MFR File not found exception (Encountered when does not exist)
- Added Miner Failed To Fetch Mac Address exception
- Added Unit Test for Miner Failed To Fetch Mac Address exception

* Fix lint errors

* Flake linting fix

* Fix remaining lint errors

* Whitespace lines removed

* Fix PR warnings

* Version bump

* PR comment fixes

* Fix for linting

Co-authored-by: Marvin Arnold <marvin@geeky.rocks>
Co-authored-by: Sebastian <sebastian@ghostistudios.com>

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.11.4
+current_version = 0.11.5
 commit = True
 tag = True
 

hm_pyhelper/diagnostics/__init__.py

@@ -1,2 +1,2 @@
 from hm_pyhelper.diagnostics.diagnostics_report import DiagnosticsReport  # noqa F401
-from hm_pyhelper.diagnostics.diagnostic import Diagnostic  # noqa F401
+from hm_pyhelper.diagnostics.diagnostic import Diagnostic  # noqa F401

hm_pyhelper/exceptions.py

@@ -8,3 +8,11 @@ class SPIUnavailableException(Exception):
 
 class ECCMalfunctionException(Exception):
     pass
+
+
+class GatewayMFRFileNotFoundException(Exception):
+    pass
+
+
+class MinerFailedToFetchMacAddress(Exception):
+    pass

hm_pyhelper/miner_json_rpc/exceptions.py

@@ -1,4 +1,3 @@
-
 class MinerJSONRPCException(Exception):
     pass
 
@@ -13,3 +12,11 @@ class MinerMalformedURL(MinerJSONRPCException):
 
 class MinerRegionUnset(MinerJSONRPCException):
     pass
+
+
+class MinerFailedFetchData(MinerJSONRPCException):
+    pass
+
+
+class MinerFailedToFetchEthernetAddress(MinerJSONRPCException):
+    pass

hm_pyhelper/miner_param.py

@@ -5,7 +5,11 @@
 from hm_pyhelper.lock_singleton import lock_ecc
 from hm_pyhelper.logger import get_logger
 from hm_pyhelper.exceptions import MalformedRegionException, \
-    SPIUnavailableException, ECCMalfunctionException
+    SPIUnavailableException, ECCMalfunctionException, \
+    GatewayMFRFileNotFoundException, \
+    MinerFailedToFetchMacAddress
+from hm_pyhelper.miner_json_rpc.exceptions import \
+     MinerFailedToFetchEthernetAddress
 from hm_pyhelper.hardware_definitions import is_rockpi
 
 
@@ -41,6 +45,11 @@ def run_gateway_mfr(args):
         err_str = "gateway_mfr exited with a non-zero status"
         LOGGER.exception(err_str)
         raise ECCMalfunctionException(err_str).with_traceback(e.__traceback__)
+    except (FileNotFoundError, NotADirectoryError) as e:
+        err_str = "file/directory for gateway_mfr was not found"
+        LOGGER.exception(err_str)
+        raise GatewayMFRFileNotFoundException(err_str) \
+            .with_traceback(e.__traceback__)
 
     try:
         return json.loads(run_gateway_mfr_result.stdout)
@@ -170,6 +179,9 @@ def get_ethernet_addresses(diagnostics):
         except Exception as e:
             diagnostics[key] = False
             LOGGER.error(e)
+            raise(MinerFailedToFetchEthernetAddress(
+                "Unable to fetch miner ethernet address.\
+                 Exception: %s" % str(e))).with_traceback(e.__traceback__)
 
 
 def get_mac_address(path):
@@ -182,13 +194,28 @@ def get_mac_address(path):
         TypeError - If the function argument is not a string.
     """
     if type(path) is not str:
-        raise TypeError("The path must be a string value")
+        raise TypeError(
+            "Constructing miner mac address failed.\
+             The path must be a string value")
     try:
         file = open(path)
     except FileNotFoundError as e:
-        raise e
+        LOGGER.exception("Failed to find Miner \
+            Mac Address file at path %s" % path)
+        raise MinerFailedToFetchMacAddress(
+            "Failed to find file containing miner mac address. \
+             Exception: %s" % str(e)).with_traceback(e.__traceback__)
     except PermissionError as e:
-        raise e
+        LOGGER.exception("Permissions invalid for Miner \
+            Mac Address file at path %s" % path)
+        raise MinerFailedToFetchMacAddress(
+            "Failed to fetch miner mac address. Invalid permissions to access file. \
+             Exception: %s" % str(e)).with_traceback(e.__traceback__)
+    except Exception as e:
+        LOGGER.exception(e)
+        raise MinerFailedToFetchMacAddress(
+            "Failed to fetch miner mac address. \
+             Exception: %s" % str(e)).with_traceback(e.__traceback__)
     return file.readline().strip().upper()
 
 

hm_pyhelper/tests/test_diagnostic_report.py

@@ -1,8 +1,7 @@
 import unittest
 import json
 
-from hm_pyhelper.diagnostics import Diagnostic
-from hm_pyhelper.diagnostics import DiagnosticsReport
+from hm_pyhelper.diagnostics import Diagnostic, DiagnosticsReport
 from hm_pyhelper.diagnostics.diagnostics_report import \
                                     DIAGNOSTICS_PASSED_KEY, \
                                     DIAGNOSTICS_ERRORS_KEY

hm_pyhelper/tests/test_miner_param.py

@@ -1,7 +1,10 @@
+from hm_pyhelper.exceptions import MinerFailedToFetchMacAddress
 from hm_pyhelper.miner_param import retry_get_region, await_spi_available, \
-    provision_key, did_gateway_mfr_test_result_include_miner_key_pass
+    provision_key, did_gateway_mfr_test_result_include_miner_key_pass, \
+    get_mac_address
 import unittest
 from unittest.mock import mock_open, patch
+import pytest
 
 ALL_PASS_GATEWAY_MFR_TESTS = [
     {
@@ -170,3 +173,7 @@ def test_get_region_from_miner(self, _):
     @patch("os.path.exists", return_value=True)
     def test_is_spi_available(self, _):
         self.assertTrue(await_spi_available("spiXY.Z"))
+
+    def test_error_mac_address(self):
+        with pytest.raises(MinerFailedToFetchMacAddress):
+            get_mac_address("test/path")

setup.py

@@ -3,7 +3,7 @@
 
 setup(
     name='hm_pyhelper',
-    version='0.11.4',
+    version='0.11.5',
     author="Nebra Ltd",
     author_email="support@nebra.com",
     description="Helium Python Helper",