Files
computer-playbook/plugins/lookup/compose_only.py
T
kevinveenbirkenbachandClaude Opus 5 53a20bc4c9 refactor(vars): ask the deployment mode by name, not by string comparison
DEPLOYMENT_MODE was compared against a quoted literal 219 times across 110
files. IS_COMPOSE_MODE and IS_SWARM_MODE say the same thing once, and
test_deployment_mode_booleans keeps it that way: only the file that defines
them may still compare.

Both are real booleans under this ansible, measured before the swap because
the alternative is silent: a variable that templates to the string "False" is
truthy in Jinja, which is why IS_STACK_HOST is written `| bool` at every use.
These need no filter.

What had to learn the names:

  * utils/annotations/task_gate.py, which several lints ask whether a task is
    compose-only gated;
  * four compose-template lints that recognise their gate by matching the
    expression;
  * the fixtures that stand in for the play's variables. They derive the
    booleans from the mode now instead of carrying them, or a test that
    overrides DEPLOYMENT_MODE keeps the old pair and asserts the wrong
    branch.

Each replacement was checked rather than trusted: the 206 conditions that
changed in place were evaluated old against new through the Templar under
compose, swarm and host, with no disagreement, and no changed line turned out
to be anything but a condition swap. `!= 'swarm'` became `not IS_SWARM_MODE`
rather than the shorter IS_COMPOSE_MODE, because only the literal translation
stays correct should the mode ever be host.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-26 02:51:58 +02:00

64 lines
2.3 KiB
Python

"""Lookup `compose_only`: emit a `key: "<value>"` YAML pair only in
compose mode; emit nothing under swarm.
A single SPOT for every service-level YAML key that is structurally
incompatible with `docker stack deploy` and must therefore be omitted
when IS_SWARM_MODE. Currently used for:
* `container_name` — swarm rejects it alongside `deploy.replicas > 1`
("can't set container_name and X as container name must be unique").
* `pull_policy` — swarm rejects it as "Additional property pull_policy
is not allowed" (compose-only extension).
Both call sites look identical:
{{ lookup('compose_only', 'container_name', MY_CONTAINER) }}
{{ lookup('compose_only', 'pull_policy', 'never') }}
The value is always double-quoted in the output. That makes the emit
safe for YAML edge cases like `restart: no` (bare `no` would otherwise
parse as a boolean) without burdening the caller with quoting rules.
"""
from __future__ import annotations
import contextlib
from typing import Any
from ansible.errors import AnsibleError
from ansible.plugins.lookup import LookupBase
class LookupModule(LookupBase):
def run(
self,
terms: list[Any] | None,
variables: dict[str, Any] | None = None,
**kwargs: Any,
) -> list[str]:
if not terms or len(terms) != 2:
raise AnsibleError(
"compose_only lookup requires exactly two terms: the key and the value"
)
key = str(terms[0]).strip()
value = str(terms[1])
if not key:
raise AnsibleError("compose_only lookup: key term must be non-empty")
vars_ = variables or getattr(self._templar, "available_variables", {}) or {}
raw_mode = vars_.get("DEPLOYMENT_MODE", "compose")
templar = getattr(self, "_templar", None)
if templar is not None:
with contextlib.suppress(Exception):
raw_mode = templar.template(raw_mode)
mode_force = vars_.get("compose_mode_force", "")
if templar is not None:
with contextlib.suppress(Exception):
mode_force = templar.template(mode_force)
effective_mode = str(mode_force or raw_mode).strip()
if effective_mode == "swarm" and not bool(kwargs.get("node_local", False)):
return [""]
return [f'{key}: "{value}"']