feat: Add E2E Test Suite for module create (#47)

* add workflow and tests * fmt * test * test * test * revert renaming fail * renaming * add unit tests for scaffold options Validate function * fix yaml unmarshal of module template * add new ginkgo format create e2e tests * lint * fix linter but keep todo to fail * fix unit tests * use build tags for e2e tests * test new e2e structure against kyma bin * stash * migrate all e2e tests * clean-up * clean-up * adapt some review issues * Add registryUrl != "" check * adapt testcases to new modulectl api * clean-up * Revert "Add registryUrl != "" check" This reverts commit f26ab1e. * Fix E2E tests * Add test case for missing security (still not passing) * add more testdata * use new testdata * clean-up * add testcases for different valid module-configs * bump mandatory version * move consts * fix tests * fix tests * fix tests * fix merge diff * new line * fix e2e expected err * adapt coverage * retrigger jobs --------- Co-authored-by: Badr, Nesma <[email protected]>
kyma-project · Sep 26, 2024 · 65ebdbe · 65ebdbe
1 parent d468133
commit 65ebdbe
Show file tree

Hide file tree

Showing 34 changed files with 1,043 additions and 411 deletions.
diff --git a/.github/workflows/build.yaml b/.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
diff --git a/.github/workflows/test-e2e-create.yml b/.github/workflows/test-e2e-create.yml
@@ -0,0 +1,40 @@
+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: 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: Run tests
+        run: |
+          make -C tests/e2e test-create-cmd
+        timeout-minutes: 3
diff --git a/...ub/workflows/e2e-test-create-scaffold.yml → .github/workflows/test-e2e-scaffold.yml b/...ub/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
diff --git a/...b/workflows/verify-unit-test-coverage.yml → .github/workflows/test-unit-coverage.yml b/...b/workflows/verify-unit-test-coverage.yml → .github/workflows/test-unit-coverage.yml
diff --git a/.github/workflows/unit-test.yaml → .github/workflows/test-unit.yaml b/.github/workflows/unit-test.yaml → .github/workflows/test-unit.yaml
diff --git a/.gitignore b/.gitignore
@@ -99,3 +99,6 @@ bin
 
 # rendered manifest
 **/manifest.yaml
+
+# copied template-operator repo
+tests/e2e/create/testdata/template-operator
diff --git a/.golangci.yaml b/.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
@@ -60,6 +60,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
       - pkg: github.com/kyma-project/modulectl/internal/service/moduleconfig/generator
         alias: moduleconfiggenerator
       - pkg: github.com/kyma-project/modulectl/internal/service/moduleconfig/reader
@@ -87,7 +93,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"

diff --git a/cmd/modulectl/create/cmd.go b/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)
 		},
 	}
 

diff --git a/cmd/modulectl/create/cmd_test.go b/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) {
@@ -130,7 +130,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
@@ -140,6 +140,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
 }
diff --git a/cmd/modulectl/scaffold/cmd.go b/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)
 		},
 	}
 

diff --git a/cmd/modulectl/scaffold/cmd_test.go b/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
 }
diff --git a/go.mod b/go.mod
@@ -9,6 +9,7 @@ require (
 	github.com/mandelsoft/vfs v0.4.3
 	github.com/onsi/ginkgo/v2 v2.20.2
 	github.com/onsi/gomega v1.34.2
+	github.com/open-component-model/ocm v0.13.0
 	github.com/spf13/cobra v1.8.1
 	github.com/spf13/pflag v1.0.5
 	github.com/stretchr/testify v1.9.0
@@ -120,6 +121,7 @@ require (
 	github.com/elliotchance/orderedmap v1.6.0 // indirect
 	github.com/emicklei/go-restful/v3 v3.11.1 // indirect
 	github.com/emirpasic/gods v1.18.1 // indirect
+	github.com/evanphx/json-patch/v5 v5.9.0 // indirect
 	github.com/fatih/color v1.17.0 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/fsnotify/fsnotify v1.7.0 // indirect
@@ -311,6 +313,7 @@ require (
 	golang.org/x/time v0.6.0 // indirect
 	golang.org/x/tools v0.24.0 // indirect
 	golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028 // indirect
+	gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
 	google.golang.org/api v0.190.0 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20240725223205-93522f1f2a9f // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20240730163845-b1a4ccb954bf // indirect
@@ -330,6 +333,7 @@ require (
 	k8s.io/kube-openapi v0.0.0-20240228011516-70dd3763d340 // indirect
 	k8s.io/utils v0.0.0-20240711033017-18e509b52bc8 // indirect
 	oras.land/oras-go v1.2.5 // indirect
+	sigs.k8s.io/controller-runtime v0.19.0 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/kustomize/api v0.17.3 // indirect
 	sigs.k8s.io/kustomize/kyaml v0.17.2 // indirect

diff --git a/go.sum b/go.sum
@@ -368,6 +368,7 @@ github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1m
 github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
 github.com/erikstmartin/go-testdb v0.0.0-20160219214506-8d10e4a1bae5/go.mod h1:a2zkGnVExMxdzMo3M0Hi/3sEU+cWnZpSni0O6/Yb/P0=
 github.com/evanphx/json-patch v5.7.0+incompatible h1:vgGkfT/9f8zE6tvSCe74nfpAVDQ2tG6yudJd8LBksgI=
+github.com/evanphx/json-patch v5.7.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk=
 github.com/evanphx/json-patch/v5 v5.9.0 h1:kcBlZQbplgElYIlo/n1hJbls2z/1awpXxpRi0/FOJfg=
 github.com/evanphx/json-patch/v5 v5.9.0/go.mod h1:VNkHZ/282BpEyt/tObQO8s5CMPmYYq14uClGH4abBuQ=
 github.com/exponent-io/jsonpath v0.0.0-20210407135951-1de76d718b3f h1:Wl78ApPPB2Wvf/TIe2xdyJxTlb6obmF18d8QdkxNDu4=
@@ -427,6 +428,8 @@ github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY=
 github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
 github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
 github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
+github.com/go-logr/zapr v1.3.0 h1:XGdV8XW8zdwFiwOA2Dryh1gj2KRQyOOoNmBy4EplIcQ=
+github.com/go-logr/zapr v1.3.0/go.mod h1:YKepepNBd1u/oyhd/yQmtjVXmm9uML4IXUgMOwR8/Gg=
 github.com/go-openapi/analysis v0.23.0 h1:aGday7OWupfMs+LbmLZG4k0MYXIANxcuBTYUC03zFCU=
 github.com/go-openapi/analysis v0.23.0/go.mod h1:9mz9ZWaSlV8TvjQHLl2mUW2PbZtemkE8yA5v22ohupo=
 github.com/go-openapi/errors v0.22.0 h1:c4xY/OLxUBSTiepAg3j/MHuAv5mJhnf53LLMWFB+u/w=
@@ -783,6 +786,8 @@ github.com/onsi/gomega v1.17.0/go.mod h1:HnhC7FXeEQY45zxNK3PPoIUhzk/80Xly9PcubAl
 github.com/onsi/gomega v1.19.0/go.mod h1:LY+I3pBVzYsTBU1AnDwOSxaYi9WoWiqgwooUqq9yPro=
 github.com/onsi/gomega v1.34.2 h1:pNCwDkzrsv7MS9kpaQvVb1aVLahQXyJ/Tv5oAZMI3i8=
 github.com/onsi/gomega v1.34.2/go.mod h1:v1xfxRgk0KIsG+QOdm7p8UosrOzPYRo60fd3B/1Dukc=
+github.com/open-component-model/ocm v0.13.0 h1:rm31Z7SpFzpxCIUagaFEUI4cSIS098Hf2H0dToV2nOA=
+github.com/open-component-model/ocm v0.13.0/go.mod h1:+ovmIxTexDM2fcnfVg9uqJh22A7KOxwa/stNJn315yU=
 github.com/open-policy-agent/opa v0.67.0 h1:FOdsO9yNhfmrh+72oVK7ImWmzruG+VSpfbr5IBqEWVs=
 github.com/open-policy-agent/opa v0.67.0/go.mod h1:aqKlHc8E2VAAylYE9x09zJYr/fYzGX+JKne89UGqFzk=
 github.com/opencontainers/go-digest v0.0.0-20170106003457-a6d0ee40d420/go.mod h1:cMLVZDEM3+U2I4VmLI6N8jQYUd2OVphdqWwCJHrFt2s=
@@ -1230,6 +1235,8 @@ golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8T
 golang.org/x/xerrors v0.0.0-20220517211312-f3a8303e98df/go.mod h1:K8+ghG5WaK9qNqU5K3HdILfMLy1f3aNYFI/wnl100a8=
 golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028 h1:+cNy6SZtPcJQH3LJVLOSmiC7MMxXNOb3PU/VUEz+EhU=
 golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028/go.mod h1:NDW/Ps6MPRej6fsCIbMTohpP40sJ/P/vI1MoTEGwX90=
+gomodules.xyz/jsonpatch/v2 v2.4.0 h1:Ci3iUJyx9UeRx7CeFN8ARgGbkESwJK+KB9lLcWxY/Zw=
+gomodules.xyz/jsonpatch/v2 v2.4.0/go.mod h1:AH3dM2RI6uoBZxn3LVrfvJ3E0/9dG4cSrbuBJT4moAY=
 google.golang.org/api v0.190.0 h1:ASM+IhLY1zljNdLu19W1jTmU6A+gMk6M46Wlur61s+Q=
 google.golang.org/api v0.190.0/go.mod h1:QIr6I9iedBLnfqoD6L6Vze1UvS5Hzj5r2aUBOaZnLHo=
 google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=

diff --git a/internal/service/create/create.go b/internal/service/create/create.go
@@ -111,7 +111,7 @@ func NewService(moduleConfigService ModuleConfigService,
 	}, nil
 }
 
-func (s *Service) CreateModule(opts Options) error {
+func (s *Service) Run(opts Options) error {
 	if err := opts.Validate(); err != nil {
 		return err
 	}

diff --git a/internal/service/create/create_test.go b/internal/service/create/create_test.go
@@ -33,7 +33,7 @@ func Test_CreateModule_ReturnsError_WhenModuleConfigFileIsEmpty(t *testing.T) {
 
 	opts := newCreateOptionsBuilder().withModuleConfigFile("").build()
 
-	err = svc.CreateModule(opts)
+	err = svc.Run(opts)
 
 	require.ErrorIs(t, err, commonerrors.ErrInvalidOption)
 	require.Contains(t, err.Error(), "opts.ModuleConfigFile")
@@ -46,7 +46,7 @@ func Test_CreateModule_ReturnsError_WhenOutIsNil(t *testing.T) {
 
 	opts := newCreateOptionsBuilder().withOut(nil).build()
 
-	err = svc.CreateModule(opts)
+	err = svc.Run(opts)
 
 	require.ErrorIs(t, err, commonerrors.ErrInvalidOption)
 	require.Contains(t, err.Error(), "opts.Out")
@@ -59,7 +59,7 @@ func Test_CreateModule_ReturnsError_WhenCredentialsIsInInvalidFormat(t *testing.
 
 	opts := newCreateOptionsBuilder().withCredentials("user").build()
 
-	err = svc.CreateModule(opts)
+	err = svc.Run(opts)
 
 	require.ErrorIs(t, err, commonerrors.ErrInvalidOption)
 	require.Contains(t, err.Error(), "opts.Credentials")
@@ -72,7 +72,7 @@ func Test_CreateModule_ReturnsError_WhenTemplateOutputIsEmpty(t *testing.T) {
 
 	opts := newCreateOptionsBuilder().withTemplateOutput("").build()
 
-	err = svc.CreateModule(opts)
+	err = svc.Run(opts)
 
 	require.ErrorIs(t, err, commonerrors.ErrInvalidOption)
 	require.Contains(t, err.Error(), "opts.TemplateOutput")
@@ -86,7 +86,7 @@ func Test_CreateModule_ReturnsError_WhenParseAndValidateModuleConfigReturnsError
 
 	opts := newCreateOptionsBuilder().build()
 
-	err = svc.CreateModule(opts)
+	err = svc.Run(opts)
 
 	require.Error(t, err)
 	require.Contains(t, err.Error(), "failed to read module config file")

diff --git a/internal/service/scaffold/options.go b/internal/service/scaffold/options.go
@@ -23,7 +23,7 @@ type Options struct {
 	ModuleChannel             string
 }
 
-func (opts Options) validate() error {
+func (opts Options) Validate() error {
 	if opts.Out == nil {
 		return fmt.Errorf("%w: opts.Out must not be nil", commonerrors.ErrInvalidOption)
 	}