feat(instance): add support detach and attach filesystem (#4797)

Laure-di · web-flow · commit 0b301e3711d1 · 2025-06-12T11:50:06.000Z
diff --git a/cmd/scw/testdata/test-all-usage-file-attachment-list-usage.golden b/cmd/scw/testdata/test-all-usage-file-attachment-list-usage.golden
@@ -0,0 +1,23 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+List all existing attachments in a specified region.
+By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
+
+USAGE:
+  scw file attachment list [arg=value ...]
+
+ARGS:
+  [filesystem-id]   UUID of the File Storage volume
+  [resource-id]     Filter by resource ID
+  [resource-type]   Filter by resource type (unknown_resource_type | instance_server)
+  [zone]            Filter by resource zone
+  [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | all)
+
+FLAGS:
+  -h, --help   help for list
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-file-attachment-usage.golden b/cmd/scw/testdata/test-all-usage-file-attachment-usage.golden
@@ -0,0 +1,20 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Attachment management.
+
+USAGE:
+  scw file attachment <command>
+
+AVAILABLE COMMANDS:
+  list        List filesystems attachments
+
+FLAGS:
+  -h, --help   help for attachment
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
+
+Use "scw file attachment [command] --help" for more information about a command.
diff --git a/cmd/scw/testdata/test-all-usage-file-filesystem-create-usage.golden b/cmd/scw/testdata/test-all-usage-file-filesystem-create-usage.golden
@@ -0,0 +1,22 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+To create a new filesystem, you must specify a name, a size, and a project ID.
+
+USAGE:
+  scw file filesystem create [arg=value ...]
+
+ARGS:
+  name              Name of the filesystem
+  [project-id]      Project ID to use. If none is passed the default project ID will be used
+  size              Filesystem size in bytes, with a granularity of 100 GB (10^11 bytes).
+  [tags.{index}]    List of tags assigned to the filesystem
+  [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par)
+
+FLAGS:
+  -h, --help   help for create
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-file-filesystem-delete-usage.golden b/cmd/scw/testdata/test-all-usage-file-filesystem-delete-usage.golden
@@ -0,0 +1,19 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+You must specify the `filesystem_id` of the filesystem you want to delete.
+
+USAGE:
+  scw file filesystem delete <filesystem-id ...> [arg=value ...]
+
+ARGS:
+  filesystem-id     UUID of the filesystem
+  [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par)
+
+FLAGS:
+  -h, --help   help for delete
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-file-filesystem-get-usage.golden b/cmd/scw/testdata/test-all-usage-file-filesystem-get-usage.golden
@@ -0,0 +1,19 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Retrieve all properties and current status of a specific filesystem identified by its ID.
+
+USAGE:
+  scw file filesystem get <filesystem-id ...> [arg=value ...]
+
+ARGS:
+  filesystem-id     UUID of the filesystem
+  [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par)
+
+FLAGS:
+  -h, --help   help for get
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-file-filesystem-list-usage.golden b/cmd/scw/testdata/test-all-usage-file-filesystem-list-usage.golden
@@ -0,0 +1,23 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
+
+USAGE:
+  scw file filesystem list [arg=value ...]
+
+ARGS:
+  [order-by]          Criteria to use when ordering the list (created_at_asc | created_at_desc | name_asc | name_desc)
+  [project-id]        Filter by project ID
+  [name]              Filter the returned filesystems by their names
+  [tags.{index}]      Filter by tags. Only filesystems with one or more matching tags will be returned
+  [organization-id]   Filter by organization ID
+  [region=fr-par]     Region to target. If none is passed will use default region from the config (fr-par | all)
+
+FLAGS:
+  -h, --help   help for list
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-file-filesystem-update-usage.golden b/cmd/scw/testdata/test-all-usage-file-filesystem-update-usage.golden
@@ -0,0 +1,22 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Update the technical details of a filesystem, such as its name, tags or its new size.
+
+USAGE:
+  scw file filesystem update [arg=value ...]
+
+ARGS:
+  filesystem-id     UUID of the filesystem
+  [name]            When defined, is the new name of the filesystem
+  [size]            Optional field for increasing the size of the filesystem (must be larger than the current size)
+  [tags.{index}]    List of tags assigned to the filesystem
+  [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par)
+
+FLAGS:
+  -h, --help   help for update
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-file-filesystem-usage.golden b/cmd/scw/testdata/test-all-usage-file-filesystem-usage.golden
@@ -0,0 +1,24 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Filesystem management.
+
+USAGE:
+  scw file filesystem <command>
+
+AVAILABLE COMMANDS:
+  create      Create a new filesystem
+  delete      Delete a detached filesystem
+  get         Get filesystem details
+  list        List all filesystems
+  update      Update filesystem properties
+
+FLAGS:
+  -h, --help   help for filesystem
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
+
+Use "scw file filesystem [command] --help" for more information about a command.
diff --git a/cmd/scw/testdata/test-all-usage-file-usage.golden b/cmd/scw/testdata/test-all-usage-file-usage.golden
@@ -0,0 +1,21 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+This API allows you to manage your File Storage resources.
+
+USAGE:
+  scw file <command>
+
+AVAILABLE COMMANDS:
+  attachment  Attachment management
+  filesystem  Filesystem management
+
+FLAGS:
+  -h, --help   help for file
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
+
+Use "scw file [command] --help" for more information about a command.
diff --git a/cmd/scw/testdata/test-main-usage-usage.golden b/cmd/scw/testdata/test-main-usage-usage.golden
@@ -71,6 +71,7 @@ SERVERLESS COMMANDS:
 
 STORAGE COMMANDS:
   block         This API allows you to manage your Block Storage volumes
+  file          This API allows you to manage your File Storage resources
   object        Object-storage utils
   registry      This API allows you to manage your Container Registry resources
 
diff --git a/commands/commands.go b/commands/commands.go
@@ -90,6 +90,7 @@ func GetCommands() *core.Commands {
 		domain.GetCommands(),
 		applesilicon.GetCommands(),
 		flexibleip.GetCommands(),
+		file.GetCommands(),
 		container.GetCommands(),
 		function.GetCommands(),
 		vpcgw.GetCommands(),
@@ -116,9 +117,8 @@ func GetCommands() *core.Commands {
 	)
 
 	if beta {
-		commands.MergeAll(
+		commands.Merge(
 			dedibox.GetCommands(),
-			file.GetCommands(),
 		)
 	}
 
diff --git a/docs/commands/file.md b/docs/commands/file.md
@@ -20,8 +20,7 @@ Attachment management.
 ### List filesystems attachments
 
 List all existing attachments in a specified region.
-By default, the attachments listed are ordered by creation date in ascending order.
-This can be modified using the `order_by` field.
+By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
 
 **Usage:**
 
@@ -49,7 +48,7 @@ Filesystem management.
 
 ### Create a new filesystem
 
-To create a new filesystem, you need to provide a name, a size, and a project ID.
+To create a new filesystem, you must specify a name, a size, and a project ID.
 
 **Usage:**
 
@@ -112,8 +111,7 @@ scw file filesystem get <filesystem-id ...> [arg=value ...]
 
 ### List all filesystems
 
-Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
-Use the order_by parameter to modify the sorting behavior.
+Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
 
 **Usage:**
 
@@ -128,16 +126,16 @@ scw file filesystem list [arg=value ...]
 |------|---|-------------|
 | order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Criteria to use when ordering the list |
 | project-id |  | Filter by project ID |
-| name |  | Filter the return filesystems by their names |
+| name |  | Filter the returned filesystems by their names |
 | tags.{index} |  | Filter by tags. Only filesystems with one or more matching tags will be returned |
+| organization-id |  | Filter by organization ID |
 | region | Default: `fr-par`<br />One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config |
 
 
 
 ### Update filesystem properties
 
 Update the technical details of a filesystem, such as its name, tags or its new size.
-You can only resize a filesystem to a larger size.
 
 **Usage:**
 
diff --git a/internal/namespaces/instance/v1/custom_server.go b/internal/namespaces/instance/v1/custom_server.go
@@ -549,6 +549,10 @@ func serverGetBuilder(c *core.Command) *core.Command {
 				Title:       "Warnings",
 				HideIfEmpty: true,
 			},
+			{
+				FieldName: "Filesystems",
+				Title:     "Server Filesystems",
+			},
 		},
 	}
 
diff --git a/internal/namespaces/instance/v1/custom_server_create_test.go b/internal/namespaces/instance/v1/custom_server_create_test.go
@@ -6,6 +6,7 @@ import (
 
 	"github.com/scaleway/scaleway-cli/v2/core"
 	block "github.com/scaleway/scaleway-cli/v2/internal/namespaces/block/v1alpha1"
+	file "github.com/scaleway/scaleway-cli/v2/internal/namespaces/file/v1alpha1"
 	"github.com/scaleway/scaleway-cli/v2/internal/namespaces/instance/v1"
 	"github.com/scaleway/scaleway-cli/v2/internal/testhelpers"
 	blockSDK "github.com/scaleway/scaleway-sdk-go/api/block/v1alpha1"
@@ -907,3 +908,37 @@ func Test_CreateServerScratchStorage(t *testing.T) {
 		DisableParallel: true,
 	}))
 }
+
+func Test_AttachFilesystem(t *testing.T) {
+	t.Run("attach filesystem", core.Test(&core.TestConfig{
+		Commands: core.NewCommandsMerge(
+			instance.GetCommands(),
+			file.GetCommands(),
+		),
+		BeforeFunc: core.BeforeFuncCombine(
+			core.ExecStoreBeforeCmd(
+				"FileSystem",
+				"scw file filesystem create name=instance-fs-cli size=100000000000",
+			),
+			core.ExecStoreBeforeCmd(
+				"Server",
+				testServerCommand("stopped=true image=ubuntu-jammy type=POP2-2C-8G"),
+			),
+		),
+		Cmd: "scw instance server attach-filesystem server-id={{ .Server.ID }} filesystem-id={{ .FileSystem.ID }}",
+		Check: core.TestCheckCombine(
+			core.TestCheckGolden(),
+			core.TestCheckExitCode(0),
+		),
+		AfterFunc: core.AfterFuncCombine(
+			core.ExecAfterCmd(
+				"scw instance server detach-filesystem server-id={{ .Server.ID }} filesystem-id={{ .FileSystem.ID }}",
+			),
+			deleteServer("Server"),
+			core.ExecAfterCmd(
+				"scw file filesystem delete {{ .FileSystem.ID }}",
+			),
+		),
+		DisableParallel: true,
+	}))
+}
diff --git a/internal/namespaces/instance/v1/helpers_test.go b/internal/namespaces/instance/v1/helpers_test.go
@@ -28,13 +28,16 @@ func createServer(metaKey string) core.BeforeFunc {
 
 // testServerCommand creates returns a create server command with the instance type and the given arguments
 func testServerCommand(params string) string {
-	baseCommand := "scw instance server create type=DEV1-S "
+	baseCommand := "scw instance server create "
 	if !strings.Contains(params, "ip=") {
 		baseCommand += "ip=none "
 	}
 	if !strings.Contains(params, "image=") {
 		baseCommand += "image=ubuntu_jammy "
 	}
+	if !strings.Contains(params, "type=") {
+		baseCommand += "type=DEV1-S "
+	}
 
 	return baseCommand + params
 }
diff --git a/internal/namespaces/instance/v1/testdata/test-attach-filesystem-attach-filesystem.cassette.yaml b/internal/namespaces/instance/v1/testdata/test-attach-filesystem-attach-filesystem.cassette.yaml
diff --git a/internal/namespaces/instance/v1/testdata/test-attach-filesystem-attach-filesystem.golden b/internal/namespaces/instance/v1/testdata/test-attach-filesystem-attach-filesystem.golden
diff --git a/internal/namespaces/instance/v1/testdata/test-get-server-simple.golden b/internal/namespaces/instance/v1/testdata/test-get-server-simple.golden
