klab-pytest-toolkit-web 0.0.0__tar.gz

klab_pytest_toolkit_web-0.0.0/.gitignore

@@ -0,0 +1,178 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Custom ###
+pytest.xml
+pytest-coverage.txt
+tmp/
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

klab_pytest_toolkit_web-0.0.0/PKG-INFO

@@ -0,0 +1,235 @@
+Metadata-Version: 2.4
+Name: klab-pytest-toolkit-web
+Version: 0.0.0
+Summary: Pytest web fixtures for the Klab Pytest Toolkit
+Project-URL: Changelog, https://github.com/klab365/klab-pytest-toolkit/blob/main/CHANGELOG.md
+Project-URL: Repository, https://github.com/klab365/klab-pytest-toolkit
+Project-URL: Issues, https://github.com/klab365/klab-pytest-toolkit/issues
+Author-email: Burak Kizilkaya <burak.kizilkaya@outlook.com>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: <4,>=3.11
+Requires-Dist: grpcio-reflection>=1.66.0
+Requires-Dist: grpcio-tools>=1.66.0
+Requires-Dist: grpcio>=1.66.0
+Requires-Dist: jsonschema>=4.25.1
+Requires-Dist: playwright>=1.57.0
+Requires-Dist: pytest>=8.3.5
+Requires-Dist: requests>=2.32.5
+Description-Content-Type: text/markdown
+
+# Klab Pytest Toolkit - Web Fixtures
+
+Custom pytest fixtures for web testing.
+The goal is to allow testers to easily test web applications (html/json/rest api) with reusable components.
+
+At the moment the package provides the following fixtures:
+
+- `response_validator_factory`: Factory for create JSON response validator instances with custom configurations.
+- `api_client_factory`: Factory for create different API client instances.
+  - REST API client for making HTTP requests to RESTful services.
+- `web_client_factory`: Factory to create web client instances for browser automation
+  - Playwright-based web client for end-to-end testing of web applications.
+
+## Installation
+
+```bash
+pip install klab-pytest-toolkit-web
+```
+
+## Usage
+
+### JSON Response Validator
+
+**Create the fixture**
+
+The factory class `ResponseValidatorFactory` is already provided as a pytest fixture `response_validator_factory`.
+
+```python
+@pytest.fixture
+def json_validator_user_schema(response_validator_factory) -> JsonResponseValidator:
+    """Fixture to provide a JSON response validator for user schema."""
+    user_schema = {
+        "type": "object",
+        "properties": {
+            "id": {"type": "integer"},
+            "name": {"type": "string"},
+        },
+        "required": ["id", "name"]
+    }
+    return response_validator_factory.create_json_validator(schema=user_schema)
+```
+
+**Functions**
+
+The validator contains one main function to validate a response against the schema. Below is an example of how to use the validator in a test.
+
+```python
+def test_user_api(json_validator_user_schema):
+    """Test user API response validation."""
+    response_data = {
+        "id": 1,
+        "name": "John Doe"
+    }
+    assert json_validator_user_schema.validate_response(response_data)
+```
+
+### REST API Client
+
+**Create the fixture**
+
+The factory class `ApiClientFactory` is already provided as a pytest fixture `api_client_factory`.
+To pass the url or other header information, you can pass this as environment variables or configure directly in the fixture.
+Below is an example of creating a REST API client fixture from a testcontainer url.
+
+```python
+
+@pytest.fixture(scope="session")
+def httpbin_container():
+    """Fixture to provide an HTTPBin container for testing."""
+
+    with DockerContainer("kennethreitz/httpbin:latest") as httpbin:
+        httpbin.with_exposed_ports(80)
+        httpbin.waiting_for(HttpWaitStrategy(path="/get", port=80).for_status_code(200))
+        httpbin.start()
+        port = httpbin.get_exposed_port(80)
+        base_url = f"http://localhost:{port}"
+        yield base_url
+
+@pytest.fixture
+def rest_api_client(api_client_factory, httpbin_container) -> RestApiClient:
+    """Fixture to provide a REST API client."""
+    return api_client_factory.create_rest_client(base_url=httpbin_container)
+```
+
+**Functions** 
+
+The REST API client provides functions to make HTTP requests. These are some examples:
+
+```python
+def test_get_request(rest_api_client: RestApiClient):
+    """Test basic GET request with query parameters."""
+    response = rest_api_client.get("/get", params={"test": "value"})
+
+    assert response.status_code == 200
+    json_data = response.json()
+    assert json_data["args"]["test"] == "value"
+
+def test_post_request(rest_api_client: RestApiClient):
+    """Test basic POST request with JSON body."""
+    response = rest_api_client.post("/post", payload={"key": "value"})
+
+    assert response.status_code == 200
+    json_data = response.json()
+    assert json_data["json"]["key"] == "value"
+
+def test_update_request(rest_api_client: RestApiClient):
+    """Test basic PUT request with JSON body."""
+    response = rest_api_client.put("/put", payload={"update": "data"})
+
+    assert response.status_code == 200
+    json_data = response.json()
+    assert json_data["json"]["update"] == "data"
+
+def test_delete_request(rest_api_client: RestApiClient):
+    """Test basic DELETE request."""
+    response = rest_api_client.delete("/delete")
+
+    assert response.status_code == 200
+    json_data = response.json()
+    assert json_data["url"].endswith("/delete")
+```
+
+### gRPC Client
+
+**Create the fixture**
+
+The factory class `ApiClientFactory` is already provided as a pytest fixture `api_client_factory`.
+You can create a gRPC client fixture as shown below:
+
+```python
+@pytest.fixture
+def grpc_client(api_client_factory) -> GrpcClient:
+    """Fixture to provide a gRPC client."""
+    return api_client_factory.create_grpc_client(
+        target="localhost:50051",
+        proto_file="path/to/your/service.proto"
+    )
+```
+
+**Functions**
+
+The `GrpcClient` provides gRPC call functionality by dynamically invoking methods defined in the provided proto file. It is imported the that the proto file defines a service with methods like `GetUser`. You will not get any code completion in your IDE since the methods are dynamically resolved at runtime, but you get error handling if the method does not exist.
+
+```python
+def test_grpc_get_user(grpc_client: GrpcClient):
+    """Test gRPC GetUser call."""
+    response = grpc_client.GetUser(id=123)
+
+    assert response.id == 123
+    assert response.name == "John Doe"
+```
+
+### Playwright Web Client
+
+**Create the fixture**
+
+The factory class `WebClientFactory` is already provided as a pytest fixture `web_client_factory`.
+For playwright, you might install the browsers first by running `playwright install` in your environment.
+You can create a Playwright web client fixture as shown below:
+
+```python
+@pytest.fixture
+def web_client(web_client_factory) -> PlaywrightWebClient:
+    """Fixture to provide a Playwright web client."""
+     with web_client_factory.create_client(client_type="playwright", headless=True) as client:
+        yield client
+```
+
+**Functions**
+
+The `WebClient` provides a variety of functions for browser automation. Refer to the api of the instance.
+Here are some examples of common operations:
+
+```python
+def test_navigate_and_click(web_client):
+    """Test navigation and clicking a button."""
+    web_client.navigate_to("https://example.com")
+    web_client.click("#start-button")
+    assert web_client.get_text("#result") == "Started"
+
+def test_form_submission(web_client):
+    """Test form submission."""
+    web_client.navigate_to("https://example.com/form")
+    web_client.fill_input("#name", "Test User")
+    web_client.fill_input("#email", "max@muster.com")
+    web_client.click("#submit-button")
+    assert web_client.get_text("#confirmation") == "Thank you for your submission!"
+
+def test_wait_for_element(web_client):
+    """Test waiting for an element to appear."""
+    web_client.navigate_to("https://example.com/dynamic")
+    web_client.wait_for_element("#dynamic-content", timeout=10)
+    assert web_client.get_text("#dynamic-content") == "Loaded Content"
+```
+
+## Examples
+
+See the test files for comprehensive examples:
+- `tests/test_jsonvalidator.py` - JSON validation examples covering basic validation, type checking, nested objects, constraints, and error handling
+- `tests/test_restapiclient.py` - REST API client examples with testcontainers integration
+- `tests/test_playwrightclient.py` - Playwright web client examples for browser automation with testcontainers
+
+## Best Practices
+
+### Use Testcontainers for Isolated Environments
+
+When testing web applications, it's recommended to use testcontainers to create isolated environments for your services.
+This ensures that your tests are reproducible and do not interfere with each other.
+
+## License
+
+MIT

klab_pytest_toolkit_web-0.0.0/README.md

@@ -0,0 +1,212 @@
+# Klab Pytest Toolkit - Web Fixtures
+
+Custom pytest fixtures for web testing.
+The goal is to allow testers to easily test web applications (html/json/rest api) with reusable components.
+
+At the moment the package provides the following fixtures:
+
+- `response_validator_factory`: Factory for create JSON response validator instances with custom configurations.
+- `api_client_factory`: Factory for create different API client instances.
+  - REST API client for making HTTP requests to RESTful services.
+- `web_client_factory`: Factory to create web client instances for browser automation
+  - Playwright-based web client for end-to-end testing of web applications.
+
+## Installation
+
+```bash
+pip install klab-pytest-toolkit-web
+```
+
+## Usage
+
+### JSON Response Validator
+
+**Create the fixture**
+
+The factory class `ResponseValidatorFactory` is already provided as a pytest fixture `response_validator_factory`.
+
+```python
+@pytest.fixture
+def json_validator_user_schema(response_validator_factory) -> JsonResponseValidator:
+    """Fixture to provide a JSON response validator for user schema."""
+    user_schema = {
+        "type": "object",
+        "properties": {
+            "id": {"type": "integer"},
+            "name": {"type": "string"},
+        },
+        "required": ["id", "name"]
+    }
+    return response_validator_factory.create_json_validator(schema=user_schema)
+```
+
+**Functions**
+
+The validator contains one main function to validate a response against the schema. Below is an example of how to use the validator in a test.
+
+```python
+def test_user_api(json_validator_user_schema):
+    """Test user API response validation."""
+    response_data = {
+        "id": 1,
+        "name": "John Doe"
+    }
+    assert json_validator_user_schema.validate_response(response_data)
+```
+
+### REST API Client
+
+**Create the fixture**
+
+The factory class `ApiClientFactory` is already provided as a pytest fixture `api_client_factory`.
+To pass the url or other header information, you can pass this as environment variables or configure directly in the fixture.
+Below is an example of creating a REST API client fixture from a testcontainer url.
+
+```python
+
+@pytest.fixture(scope="session")
+def httpbin_container():
+    """Fixture to provide an HTTPBin container for testing."""
+
+    with DockerContainer("kennethreitz/httpbin:latest") as httpbin:
+        httpbin.with_exposed_ports(80)
+        httpbin.waiting_for(HttpWaitStrategy(path="/get", port=80).for_status_code(200))
+        httpbin.start()
+        port = httpbin.get_exposed_port(80)
+        base_url = f"http://localhost:{port}"
+        yield base_url
+
+@pytest.fixture
+def rest_api_client(api_client_factory, httpbin_container) -> RestApiClient:
+    """Fixture to provide a REST API client."""
+    return api_client_factory.create_rest_client(base_url=httpbin_container)
+```
+
+**Functions** 
+
+The REST API client provides functions to make HTTP requests. These are some examples:
+
+```python
+def test_get_request(rest_api_client: RestApiClient):
+    """Test basic GET request with query parameters."""
+    response = rest_api_client.get("/get", params={"test": "value"})
+
+    assert response.status_code == 200
+    json_data = response.json()
+    assert json_data["args"]["test"] == "value"
+
+def test_post_request(rest_api_client: RestApiClient):
+    """Test basic POST request with JSON body."""
+    response = rest_api_client.post("/post", payload={"key": "value"})
+
+    assert response.status_code == 200
+    json_data = response.json()
+    assert json_data["json"]["key"] == "value"
+
+def test_update_request(rest_api_client: RestApiClient):
+    """Test basic PUT request with JSON body."""
+    response = rest_api_client.put("/put", payload={"update": "data"})
+
+    assert response.status_code == 200
+    json_data = response.json()
+    assert json_data["json"]["update"] == "data"
+
+def test_delete_request(rest_api_client: RestApiClient):
+    """Test basic DELETE request."""
+    response = rest_api_client.delete("/delete")
+
+    assert response.status_code == 200
+    json_data = response.json()
+    assert json_data["url"].endswith("/delete")
+```
+
+### gRPC Client
+
+**Create the fixture**
+
+The factory class `ApiClientFactory` is already provided as a pytest fixture `api_client_factory`.
+You can create a gRPC client fixture as shown below:
+
+```python
+@pytest.fixture
+def grpc_client(api_client_factory) -> GrpcClient:
+    """Fixture to provide a gRPC client."""
+    return api_client_factory.create_grpc_client(
+        target="localhost:50051",
+        proto_file="path/to/your/service.proto"
+    )
+```
+
+**Functions**
+
+The `GrpcClient` provides gRPC call functionality by dynamically invoking methods defined in the provided proto file. It is imported the that the proto file defines a service with methods like `GetUser`. You will not get any code completion in your IDE since the methods are dynamically resolved at runtime, but you get error handling if the method does not exist.
+
+```python
+def test_grpc_get_user(grpc_client: GrpcClient):
+    """Test gRPC GetUser call."""
+    response = grpc_client.GetUser(id=123)
+
+    assert response.id == 123
+    assert response.name == "John Doe"
+```
+
+### Playwright Web Client
+
+**Create the fixture**
+
+The factory class `WebClientFactory` is already provided as a pytest fixture `web_client_factory`.
+For playwright, you might install the browsers first by running `playwright install` in your environment.
+You can create a Playwright web client fixture as shown below:
+
+```python
+@pytest.fixture
+def web_client(web_client_factory) -> PlaywrightWebClient:
+    """Fixture to provide a Playwright web client."""
+     with web_client_factory.create_client(client_type="playwright", headless=True) as client:
+        yield client
+```
+
+**Functions**
+
+The `WebClient` provides a variety of functions for browser automation. Refer to the api of the instance.
+Here are some examples of common operations:
+
+```python
+def test_navigate_and_click(web_client):
+    """Test navigation and clicking a button."""
+    web_client.navigate_to("https://example.com")
+    web_client.click("#start-button")
+    assert web_client.get_text("#result") == "Started"
+
+def test_form_submission(web_client):
+    """Test form submission."""
+    web_client.navigate_to("https://example.com/form")
+    web_client.fill_input("#name", "Test User")
+    web_client.fill_input("#email", "max@muster.com")
+    web_client.click("#submit-button")
+    assert web_client.get_text("#confirmation") == "Thank you for your submission!"
+
+def test_wait_for_element(web_client):
+    """Test waiting for an element to appear."""
+    web_client.navigate_to("https://example.com/dynamic")
+    web_client.wait_for_element("#dynamic-content", timeout=10)
+    assert web_client.get_text("#dynamic-content") == "Loaded Content"
+```
+
+## Examples
+
+See the test files for comprehensive examples:
+- `tests/test_jsonvalidator.py` - JSON validation examples covering basic validation, type checking, nested objects, constraints, and error handling
+- `tests/test_restapiclient.py` - REST API client examples with testcontainers integration
+- `tests/test_playwrightclient.py` - Playwright web client examples for browser automation with testcontainers
+
+## Best Practices
+
+### Use Testcontainers for Isolated Environments
+
+When testing web applications, it's recommended to use testcontainers to create isolated environments for your services.
+This ensures that your tests are reproducible and do not interfere with each other.
+
+## License
+
+MIT

klab_pytest_toolkit_web-0.0.0/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "klab-pytest-toolkit-web"
+dynamic = ["version"]
+description = "Pytest web fixtures for the Klab Pytest Toolkit"
+authors = [{ name = "Burak Kizilkaya", email = "burak.kizilkaya@outlook.com" }]
+requires-python = ">=3.11,<4"
+readme = "README.md"
+license = "MIT"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "jsonschema>=4.25.1",
+    "pytest>=8.3.5",
+    "playwright>=1.57.0",
+    "requests>=2.32.5",
+    "grpcio>=1.66.0",
+    "grpcio-tools>=1.66.0",
+    "grpcio-reflection>=1.66.0",
+]
+
+[project.urls]
+Changelog = "https://github.com/klab365/klab-pytest-toolkit/blob/main/CHANGELOG.md"
+Repository = "https://github.com/klab365/klab-pytest-toolkit"
+Issues = "https://github.com/klab365/klab-pytest-toolkit/issues"
+
+[project.entry-points.pytest11]
+klab_pytest_toolkit_web = "klab_pytest_toolkit_web.plugin"
+
+[tool.hatch.version]
+path = "src/klab_pytest_toolkit_web/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "tests",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+pythonpath = [
+  "."
+]
+filterwarnings = [
+  "ignore::DeprecationWarning:testcontainers.core.waiting_utils",
+]
+
+[dependency-groups]
+dev = [
+    "testcontainers>=4.13.3",
+]