Added - Support for GoldenGate - Resource Locking

Author: lm-oracle

examples/goldengate/Certificate/main.tf

@@ -13,6 +13,10 @@ variable "password" {}
 // for certificate - base64 encoded
 variable "certificate_content" {}
 
+variable "is_lock_override" {
+  default = false
+}
+
 provider "oci" {
   tenancy_ocid     = var.tenancy_ocid
   user_ocid        = var.user_ocid
@@ -40,4 +44,7 @@ resource "oci_golden_gate_deployment_certificate" "certificate" {
   deployment_id = oci_golden_gate_deployment.test_deployment.id
   key = "certificate"
   certificate_content = var.certificate_content
+  lifecycle {
+    ignore_changes = [is_lock_override]
+  }
 }

examples/goldengate/Connection/main.tf

@@ -9,6 +9,18 @@ variable "subnet_id" {}
 variable "vault_id" {}
 variable "kms_key_id" {}
 
+variable "locks_type" {
+  default = "FULL"
+}
+
+variable "locks_message" {
+  default = "message"
+}
+
+variable "is_lock_override" {
+  default = true
+}
+
 variable "username" {
   default = "admin"
 }
@@ -76,4 +88,12 @@ resource "oci_golden_gate_connection" "test_connection"{
 
   #Optional for Postgresql connection_type
   private_ip = var.private_ip
+  locks {
+    type = var.locks_type
+    message = var.locks_message
+  }
+  is_lock_override = var.is_lock_override
+  lifecycle {
+    ignore_changes = [defined_tags, locks, freeform_tags, is_lock_override]
+  }
 }

examples/goldengate/ConnectionAssignment/main.tf

@@ -22,6 +22,9 @@ variable "host"{
 variable "port" {
   default = "14"
 }
+variable "is_lock_override" {
+  default = false
+}
 provider "oci" {
   tenancy_ocid     = var.tenancy_ocid
   user_ocid        = var.user_ocid
@@ -34,6 +37,10 @@ resource "oci_golden_gate_connection_assignment" "test_connection_assignment"{
   #Required
   connection_id = oci_golden_gate_connection.test_connection.id
   deployment_id = var.deployment_ocid
+  is_lock_override = var.is_lock_override
+  lifecycle {
+    ignore_changes = [is_lock_override]
+  }
 }
 
 resource "oci_golden_gate_connection" "test_connection"{

examples/goldengate/Deployment/main.tf

@@ -90,6 +90,7 @@ resource "oci_golden_gate_deployment_backup" "test_deployment_backup" {
   	lifecycle {
   		ignore_changes = [defined_tags, system_tags, freeform_tags]
   	}
+	locks {}
 }
 
 resource "oci_golden_gate_deployment" "test_deployment" {
@@ -106,6 +107,7 @@ resource "oci_golden_gate_deployment" "test_deployment" {
     	admin_username  = var.deployment_ogg_data_admin_username
     	deployment_name = var.deployment_ogg_data_deployment_name
   	}
+	locks {}
 }
 
 resource "oci_golden_gate_deployment" "test_deployment_GOLDENGATE" {

internal/integrationtest/golden_gate_connection_test.go

@@ -120,14 +120,22 @@ var (
 		"routing_method": acctest.Representation{RepType: acctest.Optional, Create: `SHARED_DEPLOYMENT_ENDPOINT`, Update: `DEDICATED_ENDPOINT`},
 	}
 
+	connectionLocksRepresentation = map[string]interface{}{
+		"type":    acctest.Representation{RepType: acctest.Required, Create: `FULL`},
+		"message": acctest.Representation{RepType: acctest.Optional, Create: `message`},
+	}
+
 	ConnectionTestDescriptors = []ConnectionTestDescriptor{
-		// AmazonS3
+		// AmazonS3, create a locked resource, only for this type. Resource locking is generic it applies the same way for the other types
 		{connectionType: oci_golden_gate.ConnectionTypeAmazonS3, technologyType: oci_golden_gate.TechnologyTypeAmazonS3,
 			representation: map[string]interface{}{
 				// Override compartment to test move compartment too.
 				"compartment_id":    acctest.Representation{RepType: acctest.Required, Create: `${var.compartment_id}`, Update: `${var.compartment_id_for_move}`},
 				"access_key_id":     acctest.Representation{RepType: acctest.Required, Create: `AKIAIOSFODNN7EXAMPLE`, Update: `AKIAIOSFODNN7UPDATED`},
 				"secret_access_key": acctest.Representation{RepType: acctest.Required, Create: `mysecret`},
+				"locks":             acctest.RepresentationGroup{RepType: acctest.Optional, Group: connectionLocksRepresentation},
+				"is_lock_override":  acctest.Representation{RepType: acctest.Required, Create: `true`, Update: `true`},
+				"lifecycle":         acctest.RepresentationGroup{RepType: acctest.Required, Group: ignoreDefinedTagsAndLocks},
 			},
 		},
 
@@ -504,6 +512,7 @@ var (
 		"core_site_xml",
 		"secret_access_key",
 		"service_account_key_file",
+		"is_lock_override",
 	}
 )
 
@@ -760,6 +769,9 @@ func sweepGoldenGateConnectionResource(compartment string) error {
 
 			deleteConnectionRequest.ConnectionId = &connectionId
 
+			var overrideLock = true
+			deleteConnectionRequest.IsLockOverride = &overrideLock
+
 			deleteConnectionRequest.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(true, "golden_gate")
 			_, error := goldenGateClient.DeleteConnection(context.Background(), deleteConnectionRequest)
 			if error != nil {

internal/integrationtest/golden_gate_deployment_backup_test.go

@@ -68,6 +68,21 @@ func TestGoldenGateDeploymentBackupResource_basic(t *testing.T) {
 			"lifecycle":      acctest.RepresentationGroup{RepType: acctest.Required, Group: ignoreDefinedTagsChangesRepresentation},
 		}
 
+		deploymentBackupLocksRepresentation = map[string]interface{}{
+			"type":    acctest.Representation{RepType: acctest.Required, Create: `FULL`},
+			"message": acctest.Representation{RepType: acctest.Required, Create: `message`},
+		}
+
+		ignoreDefinedTagsAndLocks = map[string]interface{}{
+			"ignore_changes": acctest.Representation{RepType: acctest.Required, Create: []string{`locks`, `defined_tags`, `is_lock_override`}},
+		}
+
+		lockedDeploymentBackupRepresentation = acctest.RepresentationCopyWithNewProperties(deploymentBackupRepresentation, map[string]interface{}{
+			"locks":            acctest.RepresentationGroup{RepType: acctest.Required, Group: deploymentBackupLocksRepresentation},
+			"is_lock_override": acctest.Representation{RepType: acctest.Required, Create: `true`, Update: `true`},
+			"lifecycle":        acctest.RepresentationGroup{RepType: acctest.Required, Group: ignoreDefinedTagsAndLocks},
+		})
+
 		DeploymentBackupRequiredOnlyResource = acctest.GenerateResourceFromRepresentationMap("oci_golden_gate_deployment_backup", "test_deployment_backup", acctest.Required, acctest.Create, deploymentBackupRepresentation)
 
 		deploymentBackupDataSourceFilterRepresentation = map[string]interface{}{
@@ -106,10 +121,10 @@ func TestGoldenGateDeploymentBackupResource_basic(t *testing.T) {
 		acctest.GenerateResourceFromRepresentationMap("oci_golden_gate_deployment_backup", "test_deployment_backup", acctest.Optional, acctest.Create, deploymentBackupRepresentation))
 
 	acctest.ResourceTest(t, testAccCheckGoldenGateDeploymentBackupDestroy, []resource.TestStep{
-		// verify Create
+		// verify Create with Lock
 		{
 			Config: config +
-				acctest.GenerateResourceFromRepresentationMap("oci_golden_gate_deployment_backup", "test_deployment_backup", acctest.Required, acctest.Create, deploymentBackupRepresentation),
+				acctest.GenerateResourceFromRepresentationMap("oci_golden_gate_deployment_backup", "test_deployment_backup", acctest.Required, acctest.Create, lockedDeploymentBackupRepresentation),
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
 				resource.TestCheckResourceAttrSet(resourceName, "bucket"),
 				resource.TestCheckResourceAttr(resourceName, "compartment_id", testCompartmentId),
@@ -118,6 +133,9 @@ func TestGoldenGateDeploymentBackupResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttr(resourceName, "display_name", "demoDeploymentBackup"),
 				resource.TestCheckResourceAttrSet(resourceName, "namespace"),
 				resource.TestCheckResourceAttr(resourceName, "object", "object"),
+				resource.TestCheckResourceAttr(resourceName, "locks.0.type", "FULL"),
+				resource.TestCheckResourceAttr(resourceName, "locks.0.message", "message"),
+				resource.TestCheckResourceAttrSet(resourceName, "locks.0.time_created"),
 
 				func(s *terraform.State) (err error) {
 					resId, err = acctest.FromInstanceState(s, resourceName, "id")
@@ -126,7 +144,7 @@ func TestGoldenGateDeploymentBackupResource_basic(t *testing.T) {
 			),
 		},
 
-		// delete before next Create
+		// delete Locked before next Create
 		{
 			Config: config,
 		},
@@ -334,6 +352,9 @@ func sweepGoldenGateDeploymentBackupResource(compartment string) error {
 
 			deleteDeploymentBackupRequest.DeploymentBackupId = &deploymentBackupId
 
+			var overrideLock = true
+			deleteDeploymentBackupRequest.IsLockOverride = &overrideLock
+
 			deleteDeploymentBackupRequest.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(true, "golden_gate")
 			_, error := goldenGateClient.DeleteDeploymentBackup(context.Background(), deleteDeploymentBackupRequest)
 			if error != nil {

internal/integrationtest/golden_gate_deployment_test.go

@@ -144,6 +144,21 @@ func TestGoldenGateDeploymentResource_basic(t *testing.T) {
 			"maintenance_window":        acctest.RepresentationGroup{RepType: acctest.Required, Group: deploymentMaintenanceWindowRepresentation},
 		}
 
+		deploymentLocksRepresentation = map[string]interface{}{
+			"type":    acctest.Representation{RepType: acctest.Required, Create: `FULL`},
+			"message": acctest.Representation{RepType: acctest.Optional, Create: `message`},
+		}
+
+		ignoreDefinedTagsAndLocks = map[string]interface{}{
+			"ignore_changes": acctest.Representation{RepType: acctest.Required, Create: []string{`locks`, `defined_tags`, `is_lock_override`}},
+		}
+
+		lockedDeploymentRepresentation = acctest.RepresentationCopyWithNewProperties(goldenGateDeploymentRepresentation, map[string]interface{}{
+			"locks":            acctest.RepresentationGroup{RepType: acctest.Optional, Group: deploymentLocksRepresentation},
+			"is_lock_override": acctest.Representation{RepType: acctest.Required, Create: `true`, Update: `true`},
+			"lifecycle":        acctest.RepresentationGroup{RepType: acctest.Required, Group: ignoreDefinedTagsAndLocks},
+		})
+
 		goldenGateDeploymentSingularDataSourceRepresentation = map[string]interface{}{
 			"deployment_id": acctest.Representation{RepType: acctest.Required, Create: `${oci_golden_gate_deployment.depl_test_ggs_deployment.id}`},
 		}
@@ -558,36 +573,43 @@ func TestGoldenGateDeploymentResource_basic(t *testing.T) {
 			Config: config,
 		},
 		/* Start/stop/upgrade test*/
-		// 0. create a new deployment and stop it right after the creation
+		// 0. create a new and locked deployment and stop it right after the creation
 		{
 			Config: config +
 				acctest.GenerateResourceFromRepresentationMap("oci_golden_gate_deployment", "depl_test_ggs_deployment", acctest.Optional, acctest.Create,
-					acctest.RepresentationCopyWithNewProperties(goldenGateDeploymentRepresentation, map[string]interface{}{
+					acctest.RepresentationCopyWithNewProperties(lockedDeploymentRepresentation, map[string]interface{}{
 						"state":    acctest.Representation{RepType: acctest.Optional, Create: string(oci_golden_gate.LifecycleStateInactive)},
 						"ogg_data": acctest.RepresentationGroup{RepType: acctest.Required, Group: oggDataForUpgradeRepresentation},
 					})),
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
 				resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
 				resource.TestCheckResourceAttr(resourceName, "state", string(oci_golden_gate.LifecycleStateInactive)),
 				resource.TestCheckResourceAttr(resourceName, "ogg_data.0.ogg_version", baseOggVersion),
+				resource.TestCheckResourceAttr(resourceName, "locks.0.type", "FULL"),
+				resource.TestCheckResourceAttr(resourceName, "locks.0.message", "message"),
+				resource.TestCheckResourceAttrSet(resourceName, "locks.0.time_created"),
+
 				func(s *terraform.State) (err error) {
 					resId, err = acctest.FromInstanceState(s, resourceName, "id")
 					return err
 				},
 			),
 		},
-		// 1. start the deployment and upgrade it at the same time
+		// 1. start the locked deployment and upgrade it at the same time
 		{
 			Config: config +
 				acctest.GenerateResourceFromRepresentationMap("oci_golden_gate_deployment", "depl_test_ggs_deployment", acctest.Optional, acctest.Update,
-					acctest.RepresentationCopyWithNewProperties(goldenGateDeploymentRepresentation, map[string]interface{}{
+					acctest.RepresentationCopyWithNewProperties(lockedDeploymentRepresentation, map[string]interface{}{
 						"state":    acctest.Representation{RepType: acctest.Optional, Create: string(oci_golden_gate.LifecycleStateActive)},
 						"ogg_data": acctest.RepresentationGroup{RepType: acctest.Required, Group: oggDataForUpgradeRepresentation},
 					})),
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
 				resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
 				resource.TestCheckResourceAttr(resourceName, "state", string(oci_golden_gate.LifecycleStateActive)),
 				resource.TestCheckResourceAttr(resourceName, "ogg_data.0.ogg_version", upgradedOggVersion),
+				resource.TestCheckResourceAttr(resourceName, "locks.0.type", "FULL"),
+				resource.TestCheckResourceAttr(resourceName, "locks.0.message", "message"),
+				resource.TestCheckResourceAttrSet(resourceName, "locks.0.time_created"),
 				func(s *terraform.State) (err error) {
 					resId2, err = acctest.FromInstanceState(s, resourceName, "id")
 					if resId != resId2 {
@@ -731,6 +753,9 @@ func sweepGoldenGateDeploymentResource(compartment string) error {
 
 			deleteDeploymentRequest.DeploymentId = &deploymentId
 
+			var overrideLock = true
+			deleteDeploymentRequest.IsLockOverride = &overrideLock
+
 			deleteDeploymentRequest.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(true, "golden_gate")
 			_, error := goldenGateClient.DeleteDeployment(context.Background(), deleteDeploymentRequest)
 			if error != nil {

internal/service/golden_gate/golden_gate_connection_assignment_resource.go

@@ -42,6 +42,12 @@ func GoldenGateConnectionAssignmentResource() *schema.Resource {
 			},
 
 			// Optional
+			"is_lock_override": {
+				Type:     schema.TypeBool,
+				Optional: true,
+				Computed: true,
+				ForceNew: true,
+			},
 
 			// Computed
 			"alias_name": {
@@ -127,6 +133,11 @@ func (s *GoldenGateConnectionAssignmentResourceCrud) Create() error {
 		request.DeploymentId = &tmp
 	}
 
+	if isLockOverride, ok := s.D.GetOkExists("is_lock_override"); ok {
+		tmp := isLockOverride.(bool)
+		request.IsLockOverride = &tmp
+	}
+
 	request.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(s.DisableNotFoundRetries, "golden_gate")
 	response, err := s.Client.CreateConnectionAssignment(context.Background(), request)
 
@@ -265,6 +276,11 @@ func (s *GoldenGateConnectionAssignmentResourceCrud) Delete() error {
 	tmp := s.D.Id()
 	request.ConnectionAssignmentId = &tmp
 
+	if isLockOverride, ok := s.D.GetOkExists("is_lock_override"); ok {
+		tmp := isLockOverride.(bool)
+		request.IsLockOverride = &tmp
+	}
+
 	request.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(s.DisableNotFoundRetries, "golden_gate")
 
 	response, err := s.Client.DeleteConnectionAssignment(context.Background(), request)