add deployment repo manager tests

Author: reshnm

internal/deployment-repo/deploymentRepoManager.go

@@ -64,6 +64,8 @@ type DeploymentRepoManager struct {
 	gitConfig *gitconfig.Config
 	// gitRepo is the cloned Git repository
 	gitRepo *git.Repository
+
+	openMCPOperatorCV *ocmcli.ComponentVersion
 }
 
 // NewDeploymentRepoManager creates a new DeploymentRepoManager with the specified parameters.
@@ -152,6 +154,15 @@ func (m *DeploymentRepoManager) Complete(ctx context.Context) (*DeploymentRepoMa
 		return m, fmt.Errorf("failed to download templates resource: %w", err)
 	}
 
+	logger.Infof("Fetching openmcp-operator component version")
+
+	m.openMCPOperatorCV, err = m.compGetter.GetReferencedComponentVersion(ctx, m.compGetter.RootComponentVersion(), openMCPOperatorComponentName)
+	if err != nil {
+		logger.Infof("No openmcp-operator component version found: %v", err)
+	} else {
+		logger.Infof("Found openmcp-operator component version: %s:%s", m.openMCPOperatorCV.Component.Name, m.openMCPOperatorCV.Component.Version)
+	}
+
 	m.gitConfig, err = gitconfig.ParseConfig(m.GitConfigPath)
 	if err != nil {
 		return m, fmt.Errorf("failed to parse git config: %w", err)
@@ -192,26 +203,22 @@ func (m *DeploymentRepoManager) ApplyTemplates(ctx context.Context) error {
 	logger := log.GetLogger()
 
 	logger.Infof("Applying templates from %s to deployment repository", m.TemplateResourceLocation)
-
 	templateInput := make(map[string]interface{})
-	openMCPOperatorCV, err := m.compGetter.GetReferencedComponentVersion(ctx, m.compGetter.RootComponentVersion(), openMCPOperatorComponentName)
 
-	if err == nil {
-		logger.Infof("Found openmcp-operator component version: %s:%s", openMCPOperatorCV.Component.Name, openMCPOperatorCV.Component.Version)
-
-		imageResources := openMCPOperatorCV.GetResourcesByType(ocmcli.OCIImageResourceType)
+	if m.openMCPOperatorCV != nil {
+		imageResources := m.openMCPOperatorCV.GetResourcesByType(ocmcli.OCIImageResourceType)
 		if len(imageResources) == 0 || imageResources[0].Access.ImageReference == nil {
-			return fmt.Errorf("no image resource found for openmcp-operator component version %s:%s", openMCPOperatorCV.Component.Name, openMCPOperatorCV.Component.Version)
+			return fmt.Errorf("no image resource found for openmcp-operator component version %s:%s", m.openMCPOperatorCV.Component.Name, m.openMCPOperatorCV.Component.Version)
 		}
 
 		templateInput["openmcpOperator"] = map[string]interface{}{
-			"version":          openMCPOperatorCV.Component.Version,
+			"version":          m.openMCPOperatorCV.Component.Version,
 			"image":            *imageResources[0].Access.ImageReference,
 			"imagePullSecrets": m.ImagePullSecrets,
 		}
 	}
 
-	err = TemplateDir(m.templatesDir, templateInput, m.gitRepo)
+	err := TemplateDir(m.templatesDir, templateInput, m.gitRepo)
 	if err != nil {
 		return fmt.Errorf("failed to apply templates from directory %s: %w", m.templatesDir, err)
 	}
@@ -234,6 +241,43 @@ func (m *DeploymentRepoManager) ApplyProviders(ctx context.Context) error {
 	return nil
 }
 
+// ApplyCustomResourceDefinitions downloads and applies Custom Resource Definitions (CRDs) from the openmcp-operator component to the deployment repository.
+// If the openmcp-operator component is not found, it skips this step.
+func (m *DeploymentRepoManager) ApplyCustomResourceDefinitions(ctx context.Context) error {
+	logger := log.GetLogger()
+
+	if m.openMCPOperatorCV == nil {
+		logger.Infof("No openmcp-operator component version found, skipping CRD application")
+		return nil
+	}
+
+	logger.Infof("Applying Custom Resource Definitions to deployment repository")
+
+	crdsDownloadDir := filepath.Join(m.gitRepoDir, "crds")
+
+	err := os.Mkdir(crdsDownloadDir, 0o755)
+	if err != nil {
+		return fmt.Errorf("failed to create CRD download directory: %w", err)
+	}
+
+	err = m.compGetter.DownloadDirectoryResource(ctx, m.openMCPOperatorCV, "openmcp-operator-crds", crdsDownloadDir)
+	if err != nil {
+		return fmt.Errorf("failed to download CRD resource: %w", err)
+	}
+
+	workTree, err := m.gitRepo.Worktree()
+	if err != nil {
+		return fmt.Errorf("failed to get worktree: %w", err)
+	}
+
+	_, err = workTree.Add("crds")
+	if err != nil {
+		return fmt.Errorf("failed to add CRD files: %w", err)
+	}
+
+	return nil
+}
+
 // CommitAndPushChanges commits all changes in the deployment repository and pushes them to the remote repository.
 // If there are no changes to commit, it does nothing.
 func (m *DeploymentRepoManager) CommitAndPushChanges(_ context.Context) error {
@@ -253,3 +297,7 @@ func (m *DeploymentRepoManager) CommitAndPushChanges(_ context.Context) error {
 
 	return nil
 }
+
+func (m *DeploymentRepoManager) GitRepoDir() string {
+	return m.gitRepoDir
+}

internal/deployment-repo/deploymentRepoManager_test.go

@@ -0,0 +1,114 @@
+package deploymentrepo_test
+
+import (
+	"path/filepath"
+	"testing"
+
+	"github.com/go-git/go-git/v5"
+	"github.com/go-git/go-git/v5/plumbing"
+	"github.com/stretchr/testify/assert"
+	"sigs.k8s.io/yaml"
+
+	deploymentrepo "github.com/openmcp-project/bootstrapper/internal/deployment-repo"
+	testutils "github.com/openmcp-project/bootstrapper/test/utils"
+)
+
+func TestDeploymentRepoManager(t *testing.T) {
+	testutils.DownloadOCMAndAddToPath(t)
+
+	ctfIn := testutils.BuildComponent("./testdata/01/component-constructor.yaml", t)
+
+	originDir := t.TempDir()
+
+	origin, err := git.PlainInit(originDir, false)
+	assert.NoError(t, err)
+
+	originWorkTree, err := origin.Worktree()
+	assert.NoError(t, err)
+	assert.NotNil(t, originWorkTree)
+
+	dummyFilePath := filepath.Join(originDir, "dummy.txt")
+	testutils.WriteToFile(t, dummyFilePath, "This is a dummy file.")
+	testutils.AddFileToWorkTree(t, originWorkTree, "dummy.txt")
+	testutils.WorkTreeCommit(t, originWorkTree, "Initial commit")
+
+	clusterProviders := []string{"test"}
+	serviceProviders := []string{"test"}
+	platformServices := []string{"test"}
+	imagePullSecrets := []string{"imgpull-a", "imgpull-b"}
+
+	deploymentRepoManager, err := deploymentrepo.NewDeploymentRepoManager(
+		ctfIn+"//github.com/openmcp-project/openmcp",
+		"deployment-templates/templates",
+		originDir,
+		"incoming",
+		"./testdata/01/git-config.yaml").
+		WithClusterProviders(clusterProviders).
+		WithServiceProviders(serviceProviders).
+		WithPlatformServices(platformServices).
+		WithImagePullSecrets(imagePullSecrets).
+		Complete(t.Context())
+	assert.NoError(t, err)
+	assert.NotNil(t, deploymentRepoManager)
+
+	repo := deploymentRepoManager.GitRepoDir()
+
+	err = deploymentRepoManager.ApplyTemplates(t.Context())
+	assert.NoError(t, err)
+
+	openMCPOperatorRaw := testutils.ReadFromFile(t, filepath.Join(repo, "openmcp-operator.yaml"))
+	var openMCPOperator map[string]interface{}
+	err = yaml.Unmarshal([]byte(openMCPOperatorRaw), &openMCPOperator)
+	assert.NoError(t, err)
+	assert.Contains(t, openMCPOperator, "openmcp-operator")
+	root := openMCPOperator["openmcp-operator"].(map[string]interface{})
+	assert.Contains(t, root, "version")
+	assert.Equal(t, "v0.2.1", root["version"])
+	assert.Contains(t, root, "image")
+	assert.Equal(t, "ghcr.io/openmcp-project/images/openmcp-operator:v0.2.1", root["image"])
+	assert.Contains(t, root, "imagePullSecrets")
+	imagePullSecretsList := root["imagePullSecrets"].([]interface{})
+	assert.Len(t, imagePullSecrets, 2)
+	assert.Contains(t, imagePullSecretsList, map[string]interface{}{"name": "imgpull-a"})
+	assert.Contains(t, imagePullSecretsList, map[string]interface{}{"name": "imgpull-b"})
+
+	err = deploymentRepoManager.ApplyProviders(t.Context())
+	assert.NoError(t, err)
+
+	clusterProviderTestRaw := testutils.ReadFromFile(t, filepath.Join(repo, "cluster-providers", "test.yaml"))
+	var clusterProviderTest map[string]interface{}
+	err = yaml.Unmarshal([]byte(clusterProviderTestRaw), &clusterProviderTest)
+	assert.NoError(t, err)
+	ValidateProvider(t, clusterProviderTest, "test", "ghcr.io/openmcp-project/images/cluster-provider-test:v0.1.0", []string{"imgpull-a", "imgpull-b"})
+
+	serviceProviderTestRaw := testutils.ReadFromFile(t, filepath.Join(repo, "service-providers", "test.yaml"))
+	var serviceProviderTest map[string]interface{}
+	err = yaml.Unmarshal([]byte(serviceProviderTestRaw), &serviceProviderTest)
+	assert.NoError(t, err)
+	ValidateProvider(t, serviceProviderTest, "test", "ghcr.io/openmcp-project/images/service-provider-test:v0.2.0", []string{"imgpull-a", "imgpull-b"})
+
+	platformServiceTestRaw := testutils.ReadFromFile(t, filepath.Join(repo, "platform-services", "test.yaml"))
+	var platformServiceTest map[string]interface{}
+	err = yaml.Unmarshal([]byte(platformServiceTestRaw), &platformServiceTest)
+	assert.NoError(t, err)
+	ValidateProvider(t, platformServiceTest, "test", "ghcr.io/openmcp-project/images/platform-service-test:v0.3.0", []string{"imgpull-a", "imgpull-b"})
+
+	err = deploymentRepoManager.ApplyCustomResourceDefinitions(t.Context())
+	assert.NoError(t, err)
+
+	crdRaw := testutils.ReadFromFile(t, filepath.Join(repo, "crds", "crd.yaml"))
+	assert.NotEmpty(t, crdRaw)
+
+	err = deploymentRepoManager.CommitAndPushChanges(t.Context())
+	assert.NoError(t, err)
+
+	err = originWorkTree.Checkout(&git.CheckoutOptions{Branch: plumbing.NewBranchReferenceName("incoming")})
+	assert.NoError(t, err)
+
+	_ = testutils.ReadFromFile(t, filepath.Join(originDir, "dummy.txt"))
+	_ = testutils.ReadFromFile(t, filepath.Join(originDir, "openmcp-operator.yaml"))
+	_ = testutils.ReadFromFile(t, filepath.Join(originDir, "cluster-providers", "test.yaml"))
+	_ = testutils.ReadFromFile(t, filepath.Join(originDir, "service-providers", "test.yaml"))
+	_ = testutils.ReadFromFile(t, filepath.Join(originDir, "platform-services", "test.yaml"))
+	_ = testutils.ReadFromFile(t, filepath.Join(originDir, "crds", "crd.yaml"))
+}

internal/deployment-repo/templater_test.go

@@ -70,22 +70,22 @@ func TestTemplateProviders(t *testing.T) {
 	var clusterProviderTest map[string]interface{}
 	err = yaml.Unmarshal([]byte(clusterProviderTestRaw), &clusterProviderTest)
 	assert.NoError(t, err)
-	validateProvider(t, clusterProviderTest, "test", "ghcr.io/openmcp-project/images/cluster-provider-test:v0.1.0", []string{"imgpull-a", "imgpull-b"})
+	ValidateProvider(t, clusterProviderTest, "test", "ghcr.io/openmcp-project/images/cluster-provider-test:v0.1.0", []string{"imgpull-a", "imgpull-b"})
 
 	serviceProviderTestRaw := testutils.ReadFromFile(t, filepath.Join(repoDir, "service-providers", "test.yaml"))
 	var serviceProviderTest map[string]interface{}
 	err = yaml.Unmarshal([]byte(serviceProviderTestRaw), &serviceProviderTest)
 	assert.NoError(t, err)
-	validateProvider(t, serviceProviderTest, "test", "ghcr.io/openmcp-project/images/service-provider-test:v0.2.0", []string{"imgpull-a", "imgpull-b"})
+	ValidateProvider(t, serviceProviderTest, "test", "ghcr.io/openmcp-project/images/service-provider-test:v0.2.0", []string{"imgpull-a", "imgpull-b"})
 
 	platformServiceTestRaw := testutils.ReadFromFile(t, filepath.Join(repoDir, "platform-services", "test.yaml"))
 	var platformServiceTest map[string]interface{}
 	err = yaml.Unmarshal([]byte(platformServiceTestRaw), &platformServiceTest)
 	assert.NoError(t, err)
-	validateProvider(t, platformServiceTest, "test", "ghcr.io/openmcp-project/images/platform-service-test:v0.3.0", []string{"imgpull-a", "imgpull-b"})
+	ValidateProvider(t, platformServiceTest, "test", "ghcr.io/openmcp-project/images/platform-service-test:v0.3.0", []string{"imgpull-a", "imgpull-b"})
 }
 
-func validateProvider(t *testing.T, provider map[string]interface{}, name, image string, imagePullSecrets []string) {
+func ValidateProvider(t *testing.T, provider map[string]interface{}, name, image string, imagePullSecrets []string) {
 	assert.Contains(t, provider, "metadata")
 	assert.Contains(t, provider["metadata"], "name")
 	assert.Equal(t, name, provider["metadata"].(map[string]interface{})["name"])

internal/deployment-repo/testdata/01/component-constructor.yaml

@@ -5,6 +5,10 @@ components:
       name: openmcp-project
 
     componentReferences:
+      - componentName: github.com/openmcp-project/openmcp-operator
+        name: openmcp-operator
+        version: v0.2.1
+
       - componentName: github.com/openmcp-project/cluster-provider-test
         name: cluster-provider-test
         version: v0.1.0
@@ -21,6 +25,26 @@ components:
         name: deployment-templates
         version: v0.1.1
 
+  - name: github.com/openmcp-project/openmcp-operator
+    version: v0.2.1
+    provider:
+      name: openmcp-project
+
+    resources:
+      - name: openmcp-operator-image
+        type: ociImage
+        version: v0.2.0
+        access:
+          type: ociArtifact
+          imageReference: ghcr.io/openmcp-project/images/openmcp-operator:v0.2.1
+
+      - name: openmcp-operator-crds
+        type: fileSystem
+        version: v0.1.1
+        input:
+          type: dir
+          path: ./crds
+
   - name: github.com/openmcp-project/cluster-provider-test
     version: v0.1.0
     provider:

internal/deployment-repo/testdata/01/crds/crd.yaml

@@ -0,0 +1,5 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: test
+spec: {}

internal/deployment-repo/testdata/01/git-config.yaml

@@ -0,0 +1,4 @@
+auth:
+  basic:
+    username: user
+    password: pass

internal/deployment-repo/testdata/01/templates/openmcp-operator.yaml

@@ -0,0 +1,11 @@
+{{- if dig "openmcpOperator" "" .values }}
+openmcp-operator:
+  version: {{ .values.openmcpOperator.version }}
+  image: {{ .values.openmcpOperator.image }}
+{{- if dig "openmcpOperator" "imagePullSecrets" "" .values }}
+  imagePullSecrets:
+{{- range $index, $value := .values.openmcpOperator.imagePullSecrets }}
+    - name: "{{ $value }}"
+{{- end }}
+{{- end }}
+{{- end }}

internal/deployment-repo/testdata/01/templates/root.txt

@@ -96,6 +96,11 @@ func (g *ComponentGetter) DownloadTemplatesResource(ctx context.Context, downloa
 	return downloadDirectoryResource(ctx, g.templatesComponentLocation, g.templatesResourceName, downloadDir, g.ocmConfig)
 }
 
+func (g *ComponentGetter) DownloadDirectoryResource(ctx context.Context, cv *ComponentVersion, resourceName string, downloadDir string) error {
+	componentLocation := buildLocation(g.repo, cv.Component.Name, cv.Component.Version)
+	return downloadDirectoryResource(ctx, componentLocation, resourceName, downloadDir, g.ocmConfig)
+}
+
 func downloadDirectoryResource(ctx context.Context, componentLocation string, resourceName string, downloadDir string, ocmConfig string) error {
 	return Execute(ctx,
 		[]string{"download", "resources", componentLocation, resourceName},