schemathesis 3.33.3__tar.gz → 3.34.1__tar.gz

{schemathesis-3.33.3 → schemathesis-3.34.1}/.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3.25.13
+        uses: github/codeql-action/init@v3.26.2
         with:
           languages: ${{ matrix.language }}
           # If you wish to specify custom queries, you can do so here or in a config file.
@@ -49,7 +49,7 @@ jobs:
       # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
       # If this step fails, then you should remove it and run the build manually (see below)
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v3.25.13
+        uses: github/codeql-action/autobuild@v3.26.2
 
       # ℹ️ Command-line programs to run using the OS shell.
       # 📚 https://git.io/JvXDl
@@ -63,4 +63,4 @@ jobs:
       #   make release
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3.25.13
+        uses: github/codeql-action/analyze@v3.26.2

{schemathesis-3.33.3 → schemathesis-3.34.1}/.github/workflows/codspeed.yml

@@ -21,7 +21,7 @@ jobs:
         run: pip install ".[bench]"
 
       - name: Run benchmarks
-        uses: CodSpeedHQ/action@v2
+        uses: CodSpeedHQ/action@v3
         with:
           token: ${{ secrets.CODSPEED_TOKEN }}
           run: pytest benches/* --codspeed -p no:schemathesis -p no:hypothesispytest -p no:subtests -p no:anyio

{schemathesis-3.33.3 → schemathesis-3.34.1}/.github/workflows/example-build.yml

@@ -36,5 +36,5 @@ jobs:
 
       - name: Stop containers
         if: always()
-        run: docker-compose down
+        run: docker compose down
         working-directory: "./example"

{schemathesis-3.33.3 → schemathesis-3.34.1}/.pre-commit-config.yaml

@@ -25,12 +25,12 @@ repos:
       - id: yamllint
 
   - repo: https://github.com/codingjoe/relint
-    rev: 3.1.1
+    rev: 3.2.0
     hooks:
       - id: relint
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.11.0
+    rev: v1.11.1
     hooks:
       - id: mypy
         exclude: ^(docs/|test/|test-corpus/|example/|benches/).*$
@@ -38,12 +38,12 @@ repos:
         additional_dependencies: [types-click, types-requests, types-PyYAML]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.5
+    rev: v0.6.1
     hooks:
       - id: ruff-format
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.5
+    rev: v0.6.1
     hooks:
       - id: ruff
 

{schemathesis-3.33.3 → schemathesis-3.34.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: schemathesis
-Version: 3.33.3
+Version: 3.34.1
 Summary: Property-based testing framework for Open API and GraphQL based apps
 Project-URL: Documentation, https://schemathesis.readthedocs.io/en/stable/
 Project-URL: Changelog, https://schemathesis.readthedocs.io/en/stable/changelog.html
@@ -33,11 +33,11 @@ Requires-Dist: click<9.0,>=7.0
 Requires-Dist: colorama<1.0,>=0.4
 Requires-Dist: harfile<1.0,>=0.3.0
 Requires-Dist: httpx<1.0,>=0.22.0
-Requires-Dist: hypothesis-graphql<1,>=0.11.0
+Requires-Dist: hypothesis-graphql<1,>=0.11.1
 Requires-Dist: hypothesis-jsonschema<0.24,>=0.23.1
 Requires-Dist: hypothesis<7,>=6.103.4; python_version > '3.8'
 Requires-Dist: hypothesis[zoneinfo]<7,>=6.103.4; python_version == '3.8'
-Requires-Dist: jsonschema<5.0,>=4.18.0
+Requires-Dist: jsonschema[format]<5.0,>=4.18.0
 Requires-Dist: junit-xml<2.0,>=1.9
 Requires-Dist: pyrate-limiter<4.0,>=2.10
 Requires-Dist: pytest-subtests<0.8.0,>=0.2.1
@@ -344,6 +344,10 @@ Schemathesis is used by a number of project and companies, including direct usag
 
 ### Articles
 
+- [Boost Your FastAPI Reliability with Schemathesis Automated Testing](https://medium.com/@jeremy3/boost-your-fastapi-reliability-with-schemathesis-automated-testing-e8b70ff704f6) by **Jeremy**
+  - **Description**: Showcases how easy Schemathesis covers API testing in FastAPI projects.
+  - **Date**: 17 Jul 2024
+
 - [Implementing Schemathesis at PayLead](https://medium.com/paylead/implementing-schemathesis-at-paylead-a469a5d43626) by **Jérémy Pelletier** at **PayLead**
   - **Description**: In-depth walkthrough including custom hooks, stateful testing and CI/CD integration.
   - **Date**: 29 May 2024
@@ -369,6 +373,10 @@ Schemathesis is used by a number of project and companies, including direct usag
 
 ### Videos
 
+- [API Testing With Unittest Mock, Pytest & Schemathesis](https://youtu.be/56whiv57T9I) by **
+Ssali Jonathan**
+  - **Description**: Describes various API testing techniques and features Schemathesis for automatic test generation.
+  - **Date**: 29 Jul 2024
 - [API Fuzzing: What it is and why you should use it](https://youtu.be/wX3GMJY9B6A) by **José Haro Peralta**
   - **Description**: A comprehensive overview and demo of Schemathesis.
   - **Date**: 14 Feb 2023

{schemathesis-3.33.3 → schemathesis-3.34.1}/README.md

@@ -264,6 +264,10 @@ Schemathesis is used by a number of project and companies, including direct usag
 
 ### Articles
 
+- [Boost Your FastAPI Reliability with Schemathesis Automated Testing](https://medium.com/@jeremy3/boost-your-fastapi-reliability-with-schemathesis-automated-testing-e8b70ff704f6) by **Jeremy**
+  - **Description**: Showcases how easy Schemathesis covers API testing in FastAPI projects.
+  - **Date**: 17 Jul 2024
+
 - [Implementing Schemathesis at PayLead](https://medium.com/paylead/implementing-schemathesis-at-paylead-a469a5d43626) by **Jérémy Pelletier** at **PayLead**
   - **Description**: In-depth walkthrough including custom hooks, stateful testing and CI/CD integration.
   - **Date**: 29 May 2024
@@ -289,6 +293,10 @@ Schemathesis is used by a number of project and companies, including direct usag
 
 ### Videos
 
+- [API Testing With Unittest Mock, Pytest & Schemathesis](https://youtu.be/56whiv57T9I) by **
+Ssali Jonathan**
+  - **Description**: Describes various API testing techniques and features Schemathesis for automatic test generation.
+  - **Date**: 29 Jul 2024
 - [API Fuzzing: What it is and why you should use it](https://youtu.be/wX3GMJY9B6A) by **José Haro Peralta**
   - **Description**: A comprehensive overview and demo of Schemathesis.
   - **Date**: 14 Feb 2023

{schemathesis-3.33.3 → schemathesis-3.34.1}/docs/additional-content.rst

@@ -13,6 +13,19 @@ Papers
 Articles
 --------
 
+
+- `Boost Your FastAPI Reliability with Schemathesis Automated Testing <https://medium.com/@jeremy3/boost-your-fastapi-reliability-with-schemathesis-automated-testing-e8b70ff704f6>`_ by **Jeremy**
+
+  - **Description**: Showcases how easy Schemathesis covers API testing in FastAPI projects.
+
+  - **Date**: 17 Jul 2024
+
+- `Implementing Schemathesis at PayLead <https://medium.com/paylead/implementing-schemathesis-at-paylead-a469a5d43626>`_ by **Jérémy Pelletier** at **PayLead**
+
+  - **Description**: In-depth walkthrough including custom hooks, stateful testing and CI/CD integration.
+
+  - **Date**: 29 May 2024
+
 - `Auto-Generating & Validating OpenAPI Docs in Rust: A Streamlined Approach with Utoipa and Schemathesis <https://identeco.de/en/blog/generating_and_validating_openapi_docs_in_rust/>`_ by **identeco**
 
   - **Description**: Demonstrates OpenAPI doc generation with Utoipa and validating it with Schemathesis.

{schemathesis-3.33.3 → schemathesis-3.34.1}/docs/auth.rst

@@ -311,6 +311,27 @@ To disable caching completely, set ``refresh_interval`` to None. For example, th
         # Here goes your implementation
         ...
 
+The default implementation does not use a cache key, but you can provide one to distinguish tokens based on specific criteria.
+For instance, you may want separate cache entries for tokens with different OAuth scopes.
+
+.. code:: python
+
+    def get_scopes(context):
+        security = context.operation.definition.raw.get("security", [])
+        if not security:
+            return None
+        scopes = security[0][context.operation.get_security_requirements()[0]]
+        if not scopes:
+            return None
+        return frozenset(scopes)
+
+    def cache_by_key(case: Case, context: AuthContext) -> str:
+        scopes = get_scopes(context) or []
+        return ",".join(scopes)
+
+    @schema.auth(cache_by_key=cache_by_key)
+    class OAuth2Bearer:
+        ...
 
 WSGI / ASGI support
 ~~~~~~~~~~~~~~~~~~~

{schemathesis-3.33.3 → schemathesis-3.34.1}/docs/changelog.rst

@@ -1,9 +1,47 @@
 Changelog
 =========
 
-:version:`Unreleased <v3.33.3...HEAD>` - TBD
+:version:`Unreleased <v3.34.1...HEAD>` - TBD
 --------------------------------------------
 
+.. _v3.34.1:
+
+:version:`3.34.1 <v3.34.0...v3.34.1>` - 2024-08-20
+--------------------------------------------------
+
+**Fixed**
+
+- Error in ``response_header_conformance`` if the header definition is behind ``$ref``. :issue:`2407`
+
+.. _v3.34.0:
+
+:version:`3.34.0 <v3.33.3...v3.34.0>` - 2024-08-17
+--------------------------------------------------
+
+**Added**
+
+- The ``ensure_resource_availability`` check. It verifies that a freshly created resource is available in related API operations.
+- The ``ignored_auth`` check. It verifies that the API operation requires the specified authentication.
+- Enable string format verification in response conformance checks. :issue:`787`
+- Control over cache key in custom auth implementation. :issue:`1775`
+- The ``--generation-graphql-allow-null`` CLI option that controls whether ``null`` should be used for optional arguments in GraphQL queries. Enabled by default. :issue:`1994`
+- Filters for hooks. :issue:`1852`
+- Verify header schema conformance. :issue:`796`
+
+**Changed**
+
+- Pass default stateful test runner config to ``TestCase`` used by ``pytest`` & ``unittest`` integration.
+- Rework transitions in stateful tests in order to reduce the number of unhelpful API calls.
+- Improve error message when ``base_url`` is missing for a schema loaded from a file.
+
+**Fixed**
+
+- Missing sanitization in new-style stateful tests.
+- Missing new-style stateful testing results in JUnit output.
+- Internal error when handling an exception inside a hook for a GraphQL schema.
+- Filters being ignored in the old-style stateful test runner. :issue:`2376`
+- Missing sanitization for query parameters in code samples.
+
 .. _v3.33.3:
 
 :version:`3.33.3 <v3.33.2...v3.33.3>` - 2024-07-29

{schemathesis-3.33.3 → schemathesis-3.34.1}/docs/cli.rst

@@ -189,8 +189,10 @@ There are four built-in checks you can use via the `--checks / -c` CLI option:
 - ``content_type_conformance``. The response content type is not defined in the API schema;
 - ``response_schema_conformance``. The response content does not conform to the schema defined for this specific response;
 - ``negative_data_rejection``. The API accepts data that is invalid according to the schema;
-- ``response_headers_conformance``. The response headers does not contain all defined headers.
+- ``response_headers_conformance``. The response headers do not contain all defined headers or do not conform to their respective schemas.
 - ``use_after_free``. The API returned a non-404 response a successful DELETE operation on a resource. **NOTE**: Only enabled for new-style stateful testing.
+- ``ensure_resource_availability``. Freshly created resource is not available in related API operations. **NOTE**: Only enabled for new-style stateful testing.
+- ``ignored_auth``. The API operation does not check the specified authentication.
 
 To make Schemathesis perform all built-in checks use ``--checks all`` CLI option:
 

{schemathesis-3.33.3 → schemathesis-3.34.1}/docs/extending.rst

@@ -296,21 +296,51 @@ Remember to return the modified ``body`` or ``case`` object from your hook funct
 Applying Hooks to Specific API Operations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To fine-tune data generation for specific API operations, you can incorporate conditional logic within the hook function. 
-This ensures the hook applies only to relevant scenarios.
+Schemathesis offers a way to apply hooks to only a specific set of API operations during testing.
+This is helpful when you need to run different hooks for different API operations.
+
+Multiple filters can be combined and applied to include or exclude API operations based on exact values, regular expressions, or custom functions.
+Here is how you can apply a hook to all API operations with the ``/users/`` path, but exclude the ``POST`` method.
 
 .. code:: python
 
     import schemathesis
 
 
-    @schemathesis.hook
+    @schemathesis.hook.apply_to(path="/users/").skip_for(method="POST")
+    def filter_body(context, body):
+        ...
+
+.. note::
+
+    This decorator syntax is supported only on Python 3.9+. For older Python versions you need to bind separate variables for each term.
+
+Basic rules:
+
+- ``apply_to`` applies the given hook to all API operations that match the filter term
+- ``skip_for`` skips the given hook for all API operations that match the filter term
+- All conditions within a filter term are combined with the ``AND`` logic
+- Each ``apply_to`` and ``skip_for`` term is combined with the ``OR`` logic
+- Both ``apply_to`` and ``skip_for`` use the same set of conditions as arguments
+
+Conditions:
+
+- ``path``: the path of the API operation without its ``basePath``.
+- ``method``: the upper-cased HTTP method of the API operation
+- ``name``: the name of the API operation, such as ``GET /users/`` or ``Query.getUsers``
+- ``tag``: the tag assigned to the API operation. For Open API it comes from the ``tags`` field.
+- ``operation_id``: the ID of an API operation. For Open API it comes from the ``operationId`` field.
+- Each condition can take either a single string or a list of options as input
+- You can also use a regular expression to match the conditions by adding ``_regex`` to the end of the condition and passing a string or a compiled regex.
+
+.. code:: python
+
+    import schemathesis
+
+
+    @schemathesis.hook.apply_to(name="PATCH /items/{item_id}/")
     def map_case(context, case):
-        op = context.operation
-        # If the operation is `PATCH /items/{item_id}/`,
-        # set `item_id` path parameter to match the body `id`.
-        if op.method == "PATCH" and op.path == "/items/{item_id}/":
-            case.path_parameters["item_id"] = case.body["data"]["id"]
+        case.path_parameters["item_id"] = case.body["data"]["id"]
         return case
 
 In this example, the ``item_id`` path parameter is synchronized with the ``id`` value from the request body, but only for test cases targeting ``PATCH /items/{item_id}/``.

{schemathesis-3.33.3 → schemathesis-3.34.1}/docs/graphql.rst

@@ -50,6 +50,8 @@ If you want to narrow the testing scope, you can use ``--include-name`` and ``--
 
 For GraphQL, the ``name`` attribute is a combination of the type and the field name, for example, ``Query.getBookings`` or ``Mutation.updateUser``.
 
+Additionally, you can disable using ``null`` values for optional arguments via the ``--generation-graphql-allow-null=false`` CLI option.
+
 Custom scalars
 ~~~~~~~~~~~~~~
 

{schemathesis-3.33.3 → schemathesis-3.34.1}/docs/python.rst

@@ -357,8 +357,10 @@ When the received response is validated, Schemathesis runs the following checks:
 - ``content_type_conformance``. The response content type is not defined in the API schema;
 - ``response_schema_conformance``. The response content does not conform to the schema defined for this specific response;
 - ``negative_data_rejection``. The API accepts data that is invalid according to the schema;
-- ``response_headers_conformance``. The response headers does not contain all defined headers.
+- ``response_headers_conformance``. The response headers do not contain all defined headers or do not conform to their respective schemas.
 - ``use_after_free``. The API returned a non-404 response a successful DELETE operation on a resource. **NOTE**: At the moment it is only available in state-machine-based stateful testing.
+- ``ensure_resource_availability``. Freshly created resource is not available in related API operations. **NOTE**: Only enabled for new-style stateful testing.
+- ``ignored_auth``. The API operation does not check the specified authentication.
 
 Validation happens in the ``case.call_and_validate`` function, but you can add your code to verify the response conformance as you do in regular Python tests.
 By default, all available checks will be applied, but you can customize it by passing a tuple of checks explicitly:

schemathesis-3.34.1/pyproject.toml

@@ -0,0 +1,182 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "schemathesis"
+version = "3.34.1"
+description = "Property-based testing framework for Open API and GraphQL based apps"
+keywords = ["pytest", "hypothesis", "openapi", "graphql", "testing"]
+authors = [{ name = "Dmitry Dygalo", email = "dmitry@dygalo.dev" }]
+maintainers = [{ name = "Dmitry Dygalo", email = "dmitry@dygalo.dev" }]
+requires-python = ">=3.8"
+license = "MIT"
+readme = "README.md"
+include = ["src/schemathesis/py.typed"]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Environment :: Console",
+  "Framework :: Pytest",
+  "Framework :: Hypothesis",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Topic :: Software Development :: Testing",
+]
+dependencies = [
+  "backoff>=2.1.2,<3.0",
+  "click>=7.0,<9.0",
+  "colorama>=0.4,<1.0",
+  "harfile>=0.3.0,<1.0",
+  "httpx>=0.22.0,<1.0",
+  "hypothesis>=6.103.4,<7; python_version > '3.8'",
+  "hypothesis[zoneinfo]>=6.103.4,<7; python_version == '3.8'",
+  "hypothesis_graphql>=0.11.1,<1",
+  "hypothesis_jsonschema>=0.23.1,<0.24",
+  "jsonschema[format]>=4.18.0,<5.0",
+  "junit-xml>=1.9,<2.0",
+  "pyrate-limiter>=2.10,<4.0",
+  "pytest-subtests>=0.2.1,<0.8.0",
+  "pytest>=4.6.4,<9",
+  "PyYAML>=5.1,<7.0",
+  "requests>=2.22,<3",
+  "starlette>=0.13,<1",
+  "starlette-testclient>=0.4.1,<1",
+  "tomli-w>=1.0.0,<2.0",
+  "tomli>=2.0.1,<3.0",
+  "werkzeug>=0.16.0,<4",
+  "yarl>=1.5,<2.0",
+]
+[project.optional-dependencies]
+tests = [
+  "aiohttp>=3.9.1,<4.0",
+  "coverage>=6",
+  "fastapi>=0.86.0",
+  "Flask>=2.1.1,<3.0",
+  "hypothesis-openapi>=0.2,<1; python_version >= '3.10'",
+  "pydantic>=1.10.2",
+  "pytest-asyncio>=0.18.0,<1.0",
+  "pytest-httpserver>=1.0,<2.0",
+  "pytest-mock>=3.7.0,<4.0",
+  "pytest-trio>=0.8,<1.0",
+  "pytest-xdist>=3,<4.0",
+  "strawberry-graphql[fastapi]>=0.109.0",
+  "syrupy>=2,<5.0",
+  "trustme>=0.9.0,<1.0",
+]
+cov = ["coverage-enable-subprocess", "coverage[toml]>=5.3"]
+bench = ["pytest-codspeed==2.2.1"]
+docs = ["sphinx", "sphinx_rtd_theme", "sphinx-click"]
+dev = ["schemathesis[tests,cov,bench,docs]"]
+
+[project.urls]
+Documentation = "https://schemathesis.readthedocs.io/en/stable/"
+Changelog = "https://schemathesis.readthedocs.io/en/stable/changelog.html"
+"Bug Tracker" = "https://github.com/schemathesis/schemathesis"
+Funding = "https://github.com/sponsors/Stranger6667"
+"Source Code" = "https://github.com/schemathesis/schemathesis"
+
+[project.scripts]
+schemathesis = "schemathesis.cli:schemathesis"
+st = "schemathesis.cli:schemathesis"
+
+[project.entry-points.pytest11]
+schemathesis = "schemathesis.extra.pytest_plugin"
+
+[tool.pytest.ini_options]
+addopts = ["-ra", "--strict-markers", "--strict-config"]
+xfail_strict = true
+testpaths = "tests"
+norecursedirs = ".hypothesis .idea .git src docs .pytest_cache .mypy_cache .tox"
+
+[tool.coverage.run]
+parallel = true
+branch = true
+source_pkgs = ["schemathesis"]
+
+[tool.coverage.paths]
+source = ["src", ".tox/*/site-packages"]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+precision = 2
+exclude_lines = [
+  "pragma: no cover",
+  "raise NotImplementedError",
+  "if TYPE_CHECKING:",
+  "pass",
+]
+
+[tool.ruff]
+line-length = 120
+target-version = "py38"
+
+[tool.ruff.lint]
+select = [
+  "E", # pycodestyle errors
+  "W", # pycodestyle warnings
+  "F", # pyflakes
+  "C", # flake8-comprehensions
+  "B", # flake8-bugbear
+  "D", # pydocstyle
+]
+ignore = [
+  "E501", # Line too long
+  "B008", # Do not perform function calls in argument defaults
+  "C901", # Too complex
+  "D100", # Missing docstring in public module
+  "D101", # Missing docstring in public class
+  "D102", # Missing docstring in public method
+  "D103", # Missing docstring in public function
+  "D104", # Missing docstring in public package
+  "D105", # Missing docstring in magic method
+  "D107", # Missing docstring in `__init__`
+  "D203", # One blank line before class
+  "D213", # Multiline summary second line
+  "D401", # Imperative mood
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["schemathesis"]
+known-third-party = [
+  "_pytest",
+  "aiohttp",
+  "click",
+  "fastapi",
+  "flask",
+  "graphene",
+  "graphql",
+  "graphql_server",
+  "hypothesis",
+  "hypothesis_graphql",
+  "hypothesis_jsonschema",
+  "jsonschema",
+  "junit_xml",
+  "packaging",
+  "pydantic",
+  "pytest",
+  "pytest_subtests",
+  "requests",
+  "starlette",
+  "urllib3",
+  "werkzeug",
+  "yaml",
+  "yarl",
+]
+
+# Ignore `F401` (unused import) in all `__init__.py` & `_compat.py` files.
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+"_compat.py" = ["F401"]
+"_rate_limiter.py" = ["F401"]
+
+[tool.ruff.format]
+skip-magic-trailing-comma = false