fix(lease): raise capability-probe timeout to 10s on both halves (#869) (#1207)
ci/woodpecker/push/publish Pipeline failed
ci/woodpecker/push/publish Pipeline failed
This commit was merged in pull request #1207.
This commit is contained in:
@@ -24,11 +24,15 @@ from __future__ import annotations
|
||||
|
||||
import importlib.util
|
||||
import io
|
||||
import os
|
||||
import shlex
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
import unittest
|
||||
from contextlib import redirect_stderr
|
||||
from pathlib import Path
|
||||
from unittest import mock
|
||||
|
||||
|
||||
TOOLS_DIR = Path(__file__).parents[2] / "framework/tools/lease-broker"
|
||||
@@ -57,6 +61,20 @@ def matching_capability() -> dict[str, object]:
|
||||
return dict(VERSION_GATE.EXPECTED_ACTIVATION_CAPABILITY)
|
||||
|
||||
|
||||
def write_fake_mosaic(directory: Path, marker: Path) -> Path:
|
||||
directory.mkdir(parents=True, exist_ok=True)
|
||||
executable = directory / "mosaic"
|
||||
executable.write_text(
|
||||
"#!/bin/sh\n"
|
||||
f"printf '%s\\n' executed >> {shlex.quote(str(marker))}\n"
|
||||
"printf '%s\\n' "
|
||||
"'{\"name\":\"lease-runtime-activation\",\"version\":1}'\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
executable.chmod(0o755)
|
||||
return executable
|
||||
|
||||
|
||||
class AssertActivationCapabilityMatchesTest(unittest.TestCase):
|
||||
"""Unit-level coverage of `activation_version_gate.py`'s own assertion,
|
||||
isolated from the launch-runtime.py seam it is wired into below."""
|
||||
@@ -110,11 +128,102 @@ class ProbeActivationCapabilityTest(unittest.TestCase):
|
||||
handling — never spawns a real `mosaic` process."""
|
||||
|
||||
def test_returns_none_when_mosaic_is_not_resolvable_on_path(self) -> None:
|
||||
result = VERSION_GATE.default_probe_activation_capability(
|
||||
{"PATH": "/nonexistent-bin-dir-for-869-c4-test"}
|
||||
)
|
||||
# Keep even a deliberate ambient-lookup mutation away from any host
|
||||
# installation. The dedicated hermeticity tests below provide fake
|
||||
# ambient executables and markers.
|
||||
with mock.patch.dict(
|
||||
os.environ, {"PATH": "/nonexistent-ambient-bin-dir-for-869-c4-test"}
|
||||
):
|
||||
result = VERSION_GATE.default_probe_activation_capability(
|
||||
{"PATH": "/nonexistent-bin-dir-for-869-c4-test"}
|
||||
)
|
||||
self.assertIsNone(result)
|
||||
|
||||
def test_supplied_path_wins_over_ambient_process_path(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as temporary:
|
||||
root = Path(temporary)
|
||||
supplied_marker = root / "supplied.marker"
|
||||
ambient_marker = root / "ambient.marker"
|
||||
supplied_bin = root / "supplied-bin"
|
||||
ambient_bin = root / "ambient-bin"
|
||||
write_fake_mosaic(supplied_bin, supplied_marker)
|
||||
write_fake_mosaic(ambient_bin, ambient_marker)
|
||||
|
||||
with mock.patch.dict(os.environ, {"PATH": str(ambient_bin)}):
|
||||
result = VERSION_GATE.default_probe_activation_capability(
|
||||
{"PATH": str(supplied_bin)}
|
||||
)
|
||||
|
||||
self.assertEqual(result, matching_capability())
|
||||
self.assertTrue(supplied_marker.exists())
|
||||
self.assertFalse(ambient_marker.exists())
|
||||
|
||||
def test_absent_or_empty_supplied_path_never_falls_back_or_executes(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as temporary:
|
||||
root = Path(temporary)
|
||||
ambient_marker = root / "ambient.marker"
|
||||
current_directory_marker = root / "current-directory.marker"
|
||||
ambient_bin = root / "ambient-bin"
|
||||
current_directory = root / "current-directory"
|
||||
write_fake_mosaic(ambient_bin, ambient_marker)
|
||||
write_fake_mosaic(current_directory, current_directory_marker)
|
||||
original_directory = Path.cwd()
|
||||
|
||||
try:
|
||||
os.chdir(current_directory)
|
||||
with mock.patch.dict(os.environ, {"PATH": str(ambient_bin)}):
|
||||
for supplied_environment in ({}, {"PATH": ""}):
|
||||
with self.subTest(environ=supplied_environment):
|
||||
result = VERSION_GATE.default_probe_activation_capability(
|
||||
supplied_environment
|
||||
)
|
||||
self.assertIsNone(result)
|
||||
self.assertFalse(ambient_marker.exists())
|
||||
self.assertFalse(current_directory_marker.exists())
|
||||
finally:
|
||||
os.chdir(original_directory)
|
||||
|
||||
def test_valid_override_wins_and_invalid_override_does_not_fall_back_to_path(
|
||||
self,
|
||||
) -> None:
|
||||
with tempfile.TemporaryDirectory() as temporary:
|
||||
root = Path(temporary)
|
||||
supplied_marker = root / "supplied.marker"
|
||||
ambient_marker = root / "ambient.marker"
|
||||
override_marker = root / "override.marker"
|
||||
supplied_bin = root / "supplied-bin"
|
||||
ambient_bin = root / "ambient-bin"
|
||||
override_bin = root / "override-bin"
|
||||
write_fake_mosaic(supplied_bin, supplied_marker)
|
||||
write_fake_mosaic(ambient_bin, ambient_marker)
|
||||
override_executable = write_fake_mosaic(override_bin, override_marker)
|
||||
|
||||
with mock.patch.dict(os.environ, {"PATH": str(ambient_bin)}):
|
||||
result = VERSION_GATE.default_probe_activation_capability(
|
||||
{
|
||||
"PATH": str(supplied_bin),
|
||||
VERSION_GATE.MOSAIC_COMMAND_OVERRIDE_VAR: str(override_executable),
|
||||
}
|
||||
)
|
||||
self.assertEqual(result, matching_capability())
|
||||
self.assertTrue(override_marker.exists())
|
||||
self.assertFalse(supplied_marker.exists())
|
||||
self.assertFalse(ambient_marker.exists())
|
||||
|
||||
override_marker.unlink()
|
||||
result = VERSION_GATE.default_probe_activation_capability(
|
||||
{
|
||||
"PATH": str(supplied_bin),
|
||||
VERSION_GATE.MOSAIC_COMMAND_OVERRIDE_VAR: str(
|
||||
root / "invalid-override" / "mosaic"
|
||||
),
|
||||
}
|
||||
)
|
||||
self.assertIsNone(result)
|
||||
self.assertFalse(override_marker.exists())
|
||||
self.assertFalse(supplied_marker.exists())
|
||||
self.assertFalse(ambient_marker.exists())
|
||||
|
||||
def test_override_command_is_parsed_and_the_probe_subcommand_is_not_double_appended(
|
||||
self,
|
||||
) -> None:
|
||||
@@ -135,6 +244,29 @@ class ProbeActivationCapabilityTest(unittest.TestCase):
|
||||
self.assertEqual(result, {"name": "lease-runtime-activation", "version": 1})
|
||||
self.assertEqual(captured, [["/fake/mosaic", "__lease-capability"]])
|
||||
|
||||
def test_probe_passes_ten_second_timeout_to_runner(self) -> None:
|
||||
captured_argv: list[str] = []
|
||||
captured_kwargs: dict[str, object] = {}
|
||||
|
||||
class FakeCompleted:
|
||||
returncode = 0
|
||||
stdout = '{"name": "lease-runtime-activation", "version": 1}'
|
||||
|
||||
def fake_run(argv: list[str], **kwargs: object) -> FakeCompleted:
|
||||
captured_argv.extend(argv)
|
||||
captured_kwargs.update(kwargs)
|
||||
return FakeCompleted()
|
||||
|
||||
result = VERSION_GATE.default_probe_activation_capability(
|
||||
{VERSION_GATE.MOSAIC_COMMAND_OVERRIDE_VAR: "/fake/mosaic"},
|
||||
run=fake_run,
|
||||
)
|
||||
|
||||
self.assertEqual(result, matching_capability())
|
||||
self.assertEqual(captured_argv, ["/fake/mosaic"])
|
||||
self.assertEqual(captured_kwargs["timeout"], 10.0)
|
||||
self.assertEqual(captured_kwargs["check"], False)
|
||||
|
||||
def test_fails_closed_on_nonzero_exit_malformed_json_and_missing_fields(self) -> None:
|
||||
class NonZeroExit:
|
||||
returncode = 1
|
||||
@@ -174,7 +306,7 @@ class ProbeActivationCapabilityTest(unittest.TestCase):
|
||||
|
||||
def test_fails_closed_on_timeout_and_transport_error(self) -> None:
|
||||
def timeout_run(*_args: object, **_kwargs: object) -> None:
|
||||
raise subprocess.TimeoutExpired(cmd="mosaic", timeout=2.0)
|
||||
raise subprocess.TimeoutExpired(cmd="mosaic", timeout=10.0)
|
||||
|
||||
def oserror_run(*_args: object, **_kwargs: object) -> None:
|
||||
raise OSError("no such file or directory")
|
||||
|
||||
Reference in New Issue
Block a user