schemathesis 3.38.0__tar.gz → 3.38.2__tar.gz

{schemathesis-3.38.0 → schemathesis-3.38.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: schemathesis
-Version: 3.38.0
+Version: 3.38.2
 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.0 → schemathesis-3.38.2}/docs/changelog.rst

@@ -1,9 +1,32 @@
 Changelog
 =========
 
-:version:`Unreleased <v3.38.0...HEAD>` - TBD
+:version:`Unreleased <v3.38.2...HEAD>` - TBD
 --------------------------------------------
 
+.. _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
+--------------------------------------------------
+
+**Added**
+
+- Generating test cases with missing required parameters during the coverage phase.
+- Store information about what parameter is mutated during the coverage phase.
+
+**Changed**
+
+- Adjust the ``negative_data_rejection`` config to include fewer 4XX status codes (400, 401, 403, 404, 422).
+
 .. _v3.38.0:
 
 :version:`3.38.0 <v3.37.1...v3.38.0>` - 2024-10-21

{schemathesis-3.38.0 → schemathesis-3.38.2}/docs/experimental.rst

@@ -187,6 +187,31 @@ Configure status codes:
 
 For more details, join the `GitHub Discussion #2499 <https://github.com/schemathesis/schemathesis/discussions/2499>`_.
 
+Negative Data Rejection
+~~~~~~~~~~~~~~~~~~~~~~~
+
+This feature covers configuring the ``negative_data_rejection`` check and allows for defining what status codes won't trigger this check.
+
+**Allowed status codes**: 400, 401, 403, 404, 422, 5XX
+
+In CLI
+~~~~~~
+
+Configuration options:
+
+.. code-block:: bash
+
+   --experimental-negative-data-rejection-allowed-statuses=4XX
+
+Using Environment Variables
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Configure status codes:
+
+.. code-block:: bash
+
+    export SCHEMATHESIS_EXPERIMENTAL_NEGATIVE_DATA_REJECTION_ALLOWED_STATUSES=4XX
+
 .. _stateful-test-runner:
 
 New Stateful Test Runner

{schemathesis-3.38.0 → schemathesis-3.38.2}/pyproject.toml

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

@@ -232,6 +232,8 @@ def _iter_coverage_cases(
         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] = {}
@@ -276,6 +278,8 @@ def _iter_coverage_cases(
             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"
             yield case
             for next_value in gen:
                 case = operation.make_case(**{**template, "body": next_value.value, "media_type": body.media_type})
@@ -283,6 +287,8 @@ def _iter_coverage_cases(
                 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"
                 yield case
     elif DataGenerationMethod.positive in data_generation_methods:
         case = operation.make_case(**template)
@@ -302,7 +308,27 @@ def _iter_coverage_cases(
             case.meta = copy(meta)
             case.meta.description = value.description
             case.meta.location = value.location
+            case.meta.parameter = name
+            case.meta.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 and parameter.location != "path":
+                name = parameter.name
+                location = parameter.location
+                container_name = LOCATION_TO_CONTAINER[location]
+                container = template[container_name]
+                case = operation.make_case(
+                    **{**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
+                yield case
 
 
 def find_invalid_headers(headers: Mapping) -> Generator[tuple[str, str], None, None]:

{schemathesis-3.38.0 → schemathesis-3.38.2}/src/schemathesis/cli/cassettes.py

@@ -244,12 +244,24 @@ http_interactions:"""
                     write_double_quoted(stream, interaction.description)
                 else:
                     stream.write("null")
-                stream.write("\n    location: ")
 
+                stream.write("\n    location: ")
                 if interaction.location is not None:
                     write_double_quoted(stream, interaction.location)
                 else:
                     stream.write("null")
+
+                stream.write("\n    parameter: ")
+                if interaction.parameter is not None:
+                    write_double_quoted(stream, interaction.parameter)
+                else:
+                    stream.write("null")
+
+                stream.write("\n    parameter_location: ")
+                if interaction.parameter_location is not None:
+                    write_double_quoted(stream, interaction.parameter_location)
+                else:
+                    stream.write("null")
                 stream.write(
                     f"""
   phase: {phase}

{schemathesis-3.38.0 → schemathesis-3.38.2}/src/schemathesis/internal/checks.py

@@ -21,7 +21,7 @@ CheckFunction = Callable[["CheckContext", "GenericResponse", "Case"], Optional[b
 @dataclass
 class NegativeDataRejectionConfig:
     # 5xx will pass through
-    allowed_statuses: list[str] = field(default_factory=lambda: ["4xx", "5xx"])
+    allowed_statuses: list[str] = field(default_factory=lambda: ["400", "401", "403", "404", "422", "5xx"])
 
 
 @dataclass

{schemathesis-3.38.0 → schemathesis-3.38.2}/src/schemathesis/models.py

@@ -158,10 +158,24 @@ class GenerationMetadata:
     cookies: DataGenerationMethod | None
     body: DataGenerationMethod | None
     phase: TestPhase
+    # Temporary attributes to carry info specific to the coverage phase
     description: str | None
     location: str | None
-
-    __slots__ = ("query", "path_parameters", "headers", "cookies", "body", "phase", "description", "location")
+    parameter: str | None
+    parameter_location: str | None
+
+    __slots__ = (
+        "query",
+        "path_parameters",
+        "headers",
+        "cookies",
+        "body",
+        "phase",
+        "description",
+        "location",
+        "parameter",
+        "parameter_location",
+    )
 
 
 @dataclass(repr=False)
@@ -1073,6 +1087,8 @@ class Interaction:
     # NOTE: It will be better to keep it in a separate attribute
     description: str | None
     location: str | None
+    parameter: str | None
+    parameter_location: str | None
     recorded_at: str = field(default_factory=lambda: datetime.datetime.now(TIMEZONE).isoformat())
 
     @classmethod
@@ -1104,6 +1120,8 @@ class Interaction:
             phase=case.meta.phase if case.meta is not None else None,
             description=case.meta.description if case.meta is not None else None,
             location=case.meta.location if case.meta is not None else None,
+            parameter=case.meta.parameter if case.meta is not None else None,
+            parameter_location=case.meta.parameter_location if case.meta is not None else None,
         )
 
     @classmethod
@@ -1129,6 +1147,8 @@ class Interaction:
             phase=case.meta.phase if case.meta is not None else None,
             description=case.meta.description if case.meta is not None else None,
             location=case.meta.location if case.meta is not None else None,
+            parameter=case.meta.parameter if case.meta is not None else None,
+            parameter_location=case.meta.parameter_location if case.meta is not None else None,
         )
 
 

{schemathesis-3.38.0 → schemathesis-3.38.2}/src/schemathesis/runner/serialization.py

@@ -398,6 +398,8 @@ class SerializedInteraction:
     phase: TestPhase | None
     description: str | None
     location: str | None
+    parameter: str | None
+    parameter_location: str | None
     recorded_at: str
 
     @classmethod
@@ -411,6 +413,8 @@ class SerializedInteraction:
             phase=interaction.phase,
             description=interaction.description,
             location=interaction.location,
+            parameter=interaction.parameter,
+            parameter_location=interaction.parameter_location,
             recorded_at=interaction.recorded_at,
         )
 

{schemathesis-3.38.0 → schemathesis-3.38.2}/src/schemathesis/specs/openapi/_hypothesis.py

@@ -179,6 +179,8 @@ def get_case_strategy(
             phase=phase,
             description=None,
             location=None,
+            parameter=None,
+            parameter_location=None,
         ),
     )
     auth_context = auths.AuthContext(

{schemathesis-3.38.0 → schemathesis-3.38.2}/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.0 → schemathesis-3.38.2}/test/apps/__init__.py

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

{schemathesis-3.38.0 → schemathesis-3.38.2}/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,22 +38,22 @@ 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(
-    "args, expected",
-    (
+    ("args", "expected"),
+    [
         (("--auth", "user:pass"), "Basic dXNlcjpwYXNz"),
         (("-H", "Authorization: Bearer EXPLICIT"), "Bearer EXPLICIT"),
-    ),
+    ],
 )
 @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,13 +65,13 @@ 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, testdir, cli, snapshot_cli):
+def test_multiple_auth_mechanisms_with_explicit_auth(ctx, cli, snapshot_cli):
     # When the schema defines multiple auth mechanisms on the same operation
     # And the user passes an explicit `Authorization` header
-    schema = ctx.openapi.build_schema(
+    schema_path = ctx.openapi.write_schema(
         {
             "/health": {
                 "get": {
@@ -97,17 +97,15 @@ def test_multiple_auth_mechanisms_with_explicit_auth(ctx, testdir, cli, snapshot
         },
         security=[{"bearerAuth": []}, {"basicAuth": []}],
     )
-    schema_file = testdir.make_openapi_schema_file(schema)
     # Then it should be able to generate requests
-    assert cli.run(str(schema_file), "--dry-run", "-H", "Authorization: Bearer foo") == snapshot_cli
+    assert cli.run(str(schema_path), "--dry-run", "-H", "Authorization: Bearer foo") == 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}"
@@ -141,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
     )
@@ -149,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")
@@ -175,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 = """
@@ -192,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}
@@ -229,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.0 → schemathesis-3.38.2}/test/auth/test_pytest.py

@@ -32,13 +32,13 @@ type Query {
 
 
 @pytest.mark.parametrize(
-    "class_decorator, pre_parametrize_decorator, post_parametrize_decorator",
-    (
+    ("class_decorator", "pre_parametrize_decorator", "post_parametrize_decorator"),
+    [
         ("@schemathesis.auth()", "", ""),
         ("@schema.auth()", "", ""),
         ("", f"@schema.auth({AUTH_CLASS_NAME})", ""),
         ("", "", f"@schema.auth({AUTH_CLASS_NAME})"),
-    ),
+    ],
     ids=("global", "schema", "test-pre-parametrize", "test-post-parametrize"),
 )
 def test_different_scopes(

{schemathesis-3.38.0 → schemathesis-3.38.2}/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.0 → schemathesis-3.38.2}/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.0 → schemathesis-3.38.2}/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.0 → schemathesis-3.38.2}/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.0 → schemathesis-3.38.2}/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.0 → schemathesis-3.38.2}/test/cli/__snapshots__/test_commands/test_no_schema_in_media_type[Open API 3.0].raw

@@ -4,7 +4,7 @@ Stdout:
 ======================= Schemathesis test session starts =======================
 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.0/test/__snapshots__/test_recoverable_errors/test_in_cli[1].raw → schemathesis-3.38.2/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.0 → schemathesis-3.38.2}/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.0 → schemathesis-3.38.2}/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