Skip to content

Commit

Permalink
Merge pull request #76 from sebageek/wrap-exceptions-instead-of-hidin…
Browse files Browse the repository at this point in the history 
…g-them

Wrap exceptions instead of hiding them
  • Loading branch information
@akarneliuk
akarneliuk authored Jul 22, 2022
2 parents 458e27a + 380bb78 commit 3808dc7
Showing 1 changed file with 37 additions and 28 deletions.
65 changes: 37 additions & 28 deletions pygnmi/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,29 +119,28 @@ def connect(self, timeout: int = None):
key = open(self.__path_key, 'rb').read()
root_cert = open(self.__path_root, 'rb').read()

except FileNotFoundError:
except FileNotFoundError as e:
logger.error('The SSL certificate cannot be opened.')
raise Exception('The SSL certificate cannot be opened.')
raise gNMIException('The SSL certificate cannot be opened.', e)

elif self.__path_cert:
try:
with open(self.__path_cert, 'rb') as f:
ssl_cert = f.read()

except FileNotFoundError:
except FileNotFoundError as e:
logger.error('The SSL certificate cannot be opened.')
raise Exception('The SSL certificate cannot be opened.')
raise gNMIException('The SSL certificate cannot be opened.', e)

# Download a certficate from device if it is not provided
else:
try:
ssl_cert = ssl.get_server_certificate((self.__target[0], self.__target[1])).encode("utf-8")

except:
except Exception as e:
logger.error(f'The SSL certificate cannot be retrieved from {self.__target}')
raise Exception(f'The SSL certificate cannot be retrieved from {self.__target}')
raise gNMIException(f'The SSL certificate cannot be retrieved from {self.__target}', e)


# Work with the certificate contents
ssl_cert_deserialized = x509.load_pem_x509_certificate(ssl_cert, default_backend())

Expand Down Expand Up @@ -283,8 +282,7 @@ def capabilities(self):

except grpc._channel._InactiveRpcError as err:
logger.critical(f"GRPC ERROR Host: {self.__target_path}, Error: {err.details()}")

raise Exception(err)
raise gNMIException(f"GRPC ERROR Host: {self.__target_path}, Error: {err.details()}", err)

except:
logger.error('Collection of Capabilities is failed.')
Expand Down Expand Up @@ -354,9 +352,9 @@ def get(self, prefix: str = "", path: list = [],
try:
protobuf_prefix = gnmi_path_generator(prefix, target)

except:
except Exception as e:
logger.error('Conversion of gNMI prefix to the Protobuf format failed')
raise Exception('Conversion of gNMI prefix to the Protobuf format failed')
raise gNMIException('Conversion of gNMI prefix to the Protobuf format failed', e)

# Gnmi PATH
try:
Expand All @@ -366,9 +364,9 @@ def get(self, prefix: str = "", path: list = [],
else:
protobuf_paths = [gnmi_path_generator(pe) for pe in path]

except:
except Exception as e:
logger.error('Conversion of gNMI paths to the Protobuf format failed')
raise Exception ('Conversion of gNMI paths to the Protobuf format failed')
raise gNMIException('Conversion of gNMI paths to the Protobuf format failed', e)

if self.__capabilities and 'supported_encodings' in self.__capabilities:
if 'json' in self.__capabilities['supported_encodings']:
Expand Down Expand Up @@ -459,8 +457,7 @@ def get(self, prefix: str = "", path: list = [],

except grpc._channel._InactiveRpcError as err:
logger.critical(f"GRPC ERROR Host: {self.__target_path}, Error: {err.details()}")

raise Exception (err)
raise gNMIException(f"GRPC ERROR Host: {self.__target_path}, Error: {err.details()}", err)

except:
logger.error(f'Collection of Get information failed is failed.')
Expand Down Expand Up @@ -500,29 +497,28 @@ def set(self, delete: list = None, replace: list = None,

if encoding not in encoding_set:
logger.error(f'The encoding {encoding} is not supported. The allowed are: {", ".join(encoding_set)}.')
raise Exception (f'The encoding {encoding} is not supported. The allowed are: {", ".join(encoding_set)}.')
raise gNMIException(f'The encoding {encoding} is not supported. The allowed are: {", ".join(encoding_set)}.')

# Gnmi PREFIX
try:
protobuf_prefix = gnmi_path_generator(prefix, target)

except:
except Exception as e:
logger.error('Conversion of gNMI prefix to the Protobuf format failed')
raise Exception('Conversion of gNMI prefix to the Protobuf format failed')
raise gNMIException('Conversion of gNMI prefix to the Protobuf format failed', e)

# Delete operation
if delete:
if isinstance(delete, list):
try:
del_protobuf_paths = [gnmi_path_generator(pe) for pe in delete]

except:
except Exception as e:
logger.error(f'Conversion of gNMI paths to the Protobuf format failed')
raise Exception (f'Conversion of gNMI paths to the Protobuf format failed')
raise gNMIException(f'Conversion of gNMI paths to the Protobuf format failed', e)

else:
logger.error(f'The provided input for Set message (delete operation) is not list.')
raise Exception (f'The provided input for Set message (delete operation) is not list.')
raise gNMIException(f'The provided input for Set message (delete operation) is not list.')

# Replace operation
if replace:
Expand All @@ -545,11 +541,11 @@ def set(self, delete: list = None, replace: list = None,

else:
logger.error(f'The input element for Update message must be tuple, got {ue}.')
raise Exception (f'The input element for Update message must be tuple, got {ue}.')
raise gNMIException(f'The input element for Update message must be tuple, got {ue}.')

else:
logger.error(f'The provided input for Set message (replace operation) is not list.')
raise Exception ('The provided input for Set message (replace operation) is not list.')
raise gNMIException('The provided input for Set message (replace operation) is not list.')

# Update operation
if update:
Expand All @@ -572,11 +568,11 @@ def set(self, delete: list = None, replace: list = None,

else:
logger.error(f'The input element for Update message must be tuple, got {ue}.')
raise Exception (f'The input element for Update message must be tuple, got {ue}.')
raise gNMIException(f'The input element for Update message must be tuple, got {ue}.')

else:
logger.error(f'The provided input for Set message (update operation) is not list.')
raise Exception ('The provided input for Set message (replace operation) is not list.')
raise gNMIException('The provided input for Set message (replace operation) is not list.')

try:
# Adding collection of data for diff before the change
Expand Down Expand Up @@ -800,7 +796,7 @@ def subscribe(self, subscribe: dict = None, poll: bool = False, aliases: list =
logger.info(f'Collecting Telemetry...')

if (subscribe and poll) or (subscribe and aliases) or (poll and aliases):
raise Exception('Subscribe request supports only one request at a time.')
raise gNMIException('Subscribe request supports only one request at a time.')

if poll:
if isinstance(poll, bool):
Expand Down Expand Up @@ -853,7 +849,7 @@ def subscribe2(self, subscribe: dict, target: str = None):
return self.subscribe_once(subscribe=subscribe, target=target)

else:
raise Exception('Unknown subscription request mode.')
raise gNMIException('Unknown subscription request mode.')

def subscribe_stream(self, subscribe: dict, target: str = None):
if 'mode' not in subscribe:
Expand Down Expand Up @@ -1096,6 +1092,19 @@ def _next_update(self, timeout):
return self._get_updates_till_sync(timeout=timeout)


class gNMIException(Exception):
"""Raised when a generic error in pygnmi occurred
Represents a generic pygnmi library error, described with a text what
the library tried to do. Optionally, an original exception can be added,
so the user of this library can further distinguish what happened in the
backend.
"""
def __init__(self, message, orig_exc=None):
super().__init__(message)
self.orig_exc = orig_exc


# User-defined functions
def telemetryParser(in_message=None, debug: bool = False):
"""
Expand Down

0 comments on commit 3808dc7

Please sign in to comment.