Added dry run logic to compile CLI command and added pytests

Author: aabmets

quantcrypt/internal/cli/commands/compile.py

@@ -40,13 +40,13 @@ def command_compile(
         algos = const.SupportedAlgos.filter(algorithms)
 
     variants = [const.PQAVariant.REF]
-    if with_opt:
+    if with_opt:  # pragma: no cover
         arch = platform.machine().lower()
         if arch in const.AMDArches:
             variants.append(const.PQAVariant.OPT_AMD)
         elif arch in const.ARMArches:
             variants.append(const.PQAVariant.OPT_ARM)
-        else:  # pragma: no branch
+        else:
             console.raise_error("This machine does not support optimized variants.")
 
     variants_fmt = 'only the [italic tan]clean[/]'
@@ -60,6 +60,11 @@ def command_compile(
     if not non_interactive:
         console.ask_continue(exit_on_false=True)
 
+    if dry_run:
+        console.styled_print("QuantCrypt would have compiled the following algorithms:")
+        console.pretty_print(', '.join(s.armor_name() for s in algos))
+        return
+
     console.styled_print("\nInitializing compilation[grey46]...[/]\n")
     process = Compiler.run(variants, algos, in_subprocess=True)
 

tests/test_cli/conftest.py

@@ -85,6 +85,7 @@ def closure(
             decrypt=cmd.dec_app,
             sign=cmd.sign_app,
             verify=cmd.verify_app,
+            compile=cmd.compile_app,
         )[command]
         result = runner.invoke(_app, options, input=user_input)
         if debug:

tests/test_cli/test_compile.py

@@ -0,0 +1,55 @@
+#
+#   MIT License
+#
+#   Copyright (c) 2024, Mattias Aabmets
+#
+#   The contents of this file are subject to the terms and conditions defined in the License.
+#   You may not use, modify, or distribute this file except in compliance with the License.
+#
+#   SPDX-License-Identifier: MIT
+#
+
+from textwrap import dedent
+from quantcrypt.internal import constants as const
+from quantcrypt.internal.cli.commands import compile
+from .conftest import CLIMessages
+
+
+class MockedProcess:
+    def __init__(self, returncode: int):
+        self._returncode = returncode
+
+    @property
+    def stdout(self) -> str:
+        return dedent(f"""
+            Some garbage output from CFFI...
+            {const.SubprocTag}Compiling clean variant of MLKEM512...
+            More garbage output from CFFI...
+        """)
+
+    @property
+    def returncode(self) -> int:
+        return int(self._returncode)
+
+    def wait(self) -> None:
+        return
+
+
+class MockedCompiler:
+    _returncode = 1
+
+    @classmethod
+    def run(cls, *_, **kwargs) -> MockedProcess:
+        assert "in_subprocess" in kwargs and kwargs["in_subprocess"] is True
+        cls._returncode = not cls._returncode
+        return MockedProcess(cls._returncode)
+
+
+def test_compile(cli_runner, alt_tmp_path, monkeypatch) -> None:
+    monkeypatch.setattr(compile, "Compiler", MockedCompiler)
+
+    cli_runner("compile", ['mlkem512'], "n\n", CLIMessages.CANCELLED)
+    cli_runner("compile", ['mlkem512'], "y\n", CLIMessages.SUCCESS)
+    cli_runner("compile", ['-D', 'mlkem512'], "y\n", CLIMessages.DRYRUN)
+    cli_runner("compile", ['-N', 'mlkem512'], "", CLIMessages.ERROR)
+    cli_runner("compile", ['-N', 'mlkem512'], "", CLIMessages.SUCCESS)