schemathesis 4.0.3__tar.gz → 4.0.4__tar.gz

{schemathesis-4.0.3 → schemathesis-4.0.4}/.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.29.0
+        uses: github/codeql-action/init@v3.29.1
         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.29.0
+        uses: github/codeql-action/autobuild@v3.29.1
 
       # ℹ️ 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.29.0
+        uses: github/codeql-action/analyze@v3.29.1

{schemathesis-4.0.3 → schemathesis-4.0.4}/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Changelog
 
-## [Unreleased](https://github.com/schemathesis/schemathesis/compare/v4.0.3...HEAD) - TBD
+## [Unreleased](https://github.com/schemathesis/schemathesis/compare/v4.0.4...HEAD) - TBD
+
+## [4.0.4](https://github.com/schemathesis/schemathesis/compare/v4.0.3...v4.0.4) - 2025-07-02
+
+### :wrench: Changed
+
+- Show cURL commands on network timeouts.
+
+### :bug: Fixed
+
+- Empty path parameter in the negative tests. [#2912](https://github.com/schemathesis/schemathesis/issues/2912)
+- Generating negative test cases where query parameters do not appear in the resulting URL making them positive. [#2900](https://github.com/schemathesis/schemathesis/issues/2900)
 
 ## [4.0.3](https://github.com/schemathesis/schemathesis/compare/v4.0.2...v4.0.3) - 2025-06-30
 

{schemathesis-4.0.3 → schemathesis-4.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: schemathesis
-Version: 4.0.3
+Version: 4.0.4
 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://github.com/schemathesis/schemathesis/blob/master/CHANGELOG.md

{schemathesis-4.0.3 → schemathesis-4.0.4}/benches/coverage_phase.py

@@ -4,7 +4,10 @@ import pytest
 
 from schemathesis.generation.coverage import CoverageContext, cover_schema_iter
 
-CONTEXTS = [CoverageContext(location="body").with_positive(), CoverageContext(location="body").with_negative()]
+CONTEXTS = [
+    CoverageContext(location="body", is_required=True).with_positive(),
+    CoverageContext(location="body", is_required=True).with_negative(),
+]
 CONTEXT_NAMES = [",".join([m.value for m in ctx.generation_modes]) for ctx in CONTEXTS]
 
 BASIC_TYPES = [

{schemathesis-4.0.3 → schemathesis-4.0.4}/docs/reference/configuration.md

@@ -568,7 +568,7 @@ These settings can only be applied at the project level.
 
 The following settings control how Schemathesis makes network requests to the API under test.
 
-#### `header`
+#### `headers`
 
 !!! note ""
 

{schemathesis-4.0.3 → schemathesis-4.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "schemathesis"
-version = "4.0.3"
+version = "4.0.4"
 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-4.0.3 → schemathesis-4.0.4}/src/schemathesis/engine/errors.py

@@ -421,6 +421,7 @@ def clear_hypothesis_notes(exc: Exception) -> None:
 def is_unrecoverable_network_error(exc: Exception) -> bool:
     from http.client import RemoteDisconnected
 
+    import requests
     from urllib3.exceptions import ProtocolError
 
     def has_connection_reset(inner: BaseException) -> bool:
@@ -433,6 +434,8 @@ def is_unrecoverable_network_error(exc: Exception) -> bool:
 
         return False
 
+    if isinstance(exc, requests.Timeout):
+        return True
     if isinstance(exc.__context__, ProtocolError):
         if len(exc.__context__.args) == 2 and isinstance(exc.__context__.args[1], RemoteDisconnected):
             return True
@@ -442,14 +445,16 @@ def is_unrecoverable_network_error(exc: Exception) -> bool:
     return has_connection_reset(exc)
 
 
-@dataclass()
+@dataclass
 class UnrecoverableNetworkError:
-    error: requests.ConnectionError | ChunkedEncodingError
+    error: requests.ConnectionError | ChunkedEncodingError | requests.Timeout
     code_sample: str
 
     __slots__ = ("error", "code_sample")
 
-    def __init__(self, error: requests.ConnectionError | ChunkedEncodingError, code_sample: str) -> None:
+    def __init__(
+        self, error: requests.ConnectionError | ChunkedEncodingError | requests.Timeout, code_sample: str
+    ) -> None:
         self.error = error
         self.code_sample = code_sample
 

{schemathesis-4.0.3 → schemathesis-4.0.4}/src/schemathesis/engine/phases/stateful/_executor.py

@@ -133,9 +133,9 @@ def execute_state_machine_loop(
                 ctx.step_failed()
                 raise
             except Exception as exc:
-                if isinstance(exc, (requests.ConnectionError, ChunkedEncodingError)) and is_unrecoverable_network_error(
-                    exc
-                ):
+                if isinstance(
+                    exc, (requests.ConnectionError, ChunkedEncodingError, requests.Timeout)
+                ) and is_unrecoverable_network_error(exc):
                     transport_kwargs = engine.get_transport_kwargs(operation=input.case.operation)
                     if exc.request is not None:
                         headers = {key: value[0] for key, value in exc.request.headers.items()}

{schemathesis-4.0.3 → schemathesis-4.0.4}/src/schemathesis/engine/phases/unit/_executor.py

@@ -327,9 +327,9 @@ def cached_test_func(f: Callable) -> Callable:
         except (KeyboardInterrupt, Failure):
             raise
         except Exception as exc:
-            if isinstance(exc, (requests.ConnectionError, ChunkedEncodingError)) and is_unrecoverable_network_error(
-                exc
-            ):
+            if isinstance(
+                exc, (requests.ConnectionError, ChunkedEncodingError, requests.Timeout)
+            ) and is_unrecoverable_network_error(exc):
                 # Server likely has crashed and does not accept any connections at all
                 # Don't report these error - only the original crash should be reported
                 if exc.request is not None:

{schemathesis-4.0.3 → schemathesis-4.0.4}/src/schemathesis/generation/coverage.py

@@ -109,19 +109,22 @@ def cached_draw(strategy: st.SearchStrategy) -> Any:
 class CoverageContext:
     generation_modes: list[GenerationMode]
     location: str
+    is_required: bool
     path: list[str | int]
 
-    __slots__ = ("location", "generation_modes", "path")
+    __slots__ = ("location", "generation_modes", "is_required", "path")
 
     def __init__(
         self,
         *,
         location: str,
         generation_modes: list[GenerationMode] | None = None,
+        is_required: bool,
         path: list[str | int] | None = None,
     ) -> None:
         self.location = location
         self.generation_modes = generation_modes if generation_modes is not None else list(GenerationMode)
+        self.is_required = is_required
         self.path = path or []
 
     @contextmanager
@@ -140,6 +143,7 @@ class CoverageContext:
         return CoverageContext(
             location=self.location,
             generation_modes=[GenerationMode.POSITIVE],
+            is_required=self.is_required,
             path=self.path,
         )
 
@@ -147,6 +151,7 @@ class CoverageContext:
         return CoverageContext(
             location=self.location,
             generation_modes=[GenerationMode.NEGATIVE],
+            is_required=self.is_required,
             path=self.path,
         )
 
@@ -157,6 +162,16 @@ class CoverageContext:
             return not is_invalid_path_parameter(value)
         return True
 
+    def leads_to_negative_test_case(self, value: Any) -> bool:
+        if self.location == "query":
+            # Some values will not be serialized into the query string
+            if isinstance(value, list) and not self.is_required:
+                # Optional parameters should be present
+                return any(item not in [{}, []] for item in value)
+            if isinstance(value, dict) and not self.is_required:
+                return bool(value)
+        return True
+
     def generate_from(self, strategy: st.SearchStrategy) -> Any:
         return cached_draw(strategy)
 
@@ -955,11 +970,13 @@ def _negative_items(ctx: CoverageContext, schema: dict[str, Any] | bool) -> Gene
     """Arrays not matching the schema."""
     nctx = ctx.with_negative()
     for value in cover_schema_iter(nctx, schema):
-        yield NegativeValue(
-            [value.value],
-            description=f"Array with invalid items: {value.description}",
-            location=nctx.current_path,
-        )
+        items = [value.value]
+        if ctx.leads_to_negative_test_case(items):
+            yield NegativeValue(
+                items,
+                description=f"Array with invalid items: {value.description}",
+                location=nctx.current_path,
+            )
 
 
 def _not_matching_pattern(value: str, pattern: re.Pattern) -> bool:
@@ -1027,6 +1044,9 @@ def _negative_format(ctx: CoverageContext, schema: dict, format: str) -> Generat
     # Hypothesis-jsonschema does not canonicalise it properly right now, which leads to unsatisfiable schema
     without_format = {k: v for k, v in schema.items() if k != "format"}
     without_format.setdefault("type", "string")
+    if ctx.location == "path":
+        # Empty path parameters are invalid
+        without_format["minLength"] = 1
     strategy = from_schema(without_format)
     if format in jsonschema.Draft202012Validator.FORMAT_CHECKER.checkers:
         if format == "hostname":
@@ -1060,7 +1080,7 @@ def _negative_type(
         strategies["number"] = FLOAT_STRATEGY.filter(_is_non_integer_float)
     for strategy in strategies.values():
         value = ctx.generate_from(strategy)
-        if seen.insert(value):
+        if seen.insert(value) and ctx.is_valid_for_location(value):
             yield NegativeValue(value, description="Incorrect type", location=ctx.current_path)
 
 

{schemathesis-4.0.3 → schemathesis-4.0.4}/src/schemathesis/generation/hypothesis/builder.py

@@ -474,7 +474,10 @@ def _iter_coverage_cases(
         for value in find_matching_in_responses(responses, parameter.name):
             schema.setdefault("examples", []).append(value)
         gen = coverage.cover_schema_iter(
-            coverage.CoverageContext(location=location, generation_modes=generation_modes), schema
+            coverage.CoverageContext(
+                location=location, generation_modes=generation_modes, is_required=parameter.is_required
+            ),
+            schema,
         )
         value = next(gen, NOT_SET)
         if isinstance(value, NotSet):
@@ -492,7 +495,10 @@ def _iter_coverage_cases(
             if examples:
                 schema.setdefault("examples", []).extend(examples)
             gen = coverage.cover_schema_iter(
-                coverage.CoverageContext(location="body", generation_modes=generation_modes), schema
+                coverage.CoverageContext(
+                    location="body", generation_modes=generation_modes, is_required=body.is_required
+                ),
+                schema,
             )
             value = next(gen, NOT_SET)
             if isinstance(value, NotSet):
@@ -712,11 +718,13 @@ def _iter_coverage_cases(
             }
 
         def _yield_negative(
-            subschema: dict[str, Any], _location: str, _container_name: str
+            subschema: dict[str, Any], _location: str, _container_name: str, is_required: bool
         ) -> Generator[Case, None, None]:
             iterator = iter(
                 coverage.cover_schema_iter(
-                    coverage.CoverageContext(location=_location, generation_modes=[GenerationMode.NEGATIVE]),
+                    coverage.CoverageContext(
+                        location=_location, generation_modes=[GenerationMode.NEGATIVE], is_required=is_required
+                    ),
                     subschema,
                 )
             )
@@ -751,7 +759,7 @@ def _iter_coverage_cases(
                 )
             if GenerationMode.NEGATIVE in generation_modes:
                 subschema = _combination_schema(only_required, required, parameter_set)
-                for case in _yield_negative(subschema, location, container_name):
+                for case in _yield_negative(subschema, location, container_name, is_required=bool(required)):
                     kwargs = _case_to_kwargs(case)
                     if not seen_negative.insert(kwargs):
                         continue
@@ -778,7 +786,7 @@ def _iter_coverage_cases(
                 )
                 if GenerationMode.NEGATIVE in generation_modes:
                     subschema = _combination_schema(combo, required, parameter_set)
-                    for case in _yield_negative(subschema, location, container_name):
+                    for case in _yield_negative(subschema, location, container_name, is_required=bool(required)):
                         assert case.meta is not None
                         assert isinstance(case.meta.phase.data, CoveragePhaseData)
                         # Already generated in one of the blocks above

{schemathesis-4.0.3 → schemathesis-4.0.4}/test/cli/__snapshots__/test_commands/test_connection_timeout[Open API 2.0-1].raw

@@ -26,6 +26,10 @@ Network Error
 
 Read timed out after 0.08 seconds
 
+Reproduce with:
+
+    curl -X GET http://127.0.0.1/api/slow
+
 Need more help?
     Join our Discord server: https://discord.gg/R9ASRAmHnA
 =================================== SUMMARY ====================================

{schemathesis-4.0.3 → schemathesis-4.0.4}/test/cli/__snapshots__/test_commands/test_connection_timeout[Open API 2.0-2].raw

@@ -26,6 +26,10 @@ Network Error
 
 Read timed out after 0.08 seconds
 
+Reproduce with:
+
+    curl -X GET http://127.0.0.1/api/slow
+
 Need more help?
     Join our Discord server: https://discord.gg/R9ASRAmHnA
 =================================== SUMMARY ====================================

{schemathesis-4.0.3 → schemathesis-4.0.4}/test/cli/__snapshots__/test_commands/test_connection_timeout[Open API 3.0-1].raw

@@ -26,6 +26,10 @@ Network Error
 
 Read timed out after 0.08 seconds
 
+Reproduce with:
+
+    curl -X GET http://127.0.0.1/api/slow
+
 Need more help?
     Join our Discord server: https://discord.gg/R9ASRAmHnA
 =================================== SUMMARY ====================================

{schemathesis-4.0.3 → schemathesis-4.0.4}/test/cli/__snapshots__/test_commands/test_connection_timeout[Open API 3.0-2].raw

@@ -26,6 +26,10 @@ Network Error
 
 Read timed out after 0.08 seconds
 
+Reproduce with:
+
+    curl -X GET http://127.0.0.1/api/slow
+
 Need more help?
     Join our Discord server: https://discord.gg/R9ASRAmHnA
 =================================== SUMMARY ====================================

{schemathesis-4.0.3 → schemathesis-4.0.4}/test/config/test_doc_examples.py

@@ -4,17 +4,24 @@ from pathlib import Path
 import pytest
 import yaml
 
+from schemathesis.checks import CHECKS
 from schemathesis.config import SchemathesisConfig
+from schemathesis.config._validator import CONFIG_SCHEMA
 from schemathesis.core.errors import HookError
+from schemathesis.core.transforms import resolve_pointer
 
 ROOT_DIR = Path(__file__).parent.parent.parent
 DOCS_DIR = ROOT_DIR / "docs"
 README_FILE = ROOT_DIR / "README.md"
 
 
-def extract_examples(path: str, format: str = "toml") -> list:
+def read_doc(path: str) -> str:
     with open(DOCS_DIR / path, encoding="utf-8") as fd:
-        markdown = fd.read()
+        return fd.read()
+
+
+def extract_examples(path: str, format: str = "toml") -> list:
+    markdown = read_doc(path)
     pattern = re.compile(rf"```{format}(.*?)```", re.DOTALL)
     return pattern.findall(markdown)
 
@@ -74,3 +81,48 @@ def test_yaml_snippets_are_valid(filename: str, snippet: str):
         yaml.safe_load(snippet)
     except yaml.YAMLError as exc:
         pytest.fail(f"Invalid YAML in {filename}:\n{exc}")
+
+
+def _resolve(current):
+    if "$ref" in current:
+        return resolve_pointer(CONFIG_SCHEMA, current["$ref"][1:])
+    return current
+
+
+def _search_rest(current, variant, title, segment):
+    data = _resolve(current["properties"][variant])
+    rest = title.split(segment, 1)[1].strip(".")
+    for rest_segment in rest.split("."):
+        data = data["properties"][rest_segment]
+
+
+def test_titles_are_valid():
+    markdown = read_doc("reference/configuration.md")
+    for title in re.findall(r"^####\s+`?([^`\n]+)`?", markdown, re.MULTILINE):
+        current = CONFIG_SCHEMA
+        for segment in title.split("."):
+            current = _resolve(current)
+            if segment.startswith("<"):
+                # Like `<format>`
+                name = segment.strip("<>")
+                if name == "format":
+                    variants = ["junit", "har", "vcr"]
+                elif name == "phase":
+                    variants = ["examples", "fuzzing", "coverage", "stateful"]
+                elif name == "check":
+                    if "expected-statuses" in title:
+                        variants = [
+                            name
+                            for name in CHECKS.get_all_names()
+                            if current["properties"][name]["$ref"] == "#/$defs/CheckConfig"
+                        ]
+                    else:
+                        variants = CHECKS.get_all_names()
+                else:
+                    raise ValueError(f"Unknown segment: {name}")
+
+                for variant in variants:
+                    _search_rest(current, variant, title, segment)
+                break
+            else:
+                current = current["properties"][segment]

{schemathesis-4.0.3 → schemathesis-4.0.4}/test/coverage/test_combinations.py

@@ -65,17 +65,17 @@ def assert_not_conform(values: list, schema: dict):
 
 @pytest.fixture
 def ctx():
-    return CoverageContext(location="query")
+    return CoverageContext(location="query", is_required=True)
 
 
 @pytest.fixture
 def pctx():
-    return CoverageContext(location="query", generation_modes=[GenerationMode.POSITIVE])
+    return CoverageContext(location="query", generation_modes=[GenerationMode.POSITIVE], is_required=True)
 
 
 @pytest.fixture
 def nctx():
-    return CoverageContext(location="query", generation_modes=[GenerationMode.NEGATIVE])
+    return CoverageContext(location="query", generation_modes=[GenerationMode.NEGATIVE], is_required=True)
 
 
 @pytest.mark.parametrize(

{schemathesis-4.0.3 → schemathesis-4.0.4}/test/coverage/test_phase.py

@@ -703,9 +703,6 @@ def test_mixed_type_keyword(ctx):
             {
                 "query": {"key": [ANY]},
             },
-            {
-                "query": {"key": [{}]},
-            },
             {
                 "query": {"key": [["null", "null"]]},
             },
@@ -1646,7 +1643,120 @@ def test_query_parameters_dont_exceed_max_length(ctx):
     )
 
 
-def test_negative_query_parameter(ctx):
+def foo_id(value):
+    return {
+        "path_parameters": {
+            "foo_id": value,
+        },
+    }
+
+
+@pytest.mark.parametrize(
+    ["schema", "expected"],
+    [
+        (
+            {
+                "type": "integer",
+            },
+            [
+                foo_id({}),
+                foo_id("null,null"),
+                foo_id("null"),
+                foo_id("false"),
+            ],
+        ),
+        (
+            {"type": "string", "format": "date-time"},
+            [
+                foo_id("0"),
+                foo_id({}),
+                foo_id("null,null"),
+                foo_id("null"),
+                foo_id("false"),
+            ],
+        ),
+    ],
+)
+def test_path_parameters_always_present(ctx, schema, expected):
+    schema = ctx.openapi.build_schema(
+        {
+            "/foo/{foo_id}": {
+                "post": {
+                    "parameters": [
+                        {
+                            "name": "foo_id",
+                            "in": "path",
+                            "required": True,
+                            "schema": schema,
+                        },
+                    ],
+                    "responses": {"default": {"description": "OK"}},
+                }
+            },
+        }
+    )
+    assert_coverage(
+        schema,
+        [GenerationMode.NEGATIVE],
+        expected,
+        ("/foo/{foo_id}", "post"),
+    )
+
+
+@pytest.mark.parametrize(
+    ["schema", "required", "expected"],
+    [
+        [
+            {
+                "type": "string",
+                "enum": ["foo", "bar", "spam"],
+                "example": "spam",
+            },
+            False,
+            [
+                "http://127.0.0.1/foo?q=0&q=0",
+                ANY,
+                "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",
+            ],
+        ],
+        [
+            {"type": "array", "items": {"type": "string"}},
+            False,
+            [
+                "http://127.0.0.1/foo?q=0&q=0",
+                "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",
+                "http://127.0.0.1/foo?q=0",
+                "http://127.0.0.1/foo?q=",
+                "http://127.0.0.1/foo?q=",
+                "http://127.0.0.1/foo?q=null",
+                "http://127.0.0.1/foo?q=false",
+            ],
+        ],
+        [
+            {"type": "array", "items": {"type": "string"}},
+            True,
+            [
+                "http://127.0.0.1/foo",
+                "http://127.0.0.1/foo?q=0&q=0",
+                "http://127.0.0.1/foo",
+                "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",
+                "http://127.0.0.1/foo?q=0",
+                "http://127.0.0.1/foo?q=",
+                "http://127.0.0.1/foo?q=",
+                "http://127.0.0.1/foo?q=null",
+                "http://127.0.0.1/foo?q=false",
+            ],
+        ],
+    ],
+)
+def test_negative_query_parameter(ctx, schema, expected, required):
     schema = ctx.openapi.build_schema(
         {
             "/foo": {
@@ -1655,11 +1765,8 @@ def test_negative_query_parameter(ctx):
                         {
                             "name": "q",
                             "in": "query",
-                            "schema": {
-                                "type": "string",
-                                "enum": ["foo", "bar", "spam"],
-                                "example": "spam",
-                            },
+                            "required": required,
+                            "schema": schema,
                         }
                     ],
                     "responses": {"200": {"description": "OK"}},
@@ -1680,6 +1787,10 @@ def test_negative_query_parameter(ctx):
             return
         kwargs = case.as_transport_kwargs(base_url="http://127.0.0.1")
         request = Request(**kwargs).prepare()
+        if not required:
+            # We generate negative data - optional parameters should appear in the URL, but should be incorrect
+            # Having it absent makes the case positive
+            assert "?q=" in request.url
         urls.append(request.url)
 
     config = ProjectConfig()
@@ -1697,14 +1808,7 @@ def test_negative_query_parameter(ctx):
 
     test_func()
 
-    assert urls == [
-        "http://127.0.0.1/foo?q=0&q=0",
-        ANY,
-        "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",
-    ]
+    assert urls == expected
 
 
 def test_negative_data_rejection(ctx, cli, openapi3_base_url, snapshot_cli):