diff --git a/.prettierrc.json b/.prettierrc.json deleted file mode 100644 index 0967ef4..0000000 --- a/.prettierrc.json +++ /dev/null @@ -1 +0,0 @@ -{} diff --git a/scripts/admin/setup_repo.sh b/scripts/admin/setup_repo.sh index 0c88697..b72a126 100755 --- a/scripts/admin/setup_repo.sh +++ b/scripts/admin/setup_repo.sh @@ -104,18 +104,34 @@ J ) upsert_ruleset() { - local id - id=$(gh api "repos/$REPO/rulesets" --jq ".[] | select(.name==\"$1\") | .id") - if [ -n "$id" ]; then - echo "$2" | gh api -X PUT "repos/$REPO/rulesets/$id" --input - >/dev/null + local ids + # This repo's own rulesets only: an org ruleset with the same name can't be updated from here. + mapfile -t ids < <(gh api --paginate "repos/$REPO/rulesets?includes_parents=false" \ + --jq ".[] | select(.name==\"$1\") | .id" | sort -n) + if [ "${#ids[@]}" -gt 1 ]; then + # Deleting a ruleset is a call to make by hand, so update the oldest and say which others exist. + echo "warning: ${#ids[@]} rulesets are named $1 (ids ${ids[*]}); updating ${ids[0]}, delete the rest by hand" >&2 + fi + if [ "${#ids[@]}" -gt 0 ]; then + echo "$2" | gh api -X PUT "repos/$REPO/rulesets/${ids[0]}" --input - >/dev/null else echo "$2" | gh api -X POST "repos/$REPO/rulesets" --input - >/dev/null fi } upsert_ruleset main-protection "$RULESET" upsert_ruleset release-tags "$TAG_RULESET" -# Last: fails while the org forbids Actions approving PRs (org setting). -gh api -X PUT "repos/$REPO/actions/permissions/workflow" \ +# The org setting caps this one: while the org forbids Actions approving PRs, GitHub refuses it. +if ! gh api -X PUT "repos/$REPO/actions/permissions/workflow" \ -f default_workflow_permissions=read \ - -F can_approve_pull_request_reviews=true >/dev/null + -F can_approve_pull_request_reviews=true >/dev/null 2>&1; then + org=$(gh api "orgs/${REPO%%/*}/actions/permissions/workflow" --jq .can_approve_pull_request_reviews 2>/dev/null || true) + if [ "$org" != false ]; then + echo "error: could not set the repo's Actions workflow permissions" >&2 + exit 1 + fi + # Still make the default token read-only; only the approval part waits on the org. + gh api -X PUT "repos/$REPO/actions/permissions/workflow" -f default_workflow_permissions=read >/dev/null + echo "note: the ${REPO%%/*} org doesn't let GitHub Actions approve pull requests, so auto-approve.yml can't" >&2 + echo " approve bot PRs yet. Allow it under the org's Settings > Actions > General, then run this again." >&2 +fi echo "done" diff --git a/scripts/tests/test_setup_repo.py b/scripts/tests/test_setup_repo.py new file mode 100755 index 0000000..c14761e --- /dev/null +++ b/scripts/tests/test_setup_repo.py @@ -0,0 +1,77 @@ +import json +import os +import stat +import subprocess +import tempfile +import unittest +from pathlib import Path + +ROOT = Path(__file__).resolve().parents[2] +SCRIPT = ROOT / "scripts/admin/setup_repo.sh" + +# Stands in for gh: logs each call, and answers the ruleset lookup and the org setting from the environment. +FAKE_GH = """#!/usr/bin/env python3 +import json, os, sys +a = sys.argv[1:] +if "--input" in a: + sys.stdin.read() +with open(os.environ["GH_LOG"], "a") as f: + f.write(json.dumps(a) + "\\n") +path = next((x for x in a if x.startswith(("repos/", "orgs/"))), "") +if "rulesets?includes_parents=false" in path: + ids = os.environ.get("IDS_" + ("release" if "release-tags" in a[-1] else "main"), "") + if ids: # like gh --jq: nothing at all when nothing matches + print(ids.replace(",", "\\n")) +elif path.startswith("orgs/"): + print(os.environ.get("ORG_APPROVE", "true")) +elif "can_approve_pull_request_reviews=true" in a and ( + os.environ.get("ORG_APPROVE") == "false" or os.environ.get("FAIL_WORKFLOW")): + sys.exit(1) +""" + + +class SetupRepoTest(unittest.TestCase): + def run_script(self, **env): + with tempfile.TemporaryDirectory() as d: + gh = Path(d) / "gh" + gh.write_text(FAKE_GH) + gh.chmod(gh.stat().st_mode | stat.S_IEXEC) + log = Path(d) / "log" + log.touch() + p = subprocess.run(["bash", str(SCRIPT)], capture_output=True, text=True, + env={**os.environ, "PATH": f"{d}:{os.environ['PATH']}", "GH_LOG": str(log), **env}) + return p, [json.loads(line) for line in log.read_text().splitlines()] + + @staticmethod + def ruleset_writes(calls): + return [(c[2], c[3]) for c in calls if c[:2] == ["api", "-X"] and "/rulesets" in c[3]] + + def test_clean_run(self): + p, calls = self.run_script(IDS_main="11") + self.assertEqual((p.returncode, p.stdout, p.stderr), (0, "done\n", "")) + self.assertEqual(self.ruleset_writes(calls), [("PUT", "repos/devstreamhq/devstream/rulesets/11"), + ("POST", "repos/devstreamhq/devstream/rulesets")]) + + def test_duplicate_rulesets_update_the_oldest_and_warn(self): + p, calls = self.run_script(IDS_main="14,11", IDS_release="20") + self.assertEqual(p.returncode, 0) + self.assertIn("2 rulesets are named main-protection (ids 11 14); updating 11", p.stderr) + self.assertEqual(self.ruleset_writes(calls), [("PUT", "repos/devstreamhq/devstream/rulesets/11"), + ("PUT", "repos/devstreamhq/devstream/rulesets/20")]) + + def test_org_blocking_approvals_is_a_note_not_a_failure(self): + p, calls = self.run_script(ORG_APPROVE="false") + self.assertEqual((p.returncode, p.stdout), (0, "done\n")) + self.assertIn("doesn't let GitHub Actions approve pull requests", p.stderr) + # The read-only default token is still set, without the approval part. + self.assertEqual(calls[-1], ["api", "-X", "PUT", "repos/devstreamhq/devstream/actions/permissions/workflow", + "-f", "default_workflow_permissions=read"]) + + def test_other_permission_failures_still_fail(self): + p, _ = self.run_script(FAIL_WORKFLOW="1") + self.assertEqual((p.returncode, p.stdout), (1, "")) + self.assertIn("could not set the repo's Actions workflow permissions", p.stderr) + + +if __name__ == "__main__": + unittest.main()