Skip to content

Avoid pip cache files in the service checkout #15

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
batteryshark merged 1 commit into from
Oct 26, 2026
Merged

Avoid pip cache files in the service checkout #15

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
3 changes: 2 additions & 1 deletion deploy/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ if [ ! -x "$VENV_PY" ]; then
sudo -u "$SERVICE_USER" python3 -m venv "$REPO_ROOT/admin/.venv"
fi
echo "==> Installing the package + admin dependencies"
sudo -u "$SERVICE_USER" sh -c "cd '$REPO_ROOT' && '$VENV_PIP' install --quiet '.[admin,vault]' -r admin/requirements.txt -c admin/requirements-lock.txt"
# The service account's HOME is the checkout; do not create an untracked .cache there.
sudo -u "$SERVICE_USER" sh -c "cd '$REPO_ROOT' && '$VENV_PIP' install --no-cache-dir --quiet '.[admin,vault]' -r admin/requirements.txt -c admin/requirements-lock.txt"

# 4. State + log dirs (the unit's StateDirectory/ReadWritePaths keep them; pre-create
# so set-password + the SPS audit logger land right instead of crashing on first write)
Expand Down
24 changes: 24 additions & 0 deletions tests/release/test_deployment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,30 @@ def test_all_installers_consume_same_export(self):
self.assertIn('admin/requirements.txt', source)
self.assertIn('admin/requirements-lock.txt', source)

def test_native_installer_disables_pip_cache_in_service_home(self):
# Execute only the dependency-install command with stand-ins, never the
# privileged installer or a real package download/service operation.
source = (ROOT / 'deploy/install.sh').read_text()
command, = [line for line in source.splitlines()
if line.startswith('sudo -u "$SERVICE_USER" sh -c ')]
with tempfile.TemporaryDirectory(prefix='toolstack-install-cache-') as tmp:
home = Path(tmp)
pip = home / 'fake-pip'
pip.write_text('#!/bin/sh\n'
'printf "%s\\n" "$@" > "$HOME/pip-args"\n'
'case " $* " in *" --no-cache-dir "*) ;; '
'*) mkdir -p "$HOME/.cache/pip" ;; esac\n')
pip.chmod(0o700)
subprocess.run(['bash', '-c', 'sudo(){ shift 2; "$@"; }\n' + command],
env={'PATH': '/usr/bin:/bin', 'HOME': tmp, 'REPO_ROOT': tmp,
'SERVICE_USER': 'fake', 'VENV_PIP': str(pip)},
check=True, capture_output=True, text=True, timeout=10)
args = (home / 'pip-args').read_text().splitlines()
self.assertEqual(args[0], 'install')
self.assertIn('--no-cache-dir', args)
self.assertIn('admin/requirements-lock.txt', args)
self.assertFalse((home / '.cache').exists())

def test_private_units_and_no_toml_environmentfile(self):
for component in ('admin', 'sps'):
source = (ROOT / f'deploy/toolstack-{component}.service').read_text()
Expand Down
Loading