pytest-httpchain 0.1.0__tar.gz

pytest_httpchain-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 aeresov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

pytest_httpchain-0.1.0/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.4
+Name: pytest-httpchain
+Version: 0.1.0
+Summary: pytest plugin for HTTP testing using JSON files
+Keywords: testing,pytest,requests
+Author: Alexander Eresov
+Author-email: Alexander Eresov <aeresov@gmail.com>
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: pytest-httpchain-jsonref
+Requires-Dist: pytest-httpchain-models
+Requires-Dist: pytest-order>=1.3.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: pytest-httpchain-mcp ; extra == 'mcp'
+Requires-Python: >=3.13, <4.0
+Provides-Extra: mcp
+Description-Content-Type: text/markdown
+
+[![image](https://img.shields.io/pypi/v/pytest-httpchain)](https://pypi.python.org/pypi/pytest-httpchain)
+[![image](https://img.shields.io/pypi/l/pytest-httpchain)](https://github.com/aeresov/pytest-httpchain/blob/main/LICENSE)
+[![image](https://img.shields.io/pypi/pyversions/pytest-httpchain)](https://pypi.python.org/pypi/pytest-httpchain)
+
+# pytest-httpchain
+
+A pytest plugin for testing HTTP endpoints.
+
+## Overview
+
+`pytest-httpchain` is an integration testing framework for HTTP APIs based on battle-hardened [requests](https://requests.readthedocs.io) lib.\
+It aims at helping with common HTTP API testing scenarios, where user needs to make several calls in specific order using data obtained along the way, like auth tokens or resource ids.
+
+## Installation
+
+Install normally via package manager of your choice from PyPi:
+
+```bash
+pip install pytest-httpchain
+```
+
+or directly from Github, in case you need a particular ref:
+
+```bash
+pip install 'git+https://github.com/aeresov/pytest-httpchain@main'
+```
+
+### Optional dependencies
+
+The following optional dependencies are available:
+
+-   `mcp`: installs MCP server package and its starting script. Details in [MCP Server](#mcp-server).
+
+## Features
+
+### Pytest integration
+
+Most of pytest magic can be used: markers, fixtures, other plugins.\
+
+> NOTE: parametrization is not yet implemented, therefore `parametrize` marker won't have any effect.
+
+### Declarative format
+
+Test scenarios are written declaratively in JSON files.\
+`pytest-httpchain` supports JSONRef, so use can reuse arbitrary parts of your scenarios with `$ref` directive.\
+Properties are merged in a greedy way with type checking.
+
+### Multi-stage tests
+
+Each test scenario contains 1+ stages; each stage is a single HTTP call.\
+`pytest-httpchain` executes stages in the order they are listed in scenario file; one stage failure stops the execution chain.
+
+### Common data context and variable substitution
+
+`pytest-httpchain` maintains key-value data storage throughout the execution.\
+This storage ("common data context") is populated with declared variables, fixtures and data saved by stages. The data remains there throughout the scenario execution.\
+Writing scenarios, you can use Jinja-style expressions like `"{{ var }}"` for JSON values. `pytest-httpchain` does variable substitution dynamically right before executing a stage, and uses common data context keys as variables in these expressions.\
+Values from common data context also might be verified during verified/asserted.
+
+### User functions
+
+`pytest-httpchain` can import and call regular python functions:
+
+-   to extract data from HTTP response
+-   to verify HTTP response and values in common data context
+-   to provide [custom authentication for requests](https://requests.readthedocs.io/en/latest/user/advanced/#custom-authentication)
+
+### JMESPath support
+
+`pytest-httpchain` can extract values from JSON responses using JMESPath expressions directly.
+
+### JSON schema support
+
+`pytest-httpchain` can verify JSON reponses against user-defined JSON schema.
+
+## Quick Start
+
+Create a JSON test file named like `test_<name>.<suffix>.json` (default suffix is `http`):
+
+```python
+# conftest.py
+import pytest
+from datetime import datetime
+
+@pytest.fixture
+def now_utc():
+    return datetime.now()
+```
+
+```json
+{
+    "vars": {
+        "user_id": 1
+    },
+    "stages": [
+        {
+            "name": "get_user",
+            "request": {
+                "url": "https://api.example.com/users/{{ user_id }}"
+            },
+            "response": [
+                {
+                    "verify": {
+                        "status": 200
+                    }
+                },
+                {
+                    "save": {
+                        "vars": {
+                            "user_name": "user.name"
+                        }
+                    }
+                }
+            ]
+        },
+        {
+            "name": "update_user",
+            "fixtures": ["now_utc"],
+            "request": {
+                "url": "https://api.example.com/users/{{ user_id }}",
+                "method": "PUT",
+                "body": {
+                    "json": {
+                        "user": {
+                            "name": "{{ user_name }}_updated",
+                            "timestamp": "{{ str(now_utc) }}"
+                        }
+                    }
+                }
+            },
+            "response": [
+                {
+                    "verify": {
+                        "status": 200
+                    }
+                }
+            ]
+        },
+        {
+            "name": "cleanup",
+            "always_run": true,
+            "request": {
+                "url": "https://api.example.com/cleanup",
+                "method": "POST"
+            }
+        }
+    ]
+}
+```
+
+Scenario we created:
+
+-   common data context is seeded with the first variable `user_id`
+-   **get_user**\
+    url is assembled using `user_id` variable from common data context\
+    HTTP GET call is made\
+    we verify the call returned code 200\
+    assuming JSON body is returned, we extract a value by JMESPath expression `user.name` and save it to common data context under `user_name` key
+-   **update_user**\
+    `now_utc` fixture value is injected into common data context\
+    url is assembled using `user_id` variable from common data context\
+    we create JSON body in place using values from common data context, note that `now_utc` is converted to string in place\
+    HTTP PUT call with body is made\
+    we verify the call returned code 200\
+-   **cleanup**\
+    finalizing call meant for graceful exit\
+    `always_run` parameter means this stage will be executed regardless of errors in previous stages
+
+For detailed examples see [USAGE.md](USAGE.md).
+
+## Configuration
+
+-   Test file discovery is based on this name pattern: `test_<name>.<suffix>.json`.\
+    The `suffix` is configurable as pytest ini option, default value is **http**.
+-   `$ref` instructions can point to other files; absolute and relative paths are supported.\
+    You can limit the depth of relative path traversal using `ref_parent_traversal_depth` ini option, default value is **3**.
+
+## MCP Server
+
+`pytest-httpchain` includes an MCP (Model Context Protocol) server to aid AI code assistants.
+
+### Installation
+
+The optional dependency `mcp` installs MCP server's package and `pytest-httpchain-mcp` script.\
+Use this script as call target for your MCP configuration.
+
+Claude Code `.mcp.json` example:
+
+```json
+{
+    "mcpServers": {
+        "pytest-httpchain": {
+            "type": "stdio",
+            "command": "uv",
+            "args": ["run", "pytest-httpchain-mcp"],
+            "env": {}
+        }
+    }
+}
+```
+
+### Features
+
+The MCP server provides:
+
+-   **Scenario validation** - validate test scenario and scan for possible problems
+
+## Documentation
+
+-   [Usage Examples](USAGE.md) - Practical code examples
+-   [Full Documentation](https://aeresov.github.io/pytest-httpchain) - Complete guide
+-   [Changelog](CHANGELOG.md) - Release notes
+
+## Thanks
+
+`pytest-httpchain` was heavily inspired by [Tavern](https://github.com/taverntesting/tavern) and [pytest-play](https://github.com/davidemoro/pytest-play).  
+[requests](https://requests.readthedocs.io) does the comms.  
+[Pydantic](https://docs.pydantic.dev) keeps the structure.  
+[pytest-order](https://github.com/pytest-dev/pytest-order) powers the chaining.  
+[pytest-datadir](https://github.com/gabrielcnr/pytest-datadir) saved me a lot of elbow grease.  

pytest_httpchain-0.1.0/README.md

@@ -0,0 +1,220 @@
+[![image](https://img.shields.io/pypi/v/pytest-httpchain)](https://pypi.python.org/pypi/pytest-httpchain)
+[![image](https://img.shields.io/pypi/l/pytest-httpchain)](https://github.com/aeresov/pytest-httpchain/blob/main/LICENSE)
+[![image](https://img.shields.io/pypi/pyversions/pytest-httpchain)](https://pypi.python.org/pypi/pytest-httpchain)
+
+# pytest-httpchain
+
+A pytest plugin for testing HTTP endpoints.
+
+## Overview
+
+`pytest-httpchain` is an integration testing framework for HTTP APIs based on battle-hardened [requests](https://requests.readthedocs.io) lib.\
+It aims at helping with common HTTP API testing scenarios, where user needs to make several calls in specific order using data obtained along the way, like auth tokens or resource ids.
+
+## Installation
+
+Install normally via package manager of your choice from PyPi:
+
+```bash
+pip install pytest-httpchain
+```
+
+or directly from Github, in case you need a particular ref:
+
+```bash
+pip install 'git+https://github.com/aeresov/pytest-httpchain@main'
+```
+
+### Optional dependencies
+
+The following optional dependencies are available:
+
+-   `mcp`: installs MCP server package and its starting script. Details in [MCP Server](#mcp-server).
+
+## Features
+
+### Pytest integration
+
+Most of pytest magic can be used: markers, fixtures, other plugins.\
+
+> NOTE: parametrization is not yet implemented, therefore `parametrize` marker won't have any effect.
+
+### Declarative format
+
+Test scenarios are written declaratively in JSON files.\
+`pytest-httpchain` supports JSONRef, so use can reuse arbitrary parts of your scenarios with `$ref` directive.\
+Properties are merged in a greedy way with type checking.
+
+### Multi-stage tests
+
+Each test scenario contains 1+ stages; each stage is a single HTTP call.\
+`pytest-httpchain` executes stages in the order they are listed in scenario file; one stage failure stops the execution chain.
+
+### Common data context and variable substitution
+
+`pytest-httpchain` maintains key-value data storage throughout the execution.\
+This storage ("common data context") is populated with declared variables, fixtures and data saved by stages. The data remains there throughout the scenario execution.\
+Writing scenarios, you can use Jinja-style expressions like `"{{ var }}"` for JSON values. `pytest-httpchain` does variable substitution dynamically right before executing a stage, and uses common data context keys as variables in these expressions.\
+Values from common data context also might be verified during verified/asserted.
+
+### User functions
+
+`pytest-httpchain` can import and call regular python functions:
+
+-   to extract data from HTTP response
+-   to verify HTTP response and values in common data context
+-   to provide [custom authentication for requests](https://requests.readthedocs.io/en/latest/user/advanced/#custom-authentication)
+
+### JMESPath support
+
+`pytest-httpchain` can extract values from JSON responses using JMESPath expressions directly.
+
+### JSON schema support
+
+`pytest-httpchain` can verify JSON reponses against user-defined JSON schema.
+
+## Quick Start
+
+Create a JSON test file named like `test_<name>.<suffix>.json` (default suffix is `http`):
+
+```python
+# conftest.py
+import pytest
+from datetime import datetime
+
+@pytest.fixture
+def now_utc():
+    return datetime.now()
+```
+
+```json
+{
+    "vars": {
+        "user_id": 1
+    },
+    "stages": [
+        {
+            "name": "get_user",
+            "request": {
+                "url": "https://api.example.com/users/{{ user_id }}"
+            },
+            "response": [
+                {
+                    "verify": {
+                        "status": 200
+                    }
+                },
+                {
+                    "save": {
+                        "vars": {
+                            "user_name": "user.name"
+                        }
+                    }
+                }
+            ]
+        },
+        {
+            "name": "update_user",
+            "fixtures": ["now_utc"],
+            "request": {
+                "url": "https://api.example.com/users/{{ user_id }}",
+                "method": "PUT",
+                "body": {
+                    "json": {
+                        "user": {
+                            "name": "{{ user_name }}_updated",
+                            "timestamp": "{{ str(now_utc) }}"
+                        }
+                    }
+                }
+            },
+            "response": [
+                {
+                    "verify": {
+                        "status": 200
+                    }
+                }
+            ]
+        },
+        {
+            "name": "cleanup",
+            "always_run": true,
+            "request": {
+                "url": "https://api.example.com/cleanup",
+                "method": "POST"
+            }
+        }
+    ]
+}
+```
+
+Scenario we created:
+
+-   common data context is seeded with the first variable `user_id`
+-   **get_user**\
+    url is assembled using `user_id` variable from common data context\
+    HTTP GET call is made\
+    we verify the call returned code 200\
+    assuming JSON body is returned, we extract a value by JMESPath expression `user.name` and save it to common data context under `user_name` key
+-   **update_user**\
+    `now_utc` fixture value is injected into common data context\
+    url is assembled using `user_id` variable from common data context\
+    we create JSON body in place using values from common data context, note that `now_utc` is converted to string in place\
+    HTTP PUT call with body is made\
+    we verify the call returned code 200\
+-   **cleanup**\
+    finalizing call meant for graceful exit\
+    `always_run` parameter means this stage will be executed regardless of errors in previous stages
+
+For detailed examples see [USAGE.md](USAGE.md).
+
+## Configuration
+
+-   Test file discovery is based on this name pattern: `test_<name>.<suffix>.json`.\
+    The `suffix` is configurable as pytest ini option, default value is **http**.
+-   `$ref` instructions can point to other files; absolute and relative paths are supported.\
+    You can limit the depth of relative path traversal using `ref_parent_traversal_depth` ini option, default value is **3**.
+
+## MCP Server
+
+`pytest-httpchain` includes an MCP (Model Context Protocol) server to aid AI code assistants.
+
+### Installation
+
+The optional dependency `mcp` installs MCP server's package and `pytest-httpchain-mcp` script.\
+Use this script as call target for your MCP configuration.
+
+Claude Code `.mcp.json` example:
+
+```json
+{
+    "mcpServers": {
+        "pytest-httpchain": {
+            "type": "stdio",
+            "command": "uv",
+            "args": ["run", "pytest-httpchain-mcp"],
+            "env": {}
+        }
+    }
+}
+```
+
+### Features
+
+The MCP server provides:
+
+-   **Scenario validation** - validate test scenario and scan for possible problems
+
+## Documentation
+
+-   [Usage Examples](USAGE.md) - Practical code examples
+-   [Full Documentation](https://aeresov.github.io/pytest-httpchain) - Complete guide
+-   [Changelog](CHANGELOG.md) - Release notes
+
+## Thanks
+
+`pytest-httpchain` was heavily inspired by [Tavern](https://github.com/taverntesting/tavern) and [pytest-play](https://github.com/davidemoro/pytest-play).  
+[requests](https://requests.readthedocs.io) does the comms.  
+[Pydantic](https://docs.pydantic.dev) keeps the structure.  
+[pytest-order](https://github.com/pytest-dev/pytest-order) powers the chaining.  
+[pytest-datadir](https://github.com/gabrielcnr/pytest-datadir) saved me a lot of elbow grease.  

pytest_httpchain-0.1.0/pyproject.toml

@@ -0,0 +1,112 @@
+[project]
+name = "pytest-httpchain"
+version = "0.1.0"
+description = "pytest plugin for HTTP testing using JSON files"
+readme = "README.md"
+requires-python = ">=3.13,<4.0"
+authors = [{ name = "Alexander Eresov", email = "aeresov@gmail.com" }]
+dependencies = [
+    "pydantic>=2.11.7",
+    "pytest-httpchain-jsonref",
+    "pytest-httpchain-models",
+    "pytest-order>=1.3.0",
+    "rich>=13.7.0",
+]
+keywords = ["testing", "pytest", "requests"]
+license-files = ["LICENSE"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Testing",
+]
+
+[project.optional-dependencies]
+mcp = ["pytest-httpchain-mcp"]
+
+[dependency-groups]
+dev = [
+    "flask-httpauth>=4.8.0",
+    "http-server-mock>=1.7",
+    "pytest-xdist>=3.8.0",
+    "responses>=0.25.7",
+    "ruff>=0.12.1",
+]
+docs = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.6.16",
+    "mkdocstrings>=0.30.0",
+    "mkdocstrings-python>=1.16.12",
+]
+
+[tool.uv]
+default-groups = ["docs"]
+
+[tool.uv.workspace]
+members = ["packages/*"]
+
+[tool.uv.sources]
+pytest-httpchain-jsonref = { workspace = true }
+pytest-httpchain-templates = { workspace = true }
+pytest-httpchain-mcp = { workspace = true }
+pytest-httpchain-models = { workspace = true }
+pytest-httpchain-userfunc = { workspace = true }
+
+[build-system]
+requires = ["uv_build>=0.7.21,<0.8.0"]
+build-backend = "uv_build"
+
+[project.entry-points.pytest11]
+pytest_httpchain = "pytest_httpchain.plugin"
+
+[tool.ruff]
+line-length = 180
+target-version = "py313"
+
+[tool.ruff.format]
+quote-style = "double"
+line-ending = "lf"
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "UP", # pyupgrade
+]
+ignore = []
+
+[tool.ruff.lint.isort]
+known-first-party = ["tests", "utils"]
+
+[tool.pytest.ini_options]
+log_cli = true
+log_cli_level = "INFO"
+# testpaths = ["tests"]
+norecursedirs = ["examples"]
+pytester_example_dir = "tests/integration/examples"
+addopts = ["--log-disable=werkzeug", "--import-mode=importlib"]
+pythonpath = [
+    ".",
+    "packages/pytest-httpchain-jsonref/src",
+    "packages/pytest-httpchain-templates/src",
+    "packages/pytest-httpchain-mcp/src",
+    "packages/pytest-httpchain-models/src",
+    "packages/pytest-httpchain-userfunc/src",
+]
+testpaths = ["tests", "packages/*/tests"]
+
+[tool.pyright]
+exclude = [".tox/"]
+ignore = [".venv/"]
+reportMissingImports = "error"
+reportMissingTypeStubs = false
+reportExplicitAny = false
+typeCheckingMode = "off"
+pythonPlatform = "Linux"