fix(server): switch to flag for service account email #1429
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -20,9 +20,11 @@ import ( | |||||
| ) | ||||||
|
|
||||||
| const ( | ||||||
| serviceAccMailArg = "SERVICE_ACCOUNT_EMAIL" // Deprecated: positional argument is not used anymore, use the flag instead, will be removed after 2026-12 | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
Did you add this to our deprecation document? |
||||||
|
|
||||||
| serverIdFlag = "server-id" | ||||||
|
|
||||||
| serviceAccFlag = "service-account-email" | ||||||
| ) | ||||||
|
|
||||||
| type inputModel struct { | ||||||
|
|
@@ -33,14 +35,14 @@ type inputModel struct { | |||||
|
|
||||||
| func NewCmd(params *types.CmdParams) *cobra.Command { | ||||||
| cmd := &cobra.Command{ | ||||||
| Use: "detach", | ||||||
| Short: "Detach a service account from a server", | ||||||
| Long: "Detach a service account from a server", | ||||||
| Args: args.SingleOptionalArg(serviceAccMailArg, nil), | ||||||
| Example: examples.Build( | ||||||
| examples.NewExample( | ||||||
| `Detach a service account with mail "xxx@sa.stackit.cloud" from a server "yyy"`, | ||||||
| "$ stackit server service-account detach --service-account-email xxx@sa.stackit.cloud --server-id yyy", | ||||||
| ), | ||||||
| ), | ||||||
| RunE: func(cmd *cobra.Command, args []string) error { | ||||||
|
|
@@ -85,18 +87,27 @@ func NewCmd(params *types.CmdParams) *cobra.Command { | |||||
|
|
||||||
| func configureFlags(cmd *cobra.Command) { | ||||||
| cmd.Flags().VarP(flags.UUIDFlag(), serverIdFlag, "s", "Server id") | ||||||
| cmd.Flags().VarP(flags.EmailFlag(), serviceAccFlag, "a", "Service Account Email") | ||||||
| err := flags.MarkFlagsRequired(cmd, serverIdFlag) | ||||||
| cobra.CheckErr(err) | ||||||
| } | ||||||
|
|
||||||
| func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inputModel, error) { | ||||||
| globalFlags := globalflags.Parse(p, cmd) | ||||||
| if globalFlags.ProjectId == "" { | ||||||
| return nil, &errors.ProjectIdError{} | ||||||
| } | ||||||
|
|
||||||
| var serviceAccMail string | ||||||
| if cmd.Flags().Changed(serviceAccFlag) { | ||||||
| serviceAccMail = flags.FlagToStringValue(p, cmd, serviceAccFlag) | ||||||
| } else if len(inputArgs) > 0 { | ||||||
| serviceAccMail = inputArgs[0] | ||||||
| p.Warn("using a positional argument for the service account email is deprecated and will be removed after 2026-12. Please use '--%s' instead.\n", serviceAccFlag) | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||
| } else { | ||||||
| return nil, fmt.Errorf(`service account must be specified by using either the --%s flag or (deprecated) as a positional argument`, serviceAccFlag) | ||||||
| } | ||||||
|
|
||||||
| model := inputModel{ | ||||||
| GlobalFlagModel: globalFlags, | ||||||
| ServerId: flags.FlagToStringValue(p, cmd, serverIdFlag), | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| package flags | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/spf13/pflag" | ||
| ) | ||
|
|
||
| type emailFlag struct { | ||
| value string | ||
| } | ||
|
|
||
| // Ensure the implementation satisfies the expected interface | ||
| var _ pflag.Value = &emailFlag{} | ||
|
|
||
| // EmailFlag returns a flag which must be a valid Email. | ||
| func EmailFlag() *emailFlag { | ||
| return &emailFlag{} | ||
| } | ||
|
|
||
| func (f *emailFlag) String() string { | ||
| return f.value | ||
| } | ||
|
|
||
| func (f *emailFlag) Set(value string) error { | ||
| isEmail := value != "" && strings.Contains(value, "@") | ||
| if !isEmail { | ||
| return fmt.Errorf("invalid email address: %s", value) | ||
| } | ||
| f.value = value | ||
| return nil | ||
| } | ||
|
|
||
| func (f *emailFlag) Type() string { | ||
| return "string" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| package flags | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func TestEmailFlag(t *testing.T) { | ||
| tests := []struct { | ||
| description string | ||
| value string | ||
| isValid bool | ||
| }{ | ||
| { | ||
| description: "valid", | ||
| value: "test@test", | ||
| isValid: true, | ||
| }, | ||
| { | ||
| description: "empty", | ||
| value: "", | ||
| isValid: false, | ||
| }, | ||
| { | ||
| description: "invalid", | ||
| value: "invalid-email", | ||
| isValid: false, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.description, func(t *testing.T) { | ||
| flag := EmailFlag() | ||
| cmd := &cobra.Command{ | ||
| Use: "test", | ||
| RunE: func(_ *cobra.Command, _ []string) error { | ||
| return nil | ||
| }, | ||
| } | ||
| cmd.Flags().Var(flag, "test-flag", "test") | ||
|
|
||
| err := cmd.Flags().Set("test-flag", tt.value) | ||
|
|
||
| if !tt.isValid && err == nil { | ||
| t.Fatalf("did not fail on invalid input") | ||
| } | ||
| if !tt.isValid { | ||
| return | ||
| } | ||
|
|
||
| if err != nil { | ||
| t.Fatalf("failed on valid input: %v", err) | ||
| } | ||
| value := FlagToStringValue(nil, cmd, "test-flag") | ||
| if value != tt.value { | ||
| t.Fatalf("flag did not return set value") | ||
| } | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.