Add new bdd assertions in sdk tests (#1430)

api-clients-generation-pipeline[bot] · nkzou · ci.datadog-api-spec · web-flow · commit d0f29e820c29 · 2023-05-04T18:49:39.000Z
* add object array key value step definition

* add array contains value assertion

* specify assert for arrays

* Regenerate client from commit 05a49f9c of spec repo

---------

Co-authored-by: Kevin Zou &lt;kevin.zou@datadoghq.com&gt;
Co-authored-by: api-clients-generation-pipeline[bot] &lt;54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com&gt;
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-03 17:34:25.219045",
-            "spec_repo_commit": "b8cbfe94"
+            "regenerated": "2023-05-04 18:36:58.546008",
+            "spec_repo_commit": "05a49f9c"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-03 17:34:25.231427",
-            "spec_repo_commit": "b8cbfe94"
+            "regenerated": "2023-05-04 18:36:58.558261",
+            "spec_repo_commit": "05a49f9c"
         }
     }
 }
diff --git a/.generator/conftest.py b/.generator/conftest.py
@@ -528,3 +528,12 @@ def expect_equal_response_items(context, fixture_length):
 @then(parsers.parse('the response "{response_path}" is false'))
 def expect_false(context, response_path):
     """Check that a response attribute is false."""
+
+
+@then(parsers.parse('the response "{response_path}" has item with field "{key_path}" with value {value}'))
+def expect_array_contains_object(context, response_path, key_path, value):
+    """Check that a response attribute contains an object with the specified key and value."""
+
+@then(parsers.parse('the response "{response_path}" array contains value {value}'))
+def expect_array_contains_object(context, response_path, value):
+    """Check that a response array contains the specified value."""
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -643,3 +643,24 @@ def expect_equal_response_items(context, fixture_length):
 def expect_false(context, response_path):
     response_value = glom(context["api_request"]["response"][0], response_path)
     assert not response_value
+
+
+@then(parsers.parse('the response "{response_path}" has item with field "{key_path}" with value {value}'))
+def expect_array_contains_object(context, response_path, key_path, value):
+    response_value = glom(context["api_request"]["response"][0], response_path)
+    test_value = json.loads(Template(value).render(**context))
+    for response_item in response_value:
+        response_item_value = glom(response_item, key_path)
+        if response_item_value == test_value:
+            return
+    raise AssertionError(f'could not find key value pair in object array: "{key_path}": "{test_value}"')
+
+
+@then(parsers.parse('the response "{response_path}" array contains value {value}'))
+def expect_array_contains_object(context, response_path, value):
+    response_value = glom(context["api_request"]["response"][0], response_path)
+    test_value = json.loads(Template(value).render(**context))
+    for response_item in response_value:
+        if response_item == test_value:
+            return
+    raise AssertionError(f"could not find value in array: {test_value}")
diff --git a/tests/v1/features/dashboards.feature b/tests/v1/features/dashboards.feature
@@ -554,7 +554,7 @@ Feature: Dashboards
     When the request is sent
     Then the response status is 200 OK
     And the response "title" is equal to "{{ unique }}"
-    And the response "tags[0]" is equal to "team:foobar"
+    And the response "tags" array contains value "team:foobar"
 
   @team:DataDog/dashboards-backend
   Scenario: Create a new dashboard with template variable defaults and default returns "Bad Request" response
diff --git a/tests/v1/features/notebooks.feature b/tests/v1/features/notebooks.feature
@@ -84,6 +84,7 @@ Feature: Notebooks
     Given new "ListNotebooks" request
     When the request is sent
     Then the response status is 200 OK
+    And the response "data" has item with field "attributes.status" with value "published"
 
   @generated @skip @team:DataDog/notebooks
   Scenario: Update a notebook returns "Bad Request" response
diff --git a/tests/v1/features/synthetics.feature b/tests/v1/features/synthetics.feature
@@ -569,6 +569,8 @@ Feature: Synthetics
     And body with value {"tests": [{"public_id": "{{ synthetics_api_test.public_id }}"}]}
     When the request is sent
     Then the response status is 200 OK
+    And the response "triggered_check_ids" array contains value "{{ synthetics_api_test.public_id }}"
+    And the response "results" has item with field "public_id" with value "{{ synthetics_api_test.public_id }}"
 
   @generated @skip @team:DataDog/synthetics-app
   Scenario: Trigger tests from CI/CD pipelines returns "JSON format is wrong" response
diff --git a/tests/v2/cassettes/test_scenarios/test_list_all_the_rum_applications_returns_ok_response.frozen b/tests/v2/cassettes/test_scenarios/test_list_all_the_rum_applications_returns_ok_response.frozen
@@ -1 +1 @@
-2022-12-05T18:19:32.662Z
+2023-04-26T15:06:53.728Z
diff --git a/tests/v2/cassettes/test_scenarios/test_list_all_the_rum_applications_returns_ok_response.yaml b/tests/v2/cassettes/test_scenarios/test_list_all_the_rum_applications_returns_ok_response.yaml
diff --git a/tests/v2/features/monitors.feature b/tests/v2/features/monitors.feature
@@ -108,4 +108,8 @@ Feature: Monitors
     And new "ListMonitorConfigPolicies" request
     When the request is sent
     Then the response status is 200 OK
-    And the response "data[0].type" is equal to "monitor-config-policy"
+    And the response "data" has item with field "type" with value "monitor-config-policy"
+    And the response "data" has item with field "id" with value "{{ monitor_configuration_policy.data.id }}"
+    And the response "data" has item with field "attributes.policy_type" with value "tag"
+    And the response "data" has item with field "attributes.policy.tag_key" with value "{{ unique_lower_alnum }}"
+    And the response "data" has item with field "attributes.policy.valid_tag_values" with value ["prod", "staging"]
diff --git a/tests/v2/features/roles.feature b/tests/v2/features/roles.feature
@@ -199,6 +199,9 @@ Feature: Roles
     Given new "ListPermissions" request
     When the request is sent
     Then the response status is 200 OK
+    And the response "data" has item with field "attributes.restricted" with value true
+    And the response "data" has item with field "attributes.restricted" with value false
+    And the response "data" has item with field "attributes.name" with value "admin"
 
   @team:DataDog/aaa-core-access
   Scenario: List roles returns "OK" response
diff --git a/tests/v2/features/rum.feature b/tests/v2/features/rum.feature
@@ -101,9 +101,11 @@ Feature: RUM
 
   @team:DataDog/rum-backend
   Scenario: List all the RUM applications returns "OK" response
-    Given new "GetRUMApplications" request
+    Given there is a valid "rum_application" in the system
+    And new "GetRUMApplications" request
     When the request is sent
     Then the response status is 200 OK
+    And the response "data" has item with field "attributes.application_id" with value "{{ rum_application.data.id }}"
 
   @generated @skip @team:DataDog/rum-backend
   Scenario: Search RUM events returns "Bad Request" response
diff --git a/tests/v2/features/security_monitoring.feature b/tests/v2/features/security_monitoring.feature
@@ -321,6 +321,8 @@ Feature: Security Monitoring
     Given new "ListSecurityFilters" request
     When the request is sent
     Then the response status is 200 OK
+    And the response "data" has item with field "attributes.filtered_data_type" with value "logs"
+    And the response "data" has item with field "attributes.is_builtin" with value true
 
   @generated @skip @team:DataDog/cloud-security-posture-management
   Scenario: List findings returns "Bad Request" response
diff --git a/tests/v2/features/sensitive_data_scanner.feature b/tests/v2/features/sensitive_data_scanner.feature
@@ -96,6 +96,7 @@ Feature: Sensitive Data Scanner
     And new "ListScanningGroups" request
     When the request is sent
     Then the response status is 200 OK
+    And the response "included" has item with field "id" with value "{{ group.data.id }}"
 
   @generated @skip @team:DataDog/logs-app @team:DataDog/logs-core
   Scenario: List standard patterns returns "Bad Request" response
diff --git a/tests/v2/features/service_accounts.feature b/tests/v2/features/service_accounts.feature
@@ -140,6 +140,7 @@ Feature: Service Accounts
     And request contains "service_account_id" parameter from "service_account_user.data.id"
     When the request is sent
     Then the response status is 200 OK
+    And the response "data" has length 0
 
   @team:DataDog/team-aaa-authn @team:DataDog/team-aaa-identity
   Scenario: Get one app key owned by this service account returns "OK" response
diff --git a/tests/v2/features/teams.feature b/tests/v2/features/teams.feature
@@ -96,6 +96,7 @@ Feature: Teams
     And there is a valid "dd_team" in the system
     When the request is sent
     Then the response status is 200 OK
+    And the response "data" has item with field "id" with value "{{ dd_team.data.id }}"
 
   @team:DataDog/core-app
   Scenario: Get links for a team returns "API error response." response
@@ -214,6 +215,8 @@ Feature: Teams
     And body with value {"data": {"attributes": {"label": "New Label", "url": "https://example.com"}, "type": "team_links"}}
     When the request is sent
     Then the response status is 200 OK
+    And the response "data.id" is equal to "{{ team_link.data.id }}"
+    And the response "data.attributes.team_id" is equal to "{{ dd_team.data.id }}"
 
   @generated @skip @team:DataDog/core-app
   Scenario: Update a team returns "API error response." response
@@ -231,6 +234,7 @@ Feature: Teams
     And body with value {"data": {"attributes": {"handle": "{{dd_team.data.attributes.handle}}", "name": "{{dd_team.data.attributes.name}} updated"}, "type": "team"}}
     When the request is sent
     Then the response status is 200 OK
+    And the response "data.id" is equal to "{{ dd_team.data.id }}"
 
   @generated @skip @team:DataDog/core-app
   Scenario: Update a user's membership attributes on a team returns "API error response." response

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.4",`
`7`		`- "regenerated": "2023-05-03 17:34:25.219045",`
`8`		`- "spec_repo_commit": "b8cbfe94"`
	`7`	`+ "regenerated": "2023-05-04 18:36:58.546008",`
	`8`	`+ "spec_repo_commit": "05a49f9c"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.4",`
`12`		`- "regenerated": "2023-05-03 17:34:25.231427",`
`13`		`- "spec_repo_commit": "b8cbfe94"`
	`12`	`+ "regenerated": "2023-05-04 18:36:58.558261",`
	`13`	`+ "spec_repo_commit": "05a49f9c"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-2022-12-05T18:19:32.662Z`
	`1`	`+2023-04-26T15:06:53.728Z`