feat(block): add block volumes and snapshots (#1998)

* feat(block): add block_volume resource

* feat(block): add block_snapshot resource

* test volumes from snapshot and add tags

* add volume datasource

* add snapshot datasource

* update new api changes with iops parameter

* bump api and tests

* api merging

* wait for volume and references

* restore public sdk and record cassettes

* remove dead code

* lint

* enable Block acceptance tests

* add 410 Gone to cassette validation valid status

* add datasource cassettes

* add doc

* set iops to required

Author: Codelax

.github/workflows/acceptance-tests.yaml

@@ -14,6 +14,7 @@ jobs:
           - AppleSilicon
           - Baremetal
           - Billing
+          - Block
           - Cockpit
           - Container
           - Domain

docs/resources/block_snapshot.md

@@ -0,0 +1,44 @@
+---
+subcategory: "Block"
+page_title: "Scaleway: scaleway_block_snapshot"
+---
+
+# scaleway_block_snapshot
+
+Creates and manages Scaleway Block Snapshots.
+For more information, see [the documentation](https://www.scaleway.com/en/developers/api/block/).
+
+## Example
+
+```hcl
+resource "scaleway_block_snapshot" "block_snapshot" {
+    name       = "some-snapshot-name"
+    volume_id  = "11111111-1111-1111-1111-111111111111"
+}
+```
+
+## Arguments Reference
+
+The following arguments are supported:
+
+- `volume_id` - (Optional) The ID of the volume to take a snapshot from.
+- `name` - (Optional) The name of the snapshot. If not provided it will be randomly generated.
+- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the snapshot should be created.
+- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the snapshot is associated with.
+- `tags` - (Optional) A list of tags to apply to the snapshot.
+
+## Attributes Reference
+
+In addition to all above arguments, the following attributes are exported:
+
+- `id` - The ID of the snapshot.
+
+~> **Important:** Block snapshots' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
+
+## Import
+
+Block Snapshots can be imported using the `{zone}/{id}`, e.g.
+
+```bash
+$ terraform import scaleway_block_snapshot.main fr-par-1/11111111-1111-1111-1111-111111111111
+```

docs/resources/block_volume.md

@@ -0,0 +1,49 @@
+---
+subcategory: "Block"
+page_title: "Scaleway: scaleway_block_volume"
+---
+
+# scaleway_block_volume
+
+Creates and manages Scaleway Block Volumes.
+For more information, see [the documentation](https://www.scaleway.com/en/developers/api/block/).
+
+## Example
+
+```hcl
+resource "scaleway_block_volume" "block_volume" {
+    iops       = 5000
+    name       = "some-volume-name"
+    size_in_gb = 20
+}
+```
+
+## Arguments Reference
+
+The following arguments are supported:
+
+- `iops` - (Required) The maximum IO/s expected, must match available options.
+- `name` - (Optional) The name of the volume. If not provided it will be randomly generated.
+- `size_in_gb` - (Optional) The size of the volume. Only one of `size_in_gb`, and `snapshot_id` should be specified.
+- `snapshot_id` - (Optional) If set, the new volume will be created from this snapshot. Only one of `size_in_gb`, `snapshot_id` should be specified.
+- `tags` - (Optional) A list of tags to apply to the volume.
+- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the volume should be created.
+- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the volume is associated with.
+
+## Attributes Reference
+
+In addition to all above arguments, the following attributes are exported:
+
+- `id` - The ID of the volume.
+
+~> **Important:** Block volumes' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
+
+- `organization_id` - The organization ID the volume is associated with.
+
+## Import
+
+Block Volumes can be imported using the `{zone}/{id}`, e.g.
+
+```bash
+$ terraform import scaleway_block_volume.block_volume fr-par-1/11111111-1111-1111-1111-111111111111
+```

docs/resources/instance_volume.md

@@ -23,8 +23,8 @@ resource "scaleway_instance_volume" "server_volume" {
 The following arguments are supported:
 
 - `type` - (Required) The type of the volume. The possible values are: `b_ssd` (Block SSD), `l_ssd` (Local SSD), `scratch` (Local Scratch SSD).
-- `size_in_gb` - (Optional) The size of the volume. Only one of `size_in_gb`, `from_volume_id` and `from_snapshot_id` should be specified.
-- `from_snapshot_id` - (Optional) If set, the new volume will be created from this snapshot. Only one of `size_in_gb`, `from_volume_id` and `from_snapshot_id` should be specified.
+- `size_in_gb` - (Optional) The size of the volume. Only one of `size_in_gb` and `from_snapshot_id` should be specified.
+- `from_snapshot_id` - (Optional) If set, the new volume will be created from this snapshot. Only one of `size_in_gb` and `from_snapshot_id` should be specified.
 - `name` - (Optional) The name of the volume. If not provided it will be randomly generated.
 - `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the volume should be created.
 - `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the volume is associated with.

scaleway/data_source_block_snapshot.go

@@ -0,0 +1,78 @@
+package scaleway
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	block "github.com/scaleway/scaleway-sdk-go/api/block/v1alpha1"
+)
+
+func dataSourceScalewayBlockSnapshot() *schema.Resource {
+	// Generate datasource schema from resource
+	dsSchema := datasourceSchemaFromResourceSchema(resourceScalewayBlockSnapshot().Schema)
+
+	addOptionalFieldsToSchema(dsSchema, "name", "zone", "volume_id")
+
+	dsSchema["snapshot_id"] = &schema.Schema{
+		Type:          schema.TypeString,
+		Optional:      true,
+		Description:   "The ID of the snapshot",
+		ConflictsWith: []string{"name"},
+		ValidateFunc:  validationUUIDorUUIDWithLocality(),
+	}
+
+	return &schema.Resource{
+		ReadContext: dataSourceScalewayBlockSnapshotRead,
+		Schema:      dsSchema,
+	}
+}
+
+func dataSourceScalewayBlockSnapshotRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	api, zone, err := blockAPIWithZone(d, meta)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	snapshotID, snapshotIDExists := d.GetOk("snapshot_id")
+	if !snapshotIDExists {
+		res, err := api.ListSnapshots(&block.ListSnapshotsRequest{
+			Zone:      zone,
+			Name:      expandStringPtr(d.Get("name")),
+			ProjectID: expandStringPtr(d.Get("project_id")),
+			VolumeID:  expandStringPtr(d.Get("volume_id")),
+		})
+		if err != nil {
+			return diag.FromErr(err)
+		}
+		for _, snapshot := range res.Snapshots {
+			if snapshot.Name == d.Get("name").(string) {
+				if snapshotID != "" {
+					return diag.Errorf("more than 1 snapshot found with the same name %s", d.Get("name"))
+				}
+				snapshotID = snapshot.ID
+			}
+		}
+		if snapshotID == "" {
+			return diag.Errorf("no snapshot found with the name %s", d.Get("name"))
+		}
+	}
+
+	zoneID := datasourceNewZonedID(snapshotID, zone)
+	d.SetId(zoneID)
+	err = d.Set("snapshot_id", zoneID)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	diags := resourceScalewayBlockSnapshotRead(ctx, d, meta)
+	if diags != nil {
+		return append(diags, diag.Errorf("failed to read snapshot state")...)
+	}
+
+	if d.Id() == "" {
+		return diag.Errorf("snapshot (%s) not found", zoneID)
+	}
+
+	return nil
+}

scaleway/data_source_block_snapshot_test.go

@@ -0,0 +1,50 @@
+package scaleway
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccScalewayDataSourceBlockSnapshot_Basic(t *testing.T) {
+	tt := NewTestTools(t)
+	defer tt.Cleanup()
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: tt.ProviderFactories,
+		CheckDestroy: resource.ComposeTestCheckFunc(
+			testAccCheckScalewayBlockSnapshotDestroy(tt),
+		),
+		Steps: []resource.TestStep{
+			{
+				Config: `
+					resource scaleway_block_volume main {
+						iops = 5000
+						size_in_gb = 10
+					}
+
+					resource scaleway_block_snapshot main {
+						name = "test-ds-block-snapshot-basic"
+						volume_id = scaleway_block_volume.main.id
+					}
+
+					data scaleway_block_snapshot find_by_name {
+						name = scaleway_block_snapshot.main.name
+					}
+
+					data scaleway_block_snapshot find_by_id {
+						snapshot_id = scaleway_block_snapshot.main.id
+					}
+				`,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayBlockSnapshotExists(tt, "scaleway_block_snapshot.main"),
+
+					resource.TestCheckResourceAttrPair("scaleway_block_snapshot.main", "name", "data.scaleway_block_snapshot.find_by_name", "name"),
+					resource.TestCheckResourceAttrPair("scaleway_block_snapshot.main", "name", "data.scaleway_block_snapshot.find_by_id", "name"),
+					resource.TestCheckResourceAttrPair("scaleway_block_snapshot.main", "id", "data.scaleway_block_snapshot.find_by_name", "id"),
+					resource.TestCheckResourceAttrPair("scaleway_block_snapshot.main", "id", "data.scaleway_block_snapshot.find_by_id", "id"),
+				),
+			},
+		},
+	})
+}

scaleway/data_source_block_volume.go

@@ -0,0 +1,77 @@
+package scaleway
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	block "github.com/scaleway/scaleway-sdk-go/api/block/v1alpha1"
+)
+
+func dataSourceScalewayBlockVolume() *schema.Resource {
+	// Generate datasource schema from resource
+	dsSchema := datasourceSchemaFromResourceSchema(resourceScalewayBlockVolume().Schema)
+
+	addOptionalFieldsToSchema(dsSchema, "name", "zone")
+
+	dsSchema["volume_id"] = &schema.Schema{
+		Type:          schema.TypeString,
+		Optional:      true,
+		Description:   "The ID of the volume",
+		ConflictsWith: []string{"name"},
+		ValidateFunc:  validationUUIDorUUIDWithLocality(),
+	}
+
+	return &schema.Resource{
+		ReadContext: dataSourceScalewayBlockVolumeRead,
+		Schema:      dsSchema,
+	}
+}
+
+func dataSourceScalewayBlockVolumeRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	api, zone, err := blockAPIWithZone(d, meta)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	volumeID, volumeIDExists := d.GetOk("volume_id")
+	if !volumeIDExists {
+		res, err := api.ListVolumes(&block.ListVolumesRequest{
+			Zone:      zone,
+			Name:      expandStringPtr(d.Get("name")),
+			ProjectID: expandStringPtr(d.Get("project_id")),
+		})
+		if err != nil {
+			return diag.FromErr(err)
+		}
+		for _, volume := range res.Volumes {
+			if volume.Name == d.Get("name").(string) {
+				if volumeID != "" {
+					return diag.Errorf("more than 1 volume found with the same name %s", d.Get("name"))
+				}
+				volumeID = volume.ID
+			}
+		}
+		if volumeID == "" {
+			return diag.Errorf("no volume found with the name %s", d.Get("name"))
+		}
+	}
+
+	zoneID := datasourceNewZonedID(volumeID, zone)
+	d.SetId(zoneID)
+	err = d.Set("volume_id", zoneID)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	diags := resourceScalewayBlockVolumeRead(ctx, d, meta)
+	if diags != nil {
+		return append(diags, diag.Errorf("failed to read volume state")...)
+	}
+
+	if d.Id() == "" {
+		return diag.Errorf("volume (%s) not found", zoneID)
+	}
+
+	return nil
+}

scaleway/data_source_block_volume_test.go

@@ -0,0 +1,46 @@
+package scaleway
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccScalewayDataSourceBlockVolume_Basic(t *testing.T) {
+	tt := NewTestTools(t)
+	defer tt.Cleanup()
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: tt.ProviderFactories,
+		CheckDestroy: resource.ComposeTestCheckFunc(
+			testAccCheckScalewayBlockVolumeDestroy(tt),
+		),
+		Steps: []resource.TestStep{
+			{
+				Config: `
+					resource scaleway_block_volume main {
+						iops = 5000
+						size_in_gb = 10
+  						name = "test-ds-block-volume-basic"
+					}
+
+					data scaleway_block_volume find_by_name {
+						name = scaleway_block_volume.main.name
+					}
+
+					data scaleway_block_volume find_by_id {
+						volume_id = scaleway_block_volume.main.id
+					}
+				`,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayBlockVolumeExists(tt, "scaleway_block_volume.main"),
+
+					resource.TestCheckResourceAttrPair("scaleway_block_volume.main", "name", "data.scaleway_block_volume.find_by_name", "name"),
+					resource.TestCheckResourceAttrPair("scaleway_block_volume.main", "name", "data.scaleway_block_volume.find_by_id", "name"),
+					resource.TestCheckResourceAttrPair("scaleway_block_volume.main", "id", "data.scaleway_block_volume.find_by_name", "id"),
+					resource.TestCheckResourceAttrPair("scaleway_block_volume.main", "id", "data.scaleway_block_volume.find_by_id", "id"),
+				),
+			},
+		},
+	})
+}

scaleway/helpers.go

@@ -329,6 +329,11 @@ func is409Error(err error) bool {
 	return isHTTPCodeError(err, http.StatusConflict) || errors.As(err, &transientStateError)
 }
 
+// is404Error returns true if err is an HTTP 410 error
+func is410Error(err error) bool {
+	return isHTTPCodeError(err, http.StatusGone)
+}
+
 // organizationIDSchema returns a standard schema for a organization_id
 func organizationIDSchema() *schema.Schema {
 	return &schema.Schema{