mirror of
https://github.com/helmfile/helmfile.git
synced 2026-09-30 12:54:14 +02:00
yxxhero
e3f757d5ed
* feat: add --template-args to enable helm lookup() during template/apply/sync (#1833) Add a --template-args flag to the template, apply, and sync subcommands so extra args (most notably --dry-run=server) can be passed to the helm template invocation, enabling Helm's lookup() function to resolve live cluster values. - template: --template-args reaches both chartify's pre-render helm template and the final helm template output (flagsForTemplate). - apply/sync: --template-args reaches chartify's pre-render helm template. apply/sync already inject --dry-run=server automatically for cluster operations; the flag is an explicit opt-in for the template subcommand or for passing additional flags. - When --dry-run is present in template args, kube-context/kubeconfig are also injected into chartify so lookup() can actually reach the cluster. - Resolves the long-stale PR #1833 rebased onto current main, which already contains the cluster-connectivity infrastructure (issues #2271, #2309, #2355, #2444). - Includes integration test (lookup.sh) covering both chartify and non-chartify scenarios. Signed-off-by: yxxhero <aiopsclub@163.com> * test: make lookup template nil-safe to fix integration CI The lookup() function returns an empty map when the chart is rendered without a cluster connection (notably the helm-diff phase of `helmfile apply`). The original fixture chained `index` over the lookup result, panicking with "index of untyped nil" during apply's diff rendering. Guard every index with `default dict` so the template falls back to "overwritten" when lookup is empty, while still resolving to the live value ("init") when cluster access is available (--dry-run=server via --template-args, or a real helm upgrade). Signed-off-by: yxxhero <aiopsclub@163.com> * feat: enable lookup() during apply/diff via --template-args in helm-diff Thread --template-args into the helm-diff rendering path so that `helmfile apply`/`diff --template-args="--dry-run=server"` resolves Helm's lookup() function during the diff phase too. helm-diff supports `--dry-run=server`, which explicitly "enables the cluster access ... and the lookup template function". Previously --template-args only reached chartify's pre-render (which is a no-op for plain charts due to chartify's early-return when there is no forceNamespace/patches/injections) and the final `helm template` of the `template` subcommand. As a result `helmfile apply` on a lookup chart rendered client-side during the diff phase. Changes: - pkg/state: add TemplateArgs to DiffOpts; append it in appendExtraDiffFlags (reaches every helm-diff invocation: apply, standalone diff, interactive sync), mirroring the existing flagsForTemplate handling. - pkg/config + cmd: add --template-args to the diff/doctor commands and to DiffConfigProvider, so lookup works for `helmfile diff` as well. - pkg/app: populate DiffOpts.TemplateArgs from apply/diff/sync-interactive. - docs/cli.md: correct the previous overpromising wording and document diff support plus the nil-safe lookup guidance. - tests: unit-test the TemplateArgs handling in appendExtraDiffFlags and flagsForTemplate; integration lookup.sh now exercises apply with --template-args="--dry-run=server". Signed-off-by: yxxhero <aiopsclub@163.com> * refactor: de-duplicate chartify template-args logic, add helmDefaults.templateArgs Address review feedback on #2666: 1. Eliminate stale duplicated test helpers (issue_2444_test.go, issue_2355_test.go). Both files intentionally copied the processChartification flag-building logic with explicit SYNC WARNING comments, then drifted out of sync when #2666 refactored the production code (needsKubeConnection gate, user-args merge). Extract the real logic into pure, unit-tested helpers (buildChartifyTemplateArgs, commandRequiresCluster) and delete the copies. 2. Add unit coverage for the new chartify merge path: template + --template-args=--dry-run=server now triggers kubeconfig/kube-context injection (TestTemplateArgsDryRunTriggersKubeInjection, TestTemplateArgsMergedBeforeInjection) — previously only covered by the cluster-dependent integration test. 3. Add a negative integration case (lookup.sh assert_template_fallback) verifying lookup() falls back to the default value WITHOUT --template-args, guarding against a regression that silently always connects to the cluster. 4. Add helmDefaults.templateArgs for parity with diffArgs/syncArgs, so users can enable lookup() support permanently instead of passing the flag on every invocation. CLI --template-args overrides (does not merge with) the default. Resolved via effectiveTemplateArgs, wired into the chartify, flagsForTemplate, and appendExtraDiffFlags paths. 5. Minor: capitalize --template-args help text to match surrounding flags; document helmDefaults.templateArgs precedence in docs/cli.md. Signed-off-by: yxxhero <aiopsclub@163.com> * test: cover helmDefaults->chartify composition; fix helm helm-diff typo Address remaining review nits on #2666: - Add TestHelmDefaultsTemplateArgsReachesChartify, a belt-and-suspenders test for the processChartification composition (effectiveTemplateArgs -> buildChartifyTemplateArgs), closing the last unit-level coverage gap for helmDefaults.templateArgs reaching the chartify path. - Fix pre-existing typo in cmd/bind_diff_flags.go: 'pass args to helm helm-diff' -> 'Pass args to helm-diff' (doubled 'helm', lowercase). Signed-off-by: yxxhero <aiopsclub@163.com> * fix: correct 'helm helm-diff' typo in apply --diff-args help text Sibling of the bind_diff_flags.go fix; the same doubled-'helm' typo and lowercase help existed in cmd/apply.go's --diff-args registration, leaving the apply and diff/doctor help strings inconsistent. Signed-off-by: yxxhero <aiopsclub@163.com> * docs: add helmDefaults.templateArgs to configuration reference The complete helmfile.yaml schema in docs/configuration.md documents diffArgs and syncArgs under helmDefaults but was missing the new templateArgs field added in #2666. Add it beside syncArgs for discoverability, noting the --template-args CLI override. Signed-off-by: yxxhero <aiopsclub@163.com> --------- Signed-off-by: yxxhero <aiopsclub@163.com>
80 lines
2.9 KiB
Bash
80 lines
2.9 KiB
Bash
#!/usr/bin/env bash
|
|
# Verify Helm `lookup` works under helmfile for both chartify and non-chartify scenarios.
|
|
#
|
|
# Assumptions (prepared by test/integration/run.sh):
|
|
# - A minikube cluster is running, context=minikube
|
|
# - Namespace ${test_ns} is created
|
|
# - Variables ${helmfile}, ${kubectl}, and ${cases_dir} are defined
|
|
|
|
set -euo pipefail
|
|
|
|
reset_live_secret() {
|
|
info "Resetting live secret to key=init"
|
|
${kubectl} delete secret my-secret -n ${test_ns} >/dev/null 2>&1 || true
|
|
init_hf="${cases_dir}/lookup/input-init/helmfile.yaml.gotmpl"
|
|
${helmfile} -f "${init_hf}" sync -q
|
|
}
|
|
|
|
assert_template_outputs() {
|
|
reset_live_secret
|
|
local hf_file="$1"
|
|
info "Templating ${hf_file} with --template-args=\"--dry-run=server\""
|
|
out=$(mktemp)
|
|
${helmfile} -f "${hf_file}" template --template-args="--dry-run=server" >"${out}"
|
|
grep -q "key: init" "${out}" || fail "template output did not contain 'key: init'"
|
|
rm -f "${out}"
|
|
}
|
|
|
|
# Negative case: WITHOUT --template-args, `helmfile template` renders client-side,
|
|
# so lookup() returns an empty map and the chart must fall back to "overwritten".
|
|
# This guards against a regression that silently always connects to the cluster.
|
|
assert_template_fallback() {
|
|
reset_live_secret
|
|
local hf_file="$1"
|
|
info "Templating ${hf_file} WITHOUT --template-args (expecting fallback to 'overwritten')"
|
|
out=$(mktemp)
|
|
${helmfile} -f "${hf_file}" template >"${out}"
|
|
grep -q "key: overwritten" "${out}" || fail "template fallback did not contain 'key: overwritten' (client-side render should not reach the cluster)"
|
|
rm -f "${out}"
|
|
}
|
|
|
|
assert_cluster_key_is_init() {
|
|
v=$(${kubectl} get secret lookup-result -n ${test_ns} -o jsonpath='{.data.key}' | base64 -d)
|
|
[ "${v}" = "init" ] || fail "expected lookup-result key to be 'init', got '${v}'"
|
|
}
|
|
|
|
assert_apply() {
|
|
local hf_file="$1"
|
|
reset_live_secret
|
|
# Pass --template-args="--dry-run=server" so the helm-diff phase of `apply`
|
|
# also resolves lookup() against the live cluster (issue #1833).
|
|
info "Applying ${hf_file} with --template-args=\"--dry-run=server\""
|
|
${helmfile} -f "${hf_file}" apply -q --template-args="--dry-run=server" || fail "apply failed"
|
|
assert_cluster_key_is_init
|
|
}
|
|
|
|
assert_sync() {
|
|
local hf_file="$1"
|
|
reset_live_secret
|
|
info "Syncing ${hf_file}"
|
|
${helmfile} -f "${hf_file}" sync -q || fail "sync failed"
|
|
assert_cluster_key_is_init
|
|
}
|
|
|
|
# Non-chartify scenario
|
|
plain_hf="${cases_dir}/lookup/input-plain/helmfile.yaml.gotmpl"
|
|
assert_template_outputs "${plain_hf}"
|
|
assert_template_fallback "${plain_hf}"
|
|
assert_apply "${plain_hf}"
|
|
assert_sync "${plain_hf}"
|
|
test_pass "lookup without chartify"
|
|
|
|
# Chartify scenario (e.g. forceNamespace triggers chartify)
|
|
chartify_hf="${cases_dir}/lookup/input-chartify/helmfile.yaml.gotmpl"
|
|
assert_template_outputs "${chartify_hf}"
|
|
assert_template_fallback "${chartify_hf}"
|
|
assert_apply "${chartify_hf}"
|
|
assert_sync "${chartify_hf}"
|
|
test_pass "lookup with chartify"
|
|
|