Use request data for undo operations in tests when response empty (#1745)

* Regenerate client from commit 89f9f50d of spec repo

* use request body when origin set to request

* change kwargs get method

* Remove conditional

* remove conditional

* Regenerate client from commit f57ca8ef of spec repo

---------

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: HantingZhang2 <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-11-20 19:20:13.651946",
-            "spec_repo_commit": "55cf29a4"
+            "regenerated": "2023-11-21 11:52:08.777997",
+            "spec_repo_commit": "f57ca8ef"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-11-20 19:20:13.666926",
-            "spec_repo_commit": "55cf29a4"
+            "regenerated": "2023-11-21 11:52:08.792413",
+            "spec_repo_commit": "f57ca8ef"
         }
     }
 }

examples/v1/aws-integration/CreateAWSAccount.py

@@ -7,10 +7,9 @@
 from datadog_api_client.v1.model.aws_account import AWSAccount
 
 body = AWSAccount(
-    account_id="123456789012",
+    account_id="163662907100",
     account_specific_namespace_rules=dict(
         auto_scaling=False,
-        opswork=False,
     ),
     cspm_resource_collection_enabled=True,
     excluded_regions=[

tests/conftest.py

@@ -484,10 +484,11 @@ def build_param(p):
                 escape_reserved_keyword(snake_case(p["name"])): build_param(p) for p in operation.get("parameters", [])
             }
             result = operation_method(**kwargs)
+            request_body = kwargs.get("body", "")
 
             # register undo method
             def undo_operation():
-                return undo(api, version, operation_name, result, client=client)
+                return undo(api, version, operation_name, result, request_body, client=client)
 
             if tracer:
                 undo_operation = tracer.wrap(name="undo", resource=operation["step"])(undo_operation)
@@ -512,11 +513,22 @@ def undo_operation():
             given(settings["step"])(build_given(version, settings))
 
 
+def extract_parameters(kwargs, data, parameter):
+    if "source" in parameter:
+        kwargs[parameter["name"]] = glom(data, parameter["source"])
+    elif "template" in parameter:
+        variables = meta.find_undeclared_variables(Environment().parse(parameter["template"]))
+        ctx = {}
+        for var in variables:
+            ctx[var] = glom(data, var)
+        kwargs[parameter["name"]] = json.loads(Template(parameter["template"]).render(**ctx))
+
+
 @pytest.fixture
 def undo(package_name, undo_operations, client):
     """Clean after operation."""
 
-    def cleanup(api, version, operation_id, response, client=client):
+    def cleanup(api, version, operation_id, response, request, client=client):
         operation = undo_operations.get(version, {}).get(operation_id)
         if operation_id is None:
             raise NotImplementedError((version, operation_id))
@@ -539,16 +551,12 @@ def cleanup(api, version, operation_id, response, client=client):
         operation_name = snake_case(operation["operationId"])
         method = getattr(api, operation_name)
         kwargs = {}
-        for parameter in operation.get("parameters", []):
-            if "source" in parameter:
-                kwargs[parameter["name"]] = glom(response, parameter["source"])
-            elif "template" in parameter:
-                variables = meta.find_undeclared_variables(Environment().parse(parameter["template"]))
-                ctx = {}
-                for var in variables:
-                    ctx[var] = glom(response, var)
-                kwargs[parameter["name"]] = json.loads(Template(parameter["template"]).render(**ctx))
-
+        parameters = operation.get("parameters", [])
+        for parameter in parameters:
+            if "origin" not in parameter or parameter["origin"] == "response":
+                extract_parameters(kwargs, response, parameter)
+            elif parameter["origin"] == "request":
+                extract_parameters(kwargs, request, parameter)
         if operation_name in client.configuration.unstable_operations:
             client.configuration.unstable_operations[operation_name] = True
 
@@ -587,9 +595,10 @@ def execute_request(undo, context, client, api_version, request):
     api = api_request["api"]
     operation_id = api_request["request"].__name__
     response = api_request["response"][0]
+    request_body = api_request.get("kwargs", {}).get("body", "")
 
     def undo_operation():
-        return undo(api, api_version, operation_id, response)
+        return undo(api, api_version, operation_id, response, request_body)
 
     if tracer:
         undo_operation = tracer.wrap(name="undo", resource="execute request")(undo_operation)

tests/v1/cassettes/test_scenarios/test_create_an_aws_integration_returns_ok_response.frozen

@@ -0,0 +1 @@
+2023-11-13T14:17:01.291Z

tests/v1/cassettes/test_scenarios/test_create_an_aws_integration_returns_ok_response.yaml

@@ -0,0 +1,42 @@
+interactions:
+- request:
+    body: '{"account_id":"169988502100","account_specific_namespace_rules":{"auto_scaling":false},"cspm_resource_collection_enabled":true,"excluded_regions":["us-east-1","us-west-2"],"filter_tags":["$KEY:$VALUE"],"host_tags":["$KEY:$VALUE"],"metrics_collection_enabled":false,"resource_collection_enabled":true,"role_name":"DatadogAWSIntegrationRole"}'
+    headers:
+      accept:
+      - application/json
+      content-type:
+      - application/json
+    method: POST
+    uri: https://api.datadoghq.com/api/v1/integration/aws
+  response:
+    body:
+      string: '{"external_id":"9668e281c0ef4cc8be01710ef7a0ae4c"}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+- request:
+    body: '{"account_id":"169988502100","role_name":"DatadogAWSIntegrationRole"}'
+    headers:
+      accept:
+      - application/json
+      content-type:
+      - application/json
+    method: DELETE
+    uri: https://api.datadoghq.com/api/v1/integration/aws
+  response:
+    body:
+      string: '{}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1

tests/v1/features/aws_integration.feature

@@ -23,10 +23,10 @@ Feature: AWS Integration
     When the request is sent
     Then the response status is 409 Conflict Error
 
-  @generated @skip @team:DataDog/cloud-integrations
+  @team:DataDog/cloud-integrations
   Scenario: Create an AWS integration returns "OK" response
     Given new "CreateAWSAccount" request
-    And body with value {"account_id": "123456789012", "account_specific_namespace_rules": {"auto_scaling": false, "opswork": false}, "cspm_resource_collection_enabled": true, "excluded_regions": ["us-east-1", "us-west-2"], "filter_tags": ["$KEY:$VALUE"], "host_tags": ["$KEY:$VALUE"], "metrics_collection_enabled": false, "resource_collection_enabled": true, "role_name": "DatadogAWSIntegrationRole"}
+    And body with value {"account_id": "{{ timestamp("now") }}00", "account_specific_namespace_rules": {"auto_scaling": false}, "cspm_resource_collection_enabled": true, "excluded_regions": ["us-east-1", "us-west-2"], "filter_tags": ["$KEY:$VALUE"], "host_tags": ["$KEY:$VALUE"], "metrics_collection_enabled": false, "resource_collection_enabled": true, "role_name": "DatadogAWSIntegrationRole"}
     When the request is sent
     Then the response status is 200 OK
 

tests/v1/features/undo.json

@@ -356,7 +356,13 @@
     "tag": "AWS Integration",
     "undo": {
       "operationId": "DeleteAWSAccount",
-      "parameters": [],
+      "parameters": [
+        {
+          "name": "body",
+          "origin": "request",
+          "template": "{\"account_id\": \"{{account_id}}\", \"role_name\": \"{{role_name}}\"}"
+        }
+      ],
       "type": "unsafe"
     }
   },