chore(edge): refactoring and migration to new SDK structure - #1503
Open
GokceGK wants to merge 11 commits into
Open
chore(edge): refactoring and migration to new SDK structure#1503GokceGK wants to merge 11 commits into
GokceGK wants to merge 11 commits into
Conversation
relates to STACKITCLI-357
relates to STACKITCLI-357
rubenhoenle
requested changes
Jul 28, 2026
rubenhoenle
left a comment
rubenhoenle
left a comment
Member
There was a problem hiding this comment.
Just a first glance, this thing is big. Will have to take a second look but I have to quit work for today.
| // Build request payload | ||
| payload := edge.CreateInstancePayload{ | ||
| DisplayName: &model.DisplayName, | ||
| DisplayName: *model.DisplayName, |
Member
There was a problem hiding this comment.
Both the display name as the plan id are required flags. Why are they pointers in your inputModel struct then? I see only a risk for nil pointers here without any benefit 😅
| // Output result based on the configured output format | ||
| func outputResult(p *print.Printer, outputFormat string, async bool, projectLabel string, instance *edge.Instance) error { | ||
| func outputResult(p *print.Printer, model *inputModel, projectLabel string, instance *edge.Instance) error { | ||
| if instance == nil { |
Member
There was a problem hiding this comment.
Move this nil check into the callback of p.OutputResult. The JSON/YAML output can handle nil values just fine.
| @@ -34,86 +27,17 @@ var ( | |||
| testPlanId = uuid.NewString() | |||
| testDescription = "Initial instance description" | |||
| if model.Async { | ||
| operationState = "Triggered deletion of" | ||
| } | ||
| params.Printer.Info("%s instance %q of project %q.\n", operationState, instanceLabel, projectLabel) |
Member
There was a problem hiding this comment.
Suggested change
| params.Printer.Info("%s instance %q of project %q.\n", operationState, instanceLabel, projectLabel) | |
| params.Printer.Outputf("%s instance %q of project %q.\n", operationState, instanceLabel, projectLabel) |
I hope this is the last time I will have to comment this. Stderr vs. stdout. 😉
| // This is only to prevent nil pointer deref. | ||
| // As long as the API behaves as defined by it's spec, instance can not be empty (HTTP 200 with an empty body) | ||
| return commonErr.NewNoInstanceError("") | ||
| return fmt.Errorf("instance response is empty") |
Member
There was a problem hiding this comment.
same here, move this nil check into the callback func please
| return string(kubeconfigYAML), nil | ||
| default: | ||
| return "", fmt.Errorf("%w: %s", commonErr.NewNoIdentifierError(""), format) | ||
| return "", fmt.Errorf("format is not JSON or YAML: %s", format) |
Member
There was a problem hiding this comment.
can't we use p.OutputResult here?
Contributor
Author
There was a problem hiding this comment.
not really, here I am returning the marshalled data which can be written in a file or output depending on the given flags.
| cmd := &cobra.Command{ | ||
| Use: "create", | ||
| Short: "Creates a token for an edge instance", | ||
| Use: fmt.Sprintf("create token for %s", instanceIdArg), |
Member
There was a problem hiding this comment.
Suggested change
| Use: fmt.Sprintf("create token for %s", instanceIdArg), | |
| Use: fmt.Sprintf("create"), |
Same here. Furthermore we don't use arguments on create commands. The instance id would be a flag.
| "An expiration time can be set for the token. The expiration time is set in seconds(s), minutes(m), hours(h), days(d) or months(M). Default is 3600(1h) seconds.", | ||
| "Note: the format for the duration is <value><unit>, e.g. 30d for 30 days. You may not combine units."), | ||
| Args: args.NoArgs, | ||
| Args: args.SingleArg(instanceIdArg, nil), |
Member
There was a problem hiding this comment.
- We don't do that by convention. Instance ID would have to be a flag.
- This is a breaking change.
| // Output result based on the configured output format | ||
| func outputResult(p *print.Printer, outputFormat string, token *edge.Token) error { | ||
| if token == nil || token.Token == nil { | ||
| if token == nil { |
Member
There was a problem hiding this comment.
same as above, move this nil check into the callback for the pretty output
| tokenString := token.Token | ||
|
|
||
| return p.OutputResult(outputFormat, token, func() error { | ||
| p.Outputln(tokenString) |
Member
There was a problem hiding this comment.
Suggested change
| p.Outputln(tokenString) | |
| p.Outputln(token.Token) |
Why a variable for everything?
| edge "github.com/stackitcloud/stackit-sdk-go/services/edge/v1beta1api" | ||
| ) | ||
|
|
||
| func GetInstanceName(ctx context.Context, apiClient edge.DefaultAPI, projectId, instanceId, region string) (string, error) { |
Contributor
There was a problem hiding this comment.
Nitpick: swap region and instanceId argument to be in the same order as the APIs expect:
Suggested change
| func GetInstanceName(ctx context.Context, apiClient edge.DefaultAPI, projectId, instanceId, region string) (string, error) { | |
| func GetInstanceName(ctx context.Context, apiClient edge.DefaultAPI, projectId, region, instanceId string) (string, error) { |
relates to STACKITCLI-357
relates to STACKITCLI-357
|
|
||
| return resp, nil | ||
| } | ||
| func buildRequest(ctx context.Context, model *inputModel, apiClient *edge.APIClient) (req edge.ApiCreateInstanceRequest, err error) { |
Contributor
There was a problem hiding this comment.
Nitpick: any reason why we use named return values here? they aren't actually by the function and pretty unusual in our codebase
Contributor
Author
There was a problem hiding this comment.
ah yes, you are right. We sometimes used that style but here it is not necessary at all, removed
| Long: fmt.Sprintf("%s\n\n%s\n%s", | ||
| "Creates a token for a STACKIT Edge Cloud (STEC) instance.", | ||
| fmt.Sprintf("An expiration time can be set for the token. The expiration time is set in seconds(s), minutes(m), hours(h), days(d) or months(M). Default is %d seconds.", commonKubeconfig.ExpirationSecondsDefault), | ||
| "An expiration time can be set for the token. The expiration time is set in seconds(s), minutes(m), hours(h), days(d) or months(M). Default is 3600(1h) seconds.", |
Contributor
There was a problem hiding this comment.
Nitpick: use the actual configuredexpirationSecondsDefault here instead of a hardcoded string value
| cmd.Flags().StringP(commonInstance.DisplayNameFlag, commonInstance.DisplayNameShorthand, "", commonInstance.DisplayNameUsage) | ||
| cmd.Flags().StringP(commonKubeconfig.ExpirationFlag, commonKubeconfig.ExpirationShorthand, "", commonKubeconfig.ExpirationUsage) | ||
| cmd.Flags().String(instanceIdFlag, "", "Edge Cloud instance ID") | ||
| cmd.Flags().StringP(expirationFlag, "e", "", "Expiration time for the token, e.g. 5d. By default, the token is valid for 1h.") |
Contributor
There was a problem hiding this comment.
Here use expirationSecondsDefault as well instead of hardcoded string
|
|
||
| // Parse user input (arguments and/or flags) | ||
| func parseInput(p *print.Printer, cmd *cobra.Command) (*inputModel, error) { | ||
| func parseInput(p *print.Printer, cmd *cobra.Command, _ []string) (*inputModel, error) { |
Contributor
There was a problem hiding this comment.
The last _ []string parameter seems to be unnecassary
Contributor
Author
There was a problem hiding this comment.
I removed it and adapted the related unit test. Changed also the kubeconfig create command as same implementation was in there.
Merging this branch changes the coverage (11 decrease, 1 increase)
Coverage by fileChanged files (no unit tests)
Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code. Changed unit test files
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
relates to STACKITCLI-357
Checklist
make fmtmake generate-docs(will be checked by CI)make test(will be checked by CI)make lint(will be checked by CI)