schemathesis 3.36.2__tar.gz → 3.36.4__tar.gz

{schemathesis-3.36.2 → schemathesis-3.36.4}/.github/workflows/build.yml

@@ -25,7 +25,7 @@ jobs:
     name: Generic pre-commit checks
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
         with:
           fetch-depth: 1
 
@@ -41,7 +41,7 @@ jobs:
     name: Documentation
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
         with:
           fetch-depth: 1
       - uses: ammaraskar/sphinx-action@master
@@ -63,7 +63,7 @@ jobs:
     name: Tests (Python ${{ matrix.python }} on ${{ matrix.os }} ${{ matrix.tox_env }})
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
         with:
           fetch-depth: 1
 
@@ -93,7 +93,7 @@ jobs:
     name: Test piping output to a file with CP1252 encoding on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
         with:
           fetch-depth: 1
 

{schemathesis-3.36.2 → schemathesis-3.36.4}/.github/workflows/codeql-analysis.yml

@@ -30,7 +30,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4.1.7
+        uses: actions/checkout@v4.2.0
         with:
           # We must fetch at least the immediate parents so that if this is
           # a pull request then we can checkout the head.
@@ -38,7 +38,7 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3.26.8
+        uses: github/codeql-action/init@v3.26.9
         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.26.8
+        uses: github/codeql-action/autobuild@v3.26.9
 
       # ℹ️ 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.26.8
+        uses: github/codeql-action/analyze@v3.26.9

{schemathesis-3.36.2 → schemathesis-3.36.4}/.github/workflows/codspeed.yml

@@ -7,11 +7,14 @@ on:
   pull_request:
   workflow_dispatch:
 
+env:
+  SCHEMATHESIS_BENCHMARK_SEED: "42"
+
 jobs:
   benchmarks:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
       - uses: actions/setup-python@v5
         with:
           # Python 3.12 for flamegraph support

{schemathesis-3.36.2 → schemathesis-3.36.4}/.github/workflows/commit.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Check out code
-        uses: actions/checkout@v4.1.7
+        uses: actions/checkout@v4.2.0
         with:
           fetch-depth: 0
       - name: Run commitsar

{schemathesis-3.36.2 → schemathesis-3.36.4}/.github/workflows/example-build.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-22.04
 
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
 
       - name: Start containers
         run: docker compose up -d --build

{schemathesis-3.36.2 → schemathesis-3.36.4}/.github/workflows/master_update.yml

@@ -20,7 +20,7 @@ jobs:
             tag: "latest-bookworm"
 
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3

{schemathesis-3.36.2 → schemathesis-3.36.4}/.github/workflows/release.yml

@@ -19,7 +19,7 @@ jobs:
             tag-suffix: "-bookworm"
 
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
 
       - name: Docker meta
         id: meta
@@ -68,7 +68,7 @@ jobs:
     name: Build and publish package to pypi.org
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
         with:
           fetch-depth: 1
 

{schemathesis-3.36.2 → schemathesis-3.36.4}/.github/workflows/test-corpus.yml

@@ -12,7 +12,7 @@ jobs:
     name: Default corpus tests
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
         with:
           fetch-depth: 1
           submodules: true
@@ -29,7 +29,7 @@ jobs:
     name: Corpus tests for the coverage phase
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
         with:
           fetch-depth: 1
           submodules: true

{schemathesis-3.36.2 → schemathesis-3.36.4}/.github/workflows/test-hypothesis.yml

@@ -11,7 +11,7 @@ jobs:
     name: Hypothesis tests with CI profile
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
         with:
           fetch-depth: 1
 

{schemathesis-3.36.2 → schemathesis-3.36.4}/.github/workflows/update-pre-commit.yml

@@ -10,7 +10,7 @@ jobs:
     name: Update pre-commit
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.0
         with:
           fetch-depth: 1
           submodules: true

{schemathesis-3.36.2 → schemathesis-3.36.4}/.pre-commit-config.yaml

@@ -38,12 +38,12 @@ repos:
         additional_dependencies: [types-click, types-requests, types-PyYAML]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.7
+    rev: v0.6.8
     hooks:
       - id: ruff-format
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.7
+    rev: v0.6.8
     hooks:
       - id: ruff
 

{schemathesis-3.36.2 → schemathesis-3.36.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: schemathesis
-Version: 3.36.2
+Version: 3.36.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.36.4/benches/coverage_phase.py

@@ -0,0 +1,133 @@
+"""Benchmarks for the coverage phase."""
+
+import pytest
+
+from schemathesis.generation.coverage import cover_schema_iter, CoverageContext
+
+CONTEXTS = [CoverageContext.with_positive(), CoverageContext.with_negative()]
+CONTEXT_NAMES = [",".join([m.value for m in ctx.data_generation_methods]) for ctx in CONTEXTS]
+
+BASIC_TYPES = [
+    {"type": "string"},
+    {"type": "integer"},
+    {"type": "number"},
+    {"type": "boolean"},
+    {"type": "null"},
+]
+
+
+@pytest.mark.benchmark
+@pytest.mark.parametrize("ctx", CONTEXTS, ids=CONTEXT_NAMES)
+@pytest.mark.parametrize("schema", BASIC_TYPES, ids=lambda x: f"basic-{x['type']}")
+def test_basic_types(benchmark, ctx, schema):
+    benchmark(lambda: list(cover_schema_iter(ctx, schema)))
+
+
+STRING_CONSTRAINTS = [
+    {"type": "string", "minLength": 5},
+    {"type": "string", "maxLength": 10},
+    {"type": "string", "pattern": "^[a-z]+$"},
+    {"type": "string", "format": "email"},
+]
+
+
+@pytest.mark.benchmark
+@pytest.mark.parametrize("ctx", CONTEXTS, ids=CONTEXT_NAMES)
+@pytest.mark.parametrize("schema", STRING_CONSTRAINTS, ids=lambda x: f"string-{list(x.keys())[1]}")
+def test_string_constraints(benchmark, ctx, schema):
+    benchmark(lambda: list(cover_schema_iter(ctx, schema)))
+
+
+NUMBER_CONSTRAINTS = [
+    {"type": "number", "minimum": 0, "maximum": 100},
+    {"type": "integer", "multipleOf": 5},
+    {"type": "number", "exclusiveMinimum": 0, "exclusiveMaximum": 1},
+]
+
+
+@pytest.mark.benchmark
+@pytest.mark.parametrize("ctx", CONTEXTS, ids=CONTEXT_NAMES)
+@pytest.mark.parametrize("schema", NUMBER_CONSTRAINTS, ids=lambda x: f"number-{list(x.keys())[1]}")
+def test_number_constraints(benchmark, ctx, schema):
+    benchmark(lambda: list(cover_schema_iter(ctx, schema)))
+
+
+ARRAY_CONSTRAINTS = [
+    {"type": "array", "items": {"type": "string"}},
+    {"type": "array", "minItems": 2, "maxItems": 5},
+    {"type": "array", "uniqueItems": True},
+]
+
+
+@pytest.mark.benchmark
+@pytest.mark.parametrize("ctx", CONTEXTS, ids=CONTEXT_NAMES)
+@pytest.mark.parametrize("schema", ARRAY_CONSTRAINTS, ids=lambda x: f"array-{list(x.keys())[1]}")
+def test_array_constraints(benchmark, ctx, schema):
+    benchmark(lambda: list(cover_schema_iter(ctx, schema)))
+
+
+OBJECT_CONSTRAINTS = [
+    {"type": "object", "properties": {"name": {"type": "string"}, "age": {"type": "integer"}}},
+    {"type": "object", "required": ["id"], "properties": {"id": {"type": "string"}}},
+    {"type": "object", "additionalProperties": False, "properties": {"key": {"type": "string"}}},
+]
+
+
+@pytest.mark.benchmark
+@pytest.mark.parametrize("ctx", CONTEXTS, ids=CONTEXT_NAMES)
+@pytest.mark.parametrize("schema", OBJECT_CONSTRAINTS, ids=lambda x: f"object-{list(x.keys())[1]}")
+def test_object_constraints(benchmark, ctx, schema):
+    benchmark(lambda: list(cover_schema_iter(ctx, schema)))
+
+
+# Combined schemas
+COMBINED_SCHEMAS = [
+    {"anyOf": [{"type": "string"}, {"type": "integer"}]},
+    {"oneOf": [{"type": "number", "multipleOf": 5}, {"type": "number", "multipleOf": 3}]},
+    {"allOf": [{"type": "string"}, {"minLength": 5}]},
+]
+
+
+@pytest.mark.benchmark
+@pytest.mark.parametrize("ctx", CONTEXTS, ids=CONTEXT_NAMES)
+@pytest.mark.parametrize("schema", COMBINED_SCHEMAS, ids=lambda x: f"combined-{list(x.keys())[0]}")
+def test_combined_schemas(benchmark, ctx, schema):
+    benchmark(lambda: list(cover_schema_iter(ctx, schema)))
+
+
+COMPLEX_NESTED_SCHEMAS = [
+    {
+        "type": "object",
+        "properties": {
+            "user": {
+                "type": "object",
+                "properties": {
+                    "name": {"type": "string"},
+                    "age": {"type": "integer", "minimum": 18},
+                    "emails": {"type": "array", "items": {"type": "string", "format": "email"}},
+                },
+                "required": ["name", "age"],
+            }
+        },
+    },
+    {
+        "type": "array",
+        "items": {
+            "type": "object",
+            "properties": {
+                "id": {"type": "integer"},
+                "tags": {"type": "array", "items": {"type": "string"}, "uniqueItems": True},
+            },
+            "required": ["id"],
+        },
+        "minItems": 1,
+        "maxItems": 10,
+    },
+]
+
+
+@pytest.mark.benchmark
+@pytest.mark.parametrize("ctx", CONTEXTS, ids=CONTEXT_NAMES)
+@pytest.mark.parametrize("schema", COMPLEX_NESTED_SCHEMAS, ids=lambda x: f"complex-{x['type']}")
+def test_complex_nested_schemas(benchmark, ctx, schema):
+    benchmark(lambda: list(cover_schema_iter(ctx, schema)))

{schemathesis-3.36.2 → schemathesis-3.36.4}/docs/changelog.rst

@@ -1,9 +1,33 @@
 Changelog
 =========
 
-:version:`Unreleased <v3.36.2...HEAD>` - TBD
+:version:`Unreleased <v3.36.4...HEAD>` - TBD
 --------------------------------------------
 
+.. _v3.36.4:
+
+:version:`3.36.4 <v3.36.3...v3.36.4>` - 2024-10-05
+--------------------------------------------------
+
+**Fixed**
+
+- False positive for ``ignored_auth`` when used in stateful test runner. :issue:`2482`
+- Open Api 3.1 spec using ``$ref`` in a path is incorrectly validated as invalid. :issue:`2484`
+- Properly serialize ``seed`` in cassettes if ``--hypothesis-derandomize`` is present.
+
+**Performance**
+
+- Improvements for the coverage phase.
+
+.. _v3.36.3:
+
+:version:`3.36.3 <v3.36.2...v3.36.3>` - 2024-09-29
+--------------------------------------------------
+
+**Added**
+
+- Meta information about generated data in the coverage phase.
+
 .. _v3.36.2:
 
 :version:`3.36.2 <v3.36.1...v3.36.2>` - 2024-09-26

{schemathesis-3.36.2 → schemathesis-3.36.4}/pyproject.toml

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

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 import asyncio
 import json
+from copy import copy
 import warnings
 from typing import TYPE_CHECKING, Any, Callable, Generator, Mapping
 
@@ -221,7 +222,13 @@ def _iter_coverage_cases(
 
     ctx = coverage.CoverageContext(data_generation_methods=data_generation_methods)
     meta = GenerationMetadata(
-        query=None, path_parameters=None, headers=None, cookies=None, body=None, phase=TestPhase.COVERAGE
+        query=None,
+        path_parameters=None,
+        headers=None,
+        cookies=None,
+        body=None,
+        phase=TestPhase.COVERAGE,
+        description=None,
     )
     generators: dict[tuple[str, str], Generator[coverage.GeneratedValue, None, None]] = {}
     template: dict[str, Any] = {}
@@ -259,17 +266,19 @@ 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 = meta
+            case.meta = copy(meta)
+            case.meta.description = value.description
             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 = meta
+                case.meta = copy(meta)
+                case.meta.description = next_value.description
                 yield case
     elif DataGenerationMethod.positive in data_generation_methods:
         case = operation.make_case(**template)
         case.data_generation_method = DataGenerationMethod.positive
-        case.meta = meta
+        case.meta = copy(meta)
         yield case
     for (location, name), gen in generators.items():
         container_name = LOCATION_TO_CONTAINER[location]
@@ -281,7 +290,8 @@ 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 = meta
+            case.meta = copy(meta)
+            case.meta.description = value.description
             yield case
 
 

{schemathesis-3.36.2 → schemathesis-3.36.4}/src/schemathesis/cli/cassettes.py

@@ -79,24 +79,18 @@ class CassetteWriter(EventHandler):
     def handle_event(self, context: ExecutionContext, event: events.ExecutionEvent) -> None:
         if isinstance(event, events.Initialized):
             # In the beginning we write metadata and start `http_interactions` list
-            self.queue.put(Initialize())
+            self.queue.put(Initialize(seed=event.seed))
         elif isinstance(event, events.AfterExecution):
-            # Seed is always present at this point, the original Optional[int] type is there because `TestResult`
-            # instance is created before `seed` is generated on the hypothesis side
-            seed = cast(int, event.result.seed)
             self.queue.put(
                 Process(
-                    seed=seed,
                     correlation_id=event.correlation_id,
                     thread_id=event.thread_id,
                     interactions=event.result.interactions,
                 )
             )
         elif isinstance(event, events.AfterStatefulExecution):
-            seed = cast(int, event.result.seed)
             self.queue.put(
                 Process(
-                    seed=seed,
                     # Correlation ID is not used in stateful testing
                     correlation_id="",
                     thread_id=event.thread_id,
@@ -118,12 +112,13 @@ class CassetteWriter(EventHandler):
 class Initialize:
     """Start up, the first message to make preparations before proceeding the input data."""
 
+    seed: int | None
+
 
 @dataclass
 class Process:
     """A new chunk of data should be processed."""
 
-    seed: int
     correlation_id: str
     thread_id: int
     interactions: list[SerializedInteraction]
@@ -219,9 +214,11 @@ def vcr_writer(file_handle: click.utils.LazyFile, preserve_exact_body_bytes: boo
                 )
                 write_double_quoted(output, string)
 
+    seed = "null"
     while True:
         item = queue.get()
         if isinstance(item, Initialize):
+            seed = f"'{item.seed}'"
             stream.write(
                 f"""command: '{get_command_representation()}'
 recorded_with: 'Schemathesis {SCHEMATHESIS_VERSION}'
@@ -235,10 +232,20 @@ http_interactions:"""
                 stream.write(
                     f"""\n- id: '{current_id}'
   status: '{status}'
-  seed: '{item.seed}'
+  seed: {seed}
   thread_id: {item.thread_id}
   correlation_id: '{item.correlation_id}'
   data_generation_method: '{interaction.data_generation_method.value}'
+  meta:
+    description: """
+                )
+
+                if interaction.description is not None:
+                    write_double_quoted(stream, interaction.description)
+                else:
+                    stream.write("null")
+                stream.write(
+                    f"""
   phase: {phase}
   elapsed: '{interaction.response.elapsed if interaction.response else 0}'
   recorded_at: '{interaction.recorded_at}'

{schemathesis-3.36.2 → schemathesis-3.36.4}/src/schemathesis/generation/_hypothesis.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import os
 from functools import lru_cache, reduce
 from operator import or_
 from typing import TYPE_CHECKING, TypeVar
@@ -8,6 +9,8 @@ if TYPE_CHECKING:
     from hypothesis import settings
     from hypothesis import strategies as st
 
+SCHEMATHESIS_BENCHMARK_SEED = os.environ.get("SCHEMATHESIS_BENCHMARK_SEED")
+
 
 @lru_cache
 def default_settings() -> settings:
@@ -33,13 +36,16 @@ def get_single_example(strategy: st.SearchStrategy[T]) -> T:  # type: ignore[typ
 
 
 def add_single_example(strategy: st.SearchStrategy[T], examples: list[T]) -> None:
-    from hypothesis import given
+    from hypothesis import given, seed
 
     @given(strategy)  # type: ignore
     @default_settings()  # type: ignore
     def example_generating_inner_function(ex: T) -> None:
         examples.append(ex)
 
+    if SCHEMATHESIS_BENCHMARK_SEED is not None:
+        example_generating_inner_function = seed(SCHEMATHESIS_BENCHMARK_SEED)(example_generating_inner_function)
+
     example_generating_inner_function()