feat(sfs): change immutable field to enum

relates to STACKITCLI-394

Author: GokceGK

docs/stackit_beta_sfs_snapshot-policy_list.md

@@ -16,8 +16,11 @@ stackit beta sfs snapshot-policy list [flags]
   List all snapshot policies
   $ stackit beta sfs snapshot-policy list
 
-  List all immutable snapshot policies
-  $ stackit beta sfs snapshot-policy list --immutable
+  List only mutable snapshot policies
+  $ stackit beta sfs snapshot-policy list --immutable mutable-only
+
+  List only immutable snapshot policies
+  $ stackit beta sfs snapshot-policy list --immutable immutable-only
 
   List up to 10 snapshot policies
   $ stackit beta sfs snapshot-policy list --limit 10
@@ -26,9 +29,9 @@ stackit beta sfs snapshot-policy list [flags]
 ### Options
 
 ```
-  -h, --help        Help for "stackit beta sfs snapshot-policy list"
-      --immutable   Immutable snapshot policy
-      --limit int   Maximum number of entries to list
+  -h, --help               Help for "stackit beta sfs snapshot-policy list"
+      --immutable string   Immutable snapshot policy, one of ["all" "immutable-only" "mutable-only"] (default "all")
+      --limit int          Maximum number of entries to list
 ```
 
 ### Options inherited from parent commands

internal/cmd/beta/sfs/snapshot-policy/list/list.go

@@ -29,7 +29,7 @@ const (
 type inputModel struct {
 	*globalflags.GlobalFlagModel
 	Limit     *int64
-	Immutable bool
+	Immutable *string
 }
 
 func NewCmd(params *types.CmdParams) *cobra.Command {
@@ -44,8 +44,12 @@ func NewCmd(params *types.CmdParams) *cobra.Command {
 				"$ stackit beta sfs snapshot-policy list",
 			),
 			examples.NewExample(
-				`List all immutable snapshot policies`,
-				"$ stackit beta sfs snapshot-policy list --immutable",
+				`List only mutable snapshot policies`,
+				"$ stackit beta sfs snapshot-policy list --immutable mutable-only",
+			),
+			examples.NewExample(
+				`List only immutable snapshot policies`,
+				"$ stackit beta sfs snapshot-policy list --immutable immutable-only",
 			),
 			examples.NewExample(
 				`List up to 10 snapshot policies`,
@@ -95,8 +99,9 @@ func NewCmd(params *types.CmdParams) *cobra.Command {
 }
 
 func configureFlags(cmd *cobra.Command) {
+	immutableOptions := []string{"all", "immutable-only", "mutable-only"}
+	cmd.Flags().Var(flags.EnumFlag(true, "all", immutableOptions...), immutableFlag, fmt.Sprintf("Immutable snapshot policy, one of %q", immutableOptions))
 	cmd.Flags().Int64(limitFlag, 0, "Maximum number of entries to list")
-	cmd.Flags().Bool(immutableFlag, false, "Immutable snapshot policy")
 }
 
 func parseInput(p *print.Printer, cmd *cobra.Command, _ []string) (*inputModel, error) {
@@ -116,7 +121,7 @@ func parseInput(p *print.Printer, cmd *cobra.Command, _ []string) (*inputModel,
 	model := inputModel{
 		GlobalFlagModel: globalFlags,
 		Limit:           limit,
-		Immutable:       flags.FlagToBoolValue(p, cmd, immutableFlag),
+		Immutable:       flags.FlagToStringPointer(p, cmd, immutableFlag),
 	}
 
 	p.DebugInputModel(model)
@@ -125,8 +130,16 @@ func parseInput(p *print.Printer, cmd *cobra.Command, _ []string) (*inputModel,
 
 func buildRequest(ctx context.Context, model *inputModel, apiClient *sfs.APIClient) sfs.ApiListSnapshotPoliciesRequest {
 	req := apiClient.DefaultAPI.ListSnapshotPolicies(ctx, model.ProjectId)
-	if model.Immutable {
-		req = req.Immutable(true)
+
+	if model.Immutable != nil {
+		switch *model.Immutable {
+		case "all":
+			return req
+		case "mutable-only":
+			req = req.Immutable(false)
+		case "immutable-only":
+			req = req.Immutable(true)
+		}
 	}
 	return req
 }

internal/cmd/beta/sfs/snapshot-policy/list/list_test.go

@@ -105,11 +105,41 @@ func TestParseInput(t *testing.T) {
 		{
 			description: "immutable snapshot policies",
 			flagValues: fixtureFlagValues(func(flagValues map[string]string) {
-				flagValues[immutableFlag] = "true"
+				flagValues[immutableFlag] = "immutable-only"
 			}),
 			isValid: true,
 			expectedModel: fixtureInputModel(func(model *inputModel) {
-				model.Immutable = true
+				model.Immutable = utils.Ptr("immutable-only")
+			}),
+		},
+		{
+			description: "mutable snapshot policies",
+			flagValues: fixtureFlagValues(func(flagValues map[string]string) {
+				flagValues[immutableFlag] = "mutable-only"
+			}),
+			isValid: true,
+			expectedModel: fixtureInputModel(func(model *inputModel) {
+				model.Immutable = utils.Ptr("mutable-only")
+			}),
+		},
+		{
+			description: "all snapshot policies",
+			flagValues: fixtureFlagValues(func(flagValues map[string]string) {
+				flagValues[immutableFlag] = "all"
+			}),
+			isValid: true,
+			expectedModel: fixtureInputModel(func(model *inputModel) {
+				model.Immutable = utils.Ptr("all")
+			}),
+		},
+		{
+			description: "all snapshot policies - without immutable flag",
+			flagValues: fixtureFlagValues(func(flagValues map[string]string) {
+				delete(flagValues, immutableFlag)
+			}),
+			isValid: true,
+			expectedModel: fixtureInputModel(func(model *inputModel) {
+				model.Immutable = nil
 			}),
 		},
 	}
@@ -132,12 +162,33 @@ func TestBuildRequest(t *testing.T) {
 			expectedRequest: fixtureRequest(),
 		},
 		{
-			description: "immutable snapshot policies",
+			description: "only immutable snapshot policies",
 			model: fixtureInputModel(func(model *inputModel) {
-				model.Immutable = true
+				model.Immutable = utils.Ptr("immutable-only")
 			}),
 			expectedRequest: fixtureRequest().Immutable(true),
 		},
+		{
+			description: "only mutable snapshot policies",
+			model: fixtureInputModel(func(model *inputModel) {
+				model.Immutable = utils.Ptr("mutable-only")
+			}),
+			expectedRequest: fixtureRequest().Immutable(false),
+		},
+		{
+			description: "all snapshot policies",
+			model: fixtureInputModel(func(model *inputModel) {
+				model.Immutable = utils.Ptr("all")
+			}),
+			expectedRequest: fixtureRequest(),
+		},
+		{
+			description: "all snapshot policies - without immutable flag",
+			model: fixtureInputModel(func(model *inputModel) {
+				model.Immutable = nil
+			}),
+			expectedRequest: fixtureRequest(),
+		},
 	}
 
 	for _, tt := range tests {