genlayer-test 0.1.0b4__tar.gz → 0.1.0b5__tar.gz

{genlayer_test-0.1.0b4 → genlayer_test-0.1.0b5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: genlayer-test
-Version: 0.1.0b4
+Version: 0.1.0b5
 Summary: GenLayer Testing Suite
 Author: GenLayer
 License-Expression: MIT

{genlayer_test-0.1.0b4 → genlayer_test-0.1.0b5}/genlayer_test.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: genlayer-test
-Version: 0.1.0b4
+Version: 0.1.0b5
 Summary: GenLayer Testing Suite
 Author: GenLayer
 License-Expression: MIT

{genlayer_test-0.1.0b4 → genlayer_test-0.1.0b5}/genlayer_test.egg-info/SOURCES.txt

@@ -19,6 +19,9 @@ gltest/glchain/__init__.py
 gltest/glchain/account.py
 gltest/glchain/client.py
 gltest/glchain/contract.py
+gltest/helpers/__init__.py
+gltest/helpers/fixture_snapshot.py
+gltest/helpers/take_snapshot.py
 gltest_cli/main.py
 tests/conftest.py
 tests/test_plugin_hooks.py

genlayer_test-0.1.0b5/gltest/exceptions.py

@@ -0,0 +1,20 @@
+class DeploymentError(Exception):
+    """Raised when a contract deployment fails."""
+
+    pass
+class FixtureSnapshotError(Exception):
+    """Raised when there's an error restoring a snapshot."""
+    pass
+
+class FixtureAnonymousFunctionError(Exception):
+    """Raised when a fixture is an anonymous function."""
+    pass
+
+class InvalidSnapshotError(Exception):
+    """Raised when a snapshot is invalid."""
+    pass
+
+class HelperError(Exception):
+    """Raised when a helper function fails."""
+    pass
+

{genlayer_test-0.1.0b4 → genlayer_test-0.1.0b5}/gltest/glchain/__init__.py

@@ -1,5 +1,5 @@
 from .contract import Contract, ContractFactory, get_contract_factory
-from .client import get_gl_client
+from .client import get_gl_client, get_gl_provider
 from .account import create_accounts, create_account, accounts, default_account
 
 
@@ -12,4 +12,5 @@ __all__ = [
     "accounts",
     "create_accounts",
     "get_gl_client",
+    "get_gl_provider",
 ]

{genlayer_test-0.1.0b4 → genlayer_test-0.1.0b5}/gltest/glchain/client.py

@@ -13,3 +13,11 @@ def get_gl_client():
     return create_client(
         chain=localnet, account=default_account, endpoint=get_rpc_url()
     )
+
+
+def get_gl_provider():
+    """
+    Get the GenLayer provider instance.
+    """
+    client = get_gl_client()
+    return client.provider

genlayer_test-0.1.0b5/gltest/helpers/__init__.py

@@ -0,0 +1,8 @@
+from .take_snapshot import take_snapshot
+from .fixture_snapshot import load_fixture, clear_snapshots
+
+__all__ = [
+    "take_snapshot",
+    "load_fixture",
+    "clear_snapshots",
+]

genlayer_test-0.1.0b5/gltest/helpers/fixture_snapshot.py

@@ -0,0 +1,67 @@
+from typing import TypeVar, Callable, List, Any
+from dataclasses import dataclass
+from .take_snapshot import SnapshotRestorer, take_snapshot
+from gltest.exceptions import (
+    FixtureSnapshotError,
+    InvalidSnapshotError,
+    FixtureAnonymousFunctionError,
+)
+
+
+T = TypeVar("T")
+
+
+@dataclass
+class Snapshot:
+    """Represents a snapshot of the blockchain state."""
+
+    restorer: SnapshotRestorer
+    fixture: Callable[[], Any]
+    data: Any
+
+
+# Global storage for snapshots
+_snapshots: List[Snapshot] = []
+
+
+def load_fixture(fixture: Callable[[], T]) -> T:
+    """
+    Useful in tests for setting up the desired state of the network.
+    """
+    if fixture.__name__ == "<lambda>":
+        raise FixtureAnonymousFunctionError("Fixtures must be named functions")
+
+    # Find existing snapshot for this fixture
+    global _snapshots
+    snapshot = next((s for s in _snapshots if s.fixture == fixture), None)
+
+    if snapshot is not None:
+        try:
+            snapshot.restorer.restore()
+            # Remove snapshots that were taken after this one
+            
+            _snapshots = [
+                s
+                for s in _snapshots
+                if int(s.restorer.snapshot_id) <= int(snapshot.restorer.snapshot_id)
+            ]
+        except Exception as e:
+            if isinstance(e, InvalidSnapshotError):
+                raise FixtureSnapshotError(e) from e
+            raise e
+
+        return snapshot.data
+    else:
+        # Execute the fixture and take a snapshot
+        data = fixture()
+        restorer = take_snapshot()
+
+        _snapshots.append(Snapshot(restorer=restorer, fixture=fixture, data=data))
+
+        return data
+
+
+def clear_snapshots() -> None:
+    """Clears every existing snapshot."""
+    global _snapshots
+    _snapshots = []

genlayer_test-0.1.0b5/gltest/helpers/take_snapshot.py

@@ -0,0 +1,41 @@
+from gltest.glchain import get_gl_provider
+from dataclasses import dataclass
+from typing import Callable
+from gltest.exceptions import HelperError, InvalidSnapshotError
+
+
+@dataclass
+class SnapshotRestorer:
+    """Class responsible for restoring blockchain state to a snapshot."""
+
+    restore: Callable[[], None]
+    snapshot_id: int
+
+
+def take_snapshot() -> SnapshotRestorer:
+    """
+    Take a snapshot of the current blockchain state and return a function to restore the state and the snapshot ID.
+    """
+    provider = get_gl_provider()
+    snapshot_id = provider.make_request(method="sim_createSnapshot", params=[])[
+        "result"
+    ]
+    if not isinstance(snapshot_id, int):
+        raise HelperError(
+            "Assertion error: the value returned by evm_snapshot should be a int"
+        )
+
+    def restore() -> None:
+        reverted = provider.make_request(
+            method="sim_restoreSnapshot", params=[snapshot_id]
+        )["result"]
+
+        if not isinstance(reverted, bool):
+            raise HelperError(
+                "Assertion error: the value returned by evm_revert should be a boolean"
+            )
+
+        if not reverted:
+            raise InvalidSnapshotError("")
+
+    return SnapshotRestorer(restore=restore, snapshot_id=snapshot_id)

{genlayer_test-0.1.0b4 → genlayer_test-0.1.0b5}/gltest/plugin_hooks.py

@@ -35,7 +35,7 @@ def pytest_addoption(parser):
         "--rpc-url",
         action="store",
         default=SIMULATOR_JSON_RPC_URL,
-        help="Directory containing contract files",
+        help="RPC URL for the genlayer network",
     )
 
 

{genlayer_test-0.1.0b4 → genlayer_test-0.1.0b5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "genlayer-test"
-version = "0.1.0b4"
+version = "0.1.0b5"
 description = "GenLayer Testing Suite"
 authors = [
     { name = "GenLayer" }

{genlayer_test-0.1.0b4 → genlayer_test-0.1.0b5}/tests/test_plugin_hooks.py

@@ -12,7 +12,7 @@ def test_help_message(pytester):
             "*Default wait interval for waiting transaction receipts",
             "*--default-wait-retries=DEFAULT_WAIT_RETRIES",
             "*Default wait retries for waiting transaction receipts",
-            "*--rpc-url=RPC_URL*Directory containing contract files",
+            "*--rpc-url=RPC_URL*RPC URL for the genlayer network",
         ]
     )
 

genlayer_test-0.1.0b4/gltest/exceptions.py

@@ -1,4 +0,0 @@
-class DeploymentError(Exception):
-    """Raised when a contract deployment fails."""
-
-    pass