Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor extensions handling #2427

Merged
merged 2 commits into from
Mar 21, 2025
Merged

Refactor extensions handling #2427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dbdc079
refactor extensions handling
FilipRudy Mar 20, 2025
2002ea0
refactor extensions handling
FilipRudy Mar 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion internal/cmd/alpha/alpha.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ func NewAlphaCMD() *cobra.Command {
"registry_config": config.NewConfigCMD,
"registry_image-import": imageimport.NewImportCMD,
"function_init": function.NewInitCmd,
}, cmd, kymaConfig)
}, cmd)

kymaConfig.DisplayExtensionsErrors(cmd.ErrOrStderr())

Expand Down
38 changes: 17 additions & 21 deletions internal/cmdcommon/extension.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@ func newExtensionsConfig(config *KymaConfig) *KymaExtensionsConfig {

if getBoolFlagValue("--skip-extensions") {
// skip extensions fetching
return &KymaExtensionsConfig{
kymaConfig: config,
}
return extensionsConfig
}

extensionsConfig.extensions, extensionsConfig.parseErrors = loadExtensionsFromCluster(config.Ctx, config.KubeClientConfig)
Expand All @@ -52,37 +50,31 @@ func (kec *KymaExtensionsConfig) GetRawExtensions() ExtensionList {
return kec.extensions
}

func (kec *KymaExtensionsConfig) BuildExtensions(availableTemplateCommands *TemplateCommandsList, availableCoreCommands CoreCommandsMap, cmd *cobra.Command, config *KymaConfig) []*cobra.Command {
func (kec *KymaExtensionsConfig) BuildExtensions(availableTemplateCommands *TemplateCommandsList, availableCoreCommands CoreCommandsMap, cmd *cobra.Command) []*cobra.Command {
var cmds []*cobra.Command

var cms, cmsError = getExtensionConfigMaps(config.Ctx, config.KubeClientConfig)
if cmsError != nil {
kec.parseErrors = cmsError
return nil
}

existingCommands := make(map[string]bool)
for _, baseCmd := range cmd.Commands() {
existingCommands[baseCmd.Name()] = true
}

for _, cm := range cms.Items {
extension, _ := parseResourceExtension(cm.Data)
for _, extensionItem := range kec.extensions {
extension := extensionItem.Extension
if existingCommands[extension.RootCommand.Name] {
kec.parseErrors = errors.Join(
kec.parseErrors,
fmt.Errorf("failed to validate configmap '%s/%s': base command with name='%s' already exists",
cm.GetNamespace(), cm.GetName(), extension.RootCommand.Name),
extensionItem.ConfigMapNamespace, extensionItem.ConfigMapName, extension.RootCommand.Name),
)
continue
}

extensionCommands, err := buildCommandFromExtension(kec.kymaConfig, extension, availableTemplateCommands, availableCoreCommands)
extensionCommands, err := buildCommandFromExtension(kec.kymaConfig, &extension, availableTemplateCommands, availableCoreCommands)
if err != nil {
kec.parseErrors = errors.Join(
kec.parseErrors,
fmt.Errorf("failed to build extensions from configmap '%s/%s': %s",
cm.GetNamespace(), cm.GetName(), err.Error()),
extensionItem.ConfigMapNamespace, extensionItem.ConfigMapName, err.Error()),
)
continue
}
Expand Down Expand Up @@ -124,13 +116,13 @@ func getExtensionConfigMaps(ctx context.Context, clientConfig *KubeClientConfig)
return cms, nil
}

func loadExtensionsFromCluster(ctx context.Context, clientConfig *KubeClientConfig) ([]Extension, error) {
func loadExtensionsFromCluster(ctx context.Context, clientConfig *KubeClientConfig) (ExtensionList, error) {
var cms, cmsError = getExtensionConfigMaps(ctx, clientConfig)
if cmsError != nil {
return nil, cmsError
}

var extensions []Extension
var extensionsItems ExtensionList
var parseErrors error
for _, cm := range cms.Items {
extension, err := parseResourceExtension(cm.Data)
Expand All @@ -144,8 +136,8 @@ func loadExtensionsFromCluster(ctx context.Context, clientConfig *KubeClientConf
continue
}

if slices.ContainsFunc(extensions, func(e Extension) bool {
return e.RootCommand.Name == extension.RootCommand.Name
if slices.ContainsFunc(extensionsItems, func(e ExtensionItem) bool {
return e.Extension.RootCommand.Name == extension.RootCommand.Name
}) {
parseErrors = errors.Join(
parseErrors,
Expand All @@ -155,10 +147,14 @@ func loadExtensionsFromCluster(ctx context.Context, clientConfig *KubeClientConf
continue
}

extensions = append(extensions, *extension)
extensionsItems = append(extensionsItems, ExtensionItem{
ConfigMapName: cm.GetName(),
ConfigMapNamespace: cm.GetNamespace(),
Extension: *extension,
})
}

return extensions, parseErrors
return extensionsItems, parseErrors
}

func parseResourceExtension(cmData map[string]string) (*Extension, error) {
Expand Down
128 changes: 68 additions & 60 deletions internal/cmdcommon/extension_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,14 @@ descriptionLong: test-description-long

want := ExtensionList{
{
RootCommand: types.RootCommand{
Name: "test-command",
Description: "test-description",
DescriptionLong: "test-description-long",
ConfigMapName: "bad-data",
ConfigMapNamespace: "",
Extension: Extension{
RootCommand: types.RootCommand{
Name: "test-command",
Description: "test-description",
DescriptionLong: "test-description-long",
},
},
},
}
Expand Down Expand Up @@ -251,70 +255,74 @@ create:
}
}

func fixTestExtension(name string) Extension {
return Extension{
RootCommand: types.RootCommand{
Name: name,
Description: "test-description",
DescriptionLong: "test-description-long",
},
Resource: &types.ResourceInfo{
Scope: types.NamespaceScope,
Kind: "TestKind",
Group: "test.group",
Version: "v1",
},
TemplateCommands: &TemplateCommands{
GetCommand: &types.GetCommand{
Description: "test-get-description",
DescriptionLong: "test-get-description-long",
Parameters: []types.Parameter{
{
Path: ".metadata.generation",
Name: "generation",
},
},
},
ExplainCommand: &types.ExplainCommand{
func fixTestExtension(name string) ExtensionItem {
return ExtensionItem{
ConfigMapName: name,
ConfigMapNamespace: "",
Extension: Extension{
RootCommand: types.RootCommand{
Name: name,
Description: "test-description",
DescriptionLong: "test-description-long",
Output: "test-explain-output",
},
DeleteCommand: &types.DeleteCommand{
Description: "test-delete-description",
DescriptionLong: "test-delete-description-long",
Resource: &types.ResourceInfo{
Scope: types.NamespaceScope,
Kind: "TestKind",
Group: "test.group",
Version: "v1",
},
CreateCommand: &types.CreateCommand{
Description: "create test resource",
DescriptionLong: "use this command to create test resource",
CustomFlags: []types.CustomFlag{
{
Type: types.StringCustomFlagType,
Name: "test-flag",
Description: "test-flag description",
Shorthand: "t",
Path: ".spec.test.field",
DefaultValue: "test-default",
Required: true,
TemplateCommands: &TemplateCommands{
GetCommand: &types.GetCommand{
Description: "test-get-description",
DescriptionLong: "test-get-description-long",
Parameters: []types.Parameter{
{
Path: ".metadata.generation",
Name: "generation",
},
},
{
Type: types.PathCustomFlagType,
Name: "test-flag-2",
Description: "test-flag-2 description",
Shorthand: "f",
Path: ".spec.test.field2",
DefaultValue: "test-default2",
Required: false,
},
ExplainCommand: &types.ExplainCommand{
Description: "test-description",
DescriptionLong: "test-description-long",
Output: "test-explain-output",
},
DeleteCommand: &types.DeleteCommand{
Description: "test-delete-description",
DescriptionLong: "test-delete-description-long",
},
CreateCommand: &types.CreateCommand{
Description: "create test resource",
DescriptionLong: "use this command to create test resource",
CustomFlags: []types.CustomFlag{
{
Type: types.StringCustomFlagType,
Name: "test-flag",
Description: "test-flag description",
Shorthand: "t",
Path: ".spec.test.field",
DefaultValue: "test-default",
Required: true,
},
{
Type: types.PathCustomFlagType,
Name: "test-flag-2",
Description: "test-flag-2 description",
Shorthand: "f",
Path: ".spec.test.field2",
DefaultValue: "test-default2",
Required: false,
},
},
},
},
},
CoreCommands: []CoreCommandInfo{
{
ActionID: "test-action-id-1",
},
{
ActionID: "test-action-id-2",
CoreCommands: []CoreCommandInfo{
{
ActionID: "test-action-id-1",
},
{
ActionID: "test-action-id-2",
},
},
},
}
Expand Down
12 changes: 9 additions & 3 deletions internal/cmdcommon/extension_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,17 @@ type TemplateCommandsList struct {
Delete func(templates.KubeClientGetter, *templates.DeleteOptions) *cobra.Command
}

type ExtensionList []Extension
type ExtensionList []ExtensionItem

type ExtensionItem struct {
ConfigMapName string
ConfigMapNamespace string
Extension Extension
}

func (el *ExtensionList) ContainResource(kind string) bool {
for _, extension := range *el {
if extension.Resource.Kind == kind {
for _, item := range *el {
if item.Extension.Resource.Kind == kind {
return true
}
}
Expand Down
Loading