Add Testcases with Set Replace (#386)

JoseIgnacioTamayo · web-flow · commit a0ce6eb78541 · 2024-08-20T12:26:57.000-06:00
* Add TestCases for SetReplace

* Document SetReplace Testclasses

* Add Demo tests with SetReplace
diff --git a/oc_config_validate/demo/config_tests.yaml b/oc_config_validate/demo/config_tests.yaml
@@ -70,14 +70,14 @@ tests:
       }
 
 - !TestCase
-  name: "Bad Compare mgmt Interface state JSON"
+  name: "FAIL Compare mgmt Interface state JSON"
   class_name: get.GetCompare
   args:
     xpath: "interfaces/interface[name=mgmt]/state"
     want: {"openconfig-interfaces:enabled": false}
 
 - !TestCase
-  name: "Set Hostname"
+  name: "Update Hostname"
   class_name: set.SetUpdate
   args:
     xpath: "system/config/hostname"
@@ -95,29 +95,40 @@ tests:
     }
 
 - !TestCase
-  name: "Bad model to compare System config"
+  name: "Replace System Config"
+  class_name: set.SetReplace
+  args:
+    xpath: "system/config"
+    value: {
+    "openconfig-system:hostname": "atestdevice",
+    "openconfig-system:domain-name": "foo.bar.com"
+  }
+
+- !TestCase
+  name: "FAIL Check System config - model"
   class_name: get.GetJsonCheckCompare
   args:
     xpath: "system/config"
-    model: system.openconfig_system
+    model: interfaces.openconfig_interfaces
     want_json: {
       "openconfig-system:domain-name": "foo.bar.com",
       "openconfig-system:hostname": "foobar"
     }
 
 - !TestCase
-  name: "Bad data to compare System config"
+  name: "FAIL Compare System config - data"
   class_name: get.GetJsonCheckCompare
   args:
     xpath: "system/config"
     model: system.openconfig_system
     want_json: {
       "openconfig-system:domain-name": "la.la.la.com",
-      "openconfig-system:hostname": "lalala"
+      "openconfig-system:hostname": "lalala",
+      "openconfig-system:motd-banner": "Welcome"
     }
 
 - !TestCase
-  name: "Set timezone with a valid Json blob"
+  name: "Update timezone with a valid Json blob"
   class_name: set.JsonCheckSetUpdate
   args:
     xpath: "system/clock/config"
@@ -137,7 +148,7 @@ tests:
     }
 
 - !TestCase
-  name: "Set timezone with a valid Json blob"
+  name: "Update timezone with a valid Json blob"
   class_name: setget.SetGetJsonCheck
   args:
     xpath: "system/clock/config"
@@ -147,7 +158,7 @@ tests:
     }
 
 - !TestCase
-  name: "Set timezone with a valid Json blob, and check it is Zurich"
+  name: "Update timezone with a valid Json blob, and check it is Zurich"
   class_name: setget.SetGetJsonCheckCompare
   args:
     xpath: "system/clock/config"
@@ -157,11 +168,49 @@ tests:
     }
 
 - !TestCase
-  name: "Bad Set Clock Check State"
+  name: "FAIL Update Clock Check State"
   class_name: config_state.SetConfigCheckState
   args:
     xpath: "system/clock"
     model: system.openconfig_system
     json_value: {
       "openconfig-system:timezone-name": "Europe/Paris"
     }
+
+- !TestCase
+  name: "FAIL Replace System Config - model"
+  class_name: set.JsonCheckSetReplace
+  args:
+    xpath: "system/config"
+    model: system.openconfig_system
+    json_value: {
+      "host": "zz-tri-dev01",
+      "domain": "foo.bar.com",
+    }
+
+- !TestCase
+  name: "Replace System Config"
+  class_name: setget.SetGetJsonCheck
+  args:
+    xpath: "system/config"
+    model: system.openconfig_system
+    set_replace: True
+    json_value: {
+            "openconfig-system:hostname": "zz-tri-dev01",
+            "openconfig-system:domain-name": "foo.bar.com",
+            "openconfig-system:login-banner": "This device is for authorized use only",
+            "openconfig-system:motd-banner": "Welcome to Open vSwitch"
+        }
+
+- !TestCase
+  name: "Replace and Get System Config"
+  class_name: setget.SetGetJsonCheckCompare
+  args:
+    xpath: "system/config"
+    model: system.openconfig_system
+    set_replace: True
+    json_value: {
+      "openconfig-system:hostname": "zz-tri-dev01",
+      "openconfig-system:domain-name": "foo.bar.com",
+      "openconfig-system:motd-banner": "Welcome to Open vSwitch"
+    }
diff --git a/oc_config_validate/docs/testclasses.md b/oc_config_validate/docs/testclasses.md
@@ -64,6 +64,15 @@
      *  `xpath`: gNMI path to delete.
 
 
+ *  `set.SetReplace`
+
+    Sends gNMI Set Replace of an xpath with a value.
+
+    Args:
+     *  `xpath`: gNMI path to update.
+     *  `value`: Value to set; can be numeric, string or JSON-IETF.
+ 
+ 
  *  `set.JsonCheckSetUpdate`
 
     Sends gNMI Set with a schema-checked JSON-IETF value.
@@ -74,6 +83,18 @@
      *  `model`: Python binding class to check the JSON reply against.
           The binding classes are in the `oc_config_validate.models` package.
 
+
+ *  `set.JsonCheckSetReplace`
+
+    Sends gNMI Set with a schema-checked JSON-IETF value.
+
+    Args:
+     *  `xpath`: gNMI path to read.
+     *  `json_value`: JSON-IETF value to check and set.
+     *  `model`: Python binding class to check the JSON reply against.
+          The binding classes are in the `oc_config_validate.models` package.
+
+
 ### Module setget
 
  *  `setget.SetGetJsonCheck`
@@ -92,6 +113,7 @@
           The binding classes are in the `oc_config_validate.models` package.
      *  `retries`: Optional. Number of retries if the assertion fails.
      *  `retry_delay`: Optional. Delay, in seconds, between retries. Default 10.
+     *  `set_replace`: Optional. True to use gNMI SetReplace instead of SetUpdate. Default False.
 
 
  *  `setget.SetGetJsonCheckCompare`
@@ -111,6 +133,7 @@
           The binding classes are in the `oc_config_validate.models` package.
      *  `retries`: Optional. Number of retries if the assertion fails.
      *  `retry_delay`: Optional. Delay, in seconds, between retries. Default 10.
+     *  `set_replace`: Optional. True to use gNMI SetReplace instead of SetUpdate. Default False.
 
 ### Module config_state
 
diff --git a/oc_config_validate/oc_config_validate/testbase.py b/oc_config_validate/oc_config_validate/testbase.py
@@ -249,6 +249,27 @@ def gNMISetDelete(self, xpath: str) -> bool:
             return False
         return True
 
+    def gNMISetReplace(self, xpath: str, value: Any) -> bool:
+        """Send a gNMI Set Replace message to the test's target
+
+        Args:
+            xpath: The gNMI path to update.
+            value: Value to set; can be numeric, string or JSON-IETF.
+
+        Returns:
+          False if the gNMI Set did not succeed.
+        """
+        if LOG_GNMI:
+            msg = ("gNMI Set Replace(%s) => %s", xpath, value)
+            self.log(*msg)
+            logging.info(*msg)
+        try:
+            self.test_target.gNMISetReplace(xpath, value)
+        except Exception as err:
+            self.log("Set(%s) <= Error: %s", xpath, err)
+            return False
+        return True
+
     def gNMISubsOnce(self, xpaths: List[str]) -> Optional[
             List[gnmi_pb2.Notification]]:
         """Send a gNMI Subscribe message using ONCE mode.
diff --git a/oc_config_validate/oc_config_validate/testcases/set.py b/oc_config_validate/oc_config_validate/testcases/set.py
@@ -43,6 +43,26 @@ def testSetDelete(self):
                         "gNMI Set did not succeed.")
 
 
+class SetReplace(testbase.TestCase):
+    """Sends gNMI Set of an xpath with a value.
+
+    All arguments are read from the Test YAML description.
+
+    Args:
+        xpath: gNMI path to write.
+        value: Value to set; can be numeric, string or JSON-IETF.
+    """
+    xpath = ""
+    value = None
+
+    def testSetReplace(self):
+        """"""
+        self.assertArgs(["xpath", "value"])
+        self.assertXpath(self.xpath)
+        self.assertTrue(self.gNMISetReplace(self.xpath, self.value),
+                        "gNMI Set did not succeed.")
+
+
 class JsonCheckSetUpdate(testbase.TestCase):
     """Sends gNMI Set with a schema-checked JSON-IETF value.
 
@@ -71,3 +91,33 @@ def testJsonCheckSetUpdate(self):
                              "JSON to Set does not match the model")
         self.assertTrue(self.gNMISetUpdate(self.xpath, self.json_value),
                         "gNMI Set did not succeed.")
+
+
+class JsonCheckSetReplace(testbase.TestCase):
+    """Sends gNMI Set with a schema-checked JSON-IETF value.
+
+    The intended JSON-IETF configuration is first checked for schema validity.
+
+    All arguments are read from the Test YAML description.
+
+    Args:
+        xpath: gNMI path to write.
+        json_value: JSON-IETF value to check and set.
+        model: Python binding class to check the JSON reply against.
+    """
+    xpath = ""
+    json_value = None
+    model = ""
+
+    def testJsonCheckSetReplace(self):
+        """"""
+        self.assertArgs(["xpath", "json_value", "model", ])
+        self.assertXpath(self.xpath)
+        self.assertModelXpath(self.model, self.xpath)
+        self.assertIsInstance(self.json_value, dict,
+                              "The value is not a valid JSON object")
+        model = schema.ocContainerFromPath(self.model, self.xpath)
+        self.assertJsonModel(json.dumps(self.json_value), model,
+                             "JSON to Set does not match the model")
+        self.assertTrue(self.gNMISetReplace(self.xpath, self.json_value),
+                        "gNMI Set did not succeed.")
diff --git a/oc_config_validate/oc_config_validate/testcases/setget.py b/oc_config_validate/oc_config_validate/testcases/setget.py
@@ -12,10 +12,12 @@ class TestCase(testbase.TestCase):
         xpath: gNMI path to write and read.
         json_value: JSON-IETF value to check, set and get.
         model: Python binding class to check the JSON reply against.
+        set_replace: True to use gNMI SetReplace instead of SetUpdate.
     """
     xpath = None
     json_value = None
     model = None
+    set_replace = False
 
     def setUp(self):
         # Check testcase arguments
@@ -27,8 +29,8 @@ def setUp(self):
         model = schema.ocContainerFromPath(self.model, self.xpath)
         self.assertJsonModel(json.dumps(self.json_value), model,
                              "JSON value to Set does not match the model")
-        # Set Update
-        self.assertTrue(self.gNMISetUpdate(self.xpath, self.json_value),
+        _gnmi_set = self.gNMISetReplace if self.set_replace else self.gNMISetUpdate
+        self.assertTrue(_gnmi_set(self.xpath, self.json_value),
                         "gNMI Set did not succeed.")
 
 
@@ -46,6 +48,7 @@ class SetGetJsonCheck(TestCase):
         xpath: gNMI path to write and read.
         json_value: JSON-IETF value to check, set and get.
         model: Python binding class to check the JSON reply against.
+        set_replace: True to use gNMI SetReplace instead of SetUpdate.
     """
 
     @testbase.retryAssertionError
@@ -72,6 +75,7 @@ class SetGetJsonCheckCompare(TestCase):
         xpath: gNMI path to write and read.
         json_value: JSON-IETF value to check set, get and compare.
         model: Python binding class to check the JSON reply against.
+        set_replace: True to use gNMI SetReplace instead of SetUpdate.
     """
 
     @testbase.retryAssertionError
@@ -83,3 +87,6 @@ def testSetGetJsonCheckCompare(self):
         got = json.loads(self.resp_val)
         cmp, diff = schema.intersectCmp(self.json_value, got)
         self.assertTrue(cmp, diff)
+        if self.set_replace:
+            cmp, diff = schema.intersectCmp(got, self.json_value)
+            self.assertTrue(cmp, diff)
