Add support for xpath assertions in synthetics tests (#1204)

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.4",
-            "regenerated": "2022-11-04 18:42:27.825188",
-            "spec_repo_commit": "af3f11fc"
+            "regenerated": "2022-11-08 09:49:28.138621",
+            "spec_repo_commit": "9146e44b"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-11-04 18:42:27.839660",
-            "spec_repo_commit": "af3f11fc"
+            "regenerated": "2022-11-08 09:49:28.149991",
+            "spec_repo_commit": "9146e44b"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -11299,6 +11299,7 @@ components:
       oneOf:
       - $ref: '#/components/schemas/SyntheticsAssertionTarget'
       - $ref: '#/components/schemas/SyntheticsAssertionJSONPathTarget'
+      - $ref: '#/components/schemas/SyntheticsAssertionXPathTarget'
       type: object
     SyntheticsAssertionJSONPathOperator:
       description: Assertion operator to apply.
@@ -11428,6 +11429,42 @@ components:
       - RECEIVED_MESSAGE
       - GRPC_HEALTHCHECK_STATUS
       - CONNECTION
+    SyntheticsAssertionXPathOperator:
+      description: Assertion operator to apply.
+      enum:
+      - validatesXPath
+      example: validatesXPath
+      type: string
+      x-enum-varnames:
+      - VALIDATES_X_PATH
+    SyntheticsAssertionXPathTarget:
+      description: An assertion for the `validatesXPath` operator.
+      properties:
+        operator:
+          $ref: '#/components/schemas/SyntheticsAssertionXPathOperator'
+        property:
+          description: The associated assertion property.
+          type: string
+        target:
+          $ref: '#/components/schemas/SyntheticsAssertionXPathTargetTarget'
+        type:
+          $ref: '#/components/schemas/SyntheticsAssertionType'
+      required:
+      - type
+      - operator
+      type: object
+    SyntheticsAssertionXPathTargetTarget:
+      description: Composed target for `validatesXPath` operator.
+      properties:
+        operator:
+          description: The specific operator to use on the path.
+          type: string
+        targetValue:
+          description: The path target value to compare to.
+        xPath:
+          description: The X path to assert.
+          type: string
+      type: object
     SyntheticsBasicAuth:
       description: Object to handle basic authentication when performing the test.
       oneOf:

docs/datadog_api_client.v1.model.rst

@@ -3368,6 +3368,27 @@ synthetics\_assertion\_type
    :members:
    :show-inheritance:
 
+synthetics\_assertion\_x\_path\_operator
+----------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_assertion_x_path_operator
+   :members:
+   :show-inheritance:
+
+synthetics\_assertion\_x\_path\_target
+--------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_assertion_x_path_target
+   :members:
+   :show-inheritance:
+
+synthetics\_assertion\_x\_path\_target\_target
+----------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_assertion_x_path_target_target
+   :members:
+   :show-inheritance:
+
 synthetics\_basic\_auth
 -----------------------
 

examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.py

@@ -16,6 +16,9 @@
 from datadog_api_client.v1.model.synthetics_assertion_operator import SyntheticsAssertionOperator
 from datadog_api_client.v1.model.synthetics_assertion_target import SyntheticsAssertionTarget
 from datadog_api_client.v1.model.synthetics_assertion_type import SyntheticsAssertionType
+from datadog_api_client.v1.model.synthetics_assertion_x_path_operator import SyntheticsAssertionXPathOperator
+from datadog_api_client.v1.model.synthetics_assertion_x_path_target import SyntheticsAssertionXPathTarget
+from datadog_api_client.v1.model.synthetics_assertion_x_path_target_target import SyntheticsAssertionXPathTargetTarget
 from datadog_api_client.v1.model.synthetics_config_variable import SyntheticsConfigVariable
 from datadog_api_client.v1.model.synthetics_config_variable_type import SyntheticsConfigVariableType
 from datadog_api_client.v1.model.synthetics_test_details_sub_type import SyntheticsTestDetailsSubType
@@ -50,6 +53,15 @@
                 ),
                 type=SyntheticsAssertionType.BODY,
             ),
+            SyntheticsAssertionXPathTarget(
+                operator=SyntheticsAssertionXPathOperator.VALIDATES_X_PATH,
+                target=SyntheticsAssertionXPathTargetTarget(
+                    x_path="target-xpath",
+                    target_value="0",
+                    operator="contains",
+                ),
+                type=SyntheticsAssertionType.BODY,
+            ),
         ],
         config_variables=[
             SyntheticsConfigVariable(

src/datadog_api_client/v1/model/synthetics_api_test_config.py

@@ -20,6 +20,7 @@
     from datadog_api_client.v1.model.synthetics_api_step import SyntheticsAPIStep
     from datadog_api_client.v1.model.synthetics_assertion_target import SyntheticsAssertionTarget
     from datadog_api_client.v1.model.synthetics_assertion_json_path_target import SyntheticsAssertionJSONPathTarget
+    from datadog_api_client.v1.model.synthetics_assertion_x_path_target import SyntheticsAssertionXPathTarget
 
 
 class SyntheticsAPITestConfig(ModelNormal):
@@ -47,7 +48,15 @@ def openapi_types(_):
     def __init__(
         self_,
         assertions: Union[
-            List[Union[SyntheticsAssertion, SyntheticsAssertionTarget, SyntheticsAssertionJSONPathTarget]], UnsetType
+            List[
+                Union[
+                    SyntheticsAssertion,
+                    SyntheticsAssertionTarget,
+                    SyntheticsAssertionJSONPathTarget,
+                    SyntheticsAssertionXPathTarget,
+                ]
+            ],
+            UnsetType,
         ] = unset,
         config_variables: Union[List[SyntheticsConfigVariable], UnsetType] = unset,
         request: Union[SyntheticsTestRequest, UnsetType] = unset,

src/datadog_api_client/v1/model/synthetics_assertion.py

@@ -41,10 +41,12 @@ def _composed_schemas(_):
         # loading
         from datadog_api_client.v1.model.synthetics_assertion_target import SyntheticsAssertionTarget
         from datadog_api_client.v1.model.synthetics_assertion_json_path_target import SyntheticsAssertionJSONPathTarget
+        from datadog_api_client.v1.model.synthetics_assertion_x_path_target import SyntheticsAssertionXPathTarget
 
         return {
             "oneOf": [
                 SyntheticsAssertionTarget,
                 SyntheticsAssertionJSONPathTarget,
+                SyntheticsAssertionXPathTarget,
             ],
         }

src/datadog_api_client/v1/model/synthetics_assertion_x_path_operator.py

@@ -0,0 +1,35 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class SyntheticsAssertionXPathOperator(ModelSimple):
+    """
+    Assertion operator to apply.
+
+    :param value: If omitted defaults to "validatesXPath". Must be one of ["validatesXPath"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "validatesXPath",
+    }
+    VALIDATES_X_PATH: ClassVar["SyntheticsAssertionXPathOperator"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+SyntheticsAssertionXPathOperator.VALIDATES_X_PATH = SyntheticsAssertionXPathOperator("validatesXPath")

src/datadog_api_client/v1/model/synthetics_assertion_x_path_target.py

@@ -0,0 +1,77 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Union
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v1.model.synthetics_assertion_x_path_operator import SyntheticsAssertionXPathOperator
+    from datadog_api_client.v1.model.synthetics_assertion_x_path_target_target import (
+        SyntheticsAssertionXPathTargetTarget,
+    )
+    from datadog_api_client.v1.model.synthetics_assertion_type import SyntheticsAssertionType
+
+
+class SyntheticsAssertionXPathTarget(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v1.model.synthetics_assertion_x_path_operator import SyntheticsAssertionXPathOperator
+        from datadog_api_client.v1.model.synthetics_assertion_x_path_target_target import (
+            SyntheticsAssertionXPathTargetTarget,
+        )
+        from datadog_api_client.v1.model.synthetics_assertion_type import SyntheticsAssertionType
+
+        return {
+            "operator": (SyntheticsAssertionXPathOperator,),
+            "_property": (str,),
+            "target": (SyntheticsAssertionXPathTargetTarget,),
+            "type": (SyntheticsAssertionType,),
+        }
+
+    attribute_map = {
+        "operator": "operator",
+        "_property": "property",
+        "target": "target",
+        "type": "type",
+    }
+
+    def __init__(
+        self_,
+        operator: SyntheticsAssertionXPathOperator,
+        type: SyntheticsAssertionType,
+        _property: Union[str, UnsetType] = unset,
+        target: Union[SyntheticsAssertionXPathTargetTarget, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        An assertion for the ``validatesXPath`` operator.
+
+        :param operator: Assertion operator to apply.
+        :type operator: SyntheticsAssertionXPathOperator
+
+        :param _property: The associated assertion property.
+        :type _property: str, optional
+
+        :param target: Composed target for ``validatesXPath`` operator.
+        :type target: SyntheticsAssertionXPathTargetTarget, optional
+
+        :param type: Type of the assertion.
+        :type type: SyntheticsAssertionType
+        """
+        if _property is not unset:
+            kwargs["_property"] = _property
+        if target is not unset:
+            kwargs["target"] = target
+        super().__init__(kwargs)
+
+        self_.operator = operator
+        self_.type = type

src/datadog_api_client/v1/model/synthetics_assertion_x_path_target_target.py

@@ -0,0 +1,69 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import Any, Union
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    date,
+    datetime,
+    none_type,
+    unset,
+    UnsetType,
+)
+
+
+class SyntheticsAssertionXPathTargetTarget(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        return {
+            "operator": (str,),
+            "target_value": (
+                bool,
+                date,
+                datetime,
+                dict,
+                float,
+                int,
+                list,
+                str,
+                none_type,
+            ),
+            "x_path": (str,),
+        }
+
+    attribute_map = {
+        "operator": "operator",
+        "target_value": "targetValue",
+        "x_path": "xPath",
+    }
+
+    def __init__(
+        self_,
+        operator: Union[str, UnsetType] = unset,
+        target_value: Union[Any, UnsetType] = unset,
+        x_path: Union[str, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        Composed target for ``validatesXPath`` operator.
+
+        :param operator: The specific operator to use on the path.
+        :type operator: str, optional
+
+        :param target_value: The path target value to compare to.
+        :type target_value: bool, date, datetime, dict, float, int, list, str, none_type, optional
+
+        :param x_path: The X path to assert.
+        :type x_path: str, optional
+        """
+        if operator is not unset:
+            kwargs["operator"] = operator
+        if target_value is not unset:
+            kwargs["target_value"] = target_value
+        if x_path is not unset:
+            kwargs["x_path"] = x_path
+        super().__init__(kwargs)

src/datadog_api_client/v1/model/synthetics_test_config.py

@@ -20,6 +20,7 @@
     from datadog_api_client.v1.model.synthetics_browser_variable import SyntheticsBrowserVariable
     from datadog_api_client.v1.model.synthetics_assertion_target import SyntheticsAssertionTarget
     from datadog_api_client.v1.model.synthetics_assertion_json_path_target import SyntheticsAssertionJSONPathTarget
+    from datadog_api_client.v1.model.synthetics_assertion_x_path_target import SyntheticsAssertionXPathTarget
 
 
 class SyntheticsTestConfig(ModelNormal):
@@ -47,7 +48,15 @@ def openapi_types(_):
     def __init__(
         self_,
         assertions: Union[
-            List[Union[SyntheticsAssertion, SyntheticsAssertionTarget, SyntheticsAssertionJSONPathTarget]], UnsetType
+            List[
+                Union[
+                    SyntheticsAssertion,
+                    SyntheticsAssertionTarget,
+                    SyntheticsAssertionJSONPathTarget,
+                    SyntheticsAssertionXPathTarget,
+                ]
+            ],
+            UnsetType,
         ] = unset,
         config_variables: Union[List[SyntheticsConfigVariable], UnsetType] = unset,
         request: Union[SyntheticsTestRequest, UnsetType] = unset,