Kcc Direct Controller Logic Implementer

KCC Direct Controller Logic Implementer

This skill guides the implementation of the Adapter interface and the creation of "Minimal" and "Maximal" E2E fixtures to verify the resource against real GCP.

Inputs

• resource_kind: The KCC Kind.
• service_name: The GCP service name (short, e.g., apigee).
• api_version: The KCC API version.

Workflow

1. Implement Adapter Logic: Update pkg/controller/direct/<service>/<resource_lower>_controller.go.

   • Implement Find, Create, Update, and Delete.
   • Use the generated mappers and manual mappers as needed.
   • Ensure correct error handling (e.g., handling 404s in Find).

2. Create Minimal Fixture: Create directory pkg/test/resourcefixture/testdata/basic/<service_name>/<api_version>/<resource_lower>/<resource_lower>-minimal/.

   • Add create.yaml: Use the bare minimum Required fields.
   • Use ${uniqueId} for resource names.

3. Create Maximal Fixture: Create directory pkg/test/resourcefixture/testdata/basic/<service_name>/<api_version>/<resource_lower>/<resource_lower>-maximal/.

   • Add create.yaml: Include every supported field in the Spec.
   • Add update.yaml: Update all mutable fields.
   • Add dependencies.yaml if the resource requires other KCC resources to exist first.

3.5. Remove from Ratcheting Exclusions (MANDATORY): Before running the test cases against real or mock GCP, you MUST ensure the target resource is removed from the ratcheting exclusion list in tests/e2e/ratcheting.go. This enables the re-reconciliation test step, which is a fundamental use case KCC resources must support. 1. Open tests/e2e/ratcheting.go. 2. Locate the function ShouldTestRereconiliation. 3. Locate the switch statement that checks primaryResource.GroupVersionKind(). 4. If there is a case block for your target resource's GroupKind, remove that case line from the switch statement.

4. Record Golden Files (Real GCP): Run the tests against real GCP to record the traffic and object state. Ensure you use a sufficient timeout (e.g., 30-60 minutes) as GCP resource creation can be slow:

   [!WARNING] WHENEVER A TEST CASE IS UPDATED, WE MUST RECORD REAL GCP LOGS AGAIN. If you make any modifications to a test case configuration, manifest files (such as create.yaml, update.yaml, or dependencies.yaml), or the controller's runtime mapping configuration, you MUST run the test case against real GCP (hack/record-gcp or with E2E_GCP_TARGET=real) to regenerate the authentic _http.log baseline before comparing or committing any mock log changes. Do not attempt to manually edit the logs or bypass recording live traffic.

   # Run from the repository root
   RUN_E2E=1 \
   E2E_GCP_TARGET=real \
   E2E_KUBE_TARGET=envtest \
   GOLDEN_REQUEST_CHECKS=1 \
   GOLDEN_OBJECT_CHECKS=1 \
   WRITE_GOLDEN_OUTPUT=1 \
   go test -v ./tests/e2e \
     -timeout 60m \
     -run TestAllInSeries/fixtures/<resource_lower>-minimal
   

   Repeat for the -maximal fixture. Commit the resulting _http.log and _generated_object_*.golden.yaml files.

5. Verify Field Coverage: Run the API check tests:

   • For alpha: WRITE_GOLDEN_OUTPUT=1 go test -v ./tests/apichecks/... -run TestCRDFieldPresenceInTestsForAlpha
   • Verify that your "Maximal" test reduces the number of missing fields in the exceptions file.

Journaling

Append any reconciliation hurdles, GCP SDK quirks, or other controller issues to .gemini/journals/<service>.md using the format described in the kcc-agentic-journaler skill.