feat(cdn): add cdn client, config, list command #1100
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
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,25 @@ | ||
| package cdn | ||
|
|
||
| import ( | ||
| "github.com/spf13/cobra" | ||
| "github.com/stackitcloud/stackit-cli/internal/cmd/beta/cdn/distribution" | ||
| "github.com/stackitcloud/stackit-cli/internal/cmd/params" | ||
| "github.com/stackitcloud/stackit-cli/internal/pkg/args" | ||
| "github.com/stackitcloud/stackit-cli/internal/pkg/utils" | ||
| ) | ||
|
|
||
| func NewCmd(params *params.CmdParams) *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "cdn", | ||
| Short: "Manage CDN resources", | ||
| Long: "Manage the lifecycle of CDN resources.", | ||
| Args: args.NoArgs, | ||
| Run: utils.CmdHelp, | ||
| } | ||
| addSubcommands(cmd, params) | ||
| return cmd | ||
| } | ||
|
|
||
| func addSubcommands(cmd *cobra.Command, params *params.CmdParams) { | ||
| cmd.AddCommand(distribution.NewCommand(params)) | ||
| } |
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,24 @@ | ||
| package distribution | ||
|
|
||
| import ( | ||
| "github.com/spf13/cobra" | ||
| "github.com/stackitcloud/stackit-cli/internal/cmd/beta/cdn/distribution/list" | ||
| "github.com/stackitcloud/stackit-cli/internal/cmd/params" | ||
| "github.com/stackitcloud/stackit-cli/internal/pkg/utils" | ||
| ) | ||
|
|
||
| func NewCommand(params *params.CmdParams) *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "distribution", | ||
| Short: "Manage CDN distributions", | ||
| Long: "Manage the lifecycle of CDN distributions.", | ||
| Args: cobra.NoArgs, | ||
| Run: utils.CmdHelp, | ||
| } | ||
| addSubcommands(cmd, params) | ||
| return cmd | ||
| } | ||
|
|
||
| func addSubcommands(cmd *cobra.Command, params *params.CmdParams) { | ||
| cmd.AddCommand(list.NewCmd(params)) | ||
| } |
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,173 @@ | ||
| package list | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/stackitcloud/stackit-cli/internal/cmd/params" | ||
| "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/cdn/client" | ||
| "github.com/stackitcloud/stackit-cli/internal/pkg/tables" | ||
| "github.com/stackitcloud/stackit-cli/internal/pkg/utils" | ||
| "github.com/stackitcloud/stackit-sdk-go/services/cdn" | ||
| ) | ||
|
|
||
| type inputModel struct { | ||
| *globalflags.GlobalFlagModel | ||
| SortBy string | ||
| } | ||
|
|
||
| const ( | ||
| sortByFlag = "sort-by" | ||
| ) | ||
|
|
||
| func NewCmd(params *params.CmdParams) *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "list", | ||
| Short: "List CDN distributions", | ||
| Long: "List all CDN distributions in your account.", | ||
| Args: args.NoArgs, | ||
| Example: examples.Build( | ||
| examples.NewExample( | ||
| `List all CDN distributions`, | ||
| `$ stackit beta cdn distribution list`, | ||
| ), | ||
| examples.NewExample( | ||
| `List all CDN distributions sorted by id`, | ||
| `$ stackit beta cdn distribution list --sort-by=id`, | ||
| ), | ||
| ), | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| ctx := context.Background() // should this be cancellable? | ||
|
|
||
| model, err := parseInput(params.Printer, cmd, args) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| apiClient, err := client.ConfigureClient(params.Printer, params.CliVersion) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| distributions, err := fetchDistributions(ctx, model, apiClient) | ||
| if err != nil { | ||
| return fmt.Errorf("fetch distributions: %w", err) | ||
| } | ||
|
|
||
| return outputResult(params.Printer, model.OutputFormat, distributions) | ||
| }, | ||
| } | ||
|
|
||
| configureFlags(cmd) | ||
| return cmd | ||
| } | ||
|
|
||
| var sortByFlagOptions = []string{"id", "created", "updated", "origin-url", "status"} | ||
|
|
||
| func configureFlags(cmd *cobra.Command) { | ||
| // same default as apiClient | ||
| cmd.Flags().Var(flags.EnumFlag(false, "created", sortByFlagOptions...), sortByFlag, fmt.Sprintf("Sort entries by a specific field, one of %q", sortByFlagOptions)) | ||
| } | ||
|
|
||
| func parseInput(p *print.Printer, cmd *cobra.Command, _ []string) (*inputModel, error) { | ||
| globalFlags := globalflags.Parse(p, cmd) | ||
| if globalFlags.ProjectId == "" { | ||
| return nil, &errors.ProjectIdError{} | ||
| } | ||
|
|
||
| model := inputModel{ | ||
| GlobalFlagModel: globalFlags, | ||
| SortBy: flags.FlagWithDefaultToStringValue(p, cmd, sortByFlag), | ||
| } | ||
|
|
||
| p.DebugInputModel(model) | ||
| return &model, nil | ||
| } | ||
|
|
||
| func buildRequest(ctx context.Context, model *inputModel, apiClient *cdn.APIClient, nextPageID cdn.ListDistributionsResponseGetNextPageIdentifierAttributeType) cdn.ApiListDistributionsRequest { | ||
| req := apiClient.ListDistributions(ctx, model.GlobalFlagModel.ProjectId) | ||
| req = req.SortBy(toAPISortBy(model.SortBy)) | ||
| req = req.PageSize(100) | ||
| if nextPageID != nil { | ||
| req = req.PageIdentifier(*nextPageID) | ||
| } | ||
| return req | ||
| } | ||
|
|
||
| func toAPISortBy(sortBy string) string { | ||
| switch sortBy { | ||
| case "id": | ||
| return "id" | ||
| case "created": | ||
| return "createdAt" | ||
| case "updated": | ||
| return "updatedAt" | ||
| case "origin-url": | ||
| return "originUrl" | ||
| case "status": | ||
| return "status" | ||
| default: | ||
| panic("invalid sortBy value, programmer error") | ||
| } | ||
| } | ||
|
|
||
| func outputResult(p *print.Printer, outputFormat string, distributions []cdn.Distribution) error { | ||
| if distributions == nil { | ||
| distributions = make([]cdn.Distribution, 0) // otherwise prints null in json output | ||
|
Member
There was a problem hiding this comment. That's a good catch indeed! Any chance we can solve this in a central place for all commands?
Author
There was a problem hiding this comment. Nice idea, I'll investigate this a bit, don't know much about go reflection yet.
Member
There was a problem hiding this comment. Reflection is considered a no-no, see https://principles.schwarz/principles/engineering-principles/go/avoid-using-reflection
Author
There was a problem hiding this comment. With reflection I'd add this in val := reflect.ValueOf(output)
if val.IsNil() {
// when passing a nil slice or map, JSON and YAML marshal to "null"
// so we need to create an empty slice or map to have "[]" or "{}" output instead
switch val.Kind() {
case reflect.Slice:
output = make([]any, 0)
case reflect.Map:
output = make(map[any]any)
default:
// do nothing
}
}The linked document suggests type switches, which would not work here. Another solution without reflection, that comes to mind, would be to introduce specialized |
||
| } | ||
| return p.OutputResult(outputFormat, distributions, func() error { | ||
| if len(distributions) == 0 { | ||
| p.Outputln("No CDN distributions found") | ||
| return nil | ||
| } | ||
|
|
||
| table := tables.NewTable() | ||
| table.SetHeader("ID", "REGIONS", "STATUS") | ||
|
Author
There was a problem hiding this comment. @rubenhoenle, when using the |
||
| for i := range distributions { | ||
| d := &distributions[i] | ||
| regions := make([]string, 0, len(*d.Config.Regions)) | ||
| for _, r := range *d.Config.Regions { | ||
| regions = append(regions, string(r)) | ||
| } | ||
| joinedRegions := strings.Join(regions, ", ") | ||
| table.AddRow( | ||
| utils.PtrString(d.Id), | ||
| joinedRegions, | ||
cgoetz-inovex marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| utils.PtrString(d.Status), | ||
| ) | ||
| } | ||
| err := table.Display(p) | ||
| if err != nil { | ||
| return fmt.Errorf("render table: %w", err) | ||
| } | ||
| return nil | ||
| }) | ||
| } | ||
|
|
||
| func fetchDistributions(ctx context.Context, model *inputModel, apiClient *cdn.APIClient) ([]cdn.Distribution, error) { | ||
| var nextPageID cdn.ListDistributionsResponseGetNextPageIdentifierAttributeType | ||
| var distributions []cdn.Distribution | ||
| for { | ||
| request := buildRequest(ctx, model, apiClient, nextPageID) | ||
| response, err := request.Execute() | ||
| if err != nil { | ||
| return nil, fmt.Errorf("list distributions: %w", err) | ||
| } | ||
| nextPageID = response.NextPageIdentifier | ||
| if response.Distributions != nil { | ||
| distributions = append(distributions, *response.Distributions...) | ||
| } | ||
| if nextPageID == nil { | ||
| break | ||
| } | ||
| } | ||
| return distributions, nil | ||
| } | ||
Oops, something went wrong.
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.
Please directly use directly the API values: "id" "updatedAt" "createdAt" "originUrl" "status" "originUrlRelated"
This was wrong in the Jira story.
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.
Maybe there's also a enum generated in the SDK which holds these values. Then this would be the way to go because it will be kept up-to-date in the future without any efforts on our side.
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.
Searched for
sortByandoriginUrletc. could not find an enum for this. The spec looks like it should generate an enum: https://github.com/stackitcloud/stackit-api-specifications/blob/83214868e6dbdc53d053cc07654542d8f34b5491/services/cdn/v1beta2/cdn.json#L1486How could I start to investigate this further?