feat: Add E2E Test Suite for module create

.github/workflows/build.yaml

@@ -1,21 +1,20 @@
-name: Build modulectl
+name: Build
 on:
   pull_request:
     branches:
       - main
       - 'release-**'
   workflow_dispatch:
 jobs:
-  build:
-    name: Build modulectl
+  build-modulectl:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout modulectl
+      - name: Checkout
         uses: actions/checkout@v4
-      - name: Set up Go
+      - name: Go setup
         uses: actions/setup-go@v4
         with:
           go-version-file: 'go.mod'
           cache-dependency-path: 'go.sum'
-      - name: Run CLI Build
+      - name: "Run 'make build'"
         run: make build

.github/workflows/test-e2e-create.yml

@@ -0,0 +1,57 @@
+name: E2E test - create command
+on:
+  push:
+    branches:
+      - main
+      - 'release-**'
+  pull_request:
+    branches:
+      - main
+      - 'release-**'
+jobs:
+  test-create-cmd:
+    runs-on: ubuntu-latest
+    env:
+      K3D_VERSION: v5.4.7
+      MODULE_TEMPLATE_VERSION: 1.0.0
+      OCI_REPOSITORY_URL: http://k3d-oci.localhost:5001
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Go setup
+        uses: actions/setup-go@v4
+        with:
+          go-version-file: 'go.mod'
+          cache-dependency-path: 'go.sum'
+      - name: Build
+        run: |
+          make build-linux
+          chmod +x ./bin/modulectl-linux
+          ls -la ./bin
+          mv ./bin/modulectl-linux /usr/local/bin/modulectl
+        timeout-minutes: 5
+      - name: Checkout template-operator
+        uses: actions/checkout@v4
+        with:
+          repository: kyma-project/template-operator
+          path: ./template-operator/
+      - name: Copy template-operator to e2e testdata folder
+        run: |
+          mkdir -p ./tests/e2e/create/testdata/template-operator/
+          cp -r ./../template-operator/ ./tests/e2e/create/testdata/template-operator/
+      - name: Set template-operator github URL
+        run: |
+          cd ./template-operator
+          echo "TEST_REPOSITORY_URL=$(git remote get-url origin)" >> "$GITHUB_ENV"
+      - name: Install k3d and create registry
+        run: |
+          wget -qO - https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | TAG=$K3D_VERSION bash
+          k3d registry create oci.localhost --port 5001
+      - name: Make manifests template-operator
+        run: |
+          cd ./template-operator
+          make build-manifests
+      - name: Run tests
+        run: |
+          make -C tests/e2e test-create-cmd
+        timeout-minutes: 3

.github/workflows/e2e-test-create-scaffold.yml → .github/workflows/test-e2e-scaffold.yml

@@ -1,29 +1,28 @@
-name: E2E Test - Create Scaffold
+name: E2E test - scaffold command
 on:
   pull_request:
     branches:
       - main
       - 'release-**'
 jobs:
-  e2e-test:
-    name: E2E Test - Create Scaffold
+  test-scaffold-cmd:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout modulectl
+      - name: Checkout
         uses: actions/checkout@v4
-      - name: Set up Go
+      - name: Go setup
         uses: actions/setup-go@v4
         with:
           go-version-file: 'go.mod'
           cache-dependency-path: 'go.sum'
-      - name: Build modulectl
+      - name: Build
         run: |
           make build-linux
           chmod +x ./bin/modulectl-linux
           ls -la ./bin
           mv ./bin/modulectl-linux /usr/local/bin/modulectl
-        timeout-minutes: 10
-      - name: Run E2E Test - Create Scaffold
+        timeout-minutes: 5
+      - name: Run tests
         run: |
-          make -C tests/e2e test-create-scaffold
+          make -C tests/e2e test-scaffold-cmd
         timeout-minutes: 3

.gitignore

@@ -99,3 +99,6 @@ bin
 
 # rendered manifest
 **/manifest.yaml
+
+# copied template-operator repo
+tests/e2e/create/testdata/template-operator

.golangci.yaml

@@ -6,7 +6,7 @@ linters:
     - exhaustruct   # too subjective and harms code readability
     - execinquery   # deprecated (since v1.58.0)
     - exportloopref # deprecated (since v1.60.2), replaced by copyloopvar
-    - forbidigo     # temparily disabled
+    - forbidigo     # temporarily disabled
     - godot         # not needed
     - gomnd         # deprecated (since v1.58.0), renamed to mnd
     - lll
@@ -58,6 +58,12 @@ linters-settings:
         alias: scaffoldcmd
       - pkg: github.com/kyma-project/modulectl/cmd/modulectl/create
         alias: createcmd
+      - pkg: github.com/open-component-model/ocm/pkg/contexts/ocm/compdesc/meta/v1
+        alias: ocmmetav1
+      - pkg: github.com/open-component-model/ocm/pkg/contexts/ocm/compdesc/versions/v2
+        alias: compdescv2
+      - pkg: github.com/open-component-model/ocm/pkg/contexts/ocm/repositories/ocireg
+        alias: ocmocireg
   ireturn:
     allow:
       - anon
@@ -70,7 +76,6 @@ linters-settings:
     ignore-type-assert-ok: true
     ignore-map-index-ok: true
     ignore-chan-recv-ok: true
-  godox:  # `TODO`, `BUG`, `FIXME` are the default, no need to mention again
 issues:
   exclude-rules:
     - path: "_test\\.go"

cmd/modulectl/create/cmd.go

@@ -24,13 +24,13 @@ var long string
 //go:embed example.txt
 var example string
 
-type ModuleService interface {
-	CreateModule(opts create.Options) error
+type Service interface {
+	Run(opts create.Options) error
 }
 
-func NewCmd(moduleService ModuleService) (*cobra.Command, error) {
-	if moduleService == nil {
-		return nil, fmt.Errorf("%w: createService must not be nil", commonerrors.ErrInvalidArg)
+func NewCmd(service Service) (*cobra.Command, error) {
+	if service == nil {
+		return nil, fmt.Errorf("%w: service must not be nil", commonerrors.ErrInvalidArg)
 	}
 
 	opts := create.Options{}
@@ -41,7 +41,7 @@ func NewCmd(moduleService ModuleService) (*cobra.Command, error) {
 		Long:    long,
 		Example: example,
 		RunE: func(cmd *cobra.Command, _ []string) error {
-			return moduleService.CreateModule(opts)
+			return service.Run(opts)
 		},
 	}
 

cmd/modulectl/create/cmd_test.go

@@ -18,7 +18,7 @@ func Test_NewCmd_ReturnsError_WhenModuleServiceIsNil(t *testing.T) {
 	_, err := createcmd.NewCmd(nil)
 
 	require.Error(t, err)
-	assert.Contains(t, err.Error(), "createService")
+	assert.Contains(t, err.Error(), "service must not be nil")
 }
 
 func Test_NewCmd_Succeeds(t *testing.T) {
@@ -134,7 +134,7 @@ type moduleServiceStub struct {
 	opts   create.Options
 }
 
-func (m *moduleServiceStub) CreateModule(opts create.Options) error {
+func (m *moduleServiceStub) Run(opts create.Options) error {
 	m.called = true
 	m.opts = opts
 	return nil
@@ -144,6 +144,6 @@ type moduleServiceErrorStub struct{}
 
 var errSomeTestError = errors.New("some test error")
 
-func (s *moduleServiceErrorStub) CreateModule(_ create.Options) error {
+func (s *moduleServiceErrorStub) Run(_ create.Options) error {
 	return errSomeTestError
 }

cmd/modulectl/scaffold/cmd.go

@@ -24,13 +24,13 @@ var long string
 //go:embed example.txt
 var example string
 
-type ScaffoldService interface {
-	CreateScaffold(opts scaffold.Options) error
+type Service interface {
+	Run(opts scaffold.Options) error
 }
 
-func NewCmd(scaffoldService ScaffoldService) (*cobra.Command, error) {
-	if scaffoldService == nil {
-		return nil, fmt.Errorf("%w: scaffoldService must not be nil", commonerrors.ErrInvalidArg)
+func NewCmd(service Service) (*cobra.Command, error) {
+	if service == nil {
+		return nil, fmt.Errorf("%w: service must not be nil", commonerrors.ErrInvalidArg)
 	}
 
 	opts := scaffold.Options{}
@@ -42,7 +42,7 @@ func NewCmd(scaffoldService ScaffoldService) (*cobra.Command, error) {
 		Example: example,
 		Args:    cobra.NoArgs,
 		RunE: func(_ *cobra.Command, _ []string) error {
-			return scaffoldService.CreateScaffold(opts)
+			return service.Run(opts)
 		},
 	}
 

cmd/modulectl/scaffold/cmd_test.go

@@ -17,7 +17,7 @@ func Test_NewCmd_ReturnsError_WhenScaffoldServiceIsNil(t *testing.T) {
 	_, err := scaffoldcmd.NewCmd(nil)
 
 	require.Error(t, err)
-	assert.Contains(t, err.Error(), "scaffoldService")
+	assert.Contains(t, err.Error(), "service must not be nil")
 }
 
 func Test_NewCmd_Succceeds(t *testing.T) {
@@ -143,7 +143,7 @@ type scaffoldServiceStub struct {
 	opts   scaffold.Options
 }
 
-func (s *scaffoldServiceStub) CreateScaffold(opts scaffold.Options) error {
+func (s *scaffoldServiceStub) Run(opts scaffold.Options) error {
 	s.called = true
 	s.opts = opts
 	return nil
@@ -153,6 +153,6 @@ type scaffoldServiceErrorStub struct{}
 
 var errSomeTestError = errors.New("some test error")
 
-func (s *scaffoldServiceErrorStub) CreateScaffold(_ scaffold.Options) error {
+func (s *scaffoldServiceErrorStub) Run(_ scaffold.Options) error {
 	return errSomeTestError
 }