chore: wip refinements; replacing poetry with pipx based tealer invocation

Author: aorumbayev

poetry.lock

@@ -25,7 +25,6 @@ algokit-utils = "v2.1.0"
 multiformats = "0.3.1"
 multiformats_config = "0.3.1" # pinned this to be in lockstep with multiformats
 aiohttp = "3.9.1"
-tealer = {git = "https://github.com/algorandfoundation/tealer.git"}
 jsondiff = "^2.0.0"
 
 [tool.poetry.group.dev.dependencies]

pyproject.toml

@@ -177,7 +177,6 @@ def analyze(  # noqa: PLR0913
             abort=True,
         )
 
-    duplicate_files: dict = {}
     reports = {}
     for cur_file in input_files:
         file = cur_file.resolve()
@@ -190,7 +189,7 @@ def analyze(  # noqa: PLR0913
             )
             continue
 
-        filename = generate_report_filename(file, duplicate_files)
+        filename = generate_report_filename(file)
 
         # If baseline is enabled, store the report in the snapshots folder otherwise store it in the reports folder
         # If a custom output path is provided, store the report in the specified path

src/algokit/cli/tasks/analyze.py

@@ -11,7 +11,7 @@
 
 logger = logging.getLogger(__name__)
 
-TEALER_REPORTS_ROOT = Path.cwd() / Path(".algokit/static-analysis")
+TEALER_REPORTS_ROOT = Path.cwd() / ".algokit/static-analysis"
 TEALER_ARTIFACTS_ROOT = TEALER_REPORTS_ROOT / "artifacts"
 TEALER_SNAPSHOTS_ROOT = TEALER_REPORTS_ROOT / "snapshots"
 TEALER_DOT_FILES_ROOT = TEALER_REPORTS_ROOT / "tealer"
@@ -47,15 +47,12 @@ def _extract_lines(block: list[list[str]]) -> str:
     return "->".join([_extract_line(b) for b in block])
 
 
-def generate_report_filename(file: Path, duplicate_files: dict) -> str:
-    filename = f"{file.parent.stem}_{file.stem}"
-    if filename in duplicate_files:
-        duplicate_files[filename] += 1
-        filename = f"{filename}_{duplicate_files[filename]}.json"
-    else:
-        duplicate_files[filename] = 0
-        filename = f"{filename}.json"
-    return filename
+def generate_report_filename(file: Path) -> str:
+    duplicate_files: dict[str, int] = {}
+    base_filename = f"{file.parent.stem}_{file.stem}"
+    duplicate_count = duplicate_files.get(base_filename, 0)
+    duplicate_files[base_filename] = duplicate_count + 1
+    return f"{base_filename}_{duplicate_count}.json" if duplicate_count else f"{base_filename}.json"
 
 
 def load_tealer_report(file_path: str) -> TealerAnalysisReport:
@@ -87,8 +84,10 @@ def generate_tealer_command(cur_file: Path, report_output_path: Path, detectors_
     """
 
     command = [
-        "poetry",
+        "pipx",
         "run",
+        "--spec",
+        "git+https://github.com/algorandfoundation/tealer.git@py3.12",
         "tealer",
         "--json",
         str(report_output_path),
@@ -136,7 +135,7 @@ def has_baseline_diff(*, cur_file: Path, report_output_path: Path, old_report: T
     """
 
     new_report = load_tealer_report(str(report_output_path))
-    baseline_diff = diff(old_report.model_dump(), new_report.model_dump())
+    baseline_diff = diff(old_report.model_dump(by_alias=True), new_report.model_dump(by_alias=True))
     if baseline_diff:
         logger.error(f"Diff detected in {cur_file}! Please check the content of " f"{report_output_path}.")
 

src/algokit/core/tasks/analyze.py

@@ -1,8 +1,26 @@
-from pytest import TempPathFactory
+from collections.abc import Generator
+from pathlib import Path
+from unittest.mock import patch
+
+import pytest
 
 from tests.utils.approvals import verify
 from tests.utils.click_invoker import invoke
 
+
+def _format_snapshot(output: str, targets: list[str], replacement: str = "dummy") -> str:
+    for target in targets:
+        output = output.replace(target, replacement)
+    return output
+
+
+@pytest.fixture()
+def mock_tealer_artifacts_path(tmp_path_factory: pytest.TempPathFactory) -> Generator[Path, None, None]:
+    cwd = tmp_path_factory.mktemp("cwd")
+    with patch("algokit.cli.tasks.analyze.generate_report_filename", return_value="dummy_content.teal"):
+        yield cwd
+
+
 # Default algokit beaker hello world contract
 # transpiled to TEAL
 TEAL_FILE_CONTENT = """
@@ -128,18 +146,21 @@
 """
 
 
-def test_analyze_single_file(tmp_path_factory: TempPathFactory) -> None:
+def test_analyze_single_file(
+    tmp_path_factory: pytest.TempPathFactory,
+    mock_tealer_artifacts_path: Path,
+) -> None:
     cwd = tmp_path_factory.mktemp("cwd")
     teal_file = cwd / "dummy.teal"
     teal_file.write_text(TEAL_FILE_CONTENT)
-    result = invoke(f"task analyze {teal_file}", input="y\n")
+    result = invoke(f"task analyze {teal_file} --output {cwd}", input="y\n", cwd=cwd)
 
     assert result.exit_code == 1
-    result.output = result.output.replace(str(teal_file), "dummy/path/dummy.teal")
+    _format_snapshot(result.output, [str(cwd), str(mock_tealer_artifacts_path)])
     verify(result.output)
 
 
-def test_analyze_multiple_files(tmp_path_factory: TempPathFactory) -> None:
+def test_analyze_multiple_files(tmp_path_factory: pytest.TempPathFactory) -> None:
     cwd = tmp_path_factory.mktemp("cwd")
     teal_folder = cwd / "dummy_contracts"
     teal_folder.mkdir()
@@ -154,7 +175,7 @@ def test_analyze_multiple_files(tmp_path_factory: TempPathFactory) -> None:
     verify(result.output)
 
 
-def test_analyze_multiple_files_recursive(tmp_path_factory: TempPathFactory) -> None:
+def test_analyze_multiple_files_recursive(tmp_path_factory: pytest.TempPathFactory) -> None:
     cwd = tmp_path_factory.mktemp("cwd")
     teal_root_folder = cwd / "dummy_contracts"
     teal_folder = teal_root_folder / "subfolder"
@@ -172,7 +193,7 @@ def test_analyze_multiple_files_recursive(tmp_path_factory: TempPathFactory) ->
     verify(result.output)
 
 
-def test_exclude_vulnerabilities(tmp_path_factory: TempPathFactory) -> None:
+def test_exclude_vulnerabilities(tmp_path_factory: pytest.TempPathFactory) -> None:
     cwd = tmp_path_factory.mktemp("cwd")
     teal_file = cwd / "dummy.teal"
     teal_file.write_text(TEAL_FILE_CONTENT)
@@ -186,7 +207,7 @@ def test_exclude_vulnerabilities(tmp_path_factory: TempPathFactory) -> None:
     verify(result.output)
 
 
-def test_analyze_skipping_tmpl_vars(tmp_path_factory: TempPathFactory) -> None:
+def test_analyze_skipping_tmpl_vars(tmp_path_factory: pytest.TempPathFactory) -> None:
     cwd = tmp_path_factory.mktemp("cwd")
     teal_file = cwd / "dummy.teal"
     teal_file.write_text(
@@ -199,7 +220,7 @@ def test_analyze_skipping_tmpl_vars(tmp_path_factory: TempPathFactory) -> None:
     verify(result.output)
 
 
-def test_analyze_abort_disclaimer(tmp_path_factory: TempPathFactory) -> None:
+def test_analyze_abort_disclaimer(tmp_path_factory: pytest.TempPathFactory) -> None:
     cwd = tmp_path_factory.mktemp("cwd")
     teal_file = cwd / "dummy.teal"
     teal_file.touch()
@@ -209,7 +230,7 @@ def test_analyze_abort_disclaimer(tmp_path_factory: TempPathFactory) -> None:
     verify(result.output)
 
 
-def test_analyze_error_in_tealer(tmp_path_factory: TempPathFactory) -> None:
+def test_analyze_error_in_tealer(tmp_path_factory: pytest.TempPathFactory) -> None:
     cwd = tmp_path_factory.mktemp("cwd")
     teal_file = cwd / "dummy.teal"
     teal_file.touch()
@@ -220,15 +241,16 @@ def test_analyze_error_in_tealer(tmp_path_factory: TempPathFactory) -> None:
     verify(result.output)
 
 
-def test_analyze_baseline_flag(tmp_path_factory: TempPathFactory) -> None:
+def test_analyze_baseline_flag(tmp_path_factory: pytest.TempPathFactory, mock_tealer_artifacts_path: Path) -> None:
     cwd = tmp_path_factory.mktemp("cwd")
     teal_file = cwd / "dummy.teal"
     teal_file.write_text(TEAL_FILE_CONTENT)
     result = invoke(f"task analyze {teal_file} --baseline", input="y\n")
-    assert result.exit_code == 0
+    assert result.exit_code == 1
 
     teal_file.write_text("\n#pragma version 8\nint 1\nreturn\n")
     result = invoke(f"task analyze {teal_file} --baseline", input="y\n")
     assert result.exit_code == 1
-    result.output = result.output.replace(str(teal_file), "dummy/path/dummy.teal")
+    result.output = result.output.replace(str(cwd), "dummy/path/dummy.teal")
+    result.output = result.output.replace(str(mock_tealer_artifacts_path), "dummy/path/dummy.teal")
     verify(result.output)

tests/tasks/test_analyze.py

@@ -1,8 +1,8 @@
 Standard disclaimer: This tool provides suggestions for improving your TEAL programs, but it does not guarantee their correctness or security. Do you understand? [y/N]: y
-DEBUG: Running 'poetry run tealer --json {current_working_directory}/.algokit/static-analysis/snapshots/cwd0_dummy.json detect --contracts dummy/path/dummy.teal' in '{current_working_directory}'
+DEBUG: Running 'poetry run tealer --json dummy/path/dummy.teal/.algokit/static-analysis/snapshots/cwd1_dummy.json detect --contracts dummy/path/dummy.teal/dummy.teal' in '{current_working_directory}'
 DEBUG: poetry: Configuration file exists at /Users/aorumbayev/Library/Preferences/pypoetry, reusing this directory.
 DEBUG: poetry: 
 DEBUG: poetry: Consider moving TOML configuration files to /Users/aorumbayev/Library/Application Support/pypoetry, as support for the legacy directory will be removed in an upcoming release.
-DEBUG: poetry: Reading contract from file: "dummy/path/dummy.teal"
-DEBUG: poetry: json output is written to {current_working_directory}/.algokit/static-analysis/snapshots/cwd0_dummy.json
-ERROR: Diff detected in dummy/path/dummy.teal! Please check the content of {current_working_directory}/.algokit/static-analysis/snapshots/cwd0_dummy.json.
+DEBUG: poetry: Reading contract from file: "dummy/path/dummy.teal/dummy.teal"
+DEBUG: poetry: json output is written to dummy/path/dummy.teal/.algokit/static-analysis/snapshots/cwd1_dummy.json
+ERROR: Diff detected in dummy/path/dummy.teal/dummy.teal! Please check the content of dummy/path/dummy.teal/.algokit/static-analysis/snapshots/cwd1_dummy.json.

tests/tasks/test_analyze.test_analyze_baseline_flag.approved.txt

@@ -1,5 +1,5 @@
 Standard disclaimer: This tool provides suggestions for improving your TEAL programs, but it does not guarantee their correctness or security. Do you understand? [y/N]: y
-DEBUG: Running 'poetry run tealer --json {current_working_directory}/.algokit/static-analysis/cwd0_dummy.json detect --contracts dummy/path/dummy.teal' in '{current_working_directory}'
+DEBUG: Running 'poetry run tealer --json {current_working_directory}/.algokit/static-analysis/cwd6_dummy.json detect --contracts dummy/path/dummy.teal' in '{current_working_directory}'
 DEBUG: poetry: Configuration file exists at /Users/aorumbayev/Library/Preferences/pypoetry, reusing this directory.
 DEBUG: poetry: 
 DEBUG: poetry: Consider moving TOML configuration files to /Users/aorumbayev/Library/Application Support/pypoetry, as support for the legacy directory will be removed in an upcoming release.

tests/tasks/test_analyze.test_analyze_error_in_tealer.approved.txt

@@ -1,12 +1,12 @@
 Standard disclaimer: This tool provides suggestions for improving your TEAL programs, but it does not guarantee their correctness or security. Do you understand? [y/N]: y
-DEBUG: Running 'poetry run tealer --json {current_working_directory}/.algokit/static-analysis/cwd0_dummy.json detect --contracts dummy/path/dummy.teal' in '{current_working_directory}'
+DEBUG: Running 'poetry run tealer --json {current_working_directory}/.algokit/static-analysis/dummy_contracts_dummy.json detect --contracts dummy/path/dummy.teal' in '{current_working_directory}'
 DEBUG: poetry: Configuration file exists at /Users/aorumbayev/Library/Preferences/pypoetry, reusing this directory.
 DEBUG: poetry: 
 DEBUG: poetry: Consider moving TOML configuration files to /Users/aorumbayev/Library/Application Support/pypoetry, as support for the legacy directory will be removed in an upcoming release.
 DEBUG: poetry: Reading contract from file: "dummy/path/dummy.teal"
-DEBUG: poetry: json output is written to {current_working_directory}/.algokit/static-analysis/cwd0_dummy.json
+DEBUG: poetry: json output is written to {current_working_directory}/.algokit/static-analysis/dummy_contracts_dummy.json
 
-File: .algokit/static-analysis/cwd0_dummy.json
+File: .algokit/static-analysis/dummy_contracts_dummy.json
 
 Detector: is-deletable
 Impact: High

tests/tasks/test_analyze.test_analyze_single_file.approved.txt

@@ -1,9 +1,9 @@
 Standard disclaimer: This tool provides suggestions for improving your TEAL programs, but it does not guarantee their correctness or security. Do you understand? [y/N]: y
-DEBUG: Running 'poetry run tealer --json {current_working_directory}/.algokit/static-analysis/cwd0_dummy.json detect --contracts dummy/path/dummy.teal --exclude is-deletable, missing-fee-check, rekey-to' in '{current_working_directory}'
+DEBUG: Running 'poetry run tealer --json {current_working_directory}/.algokit/static-analysis/dummycwd_dummy.json detect --contracts /private/var/folders/t6/57q65mk543l7xw6_bdgx1bmc0000gn/T/pytest-of-aorumbayev/pytest-53/dummycwd/dummy.teal --exclude is-deletable, missing-fee-check, rekey-to' in '{current_working_directory}'
 DEBUG: poetry: Configuration file exists at /Users/aorumbayev/Library/Preferences/pypoetry, reusing this directory.
 DEBUG: poetry: 
 DEBUG: poetry: Consider moving TOML configuration files to /Users/aorumbayev/Library/Application Support/pypoetry, as support for the legacy directory will be removed in an upcoming release.
-DEBUG: poetry: Reading contract from file: "dummy/path/dummy.teal"
-DEBUG: poetry: json output is written to {current_working_directory}/.algokit/static-analysis/cwd0_dummy.json
+DEBUG: poetry: Reading contract from file: "/private/var/folders/t6/57q65mk543l7xw6_bdgx1bmc0000gn/T/pytest-of-aorumbayev/pytest-53/dummycwd/dummy.teal"
+DEBUG: poetry: json output is written to {current_working_directory}/.algokit/static-analysis/dummycwd_dummy.json
 
 No issues identified.