schemathesis 3.38.1__tar.gz → 3.38.3__tar.gz

{schemathesis-3.38.1 → schemathesis-3.38.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: schemathesis
-Version: 3.38.1
+Version: 3.38.3
 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

{schemathesis-3.38.1 → schemathesis-3.38.3}/docs/changelog.rst

@@ -1,9 +1,28 @@
 Changelog
 =========
 
-:version:`Unreleased <v3.38.1...HEAD>` - TBD
+:version:`Unreleased <v3.38.3...HEAD>` - TBD
 --------------------------------------------
 
+.. _v3.38.3:
+
+:version:`3.38.3 <v3.38.2...v3.38.3>` - 2024-10-26
+--------------------------------------------------
+
+**Changed**
+
+- Generate more negative combinations during the coverage phase.
+- Ensure text description is always present for test cases in the coverage phase.
+
+.. _v3.38.2:
+
+:version:`3.38.2 <v3.38.1...v3.38.2>` - 2024-10-22
+--------------------------------------------------
+
+**Fixed**
+
+- Internal error on generating missed required path parameter during the coverage phase.
+
 .. _v3.38.1:
 
 :version:`3.38.1 <v3.38.0...v3.38.1>` - 2024-10-21

{schemathesis-3.38.1 → schemathesis-3.38.3}/example/requirements-app.txt

@@ -28,5 +28,5 @@ sqlalchemy==1.4.50
     # via
     #   -r requirements-app.in
     #   flask-sqlalchemy
-werkzeug==3.0.3
+werkzeug==3.0.6
     # via flask

{schemathesis-3.38.1 → schemathesis-3.38.3}/example/requirements-pytest.txt

@@ -114,7 +114,7 @@ typing-extensions==4.8.0
     # via schemathesis
 urllib3==2.2.2
     # via requests
-werkzeug==3.0.3
+werkzeug==3.0.6
     # via schemathesis
 yarl==1.9.3
     # via schemathesis

{schemathesis-3.38.1 → schemathesis-3.38.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "schemathesis"
-version = "3.38.1"
+version = "3.38.3"
 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.38.1 → schemathesis-3.38.3}/src/schemathesis/_hypothesis.py

@@ -5,8 +5,8 @@ from __future__ import annotations
 import asyncio
 import json
 import warnings
-from copy import copy
 from functools import wraps
+from itertools import combinations
 from typing import TYPE_CHECKING, Any, Callable, Generator, Mapping
 
 import hypothesis
@@ -223,18 +223,6 @@ def _iter_coverage_cases(
     from .specs.openapi.constants import LOCATION_TO_CONTAINER
     from .specs.openapi.examples import find_in_responses, find_matching_in_responses
 
-    meta = GenerationMetadata(
-        query=None,
-        path_parameters=None,
-        headers=None,
-        cookies=None,
-        body=None,
-        phase=TestPhase.COVERAGE,
-        description=None,
-        location=None,
-        parameter=None,
-        parameter_location=None,
-    )
     generators: dict[tuple[str, str], Generator[coverage.GeneratedValue, None, None]] = {}
     template: dict[str, Any] = {}
     responses = find_in_responses(operation)
@@ -275,25 +263,27 @@ def _iter_coverage_cases(
                 template["media_type"] = body.media_type
             case = operation.make_case(**{**template, "body": value.value, "media_type": body.media_type})
             case.data_generation_method = value.data_generation_method
-            case.meta = copy(meta)
-            case.meta.description = value.description
-            case.meta.location = value.location
-            case.meta.parameter = body.media_type
-            case.meta.parameter_location = "body"
+            case.meta = _make_meta(
+                description=value.description,
+                location=value.location,
+                parameter=body.media_type,
+                parameter_location="body",
+            )
             yield case
             for next_value in gen:
                 case = operation.make_case(**{**template, "body": next_value.value, "media_type": body.media_type})
                 case.data_generation_method = next_value.data_generation_method
-                case.meta = copy(meta)
-                case.meta.description = next_value.description
-                case.meta.location = next_value.location
-                case.meta.parameter = body.media_type
-                case.meta.parameter_location = "body"
+                case.meta = _make_meta(
+                    description=next_value.description,
+                    location=next_value.location,
+                    parameter=body.media_type,
+                    parameter_location="body",
+                )
                 yield case
     elif DataGenerationMethod.positive in data_generation_methods:
         case = operation.make_case(**template)
         case.data_generation_method = DataGenerationMethod.positive
-        case.meta = copy(meta)
+        case.meta = _make_meta(description="Default positive test case")
         yield case
     for (location, name), gen in generators.items():
         container_name = LOCATION_TO_CONTAINER[location]
@@ -305,16 +295,17 @@ def _iter_coverage_cases(
                 generated = value.value
             case = operation.make_case(**{**template, container_name: {**container, name: generated}})
             case.data_generation_method = value.data_generation_method
-            case.meta = copy(meta)
-            case.meta.description = value.description
-            case.meta.location = value.location
-            case.meta.parameter = name
-            case.meta.parameter_location = location
+            case.meta = _make_meta(
+                description=value.description,
+                location=value.location,
+                parameter=name,
+                parameter_location=location,
+            )
             yield case
     # Generate missing required parameters
     if DataGenerationMethod.negative in data_generation_methods:
         for parameter in operation.iter_parameters():
-            if parameter.is_required:
+            if parameter.is_required and parameter.location != "path":
                 name = parameter.name
                 location = parameter.location
                 container_name = LOCATION_TO_CONTAINER[location]
@@ -323,12 +314,87 @@ def _iter_coverage_cases(
                     **{**template, container_name: {k: v for k, v in container.items() if k != name}}
                 )
                 case.data_generation_method = DataGenerationMethod.negative
-                case.meta = copy(meta)
-                case.meta.description = f"Missing `{name}` at {location}"
-                case.meta.location = parameter.location
-                case.meta.parameter = name
-                case.meta.parameter_location = location
+                case.meta = _make_meta(
+                    description=f"Missing `{name}` at {location}",
+                    location=parameter.location,
+                    parameter=name,
+                    parameter_location=location,
+                )
                 yield case
+    # Generate combinations for each location
+    for location, parameter_set in [
+        ("query", operation.query),
+        ("header", operation.headers),
+        ("cookie", operation.cookies),
+    ]:
+        if not parameter_set:
+            continue
+
+        container_name = LOCATION_TO_CONTAINER[location]
+        base_container = template.get(container_name, {})
+
+        # Get required and optional parameters
+        required = {p.name for p in parameter_set if p.is_required}
+        all_params = {p.name for p in parameter_set}
+        optional = sorted(all_params - required)
+
+        # Helper function to create and yield a case
+        def make_case(container_values: dict, description: str, _location: str, _container_name: str) -> Case:
+            if _location in ("header", "cookie"):
+                container = {
+                    name: json.dumps(val) if not isinstance(val, str) else val for name, val in container_values.items()
+                }
+            else:
+                container = container_values
+
+            case = operation.make_case(**{**template, _container_name: container})
+            case.data_generation_method = DataGenerationMethod.positive
+            case.meta = _make_meta(
+                description=description,
+                location=_location,
+                parameter_location=_location,
+            )
+            return case
+
+        # 1. Generate only required properties
+        if required and all_params != required:
+            only_required = {k: v for k, v in base_container.items() if k in required}
+            yield make_case(only_required, "Only required properties", location, container_name)
+
+        # 2. Generate combinations with required properties and one optional property
+        for opt_param in optional:
+            combo = {k: v for k, v in base_container.items() if k in required or k == opt_param}
+            if combo != base_container:
+                yield make_case(combo, f"All required properties and optional '{opt_param}'", location, container_name)
+
+        # 3. Generate one combination for each size from 2 to N-1 of optional parameters
+        if len(optional) > 1:
+            for size in range(2, len(optional)):
+                for combination in combinations(optional, size):
+                    combo = {k: v for k, v in base_container.items() if k in required or k in combination}
+                    if combo != base_container:
+                        yield make_case(combo, f"All required and {size} optional properties", location, container_name)
+
+
+def _make_meta(
+    *,
+    description: str,
+    location: str | None = None,
+    parameter: str | None = None,
+    parameter_location: str | None = None,
+) -> GenerationMetadata:
+    return GenerationMetadata(
+        query=None,
+        path_parameters=None,
+        headers=None,
+        cookies=None,
+        body=None,
+        phase=TestPhase.COVERAGE,
+        description=description,
+        location=location,
+        parameter=parameter,
+        parameter_location=parameter_location,
+    )
 
 
 def find_invalid_headers(headers: Mapping) -> Generator[tuple[str, str], None, None]:

{schemathesis-3.38.1 → schemathesis-3.38.3}/src/schemathesis/schemas.py

@@ -49,6 +49,7 @@ from .utils import PARAMETRIZE_MARKER, GivenInput, given_proxy
 if TYPE_CHECKING:
     import hypothesis
     from hypothesis.strategies import SearchStrategy
+    from hypothesis.vendor.pretty import RepresentationPrinter
     from pyrate_limiter import Limiter
 
     from .stateful import Stateful, StatefulTest
@@ -102,6 +103,9 @@ class BaseSchema(Mapping):
     def __post_init__(self) -> None:
         self.hook = to_filterable_hook(self.hooks)  # type: ignore[method-assign]
 
+    def _repr_pretty_(self, printer: RepresentationPrinter, cycle: bool) -> None:
+        return None
+
     def include(
         self,
         func: MatcherFunc | None = None,

{schemathesis-3.38.1 → schemathesis-3.38.3}/test/__snapshots__/test_recoverable_errors/test_in_cli[2].raw

@@ -2,7 +2,7 @@ Exit code: 1
 ---
 Stdout:
 ======================= Schemathesis test session starts =======================
-Schema location: file:///tmp/schema.yaml
+Schema location: file:///tmp/schema.json
 Base URL: file:///
 Specification version: Open API 3.0.2
 Random seed: 42

{schemathesis-3.38.1 → schemathesis-3.38.3}/test/apps/__init__.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-import logging
-
 import click
 from aiohttp import web
 

{schemathesis-3.38.1 → schemathesis-3.38.3}/test/auth/test_cli.py

@@ -22,10 +22,10 @@ class TokenAuth:
 
 @pytest.mark.openapi_version("3.0")
 @pytest.mark.operations("success")
-def test_custom_auth(testdir, cli, schema_url, app, snapshot_cli):
+def test_custom_auth(ctx, cli, schema_url, app, snapshot_cli):
     # When a custom auth is used
-    module = testdir.make_importable_pyfile(
-        hook=f"""
+    module = ctx.write_pymodule(
+        f"""
 {AUTH_PROVIDER_MODULE_CODE}
 @schemathesis.hook
 def after_call(context, case, response):
@@ -38,7 +38,7 @@ def after_call(context, case, response):
     )
     # Then CLI should run successfully
     # And the auth should be used
-    assert cli.main("run", schema_url, hooks=module.purebasename) == snapshot_cli
+    assert cli.main("run", schema_url, hooks=module) == snapshot_cli
 
 
 @pytest.mark.parametrize(
@@ -50,10 +50,10 @@ def after_call(context, case, response):
 )
 @pytest.mark.openapi_version("3.0")
 @pytest.mark.operations("success")
-def test_explicit_auth_precedence(testdir, cli, schema_url, args, expected, snapshot_cli):
+def test_explicit_auth_precedence(ctx, cli, schema_url, args, expected, snapshot_cli):
     # If explicit auth is passed via CLI
-    module = testdir.make_importable_pyfile(
-        hook=f"""
+    module = ctx.write_pymodule(
+        f"""
 {AUTH_PROVIDER_MODULE_CODE}
 @schemathesis.hook
 def after_call(context, case, response):
@@ -65,7 +65,7 @@ def after_call(context, case, response):
     )
     # Then it overrides the one from the auth provider
     # And the auth should be used
-    assert cli.main("run", schema_url, "--show-trace", *args, hooks=module.purebasename) == snapshot_cli
+    assert cli.main("run", schema_url, "--show-trace", *args, hooks=module) == snapshot_cli
 
 
 def test_multiple_auth_mechanisms_with_explicit_auth(ctx, cli, snapshot_cli):
@@ -103,10 +103,9 @@ def test_multiple_auth_mechanisms_with_explicit_auth(ctx, cli, snapshot_cli):
 
 @pytest.mark.openapi_version("3.0")
 @pytest.mark.operations("success", "custom_format")
-def test_multiple_threads(testdir, cli, schema_url, snapshot_cli):
-    module = testdir.make_importable_pyfile(
-        hook=f"""
-    import schemathesis
+def test_multiple_threads(ctx, cli, schema_url, snapshot_cli):
+    module = ctx.write_pymodule(
+        f"""
     import time
 
     TOKEN = "{TOKEN}"
@@ -140,7 +139,7 @@ def test_multiple_threads(testdir, cli, schema_url, snapshot_cli):
             "2",
             "--hypothesis-max-examples=1",
             "--show-trace",
-            hooks=module.purebasename,
+            hooks=module,
         )
         == snapshot_cli
     )
@@ -148,13 +147,11 @@ def test_multiple_threads(testdir, cli, schema_url, snapshot_cli):
 
 @pytest.mark.openapi_version("3.0")
 @pytest.mark.operations("success", "text")
-def test_requests_auth(testdir, cli, schema_url, snapshot_cli):
+def test_requests_auth(ctx, cli, schema_url, snapshot_cli):
     # When the user registers auth from `requests`
     expected = "Basic dXNlcjpwYXNz"
-    module = testdir.make_importable_pyfile(
-        hook=f"""
-import schemathesis
-
+    module = ctx.write_pymodule(
+        f"""
 from requests.auth import HTTPBasicAuth
 
 schemathesis.auth.set_from_requests(HTTPBasicAuth("user", "pass")).apply_to(method="GET", path="/success")
@@ -174,12 +171,12 @@ def after_call(context, case, response):
     )
     # Then CLI should run successfully
     # And the auth should be used
-    assert cli.main("run", schema_url, hooks=module.purebasename) == snapshot_cli
+    assert cli.main("run", schema_url, hooks=module) == snapshot_cli
 
 
 @pytest.mark.openapi_version("3.0")
 @pytest.mark.operations("success", "text")
-def test_conditional(testdir, cli, schema_url, snapshot_cli):
+def test_conditional(ctx, cli, schema_url, snapshot_cli):
     # When the user sets up multiple auths applied to different API operations
     if sys.version_info < (3, 9):
         dec1 = """
@@ -191,10 +188,8 @@ auth = schemathesis.auth()
     else:
         dec1 = '@schemathesis.auth().apply_to(method="GET", path="/text")'
         dec2 = '@schemathesis.auth().apply_to(method="GET", path="/success")'
-    module = testdir.make_importable_pyfile(
-        hook=f"""
-import schemathesis
-
+    module = ctx.write_pymodule(
+        f"""
 TOKEN_1 = "ABC"
 
 {dec1}
@@ -228,4 +223,4 @@ def verify_auth(ctx, response, case):
 """
     )
     # Then all auths should be properly applied
-    assert cli.main("run", schema_url, "-c", "verify_auth", hooks=module.purebasename) == snapshot_cli
+    assert cli.main("run", schema_url, "-c", "verify_auth", hooks=module) == snapshot_cli

{schemathesis-3.38.1 → schemathesis-3.38.3}/test/checks/test_checks.py

@@ -23,16 +23,14 @@ def test_wrap_check_old_style():
 
 
 def test_wrap_check_invalid():
-    def invalid_check(arg1):
-        return True
+    def invalid_check(arg1): ...
 
     with pytest.raises(ValueError, match="Invalid check function signature"):
         wrap_check(invalid_check)
 
 
 def test_wrap_check_too_many_args():
-    def too_many_args(arg1, arg2, arg3, arg4):
-        return True
+    def too_many_args(arg1, arg2, arg3, arg4): ...
 
     with pytest.raises(ValueError, match="Invalid check function signature"):
         wrap_check(too_many_args)

{schemathesis-3.38.1 → schemathesis-3.38.3}/test/cli/__snapshots__/test_commands/test_explicit_example_failure_output.raw

@@ -2,9 +2,9 @@ Exit code: 1
 ---
 Stdout:
 ======================= Schemathesis test session starts =======================
-Schema location: file:///tmp/schema.yaml
+Schema location: file:///tmp/schema.json
 Base URL: http://127.0.0.1/api
-Specification version: Open API 3.0.0
+Specification version: Open API 3.0.2
 Random seed: 42
 Workers: 1
 Collected API operations: 1

{schemathesis-3.38.1 → schemathesis-3.38.3}/test/cli/__snapshots__/test_commands/test_get_request_with_body[Open API 2.0].raw

@@ -2,7 +2,7 @@ Exit code: 1
 ---
 Stdout:
 ======================= Schemathesis test session starts =======================
-Schema location: file:///tmp/schema.yaml
+Schema location: file:///tmp/schema.json
 Base URL: http://127.0.0.1/api
 Specification version: Open API 3.0.2
 Random seed: 42

{schemathesis-3.38.1 → schemathesis-3.38.3}/test/cli/__snapshots__/test_commands/test_get_request_with_body[Open API 3.0].raw

@@ -2,7 +2,7 @@ Exit code: 1
 ---
 Stdout:
 ======================= Schemathesis test session starts =======================
-Schema location: file:///tmp/schema.yaml
+Schema location: file:///tmp/schema.json
 Base URL: http://127.0.0.1/api
 Specification version: Open API 3.0.2
 Random seed: 42

{schemathesis-3.38.1 → schemathesis-3.38.3}/test/cli/__snapshots__/test_commands/test_hooks_with_inner_import_error.raw

@@ -3,10 +3,10 @@ Exit code: 1
 Stdout:
 Unable to load Schemathesis extension hooks
 
-An error occurred while importing the module 'hook'. Traceback:
+An error occurred while importing the module 'module'. Traceback:
 
 Traceback (most recent call last):
-  File "/tmp/hook.py", line XXX, in <module>
+  File "/tmp/module.py", line XXX, in <module>
     import something_else
 ModuleNotFoundError: No module named 'something_else'
 

schemathesis-3.38.1/test/__snapshots__/test_recoverable_errors/test_in_cli[1].raw → schemathesis-3.38.3/test/cli/__snapshots__/test_commands/test_unresolvable_reference_with_disabled_validation.raw

@@ -2,7 +2,7 @@ Exit code: 1
 ---
 Stdout:
 ======================= Schemathesis test session starts =======================
-Schema location: file:///tmp/schema.yaml
+Schema location: file:///tmp/schema.json
 Base URL: file:///
 Specification version: Open API 3.0.2
 Random seed: 42

{schemathesis-3.38.1 → schemathesis-3.38.3}/test/cli/__snapshots__/test_commands/test_unsupported_regex.raw

@@ -2,7 +2,7 @@ Exit code: 1
 ---
 Stdout:
 ======================= Schemathesis test session starts =======================
-Schema location: file:///tmp/schema.yaml
+Schema location: file:///tmp/schema.json
 Base URL: file:///
 Specification version: Open API 3.0.2
 Random seed: 42
@@ -12,8 +12,8 @@ Collected API links: 0
 API probing: SKIP
 Schema analysis: SKIP
 
-POST /bar .                                                               [ 50%]
-POST /foo E                                                               [100%]
+POST /foo E                                                               [ 50%]
+POST /bar .                                                               [100%]
 
 ==================================== ERRORS ====================================
 __________________________________ POST /foo ___________________________________

{schemathesis-3.38.1 → schemathesis-3.38.3}/test/cli/__snapshots__/test_commands/test_useful_traceback[Open API 3.0].raw

@@ -27,7 +27,7 @@ division by zero
         run_checks(
       File "/package-root/runner/impl/core.py", line XXX, in run_checks
         skip_check = check(ctx, response, copied_case)
-      File "/tmp/hook.py", line XXX, in with_error
+      File "/tmp/module.py", line XXX, in with_error
         1 / 0
     ZeroDivisionError: division by zero
 

{schemathesis-3.38.1 → schemathesis-3.38.3}/test/cli/output/test_default.py

@@ -71,7 +71,7 @@ def results_set(operation):
 
 
 @pytest.fixture
-def after_execution(results_set, operation, swagger_20):
+def after_execution(results_set, operation):
     return runner.events.AfterExecution.from_result(
         result=results_set.results[0],
         status=models.Status.success,
@@ -88,13 +88,13 @@ def test_get_terminal_width():
 
 
 @pytest.mark.parametrize(
-    ("title", "separator", "printed", "expected"),
+    ("title", "separator", "expected"),
     [
-        ("TEST", "-", "data in section", "------- TEST -------"),
-        ("TEST", "*", "data in section", "******* TEST *******"),
+        ("TEST", "-", "------- TEST -------"),
+        ("TEST", "*", "******* TEST *******"),
     ],
 )
-def test_display_section_name(capsys, title, separator, printed, expected):
+def test_display_section_name(capsys, title, separator, expected):
     # When section name is displayed
     default.display_section_name(title, separator=separator)
     out = capsys.readouterr().out.strip()
@@ -107,7 +107,7 @@ def test_display_section_name(capsys, title, separator, printed, expected):
 
 
 @pytest.mark.parametrize("verbosity", [0, 1])
-def test_handle_initialized(capsys, mocker, execution_context, results_set, swagger_20, verbosity):
+def test_handle_initialized(capsys, mocker, execution_context, swagger_20, verbosity):
     execution_context.verbosity = verbosity
     # Given Initialized event
     event = runner.events.Initialized.from_schema(schema=swagger_20, seed=42)
@@ -130,7 +130,7 @@ def test_handle_initialized(capsys, mocker, execution_context, results_set, swag
     assert out.endswith("\n")
 
 
-def test_display_statistic(capsys, swagger_20, execution_context, operation, response):
+def test_display_statistic(capsys, execution_context, operation, response):
     # Given multiple successful & failed checks in a single test
     success = models.Check(
         "not_a_server_error", models.Status.success, response, 0, models.Case(operation, generation_time=0.0)
@@ -169,7 +169,7 @@ def test_display_statistic(capsys, swagger_20, execution_context, operation, res
     ]
 
 
-def test_display_multiple_warnings(capsys, swagger_20, execution_context, operation, response):
+def test_display_multiple_warnings(capsys, execution_context):
     results = models.TestResultSet(seed=42, results=[])
     results.add_warning("Foo")
     results.add_warning("Bar")
@@ -220,7 +220,7 @@ def test_get_percentage(position, length, expected):
 @pytest.mark.parametrize("current_line_length", [0, 20])
 @pytest.mark.parametrize(("operations_processed", "percentage"), [(0, "[  0%]"), (1, "[100%]")])
 def test_display_percentage(
-    capsys, execution_context, after_execution, swagger_20, current_line_length, operations_processed, percentage
+    capsys, execution_context, after_execution, current_line_length, operations_processed, percentage
 ):
     execution_context.current_line_length = current_line_length
     execution_context.operations_processed = operations_processed
@@ -245,7 +245,7 @@ def test_display_hypothesis_output(capsys):
 
 
 @pytest.mark.parametrize("body", [{}, {"foo": "bar"}, NOT_SET])
-def test_display_single_failure(capsys, swagger_20, execution_context, operation, body, response):
+def test_display_single_failure(capsys, execution_context, operation, body, response):
     # Given a single test result with multiple successful & failed checks
     media_type = "application/json" if body is not NOT_SET else None
     success = models.Check(
@@ -341,7 +341,7 @@ def test_display_internal_error(capsys, execution_context, show_errors_traceback
         assert "ZeroDivisionError: division by zero" in out
 
 
-def test_display_summary(capsys, results_set, swagger_20):
+def test_display_summary(capsys, results_set):
     # Given the Finished event
     event = runner.events.Finished.from_results(results=results_set, running_time=1.257)
     # When `display_summary` is called