fix: validate resource_type with warning instead of error

Author: estellesoulard

internal/services/audittrail/event_data_source.go

@@ -5,6 +5,7 @@ import (
 	"strconv"
 
 	"github.com/google/uuid"
+	"github.com/hashicorp/go-cty/cty"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	audittrailSDK "github.com/scaleway/scaleway-sdk-go/api/audit_trail/v1alpha1"
@@ -32,10 +33,19 @@ func DataSourceEvent() *schema.Resource {
 				ValidateDiagFunc: verify.IsUUID(),
 			},
 			"resource_type": {
-				Type:             schema.TypeString,
-				Description:      "Type of the scaleway resources associated with the listed events",
-				Optional:         true,
-				ValidateDiagFunc: verify.ValidateEnum[audittrailSDK.ResourceType](),
+				Type:        schema.TypeString,
+				Description: "Type of the scaleway resources associated with the listed events",
+				Optional:    true,
+				ValidateDiagFunc: func(i any, p cty.Path) diag.Diagnostics {
+					resourceTypeValues := audittrailSDK.ResourceType("").Values()
+
+					resourceTypeStringValues := make([]string, 0, len(resourceTypeValues))
+					for _, resourceTypeValue := range resourceTypeValues {
+						resourceTypeStringValues = append(resourceTypeStringValues, resourceTypeValue.String())
+					}
+
+					return verify.ValidateStringInSliceWithWarning(resourceTypeStringValues, "resourceType")(i, p)
+				},
 			},
 			"resource_id": {
 				Type:             schema.TypeString,

internal/services/audittrail/event_data_source_test.go

@@ -2,6 +2,7 @@ package audittrail_test
 
 import (
 	"fmt"
+	"regexp"
 	"testing"
 
 	"github.com/google/uuid"
@@ -139,3 +140,37 @@ func TestAccDataSourceEvent_Basic(t *testing.T) {
 		},
 	})
 }
+
+func TestAccDataSourceEvent_Warning(t *testing.T) {
+	// Test that a resource_type that is not yet supported on the
+	// provider only raises a warning before calling the API
+	// anyway (it could exist on API side)
+
+	// NOTE: Currently, we cannot programmatically assert that a warning was emitted
+	// during the test step. This needs support from the testing framework:
+	// https://github.com/hashicorp/terraform-plugin-testing/issues/69
+	// Once implemented, we should add a check like:
+	//   ExpectWarning: regexp.MustCompile(`expected resourceType to be one of [\"unknown_type\" \"secm_secret\" \"secm_secret_version\" \"kube_cluster\" \"kube_pool\" \"kube_node\" \"kube_acl\" \"keym_key\" \"iam_user\" \"iam_application\" \"iam_group\" \"iam_policy\" \"iam_api_key\" \"iam_ssh_key\" \"iam_rule\" \"iam_saml\" \"iam_saml_certificate\" \"secret_manager_secret\" \"secret_manager_version\" \"key_manager_key\" \"account_user\" \"account_organization\" \"account_project\" \"instance_server\" \"instance_placement_group\" \"instance_security_group\" \"instance_volume\" \"instance_snapshot\" \"instance_image\" \"apple_silicon_server\" \"baremetal_server\" \"baremetal_setting\" \"ipam_ip\" \"sbs_volume\" \"sbs_snapshot\" \"load_balancer_lb\" \"load_balancer_ip\" \"load_balancer_frontend\" \"load_balancer_backend\" \"load_balancer_route\" \"load_balancer_acl\" \"load_balancer_certificate\" \"sfs_filesystem\" \"vpc_private_network\"], got a_new_resource_type`)
+	tt := acctest.NewTestTools(t)
+	defer tt.Cleanup()
+
+	resource.ParallelTest(t, resource.TestCase{
+		ProtoV6ProviderFactories: tt.ProviderFactories,
+		CheckDestroy:             testAccCheckSecretDestroy(tt),
+		Steps: []resource.TestStep{
+			{
+				Config: `
+					data "scaleway_audit_trail_event" "unknown_resource_type" {
+						resource_type = "a_new_resource_type"
+					}
+				`,
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("data.scaleway_audit_trail_event.unknown_resource_type", "events.#", "0"),
+				),
+				// In this test, we still expect a 400 from the API since `a_new_resource_type`
+				// does not actually exist on API side.
+				ExpectError: regexp.MustCompile(`400 Bad Request`),
+			},
+		},
+	})
+}

internal/services/audittrail/helpers_test.go

@@ -2,6 +2,7 @@ package audittrail_test
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"testing"
 	"time"
@@ -55,9 +56,8 @@ func waitForAuditTrailEvents(t *testing.T, ctx context.Context, api *audit_trail
 		}
 
 		// Not found yet
-		return retry.RetryableError(fmt.Errorf("audit event not found yet for resource, retrying..."))
+		return retry.RetryableError(errors.New("audit event not found yet for resource, retrying..."))
 	})
-
 	if err != nil {
 		t.Fatalf("timed out waiting for audit trail event: %v", err)
 	}