Support for Moving DRG Resources Across Compartments

Author: abhilash-av

CHANGELOG.md

@@ -3,6 +3,7 @@
 ### Added
 - Support DBaaS VM DB Fast Provisioning
 - Support for required default tags
+- Support for moving `oci_core_drg` resources across compartments
 
 ### Fixed
 - Fix compositeId parsing for pre-authenticated requests in object storage [Issue #867](https://github.com/terraform-providers/terraform-provider-oci/issues/867)

oci/core_drg_resource.go

@@ -8,6 +8,7 @@ import (
 	"github.com/hashicorp/terraform/helper/schema"
 
 	oci_core "github.com/oracle/oci-go-sdk/core"
+	oci_work_requests "github.com/oracle/oci-go-sdk/workrequests"
 )
 
 func CoreDrgResource() *schema.Resource {
@@ -25,7 +26,6 @@ func CoreDrgResource() *schema.Resource {
 			"compartment_id": {
 				Type:     schema.TypeString,
 				Required: true,
-				ForceNew: true,
 			},
 
 			// Optional
@@ -81,7 +81,7 @@ func updateCoreDrg(d *schema.ResourceData, m interface{}) error {
 	sync := &CoreDrgResourceCrud{}
 	sync.D = d
 	sync.Client = m.(*OracleClients).virtualNetworkClient
-
+	sync.workRequestClient = m.(*OracleClients).workRequestClient
 	return UpdateResource(d, sync)
 }
 
@@ -97,6 +97,7 @@ func deleteCoreDrg(d *schema.ResourceData, m interface{}) error {
 type CoreDrgResourceCrud struct {
 	BaseCrud
 	Client                 *oci_core.VirtualNetworkClient
+	workRequestClient      *oci_work_requests.WorkRequestClient
 	Res                    *oci_core.Drg
 	DisableNotFoundRetries bool
 }
@@ -183,6 +184,15 @@ func (s *CoreDrgResourceCrud) Get() error {
 }
 
 func (s *CoreDrgResourceCrud) Update() error {
+	if compartment, ok := s.D.GetOkExists("compartment_id"); ok && s.D.HasChange("compartment_id") {
+		oldRaw, newRaw := s.D.GetChange("compartment_id")
+		if newRaw != "" && oldRaw != "" {
+			err := s.updateCompartment(compartment)
+			if err != nil {
+				return err
+			}
+		}
+	}
 	request := oci_core.UpdateDrgRequest{}
 
 	if definedTags, ok := s.D.GetOkExists("defined_tags"); ok {
@@ -251,3 +261,26 @@ func (s *CoreDrgResourceCrud) SetData() error {
 
 	return nil
 }
+
+func (s *CoreDrgResourceCrud) updateCompartment(compartment interface{}) error {
+	changeCompartmentRequest := oci_core.ChangeDrgCompartmentRequest{}
+
+	compartmentTmp := compartment.(string)
+	changeCompartmentRequest.CompartmentId = &compartmentTmp
+
+	idTmp := s.D.Id()
+	changeCompartmentRequest.DrgId = &idTmp
+
+	changeCompartmentRequest.RequestMetadata.RetryPolicy = getRetryPolicy(s.DisableNotFoundRetries, "core")
+
+	response, err := s.Client.ChangeDrgCompartment(context.Background(), changeCompartmentRequest)
+	if err != nil {
+		return err
+	}
+	workId := response.OpcWorkRequestId
+	_, err = WaitForWorkRequest(s.workRequestClient, workId, "core", oci_work_requests.WorkRequestResourceActionTypeUpdated, s.D.Timeout(schema.TimeoutUpdate), s.DisableNotFoundRetries)
+	if err != nil {
+		return err
+	}
+	return nil
+}

oci/core_drg_test.go

@@ -48,6 +48,9 @@ func TestCoreDrgResource_basic(t *testing.T) {
 	compartmentId := getEnvSettingWithBlankDefault("compartment_ocid")
 	compartmentIdVariableStr := fmt.Sprintf("variable \"compartment_id\" { default = \"%s\" }\n", compartmentId)
 
+	compartmentIdU := getEnvSettingWithDefault("compartment_id_for_update", compartmentId)
+	compartmentIdUVariableStr := fmt.Sprintf("variable \"compartment_id_for_update\" { default = \"%s\" }\n", compartmentIdU)
+
 	resourceName := "oci_core_drg.test_drg"
 	datasourceName := "data.oci_core_drgs.test_drgs"
 
@@ -97,6 +100,31 @@ func TestCoreDrgResource_basic(t *testing.T) {
 				),
 			},
 
+			// verify update to the compartment (the compartment will be switched back in the next step)
+			{
+				Config: config + compartmentIdVariableStr + compartmentIdUVariableStr + DrgResourceDependencies +
+					generateResourceFromRepresentationMap("oci_core_drg", "test_drg", Optional, Create,
+						representationCopyWithNewProperties(drgRepresentation, map[string]interface{}{
+							"compartment_id": Representation{repType: Required, create: `${var.compartment_id_for_update}`},
+						})),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentIdU),
+					resource.TestCheckResourceAttr(resourceName, "defined_tags.%", "1"),
+					resource.TestCheckResourceAttr(resourceName, "display_name", "MyDrg"),
+					resource.TestCheckResourceAttr(resourceName, "freeform_tags.%", "1"),
+					resource.TestCheckResourceAttrSet(resourceName, "id"),
+					resource.TestCheckResourceAttrSet(resourceName, "state"),
+
+					func(s *terraform.State) (err error) {
+						resId2, err = fromInstanceState(s, resourceName, "id")
+						if resId != resId2 {
+							return fmt.Errorf("resource recreated when it was supposed to be updated")
+						}
+						return err
+					},
+				),
+			},
+
 			// verify updates to updatable parameters
 			{
 				Config: config + compartmentIdVariableStr + DrgResourceDependencies +

oci/crud_helpers.go

@@ -18,6 +18,7 @@ import (
 	oci_common "github.com/oracle/oci-go-sdk/common"
 	oci_identity "github.com/oracle/oci-go-sdk/identity"
 	oci_load_balancer "github.com/oracle/oci-go-sdk/loadbalancer"
+	oci_work_requests "github.com/oracle/oci-go-sdk/workrequests"
 
 	"github.com/terraform-providers/terraform-provider-oci/httpreplay"
 	"github.com/terraform-providers/terraform-provider-oci/metrics"
@@ -795,3 +796,75 @@ func getRetryPolicyWithAdditionalRetryCondition(timeout time.Duration, retryCond
 func elaspedInMillisecond(start time.Time) int64 {
 	return time.Since(start).Nanoseconds() / int64(time.Millisecond)
 }
+
+func WaitForWorkRequest(workRequestClient *oci_work_requests.WorkRequestClient, workRequestId *string, entityType string, action oci_work_requests.WorkRequestResourceActionTypeEnum,
+	timeout time.Duration, disableFoundRetries bool) (*string, error) {
+	retryPolicy := getRetryPolicy(disableFoundRetries, "work_request")
+	retryPolicy.ShouldRetryOperation = workRequestShouldRetryFunc(timeout)
+
+	response := oci_work_requests.GetWorkRequestResponse{}
+	stateConf := &resource.StateChangeConf{
+		Pending: []string{
+			string(oci_work_requests.WorkRequestStatusInProgress),
+			string(oci_work_requests.WorkRequestStatusAccepted),
+			string(oci_work_requests.WorkRequestStatusCanceling),
+		},
+		Target: []string{
+			string(oci_work_requests.WorkRequestStatusSucceeded),
+			string(oci_work_requests.WorkRequestStatusFailed),
+			string(oci_work_requests.WorkRequestStatusCanceled),
+		},
+		Refresh: func() (interface{}, string, error) {
+			var err error
+			response, err = workRequestClient.GetWorkRequest(context.Background(),
+				oci_work_requests.GetWorkRequestRequest{
+					WorkRequestId: workRequestId,
+					RequestMetadata: oci_common.RequestMetadata{
+						RetryPolicy: retryPolicy,
+					},
+				})
+			wr := &response.WorkRequest
+			return wr, string(wr.Status), err
+		},
+		Timeout: timeout,
+	}
+	if _, e := stateConf.WaitForState(); e != nil {
+		return nil, e
+	}
+
+	var identifier *string
+	// The work request response contains an array of objects that finished the operation
+	for _, res := range response.Resources {
+		if strings.Contains(strings.ToLower(*res.EntityType), entityType) {
+			if res.ActionType == action {
+				identifier = res.Identifier
+				break
+			}
+		}
+	}
+
+	return identifier, nil
+}
+
+func workRequestShouldRetryFunc(timeout time.Duration) func(response oci_common.OCIOperationResponse) bool {
+	startTime := time.Now()
+	stopTime := startTime.Add(timeout)
+	return func(response oci_common.OCIOperationResponse) bool {
+
+		// Stop after timeout has elapsed
+		if time.Now().After(stopTime) {
+			return false
+		}
+
+		// Make sure we stop on default rules
+		if shouldRetry(response, false, "work_request", startTime) {
+			return true
+		}
+
+		// Only stop if the time Finished is set
+		if workRequestResponse, ok := response.Response.(oci_work_requests.GetWorkRequestResponse); ok {
+			return workRequestResponse.TimeFinished == nil
+		}
+		return false
+	}
+}

oci/provider_clients.go

@@ -24,6 +24,7 @@ import (
 	oci_ons "github.com/oracle/oci-go-sdk/ons"
 	oci_streaming "github.com/oracle/oci-go-sdk/streaming"
 	oci_waas "github.com/oracle/oci-go-sdk/waas"
+	oci_work_requests "github.com/oracle/oci-go-sdk/workrequests"
 
 	oci_common "github.com/oracle/oci-go-sdk/common"
 )
@@ -59,6 +60,7 @@ type OracleClients struct {
 	streamAdminClient              *oci_streaming.StreamAdminClient
 	virtualNetworkClient           *oci_core.VirtualNetworkClient
 	waasClient                     *oci_waas.WaasClient
+	workRequestClient              *oci_work_requests.WorkRequestClient
 }
 
 func (m *OracleClients) FunctionsInvokeClient(endpoint string) (*oci_functions.FunctionsInvokeClient, error) {
@@ -386,5 +388,15 @@ func createSDKClients(clients *OracleClients, configProvider oci_common.Configur
 	}
 	clients.waasClient = &waasClient
 
+	workRequestClient, err := oci_work_requests.NewWorkRequestClientWithConfigurationProvider(configProvider)
+	if err != nil {
+		return
+	}
+	err = configureClient(&workRequestClient.BaseClient)
+	if err != nil {
+		return
+	}
+	clients.workRequestClient = &workRequestClient
+
 	return
 }