genlayer-test 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

{genlayer_test-0.1.1.dist-info → genlayer_test-0.1.3.dist-info}/METADATA

@@ -1,22 +1,20 @@
 Metadata-Version: 2.4
 Name: genlayer-test
-Version: 0.1.1
+Version: 0.1.3
 Summary: GenLayer Testing Suite
 Author: GenLayer
 License-Expression: MIT
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Testing
-Requires-Python: >=3.8
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pytest
-Requires-Dist: genlayer-py==0.1.0
+Requires-Dist: genlayer-py==0.3.0
 Dynamic: license-file
 
 # GenLayer Testing Suite
@@ -162,7 +160,7 @@ Before diving into the examples, let's understand the basic project structure:
 ```
 genlayer-example/
 ├── contracts/              # Contract definitions
-│   └── storage.gpy         # Example storage contract
+│   └── storage.py          # Example storage contract
 └── test/                   # Test files
     └── test_contract.py    # Contract test cases
 ```
@@ -279,6 +277,44 @@ def test_write_methods():
     assert contract.get_storage() == "new_value"
 ```
 
+### Assertions
+
+The GenLayer Testing Suite provides powerful assertion functions to validate transaction results and their output:
+
+#### Basic Transaction Assertions
+
+```python
+from gltest.assertions import tx_execution_succeeded, tx_execution_failed
+
+# Basic success/failure checks
+assert tx_execution_succeeded(tx_receipt)
+assert tx_execution_failed(tx_receipt)  # Opposite of tx_execution_succeeded
+```
+
+#### Advanced Output Matching
+
+You can match specific patterns in the transaction's stdout and stderr output using regex patterns, similar to pytest's `match` parameter:
+
+```python
+# Simple string matching
+assert tx_execution_succeeded(tx_receipt, match_std_out="Process completed")
+assert tx_execution_failed(tx_receipt, match_std_err="Warning: deprecated")
+
+# Regex pattern matching
+assert tx_execution_succeeded(tx_receipt, match_std_out=r".*code \d+")
+assert tx_execution_failed(tx_receipt, match_std_err=r"Method.*failed")
+```
+
+#### Assertion Function Parameters
+
+Both `tx_execution_succeeded` and `tx_execution_failed` accept the following parameters:
+
+- `result`: The transaction result object from contract method calls
+- `match_std_out` (optional): String or regex pattern to match in stdout
+- `match_std_err` (optional): String or regex pattern to match in stderr
+
+**Network Compatibility**: The stdout/stderr matching feature (`match_std_out` and `match_std_err` parameters) is only available when running on **studionet** and **localnet**. These features are not supported on testnet.
+
 For more example contracts, check out the [contracts directory](tests/examples/contracts) which contains various sample contracts demonstrating different features and use cases.
 
 ## 📝 Best Practices
@@ -354,7 +390,7 @@ For more example contracts, check out the [contracts directory](tests/examples/c
    # Default structure
    your_project/
    ├── contracts/           # Default contracts directory
-   │   └── my_contract.gpy  # Your contract file
+   │   └── my_contract.py   # Your contract file
    └── tests/
        └── test_contract.py # Your test file
    
@@ -366,7 +402,8 @@ For more example contracts, check out the [contracts directory](tests/examples/c
    - **Problem**: Contracts aren't being recognized or loaded properly.
    - **Solution**: Follow the correct naming and structure conventions:
    ```python
-   # Correct file: contracts/my_contract.gpy
+   # Correct file: contracts/my_contract.py
+
    # Correct structure:
    from genlayer import *
    
@@ -374,7 +411,7 @@ For more example contracts, check out the [contracts directory](tests/examples/c
        # Contract code here
        pass
    
-   # Incorrect file: contracts/my_contract.py  # Wrong extension
+
    # Incorrect structure:
    class MyContract:  # Missing gl.Contract inheritance
        pass
@@ -385,7 +422,7 @@ For more example contracts, check out the [contracts directory](tests/examples/c
    - **Solution**: Verify your environment:
    ```bash
    # Check Python version
-   python --version  # Should be >= 3.8
+   python --version  # Should be >= 3.12
    
    # Check GenLayer Studio status
    docker ps  # Should show GenLayer Studio running

{genlayer_test-0.1.1.dist-info → genlayer_test-0.1.3.dist-info}/RECORD

@@ -1,12 +1,12 @@
-genlayer_test-0.1.1.dist-info/licenses/LICENSE,sha256=che_H4vE0QUx3HvWrAa1_jDEVInift0U6VO15-QqEls,1064
+genlayer_test-0.1.3.dist-info/licenses/LICENSE,sha256=che_H4vE0QUx3HvWrAa1_jDEVInift0U6VO15-QqEls,1064
 gltest/__init__.py,sha256=AK_YfRvwlhrOheOelUG8qIRG17on0-nFCF747dopg2w,332
-gltest/assertions.py,sha256=O9pHt9aOxMVYk_C2fF2-qzT_xYMaK0YigR3HXeejmaU,590
+gltest/assertions.py,sha256=0dEk0VxcHK4I7GZPHxJmz-2jaA60V499gOSR74rZbfM,1748
 gltest/exceptions.py,sha256=deJPmrTe5gF33qkkKF2IVJY7lc_knI7Ql3N7jZ8aLZs,510
 gltest/plugin_config.py,sha256=8Z97RtEJ89OcRbki_oRuBBVct_q56BFmKvthan1y9Y4,840
 gltest/plugin_hooks.py,sha256=py1rzIR9QSsFOt8SEePPL96e-8DeiPFxvcPZurRlExM,1436
 gltest/types.py,sha256=BODmwTr2gAUEiO9FjiuTiWwuKvXgo4xZWstQWNUfnlw,156
 gltest/artifacts/__init__.py,sha256=qiJN5F1cVh_3fmxZeDFznoABxAdLhLqBfUUKwqXqvgo,87
-gltest/artifacts/contract.py,sha256=CBRfUTltKv2tPy--LcmVbP_4hbXYt9VrunvJlMzNd5s,3566
+gltest/artifacts/contract.py,sha256=0Sp8YTKBw7hwuhIQ7Q-PnchxNfusF0HNAcWaWPWT9Cg,3570
 gltest/glchain/__init__.py,sha256=X-mEbREoAOe9K4n74C55gCiXH4wItzY5HTJcg3_F3mI,412
 gltest/glchain/account.py,sha256=ZxYsfbtBXKVC5vV4pko3yyL6lhPljqIb68NgIgvInSc,403
 gltest/glchain/client.py,sha256=q04LIQy5SCIrYZflZiTapfeQ-AaSTa0w369ehnVbJLM,532
@@ -17,6 +17,7 @@ gltest/helpers/take_snapshot.py,sha256=eXqEKXM2hcox3pLGIcNddobU8zXPQvD-Iwf87eHqW
 gltest_cli/main.py,sha256=Ti2-0Ev1x5_cM0D1UKqdgaDt80CDHEQGtdRne2qLm4M,53
 tests/artifact/test_contract_definition.py,sha256=8X829MsNfEObtIMmotk6nRVLDEp5KfJE6zrAK4IPfCc,3323
 tests/artifact/contracts/not_ic_contract.py,sha256=hQyGnYiiVceYdLI2WrvcFgPqzy1S4-YMb9FPhiHEGSA,510
+tests/assertions/test_assertions.py,sha256=qzVrOdOM4xYtIy1sFHVAD_-naDHOequ23tEN0MELh0k,10781
 tests/examples/contracts/football_prediction_market.py,sha256=kdouFijjeCdIJyaVJlgXcqbBAXecA9_YdhklSsIW-QM,3219
 tests/examples/contracts/intelligent_oracle.py,sha256=WrNZWWoi1sz22Azt2EXgdWHDg5Ihca2pWUHrM9pVfQE,12319
 tests/examples/contracts/intelligent_oracle_factory.py,sha256=ax496IZuDCA728rRcbjwTaM4Q4E-Y1jGkHsEcyf1cig,1490
@@ -45,8 +46,8 @@ tests/examples/tests/test_user_storage.py,sha256=QEgt2p22LAyzBnBb0YW4BWa_Jasrt15
 tests/examples/tests/test_wizard_of_coin.py,sha256=aUDeV5w0XONMMS71Vzw80lHfcSM0z8RKPJSXAuDwRto,392
 tests/plugin/conftest.py,sha256=RKdoE5_zcMimeojAoA_GSFI9du4pMzMi1vZ1njtfoAs,28
 tests/plugin/test_plugin_hooks.py,sha256=FQOrkhoXLinq0sjvoYjr63Oqg-ZVPcNFeUrK4bqrn4E,2020
-genlayer_test-0.1.1.dist-info/METADATA,sha256=SLlBr5OZZWmgBKAfkz889L-k7mMYX92PFyiCjK67oVQ,13471
-genlayer_test-0.1.1.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-genlayer_test-0.1.1.dist-info/entry_points.txt,sha256=rXhrPVq2IhVsd4uWzxzwCTx7jA1KcQIVNxDCUuxq4f8,89
-genlayer_test-0.1.1.dist-info/top_level.txt,sha256=-qiGZxTRBytujzgVcKpxjvQ-WNeUDjXa59ceGMwMpko,24
-genlayer_test-0.1.1.dist-info/RECORD,,
+genlayer_test-0.1.3.dist-info/METADATA,sha256=10N09rjm2S2uoCmyyVu6A9hPuU6w2-_rP8jU4HYsNc0,14814
+genlayer_test-0.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+genlayer_test-0.1.3.dist-info/entry_points.txt,sha256=rXhrPVq2IhVsd4uWzxzwCTx7jA1KcQIVNxDCUuxq4f8,89
+genlayer_test-0.1.3.dist-info/top_level.txt,sha256=-qiGZxTRBytujzgVcKpxjvQ-WNeUDjXa59ceGMwMpko,24
+genlayer_test-0.1.3.dist-info/RECORD,,

{genlayer_test-0.1.1.dist-info → genlayer_test-0.1.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

gltest/artifacts/contract.py

@@ -10,7 +10,7 @@ from typing import Union
 
 @dataclass
 class ContractDefinition:
-    """Class that represents a contract definition from a .gpy file."""
+    """Class that represents a contract definition from a contract file."""
 
     contract_name: str
     contract_code: Union[str, bytes]

gltest/assertions.py

@@ -1,16 +1,59 @@
+import re
+from typing import Optional
 from genlayer_py.types import GenLayerTransaction
 
 
-def tx_execution_succeeded(result: GenLayerTransaction) -> bool:
+def tx_execution_succeeded(
+    result: GenLayerTransaction,
+    match_std_out: Optional[str] = None,
+    match_std_err: Optional[str] = None,
+) -> bool:
     if "consensus_data" not in result:
         return False
     if "leader_receipt" not in result["consensus_data"]:
         return False
-    if "execution_result" not in result["consensus_data"]["leader_receipt"]:
+    if len(result["consensus_data"]["leader_receipt"]) == 0:
         return False
-    execution_result = result["consensus_data"]["leader_receipt"]["execution_result"]
-    return execution_result == "SUCCESS"
 
+    leader_receipt = result["consensus_data"]["leader_receipt"][0]
 
-def tx_execution_failed(result: GenLayerTransaction) -> bool:
-    return not tx_execution_succeeded(result)
+    if "execution_result" not in leader_receipt:
+        return False
+
+    execution_result = leader_receipt["execution_result"]
+
+    if execution_result != "SUCCESS":
+        return False
+
+    if match_std_out is not None or match_std_err is not None:
+        if "genvm_result" not in leader_receipt:
+            return False
+
+        genvm_result = leader_receipt["genvm_result"]
+
+        if match_std_out is not None:
+            if "stdout" not in genvm_result:
+                return False
+            try:
+                if not re.search(match_std_out, genvm_result["stdout"]):
+                    return False
+            except re.error:
+                return False
+
+        if match_std_err is not None:
+            if "stderr" not in genvm_result:
+                return False
+            try:
+                if not re.search(match_std_err, genvm_result["stderr"]):
+                    return False
+            except re.error:
+                return False
+    return True
+
+
+def tx_execution_failed(
+    result: GenLayerTransaction,
+    match_std_out: Optional[str] = None,
+    match_std_err: Optional[str] = None,
+) -> bool:
+    return not tx_execution_succeeded(result, match_std_out, match_std_err)

tests/assertions/test_assertions.py

@@ -0,0 +1,344 @@
+from gltest.assertions import tx_execution_succeeded, tx_execution_failed
+
+GENLAYER_SUCCESS_TRANSACTION = {
+    "consensus_data": {"leader_receipt": [{"execution_result": "SUCCESS"}]}
+}
+
+GENLAYER_FAILED_TRANSACTION = {
+    "consensus_data": {"leader_receipt": [{"execution_result": "ERROR"}]}
+}
+
+GENLAYER_EMPTY_LEADER_RECEIPT = {"consensus_data": {"leader_receipt": []}}
+
+GENLAYER_GENVM_TRANSACTION = {
+    "consensus_data": {
+        "leader_receipt": [
+            {
+                "execution_result": "SUCCESS",
+                "genvm_result": {
+                    "stdout": "Process completed successfully with code 123 items",
+                    "stderr": "Warning: deprecated function used",
+                },
+            }
+        ]
+    }
+}
+
+GENLAYER_GENVM_EMPTY_STDERR = {
+    "consensus_data": {
+        "leader_receipt": [
+            {
+                "execution_result": "SUCCESS",
+                "genvm_result": {
+                    "stdout": "Task finished without errors",
+                    "stderr": "",
+                },
+            }
+        ]
+    }
+}
+
+GENLAYER_GENVM_NO_STDOUT = {
+    "consensus_data": {
+        "leader_receipt": [
+            {
+                "execution_result": "SUCCESS",
+                "genvm_result": {"stderr": "Error occurred"},
+            }
+        ]
+    }
+}
+
+GENLAYER_GENVM_FAILED = {
+    "consensus_data": {
+        "leader_receipt": [
+            {
+                "execution_result": "ERROR",
+                "genvm_result": {
+                    "stdout": "Process failed",
+                    "stderr": "Critical error occurred",
+                },
+            }
+        ]
+    }
+}
+
+
+def test_with_successful_transaction():
+    """Test assertion functions with a basic successful transaction.
+
+    Validates that:
+    - tx_execution_succeeded returns True for successful transactions
+    - tx_execution_failed returns False for successful transactions
+    """
+    assert tx_execution_succeeded(GENLAYER_SUCCESS_TRANSACTION) is True
+    assert tx_execution_failed(GENLAYER_SUCCESS_TRANSACTION) is False
+
+
+def test_with_failed_transaction():
+    """Test assertion functions with a basic failed transaction.
+
+    Validates that:
+    - tx_execution_succeeded returns False for failed transactions
+    - tx_execution_failed returns True for failed transactions
+    """
+    assert tx_execution_succeeded(GENLAYER_FAILED_TRANSACTION) is False
+    assert tx_execution_failed(GENLAYER_FAILED_TRANSACTION) is True
+
+
+def test_with_empty_leader_receipt():
+    """Test assertion functions with empty leader_receipt array.
+
+    Validates that:
+    - Both functions handle empty leader_receipt gracefully
+    - Empty leader_receipt is treated as a failed transaction
+    """
+    assert tx_execution_succeeded(GENLAYER_EMPTY_LEADER_RECEIPT) is False
+    assert tx_execution_failed(GENLAYER_EMPTY_LEADER_RECEIPT) is True
+
+
+def test_with_invalid_transaction():
+    """Test assertion functions with completely invalid transaction structure.
+
+    Validates that:
+    - Both functions handle malformed transactions gracefully
+    - Invalid transactions are treated as failed
+    """
+    assert tx_execution_succeeded({}) is False
+    assert tx_execution_failed({}) is True
+
+
+def test_genvm_result_without_match():
+    """Test assertion functions with genvm_result but no match parameters.
+
+    Validates that:
+    - Transactions with genvm_result succeed when execution_result is SUCCESS
+    - No match parameters means only basic execution status is checked
+    """
+    assert tx_execution_succeeded(GENLAYER_GENVM_TRANSACTION) is True
+    assert tx_execution_failed(GENLAYER_GENVM_TRANSACTION) is False
+
+
+def test_match_std_out_simple_string():
+    """Test stdout matching with simple string patterns.
+
+    Validates that:
+    - Simple string matching works correctly in stdout
+    - Non-matching strings cause the assertion to fail
+    - tx_execution_failed behaves oppositely to tx_execution_succeeded
+    """
+    assert (
+        tx_execution_succeeded(
+            GENLAYER_GENVM_TRANSACTION, match_std_out="Process completed"
+        )
+        is True
+    )
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_TRANSACTION, match_std_out="nonexistent")
+        is False
+    )
+    assert (
+        tx_execution_failed(GENLAYER_GENVM_TRANSACTION, match_std_out="nonexistent")
+        is True
+    )
+
+
+def test_match_std_err_simple_string():
+    """Test stderr matching with simple string patterns.
+
+    Validates that:
+    - Simple string matching works correctly in stderr
+    - Non-matching strings cause the assertion to fail
+    - tx_execution_failed behaves oppositely to tx_execution_succeeded
+    """
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_TRANSACTION, match_std_err="Warning")
+        is True
+    )
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_TRANSACTION, match_std_err="nonexistent")
+        is False
+    )
+    assert (
+        tx_execution_failed(GENLAYER_GENVM_TRANSACTION, match_std_err="nonexistent")
+        is True
+    )
+
+
+def test_match_std_out_regex():
+    """Test stdout matching with regex patterns.
+
+    Validates that:
+    - Complex regex patterns work correctly in stdout
+    - Different regex patterns match appropriately
+    - Non-matching regex patterns cause assertions to fail
+    - Tests various regex features like \\d+, .*, word boundaries
+    """
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_TRANSACTION, match_std_out=r".*code \d+")
+        is True
+    )
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_TRANSACTION, match_std_out=r".* 123 .*")
+        is True
+    )
+    assert (
+        tx_execution_succeeded(
+            GENLAYER_GENVM_TRANSACTION, match_std_out=r"Process.*successfully"
+        )
+        is True
+    )
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_TRANSACTION, match_std_out=r"code \d{4}")
+        is False
+    )
+
+
+def test_match_std_err_regex():
+    """Test stderr matching with regex patterns.
+
+    Validates that:
+    - Complex regex patterns work correctly in stderr
+    - Different regex patterns match appropriately
+    - Non-matching regex patterns cause assertions to fail
+    - Tests various regex features like .*, word boundaries
+    """
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_TRANSACTION, match_std_err=r"Warning:.*")
+        is True
+    )
+    assert (
+        tx_execution_succeeded(
+            GENLAYER_GENVM_TRANSACTION, match_std_err=r".*deprecated.*"
+        )
+        is True
+    )
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_TRANSACTION, match_std_err=r"Error:.*")
+        is False
+    )
+
+
+def test_match_both_stdout_and_stderr():
+    """Test matching both stdout and stderr simultaneously.
+
+    Validates that:
+    - Both stdout and stderr patterns must match for success
+    - If either pattern fails to match, the assertion fails
+    - Combined matching works with both simple strings and regex
+    """
+    assert (
+        tx_execution_succeeded(
+            GENLAYER_GENVM_TRANSACTION,
+            match_std_out="Process completed",
+            match_std_err="Warning",
+        )
+        is True
+    )
+
+    assert (
+        tx_execution_succeeded(
+            GENLAYER_GENVM_TRANSACTION,
+            match_std_out="Process completed",
+            match_std_err="nonexistent",
+        )
+        is False
+    )
+
+
+def test_match_empty_stderr():
+    """Test matching empty stderr with different approaches.
+
+    Validates that:
+    - Empty stderr can be matched with regex pattern ^$
+    - Empty stderr can be matched with empty string
+    - Non-empty patterns fail when stderr is empty
+    """
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_EMPTY_STDERR, match_std_err=r"^$") is True
+    )
+    assert tx_execution_succeeded(GENLAYER_GENVM_EMPTY_STDERR, match_std_err="") is True
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_EMPTY_STDERR, match_std_err="Warning")
+        is False
+    )
+
+
+def test_missing_stdout_field():
+    """Test behavior when stdout field is missing from genvm_result.
+
+    Validates that:
+    - Missing stdout field causes match_std_out to fail
+    - The assertion handles missing fields gracefully
+    - tx_execution_failed returns True when stdout matching is requested but field is missing
+    """
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_NO_STDOUT, match_std_out="anything")
+        is False
+    )
+    assert (
+        tx_execution_failed(GENLAYER_GENVM_NO_STDOUT, match_std_out="anything") is True
+    )
+
+
+def test_missing_stderr_field():
+    """Test behavior when stderr field is missing from genvm_result.
+
+    Validates that:
+    - Missing stderr field causes match_std_err to fail
+    - The assertion handles missing fields gracefully
+    - tx_execution_failed returns True when stderr matching is requested but field is missing
+    """
+    genvm_no_stderr = {
+        "consensus_data": {
+            "leader_receipt": [
+                {"execution_result": "SUCCESS", "genvm_result": {"stdout": "Success"}}
+            ]
+        }
+    }
+    assert tx_execution_succeeded(genvm_no_stderr, match_std_err="anything") is False
+    assert tx_execution_failed(genvm_no_stderr, match_std_err="anything") is True
+
+
+def test_failed_execution_with_genvm_result():
+    """Test assertion behavior with failed execution but present genvm_result.
+
+    Validates that:
+    - execution_result takes precedence over output matching
+    - Even with matching stdout/stderr, failed executions return False
+    - The basic execution status is checked before output matching
+    """
+    assert tx_execution_succeeded(GENLAYER_GENVM_FAILED) is False
+    assert tx_execution_failed(GENLAYER_GENVM_FAILED) is True
+
+    # Even with matching stdout/stderr, should still fail if execution_result is not SUCCESS
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_FAILED, match_std_out="Process failed")
+        is False
+    )
+    assert (
+        tx_execution_succeeded(GENLAYER_GENVM_FAILED, match_std_err="Critical error")
+        is False
+    )
+
+
+def test_missing_genvm_result_with_match():
+    """Test behavior when genvm_result is missing but match parameters are provided.
+
+    Validates that:
+    - Missing genvm_result causes output matching to fail
+    - Both stdout and stderr matching fail when genvm_result is absent
+    - tx_execution_failed returns True when match parameters are used without genvm_result
+    """
+    assert (
+        tx_execution_succeeded(GENLAYER_SUCCESS_TRANSACTION, match_std_out="anything")
+        is False
+    )
+    assert (
+        tx_execution_succeeded(GENLAYER_SUCCESS_TRANSACTION, match_std_err="anything")
+        is False
+    )
+    assert (
+        tx_execution_failed(GENLAYER_SUCCESS_TRANSACTION, match_std_out="anything")
+        is True
+    )