XE set working

Author: miott

src/cisco_gnmi/nx.py

@@ -186,7 +186,7 @@ def check_configs(self, configs):
             )
         return configs
 
-    def create_updates(self, configs, origin):
+    def create_updates(self, configs, origin, json_ietf=False):
         if not configs:
             return None
         configs = self.check_configs(configs)
@@ -208,7 +208,10 @@ def create_updates(self, configs, origin):
                         xpath, origin=origin
                     )
                 )
-                update.val.json_val = payload
+                if json_ietf:
+                    update.val.json_ietf_val = payload
+                else:
+                    update.val.json_val = payload
                 updates.append(update)
             return updates
         else:
@@ -217,15 +220,15 @@ def create_updates(self, configs, origin):
                 update = proto.gnmi_pb2.Update()
                 update.path.CopyFrom(self.parse_xpath_to_gnmi_path(top_element))
                 config = config.pop(top_element)
-                if ietf:
+                if json_ietf:
                     update.val.json_ietf_val = json.dumps(config).encode("utf-8")
                 else:
                     update.val.json_val = json.dumps(config).encode("utf-8")
                 updates.append(update)
             return updates
 
     def set_json(self, update_json_configs=None, replace_json_configs=None,
-                 origin='device'):
+                 origin='device', json_ietf=False):
         """A convenience wrapper for set() which assumes JSON payloads and constructs desired messages.
         All parameters are optional, but at least one must be present.
 
@@ -247,10 +250,19 @@ def set_json(self, update_json_configs=None, replace_json_configs=None,
         if not any([update_json_configs, replace_json_configs]):
             raise Exception("Must supply at least one set of configurations to method!")
 
-        updates = self.create_updates(update_json_configs, origin=origin)
-        for update in updates:
+        updates = self.create_updates(
+            update_json_configs,
+            origin=origin,
+            json_ietf=json_ietf
+        )
+        replaces = self.create_updates(
+            replace_json_configs,
+            origin=origin,
+            json_ietf=json_ietf
+        )
+        for update in updates + replaces:
             logger.info('\nGNMI set:\n{0}\n{1}'.format(9 * '=', str(update)))
-        replaces = self.create_updates(replace_json_configs, origin=origin)
+
         return self.set(updates=updates, replaces=replaces)
 
     def get_xpaths(self, xpaths, data_type="ALL",

src/cisco_gnmi/xe.py

@@ -25,6 +25,7 @@
 
 import json
 import logging
+import os
 
 from six import string_types
 from .client import Client, proto, util
@@ -181,7 +182,66 @@ def delete_xpaths(self, xpaths, prefix=None):
             paths.append(self.parse_xpath_to_gnmi_path(xpath))
         return self.set(deletes=paths)
 
-    def set_json(self, update_json_configs=None, replace_json_configs=None, ietf=True):
+    def check_configs(self, configs):
+        if isinstance(configs, string_types):
+            logger.debug("Handling as JSON string.")
+            try:
+                configs = json.loads(configs)
+            except:
+                raise Exception("{0}\n is invalid JSON!".format(configs))
+            configs = [configs]
+        elif isinstance(configs, dict):
+            logger.debug("Handling already serialized JSON object.")
+            configs = [configs]
+        elif not isinstance(configs, (list, set)):
+            raise Exception(
+                "{0} must be an iterable of configs!".format(str(configs))
+            )
+        return configs
+
+    def create_updates(self, configs, origin, json_ietf=True):
+        if not configs:
+            return None
+        configs = self.check_configs(configs)
+
+        xpaths = []
+        updates = []
+        for config in configs:
+            xpath = next(iter(config.keys()))
+            xpaths.append(xpath)
+        common_xpath = os.path.commonprefix(xpaths)
+
+        if common_xpath:
+            update_configs = self.get_payload(configs)
+            for update_cfg in update_configs:
+                xpath, payload = update_cfg
+                update = proto.gnmi_pb2.Update()
+                update.path.CopyFrom(
+                    self.parse_xpath_to_gnmi_path(
+                        xpath, origin=origin
+                    )
+                )
+                if json_ietf:
+                    update.val.json_ietf_val = payload
+                else:
+                    update.val.json_val = payload
+                updates.append(update)
+            return updates
+        else:
+            for config in configs:
+                top_element = next(iter(config.keys()))
+                update = proto.gnmi_pb2.Update()
+                update.path.CopyFrom(self.parse_xpath_to_gnmi_path(top_element))
+                config = config.pop(top_element)
+                if json_ietf:
+                    update.val.json_ietf_val = json.dumps(config).encode("utf-8")
+                else:
+                    update.val.json_val = json.dumps(config).encode("utf-8")
+                updates.append(update)
+            return updates
+
+    def set_json(self, update_json_configs=None, replace_json_configs=None,
+                 origin='device', json_ietf=True):
         """A convenience wrapper for set() which assumes JSON payloads and constructs desired messages.
         All parameters are optional, but at least one must be present.
 
@@ -194,8 +254,7 @@ def set_json(self, update_json_configs=None, replace_json_configs=None, ietf=Tru
             JSON configs to apply as updates.
         replace_json_configs : iterable of JSON configurations, optional
             JSON configs to apply as replacements.
-        ietf : bool, optional
-            Use JSON_IETF vs JSON.
+        origin : openconfig, device, or DME
 
         Returns
         -------
@@ -204,52 +263,19 @@ def set_json(self, update_json_configs=None, replace_json_configs=None, ietf=Tru
         if not any([update_json_configs, replace_json_configs]):
             raise Exception("Must supply at least one set of configurations to method!")
 
-        def check_configs(configs):
-            if isinstance(configs, string_types):
-                logger.debug("Handling as JSON string.")
-                try:
-                    configs = json.loads(configs)
-                except:
-                    raise Exception("{0}\n is invalid JSON!".format(configs))
-                configs = [configs]
-            elif isinstance(configs, dict):
-                logger.debug("Handling already serialized JSON object.")
-                configs = [configs]
-            elif not isinstance(configs, (list, set)):
-                raise Exception(
-                    "{0} must be an iterable of configs!".format(str(configs))
-                )
-            return configs
-
-        def create_updates(configs):
-            if not configs:
-                return None
-            configs = check_configs(configs)
-            updates = []
-            for config in configs:
-                if not isinstance(config, dict):
-                    raise Exception("config must be a JSON object!")
-                if len(config.keys()) > 1:
-                    raise Exception("config should only target one YANG module!")
-                top_element = next(iter(config.keys()))
-                # start mike
-                # path_obj = self.parse_xpath_to_gnmi_path(top_element)
-                # config = config.pop(top_element)
-                # value_obj = proto.gnmi_pb2.TypedValue(json_ietf_val=json.dumps(config).encode("utf-8"))
-                # update = proto.gnmi_pb2.Update(path=path_obj, val=value_obj)
-                # end mike
-                update = proto.gnmi_pb2.Update()
-                update.path.CopyFrom(self.parse_xpath_to_gnmi_path(top_element))
-                config = config.pop(top_element)
-                if ietf:
-                    update.val.json_ietf_val = json.dumps(config).encode("utf-8")
-                else:
-                    update.val.json_val = json.dumps(config).encode("utf-8")
-                updates.append(update)
-            return updates
+        updates = self.create_updates(
+            update_json_configs,
+            origin=origin,
+            json_ietf=json_ietf
+        )
+        replaces = self.create_updates(
+            replace_json_configs,
+            origin=origin,
+            json_ietf=json_ietf
+        )
+        for update in updates + replaces:
+            logger.info('\nGNMI set:\n{0}\n{1}'.format(9 * '=', str(update)))
 
-        updates = create_updates(update_json_configs)
-        replaces = create_updates(replace_json_configs)
         return self.set(updates=updates, replaces=replaces)
 
     def get_xpaths(self, xpaths, data_type="ALL", encoding="JSON_IETF", origin=None):
@@ -296,9 +322,11 @@ def get_xpaths(self, xpaths, data_type="ALL", encoding="JSON_IETF", origin=None)
     def subscribe_xpaths(
         self,
         xpath_subscriptions,
-        encoding="JSON_IETF",
+        request_mode="STREAM",
+        sub_mode="SAMPLE",
+        encoding="PROTO",
         sample_interval=Client._NS_IN_S * 10,
-        heartbeat_interval=None,
+        origin='openconfig'
     ):
         """A convenience wrapper of subscribe() which aids in building of SubscriptionRequest
         with request as subscribe SubscriptionList. This method accepts an iterable of simply xpath strings,
@@ -315,26 +343,30 @@ def subscribe_xpaths(
             to SubscriptionRequest. Strings are parsed as XPaths and defaulted with the default arguments,
             dictionaries are treated as dicts of args to pass to the Subscribe init, and Subscription is
             treated as simply a pre-made Subscription.
+        request_mode : proto.gnmi_pb2.SubscriptionList.Mode, optional
+            Indicates whether STREAM to stream from target,
+            ONCE to stream once (like a get),
+            POLL to respond to POLL.
+            [STREAM, ONCE, POLL]
+        sub_mode : proto.gnmi_pb2.SubscriptionMode, optional
+            The default SubscriptionMode on a per Subscription basis in the SubscriptionList.
+            ON_CHANGE only streams updates when changes occur.
+            SAMPLE will stream the subscription at a regular cadence/interval.
+            [ON_CHANGE, SAMPLE]
         encoding : proto.gnmi_pb2.Encoding, optional
             A member of the proto.gnmi_pb2.Encoding enum specifying desired encoding of returned data
-            [JSON, JSON_IETF]
+            [JSON, PROTO]
         sample_interval : int, optional
             Default nanoseconds for sample to occur.
             Defaults to 10 seconds.
-        heartbeat_interval : int, optional
-            Specifies the maximum allowable silent period in nanoseconds when
-            suppress_redundant is in use. The target should send a value at least once
-            in the period specified.
 
         Returns
         -------
         subscribe()
         """
-        supported_request_modes = ["STREAM"]
-        request_mode = "STREAM"
-        supported_sub_modes = ["SAMPLE"]
-        sub_mode = "SAMPLE"
+        supported_request_modes = ["STREAM", "ONCE", "POLL"]
         supported_encodings = ["JSON", "JSON_IETF"]
+        supported_sub_modes = ["ON_CHANGE", "SAMPLE"]
         subscription_list = proto.gnmi_pb2.SubscriptionList()
         subscription_list.mode = util.validate_proto_enum(
             "mode",
@@ -358,7 +390,10 @@ def subscribe_xpaths(
             if isinstance(xpath_subscription, string_types):
                 subscription = proto.gnmi_pb2.Subscription()
                 subscription.path.CopyFrom(
-                    self.parse_xpath_to_gnmi_path(xpath_subscription)
+                    self.parse_xpath_to_gnmi_path(
+                        xpath_subscription,
+                        origin
+                    )
                 )
                 subscription.mode = util.validate_proto_enum(
                     "sub_mode",
@@ -369,7 +404,10 @@ def subscribe_xpaths(
                 )
                 subscription.sample_interval = sample_interval
             elif isinstance(xpath_subscription, dict):
-                path = self.parse_xpath_to_gnmi_path(xpath_subscription["path"])
+                path = self.parse_xpath_to_gnmi_path(
+                    xpath_subscription["path"],
+                    origin
+                )
                 arg_dict = {
                     "path": path,
                     "mode": sub_mode,
@@ -391,6 +429,9 @@ def subscribe_xpaths(
                 raise Exception("xpath in list must be xpath or dict/Path!")
             subscriptions.append(subscription)
         subscription_list.subscription.extend(subscriptions)
+        logger.info('GNMI subscribe:\n{0}\n{1}'.format(
+            15 * '=', str(subscription_list))
+        )
         return self.subscribe([subscription_list])
 
     def parse_xpath_to_gnmi_path(self, xpath, origin=None):