feat(argocd-cmp-hk-deployment): add a single entrypoint

fredleger · neilime · commit f96d5cd1f21c · 2025-12-09T22:55:08.000+01:00
diff --git a/.tool-versions b/.tool-versions
@@ -0,0 +1 @@
+container-structure-test 1.22.0
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: help
+.PHONY: help test test-all
 
 help: ## Display help
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
@@ -37,8 +37,13 @@ define run_linter
 	DEFAULT_WORKSPACE="$(CURDIR)"; \
 	LINTER_IMAGE="linter:latest"; \
 	VOLUME="$$DEFAULT_WORKSPACE:$$DEFAULT_WORKSPACE"; \
-	docker build --target linter --build-arg UID=$(shell id -u) --build-arg GID=$(shell id -g) --tag $$LINTER_IMAGE .; \
+	docker build --platform linux/amd64 \
+			--target linter \
+			--build-arg UID=$(shell id -u) \
+			--build-arg GID=$(shell id -g) \
+			--tag $$LINTER_IMAGE .; \
 	docker run \
+		--platform linux/amd64 \
 		-e DEFAULT_WORKSPACE="$$DEFAULT_WORKSPACE" \
 		-e FILTER_REGEX_INCLUDE="$(filter-out $@,$(MAKECMDGOALS))" \
 		-e IGNORE_GITIGNORED_FILES=true \
diff --git a/images/argocd-cmp-hk-deployment/.dockerignore b/images/argocd-cmp-hk-deployment/.dockerignore
@@ -1,4 +1,2 @@
 .dockerignore
 Dockerfile
-Taskfile.yml
-tests
diff --git a/images/argocd-cmp-hk-deployment/Dockerfile b/images/argocd-cmp-hk-deployment/Dockerfile
@@ -1,7 +1,7 @@
 FROM quay.io/argoproj/argocd:v3.2.0
 
 USER root
-COPY * /hk-tools/
+COPY . /hk-tools/
 RUN chown -R argocd:argocd /hk-tools
 
 USER argocd
diff --git a/images/argocd-cmp-hk-deployment/README.md b/images/argocd-cmp-hk-deployment/README.md
@@ -6,15 +6,17 @@ Docker base image for the Hoverkraft ArgoCD custom CMP (Config Management Plugin
 
 - **Image purpose:** Provides a containerized environment for ArgoCD to render and manage Hoverkraft deployments using Helm and Kustomize, with support for multi-source and single-source workflows.
 - **Key scripts:**
+  - `entrypoint.sh`: call correct script depending of the argocd context
   - `single-source.sh`: Renders a Helm chart and applies Kustomize overlays, outputting the final Kubernetes manifests. Supports injection of deployment ID and ArgoCD environment variables.
   - `multi-sources.sh`: Generates a ConfigMap manifest for multi-source deployments, propagating the deployment ID.
 - **Kustomize template:** `kustomize-template.yaml` is used by the scripts to inject deployment-specific configuration.
 
 ## Scripts
 
-- `single-source.sh`: Entrypoint for single-source ArgoCD CMP integration. Expects a Helm chart in the working directory and outputs manifests to stdout. Honors the following environment variables:
+- `entrypoint.sh`: Honors the following environment variables:
+  - `ARGOCD_APP_NAME`: name of the argocd application
+  - `ARGOCD_ENV_ARGOCD_MULTI_SOURCES`: is the argocd app multi-sources or not (0 or 1)
+  - `ARGOCD_ENV_DEBUG`: enable debug env output (0 or 1)
+- `single-source.sh`: Expects a Helm chart in the working directory and outputs manifests to stdout. Honors the following environment variables:
   - `ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID`
-  - `ARGOCD_APP_NAME`
-  - `ARGOCD_APP_NAMESPACE`
-  - `KUBE_VERSION`
-- `multi-sources.sh`: Outputs a ConfigMap manifest with the deployment ID, suitable for multi-source workflows.
+- `multi-sources.sh`: Outputs a ConfigMap manifest with the deployment ID, suitable for multi-source workflows. Honors the following environment variables:
diff --git a/images/argocd-cmp-hk-deployment/container-structure-test.yaml b/images/argocd-cmp-hk-deployment/container-structure-test.yaml
@@ -3,106 +3,185 @@ schemaVersion: "2.0.0"
 
 commandTests:
   - name: "single-source renders helm output with provided deployment id"
+    envVars:
+      - key: ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID
+        value: "4242"
     command: "bash"
     args:
       - -c
       - |
         set -euo pipefail
-        WORKDIR="$(mktemp -d)"
-        cd "$WORKDIR"
-        cat <<'EOF' > Chart.yaml
-        apiVersion: v2
-        name: hk-deployment-fixture
-        description: Fixture chart for container tests
-        type: application
-        version: 0.1.0
-        appVersion: "1.0.0"
-        EOF
-        cat <<'EOF' > values.yaml
-        replicaCount: 1
-        EOF
-        mkdir -p templates
-        cat <<'EOF' > templates/configmap.yaml
-        apiVersion: v1
-        kind: ConfigMap
-        metadata:
-          name: sample-config
-          labels:
-            app.kubernetes.io/name: sample-config
-        data:
-          foo: bar
-        EOF
+        cd /hk-tools/tests
         /hk-tools/single-source.sh
-    envVars:
-      - key: "ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID"
-        value: "4242"
-      - key: "ARGOCD_APP_NAME"
-        value: "hk-app"
-      - key: "ARGOCD_APP_NAMESPACE"
-        value: "hk-namespace"
-      - key: "KUBE_VERSION"
-        value: "1.31.0"
+    exitCode: 0
     expectedOutput:
+      - "name: hoverkraft-deployment"
       - 'deploymentId: "4242"'
-      - "name: sample-config"
-      - "foo: bar"
 
   - name: "single-source falls back to unknown deployment id"
     command: "bash"
     args:
       - -c
       - |
         set -euo pipefail
-        WORKDIR="$(mktemp -d)"
-        cd "$WORKDIR"
-        cat <<'EOF' > Chart.yaml
-        apiVersion: v2
-        name: hk-deployment-fixture
-        description: Fixture chart for container tests
-        type: application
-        version: 0.1.0
-        appVersion: "1.0.0"
-        EOF
-        cat <<'EOF' > values.yaml
-        replicaCount: 1
-        EOF
-        mkdir -p templates
-        cat <<'EOF' > templates/configmap.yaml
-        apiVersion: v1
-        kind: ConfigMap
-        metadata:
-          name: sample-config
-        data:
-          foo: bar
-        EOF
+        cd /hk-tools/tests
         /hk-tools/single-source.sh
-    envVars:
-      - key: "ARGOCD_APP_NAME"
-        value: "hk-app"
-      - key: "ARGOCD_APP_NAMESPACE"
-        value: "hk-namespace"
-      - key: "KUBE_VERSION"
-        value: "1.31.0"
+    exitCode: 0
     expectedOutput:
+      - "name: hoverkraft-deployment"
       - "deploymentId: unknown"
-      - "name: sample-config"
 
   - name: "multi-sources propagates deployment id"
-    command: "/hk-tools/multi-sources.sh"
     envVars:
       - key: "ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID"
         value: "7777"
+    command: "bash"
+    args:
+      - -c
+      - |
+        set -euo pipefail
+        cd /hk-tools/tests
+        /hk-tools/multi-sources.sh
+    exitCode: 0
     expectedOutput:
-      - 'deploymentId: "7777"'
       - "name: hoverkraft-deployment"
+      - 'deploymentId: "7777"'
 
   - name: "multi-sources defaults deployment id"
-    command: "/hk-tools/multi-sources.sh"
+    command: "bash"
+    args:
+      - -c
+      - |
+        set -euo pipefail
+        cd /hk-tools/tests
+        /hk-tools/multi-sources.sh
     expectedOutput:
+      - "name: hoverkraft-deployment"
       - 'deploymentId: "unknown"'
+
+  - name: "entrypoint executes single-source when ARGOCD_MULTI_SOURCES is 0"
+    command: "bash"
+    args:
+      - -c
+      - |
+        set -euo pipefail
+        cd /hk-tools/tests
+        /hk-tools/entrypoint.sh
+    envVars:
+      - key: "ARGOCD_ENV_ARGOCD_MULTI_SOURCES"
+        value: "0"
+      - key: "ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID"
+        value: "1234"
+    expectedOutput:
       - "name: hoverkraft-deployment"
+      - 'deploymentId: "1234"'
+    expectedError:
+      - "hoverkraft-deployment CMP plugin"
+      - "single-source application"
+
+  - name: "entrypoint executes multi-sources when ARGOCD_MULTI_SOURCES is 1"
+    envVars:
+      - key: "ARGOCD_ENV_ARGOCD_MULTI_SOURCES"
+        value: "1"
+      - key: "ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID"
+        value: "5678"
+    command: "bash"
+    args:
+      - -c
+      - |
+        set -euo pipefail
+        cd /hk-tools/tests
+        /hk-tools/entrypoint.sh
+    expectedOutput:
+      - "name: hoverkraft-deployment"
+      - 'deploymentId: "5678"'
+    expectedError:
+      - "hoverkraft-deployment CMP plugin"
+      - "multi-sources application"
+
+  - name: "entrypoint defaults to single-source when ARGOCD_MULTI_SOURCES is unset"
+    envVars:
+      - key: "ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID"
+        value: "9999"
+      - key: "ARGOCD_APP_NAME"
+        value: "test-app"
+    command: "bash"
+    args:
+      - -c
+      - |
+        set -euo pipefail
+        cd /hk-tools/tests
+        /hk-tools/entrypoint.sh
+    expectedOutput:
+      - "name: hoverkraft-deployment"
+      - 'deploymentId: "9999"'
+    expectedError:
+      - "WARN: ARGOCD_MULTI_SOURCES is not set"
+      - "single-source application"
+
+  - name: "entrypoint handles invalid ARGOCD_MULTI_SOURCES value"
+    command: "bash"
+    envVars:
+      - key: "ARGOCD_ENV_ARGOCD_MULTI_SOURCES"
+        value: "invalid"
+      - key: "ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID"
+        value: "8888"
+    args:
+      - -c
+      - |
+        set -euo pipefail
+        cd /hk-tools/tests
+        /hk-tools/entrypoint.sh
+    exitCode: 0
+    expectedError:
+      - "WARN: ARGOCD_MULTI_SOURCES is invalid"
+      - "WARN: defaulting to single source mode"
+
+  - name: "entrypoint with DEBUG enabled shows environment"
+    envVars:
+      - key: "ARGOCD_ENV_DEBUG"
+        value: "true"
+      - key: "ARGOCD_ENV_ARGOCD_MULTI_SOURCES"
+        value: "0"
+      - key: "ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID"
+        value: "1111"
+    command: "bash"
+    args:
+      - -c
+      - |
+        set -euo pipefail
+        cd /hk-tools/tests
+        /hk-tools/entrypoint.sh
+    exitCode: 0
+    expectedError:
+      - '\+ DEBUG: current environment:'
+      - "ARGOCD_ENV_DEBUG=true"
+      - "ARGOCD_ENV_ARGOCD_MULTI_SOURCES=0"
+      - "ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID=1111"
+
+  - name: "entrypoint display argocd app name"
+    command: "bash"
+    envVars:
+      - key: "ARGOCD_ENV_ARGOCD_MULTI_SOURCES"
+        value: "1"
+      - key: "ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID"
+        value: "9999"
+    args:
+      - -c
+      - |
+        set -euo pipefail
+        cd /hk-tools/tests
+        /hk-tools/entrypoint.sh
+    exitCode: 0
+    expectedError:
+      - '\+ application: hk-app'
 
 fileExistenceTests:
+  - name: "entrypoint script is present"
+    path: "/hk-tools/entrypoint.sh"
+    shouldExist: true
+    isExecutableBy: "any"
+
   - name: "single-source script is present"
     path: "/hk-tools/single-source.sh"
     shouldExist: true
@@ -119,3 +198,12 @@ fileExistenceTests:
 
 metadataTest:
   user: "argocd"
+
+# global configuration
+globalEnvVars:
+  - key: "ARGOCD_APP_NAME"
+    value: "hk-app"
+  - key: "ARGOCD_APP_NAMESPACE"
+    value: "hk-ns"
+  - key: "KUBE_VERSION"
+    value: "1.33.0"
diff --git a/images/argocd-cmp-hk-deployment/entrypoint.sh b/images/argocd-cmp-hk-deployment/entrypoint.sh
@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# save stdout descriptor
+exec 3>&1
+# redirect all output to stderr
+exec 1>&2
+
+echo "+ hoverkraft-deployment CMP plugin"
+echo "+ application: ${ARGOCD_APP_NAME}"
+
+echo "+ init"
+
+if [ -n "${ARGOCD_ENV_DEBUG}" ]; then
+	echo "+ DEBUG: current environment:"
+	printenv | grep "ARGOCD_ENV_"
+	echo "+++"
+fi
+
+# ARGOCD_ENV_ARGOCD_MULTI_SOURCES is a boolean that can be either 0 or 1
+if [ -z "${ARGOCD_ENV_ARGOCD_MULTI_SOURCES}" ]; then
+	echo "WARN: ARGOCD_MULTI_SOURCES is not set (expected 0 or 1, got empty string)"
+	echo "WARN: defaulting to single source mode"
+elif [ "${ARGOCD_ENV_ARGOCD_MULTI_SOURCES}" != "0" ] && [ "${ARGOCD_ENV_ARGOCD_MULTI_SOURCES}" != "1" ]; then
+	echo "WARN: ARGOCD_MULTI_SOURCES is invalid (expected 0 or 1, got '${ARGOCD_ENV_ARGOCD_MULTI_SOURCES}')"
+	echo "WARN: defaulting to single source mode"
+fi
+
+case "${ARGOCD_ENV_ARGOCD_MULTI_SOURCES}" in
+1)
+	echo "+ multi-sources application"
+	/hk-tools/multi-sources.sh >&3
+	;;
+*)
+	echo "+ single-source application"
+	/hk-tools/single-source.sh >&3
+	;;
+esac
diff --git a/images/argocd-cmp-hk-deployment/kustomize-template.yaml b/images/argocd-cmp-hk-deployment/kustomize-template.yaml
@@ -6,7 +6,7 @@ resources:
   - all.yaml
 
 configMapGenerator:
-  - name: hk-deployment
+  - name: hoverkraft-deployment
     options:
       disableNameSuffixHash: true
     literals:
diff --git a/images/argocd-cmp-hk-deployment/multi-sources.sh b/images/argocd-cmp-hk-deployment/multi-sources.sh
@@ -7,8 +7,9 @@ exec 1>&2
 
 echo "hoverkraft-deployment-multi"
 
-echo "+ init"
+echo "+ pre-checks"
 if [ -z "${ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID}" ]; then
+	echo "WARN: HOVERKRAFT_DEPLOYMENT_ID is empty"
 	ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID="unknown"
 fi
 
diff --git a/images/argocd-cmp-hk-deployment/single-source.sh b/images/argocd-cmp-hk-deployment/single-source.sh
@@ -7,11 +7,12 @@ exec 1>&2
 
 SOURCE_DIR="$(realpath "$(dirname "${BASH_SOURCE[0]}")")"
 
-echo "hk-deployment"
+echo "hk-deployment-single"
 
-echo "+ init"
+echo "+ pre-checks"
 cp "$SOURCE_DIR/kustomize-template.yaml" ./kustomization.yaml
 if [ -z "${ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID}" ]; then
+	echo "WARN: HOVERKRAFT_DEPLOYMENT_ID is empty"
 	ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID="unknown"
 fi
 sed -i'' -e "s/<HK_DEPLOYMENT_ID>/${ARGOCD_ENV_HOVERKRAFT_DEPLOYMENT_ID}/" kustomization.yaml
