From 0e22b835ad52dca600c70ffa93f5b477aeab674b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Palet?= Date: Thu, 20 Jun 2024 16:14:06 +0100 Subject: [PATCH 1/3] Implement database create command --- .../sqlserverflex/database/create/create.go | 162 ++++++++++++ .../database/create/create_test.go | 242 ++++++++++++++++++ .../beta/sqlserverflex/database/database.go | 29 +++ .../cmd/beta/sqlserverflex/options/options.go | 4 +- .../cmd/beta/sqlserverflex/sqlserverflex.go | 2 + internal/pkg/spinner/spinner.go | 6 + 6 files changed, 443 insertions(+), 2 deletions(-) create mode 100644 internal/cmd/beta/sqlserverflex/database/create/create.go create mode 100644 internal/cmd/beta/sqlserverflex/database/create/create_test.go create mode 100644 internal/cmd/beta/sqlserverflex/database/database.go diff --git a/internal/cmd/beta/sqlserverflex/database/create/create.go b/internal/cmd/beta/sqlserverflex/database/create/create.go new file mode 100644 index 000000000..9a67a7a43 --- /dev/null +++ b/internal/cmd/beta/sqlserverflex/database/create/create.go @@ -0,0 +1,162 @@ +package create + +import ( + "context" + "encoding/json" + "fmt" + + "github.com/goccy/go-yaml" + "github.com/stackitcloud/stackit-cli/internal/pkg/args" + "github.com/stackitcloud/stackit-cli/internal/pkg/errors" + "github.com/stackitcloud/stackit-cli/internal/pkg/examples" + "github.com/stackitcloud/stackit-cli/internal/pkg/flags" + "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" + "github.com/stackitcloud/stackit-cli/internal/pkg/print" + "github.com/stackitcloud/stackit-cli/internal/pkg/services/sqlserverflex/client" + "github.com/stackitcloud/stackit-cli/internal/pkg/spinner" + "github.com/stackitcloud/stackit-cli/internal/pkg/utils" + "github.com/stackitcloud/stackit-sdk-go/services/sqlserverflex" + + "github.com/spf13/cobra" +) + +const ( + databaseNameArg = "DATABASE_NAME" + + instanceIdFlag = "instance-id" + ownerFlag = "owner" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + DatabaseName string + InstanceId string + Owner string +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: fmt.Sprintf("create %s", databaseNameArg), + Short: "Creates an SQLServer Flex database", + Long: fmt.Sprintf("%s\n%s", + "Creates an SQLServer Flex database.", + `This operation cannot be triggered asynchronously (the "--async" flag will have no effect).`, + ), + Args: args.SingleArg(databaseNameArg, nil), + Example: examples.Build( + examples.NewExample( + `Create an SQLServer Flex database with name "my-database" on instance with ID "xxx"`, + "$ stackit beta sqlserverflex database create my-database --instance-id xxx --owner some-username"), + ), + RunE: func(cmd *cobra.Command, args []string) error { + ctx := context.Background() + model, err := parseInput(p, cmd, args) + if err != nil { + return err + } + + // Configure API client + apiClient, err := client.ConfigureClient(p) + if err != nil { + return err + } + + if !model.AssumeYes { + prompt := fmt.Sprintf("Are you sure you want to create database %q? (This cannot be undone)", model.DatabaseName) + err = p.PromptForConfirmation(prompt) + if err != nil { + return err + } + } + + // Call API + req := buildRequest(ctx, model, apiClient) + s := spinner.New(p) + s.Start("Creating database") + resp, err := req.Execute() + if err != nil { + s.StopWithError() + return fmt.Errorf("create SQLServer Flex database: %w", err) + } + s.Stop() + + return outputResult(p, model, resp) + }, + } + configureFlags(cmd) + return cmd +} + +func configureFlags(cmd *cobra.Command) { + cmd.Flags().Var(flags.UUIDFlag(), instanceIdFlag, "SQLServer Flex instance ID") + cmd.Flags().String(ownerFlag, "", "Username of the owner user") + err := flags.MarkFlagsRequired(cmd, instanceIdFlag, ownerFlag) + cobra.CheckErr(err) +} + +func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inputModel, error) { + databaseName := inputArgs[0] + + globalFlags := globalflags.Parse(p, cmd) + if globalFlags.ProjectId == "" { + return nil, &errors.ProjectIdError{} + } + + model := inputModel{ + GlobalFlagModel: globalFlags, + DatabaseName: databaseName, + InstanceId: flags.FlagToStringValue(p, cmd, instanceIdFlag), + Owner: flags.FlagToStringValue(p, cmd, ownerFlag), + } + + if p.IsVerbosityDebug() { + modelStr, err := print.BuildDebugStrFromInputModel(model) + if err != nil { + p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err) + } else { + p.Debug(print.DebugLevel, "parsed input values: %s", modelStr) + } + } + + return &model, nil +} + +func buildRequest(ctx context.Context, model *inputModel, apiClient *sqlserverflex.APIClient) sqlserverflex.ApiCreateDatabaseRequest { + req := apiClient.CreateDatabase(ctx, model.ProjectId, model.InstanceId) + payload := sqlserverflex.CreateDatabasePayload{ + Name: &model.DatabaseName, + Options: utils.Ptr(map[string]string{ + "owner": model.Owner, + }), + } + req = req.CreateDatabasePayload(payload) + return req +} + +func outputResult(p *print.Printer, model *inputModel, resp *sqlserverflex.CreateDatabaseResponse) error { + switch model.OutputFormat { + case print.JSONOutputFormat: + details, err := json.MarshalIndent(resp, "", " ") + if err != nil { + return fmt.Errorf("marshal SQLServer Flex database: %w", err) + } + p.Outputln(string(details)) + + return nil + case print.YAMLOutputFormat: + details, err := yaml.MarshalWithOptions(resp, yaml.IndentSequence(true)) + if err != nil { + return fmt.Errorf("marshal SQLServer Flex database: %w", err) + } + p.Outputln(string(details)) + + return nil + default: + operationState := "Created" + if model.Async { + operationState = "Triggered creation of" + } + p.Outputf("%s database %q\n", operationState, model.DatabaseName) + return nil + } +} diff --git a/internal/cmd/beta/sqlserverflex/database/create/create_test.go b/internal/cmd/beta/sqlserverflex/database/create/create_test.go new file mode 100644 index 000000000..b3b436e0e --- /dev/null +++ b/internal/cmd/beta/sqlserverflex/database/create/create_test.go @@ -0,0 +1,242 @@ +package create + +import ( + "context" + "testing" + + "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" + "github.com/stackitcloud/stackit-cli/internal/pkg/print" + "github.com/stackitcloud/stackit-cli/internal/pkg/utils" + "github.com/stackitcloud/stackit-sdk-go/services/sqlserverflex" + + "github.com/google/go-cmp/cmp" + "github.com/google/go-cmp/cmp/cmpopts" + "github.com/google/uuid" +) + +var projectIdFlag = globalflags.ProjectIdFlag + +type testCtxKey struct{} + +var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo") +var testClient = &sqlserverflex.APIClient{} +var testProjectId = uuid.NewString() +var testInstanceId = uuid.NewString() +var testDatabaseName = "my-database" +var testOwner = "owner" + +func fixtureArgValues(mods ...func(argValues []string)) []string { + argValues := []string{ + testDatabaseName, + } + for _, mod := range mods { + mod(argValues) + } + return argValues +} + +func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]string { + flagValues := map[string]string{ + projectIdFlag: testProjectId, + instanceIdFlag: testInstanceId, + ownerFlag: testOwner, + } + for _, mod := range mods { + mod(flagValues) + } + return flagValues +} + +func fixtureInputModel(mods ...func(model *inputModel)) *inputModel { + model := &inputModel{ + GlobalFlagModel: &globalflags.GlobalFlagModel{ + ProjectId: testProjectId, + Verbosity: globalflags.VerbosityDefault, + }, + DatabaseName: testDatabaseName, + InstanceId: testInstanceId, + Owner: testOwner, + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *sqlserverflex.ApiCreateDatabaseRequest)) sqlserverflex.ApiCreateDatabaseRequest { + request := testClient.CreateDatabase(testCtx, testProjectId, testInstanceId) + payload := sqlserverflex.CreateDatabasePayload{ + Name: &testDatabaseName, + Options: utils.Ptr(map[string]string{ + "owner": testOwner, + }), + } + request = request.CreateDatabasePayload(payload) + for _, mod := range mods { + mod(&request) + } + return request +} + +func TestParseInput(t *testing.T) { + tests := []struct { + description string + argValues []string + flagValues map[string]string + isValid bool + expectedModel *inputModel + }{ + { + description: "base", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(), + isValid: true, + expectedModel: fixtureInputModel(), + }, + { + description: "no values", + argValues: []string{}, + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "no arg values", + argValues: []string{}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + { + description: "no flag values", + argValues: fixtureArgValues(), + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "project id missing", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, projectIdFlag) + }), + isValid: false, + }, + { + description: "project id invalid 1", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "" + }), + isValid: false, + }, + { + description: "project id invalid 2", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "invalid-uuid" + }), + isValid: false, + }, + { + description: "instance id missing", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, instanceIdFlag) + }), + isValid: false, + }, + { + description: "owner missing", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, ownerFlag) + }), + isValid: false, + }, + { + description: "database name invalid 1", + argValues: []string{""}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + p := print.NewPrinter() + cmd := NewCmd(p) + err := globalflags.Configure(cmd.Flags()) + if err != nil { + t.Fatalf("configure global flags: %v", err) + } + + for flag, value := range tt.flagValues { + err := cmd.Flags().Set(flag, value) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("setting flag --%s=%s: %v", flag, value, err) + } + } + + err = cmd.ValidateArgs(tt.argValues) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error validating args: %v", err) + } + + err = cmd.ValidateRequiredFlags() + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error validating flags: %v", err) + } + + model, err := parseInput(p, cmd, tt.argValues) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error parsing input: %v", err) + } + + if !tt.isValid { + t.Fatalf("did not fail on invalid input") + } + diff := cmp.Diff(model, tt.expectedModel) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} + +func TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest sqlserverflex.ApiCreateDatabaseRequest + }{ + { + description: "base", + model: fixtureInputModel(), + expectedRequest: fixtureRequest(), + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + request := buildRequest(testCtx, tt.model, testClient) + + diff := cmp.Diff(request, tt.expectedRequest, + cmp.AllowUnexported(tt.expectedRequest), + cmpopts.EquateComparable(testCtx), + ) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} diff --git a/internal/cmd/beta/sqlserverflex/database/database.go b/internal/cmd/beta/sqlserverflex/database/database.go new file mode 100644 index 000000000..27d532ed7 --- /dev/null +++ b/internal/cmd/beta/sqlserverflex/database/database.go @@ -0,0 +1,29 @@ +package database + +import ( + "github.com/stackitcloud/stackit-cli/internal/cmd/beta/sqlserverflex/database/create" + "github.com/stackitcloud/stackit-cli/internal/pkg/args" + "github.com/stackitcloud/stackit-cli/internal/pkg/print" + "github.com/stackitcloud/stackit-cli/internal/pkg/utils" + + "github.com/spf13/cobra" +) + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: "database", + Short: "Provides functionality for SQLServer Flex databases", + Long: "Provides functionality for SQLServer Flex databases.", + Args: args.NoArgs, + Run: utils.CmdHelp, + } + addSubcommands(cmd, p) + return cmd +} + +func addSubcommands(cmd *cobra.Command, p *print.Printer) { + // cmd.AddCommand(delete.NewCmd(p)) + // cmd.AddCommand(describe.NewCmd(p)) + cmd.AddCommand(create.NewCmd(p)) + // cmd.AddCommand(list.NewCmd(p)) +} diff --git a/internal/cmd/beta/sqlserverflex/options/options.go b/internal/cmd/beta/sqlserverflex/options/options.go index 1e585bb55..3b3ef5dbf 100644 --- a/internal/cmd/beta/sqlserverflex/options/options.go +++ b/internal/cmd/beta/sqlserverflex/options/options.go @@ -153,14 +153,14 @@ func parseInput(p *print.Printer, cmd *cobra.Command) (*inputModel, error) { return nil, fmt.Errorf("%s\n\n%s\n%s", `please specify a flavor ID to show storages for by setting the flag "--flavor-id ".`, "You can get the available flavor IDs by running:", - " $ stackit sqlserverflex options --flavors") + " $ stackit beta sqlserverflex options --flavors") } if (userRoles || dbCollations || dbCompatibilities) && instanceId == nil { return nil, fmt.Errorf("%s\n\n%s\n%s", `please specify an instance ID to show user roles, database collations or database compatibilities for by setting the flag "--instance-id ".`, "You can get the available instances and their IDs by running:", - " $ stackit sqlserverflex instance list") + " $ stackit beta sqlserverflex instance list") } model := inputModel{ diff --git a/internal/cmd/beta/sqlserverflex/sqlserverflex.go b/internal/cmd/beta/sqlserverflex/sqlserverflex.go index 196d7a6e1..a65ca22e8 100644 --- a/internal/cmd/beta/sqlserverflex/sqlserverflex.go +++ b/internal/cmd/beta/sqlserverflex/sqlserverflex.go @@ -1,6 +1,7 @@ package sqlserverflex import ( + "github.com/stackitcloud/stackit-cli/internal/cmd/beta/sqlserverflex/database" "github.com/stackitcloud/stackit-cli/internal/cmd/beta/sqlserverflex/instance" "github.com/stackitcloud/stackit-cli/internal/cmd/beta/sqlserverflex/options" "github.com/stackitcloud/stackit-cli/internal/cmd/beta/sqlserverflex/user" @@ -24,6 +25,7 @@ func NewCmd(p *print.Printer) *cobra.Command { } func addSubcommands(cmd *cobra.Command, p *print.Printer) { + cmd.AddCommand(database.NewCmd(p)) cmd.AddCommand(instance.NewCmd(p)) cmd.AddCommand(options.NewCmd(p)) cmd.AddCommand(user.NewCmd(p)) diff --git a/internal/pkg/spinner/spinner.go b/internal/pkg/spinner/spinner.go index 23635a44e..9c530f1ca 100644 --- a/internal/pkg/spinner/spinner.go +++ b/internal/pkg/spinner/spinner.go @@ -36,6 +36,12 @@ func (s *Spinner) Stop() { s.printer.Info("\r%s ✓ \n", s.message) } +func (s *Spinner) StopWithError() { + s.done <- true + close(s.done) + s.printer.Info("\r%s ✗ \n", s.message) +} + func (s *Spinner) animate() { i := 0 for { From bfe29ff0d3bbba909dde30b60399492ab4ca6477 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Palet?= Date: Thu, 20 Jun 2024 16:23:41 +0100 Subject: [PATCH 2/3] Implement database delete command --- docs/stackit_beta_sqlserverflex.md | 1 + docs/stackit_beta_sqlserverflex_database.md | 34 +++ ...ckit_beta_sqlserverflex_database_create.md | 42 +++ ...ckit_beta_sqlserverflex_database_delete.md | 41 +++ .../sqlserverflex/database/create/create.go | 6 +- .../database/create/create_test.go | 16 ++ .../beta/sqlserverflex/database/database.go | 5 +- .../sqlserverflex/database/delete/delete.go | 121 +++++++++ .../database/delete/delete_test.go | 239 ++++++++++++++++++ 9 files changed, 497 insertions(+), 8 deletions(-) create mode 100644 docs/stackit_beta_sqlserverflex_database.md create mode 100644 docs/stackit_beta_sqlserverflex_database_create.md create mode 100644 docs/stackit_beta_sqlserverflex_database_delete.md create mode 100644 internal/cmd/beta/sqlserverflex/database/delete/delete.go create mode 100644 internal/cmd/beta/sqlserverflex/database/delete/delete_test.go diff --git a/docs/stackit_beta_sqlserverflex.md b/docs/stackit_beta_sqlserverflex.md index 79a07e351..a832ef36e 100644 --- a/docs/stackit_beta_sqlserverflex.md +++ b/docs/stackit_beta_sqlserverflex.md @@ -29,6 +29,7 @@ stackit beta sqlserverflex [flags] ### SEE ALSO * [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands +* [stackit beta sqlserverflex database](./stackit_beta_sqlserverflex_database.md) - Provides functionality for SQLServer Flex databases * [stackit beta sqlserverflex instance](./stackit_beta_sqlserverflex_instance.md) - Provides functionality for SQLServer Flex instances * [stackit beta sqlserverflex options](./stackit_beta_sqlserverflex_options.md) - Lists SQL Server Flex options * [stackit beta sqlserverflex user](./stackit_beta_sqlserverflex_user.md) - Provides functionality for SQLServer Flex users diff --git a/docs/stackit_beta_sqlserverflex_database.md b/docs/stackit_beta_sqlserverflex_database.md new file mode 100644 index 000000000..324a7d9c3 --- /dev/null +++ b/docs/stackit_beta_sqlserverflex_database.md @@ -0,0 +1,34 @@ +## stackit beta sqlserverflex database + +Provides functionality for SQLServer Flex databases + +### Synopsis + +Provides functionality for SQLServer Flex databases. + +``` +stackit beta sqlserverflex database [flags] +``` + +### Options + +``` + -h, --help Help for "stackit beta sqlserverflex database" +``` + +### Options inherited from parent commands + +``` + -y, --assume-yes If set, skips all confirmation prompts + --async If set, runs the command asynchronously + -o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"] + -p, --project-id string Project ID + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") +``` + +### SEE ALSO + +* [stackit beta sqlserverflex](./stackit_beta_sqlserverflex.md) - Provides functionality for SQLServer Flex +* [stackit beta sqlserverflex database create](./stackit_beta_sqlserverflex_database_create.md) - Creates an SQLServer Flex database +* [stackit beta sqlserverflex database delete](./stackit_beta_sqlserverflex_database_delete.md) - Deletes an SQLServer Flex database + diff --git a/docs/stackit_beta_sqlserverflex_database_create.md b/docs/stackit_beta_sqlserverflex_database_create.md new file mode 100644 index 000000000..5d1cbcaf3 --- /dev/null +++ b/docs/stackit_beta_sqlserverflex_database_create.md @@ -0,0 +1,42 @@ +## stackit beta sqlserverflex database create + +Creates an SQLServer Flex database + +### Synopsis + +Creates an SQLServer Flex database. +This operation cannot be triggered asynchronously (the "--async" flag will have no effect). + +``` +stackit beta sqlserverflex database create DATABASE_NAME [flags] +``` + +### Examples + +``` + Create an SQLServer Flex database with name "my-database" on instance with ID "xxx" + $ stackit beta sqlserverflex database create my-database --instance-id xxx --owner some-username +``` + +### Options + +``` + -h, --help Help for "stackit beta sqlserverflex database create" + --instance-id string SQLServer Flex instance ID + --owner string Username of the owner user +``` + +### Options inherited from parent commands + +``` + -y, --assume-yes If set, skips all confirmation prompts + --async If set, runs the command asynchronously + -o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"] + -p, --project-id string Project ID + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") +``` + +### SEE ALSO + +* [stackit beta sqlserverflex database](./stackit_beta_sqlserverflex_database.md) - Provides functionality for SQLServer Flex databases + diff --git a/docs/stackit_beta_sqlserverflex_database_delete.md b/docs/stackit_beta_sqlserverflex_database_delete.md new file mode 100644 index 000000000..638a9734d --- /dev/null +++ b/docs/stackit_beta_sqlserverflex_database_delete.md @@ -0,0 +1,41 @@ +## stackit beta sqlserverflex database delete + +Deletes an SQLServer Flex database + +### Synopsis + +Deletes an SQLServer Flex database. +This operation cannot be triggered asynchronously (the "--async" flag will have no effect). + +``` +stackit beta sqlserverflex database delete DATABASE_NAME [flags] +``` + +### Examples + +``` + Delete an SQLServer Flex database with name "my-database" of instance with ID "xxx" + $ stackit beta sqlserverflex database delete my-database --instance-id xxx +``` + +### Options + +``` + -h, --help Help for "stackit beta sqlserverflex database delete" + --instance-id string SQLServer Flex instance ID +``` + +### Options inherited from parent commands + +``` + -y, --assume-yes If set, skips all confirmation prompts + --async If set, runs the command asynchronously + -o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"] + -p, --project-id string Project ID + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") +``` + +### SEE ALSO + +* [stackit beta sqlserverflex database](./stackit_beta_sqlserverflex_database.md) - Provides functionality for SQLServer Flex databases + diff --git a/internal/cmd/beta/sqlserverflex/database/create/create.go b/internal/cmd/beta/sqlserverflex/database/create/create.go index 9a67a7a43..2f261b028 100644 --- a/internal/cmd/beta/sqlserverflex/database/create/create.go +++ b/internal/cmd/beta/sqlserverflex/database/create/create.go @@ -152,11 +152,7 @@ func outputResult(p *print.Printer, model *inputModel, resp *sqlserverflex.Creat return nil default: - operationState := "Created" - if model.Async { - operationState = "Triggered creation of" - } - p.Outputf("%s database %q\n", operationState, model.DatabaseName) + p.Outputf("Created database %q\n", model.DatabaseName) return nil } } diff --git a/internal/cmd/beta/sqlserverflex/database/create/create_test.go b/internal/cmd/beta/sqlserverflex/database/create/create_test.go index b3b436e0e..fc98c388a 100644 --- a/internal/cmd/beta/sqlserverflex/database/create/create_test.go +++ b/internal/cmd/beta/sqlserverflex/database/create/create_test.go @@ -143,6 +143,22 @@ func TestParseInput(t *testing.T) { }), isValid: false, }, + { + description: "instance id invalid 1", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[instanceIdFlag] = "" + }), + isValid: false, + }, + { + description: "instance id invalid 2", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[instanceIdFlag] = "invalid-uuid" + }), + isValid: false, + }, { description: "owner missing", argValues: fixtureArgValues(), diff --git a/internal/cmd/beta/sqlserverflex/database/database.go b/internal/cmd/beta/sqlserverflex/database/database.go index 27d532ed7..382b646c1 100644 --- a/internal/cmd/beta/sqlserverflex/database/database.go +++ b/internal/cmd/beta/sqlserverflex/database/database.go @@ -2,6 +2,7 @@ package database import ( "github.com/stackitcloud/stackit-cli/internal/cmd/beta/sqlserverflex/database/create" + "github.com/stackitcloud/stackit-cli/internal/cmd/beta/sqlserverflex/database/delete" "github.com/stackitcloud/stackit-cli/internal/pkg/args" "github.com/stackitcloud/stackit-cli/internal/pkg/print" "github.com/stackitcloud/stackit-cli/internal/pkg/utils" @@ -22,8 +23,6 @@ func NewCmd(p *print.Printer) *cobra.Command { } func addSubcommands(cmd *cobra.Command, p *print.Printer) { - // cmd.AddCommand(delete.NewCmd(p)) - // cmd.AddCommand(describe.NewCmd(p)) cmd.AddCommand(create.NewCmd(p)) - // cmd.AddCommand(list.NewCmd(p)) + cmd.AddCommand(delete.NewCmd(p)) } diff --git a/internal/cmd/beta/sqlserverflex/database/delete/delete.go b/internal/cmd/beta/sqlserverflex/database/delete/delete.go new file mode 100644 index 000000000..92b8c6c6b --- /dev/null +++ b/internal/cmd/beta/sqlserverflex/database/delete/delete.go @@ -0,0 +1,121 @@ +package delete + +import ( + "context" + "fmt" + + "github.com/stackitcloud/stackit-cli/internal/pkg/args" + "github.com/stackitcloud/stackit-cli/internal/pkg/errors" + "github.com/stackitcloud/stackit-cli/internal/pkg/examples" + "github.com/stackitcloud/stackit-cli/internal/pkg/flags" + "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" + "github.com/stackitcloud/stackit-cli/internal/pkg/print" + "github.com/stackitcloud/stackit-cli/internal/pkg/services/sqlserverflex/client" + "github.com/stackitcloud/stackit-cli/internal/pkg/spinner" + + "github.com/spf13/cobra" + "github.com/stackitcloud/stackit-sdk-go/services/sqlserverflex" +) + +const ( + databaseNameArg = "DATABASE_NAME" + + instanceIdFlag = "instance-id" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + DatabaseName string + InstanceId string +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: fmt.Sprintf("delete %s", databaseNameArg), + Short: "Deletes an SQLServer Flex database", + Long: fmt.Sprintf("%s\n%s", + "Deletes an SQLServer Flex database.", + `This operation cannot be triggered asynchronously (the "--async" flag will have no effect).`, + ), + Args: args.SingleArg(databaseNameArg, nil), + Example: examples.Build( + examples.NewExample( + `Delete an SQLServer Flex database with name "my-database" of instance with ID "xxx"`, + "$ stackit beta sqlserverflex database delete my-database --instance-id xxx"), + ), + RunE: func(cmd *cobra.Command, args []string) error { + ctx := context.Background() + model, err := parseInput(p, cmd, args) + if err != nil { + return err + } + + // Configure API client + apiClient, err := client.ConfigureClient(p) + if err != nil { + return err + } + + if !model.AssumeYes { + prompt := fmt.Sprintf("Are you sure you want to delete database %q? (This cannot be undone)", model.DatabaseName) + err = p.PromptForConfirmation(prompt) + if err != nil { + return err + } + } + + // Call API + req := buildRequest(ctx, model, apiClient) + s := spinner.New(p) + s.Start("Deleting database") + err = req.Execute() + if err != nil { + s.StopWithError() + return fmt.Errorf("delete SQLServer Flex database: %w", err) + } + s.Stop() + + p.Info("Deleted database %q\n", model.DatabaseName) + return nil + }, + } + configureFlags(cmd) + return cmd +} + +func configureFlags(cmd *cobra.Command) { + cmd.Flags().Var(flags.UUIDFlag(), instanceIdFlag, "SQLServer Flex instance ID") + err := flags.MarkFlagsRequired(cmd, instanceIdFlag) + cobra.CheckErr(err) +} + +func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inputModel, error) { + databaseName := inputArgs[0] + + globalFlags := globalflags.Parse(p, cmd) + if globalFlags.ProjectId == "" { + return nil, &errors.ProjectIdError{} + } + + model := inputModel{ + GlobalFlagModel: globalFlags, + DatabaseName: databaseName, + InstanceId: flags.FlagToStringValue(p, cmd, instanceIdFlag), + } + + if p.IsVerbosityDebug() { + modelStr, err := print.BuildDebugStrFromInputModel(model) + if err != nil { + p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err) + } else { + p.Debug(print.DebugLevel, "parsed input values: %s", modelStr) + } + } + + return &model, nil +} + +func buildRequest(ctx context.Context, model *inputModel, apiClient *sqlserverflex.APIClient) sqlserverflex.ApiDeleteDatabaseRequest { + req := apiClient.DeleteDatabase(ctx, model.ProjectId, model.InstanceId, model.DatabaseName) + return req +} diff --git a/internal/cmd/beta/sqlserverflex/database/delete/delete_test.go b/internal/cmd/beta/sqlserverflex/database/delete/delete_test.go new file mode 100644 index 000000000..ede474f38 --- /dev/null +++ b/internal/cmd/beta/sqlserverflex/database/delete/delete_test.go @@ -0,0 +1,239 @@ +package delete + +import ( + "context" + "testing" + + "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" + "github.com/stackitcloud/stackit-cli/internal/pkg/print" + "github.com/stackitcloud/stackit-sdk-go/services/sqlserverflex" + + "github.com/google/go-cmp/cmp" + "github.com/google/go-cmp/cmp/cmpopts" + "github.com/google/uuid" +) + +var projectIdFlag = globalflags.ProjectIdFlag + +type testCtxKey struct{} + +var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo") +var testClient = &sqlserverflex.APIClient{} +var testProjectId = uuid.NewString() +var testInstanceId = uuid.NewString() +var testDatabaseName = "my-database" + +func fixtureArgValues(mods ...func(argValues []string)) []string { + argValues := []string{ + testDatabaseName, + } + for _, mod := range mods { + mod(argValues) + } + return argValues +} + +func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]string { + flagValues := map[string]string{ + projectIdFlag: testProjectId, + instanceIdFlag: testInstanceId, + } + for _, mod := range mods { + mod(flagValues) + } + return flagValues +} + +func fixtureInputModel(mods ...func(model *inputModel)) *inputModel { + model := &inputModel{ + GlobalFlagModel: &globalflags.GlobalFlagModel{ + ProjectId: testProjectId, + Verbosity: globalflags.VerbosityDefault, + }, + DatabaseName: testDatabaseName, + InstanceId: testInstanceId, + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *sqlserverflex.ApiDeleteDatabaseRequest)) sqlserverflex.ApiDeleteDatabaseRequest { + request := testClient.DeleteDatabase(testCtx, testProjectId, testInstanceId, testDatabaseName) + for _, mod := range mods { + mod(&request) + } + return request +} + +func TestParseInput(t *testing.T) { + tests := []struct { + description string + argValues []string + flagValues map[string]string + isValid bool + expectedModel *inputModel + }{ + { + description: "base", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(), + isValid: true, + expectedModel: fixtureInputModel(), + }, + { + description: "no values", + argValues: []string{}, + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "no arg values", + argValues: []string{}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + { + description: "no flag values", + argValues: fixtureArgValues(), + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "project id missing", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, projectIdFlag) + }), + isValid: false, + }, + { + description: "project id invalid 1", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "" + }), + isValid: false, + }, + { + description: "project id invalid 2", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "invalid-uuid" + }), + isValid: false, + }, + { + description: "instance id missing", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, instanceIdFlag) + }), + isValid: false, + }, + { + description: "instance id invalid 1", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[instanceIdFlag] = "" + }), + isValid: false, + }, + { + description: "instance id invalid 2", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[instanceIdFlag] = "invalid-uuid" + }), + isValid: false, + }, + { + description: "database name invalid 1", + argValues: []string{""}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + p := print.NewPrinter() + cmd := NewCmd(p) + err := globalflags.Configure(cmd.Flags()) + if err != nil { + t.Fatalf("configure global flags: %v", err) + } + + for flag, value := range tt.flagValues { + err := cmd.Flags().Set(flag, value) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("setting flag --%s=%s: %v", flag, value, err) + } + } + + err = cmd.ValidateArgs(tt.argValues) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error validating args: %v", err) + } + + err = cmd.ValidateRequiredFlags() + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error validating flags: %v", err) + } + + model, err := parseInput(p, cmd, tt.argValues) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error parsing input: %v", err) + } + + if !tt.isValid { + t.Fatalf("did not fail on invalid input") + } + diff := cmp.Diff(model, tt.expectedModel) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} + +func TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest sqlserverflex.ApiDeleteDatabaseRequest + }{ + { + description: "base", + model: fixtureInputModel(), + expectedRequest: fixtureRequest(), + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + request := buildRequest(testCtx, tt.model, testClient) + + diff := cmp.Diff(request, tt.expectedRequest, + cmp.AllowUnexported(tt.expectedRequest), + cmpopts.EquateComparable(testCtx), + ) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} From 652a3171721d056db44340ff89ca5b6b7d6b57a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Palet?= Date: Fri, 21 Jun 2024 10:24:12 +0100 Subject: [PATCH 3/3] Fix typo --- docs/stackit_beta_sqlserverflex_database.md | 4 ++-- docs/stackit_beta_sqlserverflex_database_create.md | 6 +++--- docs/stackit_beta_sqlserverflex_database_delete.md | 6 +++--- internal/cmd/beta/sqlserverflex/database/create/create.go | 6 +++--- internal/cmd/beta/sqlserverflex/database/delete/delete.go | 6 +++--- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/stackit_beta_sqlserverflex_database.md b/docs/stackit_beta_sqlserverflex_database.md index 324a7d9c3..0ff6409a5 100644 --- a/docs/stackit_beta_sqlserverflex_database.md +++ b/docs/stackit_beta_sqlserverflex_database.md @@ -29,6 +29,6 @@ stackit beta sqlserverflex database [flags] ### SEE ALSO * [stackit beta sqlserverflex](./stackit_beta_sqlserverflex.md) - Provides functionality for SQLServer Flex -* [stackit beta sqlserverflex database create](./stackit_beta_sqlserverflex_database_create.md) - Creates an SQLServer Flex database -* [stackit beta sqlserverflex database delete](./stackit_beta_sqlserverflex_database_delete.md) - Deletes an SQLServer Flex database +* [stackit beta sqlserverflex database create](./stackit_beta_sqlserverflex_database_create.md) - Creates a SQLServer Flex database +* [stackit beta sqlserverflex database delete](./stackit_beta_sqlserverflex_database_delete.md) - Deletes a SQLServer Flex database diff --git a/docs/stackit_beta_sqlserverflex_database_create.md b/docs/stackit_beta_sqlserverflex_database_create.md index 5d1cbcaf3..4f4fdab41 100644 --- a/docs/stackit_beta_sqlserverflex_database_create.md +++ b/docs/stackit_beta_sqlserverflex_database_create.md @@ -1,10 +1,10 @@ ## stackit beta sqlserverflex database create -Creates an SQLServer Flex database +Creates a SQLServer Flex database ### Synopsis -Creates an SQLServer Flex database. +Creates a SQLServer Flex database. This operation cannot be triggered asynchronously (the "--async" flag will have no effect). ``` @@ -14,7 +14,7 @@ stackit beta sqlserverflex database create DATABASE_NAME [flags] ### Examples ``` - Create an SQLServer Flex database with name "my-database" on instance with ID "xxx" + Create a SQLServer Flex database with name "my-database" on instance with ID "xxx" $ stackit beta sqlserverflex database create my-database --instance-id xxx --owner some-username ``` diff --git a/docs/stackit_beta_sqlserverflex_database_delete.md b/docs/stackit_beta_sqlserverflex_database_delete.md index 638a9734d..b2c6bc471 100644 --- a/docs/stackit_beta_sqlserverflex_database_delete.md +++ b/docs/stackit_beta_sqlserverflex_database_delete.md @@ -1,10 +1,10 @@ ## stackit beta sqlserverflex database delete -Deletes an SQLServer Flex database +Deletes a SQLServer Flex database ### Synopsis -Deletes an SQLServer Flex database. +Deletes a SQLServer Flex database. This operation cannot be triggered asynchronously (the "--async" flag will have no effect). ``` @@ -14,7 +14,7 @@ stackit beta sqlserverflex database delete DATABASE_NAME [flags] ### Examples ``` - Delete an SQLServer Flex database with name "my-database" of instance with ID "xxx" + Delete a SQLServer Flex database with name "my-database" of instance with ID "xxx" $ stackit beta sqlserverflex database delete my-database --instance-id xxx ``` diff --git a/internal/cmd/beta/sqlserverflex/database/create/create.go b/internal/cmd/beta/sqlserverflex/database/create/create.go index 2f261b028..4cb15352f 100644 --- a/internal/cmd/beta/sqlserverflex/database/create/create.go +++ b/internal/cmd/beta/sqlserverflex/database/create/create.go @@ -37,15 +37,15 @@ type inputModel struct { func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: fmt.Sprintf("create %s", databaseNameArg), - Short: "Creates an SQLServer Flex database", + Short: "Creates a SQLServer Flex database", Long: fmt.Sprintf("%s\n%s", - "Creates an SQLServer Flex database.", + "Creates a SQLServer Flex database.", `This operation cannot be triggered asynchronously (the "--async" flag will have no effect).`, ), Args: args.SingleArg(databaseNameArg, nil), Example: examples.Build( examples.NewExample( - `Create an SQLServer Flex database with name "my-database" on instance with ID "xxx"`, + `Create a SQLServer Flex database with name "my-database" on instance with ID "xxx"`, "$ stackit beta sqlserverflex database create my-database --instance-id xxx --owner some-username"), ), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/internal/cmd/beta/sqlserverflex/database/delete/delete.go b/internal/cmd/beta/sqlserverflex/database/delete/delete.go index 92b8c6c6b..6f6426bea 100644 --- a/internal/cmd/beta/sqlserverflex/database/delete/delete.go +++ b/internal/cmd/beta/sqlserverflex/database/delete/delete.go @@ -32,15 +32,15 @@ type inputModel struct { func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: fmt.Sprintf("delete %s", databaseNameArg), - Short: "Deletes an SQLServer Flex database", + Short: "Deletes a SQLServer Flex database", Long: fmt.Sprintf("%s\n%s", - "Deletes an SQLServer Flex database.", + "Deletes a SQLServer Flex database.", `This operation cannot be triggered asynchronously (the "--async" flag will have no effect).`, ), Args: args.SingleArg(databaseNameArg, nil), Example: examples.Build( examples.NewExample( - `Delete an SQLServer Flex database with name "my-database" of instance with ID "xxx"`, + `Delete a SQLServer Flex database with name "my-database" of instance with ID "xxx"`, "$ stackit beta sqlserverflex database delete my-database --instance-id xxx"), ), RunE: func(cmd *cobra.Command, args []string) error {