|
| 1 | +import contextlib |
| 2 | +import pathlib |
| 3 | +import subprocess |
| 4 | +import sys |
| 5 | +import tempfile |
| 6 | +import unittest |
| 7 | +from unittest import mock |
| 8 | + |
| 9 | +from click.testing import CliRunner |
| 10 | + |
| 11 | + |
| 12 | +PWNSHOP_ROOT = pathlib.Path(__file__).resolve().parents[1] |
| 13 | +sys.path.insert(0, str(PWNSHOP_ROOT / "src")) |
| 14 | + |
| 15 | +from pwnshop.commands import test as test_command # noqa: E402 |
| 16 | + |
| 17 | + |
| 18 | +class TestCommandMetadataTests(unittest.TestCase): |
| 19 | + @staticmethod |
| 20 | + def challenge_context(flag): |
| 21 | + @contextlib.contextmanager |
| 22 | + def manager(): |
| 23 | + yield "container-id", "http://workspace/", flag |
| 24 | + |
| 25 | + return manager() |
| 26 | + |
| 27 | + def invoke_test_command( |
| 28 | + self, |
| 29 | + returncode, |
| 30 | + *, |
| 31 | + allow_unsupported_tests=False, |
| 32 | + attempts=1, |
| 33 | + required=None, |
| 34 | + ): |
| 35 | + with tempfile.TemporaryDirectory() as directory: |
| 36 | + module = pathlib.Path(directory) |
| 37 | + challenge = module / "challenge" |
| 38 | + challenge.mkdir() |
| 39 | + if allow_unsupported_tests: |
| 40 | + (challenge / "challenge.yml").write_text("allow_unsupported_tests: true\n") |
| 41 | + if required is not None: |
| 42 | + (module / "module.yml").write_text( |
| 43 | + f"resources:\n - type: challenge\n id: challenge\n required: {str(required).lower()}\n" |
| 44 | + ) |
| 45 | + |
| 46 | + rendered = module / "rendered" |
| 47 | + test = rendered / "tests_private" / "test_solve.py" |
| 48 | + test.parent.mkdir(parents=True) |
| 49 | + test.write_text("#!/usr/bin/python3\n") |
| 50 | + |
| 51 | + arguments = [ |
| 52 | + "--jobs", |
| 53 | + "1", |
| 54 | + "--attempts", |
| 55 | + str(attempts), |
| 56 | + "--require-solved", |
| 57 | + str(challenge), |
| 58 | + ] |
| 59 | + outcome = subprocess.CompletedProcess( |
| 60 | + [str(test)], |
| 61 | + returncode, |
| 62 | + stdout="test output without the generated flag\n", |
| 63 | + stderr="", |
| 64 | + ) |
| 65 | + |
| 66 | + with ( |
| 67 | + mock.patch.object(test_command.lib, "resolve_targets", return_value=[challenge]), |
| 68 | + mock.patch.object(test_command.lib, "render_challenge", return_value=rendered), |
| 69 | + mock.patch.object(test_command.lib, "build_challenge", return_value="image-id"), |
| 70 | + mock.patch.object( |
| 71 | + test_command.lib, |
| 72 | + "run_challenge", |
| 73 | + side_effect=lambda *_args, **_kwargs: self.challenge_context("generated-flag"), |
| 74 | + ) as run_challenge, |
| 75 | + mock.patch.object(test_command, "run_workspace_command", return_value=outcome) as run_test, |
| 76 | + ): |
| 77 | + result = CliRunner().invoke(test_command.test_command, arguments) |
| 78 | + |
| 79 | + return result, run_challenge.call_count, run_test.call_count |
| 80 | + |
| 81 | + def test_optional_challenge_does_not_need_to_emit_the_flag(self): |
| 82 | + result, container_calls, test_calls = self.invoke_test_command(0, required=False) |
| 83 | + |
| 84 | + self.assertEqual(result.exit_code, 0, result.output) |
| 85 | + self.assertEqual((container_calls, test_calls), (1, 1)) |
| 86 | + self.assertNotIn("Unsolved challenges", result.output) |
| 87 | + |
| 88 | + def test_optional_challenge_test_failure_still_fails(self): |
| 89 | + result, container_calls, test_calls = self.invoke_test_command(1, required=False) |
| 90 | + |
| 91 | + self.assertEqual(result.exit_code, 1) |
| 92 | + self.assertEqual((container_calls, test_calls), (1, 1)) |
| 93 | + self.assertIn("Some tests failed", result.output) |
| 94 | + self.assertNotIn("Unsolved challenges", result.output) |
| 95 | + |
| 96 | + def test_unsupported_test_is_exempt_and_not_retried(self): |
| 97 | + result, container_calls, test_calls = self.invoke_test_command( |
| 98 | + test_command.UNSUPPORTED_TEST_EXIT_CODE, |
| 99 | + allow_unsupported_tests=True, |
| 100 | + attempts=4, |
| 101 | + ) |
| 102 | + |
| 103 | + self.assertEqual(result.exit_code, 0, result.output) |
| 104 | + self.assertEqual((container_calls, test_calls), (1, 1)) |
| 105 | + self.assertNotIn("Unsolved challenges", result.output) |
| 106 | + |
| 107 | + def test_unsupported_exit_requires_opt_in(self): |
| 108 | + result, container_calls, test_calls = self.invoke_test_command(test_command.UNSUPPORTED_TEST_EXIT_CODE) |
| 109 | + |
| 110 | + self.assertEqual(result.exit_code, 1) |
| 111 | + self.assertEqual((container_calls, test_calls), (1, 1)) |
| 112 | + self.assertIn("Some tests failed", result.output) |
| 113 | + |
| 114 | + def test_other_nonzero_exit_is_not_unsupported(self): |
| 115 | + result, container_calls, test_calls = self.invoke_test_command(1, allow_unsupported_tests=True) |
| 116 | + |
| 117 | + self.assertEqual(result.exit_code, 1) |
| 118 | + self.assertEqual((container_calls, test_calls), (1, 1)) |
| 119 | + self.assertIn("Some tests failed", result.output) |
| 120 | + |
| 121 | + def test_required_challenge_without_flag_is_still_unsolved(self): |
| 122 | + result, container_calls, test_calls = self.invoke_test_command(0) |
| 123 | + |
| 124 | + self.assertEqual(result.exit_code, 1) |
| 125 | + self.assertEqual((container_calls, test_calls), (1, 1)) |
| 126 | + self.assertIn("Unsolved challenges", result.output) |
| 127 | + |
| 128 | + |
| 129 | +if __name__ == "__main__": |
| 130 | + unittest.main() |
0 commit comments