Merge pull request #44491 from hashicorp/b-datazone-project-sweeper

`datazone` fixes

Author: gdavison

.changelog/44491.txt

@@ -0,0 +1,39 @@
+```release-note:bug
+resource/aws_datazone_environment: Prevents `unknown value` error when optional `account_identifier` is not specified.
+```
+
+```release-note:bug
+resource/aws_datazone_environment: Prevents `unknown value` error when optional `account_region` is not specified.
+```
+
+```release-note:bug
+resource/aws_datazone_environment: Properly passes `blueprint_identifier` on creation.
+```
+
+```release-note:bug
+resource/aws_datazone_environment: Prevents error when updating.
+```
+
+```release-note:bug
+resource/aws_datazone_environment: Prevents occasional `unexpected state` error when deleting.
+```
+
+```release-note:bug
+resource/aws_datazone_environment: Sets values for `user_parameters` when importing.
+```
+
+```release-note:bug
+resource/aws_datazone_environment: Values in `user_parameters` should not be updateable.
+```
+
+```release-note:bug
+resource/aws_datazone_environment: Correctly updates `glossary_terms`.
+```
+
+```release-note:bug
+resource/aws_datazone_project: No longer ignores errors when deleting.
+```
+
+```release-note:bug
+resource/aws_datazone_project: No longer returns error when already deleting.
+```

internal/service/datazone/asset_type_test.go

@@ -31,8 +31,6 @@ func TestAccDataZoneAssetType_basic(t *testing.T) {
 
 	var assettype datazone.GetAssetTypeOutput
 	rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
-	pName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
-	dName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
 	resourceName := "aws_datazone_asset_type.test"
 	projectName := "aws_datazone_project.test"
 	domainName := "aws_datazone_domain.test"
@@ -48,7 +46,7 @@ func TestAccDataZoneAssetType_basic(t *testing.T) {
 		CheckDestroy:             testAccCheckAssetTypeDestroy(ctx),
 		Steps: []resource.TestStep{
 			{
-				Config: testAccAssetTypeConfig_basic(rName, pName, dName),
+				Config: testAccAssetTypeConfig_basic(rName),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckAssetTypeExists(ctx, resourceName, &assettype),
 					resource.TestCheckResourceAttrSet(resourceName, names.AttrCreatedAt),
@@ -79,8 +77,6 @@ func TestAccDataZoneAssetType_disappears(t *testing.T) {
 
 	var assettype datazone.GetAssetTypeOutput
 	rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
-	pName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
-	dName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
 	resourceName := "aws_datazone_asset_type.test"
 
 	resource.ParallelTest(t, resource.TestCase{
@@ -94,7 +90,7 @@ func TestAccDataZoneAssetType_disappears(t *testing.T) {
 		CheckDestroy:             testAccCheckAssetTypeDestroy(ctx),
 		Steps: []resource.TestStep{
 			{
-				Config: testAccAssetTypeConfig_basic(rName, pName, dName),
+				Config: testAccAssetTypeConfig_basic(rName),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckAssetTypeExists(ctx, resourceName, &assettype),
 					acctest.CheckFrameworkResourceDisappears(ctx, acctest.Provider, tfdatazone.ResourceAssetType, resourceName),
@@ -164,8 +160,8 @@ func testAccAssetTypeImportStateIdFunc(resourceName string) resource.ImportState
 	}
 }
 
-func testAccAssetTypeConfig_basic(rName, pName, dName string) string {
-	return acctest.ConfigCompose(testAccProjectConfig_basic(pName, dName), fmt.Sprintf(`
+func testAccAssetTypeConfig_basic(rName string) string {
+	return acctest.ConfigCompose(testAccProjectConfig_basic(rName), fmt.Sprintf(`
 resource "aws_datazone_asset_type" "test" {
   description               = %[1]q
   domain_identifier         = aws_datazone_domain.test.id

internal/service/datazone/datazone_test.go

@@ -15,6 +15,7 @@ import (
 	awstypes "github.com/aws/aws-sdk-go-v2/service/datazone/types"
 	"github.com/hashicorp/terraform-plugin-framework-timeouts/resource/timeouts"
 	"github.com/hashicorp/terraform-plugin-framework-timetypes/timetypes"
+	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
@@ -142,6 +143,7 @@ func (r *environmentResource) Schema(ctx context.Context, req resource.SchemaReq
 				CustomType: fwtypes.NewListNestedObjectTypeOf[resourceUserParametersData](ctx),
 				PlanModifiers: []planmodifier.List{
 					listplanmodifier.UseStateForUnknown(),
+					listplanmodifier.RequiresReplace(),
 				},
 				NestedObject: schema.NestedBlockObject{
 					Attributes: map[string]schema.Attribute{
@@ -219,7 +221,7 @@ func (r *environmentResource) Create(ctx context.Context, req resource.CreateReq
 		return
 	}
 
-	resp.Diagnostics.Append(fwflex.Flatten(ctx, output, &state, fwflex.WithIgnoredFieldNames([]string{"UserParameters"}))...)
+	flattenEnvironment(ctx, output, &state, &resp.Diagnostics)
 	if resp.Diagnostics.HasError() {
 		return
 	}
@@ -252,21 +254,14 @@ func (r *environmentResource) Read(ctx context.Context, req resource.ReadRequest
 		return
 	}
 
-	resp.Diagnostics.Append(fwflex.Flatten(ctx, out, &state, fwflex.WithIgnoredFieldNamesAppend("UserParameters"),
-		fwflex.WithFieldNamePrefix("Environment"),
-	)...)
-
+	flattenEnvironment(ctx, out, &state, &resp.Diagnostics)
 	if resp.Diagnostics.HasError() {
 		return
 	}
 
-	state.AccountIdentifier = fwflex.StringToFramework(ctx, out.AwsAccountId)
-	state.AccountRegion = fwflex.StringToFramework(ctx, out.AwsAccountRegion)
-	state.ProjectIdentifier = fwflex.StringToFramework(ctx, out.ProjectId)
-	state.ProfileIdentifier = fwflex.StringToFramework(ctx, out.EnvironmentProfileId)
-
 	resp.Diagnostics.Append(resp.State.Set(ctx, &state)...)
 }
+
 func (r *environmentResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
 	conn := r.Meta().DataZoneClient(ctx)
 
@@ -277,18 +272,35 @@ func (r *environmentResource) Update(ctx context.Context, req resource.UpdateReq
 		return
 	}
 
-	if !plan.Name.Equal(state.Name) ||
-		!plan.Description.Equal(state.Description) ||
-		!plan.GlossaryTerms.Equal(state.GlossaryTerms) {
-		in := &datazone.UpdateEnvironmentInput{}
-		resp.Diagnostics.Append(fwflex.Expand(ctx, plan, in)...)
+	var (
+		needsUpdate bool
+	)
+	input := datazone.UpdateEnvironmentInput{
+		DomainIdentifier: plan.DomainIdentifier.ValueStringPointer(),
+		Identifier:       plan.Id.ValueStringPointer(),
+	}
+
+	if !plan.Name.Equal(state.Name) {
+		needsUpdate = true
+		input.Name = plan.Name.ValueStringPointer()
+	}
 
-		if resp.Diagnostics.HasError() {
+	if !plan.Description.Equal(state.Description) {
+		needsUpdate = true
+		input.Description = plan.Description.ValueStringPointer()
+	}
+
+	if !plan.GlossaryTerms.Equal(state.GlossaryTerms) {
+		needsUpdate = true
+		d := fwflex.Expand(ctx, &plan.GlossaryTerms, &input.GlossaryTerms)
+		resp.Diagnostics.Append(d...)
+		if d.HasError() {
 			return
 		}
-		in.Identifier = state.Id.ValueStringPointer()
+	}
 
-		out, err := conn.UpdateEnvironment(ctx, in)
+	if needsUpdate {
+		out, err := conn.UpdateEnvironment(ctx, &input)
 		if err != nil {
 			resp.Diagnostics.AddError(
 				create.ProblemStandardMessage(names.DataZone, create.ErrActionUpdating, ResNameEnvironment, plan.Id.String(), err),
@@ -306,7 +318,7 @@ func (r *environmentResource) Update(ctx context.Context, req resource.UpdateReq
 		}
 
 		updateTimeout := r.UpdateTimeout(ctx, plan.Timeouts)
-		_, err = waitEnvironmentUpdated(ctx, conn, plan.DomainIdentifier.ValueString(), plan.Id.ValueString(), updateTimeout)
+		output, err := waitEnvironmentUpdated(ctx, conn, plan.DomainIdentifier.ValueString(), plan.Id.ValueString(), updateTimeout)
 
 		if err != nil {
 			resp.Diagnostics.AddError(
@@ -315,6 +327,11 @@ func (r *environmentResource) Update(ctx context.Context, req resource.UpdateReq
 			)
 			return
 		}
+
+		flattenEnvironment(ctx, output, &plan, &resp.Diagnostics)
+		if resp.Diagnostics.HasError() {
+			return
+		}
 	}
 
 	resp.Diagnostics.Append(resp.State.Set(ctx, &plan)...)
@@ -375,8 +392,8 @@ func (r *environmentResource) ImportState(ctx context.Context, req resource.Impo
 
 func waitEnvironmentCreated(ctx context.Context, conn *datazone.Client, domainId string, id string, timeout time.Duration) (*datazone.GetEnvironmentOutput, error) {
 	stateConf := &retry.StateChangeConf{
-		Pending:                   enum.Slice[awstypes.EnvironmentStatus](awstypes.EnvironmentStatusCreating),
-		Target:                    enum.Slice[awstypes.EnvironmentStatus](awstypes.EnvironmentStatusActive),
+		Pending:                   enum.Slice(awstypes.EnvironmentStatusCreating),
+		Target:                    enum.Slice(awstypes.EnvironmentStatusActive),
 		Refresh:                   statusEnvironment(ctx, conn, domainId, id),
 		Timeout:                   timeout,
 		NotFoundChecks:            20,
@@ -385,7 +402,7 @@ func waitEnvironmentCreated(ctx context.Context, conn *datazone.Client, domainId
 
 	outputRaw, err := stateConf.WaitForStateContext(ctx)
 	if out, ok := outputRaw.(*datazone.GetEnvironmentOutput); ok {
-		if status, deployment := out.Status, out.LastDeployment; status == awstypes.EnvironmentStatusCreateFailed && deployment != nil {
+		if status, deployment := out.Status, out.LastDeployment; (status == awstypes.EnvironmentStatusCreateFailed || status == awstypes.EnvironmentStatusValidationFailed) && deployment != nil {
 			tfresource.SetLastError(err, fmt.Errorf("%s: %s", status, aws.ToString(deployment.FailureReason.Message)))
 		}
 		return out, err
@@ -396,8 +413,8 @@ func waitEnvironmentCreated(ctx context.Context, conn *datazone.Client, domainId
 
 func waitEnvironmentUpdated(ctx context.Context, conn *datazone.Client, domainId string, id string, timeout time.Duration) (*datazone.GetEnvironmentOutput, error) {
 	stateConf := &retry.StateChangeConf{
-		Pending:                   enum.Slice[awstypes.EnvironmentStatus](awstypes.EnvironmentStatusUpdating),
-		Target:                    enum.Slice[awstypes.EnvironmentStatus](awstypes.EnvironmentStatusActive),
+		Pending:                   enum.Slice(awstypes.EnvironmentStatusUpdating),
+		Target:                    enum.Slice(awstypes.EnvironmentStatusActive),
 		Refresh:                   statusEnvironment(ctx, conn, domainId, id),
 		Timeout:                   timeout,
 		NotFoundChecks:            20,
@@ -417,10 +434,12 @@ func waitEnvironmentUpdated(ctx context.Context, conn *datazone.Client, domainId
 
 func waitEnvironmentDeleted(ctx context.Context, conn *datazone.Client, domainId string, id string, timeout time.Duration) (*datazone.GetEnvironmentOutput, error) {
 	stateConf := &retry.StateChangeConf{
-		Pending: enum.Slice(awstypes.EnvironmentStatusDeleting, awstypes.EnvironmentStatusActive),
-		Target:  []string{},
-		Refresh: statusEnvironment(ctx, conn, domainId, id),
-		Timeout: timeout,
+		Pending:      enum.Slice(awstypes.EnvironmentStatusActive, awstypes.EnvironmentStatusDeleting, awstypes.EnvironmentStatusDeleted),
+		Target:       []string{},
+		Refresh:      statusEnvironment(ctx, conn, domainId, id),
+		Timeout:      timeout,
+		Delay:        10 * time.Second,
+		PollInterval: 5 * time.Second,
 	}
 
 	outputRaw, err := stateConf.WaitForStateContext(ctx)
@@ -479,7 +498,7 @@ type environmentResourceModel struct {
 	framework.WithRegionModel
 	AccountIdentifier    types.String                                                      `tfsdk:"account_identifier"`
 	AccountRegion        types.String                                                      `tfsdk:"account_region"`
-	BlueprintId          types.String                                                      `tfsdk:"blueprint_identifier"`
+	BlueprintIdentifier  types.String                                                      `tfsdk:"blueprint_identifier"`
 	CreatedAt            timetypes.RFC3339                                                 `tfsdk:"created_at"`
 	CreatedBy            types.String                                                      `tfsdk:"created_by"`
 	Description          types.String                                                      `tfsdk:"description"`
@@ -496,6 +515,23 @@ type environmentResourceModel struct {
 	UserParameters       fwtypes.ListNestedObjectValueOf[resourceUserParametersData]       `tfsdk:"user_parameters"`
 }
 
+// nosemgrep:ci.semgrep.framework.manual-flattener-functions
+func flattenEnvironment(ctx context.Context, apiObject *datazone.GetEnvironmentOutput, model *environmentResourceModel, diags *diag.Diagnostics) {
+	diags.Append(fwflex.Flatten(ctx, apiObject, model, fwflex.WithIgnoredFieldNamesAppend("UserParameters"))...)
+
+	model.AccountIdentifier = fwflex.StringToFramework(ctx, apiObject.AwsAccountId)
+	model.AccountRegion = fwflex.StringToFramework(ctx, apiObject.AwsAccountRegion)
+	model.BlueprintIdentifier = fwflex.StringToFramework(ctx, apiObject.EnvironmentBlueprintId)
+	model.ProfileIdentifier = fwflex.StringToFramework(ctx, apiObject.EnvironmentProfileId)
+	model.ProjectIdentifier = fwflex.StringToFramework(ctx, apiObject.ProjectId)
+
+	if model.UserParameters.IsNull() { // Import
+		importUserParameters(ctx, &model.UserParameters, apiObject.UserParameters, diags)
+	} else {
+		populateUserParameters(ctx, &model.UserParameters, apiObject.UserParameters, diags)
+	}
+}
+
 type resourceLastDeployment struct {
 	DeploymentId         types.String                                                `tfsdk:"deployment_id"`
 	DeploymentStatus     types.String                                                `tfsdk:"deployment_status"`
@@ -521,3 +557,38 @@ type resourceUserParametersData struct {
 	Name  types.String `tfsdk:"name"`
 	Value types.String `tfsdk:"value"`
 }
+
+func importUserParameters(ctx context.Context, stateUserParams *fwtypes.ListNestedObjectValueOf[resourceUserParametersData], userParameters []awstypes.CustomParameter, diags *diag.Diagnostics) {
+	params := make([]resourceUserParametersData, 0, len(userParameters))
+	for _, param := range userParameters {
+		// If `DefaultValue` is nil, no value has been set
+		if param.DefaultValue != nil {
+			params = append(params, resourceUserParametersData{
+				Name:  fwflex.StringToFramework(ctx, param.KeyName),
+				Value: fwflex.StringToFramework(ctx, param.DefaultValue),
+			})
+		}
+	}
+	s, d := fwtypes.NewListNestedObjectValueOfValueSlice(ctx, params)
+	diags.Append(d...)
+	if d.HasError() {
+		return
+	}
+	*stateUserParams = s
+}
+
+func populateUserParameters(ctx context.Context, stateUserParams *fwtypes.ListNestedObjectValueOf[resourceUserParametersData], userParameters []awstypes.CustomParameter, diags *diag.Diagnostics) {
+	params, d := stateUserParams.ToSlice(ctx)
+	diags.Append(d...)
+	if d.HasError() {
+		return
+	}
+	for _, p := range params {
+		for _, up := range userParameters {
+			if p.Name.ValueString() == aws.ToString(up.KeyName) {
+				p.Value = fwflex.StringToFramework(ctx, up.DefaultValue)
+				break
+			}
+		}
+	}
+}