[datadog_synthetics_test] Support the bodyHash assertion. (#2431)

* Support bodyHash. * Remove unused fields. * Update go client. * Add test. * Update docs. * Update test. * Fix test. * Fix tests.
DataDog · Jun 11, 2024 · 835587c · 835587c
1 parent 8552cf3
commit 835587c
Show file tree

Hide file tree

Showing 15 changed files with 261 additions and 241 deletions.
diff --git a/datadog/resource_datadog_synthetics_test_.go b/datadog/resource_datadog_synthetics_test_.go
@@ -460,7 +460,7 @@ func syntheticsAPIAssertion() *schema.Schema {
 				"type": {
 					Description:      "Type of assertion. **Note** Only some combinations of `type` and `operator` are valid (please refer to [Datadog documentation](https://docs.datadoghq.com/api/latest/synthetics/#create-a-test)).",
 					Type:             schema.TypeString,
-					ValidateDiagFunc: validators.ValidateEnumValue(datadogV1.NewSyntheticsAssertionTypeFromValue),
+					ValidateDiagFunc: validators.ValidateEnumValue(datadogV1.NewSyntheticsAssertionTypeFromValue, datadogV1.NewSyntheticsAssertionBodyHashTypeFromValue),
 					Required:         true,
 				},
 				"operator": {
@@ -2595,6 +2595,17 @@ func buildLocalAssertions(actualAssertions []datadogV1.SyntheticsAssertion) (loc
 			if v, ok := assertionTarget.GetTypeOk(); ok {
 				localAssertion["type"] = string(*v)
 			}
+		} else if assertion.SyntheticsAssertionBodyHashTarget != nil {
+			assertionTarget := assertion.SyntheticsAssertionBodyHashTarget
+			if v, ok := assertionTarget.GetOperatorOk(); ok {
+				localAssertion["operator"] = string(*v)
+			}
+			if target := assertionTarget.GetTarget(); target != nil {
+				localAssertion["target"] = convertToString(target)
+			}
+			if v, ok := assertionTarget.GetTypeOk(); ok {
+				localAssertion["type"] = string(*v)
+			}
 		}
 		localAssertions[i] = localAssertion
 	}
@@ -3395,11 +3406,12 @@ func validateSyntheticsAssertionOperator(val interface{}, key string) (warns []s
 	if err != nil {
 		_, err2 := datadogV1.NewSyntheticsAssertionJSONPathOperatorFromValue(val.(string))
 		_, err3 := datadogV1.NewSyntheticsAssertionXPathOperatorFromValue(val.(string))
+		_, err4 := datadogV1.NewSyntheticsAssertionBodyHashOperatorFromValue(val.(string))
 
-		if err2 == nil || err3 == nil {
+		if err2 == nil || err3 == nil || err4 == nil {
 			return
 		} else {
-			errs = append(errs, err, err2)
+			errs = append(errs, err, err2, err3, err4)
 		}
 	}
 	return

diff --git a/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_Basic.freeze b/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_Basic.freeze
@@ -1 +1 @@
-2024-05-03T15:38:42.643125-04:00
+2024-06-11T09:12:35.53009-04:00
diff --git a/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_Basic.yaml b/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_Basic.yaml
diff --git a/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_BasicNewAssertionsOptions.freeze b/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_BasicNewAssertionsOptions.freeze
@@ -1 +1 @@
-2024-05-03T15:38:42.643126-04:00
+2024-06-11T09:12:35.529963-04:00
diff --git a/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_BasicNewAssertionsOptions.yaml b/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_BasicNewAssertionsOptions.yaml
diff --git a/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_Updated.freeze b/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_Updated.freeze
@@ -1 +1 @@
-2024-05-03T15:38:31.296513-04:00
+2024-06-11T09:12:49.827629-04:00
diff --git a/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_Updated.yaml b/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_Updated.yaml
diff --git a/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_UpdatedNewAssertionsOptions.freeze b/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_UpdatedNewAssertionsOptions.freeze
@@ -1 +1 @@
-2024-05-03T15:38:31.296496-04:00
+2024-06-11T09:12:49.828853-04:00
diff --git a/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_UpdatedNewAssertionsOptions.yaml b/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_UpdatedNewAssertionsOptions.yaml
diff --git a/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_importBasic.freeze b/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_importBasic.freeze
@@ -1 +1 @@
-2024-05-03T15:37:58.818744-04:00
+2024-06-10T16:49:39.132063-04:00
diff --git a/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_importBasic.yaml b/datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_importBasic.yaml
diff --git a/datadog/tests/resource_datadog_synthetics_test_test.go b/datadog/tests/resource_datadog_synthetics_test_test.go
@@ -30,6 +30,10 @@ func TestAccDatadogSyntheticsAPITest_importBasic(t *testing.T) {
 		Steps: []resource.TestStep{
 			{
 				Config: createSyntheticsAPITestConfig(testName, variableName),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(
+						"datadog_synthetics_test.foo", "assertion.4.operator", "md5"),
+				),
 			},
 			{
 				ResourceName:      "datadog_synthetics_test.foo",
@@ -730,7 +734,7 @@ func createSyntheticsAPITestStep(ctx context.Context, accProvider func() (*schem
 			resource.TestCheckResourceAttr(
 				"datadog_synthetics_test.foo", "variables_from_script", "dd.variable.set('FOO', 'hello');"),
 			resource.TestCheckResourceAttr(
-				"datadog_synthetics_test.foo", "assertion.#", "4"),
+				"datadog_synthetics_test.foo", "assertion.#", "5"),
 			resource.TestCheckResourceAttr(
 				"datadog_synthetics_test.foo", "assertion.0.type", "header"),
 			resource.TestCheckResourceAttr(
@@ -884,7 +888,11 @@ resource "datadog_synthetics_test" "foo" {
 		operator = "doesNotContain"
 		target = "terraform"
 	}
-
+	assertion {
+		type = "bodyHash"
+		operator = "md5"
+		target = "a"
+	}
 	locations = [ "aws:eu-central-1" ]
 
 	options_list {

diff --git a/docs/resources/synthetics_test.md b/docs/resources/synthetics_test.md
@@ -476,7 +476,7 @@ Optional:
 Required:
 
 - `operator` (String) Assertion operator. **Note** Only some combinations of `type` and `operator` are valid (please refer to [Datadog documentation](https://docs.datadoghq.com/api/latest/synthetics/#create-a-test)).
-- `type` (String) Type of assertion. **Note** Only some combinations of `type` and `operator` are valid (please refer to [Datadog documentation](https://docs.datadoghq.com/api/latest/synthetics/#create-a-test)). Valid values are `body`, `header`, `statusCode`, `certificate`, `responseTime`, `property`, `recordEvery`, `recordSome`, `tlsVersion`, `minTlsVersion`, `latency`, `packetLossPercentage`, `packetsReceived`, `networkHop`, `receivedMessage`, `grpcHealthcheckStatus`, `grpcMetadata`, `grpcProto`, `connection`.
+- `type` (String) Type of assertion. **Note** Only some combinations of `type` and `operator` are valid (please refer to [Datadog documentation](https://docs.datadoghq.com/api/latest/synthetics/#create-a-test)). Valid values are `body`, `header`, `statusCode`, `certificate`, `responseTime`, `property`, `recordEvery`, `recordSome`, `tlsVersion`, `minTlsVersion`, `latency`, `packetLossPercentage`, `packetsReceived`, `networkHop`, `receivedMessage`, `grpcHealthcheckStatus`, `grpcMetadata`, `grpcProto`, `connection`, `bodyHash`.
 
 Optional:
 
@@ -673,7 +673,7 @@ Optional:
 Required:
 
 - `operator` (String) Assertion operator. **Note** Only some combinations of `type` and `operator` are valid (please refer to [Datadog documentation](https://docs.datadoghq.com/api/latest/synthetics/#create-a-test)).
-- `type` (String) Type of assertion. **Note** Only some combinations of `type` and `operator` are valid (please refer to [Datadog documentation](https://docs.datadoghq.com/api/latest/synthetics/#create-a-test)). Valid values are `body`, `header`, `statusCode`, `certificate`, `responseTime`, `property`, `recordEvery`, `recordSome`, `tlsVersion`, `minTlsVersion`, `latency`, `packetLossPercentage`, `packetsReceived`, `networkHop`, `receivedMessage`, `grpcHealthcheckStatus`, `grpcMetadata`, `grpcProto`, `connection`.
+- `type` (String) Type of assertion. **Note** Only some combinations of `type` and `operator` are valid (please refer to [Datadog documentation](https://docs.datadoghq.com/api/latest/synthetics/#create-a-test)). Valid values are `body`, `header`, `statusCode`, `certificate`, `responseTime`, `property`, `recordEvery`, `recordSome`, `tlsVersion`, `minTlsVersion`, `latency`, `packetLossPercentage`, `packetsReceived`, `networkHop`, `receivedMessage`, `grpcHealthcheckStatus`, `grpcMetadata`, `grpcProto`, `connection`, `bodyHash`.
 
 Optional:
 

diff --git a/go.mod b/go.mod
@@ -1,7 +1,7 @@
 module github.com/terraform-providers/terraform-provider-datadog
 
 require (
-	github.com/DataDog/datadog-api-client-go/v2 v2.26.1-0.20240607153051-dcbfc17c9179
+	github.com/DataDog/datadog-api-client-go/v2 v2.26.1-0.20240610185644-7125535457c2
 	github.com/DataDog/dd-sdk-go-testing v0.0.0-20211116174033-1cd082e322ad
 	github.com/google/uuid v1.5.0
 	github.com/hashicorp/go-cleanhttp v0.5.2

diff --git a/go.sum b/go.sum
@@ -1,7 +1,7 @@
 cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
-github.com/DataDog/datadog-api-client-go/v2 v2.26.1-0.20240607153051-dcbfc17c9179 h1:1JhH7F3V89jun91SgR0LwpR+ExyML4lOgG5zb4ggo/I=
-github.com/DataDog/datadog-api-client-go/v2 v2.26.1-0.20240607153051-dcbfc17c9179/go.mod h1:QKOu6vscsh87fMY1lHfLEmNSunyXImj8BUaUWJXOehc=
+github.com/DataDog/datadog-api-client-go/v2 v2.26.1-0.20240610185644-7125535457c2 h1:MiYvP649Bbpd9sr2KWhgcRqA45erNJAHHh4smfDobos=
+github.com/DataDog/datadog-api-client-go/v2 v2.26.1-0.20240610185644-7125535457c2/go.mod h1:QKOu6vscsh87fMY1lHfLEmNSunyXImj8BUaUWJXOehc=
 github.com/DataDog/datadog-go v4.4.0+incompatible/go.mod h1:LButxg5PwREeZtORoXG3tL4fMGNddJ+vMq1mwgfaqoQ=
 github.com/DataDog/datadog-go v4.8.3+incompatible h1:fNGaYSuObuQb5nzeTQqowRAd9bpDIRRV4/gUtIBjh8Q=
 github.com/DataDog/datadog-go v4.8.3+incompatible/go.mod h1:LButxg5PwREeZtORoXG3tL4fMGNddJ+vMq1mwgfaqoQ=
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		2024-05-03T15:38:42.643125-04:00
		2024-06-11T09:12:35.53009-04:00
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		2024-05-03T15:38:42.643126-04:00
		2024-06-11T09:12:35.529963-04:00
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		2024-05-03T15:38:31.296513-04:00
		2024-06-11T09:12:49.827629-04:00
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		2024-05-03T15:38:31.296496-04:00
		2024-06-11T09:12:49.828853-04:00
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		2024-05-03T15:37:58.818744-04:00
		2024-06-10T16:49:39.132063-04:00