update

Author: reshnm

internal/deployment-repo/deploymentRepoManager.go

@@ -18,35 +18,55 @@ const (
 	openMCPOperatorComponentName = "openmcp-operator"
 )
 
-type GitLogWriter struct{}
-
-func (w GitLogWriter) Write(p []byte) (n int, err error) {
-	logger := log.GetLogger()
-	logger.Debugf("Git progress: %s", string(p))
-	return len(p), nil
-}
-
+// DeploymentRepoManager manages the deployment repository by applying templates and committing changes.
 type DeploymentRepoManager struct {
-	ComponentLocation          string
-	TemplateResourceLocation   string
-	DeploymentRepository       string
+	// Vars set via constructor or "With" methods
+
+	// ComponentLocation is the location of the OCM component to use for deployment
+	ComponentLocation string
+	// TemplateResourceLocation is the location of the templates resource within the component or its references
+	TemplateResourceLocation string
+	// DeploymentRepository is the URL of the Git repository to manage
+	DeploymentRepository string
+	// DeploymentRepositoryBranch is the branch of the Git repository to manage
 	DeploymentRepositoryBranch string
-	GitConfigPath              string
-	OcmConfigPath              string
-	ClusterProviders           []string
-	ServiceProviders           []string
-	PlatformServices           []string
-	ImagePullSecrets           []string
-
-	tempDir      string
+	// GitConfigPath is the path to the Git configuration file
+	GitConfigPath string
+	// OcmConfigPath is the path to the OCM configuration file
+	// +optional
+	OcmConfigPath string
+	// ClusterProviders is a list of cluster providers to include in the deployment
+	// +optional
+	ClusterProviders []string
+	// ServiceProviders is a list of service providers to include in the deployment
+	// +optional
+	ServiceProviders []string
+	// PlatformServices is a list of platform services to include in the deployment
+	// +optional
+	PlatformServices []string
+	// ImagePullSecrets is a list of image pull secrets to include in the deployment
+	// +optional
+	ImagePullSecrets []string
+
+	// Internals
+	// tempDir is a temporary directory used for processing
+	tempDir string
+	// templatesDir is the directory into which the templates resource are downloaded
+	// (a subdirectory of tempDir)
 	templatesDir string
-	gitRepoDir   string
+	// gitRepoDir is the directory into which the deployment repository is cloned
+	// (a subdirectory of tempDir)
+	gitRepoDir string
 
+	// compGetter is the OCM component getter used to fetch components and resources
 	compGetter *ocmcli.ComponentGetter
-	gitConfig  *gitconfig.Config
-	gitRepo    *git.Repository
+	// gitConfig is the parsed Git configuration
+	gitConfig *gitconfig.Config
+	// gitRepo is the cloned Git repository
+	gitRepo *git.Repository
 }
 
+// NewDeploymentRepoManager creates a new DeploymentRepoManager with the specified parameters.
 func NewDeploymentRepoManager(componentLocation, templateResourceLocation, deploymentRepository, deploymentRepositoryBranch, gitConfigPath string) *DeploymentRepoManager {
 	return &DeploymentRepoManager{
 		ComponentLocation:          componentLocation,
@@ -57,31 +77,37 @@ func NewDeploymentRepoManager(componentLocation, templateResourceLocation, deplo
 	}
 }
 
+// WithOcmConfig sets the OCM configuration file path.
 func (m *DeploymentRepoManager) WithOcmConfig(ocmConfigPath string) *DeploymentRepoManager {
 	m.OcmConfigPath = ocmConfigPath
 	return m
 }
 
+// WithClusterProviders sets the list of cluster providers to include in the deployment.
 func (m *DeploymentRepoManager) WithClusterProviders(clusterProviders []string) *DeploymentRepoManager {
 	m.ClusterProviders = clusterProviders
 	return m
 }
 
+// WithServiceProviders sets the list of service providers to include in the deployment.
 func (m *DeploymentRepoManager) WithServiceProviders(serviceProviders []string) *DeploymentRepoManager {
 	m.ServiceProviders = serviceProviders
 	return m
 }
 
+// WithPlatformServices sets the list of platform services to include in the deployment.
 func (m *DeploymentRepoManager) WithPlatformServices(platformServices []string) *DeploymentRepoManager {
 	m.PlatformServices = platformServices
 	return m
 }
 
+// WithImagePullSecrets sets the list of image pull secrets to include in the deployment.
 func (m *DeploymentRepoManager) WithImagePullSecrets(imagePullSecrets []string) *DeploymentRepoManager {
 	m.ImagePullSecrets = imagePullSecrets
 	return m
 }
 
+// Complete initializes the DeploymentRepoManager by setting up temporary directories, downloading components and templates, and cloning the deployment repository.
 func (m *DeploymentRepoManager) Complete(ctx context.Context) (*DeploymentRepoManager, error) {
 	var err error
 
@@ -134,14 +160,6 @@ func (m *DeploymentRepoManager) Complete(ctx context.Context) (*DeploymentRepoMa
 		return m, fmt.Errorf("invalid git config: %w", err)
 	}
 
-	cloneOptions := &git.CloneOptions{
-		URL:      m.DeploymentRepository,
-		Progress: GitLogWriter{},
-	}
-	if err = m.gitConfig.ConfigureCloneOptions(cloneOptions); err != nil {
-		return m, fmt.Errorf("failed to configure git clone options: %w", err)
-	}
-
 	logger.Infof("Cloning deployment repository %s", m.DeploymentRepository)
 
 	m.gitRepo, err = CloneRepo(m.DeploymentRepository, m.gitRepoDir, m.gitConfig)
@@ -159,6 +177,7 @@ func (m *DeploymentRepoManager) Complete(ctx context.Context) (*DeploymentRepoMa
 	return m, nil
 }
 
+// Cleanup removes temporary directories created during processing.
 func (m *DeploymentRepoManager) Cleanup() {
 	if m.tempDir != "" {
 		log.GetLogger().Tracef("Removing temp dir: %s", m.tempDir)
@@ -168,6 +187,7 @@ func (m *DeploymentRepoManager) Cleanup() {
 	}
 }
 
+// ApplyTemplates applies the templates from the templates directory to the deployment repository.
 func (m *DeploymentRepoManager) ApplyTemplates(ctx context.Context) error {
 	logger := log.GetLogger()
 
@@ -199,6 +219,7 @@ func (m *DeploymentRepoManager) ApplyTemplates(ctx context.Context) error {
 	return nil
 }
 
+// ApplyProviders applies the specified providers to the deployment repository.
 func (m *DeploymentRepoManager) ApplyProviders(ctx context.Context) error {
 	logger := log.GetLogger()
 
@@ -213,6 +234,8 @@ func (m *DeploymentRepoManager) ApplyProviders(ctx context.Context) error {
 	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 {
 	logger := log.GetLogger()
 

internal/deployment-repo/repo.go

@@ -15,11 +15,12 @@ import (
 	"github.com/openmcp-project/bootstrapper/internal/log"
 )
 
+// gitProgressWriter is a writer that logs Git progress messages.
 type gitProgressWriter struct{}
 
 func (w gitProgressWriter) Write(p []byte) (n int, err error) {
 	logger := log.GetLogger()
-	logger.Trace(string(p))
+	logger.Debugf("[Git] %s", string(p))
 	return len(p), nil
 }
 

internal/deployment-repo/templater.go

@@ -121,6 +121,7 @@ type ProviderOptions struct {
 	ImagePullSecrets []string
 }
 
+// TemplateProviders templates the specified cluster providers, service providers, and platform services
 func TemplateProviders(ctx context.Context, clusterProviders, serviceProviders, platformServices, imagePullSecrets []string, ocmGetter *ocmcli.ComponentGetter, repo *git.Repository) error {
 	for _, cp := range clusterProviders {
 		componentVersion, err := ocmGetter.GetReferencedComponentVersion(ctx, "cluster-provider-"+cp)
@@ -139,7 +140,7 @@ func TemplateProviders(ctx context.Context, clusterProviders, serviceProviders,
 			ImagePullSecrets: imagePullSecrets,
 		}
 
-		err = TemplateClusterProvider(opts, repo)
+		err = templateProvider(opts, clusterProviderTemplate, "cluster-providers", repo)
 		if err != nil {
 			return fmt.Errorf("failed to apply cluster provider %s: %w", cp, err)
 		}
@@ -162,7 +163,7 @@ func TemplateProviders(ctx context.Context, clusterProviders, serviceProviders,
 			ImagePullSecrets: imagePullSecrets,
 		}
 
-		err = TemplateServiceProvider(opts, repo)
+		err = templateProvider(opts, serviceProviderTemplate, "service-providers", repo)
 		if err != nil {
 			return fmt.Errorf("failed to apply service provider %s: %w", sp, err)
 		}
@@ -185,7 +186,7 @@ func TemplateProviders(ctx context.Context, clusterProviders, serviceProviders,
 			ImagePullSecrets: imagePullSecrets,
 		}
 
-		err = TemplatePlatformService(opts, repo)
+		err = templateProvider(opts, platformServiceTemplate, "platform-services", repo)
 		if err != nil {
 			return fmt.Errorf("failed to apply platform service %s: %w", ps, err)
 		}
@@ -204,18 +205,6 @@ func getImageResource(cv *ocmcli.ComponentVersion) (*ocmcli.Resource, error) {
 	return nil, fmt.Errorf("image resource not found for component %s", cv.Component.Name)
 }
 
-func TemplateClusterProvider(options *ProviderOptions, repo *git.Repository) error {
-	return templateProvider(options, clusterProviderTemplate, "cluster-providers", repo)
-}
-
-func TemplateServiceProvider(options *ProviderOptions, repo *git.Repository) error {
-	return templateProvider(options, serviceProviderTemplate, "service-providers", repo)
-}
-
-func TemplatePlatformService(options *ProviderOptions, repo *git.Repository) error {
-	return templateProvider(options, platformServiceTemplate, "platform-services", repo)
-}
-
 func templateProvider(options *ProviderOptions, templateSource, dir string, repo *git.Repository) error {
 	logger := log.GetLogger()
 	providerPath := filepath.Join(dir, options.Name+".yaml")