pytest-api-core 1.0.2__tar.gz → 1.0.4__tar.gz

pytest_api_core-1.0.4/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+include LICENSE

pytest_api_core-1.0.4/PKG-INFO

@@ -0,0 +1,254 @@
+Metadata-Version: 2.4
+Name: pytest-api-core
+Version: 1.0.4
+Summary: Pytest API automation framework with custom HTML reporting, reusable fixtures, and fluent assertions
+Author: QA Platform Team
+License: MIT License
+        
+        Copyright (c) 2026 Subodh Singh
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/sksingh329/pytest-api-core-framework
+Project-URL: Repository, https://github.com/sksingh329/pytest-api-core-framework
+Project-URL: Documentation, https://github.com/sksingh329/pytest-api-core-framework/blob/develop/README.md
+Project-URL: Bug Tracker, https://github.com/sksingh329/pytest-api-core-framework/issues
+Project-URL: Changelog, https://github.com/sksingh329/pytest-api-core-framework/blob/develop/CHANGELOG.md
+Keywords: pytest,api,testing,automation,html-report
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Software Development :: Testing
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest<10.0,>=7.4
+Requires-Dist: requests<3.0,>=2.31
+Requires-Dist: Jinja2<4.0,>=3.1
+Requires-Dist: urllib3<3.0,>=2.0
+Requires-Dist: jsonschema<5.0,>=4.20
+Provides-Extra: dotenv
+Requires-Dist: python-dotenv>=1.0; extra == "dotenv"
+Provides-Extra: dev
+Requires-Dist: pytest-mock>=3.12; extra == "dev"
+Requires-Dist: responses>=0.25; extra == "dev"
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: isort>=5.13; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Dynamic: license-file
+
+# pytest-api-core
+
+[![PyPI version](https://img.shields.io/pypi/v/pytest-api-core)](https://pypi.org/project/pytest-api-core/)
+[![Python](https://img.shields.io/pypi/pyversions/pytest-api-core)](https://pypi.org/project/pytest-api-core/)
+[![License](https://img.shields.io/pypi/l/pytest-api-core)](LICENSE)
+
+> A reusable pytest plugin for API automation — fluent assertions, built-in auth strategies, environment-aware configuration, and a self-contained HTML report.
+
+## Features
+
+- **`APIClient`** — `requests.Session` wrapper with retry, timeout, and structured logging
+- **Fluent assertions** — `assert_that(response).status_is(200).json_path("$.id").equals(1)`
+  (`json_path()` supports a small dot/bracket-index subset, not full JSONPath — see [docs/QUICKSTART.md](docs/QUICKSTART.md#json_path-syntax);
+  `response_time_under()` measures the whole request including any retries, not just the final attempt)
+- **Auth strategies** — Bearer token, Basic, API Key (header/query), OAuth2 client credentials
+  (need something else, like an OAuth2 refresh-token flow or signed requests? subclass `AuthBase` — see [docs/QUICKSTART.md](docs/QUICKSTART.md#custom-auth-handlers))
+- **Standalone assertion helpers** — `assert_equal`, `assert_contains`, `assert_matches`, `assert_matches_schema`, etc. for values outside an `APIResponse` — see [docs/QUICKSTART.md](docs/QUICKSTART.md#standalone-assertion-helpers)
+- **Configurable retry policy** — max attempts, backoff factor, and retryable methods, overridable per environment (see below)
+- **Environment config** — Python `settings.py` classes + `.env` file + env var overrides
+- **Custom HTML report** — self-contained file with charts, filterable table, and request/response details
+- **Auto-registered fixtures** — zero boilerplate in consuming projects
+
+---
+
+## Installation
+
+```bash
+pip install pytest-api-core==1.0.3
+```
+
+With `.env` file support (recommended):
+
+```bash
+pip install "pytest-api-core[dotenv]==1.0.3"
+```
+
+---
+
+## Quick start
+
+```python
+# tests/test_posts.py
+from pytest_api_core.assertions import assert_that
+
+def test_get_post(api_client):
+    response = api_client.get("/posts/1")
+    assert_that(response).status_is(200).json_path("$.id").equals(1)
+
+def test_create_post(api_client):
+    payload = {"title": "foo", "body": "bar", "userId": 1}
+    response = api_client.post("/posts", json=payload)
+    assert_that(response).status_is(201).has_key("id")
+```
+
+```bash
+pytest tests/ --api-env=staging
+```
+
+For full setup instructions — including `pytest.ini`, `config/settings.py`, `conftest.py` auth overrides, and CI integration — see **[docs/QUICKSTART.md](docs/QUICKSTART.md)**.
+
+---
+
+## Configuration
+
+### Resolution order (highest → lowest priority)
+
+| Priority | Source |
+|---|---|
+| 1 | Shell / CI environment variables (`API_BASE_URL`, `API_TOKEN`, …) |
+| 2 | `--api-base-url` CLI flag |
+| 3 | `ENVIRONMENTS[env]` class in `settings_module` |
+| 4 | Built-in defaults (`http://localhost`, timeout 30 s) |
+
+### Retry policy
+
+`APIClient` retries idempotent requests (`GET`, `HEAD`, `OPTIONS`) on `500/502/503/504`
+responses using `urllib3.Retry`. All three knobs follow the same env var → CLI flag →
+`settings_module` → built-in default precedence as `base_url`:
+
+| Setting | `settings_module` attribute | CLI flag | Env var | Default |
+|---|---|---|---|---|
+| Max retry attempts | `api_retry_total` | `--api-retry-total` | `API_RETRY_TOTAL` | `3` |
+| Backoff factor | `api_retry_backoff_factor` | `--api-retry-backoff-factor` | `API_RETRY_BACKOFF_FACTOR` | `0.3` |
+| Retryable methods | `api_retry_methods` | `--api-retry-methods` (comma-separated) | `API_RETRY_METHODS` (comma-separated) | `GET,HEAD,OPTIONS` |
+
+Backoff factor `0.3` produces sleeps of `0s, 0.3s, 0.6s, 1.2s, ...` between attempts.
+
+Example — a flakier staging environment gets more retries and a longer backoff:
+
+```python
+# settings.py
+class StagingSettings(BaseSettings):
+    base_url = "https://api.staging.mycompany.com"
+    api_retry_total = 5
+    api_retry_backoff_factor = 1.0
+```
+
+Or per-run, without touching code:
+
+```bash
+pytest tests/ --api-env=staging --api-retry-total=5 --api-retry-backoff-factor=1.0
+```
+
+To disable retries entirely, pass `retry=None` directly when constructing an
+`APIClient` yourself (not available as a config option, since "no retries" isn't
+something you'd want to toggle per environment).
+
+### Key `pytest.ini` options
+
+| Option | Description | Default |
+|---|---|---|
+| `api_env` | Active environment name | `dev` |
+| `api_settings_module` | Dotted path to your settings module | — |
+| `api_dotenv_file` | Path to `.env` file | `.env` |
+| `api_log_level` | Framework log level | `WARNING` |
+| `api_html_report` | HTML report path (supports `{env}`, `{timestamp}`) | — |
+| `api_html_theme` | Report theme: `light` or `dark` | `dark` |
+| `api_html_title` | Report browser tab title | `API Test Report` |
+| `api_html_header` | Report page header text | `API Test Report` |
+
+### CLI flags
+
+| Flag | Description |
+|---|---|
+| `--api-env` | Override active environment |
+| `--api-base-url` | Override `base_url` |
+| `--api-log-level` | Override framework log level |
+| `--api-html-report` | Override HTML report path |
+| `--api-retry-total` | Override max retry attempts (default: `3`) |
+| `--api-retry-backoff-factor` | Override retry backoff factor (default: `0.3`) |
+| `--api-retry-methods` | Override retryable HTTP methods, comma-separated (default: `GET,HEAD,OPTIONS`) |
+
+---
+
+## Fixtures
+
+All fixtures are auto-registered — no imports needed in `conftest.py`.
+
+| Fixture | Scope | Description |
+|---|---|---|
+| `api_config` | session | Resolved config dict for the active env |
+| `auth_provider` | session | Auth strategy passed to `api_client` — override this alone to swap auth |
+| `api_client` | session | Configured `APIClient` instance, depends on `auth_provider` |
+| `api_bearer_auth` | function | `BearerAuth` from `API_TOKEN` env var |
+| `api_basic_auth` | function | `BasicAuth` from `API_USERNAME` / `API_PASSWORD` |
+| `api_key_auth` | function | `APIKeyAuth` from `API_KEY_NAME` / `API_KEY_VALUE` |
+
+Override `auth_provider` in your project's `conftest.py` to inject custom auth without
+redeclaring `api_client` — see [docs/QUICKSTART.md](docs/QUICKSTART.md#7-override-auth--testsconftestpy).
+
+---
+
+## Project structure
+
+```
+pytest-api-core-framework/
+├── src/pytest_api_core/
+│   ├── plugin.py               # pytest11 entry point — CLI/ini options, .env loading, reporter registration
+│   ├── assertions/
+│   │   ├── response_assertions.py   # assert_that(response) fluent chain
+│   │   └── assert_utils.py          # standalone helpers: assert_equal, assert_contains, ...
+│   ├── auth/
+│   │   └── auth_handlers.py    # BearerAuth, BasicAuth, APIKeyAuth, OAuth2ClientCredentials
+│   ├── client/
+│   │   ├── api_client.py       # APIClient (requests.Session wrapper, retry, __API_CALL__ logging)
+│   │   └── api_response.py     # APIResponse wrapper (adds elapsed_ms)
+│   ├── config/
+│   │   ├── base_settings.py    # BaseSettings — subclass to define environments
+│   │   ├── config_manager.py   # ConfigManager — merges env vars / CLI / settings_module / defaults
+│   │   └── env_loader.py       # .env file loading
+│   ├── fixtures/
+│   │   └── api_fixtures.py     # api_config, auth_provider, api_client, api_*_auth fixtures
+│   └── reporters/
+│       ├── html_reporter.py    # parses __API_CALL__/__API_ASSERT__ sentinels, renders HTML report
+│       └── templates/report.html
+├── tests/
+│   ├── unit/test_unit.py       # mocked HTTP tests (responses library)
+│   └── e2e/test_e2e_jsonplaceholder.py  # live tests against jsonplaceholder.typicode.com
+├── docs/QUICKSTART.md          # full setup guide (settings.py, conftest.py, CI)
+├── config/settings.py          # example ENVIRONMENTS settings module
+└── pyproject.toml
+```
+
+---
+
+## License
+
+See [LICENSE](LICENSE).

pytest_api_core-1.0.4/README.md

@@ -0,0 +1,188 @@
+# pytest-api-core
+
+[![PyPI version](https://img.shields.io/pypi/v/pytest-api-core)](https://pypi.org/project/pytest-api-core/)
+[![Python](https://img.shields.io/pypi/pyversions/pytest-api-core)](https://pypi.org/project/pytest-api-core/)
+[![License](https://img.shields.io/pypi/l/pytest-api-core)](LICENSE)
+
+> A reusable pytest plugin for API automation — fluent assertions, built-in auth strategies, environment-aware configuration, and a self-contained HTML report.
+
+## Features
+
+- **`APIClient`** — `requests.Session` wrapper with retry, timeout, and structured logging
+- **Fluent assertions** — `assert_that(response).status_is(200).json_path("$.id").equals(1)`
+  (`json_path()` supports a small dot/bracket-index subset, not full JSONPath — see [docs/QUICKSTART.md](docs/QUICKSTART.md#json_path-syntax);
+  `response_time_under()` measures the whole request including any retries, not just the final attempt)
+- **Auth strategies** — Bearer token, Basic, API Key (header/query), OAuth2 client credentials
+  (need something else, like an OAuth2 refresh-token flow or signed requests? subclass `AuthBase` — see [docs/QUICKSTART.md](docs/QUICKSTART.md#custom-auth-handlers))
+- **Standalone assertion helpers** — `assert_equal`, `assert_contains`, `assert_matches`, `assert_matches_schema`, etc. for values outside an `APIResponse` — see [docs/QUICKSTART.md](docs/QUICKSTART.md#standalone-assertion-helpers)
+- **Configurable retry policy** — max attempts, backoff factor, and retryable methods, overridable per environment (see below)
+- **Environment config** — Python `settings.py` classes + `.env` file + env var overrides
+- **Custom HTML report** — self-contained file with charts, filterable table, and request/response details
+- **Auto-registered fixtures** — zero boilerplate in consuming projects
+
+---
+
+## Installation
+
+```bash
+pip install pytest-api-core==1.0.3
+```
+
+With `.env` file support (recommended):
+
+```bash
+pip install "pytest-api-core[dotenv]==1.0.3"
+```
+
+---
+
+## Quick start
+
+```python
+# tests/test_posts.py
+from pytest_api_core.assertions import assert_that
+
+def test_get_post(api_client):
+    response = api_client.get("/posts/1")
+    assert_that(response).status_is(200).json_path("$.id").equals(1)
+
+def test_create_post(api_client):
+    payload = {"title": "foo", "body": "bar", "userId": 1}
+    response = api_client.post("/posts", json=payload)
+    assert_that(response).status_is(201).has_key("id")
+```
+
+```bash
+pytest tests/ --api-env=staging
+```
+
+For full setup instructions — including `pytest.ini`, `config/settings.py`, `conftest.py` auth overrides, and CI integration — see **[docs/QUICKSTART.md](docs/QUICKSTART.md)**.
+
+---
+
+## Configuration
+
+### Resolution order (highest → lowest priority)
+
+| Priority | Source |
+|---|---|
+| 1 | Shell / CI environment variables (`API_BASE_URL`, `API_TOKEN`, …) |
+| 2 | `--api-base-url` CLI flag |
+| 3 | `ENVIRONMENTS[env]` class in `settings_module` |
+| 4 | Built-in defaults (`http://localhost`, timeout 30 s) |
+
+### Retry policy
+
+`APIClient` retries idempotent requests (`GET`, `HEAD`, `OPTIONS`) on `500/502/503/504`
+responses using `urllib3.Retry`. All three knobs follow the same env var → CLI flag →
+`settings_module` → built-in default precedence as `base_url`:
+
+| Setting | `settings_module` attribute | CLI flag | Env var | Default |
+|---|---|---|---|---|
+| Max retry attempts | `api_retry_total` | `--api-retry-total` | `API_RETRY_TOTAL` | `3` |
+| Backoff factor | `api_retry_backoff_factor` | `--api-retry-backoff-factor` | `API_RETRY_BACKOFF_FACTOR` | `0.3` |
+| Retryable methods | `api_retry_methods` | `--api-retry-methods` (comma-separated) | `API_RETRY_METHODS` (comma-separated) | `GET,HEAD,OPTIONS` |
+
+Backoff factor `0.3` produces sleeps of `0s, 0.3s, 0.6s, 1.2s, ...` between attempts.
+
+Example — a flakier staging environment gets more retries and a longer backoff:
+
+```python
+# settings.py
+class StagingSettings(BaseSettings):
+    base_url = "https://api.staging.mycompany.com"
+    api_retry_total = 5
+    api_retry_backoff_factor = 1.0
+```
+
+Or per-run, without touching code:
+
+```bash
+pytest tests/ --api-env=staging --api-retry-total=5 --api-retry-backoff-factor=1.0
+```
+
+To disable retries entirely, pass `retry=None` directly when constructing an
+`APIClient` yourself (not available as a config option, since "no retries" isn't
+something you'd want to toggle per environment).
+
+### Key `pytest.ini` options
+
+| Option | Description | Default |
+|---|---|---|
+| `api_env` | Active environment name | `dev` |
+| `api_settings_module` | Dotted path to your settings module | — |
+| `api_dotenv_file` | Path to `.env` file | `.env` |
+| `api_log_level` | Framework log level | `WARNING` |
+| `api_html_report` | HTML report path (supports `{env}`, `{timestamp}`) | — |
+| `api_html_theme` | Report theme: `light` or `dark` | `dark` |
+| `api_html_title` | Report browser tab title | `API Test Report` |
+| `api_html_header` | Report page header text | `API Test Report` |
+
+### CLI flags
+
+| Flag | Description |
+|---|---|
+| `--api-env` | Override active environment |
+| `--api-base-url` | Override `base_url` |
+| `--api-log-level` | Override framework log level |
+| `--api-html-report` | Override HTML report path |
+| `--api-retry-total` | Override max retry attempts (default: `3`) |
+| `--api-retry-backoff-factor` | Override retry backoff factor (default: `0.3`) |
+| `--api-retry-methods` | Override retryable HTTP methods, comma-separated (default: `GET,HEAD,OPTIONS`) |
+
+---
+
+## Fixtures
+
+All fixtures are auto-registered — no imports needed in `conftest.py`.
+
+| Fixture | Scope | Description |
+|---|---|---|
+| `api_config` | session | Resolved config dict for the active env |
+| `auth_provider` | session | Auth strategy passed to `api_client` — override this alone to swap auth |
+| `api_client` | session | Configured `APIClient` instance, depends on `auth_provider` |
+| `api_bearer_auth` | function | `BearerAuth` from `API_TOKEN` env var |
+| `api_basic_auth` | function | `BasicAuth` from `API_USERNAME` / `API_PASSWORD` |
+| `api_key_auth` | function | `APIKeyAuth` from `API_KEY_NAME` / `API_KEY_VALUE` |
+
+Override `auth_provider` in your project's `conftest.py` to inject custom auth without
+redeclaring `api_client` — see [docs/QUICKSTART.md](docs/QUICKSTART.md#7-override-auth--testsconftestpy).
+
+---
+
+## Project structure
+
+```
+pytest-api-core-framework/
+├── src/pytest_api_core/
+│   ├── plugin.py               # pytest11 entry point — CLI/ini options, .env loading, reporter registration
+│   ├── assertions/
+│   │   ├── response_assertions.py   # assert_that(response) fluent chain
+│   │   └── assert_utils.py          # standalone helpers: assert_equal, assert_contains, ...
+│   ├── auth/
+│   │   └── auth_handlers.py    # BearerAuth, BasicAuth, APIKeyAuth, OAuth2ClientCredentials
+│   ├── client/
+│   │   ├── api_client.py       # APIClient (requests.Session wrapper, retry, __API_CALL__ logging)
+│   │   └── api_response.py     # APIResponse wrapper (adds elapsed_ms)
+│   ├── config/
+│   │   ├── base_settings.py    # BaseSettings — subclass to define environments
+│   │   ├── config_manager.py   # ConfigManager — merges env vars / CLI / settings_module / defaults
+│   │   └── env_loader.py       # .env file loading
+│   ├── fixtures/
+│   │   └── api_fixtures.py     # api_config, auth_provider, api_client, api_*_auth fixtures
+│   └── reporters/
+│       ├── html_reporter.py    # parses __API_CALL__/__API_ASSERT__ sentinels, renders HTML report
+│       └── templates/report.html
+├── tests/
+│   ├── unit/test_unit.py       # mocked HTTP tests (responses library)
+│   └── e2e/test_e2e_jsonplaceholder.py  # live tests against jsonplaceholder.typicode.com
+├── docs/QUICKSTART.md          # full setup guide (settings.py, conftest.py, CI)
+├── config/settings.py          # example ENVIRONMENTS settings module
+└── pyproject.toml
+```
+
+---
+
+## License
+
+See [LICENSE](LICENSE).

{pytest_api_core-1.0.2 → pytest_api_core-1.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pytest-api-core"
-version = "1.0.2"
+version = "1.0.4"
 description = "Pytest API automation framework with custom HTML reporting, reusable fixtures, and fluent assertions"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -14,21 +14,24 @@ classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Framework :: Pytest",
     "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
     "Topic :: Software Development :: Testing",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Operating System :: OS Independent",
 ]
 requires-python = ">=3.9"
 dependencies = [
-    "pytest>=7.4",
-    "requests>=2.31",
-    "Jinja2>=3.1",
-    "urllib3>=2.0",
-    "jsonschema>=4.20",
+    "pytest>=7.4,<10.0",
+    "requests>=2.31,<3.0",
+    "Jinja2>=3.1,<4.0",
+    "urllib3>=2.0,<3.0",
+    "jsonschema>=4.20,<5.0",
 ]
 
 [project.optional-dependencies]

pytest_api_core-1.0.4/src/pytest_api_core/__init__.py

@@ -0,0 +1,41 @@
+"""
+pytest-api-core: Reusable API automation framework for pytest.
+Auto-registered as a pytest plugin via entry_points["pytest11"].
+"""
+
+from pytest_api_core.assertions.assert_utils import (
+    assert_contains,
+    assert_equal,
+    assert_equal_ignore_case,
+    assert_is_empty,
+    assert_is_not_empty,
+    assert_matches,
+    assert_not_equal,
+)
+from pytest_api_core.assertions.response_assertions import assert_that
+from pytest_api_core.auth.auth_handlers import (
+    APIKeyAuth,
+    BasicAuth,
+    BearerAuth,
+    OAuth2ClientCredentials,
+)
+from pytest_api_core.client.api_client import APIClient
+from pytest_api_core.client.api_response import APIResponse
+
+__version__ = "1.0.0"
+__all__ = [
+    "APIClient",
+    "APIResponse",
+    "assert_that",
+    "assert_equal",
+    "assert_not_equal",
+    "assert_equal_ignore_case",
+    "assert_contains",
+    "assert_matches",
+    "assert_is_empty",
+    "assert_is_not_empty",
+    "BearerAuth",
+    "BasicAuth",
+    "APIKeyAuth",
+    "OAuth2ClientCredentials",
+]

pytest_api_core-1.0.4/src/pytest_api_core/assertions/__init__.py

@@ -0,0 +1,24 @@
+from pytest_api_core.assertions.assert_utils import (
+    assert_contains,
+    assert_equal,
+    assert_equal_ignore_case,
+    assert_is_empty,
+    assert_is_not_empty,
+    assert_matches,
+    assert_matches_schema,
+    assert_not_equal,
+)
+from pytest_api_core.assertions.response_assertions import ResponseAssertions, assert_that
+
+__all__ = [
+    "ResponseAssertions",
+    "assert_that",
+    "assert_equal",
+    "assert_not_equal",
+    "assert_equal_ignore_case",
+    "assert_contains",
+    "assert_matches",
+    "assert_matches_schema",
+    "assert_is_empty",
+    "assert_is_not_empty",
+]

pytest_api_core-1.0.4/src/pytest_api_core/assertions/assert_utils.py

@@ -0,0 +1,114 @@
+"""
+Generic, standalone string assertion utilities.
+
+Usage
+-----
+    from pytest_api_core.assertions import assert_equal
+
+    assert_equal(actual, expected)
+    assert_contains(actual, "substring")
+    assert_matches(actual, r"^\\d+$")
+    assert_matches_schema(actual, schema)
+
+Unlike :class:`ResponseAssertions`, these are plain functions for comparing
+arbitrary actual/expected strings — not tied to an ``APIResponse``.
+"""
+
+from __future__ import annotations
+
+import json
+import logging
+import re
+from typing import Any
+
+_assert_log = logging.getLogger("pytest_api_core.assertions")
+
+
+def _emit(name: str, passed: bool, **detail: object) -> None:
+    """Emit a machine-readable sentinel line captured by HTMLReporter."""
+    _assert_log.debug(
+        "__API_ASSERT__ %s",
+        json.dumps({"name": name, "passed": passed, **detail}, separators=(",", ":")),
+    )
+
+
+def _fail(message: str | None, default: str) -> None:
+    raise AssertionError(f"{message}\n  {default}" if message else default)
+
+
+def assert_equal(actual: str, expected: str, *, message: str | None = None) -> None:
+    """Assert *actual* equals *expected*."""
+    passed = actual == expected
+    _emit("assert_equal", passed, expected=expected, actual=actual)
+    if not passed:
+        _fail(message, f"Expected {expected!r}, got {actual!r}.")
+
+
+def assert_not_equal(actual: str, expected: str, *, message: str | None = None) -> None:
+    """Assert *actual* does not equal *expected*."""
+    passed = actual != expected
+    _emit("assert_not_equal", passed, expected=expected, actual=actual)
+    if not passed:
+        _fail(message, f"Expected value to differ from {expected!r}, got {actual!r}.")
+
+
+def assert_equal_ignore_case(actual: str, expected: str, *, message: str | None = None) -> None:
+    """Assert *actual* equals *expected*, ignoring case."""
+    passed = actual.lower() == expected.lower()
+    _emit("assert_equal_ignore_case", passed, expected=expected, actual=actual)
+    if not passed:
+        _fail(message, f"Expected {expected!r} (case-insensitive), got {actual!r}.")
+
+
+def assert_contains(actual: str, expected_substring: str, *, message: str | None = None) -> None:
+    """Assert *actual* contains *expected_substring*."""
+    passed = expected_substring in actual
+    _emit("assert_contains", passed, expected_substring=expected_substring, actual=actual)
+    if not passed:
+        _fail(message, f"Expected {actual!r} to contain {expected_substring!r}.")
+
+
+def assert_matches(actual: str, pattern: str, *, message: str | None = None) -> None:
+    """Assert *actual* matches the regex *pattern*."""
+    passed = re.search(pattern, actual) is not None
+    _emit("assert_matches", passed, pattern=pattern, actual=actual)
+    if not passed:
+        _fail(message, f"Expected {actual!r} to match /{pattern}/.")
+
+
+def assert_is_empty(actual: str, *, message: str | None = None) -> None:
+    """Assert *actual* is an empty string."""
+    passed = actual == ""
+    _emit("assert_is_empty", passed, actual=actual)
+    if not passed:
+        _fail(message, f"Expected empty string, got {actual!r}.")
+
+
+def assert_is_not_empty(actual: str, *, message: str | None = None) -> None:
+    """Assert *actual* is a non-empty string."""
+    passed = actual != ""
+    _emit("assert_is_not_empty", passed, actual=actual)
+    if not passed:
+        _fail(message, "Expected non-empty string, got empty string.")
+
+
+def assert_matches_schema(
+    actual: object, schema: dict[str, Any], *, message: str | None = None
+) -> None:
+    """Assert *actual* conforms to the given JSON Schema, collecting all errors."""
+    import jsonschema
+
+    validator = jsonschema.Draft7Validator(schema)
+    errors = sorted(validator.iter_errors(actual), key=lambda e: list(e.path))
+    passed = not errors
+    error_messages = [e.message for e in errors]
+    _emit(
+        "assert_matches_schema",
+        passed,
+        errors=error_messages,
+        schema=json.dumps(schema, indent=2, default=str),
+        actual=json.dumps(actual, indent=2, default=str),
+    )
+    if not passed:
+        joined = "; ".join(error_messages)
+        _fail(message, f"Schema validation failed with {len(errors)} error(s): {joined}")