SSH signed commit (#3201)

feat(block): support export to s3

feat(block): support export to s3

fix linter

signed with SSH

Author: Laure-di

docs/resources/block_snapshot.md

@@ -29,6 +29,52 @@ resource "scaleway_block_snapshot" "block_snapshot" {
 }
 ```
 
+### How to import from Object Storage
+
+```terraform
+resource "scaleway_object_bucket" "my-import-bucket" {
+  name = "snapshot-bucket-to-import"
+}
+
+resource "scaleway_object" "qcow-object" {
+  bucket = scaleway_object_bucket.snapshot-bucket.name
+  key    = "my-snapshot.qcow2"
+  file   = "imported-snapshot/snapshot.qcow2"
+}
+resource "scaleway_block_volume" "imported" {
+  iops = 5000
+  name = "imported-from-qcow"
+
+  import {
+    bucket = "my-import-bucket"
+    key    = "imported-snapshot/snapshot.qcow2"
+  }
+}
+```
+
+### How to export to Object Storage
+
+```terraform
+resource "scaleway_object_bucket" "my-import-bucket" {
+      name = "snapshot-bucket-to-import"
+}
+
+resource "scaleway_object" "qcow-object" {
+      bucket = scaleway_object_bucket.snapshot-bucket.name
+      key    = "export/my-snapshot.qcow2"
+}
+
+resource "scaleway_block_volume" "to_export" {
+  iops = 5000
+  name = "to-export"
+
+  export {
+    bucket = "snapshot-bucket-to-import"
+    key    = "exports/my-snapshot.qcow2"
+  }
+}
+```
+
 ## Argument Reference
 
 This section lists the arguments that are supported:
@@ -38,6 +84,12 @@ This section lists the arguments that are supported:
 - `zone` - (Defaults to the zone specified in the [provider configuration](../index.md#zone)). The [zone](../guides/regions_and_zones.md#zones) in which the snapshot should be created.
 - `project_id` - (Defaults to the Project ID specified in the [provider configuration](../index.md#project_id)). The ID of the Scaleway Project the snapshot is associated with.
 - `tags` - (Optional) A list of tags to apply to the snapshot.
+- `import` - (Optional)  Use this block to import a QCOW image from Object Storage to create a volume.
+      - `bucket` – (Required) The name of the bucket containing the QCOW file.
+      - `key` – (Required) The key of the QCOW file within the bucket.
+- `export` - (Optional) Use this block to export the volume as a QCOW file to Object Storage.
+      - `bucket` – (Required) The name of the bucket where the QCOW file will be saved.
+      - `key` – (Required) The desired key (path) for the QCOW file within the bucket.
 
 ## Attributes Reference
 

internal/services/block/snapshot.go

@@ -84,6 +84,30 @@ func ResourceSnapshot() *schema.Resource {
 				Description:   "Import snapshot from a qcow",
 				ConflictsWith: []string{"volume_id"},
 			},
+			"export": {
+				Type:     schema.TypeList,
+				MaxItems: 1,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"bucket": {
+							Type:             schema.TypeString,
+							Required:         true,
+							Description:      "Bucket containing qcow",
+							DiffSuppressFunc: dsf.Locality,
+							StateFunc: func(i any) string {
+								return regional.ExpandID(i.(string)).ID
+							},
+						},
+						"key": {
+							Type:        schema.TypeString,
+							Required:    true,
+							Description: "Key of the qcow file in the specified bucket",
+						},
+					},
+				},
+				Optional:    true,
+				Description: "Export snapshot to a qcow",
+			},
 			"zone":       zonal.Schema(),
 			"project_id": account.ProjectIDSchema(),
 		},
@@ -132,6 +156,20 @@ func ResourceBlockSnapshotCreate(ctx context.Context, d *schema.ResourceData, m
 		return diag.FromErr(err)
 	}
 
+	if _, shouldExport := d.GetOk("export"); shouldExport {
+		req := block.ExportSnapshotToObjectStorageRequest{
+			Zone:       zone,
+			SnapshotID: snapshot.ID,
+			Bucket:     regional.ExpandID(d.Get("export.0.bucket")).ID,
+			Key:        d.Get("export.0.key").(string),
+		}
+
+		_, err = api.ExportSnapshotToObjectStorage(&req, scw.WithContext(ctx))
+		if err != nil {
+			return diag.FromErr(err)
+		}
+	}
+
 	return ResourceBlockSnapshotRead(ctx, d, m)
 }
 
@@ -201,6 +239,20 @@ func ResourceBlockSnapshotUpdate(ctx context.Context, d *schema.ResourceData, m
 		return diag.FromErr(err)
 	}
 
+	if shouldExport := d.HasChange("export"); shouldExport {
+		req := block.ExportSnapshotToObjectStorageRequest{
+			Zone:       zone,
+			SnapshotID: snapshot.ID,
+			Bucket:     regional.ExpandID(d.Get("export.0.bucket")).ID,
+			Key:        d.Get("export.0.key").(string),
+		}
+
+		_, err = api.ExportSnapshotToObjectStorage(&req, scw.WithContext(ctx))
+		if err != nil {
+			return diag.FromErr(err)
+		}
+	}
+
 	return ResourceBlockSnapshotRead(ctx, d, m)
 }
 

internal/services/block/snapshot_test.go

@@ -85,3 +85,107 @@ func TestAccSnapshot_FromS3(t *testing.T) {
 		},
 	})
 }
+
+func TestAccSnapshot_ToS3(t *testing.T) {
+	tt := acctest.NewTestTools(t)
+	defer tt.Cleanup()
+
+	bucketName := sdkacctest.RandomWithPrefix("test-acc-scaleway-export-block-snapshot")
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:          func() { acctest.PreCheck(t) },
+		ProviderFactories: tt.ProviderFactories,
+		CheckDestroy: resource.ComposeTestCheckFunc(
+			blocktestfuncs.IsSnapshotDestroyed(tt),
+			objectchecks.IsObjectDestroyed(tt),
+			objectchecks.IsBucketDestroyed(tt),
+		),
+		Steps: []resource.TestStep{
+			{
+				Config: fmt.Sprintf(`
+					resource scaleway_block_volume main {
+						iops = 5000
+						size_in_gb = 10
+					}
+
+					resource "scaleway_object_bucket" "snapshot-bucket" {
+					  name = "%s"
+					}
+					
+					resource "scaleway_object" "qcow-object" {
+					  bucket = scaleway_object_bucket.snapshot-bucket.name
+					  key    = "test-acc-export-block-snapshot-qcow2"
+					  content = "test"
+					}
+
+					resource "scaleway_block_snapshot" "qcow-block-snapshot" {
+					  name = "test-acc-export-block-snapshot-qcow2"
+					  volume_id = scaleway_block_volume.main.id
+					  export {
+					    bucket = scaleway_object.qcow-object.bucket
+					    key    = scaleway_object.qcow-object.key
+					  }
+					}
+				`, bucketName),
+				Check: resource.ComposeTestCheckFunc(
+					blocktestfuncs.IsSnapshotPresent(tt, "scaleway_block_snapshot.qcow-block-snapshot"),
+					acctest.CheckResourceAttrUUID("scaleway_block_snapshot.qcow-block-snapshot", "id"),
+					resource.TestCheckResourceAttr("scaleway_block_snapshot.qcow-block-snapshot", "name", "test-acc-export-block-snapshot-qcow2"),
+					objectchecks.IsObjectExists(tt, "scaleway_object.qcow-object"),
+				),
+			},
+			{
+				Config: fmt.Sprintf(`
+					resource scaleway_block_volume main {
+						iops = 5000
+						size_in_gb = 10
+					}
+
+					resource "scaleway_object_bucket" "snapshot-bucket" {
+					  name = "%s"
+					}
+					
+					resource "scaleway_object" "qcow-object" {
+					  bucket = scaleway_object_bucket.snapshot-bucket.name
+					  key    = "test-acc-export-block-snapshot-qcow2"
+					  content = "test"
+					}
+
+					resource "scaleway_block_snapshot" "qcow-block-export-snapshot" {
+					  name = "test-acc-export-block-snapshot-qcow2"
+					  volume_id = scaleway_block_volume.main.id
+					  export {
+					    bucket = scaleway_object.qcow-object.bucket
+					    key    = scaleway_object.qcow-object.key
+					  }
+					}
+
+					resource "scaleway_block_snapshot" "qcow-block-import-snapshot" {
+					  name = "test-acc-block-snapshot-qcow2"
+					  import {
+					    bucket = scaleway_object.qcow-object.bucket
+					    key    = scaleway_object.qcow-object.key
+					  }
+					}
+
+					resource scaleway_block_volume new-volume {
+						name = "test-block-volume-from-snapshot"
+						iops = 5000
+						snapshot_id = scaleway_block_snapshot.qcow-block-import-snapshot.id
+					}
+
+				`, bucketName),
+				Check: resource.ComposeTestCheckFunc(
+					blocktestfuncs.IsSnapshotPresent(tt, "scaleway_block_snapshot.qcow-block-export-snapshot"),
+					acctest.CheckResourceAttrUUID("scaleway_block_snapshot.qcow-block-export-snapshot", "id"),
+					resource.TestCheckResourceAttr("scaleway_block_snapshot.qcow-block-export-snapshot", "name", "test-acc-export-block-snapshot-qcow2"),
+					objectchecks.IsObjectExists(tt, "scaleway_object.qcow-object"),
+					blocktestfuncs.IsSnapshotPresent(tt, "scaleway_block_snapshot.qcow-block-import-snapshot"),
+					acctest.CheckResourceAttrUUID("scaleway_block_snapshot.qcow-block-import-snapshot", "id"),
+					resource.TestCheckResourceAttr("scaleway_block_volume.new-volume", "size_in_gb", "10"),
+					resource.TestCheckResourceAttr("scaleway_block_volume.new-volume", "iops", "5000"),
+					resource.TestCheckResourceAttrPair("scaleway_block_volume.new-volume", "snapshot_id", "scaleway_block_snapshot.qcow-block-import-snapshot", "id"),
+				),
+			},
+		},
+	})
+}