|
| 1 | +import json |
| 2 | +import os |
| 3 | +from pathlib import Path |
| 4 | +import re |
| 5 | +import subprocess |
| 6 | +import tempfile |
| 7 | +import textwrap |
| 8 | +import unittest |
| 9 | + |
| 10 | +WORKFLOW = Path(__file__).parents[1] / 'workflows' / 'fork-ci.yml' |
| 11 | +TEXT = WORKFLOW.read_text() |
| 12 | + |
| 13 | + |
| 14 | +def job(name): |
| 15 | + return re.search(rf'^ {name}:\n(.*?)(?=^ [\w-]+:|\Z)', TEXT, re.M | re.S)[1] |
| 16 | + |
| 17 | + |
| 18 | +def run_block(text): |
| 19 | + return textwrap.dedent(text.split(' run: |\n')[-1]) |
| 20 | + |
| 21 | + |
| 22 | +class RoutingTests(unittest.TestCase): |
| 23 | + def request(self, server_tests, exit_code): |
| 24 | + with tempfile.TemporaryDirectory() as directory: |
| 25 | + output = Path(directory) / 'output' |
| 26 | + output.touch() |
| 27 | + script = f'gh() {{ return {exit_code}; }}\n' + run_block(job('private-linux-status')) |
| 28 | + result = subprocess.run(['bash', '-e', '-c', script], capture_output=True, text=True, |
| 29 | + env={**os.environ, 'SERVER_TESTS': server_tests, 'SOURCE_SHA': 'a' * 40, |
| 30 | + 'GITHUB_OUTPUT': str(output), 'GITHUB_REPOSITORY': 'ScriptedAlchemy/t3code', |
| 31 | + 'GITHUB_RUN_ID': '123', 'GITHUB_RUN_ATTEMPT': '1', |
| 32 | + 'GITHUB_SERVER_URL': 'https://github.com'}) |
| 33 | + return result.returncode, output.read_text() |
| 34 | + |
| 35 | + def test_request_publishes_only_after_success(self): |
| 36 | + self.assertEqual(self.request('true', 0), (0, 'enabled=true\n')) |
| 37 | + code, output = self.request('true', 1) |
| 38 | + self.assertNotEqual(code, 0) |
| 39 | + self.assertEqual(output, '') |
| 40 | + self.assertEqual(self.request('false', 0), (0, 'enabled=false\n')) |
| 41 | + |
| 42 | + def test_hosted_server_falls_back_on_failed_or_skipped_request(self): |
| 43 | + expression = re.search(r' if: >-\n(.*?)(?= runs-on:)', job('server'), re.S)[1].strip() |
| 44 | + expression = expression.replace('needs.private-linux-status', 'needs["private-linux-status"]') |
| 45 | + for result, enabled, tests, cancelled, expected in [ |
| 46 | + ('success', 'true', 'true', False, False), |
| 47 | + ('failure', '', 'true', False, True), |
| 48 | + ('failure', 'true', 'true', False, True), |
| 49 | + ('skipped', '', 'true', False, True), |
| 50 | + ('success', 'false', 'true', False, True), |
| 51 | + ('skipped', '', 'false', False, False), |
| 52 | + ('failure', '', 'true', True, False), |
| 53 | + ]: |
| 54 | + with self.subTest(result=result, enabled=enabled, tests=tests, cancelled=cancelled): |
| 55 | + needs = {'changes': {'outputs': {'test_server': tests}}, |
| 56 | + 'private-linux-status': {'result': result, 'outputs': {'enabled': enabled}}} |
| 57 | + script = f'const needs={json.dumps(needs)}; const cancelled=()=>{str(cancelled).lower()}; console.log(Boolean({expression}));' |
| 58 | + actual = subprocess.check_output(['node', '-e', script], text=True).strip() |
| 59 | + self.assertEqual(actual, str(expected).lower()) |
| 60 | + |
| 61 | + def test_aggregate_requires_server_or_acknowledged_private_route(self): |
| 62 | + for private_result, enabled, server_result, expected in [ |
| 63 | + ('success', 'true', 'skipped', True), |
| 64 | + ('skipped', '', 'success', True), |
| 65 | + ('success', 'false', 'skipped', False), |
| 66 | + ('failure', 'true', 'skipped', False), |
| 67 | + ('success', 'true', 'failure', False), |
| 68 | + ]: |
| 69 | + with self.subTest(private=private_result, enabled=enabled, server=server_result): |
| 70 | + needs = {k: {'result': 'success'} for k in ['checks', 'clients', 'rust', 'mobile_native']} |
| 71 | + needs['changes'] = {'result': 'success', 'outputs': {'test_server': 'true'}} |
| 72 | + needs['private-linux-status'] = {'result': private_result, 'outputs': {'enabled': enabled}} |
| 73 | + needs['server'] = {'result': server_result} |
| 74 | + result = subprocess.run(['bash', '-e', '-c', run_block(job('check'))], |
| 75 | + env={**os.environ, 'RESULTS': json.dumps(needs)}, capture_output=True) |
| 76 | + self.assertEqual(result.returncode == 0, expected) |
| 77 | + |
| 78 | + def test_privileged_request_never_checks_out_source(self): |
| 79 | + request = job('private-linux-status') |
| 80 | + self.assertNotRegex(request, r'(?m)^\s+-?\s*uses:') |
| 81 | + self.assertIn("github.actor_id == '25274700'", request) |
| 82 | + self.assertIn("github.triggering_actor == 'ScriptedAlchemy'", request) |
| 83 | + self.assertIn('github.event.pull_request.head.repo.full_name == github.repository', request) |
| 84 | + self.assertNotIn('statuses: write', job('changes')) |
| 85 | + |
| 86 | + |
| 87 | +if __name__ == '__main__': |
| 88 | + unittest.main() |
0 commit comments