fix: Updates integration_id in mongodbatlas_alert_configuration resource to be Optional+Computed (#2603)

Author: maastha

.changelog/2603.txt

@@ -0,0 +1,3 @@
+```release-note:note
+resource/mongodbatlas_alert_configuration: Updates `notification.#.integration_id` to be Optional & Computed
+```

docs/guides/1.20.0-upgrade-guide.md

@@ -19,6 +19,26 @@ The Terraform MongoDB Atlas Provider version 1.20.0 has a number of new and exci
   - data-source/mongodbatlas_data_lake_pipeline_run
   - data-source/mongodbatlas_data_lake_pipeline_runs
 
+**Breaking Changes:**
+- `mongodbatlas_alert_configuration` resource attribute `notification.#.integration_id` may have a computed value due to recent updates in the Atlas API [Alert Configuration](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration). Due to this, MongoDB Atlas Provider versions **1.16.0 to 1.19.0** may experience non-empty plans if you are using this resource with an integration set for the notifications without an explicitly set `integration_id`. For more details, see [#2603](https://github.com/mongodb/terraform-provider-mongodbatlas/pull/2603).
+
+  These users should either:
+
+  - Upgrade to the latest MongoDB Atlas Terraform Provider (1.20.0) to avoid the non-empty plan, or
+  - Update Terraform configurations to include the `integration_id` returned in the non-empty plan as:
+  ```
+  notification {
+    type_name = "DATADOG"
+    integration_id  = "xxxxxxxxxxxxxxxxxxxxxxxx" # add integration_id shown in the plan to your configuration
+    datadog_api_key = mongodbatlas_third_party_integration.atlas_datadog.api_key
+    datadog_region  = mongodbatlas_third_party_integration.atlas_datadog.region
+    interval_min    = 6
+  }
+  ```
+
+  Note: Applying the non-empty plan will be a no-op but users will still get the non-empty plan even after applying unless one of the above solutions are adopted.
+
+
 ## New Terraform MongoDB Atlas modules
 You can now leverage our [Terraform Modules](https://registry.terraform.io/namespaces/terraform-mongodbatlas-modules) to easily get started with MongoDB Atlas and critical features like [Push-based log export](https://registry.terraform.io/modules/terraform-mongodbatlas-modules/push-based-log-export/mongodbatlas/latest), [Private Endpoints](https://registry.terraform.io/modules/terraform-mongodbatlas-modules/private-endpoint/mongodbatlas/latest), etc.
 

internal/service/alertconfiguration/model_alert_configuration.go

@@ -4,9 +4,11 @@ import (
 	"fmt"
 	"strings"
 
+	"go.mongodb.org/atlas-sdk/v20240805004/admin"
+
 	"github.com/hashicorp/terraform-plugin-framework/types"
+
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/conversion"
-	"go.mongodb.org/atlas-sdk/v20240805004/admin"
 )
 
 func NewNotificationList(list []TfNotificationModel) (*[]admin.AlertsNotificationRootForGroup, error) {
@@ -46,10 +48,8 @@ func NewNotificationList(list []TfNotificationModel) (*[]admin.AlertsNotificatio
 			MicrosoftTeamsWebhookUrl: n.MicrosoftTeamsWebhookURL.ValueStringPointer(),
 			WebhookSecret:            n.WebhookSecret.ValueStringPointer(),
 			WebhookUrl:               n.WebhookURL.ValueStringPointer(),
-			IntegrationId:            n.IntegrationID.ValueStringPointer(),
-		}
-		if !n.NotifierID.IsUnknown() {
-			notifications[i].NotifierId = n.NotifierID.ValueStringPointer()
+			IntegrationId:            conversion.StringPtr(n.IntegrationID.ValueString()),
+			NotifierId:               conversion.StringPtr(n.NotifierID.ValueString()),
 		}
 	}
 	return &notifications, nil

internal/service/alertconfiguration/resource_alert_configuration.go

@@ -6,6 +6,8 @@ import (
 	"reflect"
 	"strings"
 
+	"go.mongodb.org/atlas-sdk/v20240805004/admin"
+
 	"github.com/hashicorp/terraform-plugin-framework-validators/listvalidator"
 	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/path"
@@ -18,9 +20,9 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
+
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/conversion"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/config"
-	"go.mongodb.org/atlas-sdk/v20240805004/admin"
 )
 
 const (
@@ -324,6 +326,7 @@ func (r *alertConfigurationRS) Schema(ctx context.Context, req resource.SchemaRe
 						},
 						"integration_id": schema.StringAttribute{
 							Optional: true,
+							Computed: true,
 						},
 						"type_name": schema.StringAttribute{
 							Required: true,

internal/service/alertconfiguration/resource_alert_configuration_migration_test.go

@@ -4,6 +4,7 @@ import (
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/testutil/acc"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/testutil/mig"
 )
@@ -142,3 +143,8 @@ func TestMigConfigRSAlertConfiguration_withEmptyOptionalAttributes(t *testing.T)
 		},
 	})
 }
+
+func TestMigConfigRSAlertConfiguration_withDataDog(t *testing.T) {
+	mig.SkipIfVersionBelow(t, "1.20.0")
+	mig.CreateAndRunTest(t, datadogTestCase(t))
+}

internal/service/alertconfiguration/resource_alert_configuration_test.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
 	"github.com/hashicorp/terraform-plugin-testing/terraform"
+
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/conversion"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/service/alertconfiguration"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/testutil/acc"
@@ -367,28 +368,67 @@ func TestAccConfigRSAlertConfiguration_updatePagerDutyWithNotifierId(t *testing.
 }
 
 func TestAccConfigRSAlertConfiguration_withDataDog(t *testing.T) {
+	resource.ParallelTest(t, *datadogTestCase(t))
+}
+
+func datadogTestCase(t *testing.T) *resource.TestCase {
+	t.Helper()
+
 	proxyPort := replay.SetupReplayProxy(t)
 
 	var (
 		projectID = replay.ManageProjectID(t, acc.ProjectIDExecution)
 		ddAPIKey  = dummy32CharKey
 		ddRegion  = "US"
+
+		groupNotificationMap = map[string]string{
+			"type_name":    "GROUP",
+			"interval_min": "5",
+			"delay_min":    "0",
+		}
+
+		ddNotificationMap = map[string]string{
+			"type_name":       "DATADOG",
+			"interval_min":    "5",
+			"delay_min":       "0",
+			"datadog_api_key": ddAPIKey,
+			"datadog_region":  ddRegion,
+		}
+
+		ddNotificationUpdatedMap = map[string]string{
+			"type_name":       "DATADOG",
+			"interval_min":    "6",
+			"delay_min":       "0",
+			"datadog_api_key": ddAPIKey,
+			"datadog_region":  ddRegion,
+		}
 	)
 
-	resource.ParallelTest(t, resource.TestCase{
+	return &resource.TestCase{
 		PreCheck:                 func() { acc.PreCheckBasic(t) },
 		ProtoV6ProviderFactories: acc.TestAccProviderV6FactoriesWithProxy(proxyPort),
 		CheckDestroy:             checkDestroyUsingProxy(proxyPort),
 		Steps: []resource.TestStep{
 			{
-				Config: configWithDataDog(projectID, ddAPIKey, ddRegion, true),
+				Config: configWithDataDog(projectID, ddAPIKey, ddRegion, true, ddNotificationMap, groupNotificationMap),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					checkExistsUsingProxy(proxyPort, resourceName),
 					resource.TestCheckResourceAttr(resourceName, "project_id", projectID),
+					resource.TestCheckTypeSetElemNestedAttrs(resourceName, "notification.*", groupNotificationMap),
+					resource.TestCheckTypeSetElemNestedAttrs(resourceName, "notification.*", ddNotificationMap),
+				),
+			},
+			{
+				Config: configWithDataDog(projectID, ddAPIKey, ddRegion, true, ddNotificationUpdatedMap, groupNotificationMap),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					checkExistsUsingProxy(proxyPort, resourceName),
+					resource.TestCheckResourceAttr(resourceName, "project_id", projectID),
+					resource.TestCheckTypeSetElemNestedAttrs(resourceName, "notification.*", groupNotificationMap),
+					resource.TestCheckTypeSetElemNestedAttrs(resourceName, "notification.*", ddNotificationUpdatedMap),
 				),
 			},
 		},
-	})
+	}
 }
 
 func TestAccConfigRSAlertConfiguration_withPagerDuty(t *testing.T) {
@@ -412,11 +452,13 @@ func TestAccConfigRSAlertConfiguration_withPagerDuty(t *testing.T) {
 				),
 			},
 			{
-				ResourceName:            resourceName,
-				ImportStateIdFunc:       importStateProjectIDFunc(resourceName),
-				ImportState:             true,
-				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"updated", "notification.0.service_key"}, // service key is not returned by api in import operation
+				ResourceName:      resourceName,
+				ImportStateIdFunc: importStateProjectIDFunc(resourceName),
+				ImportState:       true,
+				ImportStateVerify: true,
+				// service key is not returned by api in import operation
+				// integration_id is not returned during Create
+				ImportStateVerifyIgnore: []string{"updated", "notification.0.service_key", "notification.0.integration_id"},
 			},
 		},
 	})
@@ -736,7 +778,28 @@ func configWithThresholdUpdated(projectID string, enabled bool, threshold float6
 	`, projectID, enabled, threshold)
 }
 
-func configWithDataDog(projectID, dataDogAPIKey, dataDogRegion string, enabled bool) string {
+func configWithDataDog(projectID, dataDogAPIKey, dataDogRegion string, enabled bool, ddNotificationMap, groupNotificationMap map[string]string) string {
+	ddNotificationBlock := fmt.Sprintf(`
+	notification {
+		type_name = %[1]q
+		datadog_api_key = mongodbatlas_third_party_integration.atlas_datadog.api_key
+		datadog_region = mongodbatlas_third_party_integration.atlas_datadog.region
+		interval_min  = %[2]v
+		delay_min     = %[3]v
+	}
+	`, ddNotificationMap["type_name"], ddNotificationMap["interval_min"], ddNotificationMap["delay_min"])
+
+	groupNotificationBlock := fmt.Sprintf(`
+	notification {
+		type_name     = %[1]q
+		interval_min  = %[2]v
+		delay_min     = %[3]v
+		sms_enabled   = false
+		email_enabled = true
+		roles         = ["GROUP_OWNER"]
+	}
+	`, groupNotificationMap["type_name"], groupNotificationMap["interval_min"], groupNotificationMap["delay_min"])
+
 	return fmt.Sprintf(`
 		resource "mongodbatlas_third_party_integration" "atlas_datadog" {
 			project_id = %[1]q
@@ -750,22 +813,9 @@ func configWithDataDog(projectID, dataDogAPIKey, dataDogRegion string, enabled b
 			event_type = "REPLICATION_OPLOG_WINDOW_RUNNING_OUT"
 			enabled    = %[4]t
 
-			notification {
-				type_name     = "GROUP"
-				interval_min  = 5
-				delay_min     = 0
-				sms_enabled   = false
-				email_enabled = true
-				roles         = ["GROUP_OWNER"]
-			}
+			%[5]s
 
-			notification {
-				type_name = "DATADOG"
-				datadog_api_key = mongodbatlas_third_party_integration.atlas_datadog.api_key
-				datadog_region = mongodbatlas_third_party_integration.atlas_datadog.region
-				interval_min  = 5
-				delay_min     = 0
-			}
+			%[6]s
 
 			matcher {
 				field_name = "REPLICA_SET_NAME"
@@ -779,7 +829,7 @@ func configWithDataDog(projectID, dataDogAPIKey, dataDogRegion string, enabled b
 				units       = "HOURS"
 			}
 		}
-	`, projectID, dataDogAPIKey, dataDogRegion, enabled)
+	`, projectID, dataDogAPIKey, dataDogRegion, enabled, groupNotificationBlock, ddNotificationBlock)
 }
 
 func configWithPagerDuty(projectID, serviceKey string, enabled bool) string {