Added - Support for MySQL HeatWave Service: Customer email notification

Mathias Goncalves · jiaqchenO · commit 77f68d43de85 · 2024-08-23T20:18:16.000-07:00
diff --git a/examples/mysql/main.tf b/examples/mysql/main.tf
@@ -125,6 +125,11 @@ resource "oci_mysql_mysql_db_system" "test_mysql_db_system" {
     is_delete_protected = "false"
   }
 
+  #Optional
+  customer_contacts {
+    email = "email@discard.oracle.com"
+  }
+
   #Optional
   data_storage {
     is_auto_expand_storage_enabled = "false"
diff --git a/internal/integrationtest/mysql_mysql_db_system_customer_contacts_test.go b/internal/integrationtest/mysql_mysql_db_system_customer_contacts_test.go
@@ -0,0 +1,83 @@
+// Copyright (c) 2017, 2024, Oracle and/or its affiliates. All rights reserved.
+
+package integrationtest
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
+
+	"github.com/oracle/terraform-provider-oci/httpreplay"
+	"github.com/oracle/terraform-provider-oci/internal/acctest"
+	"github.com/oracle/terraform-provider-oci/internal/utils"
+)
+
+var (
+	mysqlDbSystemRepresentationWithCustomerContacts = map[string]interface{}{
+		"admin_password":          acctest.Representation{RepType: acctest.Required, Create: `BEstrO0ng_#11`},
+		"admin_username":          acctest.Representation{RepType: acctest.Required, Create: `adminUser`},
+		"availability_domain":     acctest.Representation{RepType: acctest.Required, Create: `${data.oci_identity_availability_domains.test_availability_domains.availability_domains.0.name}`},
+		"compartment_id":          acctest.Representation{RepType: acctest.Required, Create: `${var.compartment_id}`},
+		"configuration_id":        acctest.Representation{RepType: acctest.Optional, Create: `${var.MysqlConfigurationOCID[var.region]}`},
+		"shape_name":              acctest.Representation{RepType: acctest.Required, Create: `MySQL.VM.Standard.E3.1.8GB`},
+		"subnet_id":               acctest.Representation{RepType: acctest.Required, Create: `${oci_core_subnet.test_subnet.id}`},
+		"data_storage_size_in_gb": acctest.Representation{RepType: acctest.Required, Create: `50`},
+		"customer_contacts":       acctest.RepresentationGroup{RepType: acctest.Optional, Group: MysqlMysqlDbSystemCustomerContacts},
+	}
+
+	MysqlMysqlDbSystemCustomerContacts = map[string]interface{}{
+		"email": acctest.Representation{RepType: acctest.Required, Create: `email@discard.oracle.com`, Update: `email2@discard.oracle.com`},
+	}
+)
+
+// issue-routing-tag: mysql/default
+func TestMysqlMysqlDbSystemResource_customerContacts(t *testing.T) {
+	httpreplay.SetScenario("TestMysqlMysqlDbSystemResource_customerContacts")
+	defer httpreplay.SaveScenario()
+
+	config := acctest.ProviderTestConfig()
+
+	compartmentId := utils.GetEnvSettingWithBlankDefault("compartment_ocid")
+	compartmentIdVariableStr := fmt.Sprintf("variable \"compartment_id\" { default = \"%s\" }\n", compartmentId)
+
+	resourceName := "oci_mysql_mysql_db_system.test_mysql_db_system"
+
+	var resId, resId2 string
+
+	acctest.ResourceTest(t, nil, []resource.TestStep{
+		// verify Create with optional fields
+		{
+			Config: config + compartmentIdVariableStr + MysqlMysqlDbSystemResourceDependencies +
+				acctest.GenerateResourceFromRepresentationMap("oci_mysql_mysql_db_system", "test_mysql_db_system", acctest.Optional, acctest.Create, mysqlDbSystemRepresentationWithCustomerContacts),
+			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
+				resource.TestCheckResourceAttr(resourceName, "customer_contacts.#", "1"),
+				resource.TestCheckResourceAttr(resourceName, "customer_contacts.0.email", "email@discard.oracle.com"),
+
+				func(s *terraform.State) (err error) {
+					resId, err = acctest.FromInstanceState(s, resourceName, "id")
+					return err
+				},
+			),
+		},
+
+		// verify it is possible to change the customer contacts
+		{
+			Config: config + compartmentIdVariableStr + MysqlMysqlDbSystemResourceDependencies +
+				acctest.GenerateResourceFromRepresentationMap("oci_mysql_mysql_db_system", "test_mysql_db_system", acctest.Optional, acctest.Update, mysqlDbSystemRepresentationWithCustomerContacts),
+			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
+				resource.TestCheckResourceAttr(resourceName, "customer_contacts.#", "1"),
+				resource.TestCheckResourceAttr(resourceName, "customer_contacts.0.email", "email2@discard.oracle.com"),
+
+				func(s *terraform.State) (err error) {
+					resId2, err = acctest.FromInstanceState(s, resourceName, "id")
+					if resId != resId2 {
+						return fmt.Errorf("Resource recreated when it was supposed to be updated.")
+					}
+					return err
+				},
+			),
+		},
+	})
+}
diff --git a/internal/service/mysql/mysql_mysql_db_system_data_source.go b/internal/service/mysql/mysql_mysql_db_system_data_source.go
@@ -98,6 +98,12 @@ func (s *MysqlMysqlDbSystemDataSourceCrud) SetData() error {
 		s.D.Set("current_placement", nil)
 	}
 
+	customerContacts := []interface{}{}
+	for _, item := range s.Res.CustomerContacts {
+		customerContacts = append(customerContacts, CustomerContactToMap(item))
+	}
+	s.D.Set("customer_contacts", customerContacts)
+
 	if s.Res.DataStorage != nil {
 		s.D.Set("data_storage", []interface{}{DataStorageToMap(s.Res.DataStorage)})
 	} else {
diff --git a/internal/service/mysql/mysql_mysql_db_system_resource.go b/internal/service/mysql/mysql_mysql_db_system_resource.go
@@ -180,6 +180,24 @@ func MysqlMysqlDbSystemResource() *schema.Resource {
 					},
 				},
 			},
+			"customer_contacts": {
+				Type:     schema.TypeList,
+				Optional: true,
+				Computed: true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						// Required
+						"email": {
+							Type:     schema.TypeString,
+							Required: true,
+						},
+
+						// Optional
+
+						// Computed
+					},
+				},
+			},
 			"data_storage_size_in_gb": {
 				Type:     schema.TypeInt,
 				Optional: true,
@@ -937,6 +955,27 @@ func (s *MysqlMysqlDbSystemResourceCrud) Create() error {
 		}
 	}
 
+	if customerContacts, ok := s.D.GetOkExists("customer_contacts"); ok {
+		interfaces := customerContacts.([]interface{})
+		tmp := make([]oci_mysql.CustomerContact, len(interfaces))
+		for i := range interfaces {
+			stateDataIndex := i
+			fieldKeyFormat := fmt.Sprintf("%s.%d.%%s", "customer_contacts", stateDataIndex)
+			converted, err := s.mapToCustomerContact(fieldKeyFormat)
+			if err != nil {
+				return err
+			}
+			tmp[i] = converted
+		}
+		// customer_contacts should only be set if:
+		//   1) some customer contacts are provided (not `nil`)
+		// and
+		//   2) the customer contacts have changed
+		if tmp != nil && s.D.HasChange("customer_contacts") {
+			request.CustomerContacts = tmp
+		}
+	}
+
 	if dataStorageSizeInGB, ok := s.D.GetOkExists("data_storage_size_in_gb"); ok {
 		tmp := dataStorageSizeInGB.(int)
 		request.DataStorageSizeInGBs = &tmp
@@ -1122,6 +1161,27 @@ func (s *MysqlMysqlDbSystemResourceCrud) Update() error {
 		}
 	}
 
+	if customerContacts, ok := s.D.GetOkExists("customer_contacts"); ok {
+		interfaces := customerContacts.([]interface{})
+		tmp := make([]oci_mysql.CustomerContact, len(interfaces))
+		for i := range interfaces {
+			stateDataIndex := i
+			fieldKeyFormat := fmt.Sprintf("%s.%d.%%s", "customer_contacts", stateDataIndex)
+			converted, err := s.mapToCustomerContact(fieldKeyFormat)
+			if err != nil {
+				return err
+			}
+			tmp[i] = converted
+		}
+		// customer_contacts should only be set if:
+		//   1) some customer contacts are provided (not `nil`)
+		// and
+		//   2) the customer contacts have changed
+		if tmp != nil && s.D.HasChange("customer_contacts") {
+			request.CustomerContacts = tmp
+		}
+	}
+
 	if dataStorageSizeInGB, ok := s.D.GetOkExists("data_storage_size_in_gb"); ok && s.D.HasChange("data_storage_size_in_gb") {
 		tmp := dataStorageSizeInGB.(int)
 		request.DataStorageSizeInGBs = &tmp
@@ -1257,6 +1317,12 @@ func (s *MysqlMysqlDbSystemResourceCrud) SetData() error {
 		s.D.Set("data_storage", nil)
 	}
 
+	customerContacts := []interface{}{}
+	for _, item := range s.Res.CustomerContacts {
+		customerContacts = append(customerContacts, CustomerContactToMap(item))
+	}
+	s.D.Set("customer_contacts", customerContacts)
+
 	if s.Res.DataStorageSizeInGBs != nil {
 		s.D.Set("data_storage_size_in_gb", *s.Res.DataStorageSizeInGBs)
 	}
@@ -1909,6 +1975,27 @@ func DataStorageToMap(obj *oci_mysql.DataStorage) map[string]interface{} {
 	return result
 }
 
+func (s *MysqlMysqlDbSystemResourceCrud) mapToCustomerContact(fieldKeyFormat string) (oci_mysql.CustomerContact, error) {
+	result := oci_mysql.CustomerContact{}
+
+	if email, ok := s.D.GetOkExists(fmt.Sprintf(fieldKeyFormat, "email")); ok {
+		tmp := email.(string)
+		result.Email = &tmp
+	}
+
+	return result, nil
+}
+
+func CustomerContactToMap(obj oci_mysql.CustomerContact) map[string]interface{} {
+	result := map[string]interface{}{}
+
+	if obj.Email != nil {
+		result["email"] = string(*obj.Email)
+	}
+
+	return result
+}
+
 func DbSystemPlacementToMap(obj *oci_mysql.DbSystemPlacement) map[string]interface{} {
 	result := map[string]interface{}{}
 
diff --git a/website/docs/d/mysql_mysql_db_system.html.markdown b/website/docs/d/mysql_mysql_db_system.html.markdown
@@ -120,6 +120,9 @@ The following attributes are exported:
 
 		It is not possible to decrease data storage size. You cannot set the maximum data storage size to less than either current DB System dataStorageSizeInGBs or allocatedStorageSizeInGBs. 
 * `data_storage_size_in_gb` - DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs. 
+* `customer_contacts` - The list of customer email addresses that receive information from Oracle about the specified Oracle Cloud Infrastructure DB System resource.  Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators.  Up to 10 email addresses can be added to the customer contacts for a DB System. 
+	* `email` - The email address used by Oracle to send notifications regarding the DB System. 
+* `data_storage_size_in_gb` - Initial size of the data volume in GiBs that will be created and attached. 
 * `database_management` - Whether to enable monitoring via the Database Management service. 
 * `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` 
 * `deletion_policy` - The Deletion policy for the DB System.
diff --git a/website/docs/d/mysql_mysql_db_systems.html.markdown b/website/docs/d/mysql_mysql_db_systems.html.markdown
@@ -144,6 +144,9 @@ The following attributes are exported:
 
 		It is not possible to decrease data storage size. You cannot set the maximum data storage size to less than either current DB System dataStorageSizeInGBs or allocatedStorageSizeInGBs. 
 * `data_storage_size_in_gb` - DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs. 
+* `customer_contacts` - The list of customer email addresses that receive information from Oracle about the specified Oracle Cloud Infrastructure DB System resource.  Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators.  Up to 10 email addresses can be added to the customer contacts for a DB System. 
+	* `email` - The email address used by Oracle to send notifications regarding the DB System. 
+* `data_storage_size_in_gb` - Initial size of the data volume in GiBs that will be created and attached. 
 * `database_management` - Whether to enable monitoring via the Database Management service. 
 * `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` 
 * `deletion_policy` - The Deletion policy for the DB System.
diff --git a/website/docs/r/mysql_mysql_db_system.html.markdown b/website/docs/r/mysql_mysql_db_system.html.markdown
@@ -41,6 +41,10 @@ resource "oci_mysql_mysql_db_system" "test_mysql_db_system" {
 	}
 	configuration_id = oci_audit_configuration.test_configuration.id
 	crash_recovery = var.mysql_db_system_crash_recovery
+	customer_contacts {
+		#Required
+		email = var.mysql_db_system_customer_contacts_email
+	}
 	data_storage {
 
 		#Optional
@@ -129,6 +133,8 @@ The following arguments are supported:
 		DB Systems with an initial storage size of 400 GB or less can be expanded up to 32 TB. DB Systems with an initial storage size between 401-800 GB can be expanded up to 64 TB. DB Systems with an initial storage size between 801-1200 GB can be expanded up to 96 TB. DB Systems with an initial storage size of 1201 GB or more can be expanded up to 128 TB.
 
 		It is not possible to decrease data storage size. You cannot set the maximum data storage size to less than either current DB System dataStorageSizeInGBs or allocatedStorageSizeInGBs. 
+* `customer_contacts` - (Optional) (Updatable) The list of customer email addresses that receive information from Oracle about the specified Oracle Cloud Infrastructure DB System resource.  Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators.  Up to 10 email addresses can be added to the customer contacts for a DB System. 
+	* `email` - (Required) (Updatable) The email address used by Oracle to send notifications regarding the DB System. 
 * `data_storage_size_in_gb` - (Optional) (Updatable) Initial size of the data volume in GBs that will be created and attached. Keep in mind that this only specifies the size of the database data volume, the log volume for the database will be scaled appropriately with its shape. It is required if you are creating a new database. It cannot be set if you are creating a database from a backup.
 * `database_management` - (Optional) (Updatable) Whether to enable monitoring via the Database Management service. 
 * `defined_tags` - (Optional) (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` 
@@ -276,6 +282,9 @@ The following attributes are exported:
 
 		It is not possible to decrease data storage size. You cannot set the maximum data storage size to less than either current DB System dataStorageSizeInGBs or allocatedStorageSizeInGBs. 
 * `data_storage_size_in_gb` - DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs. 
+* `customer_contacts` - The list of customer email addresses that receive information from Oracle about the specified Oracle Cloud Infrastructure DB System resource.  Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators.  Up to 10 email addresses can be added to the customer contacts for a DB System. 
+	* `email` - The email address used by Oracle to send notifications regarding the DB System. 
+* `data_storage_size_in_gb` - Initial size of the data volume in GiBs that will be created and attached. 
 * `database_management` - Whether to enable monitoring via the Database Management service. 
 * `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` 
 * `deletion_policy` - The Deletion policy for the DB System.
