Skip to content

Refuse inline entry into the tagged tree; unset PYTHONPATH for release tooling #185

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

Closed
rmcdaniel wants to merge 1 commit into from
Closed

Refuse inline entry into the tagged tree; unset PYTHONPATH for release tooling #185

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
4 changes: 4 additions & 0 deletions scripts/ci/install-release-tooling.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ if [ -z "${GITHUB_PATH:-}" ]; then
exit 2
fi

# -I protects the interpreters started here, but pip runs the target venv
# interpreter as a child that would still read PYTHONPATH.
unset PYTHONPATH

script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
release_tooling_venv="$1"

Expand Down
21 changes: 20 additions & 1 deletion scripts/ci/test-publish-rust-sdk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1269,6 +1269,20 @@ def _step_run(step: str) -> str:
"release": "release-tools/scripts/ci/install-release-tooling.sh",
}

# A step outside the allowlist must not enter the tagged tree inline either.
ENTERS_TAGGED_TREE = re.compile(r"\b(?:cd|pushd)\b[^;&|\n]*release-source")

def test_inline_directory_change_into_the_tagged_tree_is_detected(self) -> None:
for command in ("cd release-source && cargo package", "pushd ./release-source",
'cd "$GITHUB_WORKSPACE/release-source"; python3 -I x.py',
"echo ok; cd -- release-source"):
with self.subTest(command=command):
self.assertRegex(command, self.ENTERS_TAGGED_TREE)
for command in ('head_commit="$(git -C release-source rev-parse HEAD)"',
"cd release-tools && ls release-source"):
with self.subTest(command=command):
self.assertNotRegex(command, self.ENTERS_TAGGED_TREE)

def test_tagged_tree_working_directory_runs_only_maintained_entrypoints(self) -> None:
workflow = RELEASE_WORKFLOW.read_text(encoding="utf-8")
# A defaults block would set a working directory no step declares.
Expand All @@ -1280,6 +1294,8 @@ def test_tagged_tree_working_directory_runs_only_maintained_entrypoints(self) ->
for step in self._steps(job):
directories = re.findall(r"^ working-directory: (.*)$", step, flags=re.MULTILINE)
if not directories:
with self.subTest(job=name, step=step.split("\n", 1)[0]):
self.assertNotRegex(self._step_run(step), self.ENTERS_TAGGED_TREE)
continue
with self.subTest(job=name, step=step.split("\n", 1)[0]):
self.assertEqual(["release-source"], directories)
Expand Down Expand Up @@ -1323,6 +1339,8 @@ def test_isolated_tools_use_the_bootstrapped_pip_client(self) -> None:
#!{sys.executable}
import json, os, pathlib, sys
arguments = sys.argv[1:]
if "PYTHONPATH" in os.environ:
raise SystemExit("PYTHONPATH reached the release tooling interpreter")
with pathlib.Path(os.environ["INSTALLER_CALLS"]).open("a") as handle:
handle.write(json.dumps(arguments) + "\\n")
if arguments[:3] == ["-I", "-m", "venv"]:
Expand All @@ -1338,7 +1356,8 @@ def test_isolated_tools_use_the_bootstrapped_pip_client(self) -> None:
result = subprocess.run(
["bash", str(RELEASE_TOOLING_INSTALLER), str(venv)],
env={**os.environ, "PATH": f"{command_directory}:{os.environ['PATH']}",
"INSTALLER_CALLS": str(calls_file), "GITHUB_PATH": str(github_path)},
"INSTALLER_CALLS": str(calls_file), "GITHUB_PATH": str(github_path),
"PYTHONPATH": str(root / "hostile")},
capture_output=True, text=True, check=False, timeout=10,
)
self.assertEqual(0, result.returncode, result.stderr)
Expand Down