iter validation

Author: Rangababu-R

openapiart/common.py

@@ -662,8 +662,7 @@ def append(self, item):
         """Append an item to the end of OpenApiIter
         TBD: type check, raise error on mismatch
         """
-        if isinstance(item, OpenApiObject) is False:
-            raise Exception("Item is not an instance of OpenApiObject")
+        self._instanceOf(item)
         self._add(item)
         return self
 
@@ -672,8 +671,7 @@ def clear(self):
         self._index = -1
 
     def set(self, index, item):
-        if isinstance(item, OpenApiObject) is False:
-            raise Exception("Item is not an instance of OpenApiObject")
+        self._instanceOf(item)
         self._items[index] = item
         return self
 
@@ -699,3 +697,6 @@ def __str__(self):
 
     def __eq__(self, other):
         return self.__str__() == other.__str__()
+    
+    def _instanceOf(self, item):
+        raise NotImplementedError("validating an OpenApiIter object is not supported")

openapiart/generator.py

@@ -583,6 +583,10 @@ def _write_openapilist_special_methods(self, contained_class_name, schema_object
         self._write(1, "def next(self):")
         self._write(2, "# type: () -> %s" % contained_class_name)
         self._write(2, "return self._next()")
+        self._write()
+        self._write(1, "def _instanceOf(self, item):")
+        self._write(2, "if not isinstance(item, %s):" % (contained_class_name))
+        self._write(3, "raise Exception(\"Item is not an instance of %s\")" % (contained_class_name))
 
     def _write_factory_method(self, contained_class_name, method_name, ref, openapi_list=False, choice_method=False):
         yobject = self._get_object_from_ref(ref)

openapiart/tests/test_py_go_diff.py

@@ -7,17 +7,18 @@ def test_iter_set_method(default_config):
     default_config.j.add()
     default_config.j.set(0, module.JObject())
     assert len(default_config.j) == 1
-    # below 2 statements shall raise exception need to modify generator
-    # if exception is raised, it would conflict with below mentioned
-    # comments about flow.packet
-    default_config.j.append(module.FObject())
-    default_config.j.set(1, module.FObject())
+    try:
+        default_config.j.append(module.FObject())
+        pytest.fail("appending an invalid object is not throwing exception")
+    except Exception:
+        pass
+    try:
+        default_config.j.set(0, module.FObject())
+        pytest.fail("setting an invalid object is not throwing exception")
+    except Exception:
+        pass
 
-    default_config.j.set(1, module.JObject())
-    # below statement is a replica of snappi flow.packet Iter
-    # indexing will return protocol header obj instead of FlowHeader
-    # which is actually set with set or append or add methods
-    assert isinstance(default_config.j[1], module.EObject)
+    assert isinstance(default_config.j[0], module.EObject)
 
 
 def test_validation_errors():