Migrate manual tests to BDD scenarios (#608)

* fix undo from different version and camelCase access

* fix cassette names

* use correct version

* Regenerate client from commit 5bae09b of spec repo

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

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2021-10-14 09:42:22.698222",
-            "spec_repo_commit": "52f8e03"
+            "regenerated": "2021-10-14 17:39:58.149064",
+            "spec_repo_commit": "5bae09b"
         },
         "v2": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2021-10-14 09:43:03.256268",
-            "spec_repo_commit": "52f8e03"
+            "regenerated": "2021-10-14 17:40:37.330324",
+            "spec_repo_commit": "5bae09b"
         }
     }
 }

src/datadog_api_client/v1/api/monitors_api.py

@@ -146,7 +146,10 @@ def glom(value, path):
     from glom import glom as g
 
     # replace foo[index].bar by foo.index.bar
-    return g(value, re.sub(r"\[([0-9]*)\]", r".\1", path))
+    path = re.sub(r"\[([0-9]*)\]", r".\1", path)
+    # replace camelCase to snake_case
+    path = ".".join(snake_case(p) for p in path.split("."))
+    return g(value, path)
 
 
 def _get_prefix(request):
@@ -266,6 +269,11 @@ def vcr_config():
     return config
 
 
+@pytest.fixture
+def default_cassette_name(default_cassette_name):
+    return re.sub("__+", "_", default_cassette_name)
+
+
 @pytest.fixture
 def freezer(default_cassette_name, record_mode, vcr):
     from freezegun import freeze_time
@@ -327,23 +335,29 @@ def a_valid_application_key(configuration):
     configuration.api_key["appKeyAuth"] = os.getenv("DD_TEST_CLIENT_APP_KEY", "fake")
 
 
+@pytest.fixture(scope="module")
+def package_name(api_version):
+    return "datadog_api_client." + api_version
+
+
 @pytest.fixture
 def _package(package_name):
     return importlib.import_module(package_name)
 
 
 @pytest.fixture(scope="module")
-def undo_operations(package_name):
-    version = package_name.split(".")[-1]
-    with open(
-        os.path.join(os.path.dirname(__file__), version, "features", "undo.json")
-    ) as fp:
-        data = json.load(fp)
+def undo_operations():
+    result = {}
+    for f in pathlib.Path(os.path.dirname(__file__)).rglob("undo.json"):
+        version = f.parent.parent.name
+        with f.open() as fp:
+            data = json.load(fp)
+            result[version] = {
+                snake_case(operation_id): settings.get("undo")
+                for operation_id, settings in data.items()
+            }
 
-    return {
-        snake_case(operation_id): settings.get("undo")
-        for operation_id, settings in data.items()
-    }
+    return result
 
 
 def build_configuration(package):
@@ -485,7 +499,7 @@ def build_param(p):
 
             # register undo method
             context["undo_operations"].append(
-                lambda: undo(api, operation_name, result, client=client)
+                lambda: undo(api, version, operation_name, result, client=client)
             )
 
             # optional re-shaping
@@ -513,13 +527,13 @@ def undo(package_name, undo_operations, client):
     """Clean after operation."""
     exceptions = importlib.import_module(package_name + ".exceptions")
 
-    def cleanup(api, operation_id, response, client=client):
-        if operation_id not in undo_operations:
-            raise NotImplementedError(operation_id)
+    def cleanup(api, version, operation_id, response, client=client):
+        operation = undo_operations.get(version, {}).get(operation_id)
+        if operation_id is None:
+            raise NotImplementedError((version, operation_id))
 
-        operation = undo_operations[operation_id]
         if operation["type"] is None:
-            raise NotImplementedError(operation_id)
+            raise NotImplementedError((version, operation_id))
 
         if operation["type"] != "unsafe":
             return
@@ -552,7 +566,7 @@ def cleanup(api, operation_id, response, client=client):
 
 
 @when("the request is sent")
-def execute_request(undo, context, client, _package):
+def execute_request(undo, context, client, api_version, _package):
     """Execute the prepared request."""
     api_request = context["api_request"]
     exceptions = importlib.import_module(context["api"]["package"] + ".exceptions")
@@ -576,7 +590,7 @@ def execute_request(undo, context, client, _package):
     operation_id = api_request["request"].__name__
     response = api_request["response"][0]
 
-    context["undo_operations"].append(lambda: undo(api, operation_id, response))
+    context["undo_operations"].append(lambda: undo(api, api_version, operation_id, response))
 
 
 @then(parsers.parse('I should get an instance of "{name}"'))

src/datadog_api_client/v1/openapi.yaml

@@ -0,0 +1 @@
+2021-10-01T08:28:32.161Z

tests/conftest.py

@@ -0,0 +1,48 @@
+interactions:
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json, */*;q=0.8
+      connection:
+      - close
+      host:
+      - api.datadoghq.com
+      user-agent:
+      - datadog-api-client-typescript/1.0.0-beta.5 (node 14.18.0; os Linux; arch x64)
+      x-datadog-parent-id:
+      - '1445885062133744428'
+      x-datadog-trace-id:
+      - '1844874165778158805'
+    method: DELETE
+    uri: https://api.datadoghq.com/api/v1/downtime/0
+  response:
+    body:
+      string: '{"errors": ["Downtime 0 not found"]}'
+    headers:
+      cache-control:
+      - no-cache
+      connection:
+      - close
+      content-length:
+      - '36'
+      content-security-policy:
+      - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report
+      content-type:
+      - application/json
+      date:
+      - Fri, 01 Oct 2021 08:28:32 GMT
+      pragma:
+      - no-cache
+      strict-transport-security:
+      - max-age=15724800;
+      vary:
+      - Accept-Encoding
+      x-content-type-options:
+      - nosniff
+      x-frame-options:
+      - SAMEORIGIN
+    status:
+      code: 404
+      message: Not Found
+version: 1

tests/v1/cassettes/test_scenarios/test_cancel_a_downtime_returns_downtime_not_found_response.frozen

@@ -0,0 +1 @@
+2021-10-01T08:28:32.231Z