[datadog_spans_metric] Fix validation with unintended side effects (#2983)

* [datadog_spans_metric] Remove validation that breaks declaration using a dynamic block

* [datadog_spans_metric] Added tests for dynamic declaration of group_by

* [datadog_spans_metric] Modified validation to avoid dynamic blocks breaking and changed tests accordignly

* [datadog_spans_metric] (NIT) Added back the interface implementation check

Author: Supam

datadog/fwprovider/resource_datadog_spans_metric.go

@@ -6,6 +6,7 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
 	"github.com/hashicorp/terraform-plugin-framework-validators/objectvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/path"
 	frameworkPath "github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
@@ -146,6 +147,26 @@ func (r *spansMetricResource) Schema(_ context.Context, _ resource.SchemaRequest
 		},
 	}
 }
+func (r *spansMetricResource) ValidateConfig(ctx context.Context, req resource.ValidateConfigRequest, resp *resource.ValidateConfigResponse) {
+	var data computeModel
+	resp.Diagnostics.Append(req.Config.GetAttribute(ctx, path.Root("compute"), &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	if data.IncludePercentiles.IsNull() || data.IncludePercentiles.IsUnknown() {
+		return
+	}
+
+	if data.AggregationType.ValueString() != "distribution" && !data.IncludePercentiles.IsUnknown() {
+		resp.Diagnostics.AddAttributeError(
+			frameworkPath.Root("compute").AtName("include_percentiles"),
+			"Invalid configuration",
+			"include_percentiles can only be set when aggregation_type is 'distribution'",
+		)
+	}
+}
 
 type includePercentilesUnknownSuppressor struct{}
 
@@ -174,27 +195,6 @@ func (m includePercentilesUnknownSuppressor) PlanModifyBool(ctx context.Context,
 	}
 }
 
-func (r *spansMetricResource) ValidateConfig(ctx context.Context, req resource.ValidateConfigRequest, resp *resource.ValidateConfigResponse) {
-	var data spansMetricModel
-	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
-
-	if resp.Diagnostics.HasError() {
-		return
-	}
-
-	if data.Compute.IncludePercentiles.IsNull() || data.Compute.IncludePercentiles.IsUnknown() {
-		return
-	}
-
-	if data.Compute.AggregationType.ValueString() != "distribution" && !data.Compute.IncludePercentiles.IsUnknown() {
-		resp.Diagnostics.AddAttributeError(
-			frameworkPath.Root("compute").AtName("include_percentiles"),
-			"Invalid configuration",
-			"include_percentiles can only be set when aggregation_type is 'distribution'",
-		)
-	}
-}
-
 func (r *spansMetricResource) ImportState(ctx context.Context, request resource.ImportStateRequest, response *resource.ImportStateResponse) {
 	resource.ImportStatePassthroughID(ctx, frameworkPath.Root("id"), request, response)
 }

datadog/tests/cassettes/TestAccSpansMetricBasic.freeze

@@ -1 +1 @@
-2025-02-03T11:56:40.519271+01:00
+2025-04-29T15:35:17.293466+02:00

datadog/tests/cassettes/TestAccSpansMetricBasic.yaml

@@ -13,7 +13,7 @@ interactions:
         remote_addr: ""
         request_uri: ""
         body: |
-            {"data":{"attributes":{"compute":{"aggregation_type":"distribution","include_percentiles":false,"path":"@duration"},"filter":{"query":"@http.status_code:200 service:my-service"},"group_by":[{"path":"resource_name","tag_name":"resource_name"}]},"id":"\"tf_TestAccSpansMetricBasic_local_1738580200\"","type":"spans_metrics"}}
+            {"data":{"attributes":{"compute":{"aggregation_type":"distribution","include_percentiles":false,"path":"@duration"},"filter":{"query":"@http.status_code:200 service:my-service"},"group_by":[{"path":"resource_name","tag_name":"resource_name"}]},"id":"\"tf_TestAccSpansMetricBasic_local_1745933717\"","type":"spans_metrics"}}
         form: {}
         headers:
             Accept:
@@ -23,21 +23,22 @@ interactions:
         url: https://api.datadoghq.com/api/v2/apm/config/metrics
         method: POST
       response:
-        proto: HTTP/2.0
-        proto_major: 2
-        proto_minor: 0
-        transfer_encoding: []
+        proto: HTTP/1.1
+        proto_major: 1
+        proto_minor: 1
+        transfer_encoding:
+            - chunked
         trailer: {}
         content_length: -1
         uncompressed: true
         body: |
-            {"data":{"id":"tf_TestAccSpansMetricBasic_local_1738580200","attributes":{"filter":{"query":"@http.status_code:200 service:my-service"},"group_by":[{"path":"resource_name","tag_name":"resource_name"}],"compute":{"aggregation_type":"distribution","path":"@duration","include_percentiles":false}},"type":"spans_metrics"}}
+            {"data":{"id":"tf_TestAccSpansMetricBasic_local_1745933717","attributes":{"filter":{"query":"@http.status_code:200 service:my-service"},"group_by":[{"path":"resource_name","tag_name":"resource_name"}],"compute":{"aggregation_type":"distribution","path":"@duration","include_percentiles":false}},"type":"spans_metrics"}}
         headers:
             Content-Type:
                 - application/json
         status: 200 OK
         code: 200
-        duration: 448.400417ms
+        duration: 759.568708ms
     - id: 1
       request:
         proto: HTTP/1.1
@@ -54,24 +55,25 @@ interactions:
         headers:
             Accept:
                 - application/json
-        url: https://api.datadoghq.com/api/v2/apm/config/metrics/tf_TestAccSpansMetricBasic_local_1738580200
+        url: https://api.datadoghq.com/api/v2/apm/config/metrics/tf_TestAccSpansMetricBasic_local_1745933717
         method: GET
       response:
-        proto: HTTP/2.0
-        proto_major: 2
-        proto_minor: 0
-        transfer_encoding: []
+        proto: HTTP/1.1
+        proto_major: 1
+        proto_minor: 1
+        transfer_encoding:
+            - chunked
         trailer: {}
         content_length: -1
         uncompressed: true
         body: |
-            {"data":{"id":"tf_TestAccSpansMetricBasic_local_1738580200","attributes":{"filter":{"query":"@http.status_code:200 service:my-service"},"group_by":[{"path":"resource_name","tag_name":"resource_name"}],"compute":{"aggregation_type":"distribution","path":"@duration","include_percentiles":false}},"type":"spans_metrics"}}
+            {"data":{"id":"tf_TestAccSpansMetricBasic_local_1745933717","attributes":{"filter":{"query":"@http.status_code:200 service:my-service"},"group_by":[{"path":"resource_name","tag_name":"resource_name"}],"compute":{"aggregation_type":"distribution","path":"@duration","include_percentiles":false}},"type":"spans_metrics"}}
         headers:
             Content-Type:
                 - application/json
         status: 200 OK
         code: 200
-        duration: 122.608334ms
+        duration: 129.931958ms
     - id: 2
       request:
         proto: HTTP/1.1
@@ -88,24 +90,25 @@ interactions:
         headers:
             Accept:
                 - application/json
-        url: https://api.datadoghq.com/api/v2/apm/config/metrics/tf_TestAccSpansMetricBasic_local_1738580200
+        url: https://api.datadoghq.com/api/v2/apm/config/metrics/tf_TestAccSpansMetricBasic_local_1745933717
         method: GET
       response:
-        proto: HTTP/2.0
-        proto_major: 2
-        proto_minor: 0
-        transfer_encoding: []
+        proto: HTTP/1.1
+        proto_major: 1
+        proto_minor: 1
+        transfer_encoding:
+            - chunked
         trailer: {}
         content_length: -1
         uncompressed: true
         body: |
-            {"data":{"id":"tf_TestAccSpansMetricBasic_local_1738580200","attributes":{"filter":{"query":"@http.status_code:200 service:my-service"},"group_by":[{"path":"resource_name","tag_name":"resource_name"}],"compute":{"aggregation_type":"distribution","path":"@duration","include_percentiles":false}},"type":"spans_metrics"}}
+            {"data":{"id":"tf_TestAccSpansMetricBasic_local_1745933717","attributes":{"filter":{"query":"@http.status_code:200 service:my-service"},"group_by":[{"path":"resource_name","tag_name":"resource_name"}],"compute":{"aggregation_type":"distribution","path":"@duration","include_percentiles":false}},"type":"spans_metrics"}}
         headers:
             Content-Type:
                 - application/json
         status: 200 OK
         code: 200
-        duration: 129.687125ms
+        duration: 132.424417ms
     - id: 3
       request:
         proto: HTTP/1.1
@@ -125,24 +128,25 @@ interactions:
                 - application/json
             Content-Type:
                 - application/json
-        url: https://api.datadoghq.com/api/v2/apm/config/metrics/tf_TestAccSpansMetricBasic_local_1738580200
+        url: https://api.datadoghq.com/api/v2/apm/config/metrics/tf_TestAccSpansMetricBasic_local_1745933717
         method: PATCH
       response:
-        proto: HTTP/2.0
-        proto_major: 2
-        proto_minor: 0
-        transfer_encoding: []
+        proto: HTTP/1.1
+        proto_major: 1
+        proto_minor: 1
+        transfer_encoding:
+            - chunked
         trailer: {}
         content_length: -1
         uncompressed: true
         body: |
-            {"data":{"id":"tf_TestAccSpansMetricBasic_local_1738580200","attributes":{"filter":{"query":"*"},"group_by":[],"compute":{"aggregation_type":"distribution","path":"@duration","include_percentiles":true}},"type":"spans_metrics"}}
+            {"data":{"id":"tf_TestAccSpansMetricBasic_local_1745933717","attributes":{"filter":{"query":"*"},"group_by":[],"compute":{"aggregation_type":"distribution","path":"@duration","include_percentiles":true}},"type":"spans_metrics"}}
         headers:
             Content-Type:
                 - application/json
         status: 200 OK
         code: 200
-        duration: 236.091042ms
+        duration: 268.373708ms
     - id: 4
       request:
         proto: HTTP/1.1
@@ -159,24 +163,25 @@ interactions:
         headers:
             Accept:
                 - application/json
-        url: https://api.datadoghq.com/api/v2/apm/config/metrics/tf_TestAccSpansMetricBasic_local_1738580200
+        url: https://api.datadoghq.com/api/v2/apm/config/metrics/tf_TestAccSpansMetricBasic_local_1745933717
         method: GET
       response:
-        proto: HTTP/2.0
-        proto_major: 2
-        proto_minor: 0
-        transfer_encoding: []
+        proto: HTTP/1.1
+        proto_major: 1
+        proto_minor: 1
+        transfer_encoding:
+            - chunked
         trailer: {}
         content_length: -1
         uncompressed: true
         body: |
-            {"data":{"id":"tf_TestAccSpansMetricBasic_local_1738580200","attributes":{"filter":{"query":"*"},"group_by":[],"compute":{"aggregation_type":"distribution","path":"@duration","include_percentiles":true}},"type":"spans_metrics"}}
+            {"data":{"id":"tf_TestAccSpansMetricBasic_local_1745933717","attributes":{"filter":{"query":"*"},"group_by":[],"compute":{"aggregation_type":"distribution","path":"@duration","include_percentiles":true}},"type":"spans_metrics"}}
         headers:
             Content-Type:
                 - application/json
         status: 200 OK
         code: 200
-        duration: 124.605ms
+        duration: 139.312791ms
     - id: 5
       request:
         proto: HTTP/1.1
@@ -193,12 +198,12 @@ interactions:
         headers:
             Accept:
                 - '*/*'
-        url: https://api.datadoghq.com/api/v2/apm/config/metrics/tf_TestAccSpansMetricBasic_local_1738580200
+        url: https://api.datadoghq.com/api/v2/apm/config/metrics/tf_TestAccSpansMetricBasic_local_1745933717
         method: DELETE
       response:
-        proto: HTTP/2.0
-        proto_major: 2
-        proto_minor: 0
+        proto: HTTP/1.1
+        proto_major: 1
+        proto_minor: 1
         transfer_encoding: []
         trailer: {}
         content_length: 0
@@ -209,4 +214,4 @@ interactions:
                 - text/html; charset=utf-8
         status: 204 No Content
         code: 204
-        duration: 146.191333ms
+        duration: 156.094541ms

datadog/tests/cassettes/TestAccSpansMetricDynamicGroupBys_empty.freeze

@@ -0,0 +1 @@
+2025-04-24T15:39:59.557799+02:00

datadog/tests/cassettes/TestAccSpansMetricDynamicGroupBys_empty.yaml

@@ -0,0 +1,109 @@
+---
+version: 2
+interactions:
+    - id: 0
+      request:
+        proto: HTTP/1.1
+        proto_major: 1
+        proto_minor: 1
+        content_length: 221
+        transfer_encoding: []
+        trailer: {}
+        host: api.datadoghq.com
+        remote_addr: ""
+        request_uri: ""
+        body: |
+            {"data":{"attributes":{"compute":{"aggregation_type":"count"},"filter":{"query":"@http.status_code:200 service:my-service"}},"id":"\"tf_TestAccSpansMetricDynamicGroupBys_empty_local_1745501999\"","type":"spans_metrics"}}
+        form: {}
+        headers:
+            Accept:
+                - application/json
+            Content-Type:
+                - application/json
+        url: https://api.datadoghq.com/api/v2/apm/config/metrics
+        method: POST
+      response:
+        proto: HTTP/1.1
+        proto_major: 1
+        proto_minor: 1
+        transfer_encoding:
+            - chunked
+        trailer: {}
+        content_length: -1
+        uncompressed: true
+        body: |
+            {"data":{"id":"tf_TestAccSpansMetricDynamicGroupBys_empty_local_1745501999","attributes":{"filter":{"query":"@http.status_code:200 service:my-service"},"group_by":[],"compute":{"aggregation_type":"count"}},"type":"spans_metrics"}}
+        headers:
+            Content-Type:
+                - application/json
+        status: 200 OK
+        code: 200
+        duration: 732.442167ms
+    - id: 1
+      request:
+        proto: HTTP/1.1
+        proto_major: 1
+        proto_minor: 1
+        content_length: 0
+        transfer_encoding: []
+        trailer: {}
+        host: api.datadoghq.com
+        remote_addr: ""
+        request_uri: ""
+        body: ""
+        form: {}
+        headers:
+            Accept:
+                - application/json
+        url: https://api.datadoghq.com/api/v2/apm/config/metrics/tf_TestAccSpansMetricDynamicGroupBys_empty_local_1745501999
+        method: GET
+      response:
+        proto: HTTP/1.1
+        proto_major: 1
+        proto_minor: 1
+        transfer_encoding:
+            - chunked
+        trailer: {}
+        content_length: -1
+        uncompressed: true
+        body: |
+            {"data":{"id":"tf_TestAccSpansMetricDynamicGroupBys_empty_local_1745501999","attributes":{"filter":{"query":"@http.status_code:200 service:my-service"},"group_by":[],"compute":{"aggregation_type":"count"}},"type":"spans_metrics"}}
+        headers:
+            Content-Type:
+                - application/json
+        status: 200 OK
+        code: 200
+        duration: 156.014542ms
+    - id: 2
+      request:
+        proto: HTTP/1.1
+        proto_major: 1
+        proto_minor: 1
+        content_length: 0
+        transfer_encoding: []
+        trailer: {}
+        host: api.datadoghq.com
+        remote_addr: ""
+        request_uri: ""
+        body: ""
+        form: {}
+        headers:
+            Accept:
+                - '*/*'
+        url: https://api.datadoghq.com/api/v2/apm/config/metrics/tf_TestAccSpansMetricDynamicGroupBys_empty_local_1745501999
+        method: DELETE
+      response:
+        proto: HTTP/1.1
+        proto_major: 1
+        proto_minor: 1
+        transfer_encoding: []
+        trailer: {}
+        content_length: 0
+        uncompressed: false
+        body: ""
+        headers:
+            Content-Type:
+                - text/html; charset=utf-8
+        status: 204 No Content
+        code: 204
+        duration: 153.784667ms

datadog/tests/cassettes/TestAccSpansMetricDynamicGroupBys_populated.freeze

@@ -0,0 +1 @@
+2025-04-24T15:39:59.557929+02:00