konflux-ci/integration-service/running-unit-tests

Running Unit Tests

Overview

Unit tests use Ginkgo v2 + Gomega with envtest (a local K8s API server). Every package has a *_suite_test.go that bootstraps envtest with CRDs, registers schemes, and starts a controller manager.

When to Use

• Running or debugging unit tests
• Adding tests to a new or existing package
• Troubleshooting envtest or CRD-related test failures
• Understanding the mock loader pattern

Quick Reference

Suite Setup Pattern

Every suite follows this structure (see any *_suite_test.go):

1. CRD paths via CRDDirectoryPaths — local CRDs from config/crd/bases plus dependency CRDs found via toolkit.GetRelativeDependencyPath()
2. Scheme registration — add all API types (applicationapiv1alpha1, tektonv1, releasev1alpha1, v1beta2)
3. Manager creation — ctrl.NewManager() with Metrics.BindAddress: "0" (disables metrics to avoid port conflicts) and LeaderElection: false
4. Cache setup — call cache.Setup*Cache(k8sManager) functions before starting manager
5. Start manager in goroutine — go func() { defer GinkgoRecover(); k8sManager.Start(ctx) }()
6. Cleanup — cancel() context and testEnv.Stop() in AfterSuite

CRD directory paths are relative to the suite file location. Adjust depth (.., ../..) based on package nesting.

Mock Loader Pattern

loader/loader_mock.go intercepts resource loading via context keys:

mockContext := toolkit.GetMockedContext(ctx, []toolkit.MockData{
    {ContextKey: loader.SnapshotContextKey, Resource: mySnapshot},
})
result, err := adapter.loader.GetSnapshot(mockContext, client, name, namespace)

Each resource type has a corresponding *ContextKey constant (34 keys available).

Test Conventions

• BDD structure: Describe > Context("When...") > It("should...")
• Use Eventually for async assertions, never time.Sleep
• Always Get() after Create()/Update() to ensure server-side state
• Test idempotency: calling Reconcile twice must produce the same result
• ginkgolinter is enabled — follow its conventions

Common Mistakes

Coverage

• Tool: codecov with flag unit-tests
• Patch target: 85% (see estimating-codecov-patch-coverage for the local estimate)
• Project coverage remains informational
• Ignores: **/zz_generated*, e2e-tests/**, vendor