Add support for block volume fast clones (#347)

codycushing · web-flow · commit 14863975f624 · 2017-11-02T01:00:26.000-07:00
* Support creating clones from a running instance or a volume backup
diff --git a/data_source_obmcs_core_volumes.go b/data_source_obmcs_core_volumes.go
@@ -103,6 +103,14 @@ func (s *VolumeDatasourceCrud) SetData() {
 			"state":               v.State,
 			"time_created":        v.TimeCreated.String(),
 		}
+
+		if vsdRaw := v.VolumeSourceDetails; vsdRaw != nil {
+			vsd := make(map[string]interface{})
+			vsd["id"] = vsdRaw.Id
+			vsd["type"] = vsdRaw.Type
+			vol["source_details"] = []interface{}{vsd}
+		}
+
 		resources = append(resources, vol)
 	}
 
diff --git a/data_source_obmcs_core_volumes_test.go b/data_source_obmcs_core_volumes_test.go
@@ -34,6 +34,17 @@ func (s *DatasourceCoreVolumeTestSuite) SetupTest() {
 		compartment_id = "${var.compartment_id}"
 		display_name = "-tf-volume"
 		size_in_gbs = 50
+	}
+	
+	resource "oci_core_volume" "u" {
+		availability_domain = "${data.oci_identity_availability_domains.ADs.availability_domains.0.name}"
+		compartment_id = "${var.compartment_id}"
+		display_name = "-tf-volume-clone"
+		size_in_gbs = 50
+		source_details {
+			type = "volume"
+			id = "${oci_core_volume.t.id}"
+		}
 	}`
 	s.ResourceName = "data.oci_core_volumes.t"
 }
@@ -82,6 +93,22 @@ func (s *DatasourceCoreVolumeTestSuite) TestAccDatasourceCoreVolume_basic() {
 					resource.TestCheckResourceAttr(s.ResourceName, "volumes.0.size_in_mbs", "51200"),
 				),
 			},
+			{
+				Config: s.Config + `
+				data "oci_core_volumes" "u" {
+					availability_domain = "${data.oci_identity_availability_domains.ADs.availability_domains.0.name}"
+					compartment_id = "${oci_core_volume.u.compartment_id}"
+					filter {
+						name = "id"
+						values = ["${oci_core_volume.u.id}"]
+					}
+				}`,
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("data.oci_core_volumes.u", "volumes.#", "1"),
+					resource.TestCheckResourceAttr("data.oci_core_volumes.u", "volumes.0.source_details.0.type", "volume"),
+					resource.TestCheckResourceAttrSet("data.oci_core_volumes.u", "volumes.0.source_details.0.id"),
+				),
+			},
 		},
 	},
 	)
diff --git a/docs/datasources/core/volumes.md b/docs/datasources/core/volumes.md
@@ -38,3 +38,4 @@ The following attributes are exported:
 * `state` - The current state of the volume. Allowed values are: [PROVISIONING, RESTORING, AVAILABLE, TERMINATING, TERMINATED, FAULTY]
 * `size_in_gbs` - The size of the volume, in GBs. The size must be a multiple of 1024.
 * `time_created` - The date and time the Volume was created, in the format defined by RFC3339.  Example: `2016-08-25T21:10:29.600Z`.
+* `source_details` - Specifies the volume source details for a new Block Volume.
diff --git a/docs/resources/core/volume.md b/docs/resources/core/volume.md
@@ -1,15 +1,15 @@
 # oci\_core\_volumes
 
-Gets a list of volumes in a compartment.
+Create a volume.
 
 ## Example Usage
 
 ```
 resource "oci_core_volume" "t" {
     availability_domain = "availability_domain"
     compartment_id = "compartment_id"
-    size_in_gbs = 50
     volume_backup_id = "volume_id"
+    size_in_gbs = 50
 }
 ```
 
@@ -21,6 +21,27 @@ The following arguments are supported:
 * `compartment_id` - (Required) The OCID of the compartment.
 * `display_name` - (Optional) A user-friendly name. Does not have to be unique, and it's changeable.
 * `volume_backup_id` - (Optional) The OCID of the volume backup from which the data should be restored on the newly created volume.
+* `source_details` - (Optional) Specifies the volume source details for a new Block Volume. 
+See [Source Details](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/requests/CreateVolumeDetails) documentation.
+Example usage: 
+```
+resource "oci_core_volume" "t" {
+    
+    source_details {
+        type = "volume"
+        id = "${var.volume_id}"
+    }
+     
+    // or
+     
+    source_details {
+        type = "volumeBackup"
+        id = "${var.volume_backup_id}" // note: this requires an oci_core_volume_backup resource OCID
+    }
+    ...
+}
+```
+
 
 ## Attributes Reference
 * `availability_domain` - The availability domain of the volume.
@@ -31,3 +52,4 @@ The following arguments are supported:
 * `size_in_mbs` - (Deprecated) The size of the volume, in MBs.
 * `size_in_gbs` - The size of the volume, in GBs.
 * `time_created` - The date and time the Volume was created.
+* `source_details` - Specifies the volume source details for a new Block Volume.
diff --git a/resource_obmcs_core_volume.go b/resource_obmcs_core_volume.go
@@ -67,6 +67,27 @@ func VolumeResource() *schema.Resource {
 				Type:     schema.TypeString,
 				Computed: true,
 			},
+			"source_details": {
+				Type:     schema.TypeList,
+				Optional: true,
+				ForceNew: true,
+				MaxItems: 1,
+				MinItems: 1,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"id": {
+							Type:     schema.TypeString,
+							Required: true,
+							ForceNew: true,
+						},
+						"type": {
+							Type:     schema.TypeString,
+							Required: true,
+							ForceNew: true,
+						},
+					},
+				},
+			},
 		},
 	}
 }
@@ -159,6 +180,15 @@ func (s *VolumeResourceCrud) Create() (e error) {
 		opts.VolumeBackupID = volumeBackupID.(string)
 	}
 
+	if sourceDetailsList, listOk := s.D.GetOk("source_details"); listOk {
+		sourceDetailsItem := sourceDetailsList.([]interface{})[0] // if listOk this is assured to have exactly 1 item
+		sdItem := sourceDetailsItem.(map[string]interface{})
+		opts.VolumeSourceDetails = &baremetal.VolumeSourceDetails{
+			sdItem["id"].(string),
+			sdItem["type"].(string),
+		}
+	}
+
 	s.Res, e = s.Client.CreateVolume(availabilityDomain, compartmentID, opts)
 
 	return
@@ -192,6 +222,13 @@ func (s *VolumeResourceCrud) SetData() {
 	s.D.Set("size_in_gbs", s.Res.SizeInGBs)
 	s.D.Set("state", s.Res.State)
 	s.D.Set("time_created", s.Res.TimeCreated.String())
+
+	if vsdRaw := s.Res.VolumeSourceDetails; vsdRaw != nil {
+		vsd := make(map[string]interface{})
+		vsd["id"] = vsdRaw.Id
+		vsd["type"] = vsdRaw.Type
+		s.D.Set("source_details", vsd)
+	}
 }
 
 func (s *VolumeResourceCrud) Delete() (e error) {
diff --git a/resource_obmcs_core_volume_backup_test.go b/resource_obmcs_core_volume_backup_test.go
@@ -75,7 +75,7 @@ func (s *ResourceCoreVolumeBackupTestSuite) TestAccResourceCoreVolumeBackup_basi
 					resource.TestCheckResourceAttr(s.ResourceName, "display_name", "-tf-volume-backup"),
 				),
 			},
-			// verify restore
+			// verify conventional restore
 			{
 				Config: s.Config + `
 					resource "oci_core_volume_backup" "t" {
@@ -93,6 +93,30 @@ func (s *ResourceCoreVolumeBackupTestSuite) TestAccResourceCoreVolumeBackup_basi
 					resource.TestCheckResourceAttr("oci_core_volume.t2", "display_name", "-tf-volume-restored"),
 				),
 			},
+			// verify clone from backup
+			{
+				Config: s.Config + `
+					resource "oci_core_volume_backup" "t" {
+						volume_id = "${oci_core_volume.t.id}"
+						display_name = "-tf-volume-backup"
+					}
+					resource "oci_core_volume" "u" {
+						availability_domain = "${data.oci_identity_availability_domains.ADs.availability_domains.0.name}"
+						compartment_id = "${var.compartment_id}"
+						display_name = "-tf-volume-clone"
+						size_in_gbs = 50
+						source_details {
+							type = "volumeBackup"
+							id = "${oci_core_volume_backup.t.id}"
+						}
+					}`,
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet("oci_core_volume.u", "source_details.0.id"),
+					resource.TestCheckResourceAttr("oci_core_volume.u", "display_name", "-tf-volume-clone"),
+					resource.TestCheckResourceAttr("oci_core_volume.u", "source_details.0.type", "volumeBackup"),
+					resource.TestCheckResourceAttr("oci_core_volume.u", "state", baremetal.ResourceAvailable),
+				),
+			},
 		},
 	})
 }
diff --git a/resource_obmcs_core_volume_test.go b/resource_obmcs_core_volume_test.go
@@ -3,9 +3,10 @@
 package main
 
 import (
+	"testing"
+
 	"fmt"
 	"regexp"
-	"testing"
 
 	"github.com/hashicorp/terraform/helper/resource"
 	"github.com/hashicorp/terraform/terraform"
@@ -20,8 +21,6 @@ type ResourceCoreVolumeTestSuite struct {
 	Providers    map[string]terraform.ResourceProvider
 	Config       string
 	ResourceName string
-	Res          *baremetal.Volume
-	DeletedRes   *baremetal.Volume
 }
 
 func (s *ResourceCoreVolumeTestSuite) SetupTest() {
@@ -102,6 +101,32 @@ func (s *ResourceCoreVolumeTestSuite) TestCreateResourceCoreVolume_basic() {
 				}`,
 				ExpectNonEmptyPlan: false,
 			},
+			// create a clone off the existing volume
+			{
+				Config: s.Config + `
+				resource "oci_core_volume" "t" {
+					availability_domain = "${data.oci_identity_availability_domains.ADs.availability_domains.0.name}"
+					compartment_id = "${var.compartment_id}"
+					display_name = "-tf-volume"
+					size_in_gbs = 50
+				}
+				resource "oci_core_volume" "u" {
+					availability_domain = "${data.oci_identity_availability_domains.ADs.availability_domains.0.name}"
+					compartment_id = "${var.compartment_id}"
+					display_name = "-tf-volume-clone"
+					size_in_gbs = 50
+					source_details {
+						type = "volume"
+						id = "${oci_core_volume.t.id}"
+					}
+				}`,
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet("oci_core_volume.u", "source_details.0.id"),
+					resource.TestCheckResourceAttr("oci_core_volume.u", "display_name", "-tf-volume-clone"),
+					resource.TestCheckResourceAttr("oci_core_volume.u", "source_details.0.type", "volume"),
+					resource.TestCheckResourceAttr("oci_core_volume.u", "state", baremetal.ResourceAvailable),
+				),
+			},
 		},
 	})
 }
diff --git a/vendor/github.com/oracle/bmcs-go-sdk/core_volume.go b/vendor/github.com/oracle/bmcs-go-sdk/core_volume.go
diff --git a/vendor/github.com/oracle/bmcs-go-sdk/request_options.go b/vendor/github.com/oracle/bmcs-go-sdk/request_options.go
diff --git a/vendor/vendor.json b/vendor/vendor.json
@@ -2972,10 +2972,10 @@
 			"revisionTime": "2017-01-25T16:36:56Z"
 		},
 		{
-			"checksumSHA1": "Swv3Qr8tQWyEN9KlAYC6eyD1J8E=",
+			"checksumSHA1": "FZuTNT1Cksd4WxwAFXS42LvbOtA=",
 			"path": "github.com/oracle/bmcs-go-sdk",
-			"revision": "b4d4e32d4024fff11c732f5e3721c86c418b35ff",
-			"revisionTime": "2017-10-20T22:37:45Z",
+			"revision": "79eba688b52b26d9b38e71860e69cd671fed7979",
+			"revisionTime": "2017-11-01T22:20:57Z",
 			"version": "add-db-license-model",
 			"versionExact": "add-db-license-model"
 		},

Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,14 @@ func (s *VolumeDatasourceCrud) SetData() {`
`103`	`103`	`"state": v.State,`
`104`	`104`	`"time_created": v.TimeCreated.String(),`
`105`	`105`	`}`
	`106`	`+`
	`107`	`+ if vsdRaw := v.VolumeSourceDetails; vsdRaw != nil {`
	`108`	`+ vsd := make(map[string]interface{})`
	`109`	`+ vsd["id"] = vsdRaw.Id`
	`110`	`+ vsd["type"] = vsdRaw.Type`
	`111`	`+ vol["source_details"] = []interface{}{vsd}`
	`112`	`+ }`
	`113`	`+`
`106`	`114`	`resources = append(resources, vol)`
`107`	`115`	`}`
`108`	`116`