Add BDD tests to synthetics (#489)

* Support body in undo, add cassettes

* Regenerate client from commit 8327a94 of spec repo

Co-authored-by: Thomas Hervé <[email protected]>
Co-authored-by: ci.datadog-api-spec <[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.4.1.dev8",
-            "regenerated": "2021-06-17 15:07:58.879914",
-            "spec_repo_commit": "7f25c3e"
+            "regenerated": "2021-06-21 15:11:55.610953",
+            "spec_repo_commit": "8327a94"
         },
         "v2": {
             "apigentools_version": "1.4.1.dev8",
-            "regenerated": "2021-06-17 15:08:28.826169",
-            "spec_repo_commit": "7f25c3e"
+            "regenerated": "2021-06-21 15:12:23.084029",
+            "spec_repo_commit": "8327a94"
         }
     }
 }

docs/v1/SyntheticsAssertionJSONPathTargetTarget.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **json_path** | **str** | The JSON path to assert. | [optional] 
 **operator** | **str** | The specific operator to use on the path. | [optional] 
-**target_value** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | The path target value to compare to. | [optional] 
+**target_value** | **bool, date, datetime, dict, float, int, list, str, none_type** | The path target value to compare to. | [optional] 
 
 [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
 

src/datadog_api_client/v1/model/synthetics_assertion_json_path_target_target.py

@@ -67,7 +67,17 @@ def openapi_types():
         return {
             "json_path": (str,),  # noqa: E501
             "operator": (str,),  # noqa: E501
-            "target_value": ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),  # noqa: E501
+            "target_value": (
+                bool,
+                date,
+                datetime,
+                dict,
+                float,
+                int,
+                list,
+                str,
+                none_type,
+            ),  # noqa: E501
         }
 
     @cached_property
@@ -130,7 +140,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 _visited_composed_classes = (Animal,)
             json_path (str): The JSON path to assert.. [optional]  # noqa: E501
             operator (str): The specific operator to use on the path.. [optional]  # noqa: E501
-            target_value ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The path target value to compare to.. [optional]  # noqa: E501
+            target_value (bool, date, datetime, dict, float, int, list, str, none_type): The path target value to compare to.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop("_check_type", True)

src/datadog_api_client/v1/openapi.yaml

@@ -8506,7 +8506,6 @@ components:
               type: string
             targetValue:
               description: The path target value to compare to.
-              type: object
           type: object
         type:
           $ref: '#/components/schemas/SyntheticsAssertionType'
@@ -19831,8 +19830,10 @@ paths:
       x-codegen-request-body-name: body
       x-menu-order: 1
       x-undo:
-        operationId: TODO
-        parameters: []
+        operationId: DeleteTests
+        parameters:
+        - name: body
+          template: '{"public_ids": ["{{ public_id }}"]}'
         type: unsafe
   /api/v1/synthetics/tests/api/{public_id}:
     get:

tests/conftest.py

@@ -60,7 +60,7 @@ def pytest_configure(config):
 
 import pytest
 from dateutil.relativedelta import relativedelta
-from jinja2 import Template
+from jinja2 import Template, Environment, meta
 from pytest_bdd import (
     given,
     parsers,
@@ -76,12 +76,7 @@ def pytest_bdd_before_step(request, feature, scenario, step, step_func):
         return
 
     context = tracer.get_call_context()
-    span = tracer.start_span(
-        step.type,
-        resource=step.name,
-        span_type=step.type,
-        child_of=context,
-    )
+    span = tracer.start_span(step.type, resource=step.name, span_type=step.type, child_of=context,)
     setattr(step_func, "__dd_span__", span)
 
 
@@ -226,11 +221,7 @@ def context(vcr, unique, unique_lower, freezer):
 @pytest.fixture(scope="session")
 def record_mode(request):
     """Manage compatibility with DD client libraries."""
-    return {
-        "false": "none",
-        "true": "rewrite",
-        "none": "new_episodes",
-    }[os.getenv("RECORD", "false").lower()]
+    return {"false": "none", "true": "rewrite", "none": "new_episodes",}[os.getenv("RECORD", "false").lower()]
 
 
 def _disable_recording():
@@ -249,7 +240,7 @@ def vcr_config():
     config = dict(
         filter_headers=("DD-API-KEY", "DD-APPLICATION-KEY"),
         filter_query_parameters=("api_key", "application_key"),
-        match_on=['method', 'scheme', 'host', 'port', 'path', 'query', 'body']
+        match_on=["method", "scheme", "host", "port", "path", "query", "body"],
     )
     if tracer:
         config["ignore_hosts"] = [tracer.writer._hostname]
@@ -372,7 +363,7 @@ def request_body(context, data):
     context["api_request"]["kwargs"]["body"] = json.loads(tpl)
 
 
-@given(parsers.parse("body from file \"{path}\""))
+@given(parsers.parse('body from file "{path}"'))
 def request_body_from_file(context, path, package_name):
     """Set request body."""
     version = package_name.split(".")[-1]
@@ -469,7 +460,16 @@ def cleanup(api, operation_id, response, client=client):
 
         operation_name = snake_case(operation["operationId"])
         method = getattr(api, operation_name)
-        args = [glom(response, parameter["source"]) for parameter in operation.get("parameters", [])]
+        args = []
+        for parameter in operation.get("parameters", []):
+            if "source" in parameter:
+                args.append(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)
+                args.append(json.loads(Template(parameter["template"]).render(**ctx)))
 
         if operation_name in client.configuration.unstable_operations:
             client.configuration.unstable_operations[operation_name] = True
@@ -490,9 +490,7 @@ def execute_request(undo, context, client, _package):
     exceptions = importlib.import_module(context["api"]["package"] + ".exceptions")
 
     try:
-        response = api_request["request"](
-            *api_request["args"], **api_request["kwargs"]
-        )
+        response = api_request["request"](*api_request["args"], **api_request["kwargs"])
         client.last_response.urllib3_response.close()
         # Reserialise the response body to JSON to facilitate test assertions
         response_body_json = _package.api_client.ApiClient.sanitize_for_serialization(response[0])

tests/v1/cassettes/test_scenarios/test_create_an_api_test_returns_ok__returns_the_created_test_details_response.frozen

@@ -0,0 +1 @@
+2021-06-18T14:25:50.736130+02:00

tests/v1/cassettes/test_scenarios/test_create_an_api_test_returns_ok__returns_the_created_test_details_response.yaml

@@ -0,0 +1,129 @@
+interactions:
+- request:
+    body: '{"config": {"assertions": [{"operator": "contains", "property": "content-type",
+      "target": "application/json", "type": "header"}, {"operator": "is", "target":
+      200, "type": "statusCode"}, {"operator": "validatesJSONPath", "target": {"jsonPath":
+      "topKey", "operator": "isNot", "targetValue": "0"}, "type": "body"}, {"operator":
+      "validatesJSONPath", "target": {"jsonPath": "something", "operator": "moreThan",
+      "targetValue": 5}, "type": "body"}, {"operator": "isNot", "target": 200, "type":
+      "statusCode"}, {"operator": "matches", "target": "20[04]", "type": "statusCode"},
+      {"operator": "doesNotMatch", "target": "20[04]", "type": "statusCode"}], "configVariables":
+      [], "request": {"basicAuth": {"password": "secret", "username": "admin"}, "body":
+      "this is a body", "headers": {"Accept": "application/json"}, "method": "GET",
+      "query": {"foo": "bar"}, "timeout": 30, "url": "https://www.datadoghq.com"}},
+      "locations": ["aws:eu-central-1"], "message": "Notify @datadog.user", "name":
+      "Test-Create_an_API_test_returns_OK_Returns_the_created_test_details_response-1624019150",
+      "options": {"follow_redirects": true, "min_location_failed": 1, "monitor_options":
+      {"renotify_interval": 100}, "tick_every": 60}, "status": "paused", "subtype":
+      "http", "tags": ["foo:bar", "baz"], "type": "api"}'
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Dd-Operation-Id:
+      - CreateSyntheticsApiTest
+      User-Agent:
+      - datadog-api-client-python/1.1.1.dev7+dirty (python 3.8.10; os Darwin; arch
+        x86_64)
+    method: POST
+    uri: https://api.datadoghq.com/api/v1/synthetics/tests/api
+  response:
+    body:
+      string: '{"status":"paused","public_id":"z28-93g-afx","tags":["foo:bar","baz"],"org_id":321813,"locations":["aws:eu-central-1"],"message":"Notify
+        @datadog.user","deleted_at":null,"name":"Test-Create_an_API_test_returns_OK_Returns_the_created_test_details_response-1624019150","monitor_id":38926045,"type":"api","created_at":"2021-06-18T12:25:51.393485+00:00","modified_at":"2021-06-18T12:25:51.393485+00:00","subtype":"http","config":{"request":{"body":"this
+        is a body","url":"https://www.datadoghq.com","basicAuth":{"username":"admin","password":"secret"},"headers":{"Accept":"application/json"},"timeout":30,"query":{"foo":"bar"},"method":"GET"},"assertions":[{"operator":"contains","property":"content-type","type":"header","target":"application/json"},{"operator":"is","type":"statusCode","target":200},{"operator":"validatesJSONPath","type":"body","target":{"operator":"isNot","targetValue":"0","jsonPath":"topKey"}},{"operator":"validatesJSONPath","type":"body","target":{"operator":"moreThan","targetValue":5,"jsonPath":"something"}},{"operator":"isNot","type":"statusCode","target":200},{"operator":"matches","type":"statusCode","target":"20[04]"},{"operator":"doesNotMatch","type":"statusCode","target":"20[04]"}],"configVariables":[]},"options":{"follow_redirects":true,"monitor_options":{"notify_audit":false,"locked":false,"include_tags":true,"new_host_delay":300,"notify_no_data":false,"renotify_interval":100},"min_location_failed":1,"tick_every":60}}'
+    headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '1456'
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 18 Jun 2021 12:25:51 GMT
+      cache-control:
+      - no-cache
+      content-security-policy:
+      - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report
+      pragma:
+      - no-cache
+      strict-transport-security:
+      - max-age=15724800;
+      vary:
+      - Accept-Encoding
+      x-content-type-options:
+      - nosniff
+      x-dd-debug:
+      - l8RQo2maZqJf6GFThBbKNE6dvthz6njusVtau3dPXJWL2RLFoN81H+BLPB/1xgs1
+      x-dd-version:
+      - '35.4781545'
+      x-frame-options:
+      - SAMEORIGIN
+      x-ratelimit-limit:
+      - '120'
+      x-ratelimit-period:
+      - '60'
+      x-ratelimit-remaining:
+      - '118'
+      x-ratelimit-reset:
+      - '9'
+    status:
+      code: 200
+      message: OK
+- request:
+    body: '{"public_ids": ["z28-93g-afx"]}'
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Dd-Operation-Id:
+      - DeleteTests
+      User-Agent:
+      - datadog-api-client-python/1.1.1.dev7+dirty (python 3.8.10; os Darwin; arch
+        x86_64)
+    method: POST
+    uri: https://api.datadoghq.com/api/v1/synthetics/tests/delete
+  response:
+    body:
+      string: '{"deleted_tests":[{"deleted_at":"2021-06-18T12:25:51.815581+00:00","public_id":"z28-93g-afx"}]}'
+    headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '95'
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 18 Jun 2021 12:25:51 GMT
+      cache-control:
+      - no-cache
+      content-security-policy:
+      - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report
+      pragma:
+      - no-cache
+      strict-transport-security:
+      - max-age=15724800;
+      vary:
+      - Accept-Encoding
+      x-content-type-options:
+      - nosniff
+      x-dd-debug:
+      - vdJ3/nHEY1ioXQ6pQrBVvsQK1s4yyc+wufBMPSoXql71qZVuP/xMdtNo6DafhOAk
+      x-dd-version:
+      - '35.4781545'
+      x-frame-options:
+      - SAMEORIGIN
+      x-ratelimit-limit:
+      - '120'
+      x-ratelimit-period:
+      - '60'
+      x-ratelimit-remaining:
+      - '119'
+      x-ratelimit-reset:
+      - '9'
+    status:
+      code: 200
+      message: OK
+version: 1

tests/v1/features/synthetics.feature

@@ -78,10 +78,9 @@ Feature: Synthetics
     When the request is sent
     Then the response status is 400 - JSON format is wrong
 
-  @generated @skip
   Scenario: Create an API test returns "OK - Returns the created test details." response
     Given new "CreateSyntheticsAPITest" request
-    And body with value {"config": {"assertions": [], "configVariables": [{"example": null, "id": null, "name": "VARIABLE_NAME", "pattern": null, "type": "global"}], "request": {"basicAuth": {"password": "", "username": ""}, "body": null, "certificate": {"cert": {"content": null, "filename": null, "updatedAt": null}, "key": {"content": null, "filename": null, "updatedAt": null}}, "dnsServer": null, "dnsServerPort": null, "headers": null, "host": null, "method": "GET", "noSavingResponseBody": null, "numberOfPackets": null, "port": null, "query": null, "shouldTrackHops": null, "timeout": null, "url": null}, "steps": [{"allowFailure": null, "assertions": [], "extractedValues": [{"field": "content-type", "name": null, "parser": {"type": "regex", "value": ".*"}, "type": "http_body"}], "isCritical": null, "name": null, "request": {"basicAuth": {"password": "", "username": ""}, "body": null, "certificate": {"cert": {"content": null, "filename": null, "updatedAt": null}, "key": {"content": null, "filename": null, "updatedAt": null}}, "dnsServer": null, "dnsServerPort": null, "headers": null, "host": null, "method": "GET", "noSavingResponseBody": null, "numberOfPackets": null, "port": null, "query": null, "shouldTrackHops": null, "timeout": null, "url": null}, "subtype": "http"}]}, "locations": [null], "message": null, "name": null, "options": {"accept_self_signed": null, "allow_insecure": null, "device_ids": ["laptop_large"], "disableCors": null, "follow_redirects": null, "min_failure_duration": null, "min_location_failed": null, "monitor_name": null, "monitor_options": {"renotify_interval": null}, "monitor_priority": null, "noScreenshot": null, "retry": {"count": null, "interval": null}, "tick_every": 30}, "status": "live", "subtype": "http", "tags": [null], "type": "api"}
+    And body with value {"config":{"assertions":[{"operator":"contains","property":"content-type","target":"application/json","type":"header"},{"operator":"is","target":200,"type":"statusCode"},{"operator":"validatesJSONPath","target":{"jsonPath":"topKey","operator":"isNot","targetValue":"0"},"type":"body"},{"operator":"validatesJSONPath","target":{"jsonPath":"something","operator":"moreThan","targetValue":5},"type":"body"},{"operator":"isNot","target":200,"type":"statusCode"},{"operator":"matches","target":"20[04]","type":"statusCode"},{"operator":"doesNotMatch","target":"20[04]","type":"statusCode"}],"configVariables":[],"request":{"basicAuth":{"password":"secret","username":"admin"},"body":"this is a body","headers":{"Accept":"application/json"},"method":"GET","query":{"foo":"bar"},"timeout":30,"url":"https://www.datadoghq.com"}},"locations":["aws:eu-central-1"],"message":"Notify @datadog.user","name":"{{ unique }}","options":{"follow_redirects":true,"min_location_failed":1,"monitor_options":{"renotify_interval":100},"tick_every":60},"status":"paused","subtype":"http","tags":["foo:bar","baz"],"type":"api"}
     When the request is sent
     Then the response status is 200 OK - Returns the created test details.
 

tests/v1/features/undo.json

@@ -894,8 +894,13 @@
   "CreateSyntheticsAPITest": {
     "tag": "Synthetics",
     "undo": {
-      "operationId": "TODO",
-      "parameters": [],
+      "operationId": "DeleteTests",
+      "parameters": [
+        {
+          "name": "body",
+          "template": "{\"public_ids\": [\"{{ public_id }}\"]}"
+        }
+      ],
       "type": "unsafe"
     }
   },