didericis
9bf2961d13
test / unit (push) Successful in 57s
test / image-input-builds (push) Successful in 1m2s
Update Quality Badges / update-badges (push) Successful in 1m8s
test / integration-docker (push) Successful in 58s
test / coverage (push) Successful in 15s
lint / lint (push) Failing after 10m9s
The firecracker setup message told users to run
sudo bot-bottle backend setup --backend=firecracker
which fails for exactly the users who followed the documented install. sudo
replaces PATH with sudoers' secure_path — /usr/local/sbin:/usr/local/bin:
/usr/sbin:/usr/bin:/sbin:/bin on Debian and Ubuntu — which deliberately
excludes user-writable directories. Both supported install paths land in one:
pipx uses ~/.local/bin, and install.sh's venv fallback symlinks there. So the
hint works for anyone who installed system-wide and breaks with "command not
found" for everyone else, which is how it survives a read-through.
Add bot_bottle/invocation.py: self_path() resolves the running entry point to
an absolute path, and sudo_command() builds the copy-pasteable form. The one
sudo recommendation in the tree now uses it. Non-sudo hints keep the bare
`bot-bottle`, which is correct — the user reached them by running it.
self_path() falls back to the bare name when argv[0] cannot be resolved (a
`python -m` style invocation), because a slightly wrong hint beats a traceback
raised while reporting some unrelated problem.
Tested behaviourally rather than by scanning source: the first version of the
test grepped the module and failed on the comment explaining why the bare form
is wrong. It now drives _setup_systemd() as non-root and asserts what is
actually printed. Verified the guard bites by restoring the bare form and
watching it fail.
Not verified end to end: this message only prints on the systemd path, so it
is unreachable on macOS, where the rest of this work was tested.
99 lines
4.0 KiB
Python
99 lines
4.0 KiB
Python
"""Unit: how the CLI tells users to re-run it under sudo.
|
|
|
|
`sudo bot-bottle …` is wrong for the users who followed the documented
|
|
install: sudo's secure_path excludes ~/.local/bin, where both pipx and
|
|
install.sh put the entry point. These lock in the absolute-path form.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import contextlib
|
|
import io
|
|
import os
|
|
import tempfile
|
|
import unittest
|
|
from pathlib import Path
|
|
from unittest import mock
|
|
|
|
from bot_bottle import invocation
|
|
|
|
|
|
class TestSelfPath(unittest.TestCase):
|
|
def test_absolute_argv0_is_used_as_is(self):
|
|
with mock.patch.object(invocation.sys, "argv", ["/opt/venv/bin/bot-bottle"]):
|
|
self.assertEqual("/opt/venv/bin/bot-bottle", invocation.self_path())
|
|
|
|
def test_bare_name_is_resolved_through_path(self):
|
|
# The case that matters: invoked as `bot-bottle`, installed in a
|
|
# directory sudo would drop.
|
|
with tempfile.TemporaryDirectory() as d:
|
|
entry = Path(d, "bot-bottle")
|
|
entry.write_text("#!/bin/sh\n")
|
|
entry.chmod(0o755)
|
|
with mock.patch.object(invocation.sys, "argv", ["bot-bottle"]), \
|
|
mock.patch.dict(os.environ, {"PATH": d}):
|
|
self.assertEqual(str(entry), invocation.self_path())
|
|
|
|
def test_relative_path_is_made_absolute(self):
|
|
with tempfile.TemporaryDirectory() as d:
|
|
entry = Path(d, "bot-bottle")
|
|
entry.write_text("#!/bin/sh\n")
|
|
entry.chmod(0o755)
|
|
cwd = os.getcwd()
|
|
try:
|
|
os.chdir(d)
|
|
with mock.patch.object(invocation.sys, "argv", ["./bot-bottle"]):
|
|
self.assertTrue(os.path.isabs(invocation.self_path()))
|
|
finally:
|
|
os.chdir(cwd)
|
|
|
|
def test_unresolvable_entry_point_falls_back_to_the_name(self):
|
|
# `python -m`-style invocation, or an argv[0] that no longer exists.
|
|
# A slightly wrong hint beats a traceback raised while reporting some
|
|
# unrelated problem.
|
|
with mock.patch.object(invocation.sys, "argv", ["/nonexistent/gone"]), \
|
|
mock.patch.object(invocation.shutil, "which", return_value=None):
|
|
self.assertEqual("/nonexistent/gone", invocation.self_path())
|
|
with mock.patch.object(invocation.sys, "argv", [""]), \
|
|
mock.patch.object(invocation.shutil, "which", return_value=None):
|
|
self.assertEqual("bot-bottle", invocation.self_path())
|
|
|
|
|
|
class TestSudoCommand(unittest.TestCase):
|
|
def test_names_an_absolute_path_not_the_bare_command(self):
|
|
with mock.patch.object(invocation, "self_path",
|
|
return_value="/home/u/.local/bin/bot-bottle"):
|
|
cmd = invocation.sudo_command("backend", "setup", "--backend=firecracker")
|
|
self.assertEqual(
|
|
"sudo /home/u/.local/bin/bot-bottle backend setup --backend=firecracker",
|
|
cmd,
|
|
)
|
|
# The regression this exists to prevent.
|
|
self.assertNotIn("sudo bot-bottle", cmd)
|
|
|
|
|
|
class TestFirecrackerSetupUsesIt(unittest.TestCase):
|
|
def test_root_reinvocation_hint_names_an_absolute_path(self):
|
|
# The message that prompted all this. Drive the real code path rather
|
|
# than scanning the source, which would also match the comment
|
|
# explaining why the bare form is wrong.
|
|
from bot_bottle.backend.firecracker import setup as fc_setup
|
|
|
|
err, out = io.StringIO(), io.StringIO()
|
|
with mock.patch.object(fc_setup.os, "geteuid", return_value=501), \
|
|
mock.patch.object(fc_setup.invocation, "self_path",
|
|
return_value="/home/u/.local/bin/bot-bottle"), \
|
|
contextlib.redirect_stderr(err), contextlib.redirect_stdout(out):
|
|
fc_setup._setup_systemd()
|
|
|
|
printed = err.getvalue()
|
|
self.assertIn(
|
|
"sudo /home/u/.local/bin/bot-bottle backend setup --backend=firecracker",
|
|
printed,
|
|
)
|
|
self.assertNotIn("sudo bot-bottle", printed)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|