Support for moving Service Gateway resource across Compartments

Author: jiangong

CHANGELOG.md

@@ -4,6 +4,7 @@
 ### Added
 - Support for scheduling KMS key deletion
 - Support for moving Volumes, Volume groups, Boot Volumes and corresponding Backups across compartments
+- Support for moving Service Gateway resource across Compartments
 
 ## 3.29.0 (June 12, 2019)
 

oci/core_service_gateway_resource.go

@@ -28,7 +28,6 @@ func CoreServiceGatewayResource() *schema.Resource {
 			"compartment_id": {
 				Type:     schema.TypeString,
 				Required: true,
-				ForceNew: true,
 			},
 			"services": {
 				Type:     schema.TypeSet,
@@ -239,6 +238,15 @@ func (s *CoreServiceGatewayResourceCrud) Get() error {
 }
 
 func (s *CoreServiceGatewayResourceCrud) 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.UpdateServiceGatewayRequest{}
 
 	if blockTraffic, ok := s.D.GetOkExists("block_traffic"); ok {
@@ -377,3 +385,20 @@ func servicesHashCodeForSets(v interface{}) int {
 	}
 	return hashcode.String(buf.String())
 }
+func (s *CoreServiceGatewayResourceCrud) updateCompartment(compartment interface{}) error {
+	changeCompartmentRequest := oci_core.ChangeServiceGatewayCompartmentRequest{}
+
+	compartmentTmp := compartment.(string)
+	changeCompartmentRequest.CompartmentId = &compartmentTmp
+
+	idTmp := s.D.Id()
+	changeCompartmentRequest.ServiceGatewayId = &idTmp
+
+	changeCompartmentRequest.RequestMetadata.RetryPolicy = getRetryPolicy(s.DisableNotFoundRetries, "core")
+
+	_, err := s.Client.ChangeServiceGatewayCompartment(context.Background(), changeCompartmentRequest)
+	if err != nil {
+		return err
+	}
+	return nil
+}

oci/core_service_gateway_test.go

@@ -59,6 +59,9 @@ func TestCoreServiceGatewayResource_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_service_gateway.test_service_gateway"
 	datasourceName := "data.oci_core_service_gateways.test_service_gateways"
 
@@ -122,6 +125,39 @@ func TestCoreServiceGatewayResource_basic(t *testing.T) {
 				),
 			},
 
+			// verify update to the compartment (the compartment will be switched back in the next step)
+			{
+				Config: config + compartmentIdVariableStr + compartmentIdUVariableStr + ServiceGatewayResourceDependencies +
+					generateResourceFromRepresentationMap("oci_core_service_gateway", "test_service_gateway", Optional, Create,
+						representationCopyWithNewProperties(serviceGatewayRepresentation, map[string]interface{}{
+							"compartment_id": Representation{repType: Required, create: `${var.compartment_id_for_update}`},
+						})),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttrSet(resourceName, "block_traffic"),
+					resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentIdU),
+					resource.TestCheckResourceAttr(resourceName, "defined_tags.%", "1"),
+					resource.TestCheckResourceAttr(resourceName, "display_name", "displayName"),
+					resource.TestCheckResourceAttr(resourceName, "freeform_tags.%", "1"),
+					resource.TestCheckResourceAttrSet(resourceName, "id"),
+					resource.TestCheckResourceAttr(resourceName, "services.#", "1"),
+					CheckResourceSetContainsElementWithProperties(resourceName, "services", map[string]string{},
+						[]string{
+							"service_id",
+							"service_name",
+						}),
+					resource.TestCheckResourceAttrSet(resourceName, "state"),
+					resource.TestCheckResourceAttrSet(resourceName, "vcn_id"),
+
+					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 + ServiceGatewayResourceDependencies +

website/docs/d/core_service_gateways.html.markdown

@@ -30,9 +30,9 @@ data "oci_core_service_gateways" "test_service_gateways" {
 
 The following arguments are supported:
 
-* `compartment_id` - (Required) The OCID of the compartment.
+* `compartment_id` - (Required) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
 * `state` - (Optional) A filter to return only resources that match the given lifecycle state.  The state value is case-insensitive. 
-* `vcn_id` - (Optional) The OCID of the VCN.
+* `vcn_id` - (Optional) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.
 
 
 ## Attributes Reference

website/docs/r/core_service_gateway.html.markdown

@@ -43,7 +43,7 @@ resource "oci_core_service_gateway" "test_service_gateway" {
 
 The following arguments are supported:
 
-* `compartment_id` - (Required) The [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the service gateway. 
+* `compartment_id` - (Required) (Updatable) The [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the service gateway. 
 * `defined_tags` - (Optional) (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).  Example: `{"Operations.CostCenter": "42"}` 
 * `display_name` - (Optional) (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. 
 * `freeform_tags` - (Optional) (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).  Example: `{"Department": "Finance"}`