-
Notifications
You must be signed in to change notification settings - Fork 37
Expand file tree
/
Copy pathdelete.go
More file actions
executable file
·242 lines (208 loc) · 8.83 KB
/
delete.go
File metadata and controls
executable file
·242 lines (208 loc) · 8.83 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: 2025 STACKIT GmbH & Co. KG
package delete
import (
"context"
"fmt"
"github.com/spf13/cobra"
"github.com/stackitcloud/stackit-cli/internal/pkg/args"
cliErr "github.com/stackitcloud/stackit-cli/internal/pkg/errors"
"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
"github.com/stackitcloud/stackit-cli/internal/pkg/print"
"github.com/stackitcloud/stackit-cli/internal/pkg/projectname"
"github.com/stackitcloud/stackit-cli/internal/pkg/services/edge/client"
commonErr "github.com/stackitcloud/stackit-cli/internal/pkg/services/edge/common/error"
commonInstance "github.com/stackitcloud/stackit-cli/internal/pkg/services/edge/common/instance"
commonValidation "github.com/stackitcloud/stackit-cli/internal/pkg/services/edge/common/validation"
"github.com/stackitcloud/stackit-cli/internal/pkg/spinner"
"github.com/stackitcloud/stackit-cli/internal/pkg/types"
"github.com/stackitcloud/stackit-sdk-go/services/edge"
"github.com/stackitcloud/stackit-sdk-go/services/edge/wait"
)
// Struct to model user input (arguments and/or flags)
type inputModel struct {
*globalflags.GlobalFlagModel
identifier *commonValidation.Identifier
}
// deleteRequestSpec captures the details of a request for testing.
type deleteRequestSpec struct {
// Exported fields allow tests to inspect the request inputs
ProjectID string
Region string
InstanceId string // Set if deleting by ID
InstanceName string // Set if deleting by Name
// Execute is a closure that wraps the actual SDK call
Execute func() error
}
// OpenApi generated code will have different types for by-instance-id and by-display-name API calls and therefore different wait handlers.
// InstanceWaiter is an interface to abstract the different wait handlers so they can be used interchangeably.
type instanceWaiter interface {
WaitWithContext(context.Context) (*edge.Instance, error)
}
// A function that creates an instance waiter
type instanceWaiterFactory = func(client *edge.APIClient) instanceWaiter
// Command constructor
// Instance id and displayname are likely to be refactored in future. For the time being we decided to use flags
// instead of args to provide the instance-id xor displayname to uniquely identify an instance. The displayname
// is guaranteed to be unique within a given project as of today. The chosen flag over args approach ensures we
// won't need a breaking change of the CLI when we refactor the commands to take the identifier as arg at some point.
func NewCmd(params *types.CmdParams) *cobra.Command {
cmd := &cobra.Command{
Use: "delete",
Short: "Deletes an edge instance",
Long: "Deletes a STACKIT Edge Cloud (STEC) instance. The instance will be deleted permanently.",
Args: args.NoArgs,
Example: examples.Build(
examples.NewExample(
fmt.Sprintf(`Delete an edge instance with %s "xxx"`, commonInstance.InstanceIdFlag),
fmt.Sprintf(`$ stackit beta edge-cloud instance delete --%s "xxx"`, commonInstance.InstanceIdFlag)),
examples.NewExample(
fmt.Sprintf(`Delete an edge instance with %s "xxx"`, commonInstance.DisplayNameFlag),
fmt.Sprintf(`$ stackit beta edge-cloud instance delete --%s "xxx"`, commonInstance.DisplayNameFlag)),
),
RunE: func(cmd *cobra.Command, _ []string) error {
ctx := context.Background()
// Parse user input (arguments and/or flags)
model, err := parseInput(params.Printer, cmd)
if err != nil {
return err
}
// Configure API client
apiClient, err := client.ConfigureClient(params.Printer, params.CliVersion)
if err != nil {
return err
}
projectLabel, err := projectname.GetProjectName(ctx, params.Printer, params.CliVersion, cmd)
if err != nil {
params.Printer.Debug(print.ErrorLevel, "get project name: %v", err)
// If project label can't be determined, fall back to project ID
projectLabel = model.ProjectId
}
// Prompt for confirmation
if !model.AssumeYes {
prompt := fmt.Sprintf("Are you sure you want to delete the edge instance %q of project %q?", model.identifier.Value, projectLabel)
err = params.Printer.PromptForConfirmation(prompt)
if err != nil {
return err
}
}
// Call API
err = run(ctx, model, apiClient)
if err != nil {
return err
}
// Wait for async operation, if async mode not enabled
operationState := "Triggered deletion of"
if !model.Async {
err := spinner.Run(params.Printer, "Deleting instance", func() error {
// Determine identifier and waiter to use
waiterFactory, err := getWaiterFactory(ctx, model)
if err != nil {
return err
}
// The waiter factory needs a concrete concreteClient type. We can safely cast here as the real implementation will always match.
concreteClient, ok := apiClient.(*edge.APIClient)
if !ok {
return fmt.Errorf("failed to configure API concreteClient")
}
waiter := waiterFactory(concreteClient)
_, err = waiter.WaitWithContext(ctx)
return err
})
if err != nil {
return fmt.Errorf("wait for edge instance deletion: %w", err)
}
operationState = "Deleted"
}
params.Printer.Info("%s instance with %q %q of project %q.\n", operationState, model.identifier.Flag, model.identifier.Value, projectLabel)
return nil
},
}
configureFlags(cmd)
return cmd
}
func configureFlags(cmd *cobra.Command) {
cmd.Flags().StringP(commonInstance.InstanceIdFlag, commonInstance.InstanceIdShorthand, "", commonInstance.InstanceIdUsage)
cmd.Flags().StringP(commonInstance.DisplayNameFlag, commonInstance.DisplayNameShorthand, "", commonInstance.DisplayNameUsage)
identifierFlags := []string{commonInstance.InstanceIdFlag, commonInstance.DisplayNameFlag}
cmd.MarkFlagsMutuallyExclusive(identifierFlags...) // InstanceId xor DisplayName
cmd.MarkFlagsOneRequired(identifierFlags...)
}
// Parse user input (arguments and/or flags)
func parseInput(p *print.Printer, cmd *cobra.Command) (*inputModel, error) {
globalFlags := globalflags.Parse(p, cmd)
if globalFlags.ProjectId == "" {
return nil, &cliErr.ProjectIdError{}
}
// Generate input model based on chosen flags
model := inputModel{
GlobalFlagModel: globalFlags,
}
// Parse and validate user input then add it to the model
id, err := commonValidation.GetValidatedInstanceIdentifier(p, cmd)
if err != nil {
return nil, err
}
model.identifier = id
// Log the parsed model if --verbosity is set to debug
p.DebugInputModel(model)
return &model, nil
}
// Run is the main execution function used by the command runner.
// It is decoupled from TTY output to have the ability to mock the API client during testing.
func run(ctx context.Context, model *inputModel, apiClient client.APIClient) error {
spec, err := buildRequest(ctx, model, apiClient)
if err != nil {
return err
}
if err := spec.Execute(); err != nil {
return cliErr.NewRequestFailedError(err)
}
return nil
}
// buildRequest constructs the spec that can be tested.
// It handles the logic of choosing between DeleteInstance and DeleteInstanceByName.
func buildRequest(ctx context.Context, model *inputModel, apiClient client.APIClient) (*deleteRequestSpec, error) {
if model == nil || model.identifier == nil {
return nil, commonErr.NewNoIdentifierError("")
}
spec := &deleteRequestSpec{
ProjectID: model.ProjectId,
Region: model.Region,
}
// Switch the concrete client based on the identifier flag used
switch model.identifier.Flag {
case commonInstance.InstanceIdFlag:
spec.InstanceId = model.identifier.Value
req := apiClient.DeleteInstance(ctx, model.ProjectId, model.Region, model.identifier.Value)
spec.Execute = req.Execute
case commonInstance.DisplayNameFlag:
spec.InstanceName = model.identifier.Value
req := apiClient.DeleteInstanceByName(ctx, model.ProjectId, model.Region, model.identifier.Value)
spec.Execute = req.Execute
default:
return nil, fmt.Errorf("%w: %w", cliErr.NewBuildRequestError("invalid identifier flag", nil), commonErr.NewInvalidIdentifierError(model.identifier.Flag))
}
return spec, nil
}
// Returns a factory function to create the appropriate waiter based on the input model.
func getWaiterFactory(ctx context.Context, model *inputModel) (instanceWaiterFactory, error) {
if model == nil || model.identifier == nil {
return nil, commonErr.NewNoIdentifierError("")
}
switch model.identifier.Flag {
case commonInstance.InstanceIdFlag:
factory := func(c *edge.APIClient) instanceWaiter {
return wait.DeleteInstanceWaitHandler(ctx, c, model.ProjectId, model.Region, model.identifier.Value)
}
return factory, nil
case commonInstance.DisplayNameFlag:
factory := func(c *edge.APIClient) instanceWaiter {
return wait.DeleteInstanceByNameWaitHandler(ctx, c, model.ProjectId, model.Region, model.identifier.Value)
}
return factory, nil
default:
return nil, commonErr.NewInvalidIdentifierError(model.identifier.Flag)
}
}