feat: Implement the modulectl create command

.golangci.yaml

@@ -30,7 +30,9 @@ linters-settings:
         disabled: true
         arguments: [ 120 ]
   funlen:
+    statements: 50
     lines: 80
+    ignore-comments: true
   cyclop:
     max-complexity: 20
   nestif:
@@ -58,12 +60,27 @@ linters-settings:
         alias: scaffoldcmd
       - pkg: github.com/kyma-project/modulectl/cmd/modulectl/create
         alias: createcmd
+      - pkg: github.com/kyma-project/modulectl/internal/service/moduleconfig/generator
+        alias: moduleconfiggenerator
+      - pkg: github.com/kyma-project/modulectl/internal/service/moduleconfig/reader
+        alias: moduleconfigreader
+      - pkg: ocm.software/ocm/api/ocm/compdesc/meta/v1
+        alias: ocmv1
+      - pkg: ocm.software/ocm/cmds/ocm/commands/ocmcmds/common/inputs/types/ociartifact
+        alias: ociartifacttypes
+      - pkg: k8s.io/apimachinery/pkg/apis/meta/v1
+        alias: metav1
   ireturn:
     allow:
       - anon
       - error
       - empty
       - stdlib
+      - vfs.FileSystem
+      - internal.BlobAccess
+      - internal.ComponentVersionAccess
+      - internal.Credentials
+      - internal.Repository
   varnamelen:
     ignore-names:
       - ok
@@ -75,6 +92,9 @@ issues:
   exclude-rules:
     - path: "_test\\.go"
       linters:
+        - dupl # Table driven unit and integration tests are expected to have duplicate code
+        - goconst # To be descriptive in tests we sometimes don't extract constants
+        - varnamelen # Table driven unit and integration tests are expected to have short variable names
         - wrapcheck # Errors do not need to be wrapped in unit and integration tests
         - err113 # Dynamic error creation in unit and integration tests is ok
         - gochecknoglobals # Does not apply to unit and integration tests

cmd/modulectl/cmd.go

@@ -3,17 +3,27 @@ package modulectl
 import (
 	"fmt"
 
+	"github.com/mandelsoft/vfs/pkg/memoryfs"
+	"github.com/mandelsoft/vfs/pkg/osfs"
 	"github.com/spf13/cobra"
 
 	createcmd "github.com/kyma-project/modulectl/cmd/modulectl/create"
 	scaffoldcmd "github.com/kyma-project/modulectl/cmd/modulectl/scaffold"
+	"github.com/kyma-project/modulectl/internal/service/componentarchive"
+	"github.com/kyma-project/modulectl/internal/service/componentdescriptor"
 	"github.com/kyma-project/modulectl/internal/service/contentprovider"
+	"github.com/kyma-project/modulectl/internal/service/crdparser"
 	"github.com/kyma-project/modulectl/internal/service/create"
 	"github.com/kyma-project/modulectl/internal/service/filegenerator"
 	"github.com/kyma-project/modulectl/internal/service/filegenerator/reusefilegenerator"
-	"github.com/kyma-project/modulectl/internal/service/moduleconfig"
+	"github.com/kyma-project/modulectl/internal/service/git"
+	moduleconfiggenerator "github.com/kyma-project/modulectl/internal/service/moduleconfig/generator"
+	moduleconfigreader "github.com/kyma-project/modulectl/internal/service/moduleconfig/reader"
+	"github.com/kyma-project/modulectl/internal/service/registry"
 	"github.com/kyma-project/modulectl/internal/service/scaffold"
+	"github.com/kyma-project/modulectl/internal/service/templategenerator"
 	"github.com/kyma-project/modulectl/tools/filesystem"
+	"github.com/kyma-project/modulectl/tools/ocirepo"
 	"github.com/kyma-project/modulectl/tools/yaml"
 
 	_ "embed"
@@ -69,7 +79,29 @@ func NewCmd() (*cobra.Command, error) {
 }
 
 func buildModuleService() (*create.Service, error) {
-	moduleService, err := create.NewService(&create.Service{})
+	fileSystemUtil := &filesystem.Util{}
+	tmpFileSystem := filesystem.NewTempFileSystem()
+
+	moduleConfigService, err := moduleconfigreader.NewService(fileSystemUtil, tmpFileSystem)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create module config service: %w", err)
+	}
+
+	gitService := git.NewService()
+	gitSourcesService := componentdescriptor.NewGitSourcesService(gitService)
+	securityConfigService := componentdescriptor.NewSecurityConfigService(gitService)
+
+	memoryFileSystem := memoryfs.New()
+	osFileSystem := osfs.New()
+	archiveFileSystemService := filesystem.NewArchiveFileSystem(memoryFileSystem, osFileSystem)
+	componentArchiveService := componentarchive.NewService(archiveFileSystemService)
+	ociRepo := &ocirepo.OCIRepo{}
+	registryService := registry.NewService(ociRepo, nil)
+	moduleTemplateService := templategenerator.NewService(fileSystemUtil)
+	crdParserService := crdparser.NewService(fileSystemUtil)
+
+	moduleService, err := create.NewService(moduleConfigService, gitSourcesService,
+		securityConfigService, componentArchiveService, registryService, moduleTemplateService, crdParserService)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create module service: %w", err)
 	}
@@ -80,17 +112,18 @@ func buildScaffoldService() (*scaffold.Service, error) {
 	fileSystemUtil := &filesystem.Util{}
 	yamlConverter := &yaml.ObjectToYAMLConverter{}
 
-	moduleConfigContentProvider, err := contentprovider.NewModuleConfig(yamlConverter)
+	moduleConfigContentProvider, err := contentprovider.NewModuleConfigProvider(yamlConverter)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create module config content provider: %w", err)
 	}
 
-	moduleConfigFileGenerator, err := filegenerator.NewService(moduleConfigKind, fileSystemUtil, moduleConfigContentProvider)
+	moduleConfigFileGenerator, err := filegenerator.NewService(moduleConfigKind, fileSystemUtil,
+		moduleConfigContentProvider)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create module config file generator: %w", err)
 	}
 
-	moduleConfigService, err := moduleconfig.NewService(fileSystemUtil, moduleConfigFileGenerator)
+	moduleConfigService, err := moduleconfiggenerator.NewService(fileSystemUtil, moduleConfigFileGenerator)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create module config service: %w", err)
 	}
@@ -100,17 +133,20 @@ func buildScaffoldService() (*scaffold.Service, error) {
 		return nil, fmt.Errorf("failed to create manifest file generator: %w", err)
 	}
 
-	manifestReuseFileGenerator, err := reusefilegenerator.NewService(manifestKind, fileSystemUtil, manifestFileGenerator)
+	manifestReuseFileGenerator, err := reusefilegenerator.NewService(manifestKind, fileSystemUtil,
+		manifestFileGenerator)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create manifest reuse file generator: %w", err)
 	}
 
-	defaultCRFileGenerator, err := filegenerator.NewService(defaultCRKind, fileSystemUtil, contentprovider.NewDefaultCR())
+	defaultCRFileGenerator, err := filegenerator.NewService(defaultCRKind, fileSystemUtil,
+		contentprovider.NewDefaultCR())
 	if err != nil {
 		return nil, fmt.Errorf("failed to create default CR file generator: %w", err)
 	}
 
-	defaultCRReuseFileGenerator, err := reusefilegenerator.NewService(defaultCRKind, fileSystemUtil, defaultCRFileGenerator)
+	defaultCRReuseFileGenerator, err := reusefilegenerator.NewService(defaultCRKind, fileSystemUtil,
+		defaultCRFileGenerator)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create default CR reuse file generator: %w", err)
 	}
@@ -120,12 +156,14 @@ func buildScaffoldService() (*scaffold.Service, error) {
 		return nil, fmt.Errorf("failed to create security config content provider: %w", err)
 	}
 
-	securityConfigFileGenerator, err := filegenerator.NewService(securityConfigKind, fileSystemUtil, securityConfigContentProvider)
+	securityConfigFileGenerator, err := filegenerator.NewService(securityConfigKind, fileSystemUtil,
+		securityConfigContentProvider)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create security config file generator: %w", err)
 	}
 
-	securityConfigReuseFileGenerator, err := reusefilegenerator.NewService(securityConfigKind, fileSystemUtil, securityConfigFileGenerator)
+	securityConfigReuseFileGenerator, err := reusefilegenerator.NewService(securityConfigKind, fileSystemUtil,
+		securityConfigFileGenerator)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create security config reuse file generator: %w", err)
 	}

cmd/modulectl/create/cmd_test.go

@@ -52,19 +52,17 @@ func Test_Execute_ParsesAllModuleOptions(t *testing.T) {
 	insecure := "true"
 	templateOutput := testutils.RandomName(10)
 	registryURL := testutils.RandomName(10)
-	registryCredSelector := testutils.RandomName(10)
-	secScannerConfig := testutils.RandomName(10)
+	credSelector := testutils.RandomName(10)
 
 	os.Args = []string{
 		"create",
 		"--module-config-file", moduleConfigFile,
-		"--credentials", credentials,
 		"--git-remote", gitRemote,
 		"--insecure", insecure,
 		"--output", templateOutput,
 		"--registry", registryURL,
-		"--registry-cred-selector", registryCredSelector,
-		"--sec-scanners-config", secScannerConfig,
+		"--registry-credentials", credentials,
+		"--registry-cred-selector", credSelector,
 	}
 
 	svc := &moduleServiceStub{}
@@ -82,8 +80,7 @@ func Test_Execute_ParsesAllModuleOptions(t *testing.T) {
 	assert.Equal(t, insecureFlagSet, svc.opts.Insecure)
 	assert.Equal(t, templateOutput, svc.opts.TemplateOutput)
 	assert.Equal(t, registryURL, svc.opts.RegistryURL)
-	assert.Equal(t, registryCredSelector, svc.opts.RegistryCredSelector)
-	assert.Equal(t, secScannerConfig, svc.opts.SecScannerConfig)
+	assert.Equal(t, credSelector, svc.opts.RegistryCredSelector)
 }
 
 func Test_Execute_ParsesModuleShortOptions(t *testing.T) {
@@ -124,7 +121,6 @@ func Test_Execute_ModuleParsesDefaults(t *testing.T) {
 	assert.Equal(t, createcmd.TemplateOutputFlagDefault, svc.opts.TemplateOutput)
 	assert.Equal(t, createcmd.RegistryURLFlagDefault, svc.opts.RegistryURL)
 	assert.Equal(t, createcmd.RegistryCredSelectorFlagDefault, svc.opts.RegistryCredSelector)
-	assert.Equal(t, createcmd.SecScannersConfigFlagDefault, svc.opts.SecScannerConfig)
 }
 
 // Test Stubs

cmd/modulectl/create/example.txt

@@ -1,3 +1,2 @@
-Examples:
 Build a simple module and push it to a remote registry
 		modulectl create --module-config-file=/path/to/module-config-file --registry http://localhost:5001/unsigned --insecure

cmd/modulectl/create/flags.go

@@ -9,16 +9,16 @@ import (
 const (
 	ModuleConfigFileFlagName    = "module-config-file"
 	ModuleConfigFileFlagDefault = "module-config.yaml"
-	moduleConfigFileFlagUsage   = "Specifies the module configuration file."
+	moduleConfigFileFlagUsage   = "Specifies the path to the module configuration file."
 
-	CredentialsFlagName    = "credentials"
+	CredentialsFlagName    = "registry-credentials" //nolint:gosec // Not hardcoded credentials, rather just flag name
 	credentialsFlagShort   = "c"
 	CredentialsFlagDefault = ""
 	credentialsFlagUsage   = "Basic authentication credentials for the given repository in the <user:password> format."
 
 	GitRemoteFlagName    = "git-remote"
-	GitRemoteFlagDefault = "origin"
-	gitRemoteFlagUsage   = `Specifies the remote name of the wanted GitHub repository. For example "origin" or "upstream" (default "origin").`
+	GitRemoteFlagDefault = ""
+	gitRemoteFlagUsage   = "Specifies the URL of the module's GitHub repository. "
 
 	InsecureFlagName    = "insecure"
 	InsecureFlagDefault = false
@@ -27,9 +27,10 @@ const (
 	TemplateOutputFlagName    = "output"
 	templateOutputFlagShort   = "o"
 	TemplateOutputFlagDefault = "template.yaml"
-	templateOutputFlagUsage   = `File to write the module template if the module is uploaded to a registry (default "template.yaml").`
+	templateOutputFlagUsage   = `Path to write the ModuleTemplate file to, if the module is uploaded to a registry (default "template.yaml").`
 
 	RegistryURLFlagName    = "registry"
+	registryFlagShort      = "r"
 	RegistryURLFlagDefault = ""
 	registryURLFlagUsage   = "Context URL of the repository. The repository URL will be automatically added to the repository contexts in the module descriptor."
 
@@ -38,19 +39,18 @@ const (
 	RegistryCredSelectorFlagDefault = ""
 	//nolint:gosec // Not hardcoded credentials, rather just flag name
 	registryCredSelectorFlagUsage = `Label selector to identify an externally created Secret of type "kubernetes.io/dockerconfigjson". It allows the image to be accessed in private image registries. It can be used when you push your module to a registry with authenticated access. For example, "label1=value1,label2=value2".`
-
-	SecScannersConfigFlagName    = "sec-scanners-config"
-	SecScannersConfigFlagDefault = "sec-scanners-config.yaml"
-	secScannersConfigFlagUsage   = `Path to the file holding the security scan configuration (default "sec-scanners-config.yaml").`
 )
 
 func parseFlags(flags *pflag.FlagSet, opts *create.Options) {
-	flags.StringVar(&opts.ModuleConfigFile, ModuleConfigFileFlagName, ModuleConfigFileFlagDefault, moduleConfigFileFlagUsage)
-	flags.StringVarP(&opts.Credentials, CredentialsFlagName, credentialsFlagShort, CredentialsFlagDefault, credentialsFlagUsage)
+	flags.StringVar(&opts.ModuleConfigFile, ModuleConfigFileFlagName, ModuleConfigFileFlagDefault,
+		moduleConfigFileFlagUsage)
+	flags.StringVarP(&opts.Credentials, CredentialsFlagName, credentialsFlagShort, CredentialsFlagDefault,
+		credentialsFlagUsage)
 	flags.StringVar(&opts.GitRemote, GitRemoteFlagName, GitRemoteFlagDefault, gitRemoteFlagUsage)
 	flags.BoolVar(&opts.Insecure, InsecureFlagName, InsecureFlagDefault, insecureFlagUsage)
-	flags.StringVarP(&opts.TemplateOutput, TemplateOutputFlagName, templateOutputFlagShort, TemplateOutputFlagDefault, templateOutputFlagUsage)
-	flags.StringVar(&opts.RegistryURL, RegistryURLFlagName, RegistryURLFlagDefault, registryURLFlagUsage)
-	flags.StringVar(&opts.RegistryCredSelector, RegistryCredSelectorFlagName, RegistryCredSelectorFlagDefault, registryCredSelectorFlagUsage)
-	flags.StringVar(&opts.SecScannerConfig, SecScannersConfigFlagName, SecScannersConfigFlagDefault, secScannersConfigFlagUsage)
+	flags.StringVarP(&opts.TemplateOutput, TemplateOutputFlagName, templateOutputFlagShort, TemplateOutputFlagDefault,
+		templateOutputFlagUsage)
+	flags.StringVarP(&opts.RegistryURL, RegistryURLFlagName, registryFlagShort, RegistryURLFlagDefault, registryURLFlagUsage)
+	flags.StringVar(&opts.RegistryCredSelector, RegistryCredSelectorFlagName, RegistryCredSelectorFlagDefault,
+		registryCredSelectorFlagUsage)
 }

cmd/modulectl/create/flags_test.go

@@ -13,14 +13,17 @@ func Test_ScaffoldFlagsDefaults(t *testing.T) {
 		value    string
 		expected string
 	}{
-		{name: createcmd.ModuleConfigFileFlagName, value: createcmd.ModuleConfigFileFlagDefault, expected: "module-config.yaml"},
+		{
+			name:     createcmd.ModuleConfigFileFlagName,
+			value:    createcmd.ModuleConfigFileFlagDefault,
+			expected: "module-config.yaml",
+		},
 		{name: createcmd.CredentialsFlagName, value: createcmd.CredentialsFlagDefault, expected: ""},
-		{name: createcmd.GitRemoteFlagName, value: createcmd.GitRemoteFlagDefault, expected: "origin"},
+		{name: createcmd.GitRemoteFlagName, value: createcmd.GitRemoteFlagDefault, expected: ""},
 		{name: createcmd.InsecureFlagName, value: strconv.FormatBool(createcmd.InsecureFlagDefault), expected: "false"},
 		{name: createcmd.TemplateOutputFlagName, value: createcmd.TemplateOutputFlagDefault, expected: "template.yaml"},
 		{name: createcmd.RegistryURLFlagName, value: createcmd.RegistryURLFlagDefault, expected: ""},
 		{name: createcmd.RegistryCredSelectorFlagName, value: createcmd.RegistryCredSelectorFlagDefault, expected: ""},
-		{name: createcmd.SecScannersConfigFlagName, value: createcmd.SecScannersConfigFlagDefault, expected: "sec-scanners-config.yaml"},
 	}
 
 	for _, testcase := range tests {