chore: fixing race condition in tests (xdist); more robust tests

algorandfoundation · Mar 26, 2024 · e1e4728 · e1e4728
1 parent 2215bf7
commit e1e4728
Show file tree

Hide file tree

Showing 18 changed files with 93 additions and 61 deletions.
diff --git a/.github/workflows/check-python.yaml b/.github/workflows/check-python.yaml
@@ -17,6 +17,10 @@ jobs:
         # TODO: restore to algokit prior to release
         run: pipx install git+https://github.com/algorandfoundation/algokit-cli@feat/command_orchestration
 
+      - name: Run algokit localnet
+        # TODO: restore to algokit prior to release
+        run: algokit localnet reset
+
       - name: Set up Python 3.12
         uses: actions/setup-python@v5
         with:

diff --git a/.gitignore b/.gitignore
@@ -177,3 +177,7 @@ examples/**/poetry.lock
 # playground folder for previewing templates
 .playground/*
 !.playground/.gitkeep
+
+# Misc
+examples/**/smart_contracts/artifacts
+examples/**/.algokit/sources 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -5,11 +5,14 @@ This repository is a template for creating new AlgoKit projects. It includes a b
 ## Pre-requisites
 
 `poetry install` - Install the dependencies for the project.
+`pipx install algokit` - Ensure cli is installed.
 
 ## Testing
 
+Ensure localnet is running by executing `algokit localnet reset`.
+
 ```bash
-poetry run pytest
+poetry run pytest -n auto
 ```
 
 This will regenerate the tests for default `starter` and `production` presets as well as default tests for `generators` available on the template.

diff --git a/...lgokit/generators/create_contract/smart_contracts/{{ contract_name }}/deploy_config.py.j2 b/...lgokit/generators/create_contract/smart_contracts/{{ contract_name }}/deploy_config.py.j2
@@ -38,9 +38,11 @@ def deploy(
             if is_mainnet
             else algokit_utils.OnSchemaBreak.ReplaceApp
         ),
-        on_update=algokit_utils.OnUpdate.AppendApp
-        if is_mainnet
-        else algokit_utils.OnUpdate.UpdateApp,
+        on_update=(
+            algokit_utils.OnUpdate.AppendApp
+            if is_mainnet
+            else algokit_utils.OnUpdate.UpdateApp
+        ),
         allow_delete=not is_mainnet,
         allow_update=not is_mainnet,
     )

diff --git a/examples/generators/production_beaker_smart_contract_python/smart_contracts/config.py b/examples/generators/production_beaker_smart_contract_python/smart_contracts/config.py
@@ -12,9 +12,10 @@
 @dataclasses.dataclass
 class SmartContract:
     app: Application
-    deploy: Callable[
-        [AlgodClient, IndexerClient, ApplicationSpecification, Account], None
-    ] | None = None
+    deploy: (
+        Callable[[AlgodClient, IndexerClient, ApplicationSpecification, Account], None]
+        | None
+    ) = None
 
 
 def import_contract(folder: Path) -> Application:

diff --git a/...rs/production_beaker_smart_contract_python/smart_contracts/cool_contract/deploy_config.py b/...rs/production_beaker_smart_contract_python/smart_contracts/cool_contract/deploy_config.py
@@ -30,9 +30,11 @@ def deploy(
             if is_mainnet
             else algokit_utils.OnSchemaBreak.ReplaceApp
         ),
-        on_update=algokit_utils.OnUpdate.AppendApp
-        if is_mainnet
-        else algokit_utils.OnUpdate.UpdateApp,
+        on_update=(
+            algokit_utils.OnUpdate.AppendApp
+            if is_mainnet
+            else algokit_utils.OnUpdate.UpdateApp
+        ),
         allow_delete=not is_mainnet,
         allow_update=not is_mainnet,
     )

diff --git a/...tors/production_beaker_smart_contract_python/smart_contracts/hello_world/deploy_config.py b/...tors/production_beaker_smart_contract_python/smart_contracts/hello_world/deploy_config.py
@@ -30,9 +30,11 @@ def deploy(
             if is_mainnet
             else algokit_utils.OnSchemaBreak.ReplaceApp
         ),
-        on_update=algokit_utils.OnUpdate.AppendApp
-        if is_mainnet
-        else algokit_utils.OnUpdate.UpdateApp,
+        on_update=(
+            algokit_utils.OnUpdate.AppendApp
+            if is_mainnet
+            else algokit_utils.OnUpdate.UpdateApp
+        ),
         allow_delete=not is_mainnet,
         allow_update=not is_mainnet,
     )

diff --git a/examples/generators/production_beaker_smart_contract_typescript/smart_contracts/config.py b/examples/generators/production_beaker_smart_contract_typescript/smart_contracts/config.py
@@ -12,9 +12,10 @@
 @dataclasses.dataclass
 class SmartContract:
     app: Application
-    deploy: Callable[
-        [AlgodClient, IndexerClient, ApplicationSpecification, Account], None
-    ] | None = None
+    deploy: (
+        Callable[[AlgodClient, IndexerClient, ApplicationSpecification, Account], None]
+        | None
+    ) = None
 
 
 def import_contract(folder: Path) -> Application:

diff --git a/examples/generators/starter_beaker_smart_contract_python/smart_contracts/config.py b/examples/generators/starter_beaker_smart_contract_python/smart_contracts/config.py
@@ -12,9 +12,10 @@
 @dataclasses.dataclass
 class SmartContract:
     app: Application
-    deploy: Callable[
-        [AlgodClient, IndexerClient, ApplicationSpecification, Account], None
-    ] | None = None
+    deploy: (
+        Callable[[AlgodClient, IndexerClient, ApplicationSpecification, Account], None]
+        | None
+    ) = None
 
 
 def import_contract(folder: Path) -> Application:

diff --git a/examples/generators/starter_beaker_smart_contract_typescript/smart_contracts/config.py b/examples/generators/starter_beaker_smart_contract_typescript/smart_contracts/config.py
@@ -12,9 +12,10 @@
 @dataclasses.dataclass
 class SmartContract:
     app: Application
-    deploy: Callable[
-        [AlgodClient, IndexerClient, ApplicationSpecification, Account], None
-    ] | None = None
+    deploy: (
+        Callable[[AlgodClient, IndexerClient, ApplicationSpecification, Account], None]
+        | None
+    ) = None
 
 
 def import_contract(folder: Path) -> Application:

diff --git a/examples/production_beaker/smart_contracts/config.py b/examples/production_beaker/smart_contracts/config.py
@@ -12,9 +12,10 @@
 @dataclasses.dataclass
 class SmartContract:
     app: Application
-    deploy: Callable[
-        [AlgodClient, IndexerClient, ApplicationSpecification, Account], None
-    ] | None = None
+    deploy: (
+        Callable[[AlgodClient, IndexerClient, ApplicationSpecification, Account], None]
+        | None
+    ) = None
 
 
 def import_contract(folder: Path) -> Application:

diff --git a/examples/production_beaker/smart_contracts/hello_world/deploy_config.py b/examples/production_beaker/smart_contracts/hello_world/deploy_config.py
@@ -30,9 +30,11 @@ def deploy(
             if is_mainnet
             else algokit_utils.OnSchemaBreak.ReplaceApp
         ),
-        on_update=algokit_utils.OnUpdate.AppendApp
-        if is_mainnet
-        else algokit_utils.OnUpdate.UpdateApp,
+        on_update=(
+            algokit_utils.OnUpdate.AppendApp
+            if is_mainnet
+            else algokit_utils.OnUpdate.UpdateApp
+        ),
         allow_delete=not is_mainnet,
         allow_update=not is_mainnet,
     )

diff --git a/examples/starter_beaker/smart_contracts/config.py b/examples/starter_beaker/smart_contracts/config.py
@@ -12,9 +12,10 @@
 @dataclasses.dataclass
 class SmartContract:
     app: Application
-    deploy: Callable[
-        [AlgodClient, IndexerClient, ApplicationSpecification, Account], None
-    ] | None = None
+    deploy: (
+        Callable[[AlgodClient, IndexerClient, ApplicationSpecification, Account], None]
+        | None
+    ) = None
 
 
 def import_contract(folder: Path) -> Application:

diff --git a/...{% endraw %}/{% if deployment_language == 'python' %}deploy_config.py.j2{% endif %}.jinja b/...{% endraw %}/{% if deployment_language == 'python' %}deploy_config.py.j2{% endif %}.jinja
@@ -39,9 +39,11 @@ def deploy(
             if is_mainnet
             else algokit_utils.OnSchemaBreak.ReplaceApp
         ),
-        on_update=algokit_utils.OnUpdate.AppendApp
-        if is_mainnet
-        else algokit_utils.OnUpdate.UpdateApp,
+        on_update=(
+            algokit_utils.OnUpdate.AppendApp
+            if is_mainnet
+            else algokit_utils.OnUpdate.UpdateApp
+        ),
         allow_delete=not is_mainnet,
         allow_update=not is_mainnet,
     )

diff --git a/template_content/smart_contracts/config.py.jinja b/template_content/smart_contracts/config.py.jinja
@@ -12,9 +12,10 @@ from beaker import Application
 @dataclasses.dataclass
 class SmartContract:
     app: Application
-    deploy: Callable[
-        [AlgodClient, IndexerClient, ApplicationSpecification, Account], None
-    ] | None = None
+    deploy: (
+        Callable[[AlgodClient, IndexerClient, ApplicationSpecification, Account], None]
+        | None
+    ) = None
 
 
 def import_contract(folder: Path) -> Application:

diff --git a/...ontract_name }}/{% if deployment_language == 'python' %}deploy_config.py{% endif %}.jinja b/...ontract_name }}/{% if deployment_language == 'python' %}deploy_config.py{% endif %}.jinja
@@ -38,9 +38,11 @@ def deploy(
             if is_mainnet
             else algokit_utils.OnSchemaBreak.ReplaceApp
         ),
-        on_update=algokit_utils.OnUpdate.AppendApp
-        if is_mainnet
-        else algokit_utils.OnUpdate.UpdateApp,
+        on_update=(
+            algokit_utils.OnUpdate.AppendApp
+            if is_mainnet
+            else algokit_utils.OnUpdate.UpdateApp
+        ),
         allow_delete=not is_mainnet,
         allow_update=not is_mainnet,
     )

diff --git a/tests/test_generators.py b/tests/test_generators.py
@@ -20,12 +20,9 @@
 }
 config_path = Path(__file__).parent.parent / "pyproject.toml"
 BLACK_ARGS = ["black", "--check", "--diff", "--config", str(config_path), "."]
-RUFF_ARGS = ["ruff", "--diff", "--config", str(config_path), "."]
-MYPY_ARGS = [
-    "mypy",
-    "--ignore-missing-imports",  # TODO: only ignore missing typed clients in config.py
-    ".",
-]
+BUILD_ARGS = ["algokit", "project", "run", "build"]
+TEST_ARGS = ["algokit", "project", "run", "test"]
+LINT_ARGS = ["algokit", "project", "run", "lint"]
 
 
 def _load_copier_yaml(path: Path) -> dict[str, str | bool | dict]:
@@ -52,7 +49,12 @@ def working_dir() -> Iterator[Path]:
 
             dest_dir = generated_root / src_dir.stem
             shutil.rmtree(dest_dir, ignore_errors=True)
-            shutil.copytree(src_dir, dest_dir, dirs_exist_ok=True)
+            shutil.copytree(
+                src_dir,
+                dest_dir,
+                dirs_exist_ok=True,
+                ignore=shutil.ignore_patterns(".*_cache", ".venv", "__pycache__"),
+            )
 
 
 def run_init(
@@ -88,7 +90,6 @@ def run_init(
         "--defaults",
         "--no-ide",
         "--no-git",
-        "--no-bootstrap",
         "--no-workspace",
     ]
     answers = {**DEFAULT_PARAMETERS, **(answers or {})}
@@ -121,13 +122,13 @@ def check_codebase(working_dir: Path, test_name: str) -> subprocess.CompletedPro
     content = src_path_pattern.sub("_src_path: <src>", content)
     copier_answers.write_text(content, "utf-8")
 
-    check_args = [BLACK_ARGS]
+    check_args = [BLACK_ARGS, BUILD_ARGS]
 
     # Starter template does not have ruff config or mypy config by default
     # so only check for them if the starter template is not used
     processed_questions = _load_copier_yaml(copier_answers)
     if processed_questions["preset_name"] == "production":
-        check_args += [RUFF_ARGS, MYPY_ARGS]
+        check_args += [LINT_ARGS, TEST_ARGS]
 
     for check_arg in check_args:
         result = subprocess.run(

diff --git a/tests/test_templates.py b/tests/test_templates.py
@@ -19,13 +19,10 @@
     "author_email": "None",
 }
 config_path = Path(__file__).parent.parent / "pyproject.toml"
-BLACK_ARGS = ["black", "--check", "--diff", "--config", str(config_path), "."]
-RUFF_ARGS = ["ruff", "--diff", "--config", str(config_path), "."]
-MYPY_ARGS = [
-    "mypy",
-    "--ignore-missing-imports",  # TODO: only ignore missing typed clients in config.py
-    ".",
-]
+BASELINE_LINT_ARGS = ["black", "--check", "--diff", "--config", str(config_path), "."]
+BUILD_ARGS = ["algokit", "project", "run", "build"]
+TEST_ARGS = ["algokit", "project", "run", "test"]
+LINT_ARGS = ["algokit", "project", "run", "lint"]
 
 
 def _load_copier_yaml(path: Path) -> dict[str, str | bool | dict]:
@@ -52,7 +49,12 @@ def working_dir() -> Iterator[Path]:
 
             dest_dir = generated_root / src_dir.stem
             shutil.rmtree(dest_dir, ignore_errors=True)
-            shutil.copytree(src_dir, dest_dir, dirs_exist_ok=True)
+            shutil.copytree(
+                src_dir,
+                dest_dir,
+                dirs_exist_ok=True,
+                ignore=shutil.ignore_patterns(".*_cache", ".venv", "__pycache__"),
+            )
 
 
 def run_init(
@@ -88,7 +90,6 @@ def run_init(
         "--defaults",
         "--no-ide",
         "--no-git",
-        "--no-bootstrap",
         "--no-workspace",
     ]
     answers = {**DEFAULT_PARAMETERS, **(answers or {})}
@@ -118,13 +119,13 @@ def run_init(
     content = src_path_pattern.sub("_src_path: <src>", content)
     copier_answers.write_text(content, "utf-8")
 
-    check_args = [BLACK_ARGS]
+    check_args = [BUILD_ARGS, BASELINE_LINT_ARGS]
 
     # Starter template does not have ruff config or mypy config by default
     # so only check for them if the starter template is not used
     processed_questions = _load_copier_yaml(copier_answers)
     if processed_questions["preset_name"] == "production":
-        check_args += [RUFF_ARGS, MYPY_ARGS]
+        check_args += [LINT_ARGS, TEST_ARGS]
 
     for check_arg in check_args:
         result = subprocess.run(