genlayer-test 0.10.1__py3-none-any.whl → 0.11.0__py3-none-any.whl

{genlayer_test-0.10.1.dist-info → genlayer_test-0.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: genlayer-test
-Version: 0.10.1
+Version: 0.11.0
 Summary: GenLayer Testing Suite
 Author: GenLayer
 License-Expression: MIT
@@ -24,8 +24,8 @@ Dynamic: license-file
 # GenLayer Testing Suite
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/license/mit/)
-[![Discord](https://dcbadge.vercel.app/api/server/8Jm4v89VAu?compact=true&style=flat)](https://discord.gg/VpfmXEMN66)
-[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/yeagerai.svg?style=social&label=Follow%20%40GenLayer)](https://x.com/GenLayer)
+[![Discord](https://dcbadge.vercel.app/api/server/8Jm4v89VAu?compact=true&style=flat)](https://discord.gg/qjCU4AWnKE)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/genlayerlabs.svg?style=social&label=Follow%20%40GenLayer)](https://x.com/GenLayer)
 [![PyPI version](https://badge.fury.io/py/genlayer-test.svg)](https://badge.fury.io/py/genlayer-test)
 [![Documentation](https://img.shields.io/badge/docs-genlayer-blue)](https://docs.genlayer.com/api-references/genlayer-test)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
@@ -107,7 +107,7 @@ $ pip install genlayer-test
 
 2. Install from source:
 ```bash
-$ git clone https://github.com/yeagerai/genlayer-testing-suite
+$ git clone https://github.com/genlayerlabs/genlayer-testing-suite
 $ cd genlayer-testing-suite
 $ pip install -e .
 ```
@@ -622,6 +622,205 @@ The `.analyze()` method helps you:
 - Benchmark performance across multiple runs
 
 
+### Mock Web Responses
+
+The Mock Web Response system allows you to simulate HTTP responses for web requests made by intelligent contracts using GenLayer's web methods (`gl.nondet.web.get()`, `gl.nondet.web.post()`, etc.). This feature enables deterministic testing of contracts that interact with external web services without making actual HTTP calls.
+
+#### Basic Example
+
+Here's a simple example of mocking a web API response:
+
+```python
+from gltest import get_contract_factory, get_validator_factory
+from gltest.types import MockedWebResponse
+import json
+
+def test_simple_web_mock():
+    # Define mock web responses
+    mock_web_response: MockedWebResponse = {
+        "nondet_web_request": {
+            "https://api.example.com/price": {
+                "method": "GET",
+                "status": 200,
+                "body": json.dumps({"price": 100.50})
+            }
+        }
+    }
+    
+    # Create validators with mock web responses
+    validator_factory = get_validator_factory()
+    validators = validator_factory.batch_create_mock_validators(
+        count=5,
+        mock_web_response=mock_web_response
+    )
+    
+    # Use validators in transaction context
+    transaction_context = {"validators": [v.to_dict() for v in validators]}
+    
+    # Deploy and test contract
+    factory = get_contract_factory("PriceOracle")
+    contract = factory.deploy(transaction_context=transaction_context)
+    
+    # Contract's web requests will receive the mocked response
+    result = contract.update_price().transact(transaction_context=transaction_context)
+```
+
+#### Supported HTTP Methods
+
+Mock web responses support all HTTP methods including GET, POST, PUT, DELETE, PATCH, etc.:
+
+```python
+mock_web_response: MockedWebResponse = {
+    "nondet_web_request": {
+        # GET request
+        "https://api.example.com/users/123": {
+            "method": "GET",
+            "status": 200,
+            "body": '{"id": 123, "name": "Alice"}'
+        },
+        # POST request
+        "https://api.example.com/users": {
+            "method": "POST",
+            "status": 201,
+            "body": '{"id": 124, "name": "Bob", "created": true}'
+        },
+        # DELETE request
+        "https://api.example.com/users/123": {
+            "method": "DELETE",
+            "status": 204,
+            "body": ""
+        },
+        # PUT request
+        "https://api.example.com/users/123": {
+            "method": "PUT",
+            "status": 200,
+            "body": '{"id": 123, "name": "Alice Updated"}'
+        },
+        # Error response
+        "https://api.example.com/error": {
+            "method": "GET",
+            "status": 500,
+            "body": "Internal Server Error"
+        }
+    }
+}
+```
+
+#### How It Works
+
+When a contract calls any web method (`gl.nondet.web.get()`, `gl.nondet.web.post()`, etc.):
+1. The mock system checks if the URL exists in the mock configuration
+2. If found, it returns the mocked response with the specified status and body
+3. If not found, the actual web request would be made (or fail if network access is disabled)
+
+#### Complete Example: Twitter/X Username Storage
+
+Here's a real-world example showing how to mock Twitter/X API responses:
+
+```python
+# test_x_username_storage.py
+from gltest import get_contract_factory, get_validator_factory
+from gltest.assertions import tx_execution_succeeded
+from gltest.types import MockedWebResponse
+import json
+import urllib.parse
+
+def test_x_username_storage():
+    # Helper to build URL with query parameters
+    def get_username_url(username: str) -> str:
+        params = {"user.fields": "public_metrics,verified"}
+        return f"https://domain.com/api/twitter/users/by/username/{username}?{urllib.parse.urlencode(params)}"
+    
+    # Define mock responses for different usernames
+    mock_web_response: MockedWebResponse = {
+        "nondet_web_request": {
+            get_username_url("user_a"): {
+                "method": "GET",
+                "status": 200,
+                "body": json.dumps({"username": "user_a", "verified": True})
+            },
+            get_username_url("user_b"): {
+                "method": "GET",
+                "status": 200,
+                "body": json.dumps({"username": "user_b", "verified": False})
+            }
+        }
+    }
+    
+    # Create validators with mock web responses
+    validator_factory = get_validator_factory()
+    validators = validator_factory.batch_create_mock_validators(
+        count=5,
+        mock_web_response=mock_web_response
+    )
+    transaction_context = {"validators": [v.to_dict() for v in validators]}
+    
+    # Deploy and test contract
+    factory = get_contract_factory("XUsernameStorage")
+    contract = factory.deploy(transaction_context=transaction_context)
+    
+    # Test updating username - will use mocked response
+    tx_receipt = contract.update_username(args=["user_a"]).transact(
+        transaction_context=transaction_context
+    )
+    assert tx_execution_succeeded(tx_receipt)
+    
+    # Verify the username was stored
+    username = contract.get_username().call(transaction_context=transaction_context)
+    assert username == "user_a"
+```
+
+#### Combining Mock LLM and Web Responses
+
+You can combine both mock LLM responses and mock web responses in the same test:
+
+```python
+def test_combined_mocks():
+    # Define both mock types
+    mock_llm_response = {
+        "eq_principle_prompt_comparative": {
+            "values match": True
+        }
+    }
+    
+    mock_web_response: MockedWebResponse = {
+        "nondet_web_request": {
+            "https://api.example.com/data": {
+                "method": "GET",
+                "status": 200,
+                "body": '{"value": 42}'
+            }
+        }
+    }
+    
+    # Create validators with both mock types
+    validator_factory = get_validator_factory()
+    validators = validator_factory.batch_create_mock_validators(
+        count=5,
+        mock_llm_response=mock_llm_response,
+        mock_web_response=mock_web_response
+    )
+    
+    # Use in your tests...
+```
+
+#### Best Practices
+
+1. **URL Matching**: URLs must match exactly, including query parameters
+2. **Response Body**: Always provide the body as a string (use `json.dumps()` for JSON data)
+3. **Status Codes**: Use realistic HTTP status codes (200, 404, 500, etc.)
+4. **Method Matching**: Specify the correct HTTP method that your contract uses
+5. **Error Testing**: Mock error responses to test error handling paths
+6. **Deterministic Tests**: Mock web responses ensure tests don't depend on external services
+
+#### Notes
+
+- Mock web responses are only available when using mock validators
+- URL matching is exact - the full URL including query parameters must match
+- The method field should match the HTTP method used by the contract
+- Useful for testing contracts that interact with external APIs without network dependencies
+- All standard HTTP methods are supported (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS)
+
 ### Custom Transaction Context
 
 The GenLayer Testing Suite allows you to customize the transaction execution environment by providing a `transaction_context` parameter with custom validators and GenVM datetime settings.
@@ -1001,8 +1200,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 ## 💬 Support
 
 - [Documentation](https://docs.genlayer.com/api-references/genlayer-test)
-- [Discord Community](https://discord.gg/VpfmXEMN66)
-- [GitHub Issues](https://github.com/yeagerai/genlayer-testing-suite/issues)
+- [Discord Community](https://discord.gg/qjCU4AWnKE)
+- [GitHub Issues](https://github.com/genlayerlabs/genlayer-testing-suite/issues)
 - [Twitter](https://x.com/GenLayer)
 
 

{genlayer_test-0.10.1.dist-info → genlayer_test-0.11.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-genlayer_test-0.10.1.dist-info/licenses/LICENSE,sha256=che_H4vE0QUx3HvWrAa1_jDEVInift0U6VO15-QqEls,1064
+genlayer_test-0.11.0.dist-info/licenses/LICENSE,sha256=qeyU7v-TUbXruF0KGiAPMvgxsqxMq1ObA47C0gR5kWI,1070
 gltest/__init__.py,sha256=49112x2CLdYwvCbBZ1laJmMk0NQ7S3u5YUbxPefqhrk,454
 gltest/accounts.py,sha256=HUmWguJMolggQaZNRPw-LGlRlQCjLLdUanKRowMv6pI,812
 gltest/assertions.py,sha256=0dEk0VxcHK4I7GZPHxJmz-2jaA60V499gOSR74rZbfM,1748
@@ -6,7 +6,7 @@ gltest/clients.py,sha256=1dX6wmG3QCevQRLbSaFlHymZSb-sJ5aYwet1IoX2nbA,1554
 gltest/exceptions.py,sha256=deJPmrTe5gF33qkkKF2IVJY7lc_knI7Ql3N7jZ8aLZs,510
 gltest/fixtures.py,sha256=omVjLh1kXXUyL7Oo8zzdooJBbSX-Qk-Aa-prp5MqvFc,833
 gltest/logging.py,sha256=jAkHsuMm-AEx1Xu1srU6W-0YzTwXJB48mCK-OVzAiN4,342
-gltest/types.py,sha256=H32fHrU5aFMaPHXgEWcHAmLWOZ9pBFVp8PK_ncpVOgM,940
+gltest/types.py,sha256=LLkKjkFsKG0AXpqt-qk70YhOm18AGkqmihamG_9kjEc,1305
 gltest/utils.py,sha256=-gHhjrS7i_GhDG3sKOq2qsTtYBt4HHgXHEXh-3RB_rI,573
 gltest/artifacts/__init__.py,sha256=qTt3TE19gVNWnQLUlt5aDe4nNvJ2YJ1jzDkMmYIsCG0,194
 gltest/artifacts/contract.py,sha256=KChpmfjZod_0dVB8y-dvWz6IVm7QlIJsgG2ArtvVDaU,6457
@@ -21,18 +21,18 @@ gltest/helpers/__init__.py,sha256=I7HiTu_H7_hP65zY6Wl02r-5eAMr2eZvqBVmusuQLX4,18
 gltest/helpers/fixture_snapshot.py,sha256=bMgvlEVQBGIQzj7NOyosXWlphI1H2C1o75Zo0C-kGfQ,1931
 gltest/helpers/take_snapshot.py,sha256=-QkaBvFG4ZsNKv_nCSEsy5Ze1pICOHxVhReSeQmZUlY,1276
 gltest/validators/__init__.py,sha256=AXboXORF5a8MVtG7jWMT1fJcwGXNzcX6txXQstwX2EU,152
-gltest/validators/validator_factory.py,sha256=fpb-YyAKuWo4-pXBjrZ_TApYLsm6HHa6kGpbFByRucs,3886
+gltest/validators/validator_factory.py,sha256=Pu7c5XMc7HgPFIiWet0ybcgtW4T29d0lsgPrpj4tHtk,4957
 gltest_cli/logging.py,sha256=WXVhfq9vT6FtV_jxDqGEGia1ZWSIUKAfmWRnZd_gWQk,1266
 gltest_cli/main.py,sha256=Ti2-0Ev1x5_cM0D1UKqdgaDt80CDHEQGtdRne2qLm4M,53
 gltest_cli/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gltest_cli/config/constants.py,sha256=z7njbU8WXYhTnp1NYrW4YI2jN-p114BP2UDSYF0qAJE,571
 gltest_cli/config/general.py,sha256=ezpoGsT8grO9zQH6RugV14b1GzeFt-htYToHQBJhNvY,186
-gltest_cli/config/plugin.py,sha256=rySUyo7OSG1SOiUx2Xrxiv-SfjaxJSWpT5KKKNRk4Mk,6719
+gltest_cli/config/plugin.py,sha256=jxmdSBq7A1UPpxL4zolhDX53T8Eo4M8xluAsKx_6MTY,6774
 gltest_cli/config/pytest_context.py,sha256=Ze8JSkrwMTCE8jIhpzU_71CEXg92SiEPvSgNTp-gbS4,243
 gltest_cli/config/types.py,sha256=nGKm2qTwo99M8DbGchj14IdIQ4lcNTDODZFHXdsi5rY,9506
 gltest_cli/config/user.py,sha256=JeclpIVv4BT5COMW2xrEbTspI6e1RAYIOvd8ruPc3gM,12887
-genlayer_test-0.10.1.dist-info/METADATA,sha256=TAZaEuDPIKWu3kDlIfASJ_M0BGPsFFV1TLMKPivnm68,36341
-genlayer_test-0.10.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-genlayer_test-0.10.1.dist-info/entry_points.txt,sha256=RWPcSArBpz_G4BYioh5L8Q8hyClRbSgzLimjcWMp-BQ,94
-genlayer_test-0.10.1.dist-info/top_level.txt,sha256=GSdrnQbiLcZssmtCpbDgBTygsc8Bt_TPeYjwm0FmpdA,18
-genlayer_test-0.10.1.dist-info/RECORD,,
+genlayer_test-0.11.0.dist-info/METADATA,sha256=UugYMl8Xl5qnR6yhNAhR2ZhkpnAfGzeskxnDldfr7Io,43279
+genlayer_test-0.11.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+genlayer_test-0.11.0.dist-info/entry_points.txt,sha256=RWPcSArBpz_G4BYioh5L8Q8hyClRbSgzLimjcWMp-BQ,94
+genlayer_test-0.11.0.dist-info/top_level.txt,sha256=GSdrnQbiLcZssmtCpbDgBTygsc8Bt_TPeYjwm0FmpdA,18
+genlayer_test-0.11.0.dist-info/RECORD,,

{genlayer_test-0.10.1.dist-info → genlayer_test-0.11.0.dist-info}/licenses/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 YeagerAI
+Copyright (c) 2024 GenLayer Labs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

gltest/types.py

@@ -20,6 +20,20 @@ class MockedLLMResponse(TypedDict):
     eq_principle_prompt_non_comparative: Dict[str, bool]
 
 
+class MockedWebResponseData(TypedDict):
+    """Mocked web response data with method for matching"""
+
+    method: str  # GET, POST, PUT, DELETE, etc.
+    status: int  # status code of the response
+    body: str  # body of the response
+
+
+class MockedWebResponse(TypedDict):
+    """Maps urls to responses"""
+
+    nondet_web_request: Dict[str, MockedWebResponseData]
+
+
 class ValidatorConfig(TypedDict):
     """Validator information."""
 

gltest/validators/validator_factory.py

@@ -1,4 +1,4 @@
-from gltest.types import MockedLLMResponse
+from gltest.types import MockedLLMResponse, MockedWebResponse
 from dataclasses import dataclass
 from typing import Dict, Any, Optional, List
 from copy import deepcopy
@@ -16,6 +16,7 @@ class Validator:
     # Mock configuration
     mock_enabled: bool
     mock_llm_response: Optional[MockedLLMResponse]
+    mock_web_response: Optional[MockedWebResponse]
 
     def to_dict(self) -> Dict[str, Any]:
         normal_config = {
@@ -29,21 +30,27 @@ class Validator:
         if not self.mock_enabled:
             return normal_config
 
-        mock = self.mock_llm_response or {}
-        mock_config = {
-            "response": mock.get("nondet_exec_prompt", {}),
-            "eq_principle_prompt_comparative": mock.get(
+        # Mock llm response
+        mock_llm = self.mock_llm_response or {}
+        mock_llm_config = {
+            "response": mock_llm.get("nondet_exec_prompt", {}),
+            "eq_principle_prompt_comparative": mock_llm.get(
                 "eq_principle_prompt_comparative", {}
             ),
-            "eq_principle_prompt_non_comparative": mock.get(
+            "eq_principle_prompt_non_comparative": mock_llm.get(
                 "eq_principle_prompt_non_comparative", {}
             ),
         }
+        mock_web = self.mock_web_response or {}
+        mock_web_config = {
+            "nondet_web_request": mock_web.get("nondet_web_request", {}),
+        }
         return {
             **normal_config,
             "plugin_config": {
                 **self.plugin_config,
-                "mock_response": mock_config,
+                "mock_response": mock_llm_config,
+                "mock_web_response": mock_web_config,
             },
         }
 
@@ -60,6 +67,7 @@ class Validator:
             plugin_config=deepcopy(self.plugin_config),
             mock_enabled=self.mock_enabled,
             mock_llm_response=deepcopy(self.mock_llm_response),
+            mock_web_response=deepcopy(self.mock_web_response),
         )
 
 
@@ -85,6 +93,7 @@ class ValidatorFactory:
             plugin_config=deepcopy(plugin_config),
             mock_enabled=False,
             mock_llm_response=None,
+            mock_web_response=None,
         )
 
     def batch_create_validators(
@@ -109,7 +118,15 @@ class ValidatorFactory:
             for _ in range(count)
         ]
 
-    def create_mock_validator(self, mock_llm_response: MockedLLMResponse) -> Validator:
+    def create_mock_validator(
+        self,
+        mock_llm_response: Optional[MockedLLMResponse] = None,
+        mock_web_response: Optional[MockedWebResponse] = None,
+    ) -> Validator:
+        if mock_llm_response is None and mock_web_response is None:
+            raise ValueError(
+                "mock_llm_response and mock_web_response cannot both be None"
+            )
         return Validator(
             stake=8,
             provider="openai",
@@ -121,15 +138,24 @@ class ValidatorFactory:
                 "api_url": "https://api.openai.com",
             },
             mock_enabled=True,
-            mock_llm_response=deepcopy(mock_llm_response),
+            mock_llm_response=(
+                deepcopy(mock_llm_response) if mock_llm_response is not None else None
+            ),
+            mock_web_response=(
+                deepcopy(mock_web_response) if mock_web_response is not None else None
+            ),
         )
 
     def batch_create_mock_validators(
         self,
         count: int,
-        mock_llm_response: MockedLLMResponse,
+        mock_llm_response: Optional[MockedLLMResponse] = None,
+        mock_web_response: Optional[MockedWebResponse] = None,
     ) -> List[Validator]:
-        return [self.create_mock_validator(mock_llm_response) for _ in range(count)]
+        return [
+            self.create_mock_validator(mock_llm_response, mock_web_response)
+            for _ in range(count)
+        ]
 
 
 def get_validator_factory() -> ValidatorFactory:

gltest_cli/config/plugin.py

@@ -13,8 +13,6 @@ from gltest_cli.config.general import (
 from gltest_cli.config.types import PluginConfig
 from gltest_cli.config.pytest_context import _pytest_context
 from gltest_cli.config.constants import (
-    DEFAULT_WAIT_INTERVAL,
-    DEFAULT_WAIT_RETRIES,
     DEFAULT_LEADER_ONLY,
     CHAINS,
 )
@@ -39,14 +37,14 @@ def pytest_addoption(parser):
     group.addoption(
         "--default-wait-interval",
         action="store",
-        default=DEFAULT_WAIT_INTERVAL,
+        default=None,
         help="Default interval (ms) between transaction receipt checks",
     )
 
     group.addoption(
         "--default-wait-retries",
         action="store",
-        default=DEFAULT_WAIT_RETRIES,
+        default=None,
         help="Default number of retries for transaction receipt checks",
     )
 
@@ -122,8 +120,12 @@ def pytest_configure(config):
         plugin_config.artifacts_dir = (
             Path(artifacts_dir) if artifacts_dir is not None else None
         )
-        plugin_config.default_wait_interval = int(default_wait_interval)
-        plugin_config.default_wait_retries = int(default_wait_retries)
+        plugin_config.default_wait_interval = (
+            int(default_wait_interval) if default_wait_interval is not None else None
+        )
+        plugin_config.default_wait_retries = (
+            int(default_wait_retries) if default_wait_retries is not None else None
+        )
         plugin_config.rpc_url = rpc_url
         plugin_config.network_name = network
         plugin_config.leader_only = leader_only