schemathesis 3.39.2__tar.gz → 3.39.4__tar.gz

{schemathesis-3.39.2 → schemathesis-3.39.4}/.github/workflows/build.yml

@@ -80,7 +80,7 @@ jobs:
         run: uvx --with="tox" --with="tox-gh-actions" --with="tox-uv" tox
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v5.1.1
+        uses: codecov/codecov-action@v5.1.2
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 

{schemathesis-3.39.2 → schemathesis-3.39.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.27.9
+        uses: github/codeql-action/init@v3.28.0
         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.27.9
+        uses: github/codeql-action/autobuild@v3.28.0
 
       # ℹ️ 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.27.9
+        uses: github/codeql-action/analyze@v3.28.0

{schemathesis-3.39.2 → schemathesis-3.39.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: schemathesis
-Version: 3.39.2
+Version: 3.39.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://schemathesis.readthedocs.io/en/stable/changelog.html

{schemathesis-3.39.2 → schemathesis-3.39.4}/docs/additional-content.rst

@@ -28,6 +28,11 @@ Tutorials
 Articles
 --------
 
+- `Create a Cracker of an Open API Contract with VS Code, Spectral, Prism and Schemathesis <https://blog.hungovercoders.com/datagriff/2024/12/22/create-a-cracker-of-an-open-api-contract-with-vs-code-spectral-prism-and-schemathesis.html>`_ by **dataGriff**
+
+  - **Description**: Contract-first API design and testing walkthrough.
+
+  - **Date**: 22 Dec 2024
 
 - `Boost Your FastAPI Reliability with Schemathesis Automated Testing <https://medium.com/@jeremy3/boost-your-fastapi-reliability-with-schemathesis-automated-testing-e8b70ff704f6>`_ by **Jeremy**
 
@@ -37,7 +42,7 @@ Articles
 
 - `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.
+  - **Description**: In-depth walkthrough including custom hooks, stateful testing, and CI/CD integration.
 
   - **Date**: 29 May 2024
 

{schemathesis-3.39.2 → schemathesis-3.39.4}/docs/changelog.rst

@@ -1,9 +1,28 @@
 Changelog
 =========
 
-:version:`Unreleased <v3.39.2...HEAD>` - TBD
+:version:`Unreleased <v3.39.4...HEAD>` - TBD
 --------------------------------------------
 
+.. _v3.39.4:
+
+:version:`3.39.4 <v3.39.3...v3.39.4>` - 2024-12-26
+--------------------------------------------------
+
+**Fixed**
+
+- ``TypeError`` on extracting explicit examples.
+
+.. _v3.39.3:
+
+:version:`3.39.3 <v3.39.2...v3.39.3>` - 2024-12-24
+--------------------------------------------------
+
+**Fixed**
+
+- Code sample containing incorrect HTTP method for the ``Unspecified HTTP method`` case in the coverage phase.
+- ``TypeError`` on some ``x-www-form-urlencoded`` payloads during the coverage phase.
+
 .. _v3.39.2:
 
 :version:`3.39.2 <v3.39.1...v3.39.2>` - 2024-12-23

{schemathesis-3.39.2 → schemathesis-3.39.4}/pyproject.toml

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

@@ -199,21 +199,26 @@ def add_examples(
             if invalid_headers:
                 add_invalid_example_header_mark(original_test, invalid_headers)
                 continue
-        if example.media_type is not None:
-            try:
-                media_type = parse_content_type(example.media_type)
-                if media_type == ("application", "x-www-form-urlencoded"):
-                    example.body = prepare_urlencoded(example.body)
-            except ValueError:
-                pass
+        adjust_urlencoded_payload(example)
         test = hypothesis.example(case=example)(test)
     return test
 
 
+def adjust_urlencoded_payload(case: Case) -> None:
+    if case.media_type is not None:
+        try:
+            media_type = parse_content_type(case.media_type)
+            if media_type == ("application", "x-www-form-urlencoded"):
+                case.body = prepare_urlencoded(case.body)
+        except ValueError:
+            pass
+
+
 def add_coverage(
     test: Callable, operation: APIOperation, data_generation_methods: list[DataGenerationMethod]
 ) -> Callable:
     for example in _iter_coverage_cases(operation, data_generation_methods):
+        adjust_urlencoded_payload(example)
         test = hypothesis.example(case=example)(test)
     return test
 
@@ -322,7 +327,7 @@ def _iter_coverage_cases(
             case = operation.make_case(**template)
             case._explicit_method = method
             case.data_generation_method = DataGenerationMethod.negative
-            case.meta = _make_meta(description=f"Unspecified HTTP method: {method}")
+            case.meta = _make_meta(description=f"Unspecified HTTP method: {method.upper()}")
             yield case
         # Generate duplicate query parameters
         if operation.query:
@@ -518,7 +523,7 @@ def prepare_urlencoded(data: Any) -> Any:
                 for key, value in item.items():
                     output.append((key, value))
             else:
-                output.append(item)
+                output.append((item, "arbitrary-value"))
         return output
     return data
 

{schemathesis-3.39.2 → schemathesis-3.39.4}/src/schemathesis/models.py

@@ -632,6 +632,7 @@ class Case:
             id=self.id,
             _auth=self._auth,
             _has_explicit_auth=self._has_explicit_auth,
+            _explicit_method=self._explicit_method,
         )
 
 

{schemathesis-3.39.2 → schemathesis-3.39.4}/src/schemathesis/specs/openapi/examples.py

@@ -408,7 +408,8 @@ def find_matching_in_responses(examples: dict[str, list], param: str) -> Iterato
                         if found is not NOT_FOUND:
                             yield found
                     continue
-                example = inner
+                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
@@ -420,6 +421,8 @@ def _find_matching_in_responses(
     # Check for exact match
     if param in example:
         return example[param]
+    if is_id_param and param[:-2] in example:
+        return example[param[:-2]]
 
     # Check for case-insensitive match
     for key in example:

{schemathesis-3.39.2 → schemathesis-3.39.4}/test/cli/test_cassettes.py

@@ -187,15 +187,16 @@ def test_interaction_status(cli, openapi3_schema_url, hypothesis_max_examples, c
     assert result.exit_code == ExitCode.TESTS_FAILED, result.stdout
     cassette = load_cassette(cassette_path)
     # Note. There could be more than 3 calls, depends on Hypothesis internals
-    assert len(cassette["http_interactions"]) >= 3
+    assert len(cassette["http_interactions"]) >= 2
     # Then their statuses should be reflected in the "status" field
     # And it should not be overridden by the overall test status
     assert cassette["http_interactions"][0]["status"] == "FAILURE"
     assert load_response_body(cassette, 0) == "500: Internal Server Error"
     assert cassette["http_interactions"][1]["status"] == "SUCCESS"
     assert load_response_body(cassette, 1) == '{"result": "flaky!"}'
-    assert cassette["http_interactions"][2]["status"] == "SUCCESS"
-    assert load_response_body(cassette, 2) == '{"result": "flaky!"}'
+    if len(cassette["http_interactions"]) > 2:
+        assert cassette["http_interactions"][2]["status"] == "SUCCESS"
+        assert load_response_body(cassette, 2) == '{"result": "flaky!"}'
 
 
 def test_bad_yaml_headers(ctx, cli, cassette_path, hypothesis_max_examples, openapi3_base_url):

schemathesis-3.39.4/test/coverage/__snapshots__/test_phase/test_unspecified_http_methods.raw

@@ -0,0 +1,53 @@
+Exit code: 1
+---
+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.2
+Random seed: 42
+Workers: 1
+Collected API operations: 1
+Collected API links: 0
+API probing: SUCCESS
+Schema analysis: SKIP
+
+POST /api/foo F                                                           [100%]
+
+=================================== FAILURES ===================================
+________________________________ POST /api/foo _________________________________
+1. Test Case ID: <PLACEHOLDER>
+
+- Custom check failed: `failed`
+
+    Should be Unspecified HTTP method: DELETE
+
+[404] Not Found:
+
+    `404: Not Found`
+
+Reproduce with: 
+
+    curl -X DELETE 'http://127.0.0.1/api/foo?key=%5BFiltered%5D'
+
+=================================== SUMMARY ====================================
+
+Performed checks:
+    failed                    N / N passed          FAILED 
+
+WARNING: All API responses have a 404 status code. Did you specify the proper API location?
+
+Experimental Features:
+  - Coverage phase: Generate covering test cases
+    Feedback: https://github.com/schemathesis/schemathesis/discussions/2418
+
+Your feedback is crucial for experimental features. Please visit the provided URL(s) to share your thoughts.
+
+Note: Use the 'X-Schemathesis-TestCaseId' header to correlate test case ids from failure messages with server logs for debugging.
+
+Note: To replicate these test failures, rerun with `--hypothesis-seed=42`
+
+Tip: Use the `--report` CLI option to visualize test results via Schemathesis.io.
+We run additional conformance checks on reports from public repos.
+
+============================== 1 failed in 1.00s ===============================

{schemathesis-3.39.2 → schemathesis-3.39.4}/test/coverage/test_phase.py

@@ -1127,19 +1127,21 @@ def test_negative_query_parameter(ctx):
     ]
 
 
-def test_unspecified_http_methods(ctx):
-    schema = ctx.openapi.build_schema(
-        {
-            "/foo": {
-                "post": {
-                    "responses": {"200": {"description": "OK"}},
-                },
-                "get": {
-                    "responses": {"200": {"description": "OK"}},
-                },
-            }
+@pytest.mark.openapi_version("3.0")
+@pytest.mark.snapshot(replace_statistic=True)
+def test_unspecified_http_methods(ctx, cli, openapi3_base_url, snapshot_cli):
+    raw_schema = {
+        "/foo": {
+            "post": {
+                "parameters": [{"in": "query", "name": "key", "schema": {"type": "integer"}}],
+                "responses": {"200": {"description": "OK"}},
+            },
+            "get": {
+                "responses": {"200": {"description": "OK"}},
+            },
         }
-    )
+    }
+    schema = ctx.openapi.build_schema(raw_schema)
 
     schema = schemathesis.from_dict(schema, validate_schema=True)
 
@@ -1152,6 +1154,7 @@ def test_unspecified_http_methods(ctx):
         if not case.meta.description.startswith("Unspecified"):
             return
         methods.add(case.method)
+        assert f"-X {case.method}" in case.as_curl_command()
 
     test_func = create_test(
         operation=operation,
@@ -1164,6 +1167,78 @@ def test_unspecified_http_methods(ctx):
 
     assert methods == {"HEAD", "PATCH", "TRACE", "DELETE", "OPTIONS", "PUT"}
 
+    module = ctx.write_pymodule(
+        """
+import schemathesis
+
+@schemathesis.check
+def failed(ctx, response, case):
+    if case.meta.description and case.meta.description == "Unspecified HTTP method: DELETE":
+        raise AssertionError(f"Should be {case.meta.description}")
+"""
+    )
+    schema_path = ctx.openapi.write_schema(raw_schema)
+    assert (
+        cli.main(
+            "run",
+            str(schema_path),
+            "-c",
+            "failed",
+            "--include-method=POST",
+            f"--base-url={openapi3_base_url}",
+            "--data-generation-method=negative",
+            "--hypothesis-max-examples=10",
+            "--experimental=coverage-phase",
+            "--show-trace",
+            hooks=module,
+        )
+        == snapshot_cli
+    )
+
+
+def test_urlencoded_payloads_are_valid(ctx):
+    schema = ctx.openapi.build_schema(
+        {
+            "/foo": {
+                "post": {
+                    "requestBody": {
+                        "required": True,
+                        "content": {
+                            "application/x-www-form-urlencoded": {
+                                "schema": {
+                                    "type": "object",
+                                    "properties": {
+                                        "key": {"type": "number", "example": 1},
+                                    },
+                                    "required": ["key"],
+                                },
+                                "example": {"key": 1},
+                            }
+                        },
+                    },
+                    "responses": {"default": {"description": "OK"}},
+                }
+            }
+        }
+    )
+    schema = schemathesis.from_dict(schema, validate_schema=True)
+
+    operation = schema["/foo"]["post"]
+
+    def test(case):
+        if case.meta.phase != TestPhase.COVERAGE:
+            return
+        assert_requests_call(case)
+
+    test_func = create_test(
+        operation=operation,
+        test=test,
+        data_generation_methods=DataGenerationMethod.all(),
+        settings=settings(phases=[Phase.explicit]),
+    )
+
+    test_func()
+
 
 def test_no_missing_header_duplication(ctx):
     schema = ctx.openapi.build_schema(

{schemathesis-3.39.2 → schemathesis-3.39.4}/test/specs/openapi/test_examples.py

@@ -1585,11 +1585,13 @@ def test_find_in_responses_only_in_2xx(ctx):
                 "Item": [
                     {"item": [{"itemId": "123"}, {"itemId": "789"}, {"unknown": 0}]},
                     {"itemId": "456"},
+                    {"itemId": 789},
                     {"item": {"itemId": "42"}},
+                    {"item": 55},
                 ]
             },
             "itemId",
-            ["123", "789", "456", "42"],
+            ["123", "789", "456", 789, "42", 55],
         ),
         (
             {"Item": [{"id": "123"}, {"id": "456"}]},

{schemathesis-3.39.2 → schemathesis-3.39.4}/test/specs/openapi/test_randomized.py

@@ -1,5 +1,6 @@
 import sys
 
+import hypothesis.errors
 import pytest
 from hypothesis import HealthCheck, Phase, given, settings
 
@@ -12,6 +13,8 @@ if sys.version_info < (3, 10):
 
 from hypothesis_openapi import openapis
 
+IGNORED_EXCEPTIONS = [hypothesis.errors.Unsatisfiable]
+
 
 @given(openapis(version="2.0") | openapis(version="3.0"))
 @settings(max_examples=25, phases=[Phase.generate], deadline=None, suppress_health_check=list(HealthCheck))
@@ -22,6 +25,14 @@ def test_random_schemas(schema):
     for event in schemathesis.runner.from_schema(schema, dry_run=True).execute():
         assert not isinstance(event, events.InternalError), repr(event)
         if isinstance(event, events.AfterExecution):
-            if event.result.errors:
-                error = event.result.errors[0]
+            errors = [
+                error
+                for error in event.result.errors
+                if all(
+                    f"{exc.__module__}.{exc.__name__}" not in error.exception_with_traceback
+                    for exc in IGNORED_EXCEPTIONS
+                )
+            ]
+            if errors:
+                error = errors[0]
                 raise AssertionError(error.exception_with_traceback)