From d004fd272c399e10f8398c2a112bad74b9ed033e Mon Sep 17 00:00:00 2001 From: clawbot <35+clawbot@noreply.example.org> Date: Wed, 18 Nov 2026 23:23:50 +0100 Subject: [PATCH] Replace script/update-policy with a short wget-and-commit script (closes #165) The script fetches a fixed list of three files from the main branch of prompts with wget: docs/REPO_POLICIES.md, docs/CODE_STYLEGUIDE.md and itself. It moves them into place and commits them. It does not push. It stops before anything is replaced when a fetch fails, when a listed file has uncommitted changes, and when REPO_POLICIES.md is still at the repo root. It runs under busybox. The line-keeping rules, the hash argument and the push are gone. The policies and checklists say so, and name docs/REPO_POLICIES.md as the file's place. Model: opus-5-5 --- README.md | 6 +- prompts/EXISTING_REPO_CHECKLIST.md | 13 +- prompts/NEW_REPO_CHECKLIST.md | 9 +- prompts/REPO_POLICIES.md | 26 +- script/update-policy | 233 ++--------- test/update-policy.sh | 619 ++++------------------------- 6 files changed, 135 insertions(+), 771 deletions(-) diff --git a/README.md b/README.md index 02e3f61..5b349b6 100644 --- a/README.md +++ b/README.md @@ -138,9 +138,9 @@ alpine. We provide: `script/check` - `script/install-precommit` — installs the git pre-commit hook (our own extension); `make hooks` shims to it -- `script/update-policy` — fetch the vendored policy files from this repo, - commit them and push (our own extension); it is for the repos that vendor them - and stops when run here +- `script/update-policy` — fetch the shared policy files from this repo and + commit them, without pushing (our own extension); it is for the repos that + carry them and stops when run here `make hooks` installs the pre-commit hook that runs `script/precommit`. diff --git a/prompts/EXISTING_REPO_CHECKLIST.md b/prompts/EXISTING_REPO_CHECKLIST.md index 9d7ad20..cf4e908 100644 --- a/prompts/EXISTING_REPO_CHECKLIST.md +++ b/prompts/EXISTING_REPO_CHECKLIST.md @@ -1,6 +1,6 @@ --- title: Existing Repo Checklist -last_modified: 2026-11-16 +last_modified: 2026-11-18 --- Use this checklist when beginning work in a repo that may not yet conform to our @@ -22,7 +22,7 @@ with your task. - [ ] `README.md` exists with all required sections (Description, Getting Started, Rationale, Design, TODO, License, Author) - [ ] `LICENSE` file exists and matches the README -- [ ] `REPO_POLICIES.md` exists and version date is current — fetch from +- [ ] `docs/REPO_POLICIES.md` exists and version date is current — fetch from `https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md` - [ ] Guidance for coding agents, if the repo has any, is one `AGENTS.md` at the root — never a file or directory named after one agent tool, such as @@ -196,14 +196,7 @@ with your task. - [ ] `script/precommit` exists and the pre-commit hook (installed by `script/install-precommit`, shimmed by `make hooks`) runs it - [ ] `script/update-policy` exists, identical to the model script, and - `make update-policy` shims to it. Before its first use, the repo's own - entries in `.gitignore`, `.editorconfig` and `.dockerignore` go below the - comment that ends each canonical file. An entry above that comment which - the canonical file has never held makes the script stop before it writes - anything, naming the file and the entry. It stops the same way on a line - in `.golangci.yml` that the canonical file has never held, apart from - comments and the repo's entries in the `deny` list of the `test-support` - rule. + `make update-policy` shims to it - [ ] README has an **Entrypoints** section documenting the `script/` entrypoints and linking the standard - [ ] `script/lint` and `script/test` each run diff --git a/prompts/NEW_REPO_CHECKLIST.md b/prompts/NEW_REPO_CHECKLIST.md index b7a6a25..aa58346 100644 --- a/prompts/NEW_REPO_CHECKLIST.md +++ b/prompts/NEW_REPO_CHECKLIST.md @@ -1,6 +1,6 @@ --- title: New Repo Checklist -last_modified: 2026-11-16 +last_modified: 2026-11-18 --- Use this checklist when creating a new repository from scratch. Follow the steps @@ -55,7 +55,7 @@ Template files can be fetched from: ## Create Project Files - [ ] `LICENSE` file matching the chosen license -- [ ] `REPO_POLICIES.md` — fetch from +- [ ] `docs/REPO_POLICIES.md` — fetch from `https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md` - [ ] Guidance for coding agents, if the repo has any, is one `AGENTS.md` at the root — never a file or directory named after one agent tool, such as @@ -248,9 +248,8 @@ are thin shims calling them. Model scripts: - [ ] `script/install-precommit` — installs the pre-commit hook that runs `script/precommit` - [ ] `make hooks` — shims to `script/install-precommit` -- [ ] `script/update-policy` / `make update-policy` — fetches the vendored - policy files from the `prompts` repo, commits them and pushes; identical - across repos +- [ ] `script/update-policy` / `make update-policy` — fetches the shared policy + files from the `prompts` repo and commits them; identical across repos - [ ] README **Entrypoints** section documents the scripts and links the standard diff --git a/prompts/REPO_POLICIES.md b/prompts/REPO_POLICIES.md index c311511..1416ad6 100644 --- a/prompts/REPO_POLICIES.md +++ b/prompts/REPO_POLICIES.md @@ -1,6 +1,6 @@ --- title: Repository Policies -last_modified: 2026-11-16 +last_modified: 2026-11-18 --- This document covers repository structure, tooling, and workflow standards. Code @@ -106,8 +106,8 @@ style conventions are in separate documents: `script/fmt-check`. - `make docker`: `script/docker` - `make hooks`: `script/install-precommit` installs the git pre-commit hook. - - `make update-policy`: `script/update-policy` fetches the vendored policy - files from the `prompts` repo, commits them and pushes. + - `make update-policy`: `script/update-policy` fetches the shared policy + files from the `prompts` repo and commits them. Three more scripts have no required target: - `script/precommit` is what the pre-commit hook runs. It calls @@ -156,16 +156,13 @@ style conventions are in separate documents: new contributor should be able to understand the entire development workflow by reading the Makefile. -- A repo updates its policy files with one command: `make update-policy`. It - runs `script/update-policy`, which fetches each vendored file the repo carries - from the `prompts` repo, commits them and pushes. It uses the head of `main`, - or the commit given by a full hash: `script/update-policy `. The list of - vendored files is at the top of that script. The script replaces each file and - keeps only the repo's own entries: - - in `.gitignore`, `.editorconfig` and `.dockerignore`: the lines below the - comment that ends the canonical file - - in `.golangci.yml`: the entries the repo added to the `deny` list of the - `test-support` depguard rule +- A repo updates its shared policy files with one command: `make update-policy`. + It runs `script/update-policy`, which fetches each file from the `main` branch + of the `prompts` repo and commits them. It does not push: review the commit, + then push it. The script lists the files at its top: + - `docs/REPO_POLICIES.md` + - `docs/CODE_STYLEGUIDE.md` + - `script/update-policy` itself, so the script stays current # Tests and checks @@ -881,7 +878,6 @@ style conventions are in separate documents: - `LICENSE` - `.gitignore` - `.editorconfig` - - `REPO_POLICIES.md` - language-specific config Everything else goes in a subdirectory. Canonical subdirectory names: @@ -905,7 +901,7 @@ style conventions are in separate documents: - New repos must contain at minimum: - `README.md`, `.git`, `.gitignore`, `.editorconfig` - - `LICENSE`, `REPO_POLICIES.md` (copy from the `prompts` repo) + - `LICENSE`, `docs/REPO_POLICIES.md` (copy from the `prompts` repo) - `Makefile` - `script/` entrypoints (`bootstrap`, `setup`, `projectname`, `test`, `lint`, `fmt`, `fmt-check`, `check`, `docker`, `cibuild`, `precommit`, diff --git a/script/update-policy b/script/update-policy index eaf4bea..fc78ab2 100755 --- a/script/update-policy +++ b/script/update-policy @@ -1,43 +1,17 @@ #!/bin/sh -# script/update-policy: replace this repo's vendored policy files with -# the canonical ones from the prompts repo, commit them and push. -# Identical in all repos. Our own extension to -# scripts-to-rule-them-all. -# -# Usage: script/update-policy [full commit hash of prompts] -# Without a hash it uses the head of the prompts main branch. -# -# The script writes nothing until every file has been fetched and -# merged. A repo's own entries are kept: -# - .gitignore, .editorconfig, .dockerignore: the lines below the -# canonical file's last line. An entry above that line which the -# canonical file has never held stops the script. -# - .golangci.yml: the entries the repo added to the deny list of the -# test-support rule. Any other line the canonical file has never -# held stops the script, unless it is blank or a comment. +# script/update-policy: replace the files below with their current +# versions from the main branch of the prompts repo, and commit them. It +# does not push. Identical in all repos, and it updates itself. set -eu ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" -PROMPTS_URL="https://git.eeqj.de/sneak/prompts" +RAW_URL="https://git.eeqj.de/sneak/prompts/raw/branch/main" -# Paths in the prompts repo. A file this repo does not carry is skipped. -VENDORED_FILES=" -.dockerignore -.editorconfig -.gitea/workflows/check.yml -.gitignore -.golangci.yml -.prettierrc -prompts/API_POLICIES.md -prompts/CODE_STYLEGUIDE.md -prompts/CODE_STYLEGUIDE_GO.md -prompts/CODE_STYLEGUIDE_JS.md -prompts/CODE_STYLEGUIDE_PYTHON.md -prompts/EXISTING_REPO_CHECKLIST.md -prompts/GO_HTTP_SERVER_CONVENTIONS.md -prompts/LLM_PROSE_TELLS.md -prompts/NEW_REPO_CHECKLIST.md -prompts/REPO_POLICIES.md +# Each entry is the path in prompts, a colon, then the path in this repo. +FILES=" +prompts/REPO_POLICIES.md:docs/REPO_POLICIES.md +prompts/CODE_STYLEGUIDE.md:docs/CODE_STYLEGUIDE.md +script/update-policy:script/update-policy " die() { @@ -45,178 +19,45 @@ die() { exit 1 } -# local_path : print where this repo keeps the file, or -# nothing if git does not track it here. A prompts/NAME.md lands at -# docs/NAME.md or NAME.md. -local_path() { - name="${1#prompts/}" - if [ "$name" != "$1" ] && [ -n "$(git ls-files -- "docs/$name")" ]; then - echo "docs/$name" - elif [ -n "$(git ls-files -- "$name")" ]; then - echo "$name" - fi -} - -# local_only_lines [end]: print each line of the local -# file, above line end if given, that the canonical file has never held: -# not in the fetched file or in .former, the lines earlier -# commits removed from it. Blank lines and comments do not count. -local_only_lines() { - cat "$1" "$1.former" | awk -v end="${3:-}" ' - NR == FNR { held[$0]; next } - (end == "" || FNR < end) && !/^[ \t]*(#|$)/ && !($0 in held) - ' - "$2" -} - -# keep_lines_below_last : append to the fetched file -# whatever follows its last line in the local file. Stop if the canonical -# file has never held a line above that one, unless it is blank or a -# comment: replacing the file would delete it. -keep_lines_below_last() { - last="$(tail -n 1 "$1")" - number="$(grep -n -F -x -- "$last" "$2" | head -n 1 | cut -d: -f1)" - if [ -z "$last" ] || [ -z "$number" ]; then - die "$2 lacks this line; add it and put the repo's own entries below it: $last" - fi - own="$(local_only_lines "$1" "$2" "$number")" - if [ -n "$own" ]; then - die "$2 has entries above its last canonical line that the canonical file lacks; move each below that line to keep it, or delete it: -$own" - fi - tail -n "+$((number + 1))" "$2" >> "$1" -} - -# keep_deny_entries : add to the deny list of the -# test-support rule in the fetched file the entries only the local file -# has. An entry is a "- pkg:" line, the lines under it and any comment -# above it. Stop if the local file still has a line that neither the -# result nor the canonical file has ever held, unless it is blank or a -# comment: replacing the file would delete it. -keep_deny_entries() { - awk ' - function indent(line) { return match(line, /[^ ]/) - 1 } - function print_local_entries(i) { - for (i = 1; i <= count; i++) - if (!(pkg[i] in fetched_pkg)) - printf "%s", entry[i] - } - - FNR == 1 { in_rule = 0; in_list = 0 } - - in_list && /[^ ]/ && indent($0) <= list_indent { - in_list = 0 - if (FILENAME == ARGV[2]) print_local_entries() - } - - in_list { - is_entry = ($1 == "-" && $2 == "pkg:") - if (FILENAME == ARGV[2]) { - if (is_entry) fetched_pkg[$3] - print - } else if (is_entry) { - count++ - pkg[count] = $3 - entry[count] = comment $0 "\n" - comment = "" - } else if (/^ *#/) { - comment = comment $0 "\n" - } else if (count) { - entry[count] = entry[count] $0 "\n" - } - next - } - - in_rule && /^ *[^ #]/ && indent($0) <= rule_indent { in_rule = 0 } - /^ *test-support:/ { in_rule = 1; rule_indent = indent($0) } - in_rule && /^ *deny:/ { - in_rule = 0 - in_list = 1 - list_indent = indent($0) - if (FILENAME == ARGV[2]) found = 1 - } - FILENAME == ARGV[2] { print } - - END { - if (in_list) print_local_entries() - exit !found - } - ' "$2" "$1" > "$1.merged" || - die "the fetched $2 has no deny list in its test-support rule" - mv "$1.merged" "$1" - own="$(local_only_lines "$1" "$2")" - if [ -n "$own" ]; then - die "$2 has lines the canonical file has never held; only the deny list of the test-support rule may differ from canonical: -$own" - fi -} - main() { cd "$ROOT" + [ ! -e prompts/REPO_POLICIES.md ] || + die "this is the prompts repo, where these files come from" + [ ! -e REPO_POLICIES.md ] || + die "REPO_POLICIES.md is at the root;" \ + "move it into docs/ with git mv and fix the links to it first" - [ "$#" -le 1 ] || die "usage: script/update-policy [full commit hash]" + paths="" + for entry in $FILES; do + paths="$paths ${entry#*:}" + done + [ -z "$(git status --porcelain -- $paths)" ] || + die "commit or discard your changes to these files first:$paths" - project="$(script/projectname)" - if [ "$project" = "prompts" ]; then - die "this repo is the source of the policy files" - fi - - commit="${1:-}" - if [ -z "$commit" ]; then - head_line="$(git ls-remote "$PROMPTS_URL.git" refs/heads/main)" - commit="${head_line%%[[:space:]]*}" - fi - printf '%s\n' "$commit" | grep -Eqx '[0-9a-f]{40}' || - die "not a full commit hash: '$commit'" - - tmp="$(mktemp -d)" + # Every file is fetched before any is replaced. The temporary + # directory is inside the repo so that mv renames: the running script + # is replaced by a new file, never rewritten in place. + tmp="$(mktemp -d "$ROOT/.update-policy.XXXXXX")" trap 'rm -rf "$tmp"' EXIT - - git clone --quiet --bare "$PROMPTS_URL.git" "$tmp/prompts.git" || - die "cannot clone $PROMPTS_URL.git" - - carried="" - for file in $VENDORED_FILES; do - path="$(local_path "$file")" - [ -n "$path" ] || continue - if [ -n "$(git status --porcelain -- "$path")" ]; then - die "$path has uncommitted changes" - fi - mkdir -p "$tmp/$(dirname "$path")" - curl --fail --silent --show-error --max-time 60 \ - --output "$tmp/$path" \ - "$PROMPTS_URL/raw/commit/$commit/$file" || - die "cannot fetch $file at $commit" - git -C "$tmp/prompts.git" log -p --format= "$commit" -- "$file" | - sed -n 's/^-//p' > "$tmp/$path.former" - carried="$carried $path" + for entry in $FILES; do + mkdir -p "$tmp/$(dirname "${entry#*:}")" + wget -q -T 60 -O "$tmp/${entry#*:}" "$RAW_URL/${entry%%:*}" || + die "cannot fetch $RAW_URL/${entry%%:*}" done - [ -n "$carried" ] || die "this repo carries none of the vendored files" + chmod 755 "$tmp/script/update-policy" - for path in $carried; do - case "$path" in - .gitignore | .editorconfig | .dockerignore) - keep_lines_below_last "$tmp/$path" "$path" - ;; - .golangci.yml) - keep_deny_entries "$tmp/$path" "$path" - ;; - esac + for path in $paths; do + mkdir -p "$(dirname "$path")" + mv "$tmp/$path" "$path" done - for path in $carried; do - cp "$tmp/$path" "$path" - git add -- "$path" - done - - if git diff --cached --quiet -- $carried; then - echo "update-policy: already at prompts $commit, nothing to commit" + git add -- $paths + if git diff --cached --quiet -- $paths; then + echo "update-policy: already current, nothing to commit" else - git commit -m "Update policy files from prompts $commit" -- $carried + git commit -q -m "Update policy files from prompts" -- $paths + echo "update-policy: committed; review it, then push" fi - - # Also pushes when there was nothing to commit, so a run after a - # failed push delivers the commit that push left behind. - git push origin HEAD || die "push failed; fix that and run this again" } main "$@" diff --git a/test/update-policy.sh b/test/update-policy.sh index 08bdee5..2117218 100755 --- a/test/update-policy.sh +++ b/test/update-policy.sh @@ -1,14 +1,14 @@ #!/bin/sh -# test/update-policy.sh: test script/update-policy on throwaway repos. -# Each scenario gets one temp directory holding a repo, its local bare -# origin, a local git repository of the canonical files in place of -# prompts, and a stub curl that serves them, so nothing touches the -# network. +# test/update-policy.sh: test script/update-policy on throwaway repos. A +# stub wget serves the files from this checkout, or fails for the path +# in WGET_FAIL, so nothing touches the network. Like wget, it writes a +# new file without the execute bit, whatever the source's mode. set -eu -UPDATE_POLICY="$(cd "$(dirname "$0")/.." && pwd -P)/script/update-policy" +PROMPTS="$(cd "$(dirname "$0")/.." && pwd -P)" +LISTED="docs/REPO_POLICIES.md docs/CODE_STYLEGUIDE.md script/update-policy" -dir="" +dir="$(mktemp -d)" trap 'rm -rf "$dir"' EXIT fail() { @@ -17,551 +17,86 @@ fail() { exit 1 } -write_stub_curl() { - mkdir "$dir/bin" - cat > "$dir/bin/curl" << 'EOF' +mkdir "$dir/bin" +cat > "$dir/bin/wget" << EOF #!/bin/sh -previous="" -fail_flag="" -for argument in "$@"; do - [ "$previous" = "--output" ] && output="$argument" - [ "$argument" = "--fail" ] && fail_flag=yes - previous="$argument" +while [ "\$#" -gt 1 ]; do + [ "\$1" = "-O" ] && output="\$2" + shift done -url="$previous" -base="https://git.eeqj.de/sneak/prompts/raw/commit/$HASH/" -path="${url#"$base"}" -source="$(dirname "$0")/../canonical/$path" -if [ "$path" = "$url" ] || [ ! -f "$source" ]; then - [ -n "$fail_flag" ] && exit 22 - echo "404 page not found" > "$output" - exit 0 -fi -cp "$source" "$output" +path="\${1#https://git.eeqj.de/sneak/prompts/raw/branch/main/}" +[ "\$path" != "\${WGET_FAIL:-}" ] || exit 1 +cat "$PROMPTS/\$path" > "\$output" EOF - chmod +x "$dir/bin/curl" -} +chmod +x "$dir/bin/wget" +PATH="$dir/bin:$PATH" +export PATH -write_canonical_files() { - mkdir -p "$dir/canonical/prompts" - cat > "$dir/canonical/.gitignore" << 'EOF' -*.log -*.tmp - -# Own entries go below this comment. -EOF - cat > "$dir/canonical/.dockerignore" << 'EOF' -**/*.log -**/*.tmp - -# Own entries go below this comment. -EOF - cat > "$dir/canonical/.editorconfig" << 'EOF' -root = true -[*] -indent_size = 4 - -# Own sections go below this comment. -EOF - cat > "$dir/canonical/.golangci.yml" << 'EOF' -linters: - settings: - depguard: - rules: - test-support: - deny: - - pkg: net/http/httptest - desc: canonical - - pkg: net/http/cgi - desc: added canonically - other: - deny: - - pkg: example.com/other -EOF - echo '{ "tabWidth": 4 }' > "$dir/canonical/.prettierrc" - echo "new policy" > "$dir/canonical/prompts/REPO_POLICIES.md" - echo "new api policy" > "$dir/canonical/prompts/API_POLICIES.md" -} - -# commit_canonical: commit the canonical files as they stand. The stub -# curl serves only the newest commit; every other commit gets a 404. -commit_canonical() { - git -C "$dir/canonical" add .gitignore .dockerignore .editorconfig \ - .golangci.yml .prettierrc prompts - git -C "$dir/canonical" commit -q -m "Canonical" - HASH="$(git -C "$dir/canonical" rev-parse HEAD)" -} - -# write_outdated_files: this repo's files, one canonical version behind, -# with the repo's own entries in the places the script keeps them. The -# comment above the closing comment in .gitignore is replaced, not kept. -write_outdated_files() { - cat > "$dir/repo/.gitignore" << 'EOF' -*.log - -# An outdated comment. -# Own entries go below this comment. -/myapp -EOF - cat > "$dir/repo/.dockerignore" << 'EOF' -**/*.log - -# Own entries go below this comment. -/myapp -EOF - cat > "$dir/repo/.editorconfig" << 'EOF' -root = true -[*] - -# Own sections go below this comment. -[*.py] -indent_size = 2 -EOF - cat > "$dir/repo/.golangci.yml" << 'EOF' -linters: - settings: - depguard: - rules: - test-support: - deny: - - pkg: net/http/httptest - desc: canonical - # Our own test helpers. - - pkg: example.com/app/internal/apptest - desc: own entry - other: - deny: - - pkg: example.com/other -EOF - echo '{ "tabWidth": 2 }' > "$dir/repo/.prettierrc" - echo "old policy" > "$dir/repo/REPO_POLICIES.md" -} - -# start_scenario : make a new temp directory holding a repo with -# the outdated files, not yet committed, and an empty origin. -start_scenario() { +# new_repo: a repo with one commit, holding only an older copy of the +# script that is shorter than the new one. A run that rewrote the running +# script in place, instead of replacing it, would then read the new +# file's last lines as commands and fail. +new_repo() { scenario="$1" - rm -rf "$dir" - dir="$(mktemp -d)" - : > "$dir/output" - write_stub_curl - write_canonical_files - - # git clone reads no repo's own config, so the setting that points - # git at the local canonical repository has to be in this file. - export GIT_CONFIG_GLOBAL="$dir/gitconfig" - git config --global user.name "Test" - git config --global user.email "test@example.com" - git config --global "url.$dir/canonical.insteadOf" \ - "https://git.eeqj.de/sneak/prompts.git" - - git init -q -b main "$dir/canonical" - export HASH - commit_canonical - - git init -q --bare -b main "$dir/origin.git" - git init -q -b main "$dir/repo" - git -C "$dir/repo" remote add origin "$dir/origin.git" - - mkdir "$dir/repo/script" - cp "$UPDATE_POLICY" "$dir/repo/script/update-policy" - printf '#!/bin/sh\necho example\n' > "$dir/repo/script/projectname" - chmod +x "$dir/repo/script/projectname" - write_outdated_files + rm -rf "$dir/repo" + git init -q "$dir/repo" + cd "$dir/repo" + git config user.name test + git config user.email test@example.com + mkdir script + grep -v '^# ' "$PROMPTS/script/update-policy" > script/update-policy + chmod +x script/update-policy + echo own > README.md + git add README.md script/update-policy + git commit -q -m initial } -# commit_and_push_fixture : commit those paths, remove the -# rest of the outdated files, and record the commit as $before. -commit_and_push_fixture() { - ( - cd "$dir/repo" - git add script "$@" - git commit -q -m "Fixture" - git push -q origin HEAD - git clean -q -f -x - ) - before="$(git -C "$dir/repo" rev-parse HEAD)" -} +new_repo "a first run writes and commits exactly the listed files" +echo stray > stray.txt +echo staged >> README.md +git add README.md +script/update-policy > "$dir/output" 2>&1 || fail "exited non-zero" +[ "$(git rev-list --count HEAD)" = 2 ] || fail "made no single commit" +[ "$(git show --name-only --format= HEAD | sort)" = \ + "$(echo "$LISTED" | tr ' ' '\n' | sort)" ] || fail "commit holds other files" +cmp -s docs/REPO_POLICIES.md "$PROMPTS/prompts/REPO_POLICIES.md" || + fail "REPO_POLICIES.md differs" +[ -x script/update-policy ] || fail "script not executable" +[ "$(git status --porcelain)" = "$(printf 'M README.md\n?? stray.txt')" ] || + fail "changed files outside the list" -run_update_policy() { - status=0 - (cd "$dir/repo" && PATH="$dir/bin:$PATH" script/update-policy "$@") \ - > "$dir/output" 2>&1 || status=$? -} +scenario="a second run commits nothing" +script/update-policy > "$dir/output" 2>&1 || fail "exited non-zero" +[ "$(git rev-list --count HEAD)" = 2 ] || fail "made a commit" +grep -q "nothing to commit" "$dir/output" || fail "did not say so" -reject_pushes() { - printf '#!/bin/sh\nexit 1\n' > "$dir/origin.git/hooks/pre-receive" - chmod +x "$dir/origin.git/hooks/pre-receive" -} +new_repo "a failed fetch writes nothing" +WGET_FAIL=prompts/CODE_STYLEGUIDE.md script/update-policy > "$dir/output" 2>&1 && + fail "exited zero" +grep -q "cannot fetch" "$dir/output" || fail "did not say cannot fetch" +[ ! -e docs ] || fail "wrote docs/" +[ -z "$(git status --porcelain)" ] || fail "tree changed" -accept_pushes() { - rm "$dir/origin.git/hooks/pre-receive" -} +new_repo "an uncommitted change to a listed file stops the script" +mkdir docs +echo mine > docs/REPO_POLICIES.md +script/update-policy > "$dir/output" 2>&1 && fail "exited zero" +[ "$(cat docs/REPO_POLICIES.md)" = mine ] || fail "overwrote the change" -head_of_repo() { - git -C "$dir/repo" rev-parse HEAD -} +new_repo "a REPO_POLICIES.md at the root stops the script" +echo old > REPO_POLICIES.md +git add REPO_POLICIES.md +git commit -q -m "root policy file" +script/update-policy > "$dir/output" 2>&1 && fail "exited zero" +grep -q "git mv" "$dir/output" || fail "did not say to move it" +[ ! -e docs ] || fail "wrote docs/" +[ -z "$(git status --porcelain)" ] || fail "tree changed" +[ "$(git rev-list --count HEAD)" = 2 ] || fail "made a commit" -head_of_origin() { - git -C "$dir/origin.git" rev-parse refs/heads/main -} +new_repo "the prompts repo itself is refused" +mkdir prompts +echo source > prompts/REPO_POLICIES.md +script/update-policy > "$dir/output" 2>&1 && fail "exited zero" +[ ! -e docs ] || fail "wrote docs/" -expect_success() { - [ "$status" -eq 0 ] || fail "exited $status" -} - -expect_failure() { - [ "$status" -ne 0 ] || fail "exited 0" -} - -expect_output() { - grep -q -F -e "$1" "$dir/output" || fail "output lacks: $1" -} - -expect_output_without() { - if grep -q -F -e "$1" "$dir/output"; then - fail "output has: $1" - fi -} - -# expect_file : the file must equal standard input. -expect_file() { - cat > "$dir/expected" - diff "$dir/expected" "$dir/repo/$1" >&2 || fail "$1 is wrong" -} - -expect_absent() { - [ ! -e "$dir/repo/$1" ] || fail "$1 exists" -} - -expect_nothing_written() { - [ -z "$(git -C "$dir/repo" status --porcelain)" ] || - fail "the working tree changed" - [ "$(head_of_repo)" = "$before" ] || fail "the repo has a new commit" - [ "$(head_of_origin)" = "$before" ] || fail "origin has a new commit" -} - -test_own_entries_kept() { - start_scenario "own entries kept in all four files" - commit_and_push_fixture .gitignore .dockerignore .editorconfig \ - .golangci.yml .prettierrc REPO_POLICIES.md - run_update_policy "$HASH" - expect_success - - expect_file .gitignore << 'EOF' -*.log -*.tmp - -# Own entries go below this comment. -/myapp -EOF - expect_file .dockerignore << 'EOF' -**/*.log -**/*.tmp - -# Own entries go below this comment. -/myapp -EOF - expect_file .editorconfig << 'EOF' -root = true -[*] -indent_size = 4 - -# Own sections go below this comment. -[*.py] -indent_size = 2 -EOF - expect_file .golangci.yml << 'EOF' -linters: - settings: - depguard: - rules: - test-support: - deny: - - pkg: net/http/httptest - desc: canonical - - pkg: net/http/cgi - desc: added canonically - # Our own test helpers. - - pkg: example.com/app/internal/apptest - desc: own entry - other: - deny: - - pkg: example.com/other -EOF - expect_file .prettierrc << 'EOF' -{ "tabWidth": 4 } -EOF - expect_file REPO_POLICIES.md << 'EOF' -new policy -EOF - - [ "$(head_of_origin)" = "$(head_of_repo)" ] || - fail "the commit was not pushed" - [ "$(head_of_repo)" != "$before" ] || fail "no commit was made" - git -C "$dir/repo" log -1 --format=%s | grep -q -F -e "$HASH" || - fail "the commit message does not name the hash" -} - -test_files_not_carried_are_skipped() { - start_scenario "files the repo does not carry skipped" - mkdir "$dir/repo/docs" - mv "$dir/repo/REPO_POLICIES.md" "$dir/repo/docs/REPO_POLICIES.md" - commit_and_push_fixture docs/REPO_POLICIES.md - run_update_policy "$HASH" - expect_success - - expect_file docs/REPO_POLICIES.md << 'EOF' -new policy -EOF - expect_absent REPO_POLICIES.md - expect_absent API_POLICIES.md - expect_absent docs/API_POLICIES.md - expect_absent .gitignore - expect_absent .dockerignore - expect_absent .editorconfig - expect_absent .golangci.yml - expect_absent .prettierrc - [ "$(head_of_origin)" = "$(head_of_repo)" ] || - fail "the commit was not pushed" -} - -test_nothing_changed() { - start_scenario "nothing changed" - cp "$dir/canonical/.prettierrc" "$dir/repo/.prettierrc" - commit_and_push_fixture .prettierrc - run_update_policy "$HASH" - expect_success - expect_output "nothing to commit" - expect_nothing_written -} - -test_bad_commit_hash() { - for hash in not-a-hash 0000000000000000000000000000000000000000; do - start_scenario "bad commit hash $hash stops with nothing written" - commit_and_push_fixture .gitignore .prettierrc REPO_POLICIES.md - run_update_policy "$hash" - expect_failure - expect_nothing_written - done - # The last hash has the right form, so it is the one that reaches curl. - expect_output "cannot fetch" -} - -test_push_failure() { - start_scenario "push failure exits non-zero" - commit_and_push_fixture .prettierrc - reject_pushes - run_update_policy "$HASH" - expect_failure - expect_output "push failed" - [ "$(head_of_origin)" = "$before" ] || fail "origin has a new commit" -} - -# Each of these files, with the repo's own entries above the closing -# comment. The comment added with them must not be named. -test_own_entry_above_closing_comment() { - for file in .gitignore .dockerignore .editorconfig; do - start_scenario "own entries above the closing comment of $file stop" - { - printf '/myapp\n/.tool/\n\n# A comment of our own.\n' - cat "$dir/repo/$file" - } > "$dir/merged" - mv "$dir/merged" "$dir/repo/$file" - commit_and_push_fixture .gitignore .dockerignore .editorconfig \ - .prettierrc REPO_POLICIES.md - run_update_policy "$HASH" - expect_failure - expect_output "$file has entries" - expect_output "/myapp" - expect_output "/.tool/" - expect_output_without "A comment of our own." - expect_nothing_written - done -} - -test_retry_after_failed_push() { - start_scenario "a retry after a failed push delivers the commit" - commit_and_push_fixture .prettierrc - reject_pushes - run_update_policy "$HASH" - expect_failure - committed="$(head_of_repo)" - [ "$committed" != "$before" ] || fail "no commit was made" - [ "$(head_of_origin)" = "$before" ] || fail "origin has a new commit" - - accept_pushes - run_update_policy "$HASH" - expect_success - [ "$(head_of_repo)" = "$committed" ] || fail "the retry made a new commit" - [ "$(head_of_origin)" = "$committed" ] || - fail "the retry did not deliver the commit" -} - -test_uncommitted_change_stops() { - start_scenario "a carried file with uncommitted changes stops" - commit_and_push_fixture .prettierrc REPO_POLICIES.md - echo "uncommitted" >> "$dir/repo/REPO_POLICIES.md" - run_update_policy "$HASH" - expect_failure - expect_output "REPO_POLICIES.md has uncommitted changes" - expect_file REPO_POLICIES.md << 'EOF' -old policy -uncommitted -EOF - [ "$(head_of_repo)" = "$before" ] || fail "the repo has a new commit" - [ "$(head_of_origin)" = "$before" ] || fail "origin has a new commit" -} - -test_gitignore_lacks_canonical_last_line() { - start_scenario ".gitignore lacking the canonical last line stops" - printf '*.log\n/myapp\n' > "$dir/repo/.gitignore" - commit_and_push_fixture .gitignore .prettierrc - run_update_policy "$HASH" - expect_failure - expect_output ".gitignore lacks this line" - expect_nothing_written -} - -test_fetched_golangci_without_deny_list() { - start_scenario "a fetched .golangci.yml with no deny list stops" - cat > "$dir/canonical/.golangci.yml" << 'EOF' -linters: - settings: - depguard: - rules: - test-support: - files: - - "**/*.go" - other: - deny: - - pkg: example.com/other -EOF - commit_and_push_fixture .golangci.yml .prettierrc - run_update_policy "$HASH" - expect_failure - expect_output "no deny list in its test-support rule" - expect_nothing_written -} - -test_own_golangci_setting_stops() { - start_scenario "a .golangci.yml setting the canonical file lacks stops" - cat >> "$dir/repo/.golangci.yml" << 'EOF' - # A comment of our own. - forbidigo: - forbid: - - pattern: model.Operator -EOF - commit_and_push_fixture .golangci.yml .prettierrc - run_update_policy "$HASH" - expect_failure - expect_output ".golangci.yml has lines" - expect_output "forbidigo:" - expect_output "- pattern: model.Operator" - expect_output_without "A comment of our own." - expect_nothing_written -} - -test_source_repo_stops() { - start_scenario "the repo the policy files come from stops" - printf '#!/bin/sh\necho prompts\n' > "$dir/repo/script/projectname" - commit_and_push_fixture .prettierrc REPO_POLICIES.md - run_update_policy "$HASH" - expect_failure - expect_output "this repo is the source of the policy files" - expect_nothing_written -} - -test_staged_file_stays_out_of_commit() { - start_scenario "a file staged before the script starts stays out of its commit" - commit_and_push_fixture .prettierrc - echo "notes" > "$dir/repo/notes.txt" - git -C "$dir/repo" add notes.txt - run_update_policy "$HASH" - expect_success - [ "$(git -C "$dir/repo" show --name-only --format= HEAD)" = ".prettierrc" ] || - fail "the commit holds more than the policy file" - [ "$(git -C "$dir/repo" diff --cached --name-only)" = "notes.txt" ] || - fail "notes.txt is no longer staged" -} - -test_short_commit_hash_refused() { - start_scenario "a hexadecimal hash shorter than 40 characters is refused" - commit_and_push_fixture .prettierrc - run_update_policy "${HASH%?}" - expect_failure - expect_output "not a full commit hash" - expect_nothing_written -} - -# git asks the local canonical repository for the head of main, and the -# stub curl serves only that commit. -test_no_hash_uses_head_of_main() { - start_scenario "with no hash the script uses the head of main" - commit_and_push_fixture .prettierrc - run_update_policy - expect_success - expect_file .prettierrc << 'EOF' -{ "tabWidth": 4 } -EOF - git -C "$dir/repo" log -1 --format=%s | grep -q -F -e "$HASH" || - fail "the commit message does not name the head of main" - [ "$(head_of_origin)" = "$(head_of_repo)" ] || - fail "the commit was not pushed" -} - -# expect_former_canonical_line_replaced : an earlier -# canonical commit held the line and the newest does not. This repo's -# file still has it, and the script replaces it and pushes. -expect_former_canonical_line_replaced() { - cp "$dir/canonical/$1" "$dir/newest" - { echo "$2"; cat "$dir/newest"; } > "$dir/canonical/$1" - commit_canonical - cp "$dir/newest" "$dir/canonical/$1" - commit_canonical - { echo "$2"; cat "$dir/repo/$1"; } > "$dir/merged" - mv "$dir/merged" "$dir/repo/$1" - commit_and_push_fixture "$1" .prettierrc - - run_update_policy "$HASH" - expect_success - if grep -q -F -x -e "$2" "$dir/repo/$1"; then - fail "$1 still has: $2" - fi - [ "$(head_of_repo)" != "$before" ] || fail "no commit was made" - [ "$(head_of_origin)" = "$(head_of_repo)" ] || - fail "the commit was not pushed" -} - -test_former_canonical_golangci_line_replaced() { - start_scenario "a .golangci.yml line an earlier canonical commit held is replaced" - expect_former_canonical_line_replaced .golangci.yml "version: 1" -} - -test_former_canonical_gitignore_line_replaced() { - start_scenario "a .gitignore line above the closing comment that an earlier canonical commit held is replaced" - expect_former_canonical_line_replaced .gitignore "*.old" -} - -main() { - test_own_entries_kept - test_files_not_carried_are_skipped - test_nothing_changed - test_bad_commit_hash - test_push_failure - test_own_entry_above_closing_comment - test_retry_after_failed_push - test_uncommitted_change_stops - test_gitignore_lacks_canonical_last_line - test_fetched_golangci_without_deny_list - test_own_golangci_setting_stops - test_source_repo_stops - test_staged_file_stays_out_of_commit - test_short_commit_hash_refused - test_no_hash_uses_head_of_main - test_former_canonical_golangci_line_replaced - test_former_canonical_gitignore_line_replaced - echo "update-policy tests passed" -} - -main "$@" +echo "update-policy tests passed"