| 1 | #!/usr/bin/env python3 |
| 2 | import http.server |
| 3 | import json |
| 4 | import os |
| 5 | from pathlib import Path |
| 6 | import sqlite3 |
| 7 | import subprocess |
| 8 | import tempfile |
| 9 | import threading |
| 10 | import unittest |
| 11 | |
| 12 | REPO = Path(__file__).resolve().parent.parent |
| 13 | HOOK = REPO / "service/shale/webhook.sh" |
| 14 | PREPARE = REPO / "service/shale/prepare.py" |
| 15 | |
| 16 | |
| 17 | class Receiver(http.server.BaseHTTPRequestHandler): |
| 18 | events = [] |
| 19 | |
| 20 | def do_POST(self): |
| 21 | body = self.rfile.read(int(self.headers["Content-Length"])) |
| 22 | self.events.append((self.headers["X-GitHub-Event"], self.path, json.loads(body))) |
| 23 | self.send_response(204) |
| 24 | self.end_headers() |
| 25 | |
| 26 | def log_message(self, *_): |
| 27 | pass |
| 28 | |
| 29 | |
| 30 | class ShaleWebhookTests(unittest.TestCase): |
| 31 | def setUp(self): |
| 32 | self.temp = tempfile.TemporaryDirectory() |
| 33 | self.root = Path(self.temp.name) |
| 34 | self.server = http.server.ThreadingHTTPServer(("127.0.0.1", 0), Receiver) |
| 35 | Receiver.events = [] |
| 36 | self.thread = threading.Thread(target=self.server.serve_forever, daemon=True) |
| 37 | self.thread.start() |
| 38 | |
| 39 | def tearDown(self): |
| 40 | self.server.shutdown() |
| 41 | self.thread.join() |
| 42 | self.server.server_close() |
| 43 | self.temp.cleanup() |
| 44 | |
| 45 | def git(self, *args, cwd=None, env=None): |
| 46 | return subprocess.run( |
| 47 | ["git", *args], cwd=cwd, env=env, check=True, text=True, |
| 48 | capture_output=True, |
| 49 | ).stdout.strip() |
| 50 | |
| 51 | def repositories(self): |
| 52 | bare = self.root / "origin.git" |
| 53 | work = self.root / "work" |
| 54 | self.git("init", "--bare", "--initial-branch=main", bare) |
| 55 | self.git("config", "--file", bare / "config", "shale.snowglobe.repository", "snowcord") |
| 56 | (bare / "hooks/post-receive").symlink_to(HOOK) |
| 57 | self.git("init", "--initial-branch=main", work) |
| 58 | self.git("config", "user.name", "Clover", cwd=work) |
| 59 | self.git("config", "user.email", "clover@example.test", cwd=work) |
| 60 | (work / "file.txt").write_text("hello\n") |
| 61 | self.git("add", "file.txt", cwd=work) |
| 62 | self.git("commit", "-m", 'first "line"\n\nsecond \\ line', cwd=work) |
| 63 | self.git("remote", "add", "origin", str(bare), cwd=work) |
| 64 | return work |
| 65 | |
| 66 | def test_cleared_cgi_environment_falls_back_to_service_environment(self): |
| 67 | work = self.repositories() |
| 68 | service = self.root / "environ" |
| 69 | service.write_bytes(b"\0".join([ |
| 70 | b"DOMAIN=shale.test", |
| 71 | b"SHALE_WEBHOOK_ENABLED=true", |
| 72 | f"SHALE_WEBHOOK_URL=http://127.0.0.1:{self.server.server_port}/hook".encode(), |
| 73 | b"", |
| 74 | ])) |
| 75 | env = {**os.environ, "SHALE_SERVICE_ENVIRON": str(service)} |
| 76 | self.git("push", "origin", "main", cwd=work, env=env) |
| 77 | event, path, _ = Receiver.events.pop(0) |
| 78 | self.assertEqual((event, path), ("push", "/hook/github/")) |
| 79 | |
| 80 | def test_push_and_delete_match_snowcord_github_contract(self): |
| 81 | work = self.repositories() |
| 82 | env = { |
| 83 | **os.environ, |
| 84 | "DOMAIN": "shale.test", |
| 85 | "SHALE_WEBHOOK_ENABLED": "true", |
| 86 | "SHALE_WEBHOOK_URL": f"http://127.0.0.1:{self.server.server_port}/hook", |
| 87 | } |
| 88 | self.git("push", "origin", "main", cwd=work, env=env) |
| 89 | |
| 90 | event, path, payload = Receiver.events.pop(0) |
| 91 | self.assertEqual(event, "push") |
| 92 | self.assertEqual(path, "/hook/github/") |
| 93 | self.assertEqual(payload["ref"], "refs/heads/main") |
| 94 | self.assertEqual(payload["repository"]["name"], "snowcord") |
| 95 | self.assertEqual(payload["sender"]["login"], "Clover") |
| 96 | self.assertEqual(payload["commits"][0]["message"], 'first "line"\n\nsecond \\ line') |
| 97 | self.assertEqual(payload["head_commit"]["id"], payload["after"]) |
| 98 | |
| 99 | self.git("push", "origin", "main:delete-me", cwd=work, env=env) |
| 100 | Receiver.events.pop(0) |
| 101 | self.git("push", "origin", ":delete-me", cwd=work, env=env) |
| 102 | event, _, payload = Receiver.events.pop(0) |
| 103 | self.assertEqual((event, payload["ref_type"], payload["ref"]), ("delete", "branch", "delete-me")) |
| 104 | |
| 105 | def test_payload_lists_only_new_commits_capped_at_twenty(self): |
| 106 | work = self.repositories() |
| 107 | for i in range(24): |
| 108 | self.git("commit", "--allow-empty", "-m", f"c{i}", cwd=work) |
| 109 | env = { |
| 110 | **os.environ, |
| 111 | "DOMAIN": "shale.test", |
| 112 | "SHALE_WEBHOOK_ENABLED": "true", |
| 113 | "SHALE_WEBHOOK_URL": f"http://127.0.0.1:{self.server.server_port}/hook", |
| 114 | } |
| 115 | self.git("push", "origin", "main", cwd=work, env=env) |
| 116 | _, _, payload = Receiver.events.pop(0) |
| 117 | self.assertEqual([c["message"] for c in payload["commits"]][-1], "c23") |
| 118 | self.assertEqual(len(payload["commits"]), 20) |
| 119 | |
| 120 | self.git("push", "origin", "main:topic", cwd=work, env=env) |
| 121 | _, _, payload = Receiver.events.pop(0) |
| 122 | self.assertEqual(payload["commits"], []) |
| 123 | self.assertEqual(payload["head_commit"]["id"], payload["after"]) |
| 124 | |
| 125 | def test_prepare_installs_only_named_repository_hooks(self): |
| 126 | owned = self.root / "repositories_owned" |
| 127 | database = self.root / "data/astheno.shale.db" |
| 128 | database.parent.mkdir() |
| 129 | with sqlite3.connect(database) as db: |
| 130 | db.executescript(""" |
| 131 | CREATE TABLE users (provider TEXT, snowflake TEXT); |
| 132 | CREATE TABLE repositories (uuid TEXT, name TEXT); |
| 133 | INSERT INTO repositories VALUES ('snowcord-id', 'snowcord'); |
| 134 | INSERT INTO repositories VALUES ('other-id', 'other'); |
| 135 | """) |
| 136 | for name in ("snowcord-id", "other-id"): |
| 137 | self.git("init", "--bare", owned / name) |
| 138 | env = {**os.environ, "SNOWGLOBE_DOMAIN": "test"} |
| 139 | subprocess.run( |
| 140 | ["python3", PREPARE], input=json.dumps({"hostRoot": str(self.root), "uid": os.getuid()}), |
| 141 | env=env, check=True, text=True, capture_output=True, |
| 142 | ) |
| 143 | hook = owned / "snowcord-id/hooks/post-receive" |
| 144 | self.assertEqual(os.readlink(hook), "/data/shale-webhook") |
| 145 | self.assertEqual((self.root / "data/shale-webhook").stat().st_mode & 0o777, 0o750) |
| 146 | self.assertEqual( |
| 147 | self.git("config", "--file", owned / "snowcord-id/config", "--get", "shale.snowglobe.repository"), |
| 148 | "snowcord", |
| 149 | ) |
| 150 | self.assertFalse((owned / "other-id/hooks/post-receive").exists()) |
| 151 | |
| 152 | with sqlite3.connect(database) as db: |
| 153 | db.execute("UPDATE repositories SET name='renamed' WHERE uuid='snowcord-id'") |
| 154 | subprocess.run( |
| 155 | ["python3", PREPARE], input=json.dumps({"hostRoot": str(self.root), "uid": os.getuid()}), |
| 156 | env=env, check=True, text=True, capture_output=True, |
| 157 | ) |
| 158 | self.assertFalse(os.path.lexists(hook)) |
| 159 | |
| 160 | |
| 161 | if __name__ == "__main__": |
| 162 | unittest.main() |