Added - Support for Support resource locking for Email Delivery

Author: Zoey Feng

examples/email/emaildomain.tf

@@ -18,3 +18,7 @@ resource "oci_email_email_domain" "test_email_domain" {
 
   depends_on = [random_id.random_email_domain]
 }
+
+data "oci_email_email_domain" "test_email_domain" {
+	email_domain_id = oci_email_email_domain.test_email_domain.id
+}

internal/integrationtest/email_email_domain_test.go

@@ -21,6 +21,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-testing/terraform"
 	"github.com/oracle/oci-go-sdk/v65/common"
 	oci_email "github.com/oracle/oci-go-sdk/v65/email"
+	emailpkg "github.com/oracle/terraform-provider-oci/internal/service/email"
 
 	"github.com/oracle/terraform-provider-oci/httpreplay"
 )
@@ -220,6 +221,74 @@ func TestEmailEmailDomainResource_basic(t *testing.T) {
 	})
 }
 
+func TestEmailEmailDomainDataSource_withLocks(t *testing.T) {
+	resource := emailpkg.EmailEmailDomainsDataSource()
+
+	d := schema.TestResourceDataRaw(t, resource.Schema, map[string]interface{}{
+		"compartment_id": "ocid1.compartment.oc1..mocked",
+		"filter": []interface{}{
+			map[string]interface{}{
+				"name":   "id",
+				"values": []interface{}{"mocked-emaildomain-id"},
+			},
+		},
+	})
+
+	mockedTime, _ := time.Parse(time.RFC3339Nano, "2023-09-19T17:29:12.144Z")
+
+	// Build one mocked domain item with one lock.
+	item := map[string]interface{}{
+		"id":             "mocked-emaildomain-id",
+		"name":           "mocked.email.ap-mumbai-1.oci.oc-test.com",
+		"compartment_id": "ocid1.compartment.oc1..mocked",
+		"state":          "ACTIVE",
+		"locks": []interface{}{
+			map[string]interface{}{
+				"type":         "FULL",
+				"time_created": mockedTime.Format(time.RFC3339Nano),
+			},
+		},
+	}
+
+	collection := []interface{}{
+		map[string]interface{}{
+			"items": []interface{}{item},
+		},
+	}
+
+	// Set the computed collection on the data source (allowed in unit tests via ResourceData).
+	if err := d.Set("email_domain_collection", collection); err != nil {
+		t.Fatalf("failed to set email_domain_collection: %v", err)
+	}
+
+	// Assertions
+	coll := d.Get("email_domain_collection").([]interface{})
+	if len(coll) != 1 {
+		t.Fatalf("expected 1 email_domain_collection, got %d", len(coll))
+	}
+
+	items := coll[0].(map[string]interface{})["items"].([]interface{})
+	if len(items) != 1 {
+		t.Fatalf("expected 1 item, got %d", len(items))
+	}
+
+	got := items[0].(map[string]interface{})
+	locks := got["locks"].([]interface{})
+	if len(locks) != 1 {
+		t.Fatalf("expected 1 lock, got %d", len(locks))
+	}
+
+	lock := locks[0].(map[string]interface{})
+	check := func(key, expected string) {
+		if actual, ok := lock[key]; !ok || actual != expected {
+			t.Errorf("expected lock[%s] = %q, got %v", key, expected, actual)
+		}
+	}
+
+	check("type", "FULL")
+	check("time_created", "2023-09-19T17:29:12.144Z")
+}
+
 func testAccCheckEmailEmailDomainDestroy(s *terraform.State) error {
 	noResourceFound := true
 	client := acctest.TestAccProvider.Meta().(*tf_client.OracleClients).EmailClient()

internal/integrationtest/email_email_return_path_test.go

@@ -22,6 +22,8 @@ import (
 	"github.com/oracle/terraform-provider-oci/internal/resourcediscovery"
 	"github.com/oracle/terraform-provider-oci/internal/tfresource"
 	"github.com/oracle/terraform-provider-oci/internal/utils"
+
+	emailpkg "github.com/oracle/terraform-provider-oci/internal/service/email"
 )
 
 var (
@@ -191,6 +193,75 @@ func TestEmailEmailReturnPathResource_basic(t *testing.T) {
 	})
 }
 
+func TestEmailReturnPathDataSource_withLocks(t *testing.T) {
+	resource := emailpkg.EmailEmailReturnPathsDataSource()
+
+	mockedTime, _ := time.Parse(time.RFC3339, "2023-09-19T17:29:12.144Z")
+	mockedSDKTime := common.SDKTime{Time: mockedTime}
+
+	mocked := oci_email.EmailReturnPathSummary{
+		Id:             common.String("mocked_id"),
+		Name:           common.String("tfrp.test.mock"),
+		CompartmentId:  common.String("ocid1.compartment.oc1..mocked"),
+		LifecycleState: oci_email.EmailReturnPathLifecycleStateActive,
+		Locks: []oci_email.ResourceLock{
+			{
+				Type:        oci_email.ResourceLockTypeFull,
+				TimeCreated: &mockedSDKTime,
+			},
+		},
+	}
+
+	d := schema.TestResourceDataRaw(t, resource.Schema, map[string]interface{}{
+		"compartment_id": "ocid1.compartment.oc1..mocked",
+	})
+
+	domainCollection := []interface{}{
+		map[string]interface{}{
+			"items": []interface{}{
+				map[string]interface{}{
+					"id":             *mocked.Id,
+					"name":           *mocked.Name,
+					"compartment_id": *mocked.CompartmentId,
+					"state":          string(mocked.LifecycleState),
+					"locks": []interface{}{
+						map[string]interface{}{
+							"type":         string(mocked.Locks[0].Type),
+							"time_created": mocked.Locks[0].TimeCreated.Format(time.RFC3339),
+						},
+					},
+				},
+			},
+		},
+	}
+	d.Set("email_return_path_collection", domainCollection)
+
+	// Assertions
+	coll := d.Get("email_return_path_collection").([]interface{})
+	if len(coll) != 1 {
+		t.Fatalf("Expected 1 email_return_path_collection, got %d", len(coll))
+	}
+	items := coll[0].(map[string]interface{})["items"].([]interface{})
+	if len(items) != 1 {
+		t.Fatalf("Expected 1 item, got %d", len(items))
+	}
+	item := items[0].(map[string]interface{})
+	locks := item["locks"].([]interface{})
+	if len(locks) != 1 {
+		t.Fatalf("Expected 1 lock, got %d", len(locks))
+	}
+
+	lock := locks[0].(map[string]interface{})
+	check := func(k, expected string) {
+		if lock[k] != expected {
+			t.Errorf("Expected %s = %q, got %v", k, expected, lock[k])
+		}
+	}
+
+	check("type", "FULL")
+	check("time_created", "2023-09-19T17:29:12Z") // Note: SDKTime drops fractional seconds
+}
+
 func testAccCheckEmailEmailReturnPathDestroy(s *terraform.State) error {
 	noResourceFound := true
 	client := acctest.TestAccProvider.Meta().(*tf_client.OracleClients).EmailClient()

internal/integrationtest/email_sender_test.go

@@ -23,6 +23,7 @@ import (
 	oci_email "github.com/oracle/oci-go-sdk/v65/email"
 
 	"github.com/oracle/terraform-provider-oci/httpreplay"
+	emailpkg "github.com/oracle/terraform-provider-oci/internal/service/email"
 )
 
 var (
@@ -215,6 +216,64 @@ func TestEmailSenderResource_basic(t *testing.T) {
 	})
 }
 
+func TestEmailEmailSenderDataSource_withLocks(t *testing.T) {
+	resource := emailpkg.EmailSendersDataSource()
+
+	d := schema.TestResourceDataRaw(t, resource.Schema, map[string]interface{}{
+		"compartment_id": "ocid1.compartment.oc1..mocked",
+		"filter": []interface{}{
+			map[string]interface{}{
+				"name":   "id",
+				"values": []interface{}{"mocked-sender-id"},
+			},
+		},
+	})
+
+	mockedTime, _ := time.Parse(time.RFC3339Nano, "2023-09-19T17:29:12.144Z")
+
+	// Build one mocked sender with one lock.
+	sender := map[string]interface{}{
+		"id":             "mocked-sender-id",
+		"email_address":  "[email protected]",
+		"compartment_id": "ocid1.compartment.oc1..mocked",
+		"state":          "ACTIVE",
+		"locks": []interface{}{
+			map[string]interface{}{
+				"type":         "FULL",
+				"time_created": mockedTime.Format(time.RFC3339Nano),
+			},
+		},
+	}
+
+	// Inject into the data source's computed field.
+	if err := d.Set("senders", []interface{}{sender}); err != nil {
+		t.Fatalf("failed to set senders: %v", err)
+	}
+
+	// Assertions
+	senders := d.Get("senders").([]interface{})
+	if len(senders) != 1 {
+		t.Fatalf("expected 1 sender, got %d", len(senders))
+	}
+
+	s := senders[0].(map[string]interface{})
+	locks := s["locks"].([]interface{})
+	if len(locks) != 1 {
+		t.Fatalf("expected 1 lock, got %d", len(locks))
+	}
+
+	lock := locks[0].(map[string]interface{})
+	check := func(key, expected string) {
+		if actual, ok := lock[key]; !ok || actual != expected {
+			t.Errorf("expected lock[%s] = %q, got %v", key, expected, actual)
+		}
+	}
+
+	check("type", "FULL")
+	check("time_created", "2023-09-19T17:29:12.144Z")
+
+}
+
 func testAccCheckEmailSenderDestroy(s *terraform.State) error {
 	noResourceFound := true
 	client := acctest.TestAccProvider.Meta().(*tf_client.OracleClients).EmailClient()

internal/service/email/email_email_domain_data_source.go

@@ -94,6 +94,12 @@ func (s *EmailEmailDomainDataSourceCrud) SetData() error {
 		s.D.Set("is_spf", *s.Res.IsSpf)
 	}
 
+	locks := []interface{}{}
+	for _, item := range s.Res.Locks {
+		locks = append(locks, ResourceLockToMap(item))
+	}
+	s.D.Set("locks", locks)
+
 	if s.Res.Name != nil {
 		s.D.Set("name", *s.Res.Name)
 	}

internal/service/email/email_email_domain_resource.go

@@ -80,6 +80,40 @@ func EmailEmailDomainResource() *schema.Resource {
 				Type:     schema.TypeBool,
 				Computed: true,
 			},
+			"locks": {
+				Type:     schema.TypeList,
+				Computed: true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						// Required
+
+						// Optional
+						"compartment_id": {
+							Type:     schema.TypeString,
+							Optional: true,
+							Computed: true,
+						},
+
+						// Computed
+						"message": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"related_resource_id": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"time_created": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"type": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+					},
+				},
+			},
 			"state": {
 				Type:     schema.TypeString,
 				Computed: true,
@@ -387,6 +421,11 @@ func (s *EmailEmailDomainResourceCrud) Update() error {
 		request.FreeformTags = tfresource.ObjectMapToStringMap(freeformTags.(map[string]interface{}))
 	}
 
+	if isLockOverride, ok := s.D.GetOkExists("is_lock_override"); ok {
+		tmp := isLockOverride.(bool)
+		request.IsLockOverride = &tmp
+	}
+
 	request.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(s.DisableNotFoundRetries, "email")
 
 	response, err := s.Client.UpdateEmailDomain(context.Background(), request)
@@ -404,6 +443,11 @@ func (s *EmailEmailDomainResourceCrud) Delete() error {
 	tmp := s.D.Id()
 	request.EmailDomainId = &tmp
 
+	if isLockOverride, ok := s.D.GetOkExists("is_lock_override"); ok {
+		tmp := isLockOverride.(bool)
+		request.IsLockOverride = &tmp
+	}
+
 	request.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(s.DisableNotFoundRetries, "email")
 
 	response, err := s.Client.DeleteEmailDomain(context.Background(), request)
@@ -447,6 +491,12 @@ func (s *EmailEmailDomainResourceCrud) SetData() error {
 		s.D.Set("is_spf", *s.Res.IsSpf)
 	}
 
+	locks := []interface{}{}
+	for _, item := range s.Res.Locks {
+		locks = append(locks, ResourceLockToMap(item))
+	}
+	s.D.Set("locks", locks)
+
 	if s.Res.Name != nil {
 		s.D.Set("name", *s.Res.Name)
 	}
@@ -489,6 +539,12 @@ func EmailDomainSummaryToMap(obj oci_email.EmailDomainSummary) map[string]interf
 		result["id"] = string(*obj.Id)
 	}
 
+	locks := []interface{}{}
+	for _, item := range obj.Locks {
+		locks = append(locks, ResourceLockToMap(item))
+	}
+	result["locks"] = locks
+
 	if obj.Name != nil {
 		result["name"] = string(*obj.Name)
 	}
@@ -506,6 +562,30 @@ func EmailDomainSummaryToMap(obj oci_email.EmailDomainSummary) map[string]interf
 	return result
 }
 
+func ResourceLockToMap(obj oci_email.ResourceLock) map[string]interface{} {
+	result := map[string]interface{}{}
+
+	if obj.CompartmentId != nil {
+		result["compartment_id"] = string(*obj.CompartmentId)
+	}
+
+	if obj.Message != nil {
+		result["message"] = string(*obj.Message)
+	}
+
+	if obj.RelatedResourceId != nil {
+		result["related_resource_id"] = string(*obj.RelatedResourceId)
+	}
+
+	if obj.TimeCreated != nil {
+		result["time_created"] = obj.TimeCreated.String()
+	}
+
+	result["type"] = string(obj.Type)
+
+	return result
+}
+
 func (s *EmailEmailDomainResourceCrud) updateCompartment(compartment interface{}) error {
 	changeCompartmentRequest := oci_email.ChangeEmailDomainCompartmentRequest{}
 
@@ -515,6 +595,11 @@ func (s *EmailEmailDomainResourceCrud) updateCompartment(compartment interface{}
 	idTmp := s.D.Id()
 	changeCompartmentRequest.EmailDomainId = &idTmp
 
+	if isLockOverride, ok := s.D.GetOkExists("is_lock_override"); ok {
+		tmp := isLockOverride.(bool)
+		changeCompartmentRequest.IsLockOverride = &tmp
+	}
+
 	changeCompartmentRequest.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(s.DisableNotFoundRetries, "email")
 
 	response, err := s.Client.ChangeEmailDomainCompartment(context.Background(), changeCompartmentRequest)