Add exitIfSucceed to multistep API tests (#2307)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-05 20:22:41.090262",
-            "spec_repo_commit": "970515f9"
+            "regenerated": "2024-12-09 11:21:40.525950",
+            "spec_repo_commit": "21da0df3"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-05 20:22:41.108521",
-            "spec_repo_commit": "970515f9"
+            "regenerated": "2024-12-09 11:21:40.543995",
+            "spec_repo_commit": "21da0df3"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -13741,6 +13741,9 @@ components:
           items:
             $ref: '#/components/schemas/SyntheticsAssertion'
           type: array
+        exitIfSucceed:
+          description: Determines whether or not to exit the test if the step succeeds.
+          type: boolean
         extractedValues:
           description: Array of values to parse and save as variables from the response.
           items:

examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.py

@@ -50,6 +50,7 @@
                         target=200,
                     ),
                 ],
+                exit_if_succeed=True,
                 extracted_values=[
                     SyntheticsParsingOptions(
                         field="server",

examples/v1/synthetics/CreateSyntheticsBrowserTest.py

@@ -75,6 +75,8 @@
     steps=[
         SyntheticsStep(
             allow_failure=False,
+            always_execute=True,
+            exit_if_succeed=True,
             is_critical=True,
             name="Refresh page",
             params=dict(),

src/datadog_api_client/v1/model/synthetics_api_step.py

@@ -21,6 +21,9 @@ def __init__(self, **kwargs):
         :param assertions: Array of assertions used for the test.
         :type assertions: [SyntheticsAssertion]
 
+        :param exit_if_succeed: Determines whether or not to exit the test if the step succeeds.
+        :type exit_if_succeed: bool, optional
+
         :param extracted_values: Array of values to parse and save as variables from the response.
         :type extracted_values: [SyntheticsParsingOptions], optional
 

src/datadog_api_client/v1/model/synthetics_api_test_step.py

@@ -32,6 +32,7 @@ def openapi_types(_):
         return {
             "allow_failure": (bool,),
             "assertions": ([SyntheticsAssertion],),
+            "exit_if_succeed": (bool,),
             "extracted_values": ([SyntheticsParsingOptions],),
             "is_critical": (bool,),
             "name": (str,),
@@ -43,6 +44,7 @@ def openapi_types(_):
     attribute_map = {
         "allow_failure": "allowFailure",
         "assertions": "assertions",
+        "exit_if_succeed": "exitIfSucceed",
         "extracted_values": "extractedValues",
         "is_critical": "isCritical",
         "name": "name",
@@ -57,6 +59,7 @@ def __init__(
         request: SyntheticsTestRequest,
         subtype: SyntheticsAPITestStepSubtype,
         allow_failure: Union[bool, UnsetType] = unset,
+        exit_if_succeed: Union[bool, UnsetType] = unset,
         extracted_values: Union[List[SyntheticsParsingOptions], UnsetType] = unset,
         is_critical: Union[bool, UnsetType] = unset,
         retry: Union[SyntheticsTestOptionsRetry, UnsetType] = unset,
@@ -71,6 +74,9 @@ def __init__(
         :param assertions: Array of assertions used for the test.
         :type assertions: [SyntheticsAssertion]
 
+        :param exit_if_succeed: Determines whether or not to exit the test if the step succeeds.
+        :type exit_if_succeed: bool, optional
+
         :param extracted_values: Array of values to parse and save as variables from the response.
         :type extracted_values: [SyntheticsParsingOptions], optional
 
@@ -92,6 +98,8 @@ def __init__(
         """
         if allow_failure is not unset:
             kwargs["allow_failure"] = allow_failure
+        if exit_if_succeed is not unset:
+            kwargs["exit_if_succeed"] = exit_if_succeed
         if extracted_values is not unset:
             kwargs["extracted_values"] = extracted_values
         if is_critical is not unset:

tests/v1/cassettes/test_scenarios/test_create_a_browser_test_returns_ok_returns_saved_rumsettings_response.frozen

@@ -1 +1 @@
-2024-01-26T10:20:21.858Z
+2024-12-09T11:17:43.729Z

tests/v1/cassettes/test_scenarios/test_create_a_browser_test_returns_ok_returns_saved_rumsettings_response.yaml

@@ -1,7 +1,7 @@
 interactions:
 - request:
     body: '{"config":{"assertions":[],"configVariables":[{"example":"content-type","name":"PROPERTY","pattern":"content-type","type":"text"}],"request":{"certificateDomains":["https://datadoghq.com"],"method":"GET","url":"https://datadoghq.com"},"setCookie":"name:test"},"locations":["aws:us-east-2"],"message":"Test
-      message","name":"Test-Create_a_browser_test_returns_OK_Returns_saved_rumSettings_response-1706264421","options":{"accept_self_signed":false,"allow_insecure":true,"ci":{"executionRule":"skipped"},"device_ids":["tablet"],"disableCors":true,"disableCsp":true,"follow_redirects":true,"ignoreServerCertificateError":true,"initialNavigationTimeout":200,"min_failure_duration":10,"min_location_failed":1,"noScreenshot":true,"retry":{"count":2,"interval":10},"rumSettings":{"applicationId":"mockApplicationId","clientTokenId":12345,"isEnabled":true},"tick_every":300},"steps":[{"allowFailure":false,"isCritical":true,"name":"Refresh
+      message","name":"Test-Create_a_browser_test_returns_OK_Returns_saved_rumSettings_response-1733743063","options":{"accept_self_signed":false,"allow_insecure":true,"ci":{"executionRule":"skipped"},"device_ids":["tablet"],"disableCors":true,"disableCsp":true,"follow_redirects":true,"ignoreServerCertificateError":true,"initialNavigationTimeout":200,"min_failure_duration":10,"min_location_failed":1,"noScreenshot":true,"retry":{"count":2,"interval":10},"rumSettings":{"applicationId":"mockApplicationId","clientTokenId":12345,"isEnabled":true},"tick_every":300},"steps":[{"allowFailure":false,"isCritical":true,"name":"Refresh
       page","params":{},"type":"refresh"}],"tags":["testing:browser"],"type":"browser"}'
     headers:
       accept:
@@ -12,17 +12,17 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/synthetics/tests/browser
   response:
     body:
-      string: '{"public_id":"y2r-gnr-i3n","name":"Test-Create_a_browser_test_returns_OK_Returns_saved_rumSettings_response-1706264421","status":"paused","type":"browser","tags":["testing:browser"],"created_at":"2024-01-26T10:20:22.506547+00:00","modified_at":"2024-01-26T10:20:22.506547+00:00","config":{"assertions":[],"configVariables":[{"example":"content-type","name":"PROPERTY","pattern":"content-type","type":"text"}],"request":{"certificateDomains":["https://datadoghq.com"],"method":"GET","url":"https://datadoghq.com"},"setCookie":"name:test"},"message":"Test
-        message","options":{"accept_self_signed":false,"allow_insecure":true,"ci":{"executionRule":"skipped"},"device_ids":["tablet"],"disableCors":true,"disableCsp":true,"follow_redirects":true,"ignoreServerCertificateError":true,"initialNavigationTimeout":200,"min_failure_duration":10,"min_location_failed":1,"noScreenshot":true,"retry":{"count":2,"interval":10},"rumSettings":{"applicationId":"mockApplicationId","clientTokenId":12345,"isEnabled":true},"tick_every":300},"locations":["aws:us-east-2"],"created_by":{"name":"Frog","handle":"frog@datadoghq.com","email":"frog@datadoghq.com"},"deleted_at":null,"monitor_id":138446062,"org_id":569509,"modified_by":{"name":"Frog","handle":"frog@datadoghq.com","email":"frog@datadoghq.com"},"steps":[{"name":"Refresh
-        page","params":{},"type":"refresh","allowFailure":false,"isCritical":true}],"stepCount":{"assertions":0,"subtests":0,"total":1}}'
+      string: '{"public_id":"jj5-nke-dq2","name":"Test-Create_a_browser_test_returns_OK_Returns_saved_rumSettings_response-1733743063","status":"paused","type":"browser","tags":["testing:browser"],"created_at":"2024-12-09T11:17:44.348239+00:00","modified_at":"2024-12-09T11:17:44.348239+00:00","config":{"assertions":[],"configVariables":[{"example":"content-type","name":"PROPERTY","pattern":"content-type","type":"text"}],"request":{"certificateDomains":["https://datadoghq.com"],"method":"GET","url":"https://datadoghq.com"},"setCookie":"name:test"},"message":"Test
+        message","options":{"accept_self_signed":false,"allow_insecure":true,"ci":{"executionRule":"skipped"},"device_ids":["tablet"],"disableCors":true,"disableCsp":true,"follow_redirects":true,"ignoreServerCertificateError":true,"initialNavigationTimeout":200,"min_failure_duration":10,"min_location_failed":1,"noScreenshot":true,"retry":{"count":2,"interval":10},"rumSettings":{"applicationId":"mockApplicationId","clientTokenId":12345,"isEnabled":true},"tick_every":300},"locations":["aws:us-east-2"],"created_by":{"name":null,"handle":"frog@datadoghq.com","email":"frog@datadoghq.com"},"deleted_at":null,"monitor_id":159881000,"org_id":321813,"modified_by":{"name":null,"handle":"frog@datadoghq.com","email":"frog@datadoghq.com"},"steps":[{"name":"Refresh
+        page","params":{},"type":"refresh","public_id":"yb6-rim-kwp","allowFailure":false,"isCritical":true}],"stepCount":{"assertions":0,"subtests":0,"total":1}}'
     headers:
       content-type:
       - application/json
     status:
       code: 200
       message: OK
 - request:
-    body: '{"public_ids":["y2r-gnr-i3n"]}'
+    body: '{"public_ids":["jj5-nke-dq2"]}'
     headers:
       accept:
       - application/json
@@ -32,7 +32,7 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/synthetics/tests/delete
   response:
     body:
-      string: '{"deleted_tests":[{"public_id":"y2r-gnr-i3n","deleted_at":"2024-01-26T10:20:23.057714+00:00"}]}
+      string: '{"deleted_tests":[{"public_id":"jj5-nke-dq2","deleted_at":"2024-12-09T11:17:45.340410+00:00"}]}
 
         '
     headers:

tests/v1/cassettes/test_scenarios/test_create_a_browser_test_returns_ok_returns_the_created_test_details_response.frozen

@@ -1 +1 @@
-2024-07-10T11:52:27.901Z
+2024-12-09T11:17:45.545Z

tests/v1/cassettes/test_scenarios/test_create_a_browser_test_returns_ok_returns_the_created_test_details_response.yaml

@@ -1,7 +1,7 @@
 interactions:
 - request:
     body: '{"config":{"assertions":[],"configVariables":[{"example":"content-type","name":"PROPERTY","pattern":"content-type","secure":true,"type":"text"}],"request":{"method":"GET","url":"https://datadoghq.com"},"setCookie":"name:test","variables":[{"example":"secret","name":"TEST_VARIABLE","pattern":"secret","secure":true,"type":"text"}]},"locations":["aws:us-east-2"],"message":"Test
-      message","name":"Test-Create_a_browser_test_returns_OK_Returns_the_created_test_details_response-1720612347","options":{"accept_self_signed":false,"allow_insecure":true,"device_ids":["chrome.laptop_large"],"disableCors":true,"enableProfiling":true,"enableSecurityTesting":true,"follow_redirects":true,"min_failure_duration":10,"min_location_failed":1,"noScreenshot":true,"retry":{"count":2,"interval":10},"tick_every":300},"steps":[{"allowFailure":false,"isCritical":true,"name":"Refresh
+      message","name":"Test-Create_a_browser_test_returns_OK_Returns_the_created_test_details_response-1733743065","options":{"accept_self_signed":false,"allow_insecure":true,"device_ids":["chrome.laptop_large"],"disableCors":true,"enableProfiling":true,"enableSecurityTesting":true,"follow_redirects":true,"min_failure_duration":10,"min_location_failed":1,"noScreenshot":true,"retry":{"count":2,"interval":10},"tick_every":300},"steps":[{"allowFailure":false,"alwaysExecute":true,"exitIfSucceed":true,"isCritical":true,"name":"Refresh
       page","params":{},"type":"refresh"}],"tags":["testing:browser"],"type":"browser"}'
     headers:
       accept:
@@ -12,17 +12,17 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/synthetics/tests/browser
   response:
     body:
-      string: '{"public_id":"j34-jum-nef","name":"Test-Create_a_browser_test_returns_OK_Returns_the_created_test_details_response-1720612347","status":"paused","type":"browser","tags":["testing:browser"],"created_at":"2024-07-10T11:52:28.494877+00:00","modified_at":"2024-07-10T11:52:28.494877+00:00","config":{"assertions":[],"configVariables":[{"name":"PROPERTY","secure":true,"type":"text"}],"request":{"method":"GET","url":"https://datadoghq.com"},"setCookie":"name:test","variables":[{"name":"TEST_VARIABLE","secure":true,"type":"text"}]},"message":"Test
-        message","options":{"accept_self_signed":false,"allow_insecure":true,"device_ids":["chrome.laptop_large"],"disableCors":true,"enableProfiling":true,"enableSecurityTesting":true,"follow_redirects":true,"min_failure_duration":10,"min_location_failed":1,"noScreenshot":true,"retry":{"count":2,"interval":10},"tick_every":300},"locations":["aws:us-east-2"],"created_by":{"name":null,"handle":"frog@datadoghq.com","email":"frog@datadoghq.com"},"deleted_at":null,"monitor_id":148931232,"org_id":321813,"modified_by":{"name":null,"handle":"frog@datadoghq.com","email":"frog@datadoghq.com"},"steps":[{"name":"Refresh
-        page","params":{},"type":"refresh","allowFailure":false,"isCritical":true}],"stepCount":{"assertions":0,"subtests":0,"total":1}}'
+      string: '{"public_id":"y49-diz-cwy","name":"Test-Create_a_browser_test_returns_OK_Returns_the_created_test_details_response-1733743065","status":"paused","type":"browser","tags":["testing:browser"],"created_at":"2024-12-09T11:17:46.150300+00:00","modified_at":"2024-12-09T11:17:46.150300+00:00","config":{"assertions":[],"configVariables":[{"name":"PROPERTY","secure":true,"type":"text"}],"request":{"method":"GET","url":"https://datadoghq.com"},"setCookie":"name:test","variables":[{"name":"TEST_VARIABLE","secure":true,"type":"text"}]},"message":"Test
+        message","options":{"accept_self_signed":false,"allow_insecure":true,"device_ids":["chrome.laptop_large"],"disableCors":true,"enableProfiling":true,"enableSecurityTesting":true,"follow_redirects":true,"min_failure_duration":10,"min_location_failed":1,"noScreenshot":true,"retry":{"count":2,"interval":10},"tick_every":300},"locations":["aws:us-east-2"],"created_by":{"name":null,"handle":"frog@datadoghq.com","email":"frog@datadoghq.com"},"deleted_at":null,"monitor_id":159881002,"org_id":321813,"modified_by":{"name":null,"handle":"frog@datadoghq.com","email":"frog@datadoghq.com"},"steps":[{"name":"Refresh
+        page","params":{},"type":"refresh","public_id":"uyu-hni-jav","allowFailure":false,"isCritical":true,"exitIfSucceed":true,"alwaysExecute":true}],"stepCount":{"assertions":0,"subtests":0,"total":1}}'
     headers:
       content-type:
       - application/json
     status:
       code: 200
       message: OK
 - request:
-    body: '{"public_ids":["j34-jum-nef"]}'
+    body: '{"public_ids":["y49-diz-cwy"]}'
     headers:
       accept:
       - application/json
@@ -32,7 +32,7 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/synthetics/tests/delete
   response:
     body:
-      string: '{"deleted_tests":[{"public_id":"j34-jum-nef","deleted_at":"2024-07-10T11:52:30.153321+00:00"}]}
+      string: '{"deleted_tests":[{"public_id":"y49-diz-cwy","deleted_at":"2024-12-09T11:17:47.130391+00:00"}]}
 
         '
     headers: