feat: unit tests

Author: robertgraeff

internal/flux_deployer/git_credentials.go

@@ -14,18 +14,19 @@ import (
 )
 
 const (
-	username   = "username"
-	password   = "password"
-	token      = "token"
-	identity   = "identity"
-	knownHosts = "known_hosts"
+	Username   = "username"
+	Password   = "password"
+	Token      = "token"
+	Identity   = "identity"
+	KnownHosts = "known_hosts"
 )
 
 // CreateGitCredentialsSecret creates or updates a Secret with name "git" in the fluxcd namespace.
-// The secret contains git credentials for flux sync, read from the file d.gitCredentials.
+// The secret contains git credentials for the flux sync, read from the file gitCredentialsPath.
 // The file should contain a YAML of a map[string]string, whose keys are described
 // in https://fluxcd.io/flux/components/source/gitrepositories/#secret-reference, e.g. username and password.
-func CreateGitCredentialsSecret(ctx context.Context, log *logrus.Logger, gitCredentialsPath string, secretName, secretNamespace string, platformClient client.Client) error {
+func CreateGitCredentialsSecret(ctx context.Context, log *logrus.Logger, gitCredentialsPath, secretName, secretNamespace string, platformClient client.Client) error {
+
 	log.Infof("Creating/updating git credentials secret %s/%s", secretNamespace, secretName)
 
 	gitCredentialsData := map[string][]byte{}
@@ -44,12 +45,12 @@ func CreateGitCredentialsSecret(ctx context.Context, log *logrus.Logger, gitCred
 
 		if config.Authentication.BasicAuth != nil {
 			log.Debug("Using basic auth credentials for git operations")
-			gitCredentialsData[username] = []byte(config.Authentication.BasicAuth.Username)
-			gitCredentialsData[password] = []byte(config.Authentication.BasicAuth.Password)
+			gitCredentialsData[Username] = []byte(config.Authentication.BasicAuth.Username)
+			gitCredentialsData[Password] = []byte(config.Authentication.BasicAuth.Password)
 		}
 		if config.Authentication.BearerToken != nil {
 			log.Debug("Using bearer token for git operations")
-			gitCredentialsData[token] = []byte(config.Authentication.BearerToken.Token)
+			gitCredentialsData[Token] = []byte(config.Authentication.BearerToken.Token)
 		}
 		if config.Authentication.SSHPrivateKey != nil {
 			log.Debug("Using ssh private key for git operations")
@@ -58,7 +59,7 @@ func CreateGitCredentialsSecret(ctx context.Context, log *logrus.Logger, gitCred
 				return err
 			}
 
-			gitCredentialsData[identity] = privateKey
+			gitCredentialsData[Identity] = privateKey
 
 			if config.Authentication.SSHPrivateKey.KnownHosts != "" {
 				knownHostsPath := config.Authentication.SSHPrivateKey.KnownHosts
@@ -69,7 +70,7 @@ func CreateGitCredentialsSecret(ctx context.Context, log *logrus.Logger, gitCred
 				if err != nil {
 					return fmt.Errorf("error reading known hosts file %s: %w", knownHostsPath, err)
 				}
-				gitCredentialsData[knownHosts] = knownHostsContent
+				gitCredentialsData[KnownHosts] = knownHostsContent
 			}
 		}
 	}

internal/flux_deployer/git_credentials_test.go

@@ -0,0 +1,54 @@
+package flux_deployer_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	corev1 "k8s.io/api/core/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/client/fake"
+
+	"github.com/openmcp-project/bootstrapper/internal/flux_deployer"
+	logging "github.com/openmcp-project/bootstrapper/internal/log"
+)
+
+func TestCreateGitCredentialsSecret(t *testing.T) {
+	platformClient := fake.NewClientBuilder().Build()
+
+	testCases := []struct {
+		desc          string
+		gitConfigPath string
+		secretName    string
+		expectedData  map[string][]byte
+	}{
+		{
+			desc:          "Git secret with basic auth credentials",
+			gitConfigPath: "./testdata/02/git-config-basic.yaml",
+			secretName:    "test-secret-basic",
+			expectedData: map[string][]byte{
+				flux_deployer.Username: []byte("test-user"),
+				flux_deployer.Password: []byte("test-pass"),
+			},
+		},
+		{
+			desc:          "Git secret with basic ssh credentials",
+			gitConfigPath: "./testdata/02/git-config-ssh.yaml",
+			secretName:    "test-secret-ssh",
+			expectedData: map[string][]byte{
+				flux_deployer.Identity:   []byte("test-key"),
+				flux_deployer.KnownHosts: []byte("test-known-hosts"),
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.desc, func(t *testing.T) {
+			err := flux_deployer.CreateGitCredentialsSecret(t.Context(), logging.GetLogger(), tc.gitConfigPath, tc.secretName, flux_deployer.FluxSystemNamespace, platformClient)
+			assert.NoError(t, err, "Error creating git credentials secret")
+			secret := &corev1.Secret{}
+			err = platformClient.Get(t.Context(), client.ObjectKey{Name: tc.secretName, Namespace: flux_deployer.FluxSystemNamespace}, secret)
+			assert.NoError(t, err, "Error getting git credentials secret")
+			assert.Equal(t, tc.expectedData, secret.Data, "Git credentials secret data do not match expected data")
+		})
+	}
+}

internal/flux_deployer/testdata/02/git-config-basic.yaml

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

internal/flux_deployer/testdata/02/git-config-ssh.yaml

@@ -0,0 +1,4 @@
+auth:
+  sshPrivateKey:
+    privateKey: dGVzdC1rZXk=
+    knownHosts: ./testdata/02/known_hosts

internal/flux_deployer/testdata/02/known_hosts

@@ -0,0 +1 @@
+test-known-hosts