Install normally via package manager of your choice from PyPi:
pip install pytest-httpchain
For pytest, scenario acts like a test module with one test class; stages act like test methods of that class.
Scenario-level pytest markers act like they are applied to python test class.
Stage-level pytest markers act like they are applied to python test function.
Scenario-level pytest fixtures act like they are applied to each test method.
Stage-level pytest fixtures act like they are applied to python test method.
In this example:
xfail and usefixtures('prepare_boilerplate')dummy has function marker skip(reason='not implemented')dummy got fixtures string_value (from scenario) and int_value (individual)# conftest.py
import pytest
@pytest.fixture
def prepare_boilerplate():
# setup actions
yield
# teardown actions
@pytest.fixture
def string_value():
return "answer"
@pytest.fixture
def int_value():
return 42
{
"marks": ["xfail", "usefixtures('prepare_boilerplate')"],
"fixtures": ["string_value"],
"stages": [
{
"name": "dummy",
"marks": ["skip(reason='not implemented')"],
"fixtures": ["int_value"],
"request": {
"url": "https://api.example.com"
}
}
]
}
Example of using $ref and greedy props merge.
requests.json
{
"login": {
"request": {
"url": "https://api.example.com/login"
}
}
}
stages.json
{
"auth": {
"$ref": "requests.json#/login",
"request": {
"params": {
"username": "John Dow"
}
}
}
}
test_scenario.http.json
{
"stages": [
{
"name": "Startup stage",
"$ref": "stages.json#/auth"
}
]
}
Stages are executed in the order they are listed.
In case a stage fails, the rest of chain is stopped.
If always_run field is set, the stage is executed regardless of previous errors (useful for cleanup).
{
"stages": [
{
"name": "login",
"request": {
"url": "https://api.example.com/login"
},
"response": [
{
"verify": {
"status": 200
}
}
]
},
{
"name": "operation",
"request": {
"url": "https://api.example.com/operation",
"method": "POST"
},
"response": [
{
"verify": {
"status": 200
}
}
]
},
{
"name": "logout",
"always_run": true,
"request": {
"url": "https://api.example.com/logout"
}
}
]
}
Common data context is a key-value storage available throughout scenario exection.
In this example, common data context is seeded with var id at the beginning of scenario execution.
Down the stages chain, common data context can be used in jinja-style variable substitutions.
{
"vars": {
"id": 42
},
"stages": [
{
"name": "use resource",
"request": {
"url": "https://api.example.com/operation/",
"method": "POST"
},
"response": [
{
"verify": {
"status": 200
}
}
]
}
]
}
# utilities/save.py
import pytest
import requests
import xml.etree.ElementTree as ET
def extract_xml(response: requests.Response) -> dict[str, Any]
content_type = response.headers.get("Content-Type", "").lower()
is_xml_content = any(xml_type in content_type for xml_type in ["application/xml","text/xml"])
if not is_xml_content:
raise ValueError("not an XML response")
if not response.content:
raise ValueError("no content")
root = ET.fromstring(response.text)
first_author = root.find('.//book/author').text
first_title = root.find('.//book/title').text
return {"author": first_author, "title": first_title}
{
"stages": [
{
"name": "get book data",
"request": {
"url": "https://api.example.com"
},
"response": [
{
"save": {
"functions": ["utilities.save:extract_xml"]
}
},
{
"verify": {
"vars": {
"author": "Jack London"
}
}
}
]
}
]
}
# utilities/verify.py
import pytest
import requests
import xml.etree.ElementTree as ET
def check_xml(response: requests.Response, desired_author: str) -> bool
content_type = response.headers.get("Content-Type", "").lower()
is_xml_content = any(xml_type in content_type for xml_type in ["application/xml","text/xml"])
if not is_xml_content:
raise ValueError("not an XML response")
if not response.content:
raise ValueError("no content")
root = ET.fromstring(response.text)
first_author = root.find('.//book/author').text
return first_author == desired_author
{
"vars": {
"author": "Jack London"
},
"stages": [
{
"name": "get book data",
"request": {
"url": "https://api.example.com"
},
"response": [
{
"verify": {
"functions": [
{
"function": "utilities.verify:check_xml",
"kwargs": {
"desired_author": ""
}
}
]
}
}
]
}
]
}
# utilities/auth.py
import boto3
import requests.auth
from requests_aws4auth import AWS4Auth
def dummy() -> requests.auth.AuthBase:
return requests.auth.HTTPBasicAuth("dummy_user", "dummy_password")
def aws_sigv4(service: str, region: str) -> requests.auth.AuthBase
session = boto3.Session()
credentials = session.get_credentials()
return AWS4Auth(credentials.access_key, credentials.secret_key, region, service, session_token=credentials.token)
{
"auth": "utilities.auth:dummy",
"stages": [
{
"name": "internal operation",
"request": {
"url": "https://api.example.com"
}
},
{
"name": "aws operation",
"request": {
"url": "https://some_service.some_region.amazonaws.com",
"method": "POST",
"auth": {
"function": "utilities.auth:aws_sigv4",
"kwargs": {
"service": "some_service",
"region": "some_region"
}
}
},
"response": [
{
"verify": {
"status": 200
}
}
]
}
]
}
In this example, stage extracts value directly from response JSON body and saves it into common data context.
{
"stages": [
{
"name": "internal operation",
"request": {
"url": "https://api.example.com"
},
"response": [
{
"save": {
"vars": {
"id": "$.collection[0].entity.id"
}
}
}
]
}
]
}
In this example we verify response body using inline JSON schema.
{
"stages": [
{
"name": "internal operation",
"request": {
"url": "https://api.example.com"
},
"response": [
{
"verify": {
"body": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
}
}
}
}
]
}
]
}
[Common errors and solutions]