chore: pr feedback

src/algokit/cli/compile.py

@@ -58,4 +58,9 @@ def compile_py_command(context: click.Context, puya_args: list[str]) -> None:
     click.echo(run_result.output)
 
     if run_result.exit_code != 0:
+        click.secho(
+            "An error occurred during compile. Ensure supplied files are valid PuyaPy code before retrying.",
+            err=True,
+            fg="red",
+        )
         raise click.exceptions.Exit(run_result.exit_code)

tests/compile/conftest.py

@@ -0,0 +1,27 @@
+VALID_PUYA_CONTRACT_FILE_CONTENT = """
+from puyapy import Contract, Txn, log
+
+
+class HelloWorldContract(Contract):
+    def approval_program(self) -> bool:
+        name = Txn.application_args(0)
+        log(b"Hello, " + name)
+        return True
+
+    def clear_state_program(self) -> bool:
+        return True
+"""
+
+INVALID_PUYA_CONTRACT_FILE_CONTENT = """
+from puyapy import Contract, Txn, log
+
+
+class HelloWorldContract(Contract):
+    def approval_program(self) -> bool:
+        name = Txn.application_args_invalid(0)
+        log(b"Hello, " + name)
+        return True
+
+    def clear_state_program(self) -> bool:
+        return True
+"""

tests/compile/test_py.py

@@ -1,9 +1,12 @@
+import os
 from pathlib import Path
 
 import pytest
+from approvaltests.namer import NamerFactory
 from pytest_mock import MockerFixture
 
-from tests.utils.approvals import verify
+from tests.compile.conftest import INVALID_PUYA_CONTRACT_FILE_CONTENT, VALID_PUYA_CONTRACT_FILE_CONTENT
+from tests.utils.approvals import normalize_path, verify
 from tests.utils.click_invoker import invoke
 from tests.utils.proc_mock import ProcMock
 
@@ -13,8 +16,18 @@ def _normalize_path(path: Path) -> str:
 
 
 @pytest.fixture()
-def hello_world_contract_path() -> Path:
-    return Path(__file__).parent / "hello_world_contract.py"
+def dummy_contract_path() -> Path:
+    return Path(__file__).parent / "dummy_contract.py"
+
+
+@pytest.fixture(autouse=True)
+def cwd(tmp_path_factory: pytest.TempPathFactory) -> Path:
+    return tmp_path_factory.mktemp("cwd", numbered=True)
+
+
+@pytest.fixture()
+def output_path(cwd: Path) -> Path:
+    return cwd / "output"
 
 
 def test_compile_py_help(mocker: MockerFixture) -> None:
@@ -28,25 +41,25 @@ def test_compile_py_help(mocker: MockerFixture) -> None:
     verify(result.output)
 
 
-def test_puyapy_is_not_installed_anywhere(hello_world_contract_path: Path, mocker: MockerFixture) -> None:
+def test_puyapy_is_not_installed_anywhere(dummy_contract_path: Path, mocker: MockerFixture) -> None:
     proc_mock = ProcMock()
     proc_mock.should_bad_exit_on(["poetry", "run", "puyapy", "-h"], exit_code=1, output=["Puyapy not found"])
     proc_mock.should_bad_exit_on(["puyapy", "-h"], exit_code=1, output=["Puyapy not found"])
 
     proc_mock.set_output(["pipx", "--version"], ["1.0.0"])
 
     proc_mock.set_output(["pipx", "install", "puya"], ["Puyapy is installed"])
-    proc_mock.set_output(["puyapy", str(hello_world_contract_path)], ["Done"])
+    proc_mock.set_output(["puyapy", str(dummy_contract_path)], ["Done"])
 
     mocker.patch("algokit.core.proc.Popen").side_effect = proc_mock.popen
 
-    result = invoke(f"compile py {_normalize_path(hello_world_contract_path)}")
+    result = invoke(f"compile py {_normalize_path(dummy_contract_path)}")
 
     assert result.exit_code == 0
     verify(result.output)
 
 
-def test_specificed_puyapy_version_is_not_installed(hello_world_contract_path: Path, mocker: MockerFixture) -> None:
+def test_specificed_puyapy_version_is_not_installed(dummy_contract_path: Path, mocker: MockerFixture) -> None:
     current_version = "1.0.0"
     target_version = "1.1.0"
 
@@ -55,39 +68,64 @@ def test_specificed_puyapy_version_is_not_installed(hello_world_contract_path: P
     proc_mock.should_bad_exit_on(["puyapy", "--version"], exit_code=1, output=["Puyapy not found"])
 
     proc_mock.set_output(["pipx", "--version"], ["1.0.0"])
-    proc_mock.set_output(["pipx", "run", f"puya=={target_version}", str(hello_world_contract_path)], ["Done"])
+    proc_mock.set_output(["pipx", "run", f"puya=={target_version}", str(dummy_contract_path)], ["Done"])
 
     mocker.patch("algokit.core.proc.Popen").side_effect = proc_mock.popen
 
-    result = invoke(f"compile --version {target_version} py {_normalize_path(hello_world_contract_path)}")
+    result = invoke(f"compile --version {target_version} py {_normalize_path(dummy_contract_path)}")
 
     assert result.exit_code == 0
     verify(result.output)
 
 
-def test_puyapy_is_installed_in_project(hello_world_contract_path: Path, mocker: MockerFixture) -> None:
+def test_puyapy_is_installed_in_project(dummy_contract_path: Path, mocker: MockerFixture) -> None:
     proc_mock = ProcMock()
     proc_mock.set_output(["poetry", "run", "puyapy", "-h"], output=["Puyapy help"])
-    proc_mock.set_output(["poetry", "run", "puyapy", str(hello_world_contract_path)], ["Done"])
+    proc_mock.set_output(["poetry", "run", "puyapy", str(dummy_contract_path)], ["Done"])
 
     mocker.patch("algokit.core.proc.Popen").side_effect = proc_mock.popen
 
-    result = invoke(f"compile py {_normalize_path(hello_world_contract_path)}")
+    result = invoke(f"compile py {_normalize_path(dummy_contract_path)}")
 
     assert result.exit_code == 0
     verify(result.output)
 
 
-def test_puyapy_is_installed_globally(hello_world_contract_path: Path, mocker: MockerFixture) -> None:
+def test_puyapy_is_installed_globally(dummy_contract_path: Path, mocker: MockerFixture) -> None:
     proc_mock = ProcMock()
     proc_mock.should_bad_exit_on(["poetry", "run", "puyapy", "-h"], exit_code=1, output=["Puyapy not found"])
 
     proc_mock.set_output(["puyapy", "-h"], output=["Puyapy help"])
-    proc_mock.set_output(["puyapy", str(hello_world_contract_path)], ["Done"])
+    proc_mock.set_output(["puyapy", str(dummy_contract_path)], ["Done"])
 
     mocker.patch("algokit.core.proc.Popen").side_effect = proc_mock.popen
 
-    result = invoke(f"compile py {_normalize_path(hello_world_contract_path)}")
+    result = invoke(f"compile py {_normalize_path(dummy_contract_path)}")
 
     assert result.exit_code == 0
     verify(result.output)
+
+
+def test_valid_contract(cwd: Path, output_path: Path) -> None:
+    contract_path = cwd / "contract.py"
+    contract_path.write_text(VALID_PUYA_CONTRACT_FILE_CONTENT)
+    result = invoke(f"compile py {_normalize_path(contract_path)} --out-dir {_normalize_path(output_path)}")
+
+    assert result.exit_code == 0
+
+    for d, __, files in os.walk(output_path):
+        for file in files:
+            content = (d / Path(file)).read_text()
+            normalize_content = normalize_path(content, str(cwd), "{temp_output_directory}")
+            verify(normalize_content, options=NamerFactory.with_parameters(file))
+
+
+def test_invalid_contract(cwd: Path, output_path: Path) -> None:
+    contract_path = cwd / "contract.py"
+    contract_path.write_text(INVALID_PUYA_CONTRACT_FILE_CONTENT)
+    result = invoke(f"compile py {_normalize_path(contract_path)} --out-dir {_normalize_path(output_path)}")
+
+    assert result.exit_code == 1
+
+    normalize_output = normalize_path(result.output, str(cwd), "{temp_output_directory}")
+    verify(normalize_output)

tests/compile/test_py.test_invalid_contract.approved.txt

@@ -0,0 +1,67 @@
+DEBUG: Running 'poetry run puyapy -h' in '{current_working_directory}'
+DEBUG: poetry: usage: puya [-h] [-O {0,1,2}] [--output-teal | --no-output-teal]
+DEBUG: poetry: [--output-arc32 | --no-output-arc32] [--out-dir OUT_DIR]
+DEBUG: poetry: [--log-level {notset,debug,info,warning,error,fatal}] [-g {0,1,2}]
+DEBUG: poetry: [--output-awst | --no-output-awst]
+DEBUG: poetry: [--output-ssa-ir | --no-output-ssa-ir]
+DEBUG: poetry: [--output-optimization-ir | --no-output-optimization-ir]
+DEBUG: poetry: [--output-destructured-ir | --no-output-destructured-ir]
+DEBUG: poetry: [--output-memory-ir | --no-output-memory-ir]
+DEBUG: poetry: [--target-avm-version {10}]
+DEBUG: poetry: [--locals-coalescing-strategy {root_operand,root_operand_excluding_args,aggressive}]
+DEBUG: poetry: PATH [PATH ...]
+DEBUG: poetry: 
+DEBUG: poetry: positional arguments:
+DEBUG: poetry: PATH
+DEBUG: poetry: 
+DEBUG: poetry: options:
+DEBUG: poetry: -h, --help            show this help message and exit
+DEBUG: poetry: -O {0,1,2}, --optimization-level {0,1,2}
+DEBUG: poetry: set optimization level (default: 1)
+DEBUG: poetry: --output-teal, --no-output-teal
+DEBUG: poetry: Output TEAL (default: True)
+DEBUG: poetry: --output-arc32, --no-output-arc32
+DEBUG: poetry: Output ARC32 application.json (default: True)
+DEBUG: poetry: --out-dir OUT_DIR     path for outputting artefacts (default: False)
+DEBUG: poetry: --log-level {notset,debug,info,warning,error,fatal}
+DEBUG: poetry: Minimum level to log to console (default: info)
+DEBUG: poetry: -g {0,1,2}, --debug-level {0,1,2}
+DEBUG: poetry: debug information level (default: 1)
+DEBUG: poetry: --output-awst, --no-output-awst
+DEBUG: poetry: output parsed result of AST (default: False)
+DEBUG: poetry: --output-ssa-ir, --no-output-ssa-ir
+DEBUG: poetry: output IR in SSA form (default: False)
+DEBUG: poetry: --output-optimization-ir, --no-output-optimization-ir
+DEBUG: poetry: output IR after each optimization (default: False)
+DEBUG: poetry: --output-destructured-ir, --no-output-destructured-ir
+DEBUG: poetry: output IR after SSA destructuring and before codegen
+DEBUG: poetry: (default: False)
+DEBUG: poetry: --output-memory-ir, --no-output-memory-ir
+DEBUG: poetry: output MIR before lowering to TealOps (default: False)
+DEBUG: poetry: --target-avm-version {10}
+DEBUG: poetry: --locals-coalescing-strategy {root_operand,root_operand_excluding_args,aggressive}
+DEBUG: poetry: Strategy choice for out-of-ssa local variable
+DEBUG: poetry: coalescing. The best choice for your app is best
+DEBUG: poetry: determined through experimentation (default:
+DEBUG: poetry: root_operand)
+DEBUG: Running 'poetry run puyapy {temp_output_directory}/contract.py --out-dir {temp_output_directory}/output' in '{current_working_directory}'
+DEBUG: poetry: {temp_output_directory}/contract.py:7 error: "type[Txn]" has no attribute "application_args_invalid"  [attr-defined]
+DEBUG: poetry: name = Txn.application_args_invalid(0)
+DEBUG: poetry: ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
+DEBUG: poetry: {temp_output_directory}/contract.py:7 error: Expression has type "Any"  [misc]
+DEBUG: poetry: name = Txn.application_args_invalid(0)
+DEBUG: poetry: ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+DEBUG: poetry: {temp_output_directory}/contract.py:8 error: Expression has type "Any"  [misc]
+DEBUG: poetry: log(b"Hello, " + name)
+DEBUG: poetry: ^~~~~~~~~~~~~~~~~
+{temp_output_directory}/contract.py:7 error: "type[Txn]" has no attribute "application_args_invalid"  [attr-defined]
+                                                                                                                           name = Txn.application_args_invalid(0)
+                                                                                                                                  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
+{temp_output_directory}/contract.py:7 error: Expression has type "Any"  [misc]
+                                                                                                                           name = Txn.application_args_invalid(0)
+                                                                                                                                  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+{temp_output_directory}/contract.py:8 error: Expression has type "Any"  [misc]
+                                                                                                                           log(b"Hello, " + name)
+                                                                                                                               ^~~~~~~~~~~~~~~~~
+
+An error occurred during compile. Ensure supplied files are valid PuyaPy code before retrying.

tests/compile/test_py.test_puyapy_is_installed_globally.approved.txt

@@ -2,6 +2,6 @@ DEBUG: Running 'poetry run puyapy -h' in '{current_working_directory}'
 DEBUG: poetry: Puyapy not found
 DEBUG: Running 'puyapy -h' in '{current_working_directory}'
 DEBUG: puyapy: Puyapy help
-DEBUG: Running 'puyapy {current_working_directory}/tests/compile/hello_world_contract.py' in '{current_working_directory}'
+DEBUG: Running 'puyapy {current_working_directory}/tests/compile/dummy_contract.py' in '{current_working_directory}'
 DEBUG: puyapy: Done
 Done

tests/compile/test_py.test_puyapy_is_installed_in_project.approved.txt

@@ -1,5 +1,5 @@
 DEBUG: Running 'poetry run puyapy -h' in '{current_working_directory}'
 DEBUG: poetry: Puyapy help
-DEBUG: Running 'poetry run puyapy {current_working_directory}/tests/compile/hello_world_contract.py' in '{current_working_directory}'
+DEBUG: Running 'poetry run puyapy {current_working_directory}/tests/compile/dummy_contract.py' in '{current_working_directory}'
 DEBUG: poetry: Done
 Done

tests/compile/test_py.test_puyapy_is_not_installed_anywhere.approved.txt

@@ -6,6 +6,6 @@ DEBUG: Running 'pipx --version' in '{current_working_directory}'
 DEBUG: pipx: 1.0.0
 DEBUG: Running 'pipx install puya' in '{current_working_directory}'
 DEBUG: pipx: Puyapy is installed
-DEBUG: Running 'puyapy {current_working_directory}/tests/compile/hello_world_contract.py' in '{current_working_directory}'
+DEBUG: Running 'puyapy {current_working_directory}/tests/compile/dummy_contract.py' in '{current_working_directory}'
 DEBUG: puyapy: Done
 Done

tests/compile/test_py.test_specificed_puyapy_version_is_not_installed.approved.txt

@@ -4,6 +4,6 @@ DEBUG: Running 'puyapy --version' in '{current_working_directory}'
 DEBUG: puyapy: Puyapy not found
 DEBUG: Running 'pipx --version' in '{current_working_directory}'
 DEBUG: pipx: 1.0.0
-DEBUG: Running 'pipx run puya==1.1.0 {current_working_directory}/tests/compile/hello_world_contract.py' in '{current_working_directory}'
+DEBUG: Running 'pipx run puya==1.1.0 {current_working_directory}/tests/compile/dummy_contract.py' in '{current_working_directory}'
 DEBUG: pipx: Done
 Done

tests/compile/test_py.test_valid_contract.contract.approval.teal.approved.txt

@@ -0,0 +1,17 @@
+#pragma version 10
+
+contract.HelloWorldContract.approval_program:
+    // {temp_output_directory}/contract.py:8
+    // log(b"Hello, " + name)
+    byte "Hello, "
+    // {temp_output_directory}/contract.py:7
+    // name = Txn.application_args(0)
+    txna ApplicationArgs 0
+    // {temp_output_directory}/contract.py:8
+    // log(b"Hello, " + name)
+    concat
+    log
+    // {temp_output_directory}/contract.py:9
+    // return True
+    int 1
+    return

tests/compile/test_py.test_valid_contract.contract.clear.teal.approved.txt

@@ -0,0 +1,7 @@
+#pragma version 10
+
+contract.HelloWorldContract.clear_state_program:
+    // {temp_output_directory}/contract.py:12
+    // return True
+    int 1
+    return