Alpha module list

docs/user/gen-docs/_sidebar.ts

@@ -19,6 +19,7 @@ export default [
   { text: 'kyma alpha kubeconfig generate', link: './gen-docs/kyma_alpha_kubeconfig_generate' },
   { text: 'kyma alpha module', link: './gen-docs/kyma_alpha_module' },
   { text: 'kyma alpha module catalog', link: './gen-docs/kyma_alpha_module_catalog' },
+  { text: 'kyma alpha module list', link: './gen-docs/kyma_alpha_module_list' },
   { text: 'kyma alpha module pull', link: './gen-docs/kyma_alpha_module_pull' },
   { text: 'kyma alpha provision', link: './gen-docs/kyma_alpha_provision' },
   { text: 'kyma alpha reference-instance', link: './gen-docs/kyma_alpha_reference-instance' },

docs/user/gen-docs/kyma_alpha_module.md

@@ -14,6 +14,7 @@ kyma alpha module <command> [flags]
 
 ```text
   catalog - Lists modules catalog
+  list    - Lists installed modules
   pull    - Pulls a module from a remote repository
 ```
 
@@ -31,4 +32,5 @@ kyma alpha module <command> [flags]
 
 * [kyma alpha](kyma_alpha.md)                               - Groups command prototypes for which the API may still change
 * [kyma alpha module catalog](kyma_alpha_module_catalog.md) - Lists modules catalog
+* [kyma alpha module list](kyma_alpha_module_list.md)       - Lists installed modules
 * [kyma alpha module pull](kyma_alpha_module_pull.md)       - Pulls a module from a remote repository

docs/user/gen-docs/kyma_alpha_module_list.md

@@ -0,0 +1,28 @@
+# kyma alpha module list
+
+Lists installed modules.
+
+## Synopsis
+
+Use this command to list the installed Kyma modules.
+
+WARNING: This functionality is still under construction. Community modules are not yet supported.
+
+```bash
+kyma alpha module list [flags]
+```
+
+## Flags
+
+```text
+  -o, --output string           Output format (Possible values: table, json, yaml)
+      --context string          The name of the kubeconfig context to use
+  -h, --help                    Help for the command
+      --kubeconfig string       Path to the Kyma kubeconfig file
+      --show-extensions-error   Prints a possible error when fetching extensions fails
+      --skip-extensions         Skips fetching extensions from the target Kyma environment
+```
+
+## See also
+
+* [kyma alpha module](kyma_alpha_module.md) - Manages Kyma modules

internal/cmd/alpha/module/list.go

@@ -0,0 +1,57 @@
+package module
+
+import (
+	"github.com/kyma-project/cli.v3/internal/clierror"
+	"github.com/kyma-project/cli.v3/internal/cmdcommon"
+	"github.com/kyma-project/cli.v3/internal/cmdcommon/types"
+	"github.com/kyma-project/cli.v3/internal/modulesv2"
+	"github.com/kyma-project/cli.v3/internal/out"
+	"github.com/spf13/cobra"
+)
+
+type listConfig struct {
+	*cmdcommon.KymaConfig
+	outputFormat types.Format
+}
+
+func NewListV2CMD(kymaConfig *cmdcommon.KymaConfig) *cobra.Command {
+	cfg := listConfig{
+		KymaConfig: kymaConfig,
+	}
+
+	cmd := &cobra.Command{
+		Use:   "list [flags]",
+		Short: "Lists installed modules",
+		Long: `Use this command to list the installed Kyma modules.
+
+WARNING: This functionality is still under construction. Community modules are not yet supported.`,
+		Run: func(_ *cobra.Command, _ []string) {
+			clierror.Check(listModulesV2(&cfg))
+		},
+	}
+
+	cmd.Flags().VarP(&cfg.outputFormat, "output", "o", "Output format (Possible values: table, json, yaml)")
+
+	return cmd
+}
+
+func listModulesV2(cfg *listConfig) clierror.Error {
+	moduleOperations := modulesv2.NewModuleOperations(cfg.KymaConfig)
+
+	listService, err := moduleOperations.List()
+	if err != nil {
+		return clierror.Wrap(err, clierror.New("failed to execute the list command"))
+	}
+
+	results, err := listService.Run(cfg.Ctx)
+	if err != nil {
+		return clierror.Wrap(err, clierror.New("failed to list installed modules"))
+	}
+
+	err = modulesv2.RenderList(results, cfg.outputFormat, out.Default)
+	if err != nil {
+		return clierror.Wrap(err, clierror.New("failed to render module list"))
+	}
+
+	return nil
+}

internal/cmd/alpha/module/list_test.go

@@ -0,0 +1,19 @@
+package module
+
+import (
+	"testing"
+
+	"github.com/kyma-project/cli.v3/internal/cmdcommon"
+	"github.com/stretchr/testify/require"
+)
+
+func TestListCmd_Exists(t *testing.T) {
+	cmd := NewListV2CMD(&cmdcommon.KymaConfig{})
+	require.NotNil(t, cmd)
+	require.Equal(t, "list [flags]", cmd.Use)
+}
+
+func TestListCmd_HasOutputFlag(t *testing.T) {
+	cmd := NewListV2CMD(&cmdcommon.KymaConfig{})
+	require.NotNil(t, cmd.Flags().Lookup("output"))
+}

internal/cmd/alpha/module/module.go

@@ -15,6 +15,7 @@ func NewModuleCMD(kymaConfig *cmdcommon.KymaConfig) *cobra.Command {
 
 	cmd.AddCommand(NewCatalogV2CMD(kymaConfig))
 	cmd.AddCommand(NewPullV2CMD(kymaConfig))
+	cmd.AddCommand(NewListV2CMD(kymaConfig))
 
 	return cmd
 }

internal/modulesv2/dependencies.go

@@ -12,11 +12,7 @@ import (
 type ModuleOperations interface {
 	Catalog() (*CatalogService, error)
 	Pull() (*PullService, error)
-	// TODO
-	// Add() (*AddService, error)
-	// Install() (*InstallService, error)
-	// Pull() (*PullService, error)
-	// etc.
+	List() (*ListService, error)
 }
 
 type moduleOperations struct {
@@ -38,6 +34,17 @@ func (m *moduleOperations) Catalog() (*CatalogService, error) {
 	return catalogService, nil
 }
 
+func (m *moduleOperations) List() (*ListService, error) {
+	c := setupDIContainer(m.kymaConfig)
+
+	listService, err := di.GetTyped[*ListService](c)
+	if err != nil {
+		return nil, errors.New("failed to execute the list command")
+	}
+
+	return listService, nil
+}
+
 func (m *moduleOperations) Pull() (*PullService, error) {
 	c := setupDIContainer(m.kymaConfig)
 
@@ -83,6 +90,15 @@ func setupDIContainer(kymaConfig *cmdcommon.KymaConfig) *di.Container {
 		return repository.NewClusterMetadataRepository(kubeClient), nil
 	})
 
+	di.RegisterTyped(container, func(c *di.Container) (repository.ModuleInstallationsRepository, error) {
+		kubeClient, err := di.GetTyped[kube.Client](c)
+		if err != nil {
+			return nil, err
+		}
+
+		return repository.NewModuleInstallationsRepository(kubeClient), nil
+	})
+
 	// Services:
 
 	di.RegisterTyped(container, func(c *di.Container) (*CatalogService, error) {
@@ -108,5 +124,14 @@ func setupDIContainer(kymaConfig *cmdcommon.KymaConfig) *di.Container {
 		return NewPullService(moduleRepo), nil
 	})
 
+	di.RegisterTyped(container, func(c *di.Container) (*ListService, error) {
+		installedModulesRepo, err := di.GetTyped[repository.ModuleInstallationsRepository](c)
+		if err != nil {
+			return nil, err
+		}
+
+		return NewListService(installedModulesRepo), nil
+	})
+
 	return container
 }

internal/modulesv2/dtos/listresult.go

@@ -0,0 +1,11 @@
+package dtos
+
+type ListResult struct {
+	Name                 string
+	Version              string
+	Channel              string
+	ModuleState          string
+	Managed              bool
+	CustomResourcePolicy string
+	InstallationState    string
+}

internal/modulesv2/entities/moduleinstallation.go

@@ -0,0 +1,45 @@
+package entities
+
+import "github.com/kyma-project/cli.v3/internal/kube/kyma"
+
+type ModuleInstallation struct {
+	Name                 string
+	Version              string
+	Channel              string
+	KymaModuleState      string
+	ModuleState          string
+	InstallationState    string
+	Managed              *bool
+	CustomResourcePolicy string
+	TemplateName         string
+	TemplateNamespace    string
+	specModuleName       string
+	statusModuleName     string
+}
+
+func NewModuleInstallationFromRaw(raw kyma.KymaModuleInfo) *ModuleInstallation {
+	name := raw.Status.Name
+	if name == "" {
+		name = raw.Spec.Name
+	}
+	return &ModuleInstallation{
+		Name:                 name,
+		Version:              raw.Status.Version,
+		Channel:              raw.Status.Channel,
+		KymaModuleState:      raw.Status.State,
+		Managed:              raw.Spec.Managed,
+		CustomResourcePolicy: raw.Spec.CustomResourcePolicy,
+		TemplateName:         raw.Status.Template.GetName(),
+		TemplateNamespace:    raw.Status.Template.GetNamespace(),
+		specModuleName:       raw.Spec.Name,
+		statusModuleName:     raw.Status.Name,
+	}
+}
+
+func (m *ModuleInstallation) IsManaged() bool {
+	return m.Managed == nil || *m.Managed
+}
+
+func (m *ModuleInstallation) IsBeingDeleted() bool {
+	return m.statusModuleName != "" && m.specModuleName == ""
+}

internal/modulesv2/entities/moduleinstallation_test.go

@@ -0,0 +1,88 @@
+package entities
+
+import (
+	"testing"
+
+	"github.com/kyma-project/cli.v3/internal/kube/kyma"
+	"github.com/stretchr/testify/require"
+)
+
+func TestModuleInstallation_IsManaged_TrueWhenManagedIsNil(t *testing.T) {
+	m := ModuleInstallation{Managed: nil}
+	require.True(t, m.IsManaged())
+}
+
+func TestModuleInstallation_IsManaged_TrueWhenManagedIsTrue(t *testing.T) {
+	managed := true
+	m := ModuleInstallation{Managed: &managed}
+	require.True(t, m.IsManaged())
+}
+
+func TestModuleInstallation_IsManaged_FalseWhenManagedIsFalse(t *testing.T) {
+	managed := false
+	m := ModuleInstallation{Managed: &managed}
+	require.False(t, m.IsManaged())
+}
+
+func TestNewModuleInstallationFromRaw_MapsAllFields(t *testing.T) {
+	managed := false
+	status := kyma.ModuleStatus{
+		Name:    "api-gateway",
+		Version: "3.5.1",
+		Channel: "regular",
+		State:   "Ready",
+	}
+	status.Template.SetName("api-gateway-template")
+	status.Template.SetNamespace("kyma-system")
+	raw := kyma.KymaModuleInfo{
+		Spec: kyma.Module{
+			Name:                 "api-gateway",
+			Managed:              &managed,
+			CustomResourcePolicy: "CreateAndDelete",
+		},
+		Status: status,
+	}
+
+	m := NewModuleInstallationFromRaw(raw)
+
+	require.Equal(t, "api-gateway", m.Name)
+	require.Equal(t, "3.5.1", m.Version)
+	require.Equal(t, "regular", m.Channel)
+	require.Equal(t, "Ready", m.KymaModuleState)
+	require.NotNil(t, m.Managed)
+	require.False(t, *m.Managed)
+	require.Equal(t, "CreateAndDelete", m.CustomResourcePolicy)
+	require.Equal(t, "api-gateway-template", m.TemplateName)
+	require.Equal(t, "kyma-system", m.TemplateNamespace)
+}
+
+func TestNewModuleInstallationFromRaw_UsesSpecNameWhenStatusNameIsEmpty(t *testing.T) {
+	raw := kyma.KymaModuleInfo{
+		Spec: kyma.Module{Name: "api-gateway"},
+	}
+
+	m := NewModuleInstallationFromRaw(raw)
+
+	require.Equal(t, "api-gateway", m.Name)
+}
+
+func TestModuleInstallation_IsBeingDeleted_TrueWhenOnlyInStatus(t *testing.T) {
+	raw := kyma.KymaModuleInfo{
+		Status: kyma.ModuleStatus{Name: "api-gateway", State: "Deleting"},
+	}
+
+	m := NewModuleInstallationFromRaw(raw)
+
+	require.True(t, m.IsBeingDeleted())
+}
+
+func TestModuleInstallation_IsBeingDeleted_FalseWhenSpecPresent(t *testing.T) {
+	raw := kyma.KymaModuleInfo{
+		Spec:   kyma.Module{Name: "api-gateway"},
+		Status: kyma.ModuleStatus{Name: "api-gateway", State: "Ready"},
+	}
+
+	m := NewModuleInstallationFromRaw(raw)
+
+	require.False(t, m.IsBeingDeleted())
+}

internal/modulesv2/fake/installedmodules.go

@@ -0,0 +1,16 @@
+package fake
+
+import (
+	"context"
+
+	"github.com/kyma-project/cli.v3/internal/modulesv2/entities"
+)
+
+type ModuleInstallationsRepository struct {
+	ListInstalledModulesResult []entities.ModuleInstallation
+	ListInstalledModulesError  error
+}
+
+func (f *ModuleInstallationsRepository) ListInstalledModules(_ context.Context) ([]entities.ModuleInstallation, error) {
+	return f.ListInstalledModulesResult, f.ListInstalledModulesError
+}