Added error handling in client, and updated examples

Author: kkumara3

examples/grpc_cfg.py

@@ -3,35 +3,65 @@
 This is an example to show replace and merge configs work with a get command.
 The example is using XRdocs vagrant topology for all the configurations
 '''
-
+from grpc.framework.interfaces.face.face import AbortionError
+import json
+from time import sleep
 import sys
 sys.path.insert(0, '../')
 from lib.cisco_grpc_client import CiscoGRPCClient
-import json
-from time import sleep
 
-class Example:
+
+class Example(object):
     def __init__(self):
-        self.client = CiscoGRPCClient('11.1.1.10', 57777, 10, 'vagrant', 'vagrant')
+        self.client = CiscoGRPCClient('127.0.0.1', 57777, 10, 'vagrant', 'vagrant')
     def get(self):
         path = '{"Cisco-IOS-XR-ipv4-bgp-cfg:bgp": [null]}'
         result = self.client.getconfig(path)
-        print result
+        try:
+            err, result = self.client.getconfig(path)
+            if err:
+                print err
+            print json.dumps(json.loads(result))
+        except AbortionError:
+            print(
+                'Unable to connect to local box, check your gRPC destination.'
+                )
 
     def replace(self):
         path = open('snips/bgp_start.json').read()
-        result = self.client.replaceconfig(path)
-        print result # If this is sucessful, then there should be no errors.
+        try:
+            response = self.client.replaceconfig(path)
+            if response.errors:
+                err = json.loads(response.errors)
+                print err
+        except AbortionError:
+            print(
+                'Unable to connect to local box, check your gRPC destination.'
+                )
 
     def merge(self):
         path = open('snips/bgp_merge.json').read()
-        result = self.client.mergeconfig(path)
-        print result # If this is sucessful, then there should be no errors.
+        try:
+            response = self.client.mergeconfig(path)
+            if response.errors:
+                err = json.loads(response.errors)
+                print err
+        except AbortionError:
+            print(
+                'Unable to connect to local box, check your gRPC destination.'
+                )
 
     def delete(self):
         path = open('snips/bgp_start.json').read()
-        result = self.client.deleteconfig(path)
-        print result # If this is sucessful, then there should be no errors.
+        try:
+            response = self.client.deleteconfig(path)
+            if response.errors:
+                err = json.loads(response.errors)
+                print err
+        except AbortionError:
+            print(
+                'Unable to connect to local box, check your gRPC destination.'
+                )
 
 def main():
     '''

examples/grpc_example.py

@@ -1,10 +1,11 @@
 """ Basic gRPC getcall configuration. Shows how to set up the vairables
 for tls and how to put into the class and get information from the box.
 """
+import json
+from grpc.framework.interfaces.face.face import AbortionError
 import sys
 sys.path.insert(0, '../')
 from lib.cisco_grpc_client import CiscoGRPCClient
-import json
 
 def main():
     '''
@@ -14,12 +15,19 @@ def main():
     ex: client = CiscoGRPCClient('11.1.1.10', 57777, 10, 'vagrant', 'vagrant')
     '''
     creds = open('ems.pem').read()
-    options='ems.cisco.com'
-    client = CiscoGRPCClient('11.1.1.10', 57777, 10, 'vagrant', 'vagrant', creds, options)
+    options = 'ems.cisco.com'
+    client = CiscoGRPCClient('127.0.0.1', 57777, 10, 'vagrant', 'vagrant', creds, options)
     #Test 1: Test Get config json requests
     path = '{"Cisco-IOS-XR-ip-static-cfg:router-static": [null]}'
-    result = client.getconfig(path)
-    print json.dumps(json.loads(result))
+    try:
+        err, result = client.getconfig(path)
+        if err:
+            print err
+        print json.dumps(json.loads(result))
+    except AbortionError:
+        print(
+            'Unable to connect to local box, check your gRPC destination.'
+            )
 
 if __name__ == '__main__':
     main()

lib/cisco_grpc_client.py

@@ -80,10 +80,11 @@ def getconfig(self, path):
         """
         message = ems_grpc_pb2.ConfigGetArgs(yangpathjson=path)
         responses = self._stub.GetConfig(message, self._timeout, metadata=self._metadata)
-        objects = ''
+        objects, err = '', ''
         for response in responses:
             objects += response.yangjson
-        return objects
+            err += response.errors
+        return err, objects
 
     def getsubscription(self, sub_id, unmarshal):
         """Telemetry subscription function
@@ -152,9 +153,10 @@ def getoper(self, path):
         """
         message = ems_grpc_pb2.GetOperArgs(yangpathjson=path)
         responses = self._stub.GetOper(message, self._timeout, metadata=self._metadata)
-        objects = ''
+        objects, err = '', ''
         for response in responses:
             objects += response.yangjson
+            err += response.errors
         return objects
 
     def cliconfig(self, cli):
@@ -178,9 +180,10 @@ def showcmdtextoutput(self, cli):
         stub = ems_grpc_pb2.beta_create_gRPCExec_stub(self._channel)
         message = ems_grpc_pb2.ShowCmdArgs(cli=cli)
         responses = stub.ShowCmdTextOutput(message, self._timeout, metadata=self._metadata)
-        objects = ''
+        objects, err = '', ''
         for response in responses:
             objects += response.output
+            err += response.errors
         return objects
 
     def showcmdjsonoutput(self, cli):
@@ -193,7 +196,8 @@ def showcmdjsonoutput(self, cli):
         stub = ems_grpc_pb2.beta_create_gRPCExec_stub(self._channel)
         message = ems_grpc_pb2.ShowCmdArgs(cli=cli)
         responses = stub.ShowCmdJSONOutput(message, self._timeout, metadata=self._metadata)
-        objects = ''
+        objects, err = '', ''
         for response in responses:
             objects += response.jsonoutput
+            err += response.errors
         return objects