refactor: preparing codebase for gradual feature parity sync with uti…

…ls-ts

- Moving all v2 code into legacy_v2 folder inside src
- Moving all v2 tests into legacy_v2_tests
- Moving all files in beta into more granular folder structure

legacy_v2_tests/conftest.py

@@ -0,0 +1,211 @@
+import inspect
+import math
+import random
+import subprocess
+from pathlib import Path
+from typing import TYPE_CHECKING
+from uuid import uuid4
+
+import algosdk.transaction
+import pytest
+from algokit_utils import (
+    DELETABLE_TEMPLATE_NAME,
+    UPDATABLE_TEMPLATE_NAME,
+    Account,
+    ApplicationClient,
+    ApplicationSpecification,
+    EnsureBalanceParameters,
+    ensure_funded,
+    get_account,
+    get_algod_client,
+    get_indexer_client,
+    get_kmd_client_from_algod_client,
+    replace_template_variables,
+)
+from dotenv import load_dotenv
+
+from legacy_v2_tests import app_client_test
+
+if TYPE_CHECKING:
+    from algosdk.kmd import KMDClient
+    from algosdk.v2client.algod import AlgodClient
+    from algosdk.v2client.indexer import IndexerClient
+
+
+@pytest.fixture(autouse=True, scope="session")
+def _environment_fixture() -> None:
+    env_path = Path(__file__).parent / ".." / "example.env"
+    load_dotenv(env_path)
+
+
+def check_output_stability(logs: str, *, test_name: str | None = None) -> None:
+    """Test that the contract output hasn't changed for an Application, using git diff"""
+    caller_frame = inspect.stack()[1]
+    caller_path = Path(caller_frame.filename).resolve()
+    caller_dir = caller_path.parent
+    test_name = test_name or caller_frame.function
+    caller_stem = Path(caller_frame.filename).stem
+    output_dir = caller_dir / f"{caller_stem}.approvals"
+    output_dir.mkdir(exist_ok=True)
+    output_file = output_dir / f"{test_name}.approved.txt"
+    output_file_str = str(output_file)
+    output_file_did_exist = output_file.exists()
+    output_file.write_text(logs, encoding="utf-8")
+
+    git_diff = subprocess.run(
+        [
+            "git",
+            "diff",
+            "--exit-code",
+            "--no-ext-diff",
+            "--no-color",
+            output_file_str,
+        ],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT,
+        text=True,
+        check=False,
+    )
+    # first fail if there are any changes to already committed files, you must manually add them in that case
+    assert git_diff.returncode == 0, git_diff.stdout
+
+    # if first time running, fail in case of accidental change to output directory
+    if not output_file_did_exist:
+        pytest.fail(
+            f"New output folder created at {output_file_str} from test {test_name} - "
+            "if this was intentional, please commit the files to the git repo"
+        )
+
+
+def read_spec(
+    file_name: str,
+    *,
+    updatable: bool | None = None,
+    deletable: bool | None = None,
+    template_values: dict | None = None,
+) -> ApplicationSpecification:
+    path = Path(__file__).parent / file_name
+    spec = ApplicationSpecification.from_json(Path(path).read_text(encoding="utf-8"))
+
+    template_variables = template_values or {}
+    if updatable is not None:
+        template_variables["UPDATABLE"] = int(updatable)
+
+    if deletable is not None:
+        template_variables["DELETABLE"] = int(deletable)
+
+    spec.approval_program = (
+        replace_template_variables(spec.approval_program, template_variables)
+        .replace(f"// {UPDATABLE_TEMPLATE_NAME}", "// updatable")
+        .replace(f"// {DELETABLE_TEMPLATE_NAME}", "// deletable")
+    )
+    return spec
+
+
+def get_specs(
+    updatable: bool | None = None,
+    deletable: bool | None = None,
+) -> tuple[ApplicationSpecification, ApplicationSpecification, ApplicationSpecification]:
+    return (
+        read_spec("app_v1.json", updatable=updatable, deletable=deletable),
+        read_spec("app_v2.json", updatable=updatable, deletable=deletable),
+        read_spec("app_v3.json", updatable=updatable, deletable=deletable),
+    )
+
+
+def get_unique_name() -> str:
+    name = str(uuid4()).replace("-", "")
+    assert name.isalnum()
+    return name
+
+
+def is_opted_in(client_fixture: ApplicationClient) -> bool:
+    _, sender = client_fixture.resolve_signer_sender()
+    account_info = client_fixture.algod_client.account_info(sender)
+    assert isinstance(account_info, dict)
+    apps_local_state = account_info["apps-local-state"]
+    return any(x for x in apps_local_state if x["id"] == client_fixture.app_id)
+
+
+@pytest.fixture(scope="session")
+def algod_client() -> "AlgodClient":
+    return get_algod_client()
+
+
+@pytest.fixture(scope="session")
+def kmd_client(algod_client: "AlgodClient") -> "KMDClient":
+    return get_kmd_client_from_algod_client(algod_client)
+
+
+@pytest.fixture(scope="session")
+def indexer_client() -> "IndexerClient":
+    return get_indexer_client()
+
+
+@pytest.fixture()
+def creator(algod_client: "AlgodClient") -> Account:
+    creator_name = get_unique_name()
+    return get_account(algod_client, creator_name)
+
+
+@pytest.fixture(scope="session")
+def funded_account(algod_client: "AlgodClient") -> Account:
+    creator_name = get_unique_name()
+    return get_account(algod_client, creator_name)
+
+
+@pytest.fixture(scope="session")
+def app_spec() -> ApplicationSpecification:
+    app_spec = app_client_test.app.build()
+    path = Path(__file__).parent / "app_client_test.json"
+    path.write_text(app_spec.to_json())
+    return read_spec("app_client_test.json", deletable=True, updatable=True, template_values={"VERSION": 1})
+
+
+def generate_test_asset(algod_client: "AlgodClient", sender: Account, total: int | None) -> int:
+    if total is None:
+        total = math.floor(random.random() * 100) + 20
+
+    decimals = 0
+    asset_name = f"ASA ${math.floor(random.random() * 100) + 1}_${math.floor(random.random() * 100) + 1}_${total}"
+
+    params = algod_client.suggested_params()
+
+    txn = algosdk.transaction.AssetConfigTxn(
+        sender=sender.address,
+        sp=params,
+        total=total * 10**decimals,
+        decimals=decimals,
+        default_frozen=False,
+        unit_name="",
+        asset_name=asset_name,
+        manager=sender.address,
+        reserve=sender.address,
+        freeze=sender.address,
+        clawback=sender.address,
+        url="https://path/to/my/asset/details",
+        metadata_hash=None,
+        note=None,
+        lease=None,
+        rekey_to=None,
+    )  # type: ignore[no-untyped-call]
+
+    signed_transaction = txn.sign(sender.private_key)  # type: ignore[no-untyped-call]
+    algod_client.send_transaction(signed_transaction)
+    ptx = algod_client.pending_transaction_info(txn.get_txid())  # type: ignore[no-untyped-call]
+
+    if isinstance(ptx, dict) and "asset-index" in ptx and isinstance(ptx["asset-index"], int):
+        return ptx["asset-index"]
+    else:
+        raise ValueError("Unexpected response from pending_transaction_info")
+
+
+def assure_funds(algod_client: "AlgodClient", account: Account) -> None:
+    ensure_funded(
+        algod_client,
+        EnsureBalanceParameters(
+            account_to_fund=account,
+            min_spending_balance_micro_algos=300000,
+            min_funding_increment_micro_algos=1,
+        ),
+    )

tests/test_account.py → legacy_v2_tests/test_account.py

@@ -2,7 +2,7 @@
 
 from algokit_utils import get_account
 
-from tests.conftest import get_unique_name
+from legacy_v2_tests.conftest import get_unique_name
 
 if TYPE_CHECKING:
     from algosdk.v2client.algod import AlgodClient

tests/test_app_client_call.py → legacy_v2_tests/test_app_client_call.py

@@ -19,7 +19,7 @@
 )
 from algosdk.transaction import ApplicationCallTxn, PaymentTxn
 
-from tests.conftest import check_output_stability, get_unique_name
+from legacy_v2_tests.conftest import check_output_stability, get_unique_name
 
 if TYPE_CHECKING:
     from algosdk.abi import Method
@@ -40,7 +40,7 @@ def client_fixture(algod_client: "AlgodClient", app_spec: ApplicationSpecificati
 # If you need to run a test without debug mode, you can reference this mock within the test and disable it explicitly.
 @pytest.fixture(autouse=True)
 def mock_config() -> Generator[Mock, None, None]:
-    with patch("algokit_utils.application_client.config", new_callable=Mock) as mock_config:
+    with patch("algokit_utils._legacy_v2.application_client.config", new_callable=Mock) as mock_config:
         mock_config.debug = True
         mock_config.project_root = None
         yield mock_config

tests/test_app_client_clear_state.py → legacy_v2_tests/test_app_client_clear_state.py

@@ -8,7 +8,7 @@
     ApplicationSpecification,
 )
 
-from tests.conftest import is_opted_in
+from legacy_v2_tests.conftest import is_opted_in
 
 if TYPE_CHECKING:
     from algosdk.v2client.algod import AlgodClient

tests/test_app_client_close_out.py → legacy_v2_tests/test_app_client_close_out.py

@@ -8,7 +8,7 @@
     LogicError,
 )
 
-from tests.conftest import check_output_stability, is_opted_in
+from legacy_v2_tests.conftest import check_output_stability, is_opted_in
 
 if TYPE_CHECKING:
     from algosdk.v2client.algod import AlgodClient

tests/test_app_client_create.py → legacy_v2_tests/test_app_client_create.py

@@ -13,7 +13,7 @@
 from algosdk.atomic_transaction_composer import AccountTransactionSigner, AtomicTransactionComposer, TransactionSigner
 from algosdk.transaction import ApplicationCallTxn, GenericSignedTransaction, OnComplete, Transaction
 
-from tests.conftest import check_output_stability, get_unique_name
+from legacy_v2_tests.conftest import check_output_stability, get_unique_name
 
 if TYPE_CHECKING:
     from algosdk.v2client.algod import AlgodClient

tests/test_app_client_delete.py → legacy_v2_tests/test_app_client_delete.py

@@ -8,7 +8,7 @@
     LogicError,
 )
 
-from tests.conftest import check_output_stability
+from legacy_v2_tests.conftest import check_output_stability
 
 if TYPE_CHECKING:
     from algosdk.v2client.algod import AlgodClient

tests/test_app_client_deploy.py → legacy_v2_tests/test_app_client_deploy.py

@@ -10,7 +10,7 @@
     transfer,
 )
 
-from tests.conftest import get_unique_name, read_spec
+from legacy_v2_tests.conftest import get_unique_name, read_spec
 
 if TYPE_CHECKING:
     from algosdk.v2client.algod import AlgodClient

tests/test_app_client_opt_in.py → legacy_v2_tests/test_app_client_opt_in.py

@@ -8,7 +8,7 @@
     LogicError,
 )
 
-from tests.conftest import check_output_stability, is_opted_in
+from legacy_v2_tests.conftest import check_output_stability, is_opted_in
 
 if TYPE_CHECKING:
     from algosdk.v2client.algod import AlgodClient

tests/test_app_client_resolve.py → legacy_v2_tests/test_app_client_resolve.py

@@ -6,7 +6,7 @@
     DefaultArgumentDict,
 )
 
-from tests.conftest import read_spec
+from legacy_v2_tests.conftest import read_spec
 
 if TYPE_CHECKING:
     from algosdk.v2client.algod import AlgodClient

tests/test_app_client_template_values.py → legacy_v2_tests/test_app_client_template_values.py

@@ -3,7 +3,7 @@
 import algokit_utils
 import pytest
 
-from tests.conftest import get_unique_name, read_spec
+from legacy_v2_tests.conftest import get_unique_name, read_spec
 
 if TYPE_CHECKING:
     from algosdk.v2client.algod import AlgodClient
@@ -153,7 +153,7 @@ def test_deploy_with_multi_underscore_template_value(
     indexer_client: "IndexerClient",
     funded_account: algokit_utils.Account,
 ) -> None:
-    from tests.app_multi_underscore_template_var import app
+    from legacy_v2_tests.app_multi_underscore_template_var import app
 
     some_value = 123
     app_spec = app.build(algod_client)

tests/test_app_client_update.py → legacy_v2_tests/test_app_client_update.py

@@ -8,7 +8,7 @@
     LogicError,
 )
 
-from tests.conftest import check_output_stability
+from legacy_v2_tests.conftest import check_output_stability
 
 if TYPE_CHECKING:
     from algosdk.v2client.algod import AlgodClient

tests/test_asset.py → legacy_v2_tests/test_asset.py

@@ -16,7 +16,7 @@
     from algosdk.kmd import KMDClient
     from algosdk.v2client.algod import AlgodClient
 
-from tests.conftest import assure_funds, generate_test_asset, get_unique_name
+from legacy_v2_tests.conftest import assure_funds, generate_test_asset, get_unique_name
 
 
 @pytest.fixture()

tests/test_debug_utils.py → legacy_v2_tests/test_debug_utils.py

@@ -9,8 +9,8 @@
     persist_sourcemaps,
     simulate_and_persist_response,
 )
+from algokit_utils._legacy_v2.application_client import ApplicationClient
 from algokit_utils.account import get_account
-from algokit_utils.application_client import ApplicationClient
 from algokit_utils.application_specification import ApplicationSpecification
 from algokit_utils.common import Program
 from algokit_utils.models import Account
@@ -21,7 +21,7 @@
 )
 from algosdk.transaction import PaymentTxn
 
-from tests.conftest import check_output_stability, get_unique_name
+from legacy_v2_tests.conftest import check_output_stability, get_unique_name
 
 if TYPE_CHECKING:
     from algosdk.v2client.algod import AlgodClient
@@ -123,7 +123,7 @@ def test_simulate_and_persist_response_via_app_call(
     client_fixture: ApplicationClient,
     mocker: Mock,
 ) -> None:
-    mock_config = mocker.patch("algokit_utils.application_client.config")
+    mock_config = mocker.patch("algokit_utils._legacy_v2.application_client.config")
     mock_config.debug = True
     mock_config.trace_all = True
     mock_config.trace_buffer_size_mb = 256
@@ -145,7 +145,7 @@ def test_simulate_and_persist_response_via_app_call(
 def test_simulate_and_persist_response(
     tmp_path_factory: pytest.TempPathFactory, client_fixture: ApplicationClient, mocker: Mock, funded_account: Account
 ) -> None:
-    mock_config = mocker.patch("algokit_utils.application_client.config")
+    mock_config = mocker.patch("algokit_utils._legacy_v2.application_client.config")
     mock_config.debug = True
     mock_config.trace_all = True
     cwd = tmp_path_factory.mktemp("cwd")

tests/test_deploy.py → legacy_v2_tests/test_deploy.py

@@ -1,9 +1,9 @@
 from algokit_utils import (
     replace_template_variables,
 )
-from algokit_utils.deploy import strip_comments
+from algokit_utils._legacy_v2.deploy import strip_comments
 
-from tests.conftest import check_output_stability
+from legacy_v2_tests.conftest import check_output_stability
 
 
 def test_template_substitution() -> None: