Add Etags to dps and dt, unit tests

azext_iot/digitaltwins/commands_twins.py

@@ -18,11 +18,17 @@ def query_twins(
 
 
 def create_twin(
-    cmd, name_or_hostname, twin_id, model_id, properties=None, resource_group_name=None
+    cmd,
+    name_or_hostname,
+    twin_id,
+    model_id,
+    replace=False,
+    properties=None,
+    resource_group_name=None
 ):
     twin_provider = TwinProvider(cmd=cmd, name=name_or_hostname, rg=resource_group_name)
     return twin_provider.create(
-        twin_id=twin_id, model_id=model_id, properties=properties
+        twin_id=twin_id, model_id=model_id, replace=replace, properties=properties
     )
 
 
@@ -31,14 +37,14 @@ def show_twin(cmd, name_or_hostname, twin_id, resource_group_name=None):
     return twin_provider.get(twin_id)
 
 
-def update_twin(cmd, name_or_hostname, twin_id, json_patch, resource_group_name=None):
+def update_twin(cmd, name_or_hostname, twin_id, json_patch, resource_group_name=None, etag=None):
     twin_provider = TwinProvider(cmd=cmd, name=name_or_hostname, rg=resource_group_name)
-    return twin_provider.update(twin_id=twin_id, json_patch=json_patch)
+    return twin_provider.update(twin_id=twin_id, json_patch=json_patch, etag=etag)
 
 
-def delete_twin(cmd, name_or_hostname, twin_id, resource_group_name=None):
+def delete_twin(cmd, name_or_hostname, twin_id, resource_group_name=None, etag=None):
     twin_provider = TwinProvider(cmd=cmd, name=name_or_hostname, rg=resource_group_name)
-    return twin_provider.delete(twin_id)
+    return twin_provider.delete(twin_id, etag=etag)
 
 
 def create_relationship(
@@ -48,6 +54,7 @@ def create_relationship(
     target_twin_id,
     relationship_id,
     relationship,
+    replace=False,
     properties=None,
     resource_group_name=None,
 ):
@@ -57,6 +64,7 @@ def create_relationship(
         target_twin_id=target_twin_id,
         relationship_id=relationship_id,
         relationship=relationship,
+        replace=replace,
         properties=properties,
     )
 
@@ -77,10 +85,11 @@ def update_relationship(
     relationship_id,
     json_patch,
     resource_group_name=None,
+    etag=None
 ):
     twin_provider = TwinProvider(cmd=cmd, name=name_or_hostname, rg=resource_group_name)
     return twin_provider.update_relationship(
-        twin_id=twin_id, relationship_id=relationship_id, json_patch=json_patch,
+        twin_id=twin_id, relationship_id=relationship_id, json_patch=json_patch, etag=etag
     )
 
 
@@ -101,11 +110,11 @@ def list_relationships(
 
 
 def delete_relationship(
-    cmd, name_or_hostname, twin_id, relationship_id, resource_group_name=None,
+    cmd, name_or_hostname, twin_id, relationship_id, resource_group_name=None, etag=None
 ):
     twin_provider = TwinProvider(cmd=cmd, name=name_or_hostname, rg=resource_group_name)
     return twin_provider.delete_relationship(
-        twin_id=twin_id, relationship_id=relationship_id
+        twin_id=twin_id, relationship_id=relationship_id, etag=etag
     )
 
 
@@ -132,10 +141,9 @@ def show_component(
 
 
 def update_component(
-    cmd, name_or_hostname, twin_id, component_path, json_patch, resource_group_name=None
+    cmd, name_or_hostname, twin_id, component_path, json_patch, resource_group_name=None, etag=None
 ):
     twin_provider = TwinProvider(cmd=cmd, name=name_or_hostname, rg=resource_group_name)
-    twin_provider.update_component(
-        twin_id=twin_id, component_path=component_path, json_patch=json_patch
+    return twin_provider.update_component(
+        twin_id=twin_id, component_path=component_path, json_patch=json_patch, etag=etag
     )
-    return

azext_iot/digitaltwins/params.py

@@ -278,11 +278,19 @@ def load_digitaltwins_arguments(self, _):
             "Updates to property values and $model elements may happen in the same request. "
             "Operations are limited to add, replace and remove. Provide file path or inline JSON.",
         )
+        context.argument(
+            "etag", options_list=["--etag", "-e"], help="Entity tag value."
+        )
         context.argument(
             "component_path",
             options_list=["--component"],
             help="The path to the DTDL component.",
         )
+        context.argument(
+            "replace",
+            options_list=["--replace"],
+            help="Indicates the operation should replace an existing twin if it exists."
+        )
 
     with self.argument_context("dt twin create") as context:
         context.argument(

azext_iot/digitaltwins/providers/twin.py

@@ -17,6 +17,14 @@
 logger = get_logger(__name__)
 
 
+class TwinOptions():
+    def __init__(self, if_match=None, if_none_match=None):
+        self.if_match = if_match
+        self.if_none_match = if_none_match
+        self.traceparent = None
+        self.tracestate = None
+
+
 class TwinProvider(DigitalTwinsProvider):
     def __init__(self, cmd, name, rg=None):
         super(TwinProvider, self).__init__(
@@ -31,13 +39,16 @@ def __init__(self, cmd, name, rg=None):
     def invoke_query(self, query, show_cost):
         from azext_iot.digitaltwins.providers.generic import accumulate_result
 
-        accumulated_result, cost = accumulate_result(
-            self.query_sdk.query_twins,
-            values_name="value",
-            token_name="continuationToken",
-            token_arg_name="continuation_token",
-            query=query,
-        )
+        try:
+            accumulated_result, cost = accumulate_result(
+                self.query_sdk.query_twins,
+                values_name="value",
+                token_name="continuationToken",
+                token_arg_name="continuation_token",
+                query=query,
+            )
+        except ErrorResponseException as e:
+            raise CLIError(unpack_msrest_error(e))
 
         query_result = {}
         query_result["result"] = accumulated_result
@@ -46,11 +57,10 @@ def invoke_query(self, query, show_cost):
 
         return query_result
 
-    def create(self, twin_id, model_id, properties=None):
-        target_model = self.model_provider.get(id=model_id)
+    def create(self, twin_id, model_id, replace=False, properties=None):
         twin_request = {
             "$dtId": twin_id,
-            "$metadata": {"$model": target_model["id"]},
+            "$metadata": {"$model": model_id},
         }
 
         if properties:
@@ -62,7 +72,8 @@ def create(self, twin_id, model_id, properties=None):
         logger.info("Twin payload %s", json.dumps(twin_request))
 
         try:
-            return self.twins_sdk.add(id=twin_id, twin=twin_request, if_none_match="*")
+            options = TwinOptions(if_none_match=(None if replace else "*"))
+            return self.twins_sdk.add(id=twin_id, twin=twin_request, digital_twins_add_options=options)
         except ErrorResponseException as e:
             raise CLIError(unpack_msrest_error(e))
 
@@ -72,7 +83,7 @@ def get(self, twin_id):
         except ErrorResponseException as e:
             raise CLIError(unpack_msrest_error(e))
 
-    def update(self, twin_id, json_patch):
+    def update(self, twin_id, json_patch, etag=None):
         json_patch = process_json_arg(content=json_patch, argument_name="json-patch")
 
         json_patch_collection = []
@@ -84,17 +95,19 @@ def update(self, twin_id, json_patch):
         logger.info("Patch payload %s", json.dumps(json_patch_collection))
 
         try:
+            options = TwinOptions(if_match=(etag if etag else "*"))
             self.twins_sdk.update(
-                id=twin_id, patch_document=json_patch_collection, if_match="*", raw=True
+                id=twin_id, patch_document=json_patch_collection, digital_twins_update_options=options, raw=True
             )
             return self.get(twin_id=twin_id)
         except ErrorResponseException as e:
             raise CLIError(unpack_msrest_error(e))
 
-    def delete(self, twin_id):
+    def delete(self, twin_id, etag=None):
         # Not a json response
         try:
-            self.twins_sdk.delete(id=twin_id, if_match="*", raw=True)
+            options = TwinOptions(if_match=(etag if etag else "*"))
+            self.twins_sdk.delete(id=twin_id, digital_twins_delete_options=options, raw=True)
         except ErrorResponseException as e:
             raise CLIError(unpack_msrest_error(e))
 
@@ -104,6 +117,7 @@ def add_relationship(
         target_twin_id,
         relationship_id,
         relationship,
+        replace=False,
         properties=None,
     ):
         relationship_request = {
@@ -118,18 +132,25 @@ def add_relationship(
             relationship_request.update(properties)
 
         logger.info("Relationship payload %s", json.dumps(relationship_request))
-        return self.twins_sdk.add_relationship(
-            id=twin_id,
-            relationship_id=relationship_id,
-            relationship=relationship_request,
-            if_none_match="*",
-            raw=True,
-        ).response.json()
+        try:
+            options = TwinOptions(if_none_match=(None if replace else "*"))
+            return self.twins_sdk.add_relationship(
+                id=twin_id,
+                relationship_id=relationship_id,
+                relationship=relationship_request,
+                digital_twins_add_relationship_options=options,
+                raw=True,
+            ).response.json()
+        except ErrorResponseException as e:
+            raise CLIError(unpack_msrest_error(e))
 
     def get_relationship(self, twin_id, relationship_id):
-        return self.twins_sdk.get_relationship_by_id(
-            id=twin_id, relationship_id=relationship_id, raw=True
-        ).response.json()
+        try:
+            return self.twins_sdk.get_relationship_by_id(
+                id=twin_id, relationship_id=relationship_id, raw=True
+            ).response.json()
+        except ErrorResponseException as e:
+            raise CLIError(unpack_msrest_error(e))
 
     def list_relationships(
         self, twin_id, incoming_relationships=False, relationship=None
@@ -147,6 +168,8 @@ def list_relationships(
                 incoming_result.extend(incoming_pager.advance_page())
         except StopIteration:
             pass
+        except ErrorResponseException as e:
+            raise CLIError(unpack_msrest_error(e))
 
         if relationship:
             incoming_result = [
@@ -157,7 +180,7 @@ def list_relationships(
 
         return incoming_result
 
-    def update_relationship(self, twin_id, relationship_id, json_patch):
+    def update_relationship(self, twin_id, relationship_id, json_patch, etag=None):
         json_patch = process_json_arg(content=json_patch, argument_name="json-patch")
 
         json_patch_collection = []
@@ -169,32 +192,37 @@ def update_relationship(self, twin_id, relationship_id, json_patch):
         logger.info("Patch payload %s", json.dumps(json_patch_collection))
 
         try:
+            options = TwinOptions(if_match=(etag if etag else "*"))
             self.twins_sdk.update_relationship(
                 id=twin_id,
                 relationship_id=relationship_id,
                 patch_document=json_patch_collection,
-                if_match="*",
+                digital_twins_update_relationship_options=options,
             )
             return self.get_relationship(
                 twin_id=twin_id, relationship_id=relationship_id
             )
         except ErrorResponseException as e:
             raise CLIError(unpack_msrest_error(e))
 
-    def delete_relationship(self, twin_id, relationship_id):
+    def delete_relationship(self, twin_id, relationship_id, etag=None):
         try:
+            options = TwinOptions(if_match=(etag if etag else "*"))
             self.twins_sdk.delete_relationship(
-                id=twin_id, relationship_id=relationship_id, if_match="*"
+                id=twin_id, relationship_id=relationship_id, digital_twins_delete_relationship_options=options
             )
         except ErrorResponseException as e:
             raise CLIError(unpack_msrest_error(e))
 
     def get_component(self, twin_id, component_path):
-        return self.twins_sdk.get_component(
-            id=twin_id, component_path=component_path, raw=True
-        ).response.json()
+        try:
+            return self.twins_sdk.get_component(
+                id=twin_id, component_path=component_path, raw=True
+            ).response.json()
+        except ErrorResponseException as e:
+            raise CLIError(unpack_msrest_error(e))
 
-    def update_component(self, twin_id, component_path, json_patch):
+    def update_component(self, twin_id, component_path, json_patch, etag=None):
         json_patch = process_json_arg(content=json_patch, argument_name="json-patch")
 
         json_patch_collection = []
@@ -206,13 +234,14 @@ def update_component(self, twin_id, component_path, json_patch):
         logger.info("Patch payload %s", json.dumps(json_patch_collection))
 
         try:
-            # TODO: API does not return response
+            options = TwinOptions(if_match=(etag if etag else "*"))
             self.twins_sdk.update_component(
                 id=twin_id,
                 component_path=component_path,
                 patch_document=json_patch_collection,
-                if_match="*",
+                digital_twins_update_component_options=options,
             )
+            return self.get_component(twin_id=twin_id, component_path=component_path)
         except ErrorResponseException as e:
             raise CLIError(unpack_msrest_error(e))
 
@@ -236,18 +265,21 @@ def send_telemetry(self, twin_id, telemetry=None, dt_id=None, component_path=Non
         if not dt_id:
             dt_id = str(uuid4())
 
-        if component_path:
-            self.twins_sdk.send_component_telemetry(
+        try:
+            if component_path:
+                self.twins_sdk.send_component_telemetry(
+                    id=twin_id,
+                    message_id=dt_id,
+                    dt_timestamp=dt_timestamp,
+                    component_path=component_path,
+                    telemetry=telemetry_request,
+                )
+
+            self.twins_sdk.send_telemetry(
                 id=twin_id,
                 message_id=dt_id,
                 dt_timestamp=dt_timestamp,
-                component_path=component_path,
                 telemetry=telemetry_request,
             )
-
-        self.twins_sdk.send_telemetry(
-            id=twin_id,
-            message_id=dt_id,
-            dt_timestamp=dt_timestamp,
-            telemetry=telemetry_request,
-        )
+        except ErrorResponseException as e:
+            raise CLIError(unpack_msrest_error(e))