Skip to content
Merged
Changes from all commits
Commits
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
41 changes: 29 additions & 12 deletions .github/scripts/test_reuse_gate.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
from __future__ import annotations

import os
import shutil
import subprocess
import sys
import tempfile
Expand Down Expand Up @@ -121,15 +122,13 @@ class InlineHeaderCheck(unittest.TestCase):

def setUp(self) -> None:
self.tmp = tempfile.mkdtemp(prefix="reuse-gate-test-")
# Register the cleanup before `_init_repo` runs: if git is missing
# or the init call raises for any other reason, `tearDown` would
# not execute and the directory would leak. `addCleanup` runs even
# when `setUp` itself fails partway through.
self.addCleanup(shutil.rmtree, self.tmp, ignore_errors=True)
_init_repo(self.tmp)

def tearDown(self) -> None:
# `mkdtemp` returns a private directory; recursive remove is fine here
# because we created it ourselves in `setUp`.
import shutil

shutil.rmtree(self.tmp, ignore_errors=True)

def test_file_with_both_lines_passes(self) -> None:
_write(
self.tmp,
Expand Down Expand Up @@ -196,14 +195,14 @@ class MainSubprocessCheck(unittest.TestCase):

def setUp(self) -> None:
self.tmp = tempfile.mkdtemp(prefix="reuse-gate-subproc-")
# Register the cleanup before `_init_repo` runs: if git is missing
# or the init call raises for any other reason, `tearDown` would
# not execute and the directory would leak. `addCleanup` runs even
# when `setUp` itself fails partway through.
self.addCleanup(shutil.rmtree, self.tmp, ignore_errors=True)
_init_repo(self.tmp)
self.stub_path = _make_stub_reuse(self.tmp)

def tearDown(self) -> None:
import shutil

shutil.rmtree(self.tmp, ignore_errors=True)

def _run_gate(self, cwd: str) -> subprocess.CompletedProcess[str]:
env = os.environ.copy()
env["REUSE_BIN"] = self.stub_path
Expand Down Expand Up @@ -253,6 +252,24 @@ def test_main_exits_zero_on_clean_repository(self) -> None:
)
self.assertIn("REUSE gate **passed**", proc.stdout)

def test_main_from_subdirectory_still_finds_root_headerless_file(self) -> None:
# When invoked from a subdirectory of the repo, the gate must still
# look at the git root and catch a headerless file there. A plain
# `os.getcwd()` style scan would only see the empty subdirectory and
# silently pass; this case proves `main()` resolves the toplevel.
_write(self.tmp, "ok.go", "// " + _LIC + "\n// " + _CR + "\npackage x\n")
_write(self.tmp, "headerless.go", "package x\n")
subdir = os.path.join(self.tmp, "deep", "nested")
os.makedirs(subdir, exist_ok=True)
_commit(self.tmp)
proc = self._run_gate(subdir)
self.assertEqual(
proc.returncode,
1,
msg=f"stdout=\n{proc.stdout}\nstderr=\n{proc.stderr}",
)
self.assertIn("headerless.go", proc.stdout)


if __name__ == "__main__":
unittest.main()
Loading