test: add full e2e tests (#83)

isometry · web-flow · commit b6a3592d005a · 2025-07-22T14:17:08.000+02:00
* feat: switch to kstatus-compatible status conditions
* test: add full e2e tests
* ci: add e2e workflow
diff --git a/.github/workflows/e2e.yaml b/.github/workflows/e2e.yaml
@@ -0,0 +1,45 @@
+name: E2E Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  e2e:
+    name: E2E Tests
+    runs-on: ubuntu-latest
+
+    env:
+      KIND_CLUSTER: e2e
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup go
+        uses: actions/setup-go@v5
+
+      - name: Setup ko
+        uses: ko-build/setup-ko@v0.9
+
+      - name: Setup helm
+        uses: azure/setup-helm@v4
+
+      - name: Setup kind
+        uses: helm/kind-action@v1
+        with:
+          cluster_name: ${{ env.KIND_CLUSTER }}
+
+      - name: Run E2E tests
+        env:
+          GTM_APP_ID: ${{ vars.GTM_APP_ID }}
+          GTM_INSTALLATION_ID: ${{ vars.GTM_INSTALLATION_ID }}
+          GTM_PROVIDER: file
+          GTM_KEY: ${{ secrets.GTM_KEY }}
+        run: |
+          make test-e2e
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,9 @@
 bin/*
 Dockerfile.cross
 
+# Secrets
+test/e2e/values.yaml
+
 # Test binary, built with `go test -c`
 *.test
 
diff --git a/Makefile b/Makefile
@@ -150,8 +150,8 @@ cleanup-test-e2e:
 
 # Utilize Kind or modify the e2e tests to load the image locally, enabling compatibility with other vendors.
 .PHONY: test-e2e
-test-e2e: setup-test-e2e manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
-	KIND_CLUSTER=$(KIND_CLUSTER) go test ./test/e2e/ -v -ginkgo.v
+test-e2e: fmt vet setup-test-e2e ## Run the e2e tests. Expected an isolated environment using Kind.
+	KUBE_CONTEXT=kind-$(KIND_CLUSTER) go test ./test/e2e/ -tags=e2e -v -ginkgo.v
 	$(MAKE) cleanup-test-e2e
 
 .PHONY: lint
@@ -213,7 +213,7 @@ build-installer: manifests generate kustomize ## Generate a consolidated YAML wi
 .PHONY: ko-build
 ko-build: ## Build the manager image using ko.
 	KO_DOCKER_REPO=$(IMAGE_TAG_BASE) \
-	ko build --bare --platform=$(PLATFORMS) --image-label org.opencontainers.image.source=$(IMAGE_SOURCE) --tags "latest,$(VERSION)" --push ./cmd/manager
+	$(KO) build --bare --platform=$(PLATFORMS) --image-label org.opencontainers.image.source=$(IMAGE_SOURCE) --tags "latest,$(VERSION)" --push ./cmd/manager
 
 
 ##@ Deployment
@@ -249,6 +249,7 @@ $(LOCALBIN):
 ## Tool Binaries
 KUBECTL ?= kubectl
 KIND ?= kind
+KO ?= ko
 KUSTOMIZE ?= $(LOCALBIN)/kustomize
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 ENVTEST ?= $(LOCALBIN)/setup-envtest
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 [![CodeQL](https://github.com/isometry/github-token-manager/actions/workflows/codeql.yaml/badge.svg)](https://github.com/isometry/github-token-manager/actions/workflows/codeql.yaml)
+[![E2E](https://github.com/isometry/github-token-manager/actions/workflows/e2e.yaml/badge.svg)](https://github.com/isometry/github-token-manager/actions/workflows/e2e.yaml)
 [![Publish](https://github.com/isometry/github-token-manager/actions/workflows/publish.yaml/badge.svg)](https://github.com/isometry/github-token-manager/actions/workflows/publish.yaml)
 [![Go Report Card](https://goreportcard.com/badge/github.com/isometry/github-token-manager)](https://goreportcard.com/report/github.com/isometry/github-token-manager)
 
@@ -158,8 +159,8 @@ More information can be found via the [Kubebuilder Documentation](https://book.k
 make ko-build IMG=<some-registry>/github-token-manager:tag
 ```
 
-**NOTE:** This image ought to be published in the personal registry you specified. 
-And it is required to have access to pull the image from the working environment. 
+**NOTE:** This image ought to be published in the personal registry you specified.
+And it is required to have access to pull the image from the working environment.
 Make sure you have the proper permission to the registry if the above commands don’t work.
 
 #### Install the CRDs into the cluster:
@@ -174,7 +175,7 @@ make install
 make deploy IMG=<some-registry>/github-token-manager:tag
 ```
 
-> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin 
+> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
 privileges or be logged in as admin.
 
 ### To Uninstall
diff --git a/api/v1/conditions.go b/api/v1/conditions.go
@@ -1,6 +1,6 @@
 package v1
 
 const (
-	// ConditionTypeAvailable represents the status of the Secret reconciliation
-	ConditionTypeAvailable = "Available"
+	// ConditionTypeReady is used to signal whether a reconciliation has completed successfully.
+	ConditionTypeReady = "Ready"
 )
diff --git a/go.mod b/go.mod
@@ -1,8 +1,6 @@
 module github.com/isometry/github-token-manager
 
-go 1.24.0
-
-toolchain go1.24.5
+go 1.24.5
 
 require (
 	github.com/go-logr/logr v1.4.3
@@ -12,10 +10,12 @@ require (
 	github.com/onsi/gomega v1.37.0
 	github.com/spf13/viper v1.20.1
 	go.uber.org/automaxprocs v1.6.0
+	golang.org/x/oauth2 v0.30.0
 	k8s.io/api v0.33.2
 	k8s.io/apimachinery v0.33.2
 	k8s.io/client-go v0.33.2
 	sigs.k8s.io/controller-runtime v0.21.0
+	sigs.k8s.io/yaml v1.4.0
 )
 
 require (
@@ -127,7 +127,6 @@ require (
 	golang.org/x/crypto v0.40.0 // indirect
 	golang.org/x/exp v0.0.0-20250606033433-dcc06ee1d476 // indirect
 	golang.org/x/net v0.42.0 // indirect
-	golang.org/x/oauth2 v0.30.0 // indirect
 	golang.org/x/sync v0.16.0 // indirect
 	golang.org/x/sys v0.34.0 // indirect
 	golang.org/x/term v0.33.0 // indirect
@@ -154,5 +153,4 @@ require (
 	sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8 // indirect
 	sigs.k8s.io/randfill v1.0.0 // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.7.0 // indirect
-	sigs.k8s.io/yaml v1.4.0 // indirect
 )
diff --git a/internal/controller/clustertoken_controller.go b/internal/controller/clustertoken_controller.go
@@ -55,12 +55,12 @@ type ClusterTokenReconciler struct {
 // For more details, check Reconcile and its Result here:
 // - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.16.3/pkg/reconcile
 func (r *ClusterTokenReconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ctrl.Result, err error) {
-	log := log.FromContext(ctx)
+	logger := log.FromContext(ctx)
 
 	if app == nil {
 		app, err = ghapp.NewGHApp(ctx)
 		if err != nil {
-			log.Error(err, "failed to load GitHub App credentials")
+			logger.Error(err, "failed to load GitHub App credentials")
 			return ctrl.Result{RequeueAfter: time.Minute}, err
 		}
 	}
@@ -70,26 +70,26 @@ func (r *ClusterTokenReconciler) Reconcile(ctx context.Context, req ctrl.Request
 	options := []tm.Option{
 		tm.WithReconciler(r),
 		tm.WithGHApp(app),
-		tm.WithLogger(log),
+		tm.WithLogger(logger),
 	}
 
 	tokenSecret, err := tm.NewTokenSecret(ctx, req.NamespacedName, token, options...)
 	if err != nil {
-		log.Error(err, "failed to create ClusterToken reconciler")
+		logger.Error(err, "failed to create ClusterToken reconciler")
 		return ctrl.Result{}, err
 	}
 
 	if tokenSecret == nil {
-		log.Info("ClusterToken not found, skipping reconciliation")
+		logger.Info("ClusterToken not found, skipping reconciliation")
 		return ctrl.Result{}, nil
 	}
 
 	result, err = tokenSecret.Reconcile()
 	if err != nil {
-		log.Error(err, "failed to reconcile ClusterToken")
+		logger.Error(err, "failed to reconcile ClusterToken")
 		return result, err
 	}
-	log.Info("reconciled", "requeueAfter", result.RequeueAfter)
+	logger.Info("reconciled", "requeueAfter", result.RequeueAfter)
 	return result, nil
 }
 
diff --git a/internal/controller/token_controller.go b/internal/controller/token_controller.go
@@ -55,12 +55,12 @@ type TokenReconciler struct {
 // For more details, check Reconcile and its Result here:
 // - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.16.3/pkg/reconcile
 func (r *TokenReconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ctrl.Result, err error) {
-	log := log.FromContext(ctx)
+	logger := log.FromContext(ctx)
 
 	if app == nil {
 		app, err = ghapp.NewGHApp(ctx)
 		if err != nil {
-			log.Error(err, "failed to load GitHub App credentials")
+			logger.Error(err, "failed to load GitHub App credentials")
 			return ctrl.Result{RequeueAfter: time.Minute}, err
 		}
 	}
@@ -69,26 +69,26 @@ func (r *TokenReconciler) Reconcile(ctx context.Context, req ctrl.Request) (resu
 	options := []tm.Option{
 		tm.WithReconciler(r),
 		tm.WithGHApp(app),
-		tm.WithLogger(log),
+		tm.WithLogger(logger),
 	}
 
 	tokenSecret, err := tm.NewTokenSecret(ctx, req.NamespacedName, token, options...)
 	if err != nil {
-		log.Error(err, "failed to create Token reconciler")
+		logger.Error(err, "failed to create Token reconciler")
 		return ctrl.Result{}, err
 	}
 
 	if tokenSecret == nil {
-		log.Info("Token not found, skipping reconciliation")
+		logger.Info("Token not found, skipping reconciliation")
 		return ctrl.Result{}, nil
 	}
 
 	result, err = tokenSecret.Reconcile()
 	if err != nil {
-		log.Error(err, "failed to reconcile Token")
+		logger.Error(err, "failed to reconcile Token")
 		return result, err
 	}
-	log.Info("reconciled", "requeueAfter", result.RequeueAfter)
+	logger.Info("reconciled", "requeueAfter", result.RequeueAfter)
 	return result, nil
 }
 
diff --git a/internal/ghapp/config.go b/internal/ghapp/config.go
@@ -41,7 +41,7 @@ func (c *OperatorConfig) GetKey() string {
 const TokenValidity = time.Hour
 
 func LoadConfig(ctx context.Context) (*OperatorConfig, error) {
-	log := log.FromContext(ctx)
+	logger := log.FromContext(ctx)
 
 	viper.AutomaticEnv()
 	viper.SetEnvPrefix("GTM")
@@ -60,7 +60,7 @@ func LoadConfig(ctx context.Context) (*OperatorConfig, error) {
 		if _, ok := err.(viper.ConfigFileNotFoundError); !ok {
 			return nil, fmt.Errorf("error reading configuration file: %w", err)
 		} else {
-			log.Info("no configuration file found, continuing with environment variables only")
+			logger.Info("no configuration file found, continuing with environment variables only")
 		}
 	}
 
diff --git a/internal/ghapp/ghapp.go b/internal/ghapp/ghapp.go
@@ -9,14 +9,14 @@ import (
 )
 
 func NewGHApp(ctx context.Context) (ghait.GHAIT, error) {
-	log := log.FromContext(ctx)
+	logger := log.FromContext(ctx)
 
 	cfg, err := LoadConfig(ctx)
 	if err != nil {
 		return nil, fmt.Errorf("configuration: %w", err)
 	}
 
-	log.Info("loaded configuration", "config", cfg)
+	logger.Info("loaded configuration", "config", cfg)
 
 	ghapp, err := ghait.NewGHAIT(ctx, cfg)
 	if err != nil {
diff --git a/internal/tokenmanager/token_secret.go b/internal/tokenmanager/token_secret.go
@@ -43,9 +43,9 @@ func WithReconciler(reconciler tokenReconciler) Option {
 	}
 }
 
-func WithGHApp(ghait ghait.GHAIT) Option {
+func WithGHApp(g ghait.GHAIT) Option {
 	return func(s *tokenSecret) {
-		s.ghait = ghait
+		s.ghait = g
 	}
 }
 
@@ -83,7 +83,7 @@ func NewTokenSecret(ctx context.Context, key types.NamespacedName, owner tokenMa
 		s.log.Info("initializing token status conditions")
 
 		condition := metav1.Condition{
-			Type:    githubv1.ConditionTypeAvailable,
+			Type:    githubv1.ConditionTypeReady,
 			Status:  metav1.ConditionUnknown,
 			Reason:  "Reconciling",
 			Message: "Starting reconciliation",
@@ -152,7 +152,7 @@ func (s *tokenSecret) Reconcile() (result reconcile.Result, err error) {
 	// Secret was found, so update it
 	if !metav1.IsControlledBy(secret, s.owner) {
 		condition := metav1.Condition{
-			Type:    githubv1.ConditionTypeAvailable,
+			Type:    githubv1.ConditionTypeReady,
 			Status:  metav1.ConditionFalse,
 			Reason:  "Failed",
 			Message: "Secret already exists",
@@ -217,7 +217,7 @@ func (s *tokenSecret) CreateSecret() error {
 	}
 
 	condition := metav1.Condition{
-		Type:    githubv1.ConditionTypeAvailable,
+		Type:    githubv1.ConditionTypeReady,
 		Status:  metav1.ConditionFalse,
 		Reason:  "Creating",
 		Message: "Creating Secret",
@@ -263,7 +263,7 @@ func (s *tokenSecret) UpdateSecret() error {
 	s.Data = s.SecretData(installationToken.GetToken())
 
 	condition := metav1.Condition{
-		Type:    githubv1.ConditionTypeAvailable,
+		Type:    githubv1.ConditionTypeReady,
 		Status:  metav1.ConditionUnknown,
 		Reason:  "Updating",
 		Message: "Updating Secret",
@@ -300,7 +300,7 @@ func (s *tokenSecret) DeleteSecret(key types.NamespacedName) error {
 	log := s.log.WithValues("func", "DeleteSecret")
 
 	condition := metav1.Condition{
-		Type:    githubv1.ConditionTypeAvailable,
+		Type:    githubv1.ConditionTypeReady,
 		Status:  metav1.ConditionFalse,
 		Reason:  "Reconciling",
 		Message: "Deleting old Secret",
diff --git a/test/e2e/e2e_helpers_test.go b/test/e2e/e2e_helpers_test.go
diff --git a/test/e2e/e2e_suite_test.go b/test/e2e/e2e_suite_test.go
diff --git a/test/e2e/e2e_test.go b/test/e2e/e2e_test.go
diff --git a/test/utils/utils.go b/test/utils/utils.go

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`package v1`
`2`	`2`
`3`	`3`	`const (`
`4`		`- // ConditionTypeAvailable represents the status of the Secret reconciliation`
`5`		`- ConditionTypeAvailable = "Available"`
	`4`	`+ // ConditionTypeReady is used to signal whether a reconciliation has completed successfully.`
	`5`	`+ ConditionTypeReady = "Ready"`
`6`	`6`	`)`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ func (c *OperatorConfig) GetKey() string {`
`41`	`41`	`const TokenValidity = time.Hour`
`42`	`42`
`43`	`43`	`func LoadConfig(ctx context.Context) (*OperatorConfig, error) {`
`44`		`- log := log.FromContext(ctx)`
	`44`	`+ logger := log.FromContext(ctx)`
`45`	`45`
`46`	`46`	`viper.AutomaticEnv()`
`47`	`47`	`viper.SetEnvPrefix("GTM")`
`@@ -60,7 +60,7 @@ func LoadConfig(ctx context.Context) (*OperatorConfig, error) {`
`60`	`60`	`if _, ok := err.(viper.ConfigFileNotFoundError); !ok {`
`61`	`61`	`return nil, fmt.Errorf("error reading configuration file: %w", err)`
`62`	`62`	`} else {`
`63`		`- log.Info("no configuration file found, continuing with environment variables only")`
	`63`	`+ logger.Info("no configuration file found, continuing with environment variables only")`
`64`	`64`	`}`
`65`	`65`	`}`
`66`	`66`
Original file line number	Diff line number	Diff line change
`@@ -9,14 +9,14 @@ import (`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`func NewGHApp(ctx context.Context) (ghait.GHAIT, error) {`
`12`		`- log := log.FromContext(ctx)`
	`12`	`+ logger := log.FromContext(ctx)`
`13`	`13`
`14`	`14`	`cfg, err := LoadConfig(ctx)`
`15`	`15`	`if err != nil {`
`16`	`16`	`return nil, fmt.Errorf("configuration: %w", err)`
`17`	`17`	`}`
`18`	`18`
`19`		`- log.Info("loaded configuration", "config", cfg)`
	`19`	`+ logger.Info("loaded configuration", "config", cfg)`
`20`	`20`
`21`	`21`	`ghapp, err := ghait.NewGHAIT(ctx, cfg)`
`22`	`22`	`if err != nil {`