schemathesis 3.39.12__tar.gz → 3.39.14__tar.gz

{schemathesis-3.39.12 → schemathesis-3.39.14}/.readthedocs.yml

@@ -4,6 +4,9 @@ build:
   tools:
     python: "3.11"
 
+sphinx:
+  configuration: docs/conf.py
+
 python:
   install:
     - method: pip

{schemathesis-3.39.12 → schemathesis-3.39.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: schemathesis
-Version: 3.39.12
+Version: 3.39.14
 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
@@ -213,7 +213,7 @@ api-tests:
         schema: "https://example.schemathesis.io/openapi.json"
 ```
 
-For more details, check out our [GitHub Action](https://github.com/schemathesis/action) repository or see our [GitHub Tutorial](https://docs.schemathesis.io/tutorials/github).
+For more details, check out our [GitHub Action](https://github.com/schemathesis/action) repository.
 
 ## Who's Using Schemathesis?
 

{schemathesis-3.39.12 → schemathesis-3.39.14}/README.md

@@ -113,7 +113,7 @@ api-tests:
         schema: "https://example.schemathesis.io/openapi.json"
 ```
 
-For more details, check out our [GitHub Action](https://github.com/schemathesis/action) repository or see our [GitHub Tutorial](https://docs.schemathesis.io/tutorials/github).
+For more details, check out our [GitHub Action](https://github.com/schemathesis/action) repository.
 
 ## Who's Using Schemathesis?
 

{schemathesis-3.39.12 → schemathesis-3.39.14}/docs/api.rst

@@ -87,16 +87,6 @@ Targeted testing
    :members:
 .. autofunction:: schemathesis.target
 
-Custom strategies for Open API "format" keyword
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autofunction:: schemathesis.openapi.format
-
-Custom strategies for Open API media types
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autofunction:: schemathesis.openapi.media_type
-
 Custom scalars for GraphQL
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 

{schemathesis-3.39.12 → schemathesis-3.39.14}/docs/changelog.rst

@@ -1,9 +1,28 @@
 Changelog
 =========
 
-:version:`Unreleased <v3.39.12...HEAD>` - TBD
+:version:`Unreleased <v3.39.14...HEAD>` - TBD
 ---------------------------------------------
 
+.. _v3.39.14:
+
+:version:`3.39.14 <v3.39.13...v3.39.14>` - 2025-03-20
+-----------------------------------------------------
+
+**Fixed**
+
+- Internal error in the coverage phase due to incorrect example value extraction.
+- If the generated query parameter value is an empty object, send it as an empty string.
+
+.. _v3.39.13:
+
+:version:`3.39.13 <v3.39.12...v3.39.13>` - 2025-03-09
+-----------------------------------------------------
+
+**Documentation**
+
+- Fix documentation build.
+
 .. _v3.39.12:
 
 :version:`3.39.12 <v3.39.11...v3.39.12>` - 2025-03-05

{schemathesis-3.39.12 → schemathesis-3.39.14}/docs/continuous_integration.rst

@@ -6,10 +6,6 @@ This guide outlines how to set up Schemathesis for automated API testing in your
 GitHub Actions
 --------------
 
-.. note::
-
-    💡 See our `GitHub Tutorial <https://docs.schemathesis.io/tutorials/github>`_ for a step-by-step guidance.
-
 For initial setup in a GitHub Actions workflow:
 
 .. code-block:: yaml
@@ -20,13 +16,6 @@ For initial setup in a GitHub Actions workflow:
       - uses: schemathesis/action@v1
         with:
           schema: 'http://127.0.0.1:5000/api/openapi.json'
-          # Optional, for PR comments
-          token: ${{ secrets.SCHEMATHESIS_TOKEN }}
-
-To get test results as comments in your GitHub pull requests, both the ``token`` and the `GitHub app`_ are required.
-Obtain the token by signing up on `Schemathesis.io <https://app.schemathesis.io/auth/sign-up/?utm_source=oss_docs&utm_content=ci>`_.
-
-.. image:: https://raw.githubusercontent.com/schemathesis/schemathesis/master/img/service_github_report.png
 
 To add headers like ``Authorization``:
 
@@ -81,8 +70,6 @@ In most cases, you'll want to set up your app in the CI environment. Here's a Gi
       - uses: schemathesis/action@v1
         with:
           schema: 'http://127.0.0.1:5000/api/openapi.json'
-          # Optional, for PR comments
-          token: ${{ secrets.SCHEMATHESIS_TOKEN }}
 
 API Schema in a File
 --------------------
@@ -120,4 +107,3 @@ You can configure Schemathesis behavior using the following environment variable
 - **SCHEMATHESIS_REPORT**: Enable or disable reporting. Valid values: ``true``, ``false``
 
 .. _Python app: https://github.com/schemathesis/schemathesis/tree/master/example
-.. _GitHub app: https://github.com/apps/schemathesis

{schemathesis-3.39.12 → schemathesis-3.39.14}/docs/getting-started.rst

@@ -58,10 +58,6 @@ GitHub Integration
 GitHub Actions
 ^^^^^^^^^^^^^^
 
-.. note::
-
-    💡 See our `GitHub Tutorial <https://docs.schemathesis.io/tutorials/github>`_ for a step-by-step guidance.
-
 Run Schemathesis tests as a part of your CI/CD pipeline. Add this YAML configuration to your GitHub Actions:
 
 .. code-block:: yaml
@@ -72,22 +68,5 @@ Run Schemathesis tests as a part of your CI/CD pipeline. Add this YAML configura
        - uses: schemathesis/action@v1
          with:
            schema: "https://example.schemathesis.io/openapi.json"
-           # OPTIONAL. Add Schemathesis.io token for pull request reports
-           token: ${{ secrets.SCHEMATHESIS_TOKEN }}
 
 For more details, check out our `GitHub Action <https://github.com/schemathesis/action>`_ repository.
-
-GitHub App
-^^^^^^^^^^
-
-Receive automatic comments in your pull requests and updates on GitHub checks status. Requires usage of our `SaaS platform <https://app.schemathesis.io/auth/sign-up/?utm_source=oss_docs&utm_content=index_note>`_.
-
-1. Install the `GitHub app <https://github.com/apps/schemathesis>`_.
-2. Enable in your repository settings.
-
-.. image:: https://raw.githubusercontent.com/schemathesis/schemathesis/master/img/service_github_report.png
-
-Service
--------
-
-If you prefer an all-in-one solution with quick setup, we have a `free tier <https://schemathesis.io/#pricing>`_ available.

{schemathesis-3.39.12 → schemathesis-3.39.14}/docs/index.rst

@@ -85,7 +85,6 @@ It generally follows the operational workflow of Schemathesis, detailing steps f
    python
    continuous_integration
    experimental
-   service
    auth
    contrib
    stateful

{schemathesis-3.39.12 → schemathesis-3.39.14}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "schemathesis"
-version = "3.39.12"
+version = "3.39.14"
 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" }]

{schemathesis-3.39.12 → schemathesis-3.39.14}/src/schemathesis/specs/openapi/examples.py

@@ -398,45 +398,62 @@ def find_matching_in_responses(examples: dict[str, list], param: str) -> Iterato
             if not isinstance(example, dict):
                 continue
             # Unwrapping example from `{"item": [{...}]}`
-            if isinstance(example, dict) and len(example) == 1 and list(example)[0].lower() == schema_name.lower():
-                inner = list(example.values())[0]
-                if isinstance(inner, list):
-                    for sub_example in inner:
-                        found = _find_matching_in_responses(sub_example, schema_name, param, normalized, is_id_param)
-                        if found is not NOT_FOUND:
-                            yield found
-                    continue
-                if isinstance(inner, dict):
-                    example = inner
-            found = _find_matching_in_responses(example, schema_name, param, normalized, is_id_param)
-            if found is not NOT_FOUND:
-                yield found
+            if isinstance(example, dict):
+                inner = next((value for key, value in example.items() if key.lower() == schema_name.lower()), None)
+                if inner is not None:
+                    if isinstance(inner, list):
+                        for sub_example in inner:
+                            if isinstance(sub_example, dict):
+                                for found in _find_matching_in_responses(
+                                    sub_example, schema_name, param, normalized, is_id_param
+                                ):
+                                    if found is not NOT_FOUND:
+                                        yield found
+                        continue
+                    if isinstance(inner, dict):
+                        example = inner
+            for found in _find_matching_in_responses(example, schema_name, param, normalized, is_id_param):
+                if found is not NOT_FOUND:
+                    yield found
 
 
 def _find_matching_in_responses(
     example: dict[str, Any], schema_name: str, param: str, normalized: str, is_id_param: bool
-) -> Any:
+) -> Iterator[Any]:
     # Check for exact match
     if param in example:
-        return example[param]
+        yield example[param]
+        return
     if is_id_param and param[:-2] in example:
-        return example[param[:-2]]
+        value = example[param[:-2]]
+        if isinstance(value, list):
+            for sub_example in value:
+                for found in _find_matching_in_responses(sub_example, schema_name, param, normalized, is_id_param):
+                    if found is not NOT_FOUND:
+                        yield found
+            return
+        else:
+            yield value
+            return
 
     # Check for case-insensitive match
     for key in example:
         if key.lower() == normalized:
-            return example[key]
+            yield example[key]
+            return
     else:
         # If no match found and it's an ID parameter, try additional checks
         if is_id_param:
             # Check for 'id' if parameter is '{something}Id'
             if "id" in example:
-                return example["id"]
+                yield example["id"]
+                return
             # Check for '{schemaName}Id' or '{schemaName}_id'
             if normalized == "id" or normalized.startswith(schema_name.lower()):
                 for key in (schema_name, schema_name.lower()):
                     for suffix in ("_id", "Id"):
                         with_suffix = f"{key}{suffix}"
                         if with_suffix in example:
-                            return example[with_suffix]
-    return NOT_FOUND
+                            yield example[with_suffix]
+                            return
+    yield NOT_FOUND

{schemathesis-3.39.12 → schemathesis-3.39.14}/src/schemathesis/transports/__init__.py

@@ -14,6 +14,7 @@ from .. import failures
 from .._dependency_versions import IS_WERKZEUG_ABOVE_3
 from ..constants import DEFAULT_RESPONSE_TIMEOUT, NOT_SET
 from ..exceptions import get_timeout_error
+from ..internal.copy import fast_deepcopy
 from ..serializers import SerializerContext
 from ..types import Cookies, NotSet, RequestCert
 
@@ -126,12 +127,21 @@ class RequestsTransport:
             # Additional headers, needed for the serializer
             for key, value in additional_headers.items():
                 final_headers.setdefault(key, value)
+
+        p = case.query
+
+        # Replace empty dictionaries with empty strings, so the parameters actually present in the query string
+        if any(value == {} for value in (p or {}).values()):
+            p = fast_deepcopy(p)
+            for k, v in p.items():
+                if v == {}:
+                    p[k] = ""
         data = {
             "method": case.method,
             "url": url,
             "cookies": case.cookies,
             "headers": final_headers,
-            "params": case.query,
+            "params": p,
             **extra,
         }
         if params is not None:

{schemathesis-3.39.12 → schemathesis-3.39.14}/test/coverage/test_phase.py

@@ -1287,7 +1287,7 @@ def test_negative_query_parameter(ctx):
     assert urls == [
         "http://127.0.0.1/foo?q=0&q=0",
         ANY,
-        "http://127.0.0.1/foo",
+        "http://127.0.0.1/foo?q=",
         "http://127.0.0.1/foo?q=null&q=null",
         "http://127.0.0.1/foo?q=null",
         "http://127.0.0.1/foo?q=false",

{schemathesis-3.39.12 → schemathesis-3.39.14}/test/specs/openapi/test_examples.py

@@ -1588,10 +1588,21 @@ def test_find_in_responses_only_in_2xx(ctx):
                     {"itemId": 789},
                     {"item": {"itemId": "42"}},
                     {"item": 55},
+                    {"item": [55]},
+                    {"item": [{"id": "143"}], "paginationInfo": {}},
                 ]
             },
             "itemId",
-            ["123", "789", "456", 789, "42", 55],
+            ["123", "789", "456", 789, "42", 55, "143"],
+        ),
+        (
+            {
+                "ItemResult": [
+                    {"item": [{"id": "143"}, {"id": 55}, [], {}], "paginationInfo": {}},
+                ]
+            },
+            "itemId",
+            ["143", 55],
         ),
         (
             {"Item": [{"id": "123"}, {"id": "456"}]},

{schemathesis-3.39.12 → schemathesis-3.39.14}/test/test_models.py

@@ -625,7 +625,7 @@ def _assert_override(spy, arg, original, overridden):
         assert all(key not in kwargs for key in overridden)
 
 
-@pytest.mark.parametrize("arg", ["headers", "cookies", "params"])
+@pytest.mark.parametrize("arg", ["headers", "cookies"])
 def test_call_overrides(mocker, arg, openapi_30):
     spy = mocker.patch("requests.Session.request", side_effect=ValueError)
     original = {"A": "X", "B": "X"}

schemathesis-3.39.12/docs/service.rst

@@ -1,75 +0,0 @@
-Schemathesis as a Service
-=========================
-
-Schemathesis as a Service on `Schemathesis.io <https://app.schemathesis.io/auth/sign-up/?utm_source=oss_docs&utm_content=saas_docs_top>`_ provides a hosted environment, extending your testing capabilities with additional features accessible in both free and premium plans.
-
-.. note::
-
-    For a step-by-step guide on getting started with Schemathesis.io, visit our `Quick Start Guide <https://docs.schemathesis.io/quick-start/>`_.
-
-Schema Analysis (Experimental)
-------------------------------
-
-Schemathesis CLI now includes an experimental feature that integrates with Schemathesis.io to improve the efficiency and realism of generated test cases for better bug detection. This feature optimizes test case generation by:
-
-- Inferring "format" keywords for appropriate string data generation
-- Providing data generation strategies for uncommon media types (e.g., application/pdf)
-- Inferring data generation strategies for GraphQL scalars
-- Adjusting schemas for faster data generation in Schemathesis
-- Detecting the web server to generate more targeted test data and avoid rejected inputs
-
-By enabling this feature, you can potentially benefit from faster achievement of higher edge case coverage and tests that reach deeper into your API implementation.
-
-To enable schema analysis, use the ``--experimental=schema-analysis`` CLI option. It is also automatically enabled when the ``--report`` CLI option is used.
-
-.. note::
- 
-    During the experimental phase, schema analysis is available free of charge and does not require signup. By using this feature, you automatically agree to Schemathesis.io's `Terms of Service <https://schemathesis.io/legal/terms>`_ and `Privacy Policy`_.
-
-Please note that this feature is still experimental, and its effectiveness may vary depending on the API being tested. We are actively refining the algorithms and techniques used. If you encounter any issues or have suggestions, please open an issue on our GitHub repository or reach out via our support channels.
-
-Uploading Reports to Schemathesis.io
-------------------------------------
-
-When you use the Schemathesis CLI to run tests, you have the option to upload test reports to Schemathesis.io for a more detailed analysis and continuous tracking over time.
-This can be done by using the ``--report`` flag with your CLI commands.
-
-To store a report for later upload, you can first save it using the ``--report=report.tar.gz`` CLI option. Afterward, you can upload it with the ``st upload report.tar.gz`` command.
-
-.. note::
-
-    If the ``--report`` flag is not passed, or if its argument points to a local file, no data is sent to external services. Reports generated locally are fully self-contained and remain on your machine unless you explicitly upload them to Schemathesis.io using the upload command.
-
-    The content of the report includes all HTTP calls made during the test execution, providing transparency into the exact interactions Schemathesis performed.
-
-    This data helps improve the product's quality and usability by identifying edge cases, such as incompatible server behavior, but is only accessible to Schemathesis.io when the report is uploaded.
-
-What Data is Sent?
-------------------
-
-When you choose to upload your test reports, the following data is included in the reports sent to Schemathesis.io by the CLI:
-
-- **Metadata**:
-
-  - Information about your host machine to help us understand our users better.
-  - Collected data includes your Python interpreter version, implementation, system/OS name, the used Docker image name (if any) and release.
-
-- **Test Runs**:
-
-  - Most of the Schemathesis runner's events are included, encompassing all generated data and explicitly passed headers.
-  - Sensitive data within the generated test cases and received responses is automatically sanitized by default, replaced with the string ``[Filtered]`` to prevent accidental exposure.
-  - Further information on what is considered sensitive and how it is sanitized can be found at :ref:`Sanitizing Output <sanitizing-output>`.
-
-- **Environment Variables**:
-
-  - Some environment variables specific to CI providers are included.
-  - These are used to comment on pull requests.
-
-- **Command-Line Options**:
-
-  - Command-line options without free-form values are sent to help us understand how you use the CLI.
-  - Rest assured, any sensitive data passed through command-line options is sanitized by default.
-
-For more details on our data handling practices, please refer to our `Privacy Policy <https://schemathesis.io/legal/privacy>`_. If you have further questions or concerns about data handling, feel free to contact us at `support@schemathesis.io <mailto:support@schemathesis.io>`_.
-
-For information on data access, retention, and deletion, please refer to the `FAQ section <https://docs.schemathesis.io/faq>`_ in our SaaS documentation.