fix(install): widen /dev/tty open-probe to sibling gates (#16746)

The contributor's PR (#16750) scoped the fix to run_setup_wizard() and
explicitly punted the two sibling sites. Both have the identical
[ -e /dev/tty ] pattern followed by a < /dev/tty redirect and crash in
Docker the same way:

- scripts/install.sh:732 install_system_packages() -- apt sudo prompt
  fallback. sudo ... < /dev/tty dies with the same ENXIO.
- scripts/install.sh:1395 maybe_start_gateway() -- gateway-install gate,
  same function path as the wizard reproducer.

Fix both with the same (: </dev/tty) 2>/dev/null probe, and parametrize
the regression test over all three gated functions so any future
regression is caught regardless of which site breaks.
This commit is contained in:
teknium1 2026-04-28 06:43:53 -07:00 committed by Teknium
parent 89e8c87354
commit 3d8be2c617
2 changed files with 49 additions and 27 deletions

View file

@ -1,11 +1,16 @@
"""Regression for #16746: setup-wizard tty gate must actually open /dev/tty.
"""Regression for #16746: install.sh /dev/tty gates must actually open /dev/tty.
In a Docker build, ``/dev/tty`` exists as a device node (so a bare ``-e``
existence test returns true) but opening it fails with ``ENXIO: No such
device or address``. Under the old gate the wizard proceeded past the "no
device or address``. Under the old gates the script proceeded past the "no
terminal available" skip and then crashed on the ``< /dev/tty`` redirect a
few lines later, aborting the entire image build. The fix replaces the
existence check with an open-based probe so the skip kicks in correctly.
few lines later, aborting the entire image build. The fix replaces every
existence-based check that guards a subsequent ``< /dev/tty`` redirect with
an open-based probe so the skip kicks in correctly.
This module covers all three affected functions: ``run_setup_wizard()``
(the reproducer in #16746), ``install_system_packages()`` (the apt sudo
prompt fallback), and ``maybe_start_gateway()`` (the gateway-install gate).
"""
from __future__ import annotations
@ -13,29 +18,36 @@ from __future__ import annotations
import re
from pathlib import Path
import pytest
REPO_ROOT = Path(__file__).resolve().parent.parent
INSTALL_SH = REPO_ROOT / "scripts" / "install.sh"
# Every function in scripts/install.sh that previously gated on a bare
# ``[ -e /dev/tty ]`` check before redirecting stdin from ``/dev/tty``.
GATED_FUNCTIONS = ("run_setup_wizard", "install_system_packages", "maybe_start_gateway")
def _extract_run_setup_wizard() -> str:
"""Return the body of ``run_setup_wizard()`` as a single string.
Anchored to ``run_setup_wizard()`` and a top-of-line ``}`` so the helper
keeps working if neighbouring functions are renamed.
def _extract_function_body(name: str) -> str:
"""Return the body of ``<name>()`` as a single string.
Anchored to ``<name>()`` and a top-of-line ``}`` so the helper keeps
working if neighbouring functions are renamed.
"""
text = INSTALL_SH.read_text()
match = re.search(
r"^run_setup_wizard\(\)\s*\{\s*\n(?P<body>.*?)^\}",
rf"^{re.escape(name)}\(\)\s*\{{\s*\n(?P<body>.*?)^\}}",
text,
re.MULTILINE | re.DOTALL,
)
assert match is not None, "run_setup_wizard() not found in scripts/install.sh"
assert match is not None, f"{name}() not found in scripts/install.sh"
return match["body"]
def test_run_setup_wizard_does_not_use_existence_only_tty_check() -> None:
@pytest.mark.parametrize("fn_name", GATED_FUNCTIONS)
def test_tty_gate_does_not_use_existence_only_check(fn_name: str) -> None:
"""The bare ``-e`` test is the bug — no spelling of it should remain."""
body = _extract_run_setup_wizard()
body = _extract_function_body(fn_name)
# Cover ``[ -e /dev/tty ]``, ``[ -e "/dev/tty" ]``, ``test -e /dev/tty``
# and friends, with arbitrary surrounding whitespace.
pattern = re.compile(
@ -48,28 +60,32 @@ def test_run_setup_wizard_does_not_use_existence_only_tty_check() -> None:
)
match = pattern.search(body)
assert match is None, (
"run_setup_wizard contains an existence-only check on /dev/tty "
f"{fn_name} contains an existence-only check on /dev/tty "
f"({match.group(0)!r}). Bare `-e` tests pass in Docker builds "
"where the device node is in the mount namespace but cannot be "
"opened (ENXIO). Use an open-based probe (e.g. "
"`(: </dev/tty) 2>/dev/null` or `exec 3</dev/tty`) so the skip "
"kicks in before the wizard tries to read from /dev/tty. "
"kicks in before the function tries to read from /dev/tty. "
"See #16746."
)
def test_run_setup_wizard_gates_on_open_based_tty_probe() -> None:
@pytest.mark.parametrize("fn_name", GATED_FUNCTIONS)
def test_tty_gate_uses_open_based_probe(fn_name: str) -> None:
"""The gate must actually attempt to open ``/dev/tty``.
Any ``if !`` (or ``if``) whose condition opens ``/dev/tty`` for input
counts: ``(: </dev/tty)``, ``exec 3</dev/tty``, ``{ exec 3</dev/tty; }``,
etc. Asserting the higher-level invariant rather than a specific spelling
so equivalent refactors stay green.
Any ``if``/``if !``/``elif`` whose condition opens ``/dev/tty`` for
input counts: ``(: </dev/tty)``, ``exec 3</dev/tty``,
``{ exec 3</dev/tty; }``, etc. Asserting the higher-level invariant
rather than a specific spelling so equivalent refactors stay green.
"""
body = _extract_run_setup_wizard()
gate = re.compile(r"^\s*if\s+!?\s+[^\n]*<\s*/dev/tty[^\n]*;\s*then", re.MULTILINE)
assert gate.search(body), (
"run_setup_wizard must gate on an open-based probe of /dev/tty "
"(an `if`/`if !` whose test redirects stdin from /dev/tty), not a "
"mere existence check. See #16746."
body = _extract_function_body(fn_name)
gate = re.compile(
r"^\s*(?:if|elif)\s+!?\s*[^\n]*<\s*/dev/tty[^\n]*;\s*then",
re.MULTILINE,
)
assert gate.search(body), (
f"{fn_name} must gate on an open-based probe of /dev/tty "
"(an `if`/`if !`/`elif` whose test redirects stdin from /dev/tty), "
"not a mere existence check. See #16746."
)