Skip to content

docs: unquote !ENV value whereever its' ${VAR} sits #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ahze merged 1 commit into from
Oct 11, 2026
Merged

docs: unquote !ENV value whereever its' ${VAR} sits #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions dbuild/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -932,8 +932,10 @@ def _render_director_override(director: dict) -> str:
# quoted -- '!ENV ''${VAR}''' -- which director reads as literal text, not
# a tag, and the jail gets the string "!ENV '${VAR}'" as its value.
# Unquote so it is the tag pyaml-env resolves.
body = _re.sub(r"""'!ENV ''(\$\{[^}]+\}[^']*)'''""", r"!ENV '\1'", body)
body = _re.sub(r'''"!ENV '(\$\{[^}]+\}[^']*)'"''', r"!ENV '\1'", body)
# Any value with a ${VAR} in it, not only one that starts with one: immich's
# 'http://${IMMICH_ML_HOST:127.0.0.1}:3003' stayed quoted.
body = _re.sub(r"""'!ENV ''([^']*\$\{[^}]+\}[^']*)'''""", r"!ENV '\1'", body)
body = _re.sub(r'''"!ENV '([^'"]*\$\{[^}]+\}[^'"]*)'"''', r"!ENV '\1'", body)
return "# appjail-director.yml\n\n" + body


Expand Down
18 changes: 18 additions & 0 deletions tests/test_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -739,3 +739,21 @@ def test_choices_for_fjord_database_kind(self):
self.assertEqual(pg["env"]["TODO_DB_HOST"], "postgres")
ext = next(o for o in db["options"] if o["id"] == "external")
self.assertEqual([a["name"] for a in ext["ask"]][:2], ["TODO_DB_TYPE", "TODO_DB_HOST"])


class TestDirectorEnvUnquote(unittest.TestCase):
"""An !ENV value written as a string comes out as the tag, wherever its
${VAR} sits: immich's ML URL starts with http:// and stayed a quoted
string, so the jail got the literal text "!ENV 'http://...'"."""

def test_unquotes_a_variable_inside_a_value(self):
from dbuild.docs import _render_director_override
body = _render_director_override({"services": {"server": {"oci": {"environment": [
{"ML_URL": "!ENV 'http://${ML_HOST:127.0.0.1}:3003'"},
{"DB_HOST": "!ENV '${DB_HOST:127.0.0.1}'"},
{"PLAIN": "no variable here"},
]}}}})
self.assertIn("ML_URL: !ENV 'http://${ML_HOST:127.0.0.1}:3003'", body)
self.assertIn("DB_HOST: !ENV '${DB_HOST:127.0.0.1}'", body)
self.assertNotIn("'!ENV", body)
self.assertIn("PLAIN: no variable here", body)
Loading