schemathesis 3.38.7__tar.gz → 3.38.8__tar.gz

{schemathesis-3.38.7 → schemathesis-3.38.8}/.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.1
+        uses: github/codeql-action/init@v3.27.5
         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.1
+        uses: github/codeql-action/autobuild@v3.27.5
 
       # ℹ️ 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.1
+        uses: github/codeql-action/analyze@v3.27.5

{schemathesis-3.38.7 → schemathesis-3.38.8}/.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.7.3
+    rev: v0.8.0
     hooks:
       - id: ruff-format
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.3
+    rev: v0.8.0
     hooks:
       - id: ruff
 

{schemathesis-3.38.7 → schemathesis-3.38.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: schemathesis
-Version: 3.38.7
+Version: 3.38.8
 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.7 → schemathesis-3.38.8}/benches/coverage_phase.py

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

{schemathesis-3.38.7 → schemathesis-3.38.8}/docs/changelog.rst

@@ -1,9 +1,20 @@
 Changelog
 =========
 
-:version:`Unreleased <v3.38.7...HEAD>` - TBD
+:version:`Unreleased <v3.38.8...HEAD>` - TBD
 --------------------------------------------
 
+.. _v3.38.8:
+
+:version:`3.38.8 <v3.38.7...v3.38.8>` - 2024-11-28
+--------------------------------------------------
+
+**Fixed**
+
+- ``UnicodeEncodeError`` when sending a request during the coverage phase.
+- Duplicated test cases for missing required headers during the coverage phase.
+- Generating positive test cases when they are explicitly excluded via configuration during the coverage phase.
+
 .. _v3.38.7:
 
 :version:`3.38.7 <v3.38.6...v3.38.7>` - 2024-11-16

{schemathesis-3.38.7 → schemathesis-3.38.8}/pyproject.toml

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

@@ -237,17 +237,17 @@ def _iter_coverage_cases(
     template: dict[str, Any] = {}
     responses = find_in_responses(operation)
     for parameter in operation.iter_parameters():
+        location = parameter.location
+        name = parameter.name
         schema = parameter.as_json_schema(operation, update_quantifiers=False)
         for value in find_matching_in_responses(responses, parameter.name):
             schema.setdefault("examples", []).append(value)
         gen = coverage.cover_schema_iter(
-            coverage.CoverageContext(data_generation_methods=data_generation_methods), schema
+            coverage.CoverageContext(location=location, data_generation_methods=data_generation_methods), schema
         )
         value = next(gen, NOT_SET)
         if isinstance(value, NotSet):
             continue
-        location = parameter.location
-        name = parameter.name
         container = template.setdefault(LOCATION_TO_CONTAINER[location], {})
         if location in ("header", "cookie", "path", "query") and not isinstance(value.value, str):
             container[name] = _stringify_value(value.value, location)
@@ -263,7 +263,7 @@ def _iter_coverage_cases(
             if examples:
                 schema.setdefault("examples", []).extend(examples)
             gen = coverage.cover_schema_iter(
-                coverage.CoverageContext(data_generation_methods=data_generation_methods), schema
+                coverage.CoverageContext(location="body", data_generation_methods=data_generation_methods), schema
             )
             value = next(gen, NOT_SET)
             if isinstance(value, NotSet):
@@ -417,7 +417,7 @@ def _iter_coverage_cases(
             subschema: dict[str, Any], _location: str, _container_name: str
         ) -> Generator[Case, None, None]:
             for more in coverage.cover_schema_iter(
-                coverage.CoverageContext(data_generation_methods=[DataGenerationMethod.negative]),
+                coverage.CoverageContext(location=_location, data_generation_methods=[DataGenerationMethod.negative]),
                 subschema,
             ):
                 yield make_case(
@@ -432,17 +432,26 @@ def _iter_coverage_cases(
         # 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, None, DataGenerationMethod.positive
-            )
+            if DataGenerationMethod.positive in data_generation_methods:
+                yield make_case(
+                    only_required,
+                    "Only required properties",
+                    location,
+                    container_name,
+                    None,
+                    DataGenerationMethod.positive,
+                )
             if DataGenerationMethod.negative in data_generation_methods:
                 subschema = _combination_schema(only_required, required, parameter_set)
-                yield from _yield_negative(subschema, location, container_name)
+                for case in _yield_negative(subschema, location, container_name):
+                    # Already generated in one of the blocks above
+                    if location != "path" and not case.meta.description.startswith("Missing required property"):
+                        yield case
 
         # 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:
+            if combo != base_container and DataGenerationMethod.positive in data_generation_methods:
                 yield make_case(
                     combo,
                     f"All required properties and optional '{opt_param}'",
@@ -456,7 +465,7 @@ def _iter_coverage_cases(
                     yield from _yield_negative(subschema, location, container_name)
 
         # 3. Generate one combination for each size from 2 to N-1 of optional parameters
-        if len(optional) > 1:
+        if len(optional) > 1 and DataGenerationMethod.positive in data_generation_methods:
             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}

{schemathesis-3.38.7 → schemathesis-3.38.8}/src/schemathesis/cli/__init__.py

@@ -323,6 +323,15 @@ REPORT_TO_SERVICE = ReportToService()
     multiple=True,
     metavar="",
 )
+@grouped_option(
+    "--experimental-missing-required-header-allowed-statuses",
+    "missing_required_header_allowed_statuses",
+    help="Comma-separated list of status codes expected for test cases with a missing required header",
+    type=CsvListChoice(),
+    callback=callbacks.convert_status_codes,
+    metavar="",
+    envvar="SCHEMATHESIS_EXPERIMENTAL_MISSING_REQUIRED_HEADER_ALLOWED_STATUSES",
+)
 @grouped_option(
     "--experimental-positive-data-acceptance-allowed-statuses",
     "positive_data_acceptance_allowed_statuses",
@@ -855,6 +864,7 @@ def run(
     set_cookie: dict[str, str],
     set_path: dict[str, str],
     experiments: list,
+    missing_required_header_allowed_statuses: list[str],
     positive_data_acceptance_allowed_statuses: list[str],
     negative_data_rejection_allowed_statuses: list[str],
     checks: Iterable[str] = DEFAULT_CHECKS_NAMES,
@@ -1172,6 +1182,11 @@ def run(
         selected_checks += (positive_data_acceptance,)
         if positive_data_acceptance_allowed_statuses:
             checks_config.positive_data_acceptance.allowed_statuses = positive_data_acceptance_allowed_statuses
+    if missing_required_header_allowed_statuses:
+        from ..specs.openapi.checks import missing_required_header
+
+        selected_checks += (missing_required_header,)
+        checks_config.missing_required_header.allowed_statuses = missing_required_header_allowed_statuses
     if negative_data_rejection_allowed_statuses:
         checks_config.negative_data_rejection.allowed_statuses = negative_data_rejection_allowed_statuses
 

{schemathesis-3.38.7 → schemathesis-3.38.8}/src/schemathesis/generation/coverage.py

@@ -21,6 +21,7 @@ from ..internal.copy import fast_deepcopy
 from ..specs.openapi.converter import update_pattern_in_schema
 from ..specs.openapi.formats import STRING_FORMATS, get_default_format_strategies
 from ..specs.openapi.patterns import update_quantifier
+from ..transports.headers import has_invalid_characters, is_latin_1_encodable
 from ._hypothesis import get_single_example
 from ._methods import DataGenerationMethod
 
@@ -103,42 +104,55 @@ def cached_draw(strategy: st.SearchStrategy) -> Any:
 @dataclass
 class CoverageContext:
     data_generation_methods: list[DataGenerationMethod]
-    location_stack: list[str | int]
+    location: str
+    path: list[str | int]
 
-    __slots__ = ("data_generation_methods", "location_stack")
+    __slots__ = ("location", "data_generation_methods", "path")
 
     def __init__(
         self,
+        *,
+        location: str,
         data_generation_methods: list[DataGenerationMethod] | None = None,
-        location_stack: list[str | int] | None = None,
+        path: list[str | int] | None = None,
     ) -> None:
+        self.location = location
         self.data_generation_methods = (
             data_generation_methods if data_generation_methods is not None else DataGenerationMethod.all()
         )
-        self.location_stack = location_stack or []
+        self.path = path or []
 
     @contextmanager
-    def location(self, key: str | int) -> Generator[None, None, None]:
-        self.location_stack.append(key)
+    def at(self, key: str | int) -> Generator[None, None, None]:
+        self.path.append(key)
         try:
             yield
         finally:
-            self.location_stack.pop()
+            self.path.pop()
 
     @property
-    def current_location(self) -> str:
-        return "/" + "/".join(str(key) for key in self.location_stack)
+    def current_path(self) -> str:
+        return "/" + "/".join(str(key) for key in self.path)
 
     def with_positive(self) -> CoverageContext:
         return CoverageContext(
-            data_generation_methods=[DataGenerationMethod.positive], location_stack=self.location_stack
+            location=self.location,
+            data_generation_methods=[DataGenerationMethod.positive],
+            path=self.path,
         )
 
     def with_negative(self) -> CoverageContext:
         return CoverageContext(
-            data_generation_methods=[DataGenerationMethod.negative], location_stack=self.location_stack
+            location=self.location,
+            data_generation_methods=[DataGenerationMethod.negative],
+            path=self.path,
         )
 
+    def is_valid_for_location(self, value: Any) -> bool:
+        if self.location in ("header", "cookie") and isinstance(value, str):
+            return is_latin_1_encodable(value) and not has_invalid_characters("", value)
+        return True
+
     def generate_from(self, strategy: st.SearchStrategy) -> Any:
         return cached_draw(strategy)
 
@@ -322,7 +336,7 @@ def cover_schema_iter(
     if DataGenerationMethod.negative in ctx.data_generation_methods:
         template = None
         for key, value in schema.items():
-            with _ignore_unfixable(), ctx.location(key):
+            with _ignore_unfixable(), ctx.at(key):
                 if key == "enum":
                     yield from _negative_enum(ctx, value, seen)
                 elif key == "const":
@@ -350,21 +364,17 @@ def cover_schema_iter(
                 elif key == "maximum":
                     next = value + 1
                     if next not in seen:
-                        yield NegativeValue(
-                            next, description="Value greater than maximum", location=ctx.current_location
-                        )
+                        yield NegativeValue(next, description="Value greater than maximum", location=ctx.current_path)
                         seen.add(next)
                 elif key == "minimum":
                     next = value - 1
                     if next not in seen:
-                        yield NegativeValue(
-                            next, description="Value smaller than minimum", location=ctx.current_location
-                        )
+                        yield NegativeValue(next, description="Value smaller than minimum", location=ctx.current_path)
                         seen.add(next)
                 elif key == "exclusiveMaximum" or key == "exclusiveMinimum" and value not in seen:
                     verb = "greater" if key == "exclusiveMaximum" else "smaller"
                     limit = "maximum" if key == "exclusiveMaximum" else "minimum"
-                    yield NegativeValue(value, description=f"Value {verb} than {limit}", location=ctx.current_location)
+                    yield NegativeValue(value, description=f"Value {verb} than {limit}", location=ctx.current_path)
                     seen.add(value)
                 elif key == "multipleOf":
                     for value_ in _negative_multiple_of(ctx, schema, value):
@@ -391,7 +401,7 @@ def cover_schema_iter(
                         k = _to_hashable_key(value)
                         if k not in seen:
                             yield NegativeValue(
-                                value, description="String smaller than minLength", location=ctx.current_location
+                                value, description="String smaller than minLength", location=ctx.current_path
                             )
                             seen.add(k)
                 elif key == "maxLength" and value < BUFFER_SIZE:
@@ -413,7 +423,7 @@ def cover_schema_iter(
                         k = _to_hashable_key(value)
                         if k not in seen:
                             yield NegativeValue(
-                                value, description="String larger than maxLength", location=ctx.current_location
+                                value, description="String larger than maxLength", location=ctx.current_path
                             )
                             seen.add(k)
                     except (InvalidArgument, Unsatisfiable):
@@ -428,12 +438,12 @@ def cover_schema_iter(
                     yield NegativeValue(
                         {**template, UNKNOWN_PROPERTY_KEY: UNKNOWN_PROPERTY_VALUE},
                         description="Object with unexpected properties",
-                        location=ctx.current_location,
+                        location=ctx.current_path,
                     )
                 elif key == "allOf":
                     nctx = ctx.with_negative()
                     if len(value) == 1:
-                        with nctx.location(0):
+                        with nctx.at(0):
                             yield from cover_schema_iter(nctx, value[0], seen)
                     else:
                         with _ignore_unfixable():
@@ -443,7 +453,7 @@ def cover_schema_iter(
                     nctx = ctx.with_negative()
                     # NOTE: Other sub-schemas are not filtered out
                     for idx, sub_schema in enumerate(value):
-                        with nctx.location(idx):
+                        with nctx.at(idx):
                             yield from cover_schema_iter(nctx, sub_schema, seen)
 
 
@@ -487,15 +497,17 @@ def _positive_string(ctx: CoverageContext, schema: dict) -> Generator[GeneratedV
     examples = schema.get("examples")
     default = schema.get("default")
     if example or examples or default:
-        if example:
+        if example and ctx.is_valid_for_location(example):
             yield PositiveValue(example, description="Example value")
         if examples:
             for example in examples:
-                yield PositiveValue(example, description="Example value")
+                if ctx.is_valid_for_location(example):
+                    yield PositiveValue(example, description="Example value")
         if (
             default
             and not (example is not None and default == example)
             and not (examples is not None and any(default == ex for ex in examples))
+            and ctx.is_valid_for_location(default)
         ):
             yield PositiveValue(default, description="Default value")
     elif not min_length and not max_length:
@@ -755,7 +767,7 @@ def _negative_enum(
 
     strategy = (st.none() | st.booleans() | NUMERIC_STRATEGY | st.text()).filter(is_not_in_value)
     value = ctx.generate_from(strategy)
-    yield NegativeValue(value, description="Invalid enum value", location=ctx.current_location)
+    yield NegativeValue(value, description="Invalid enum value", location=ctx.current_path)
     hashed = _to_hashable_key(value)
     seen.add(hashed)
 
@@ -765,12 +777,12 @@ def _negative_properties(
 ) -> Generator[GeneratedValue, None, None]:
     nctx = ctx.with_negative()
     for key, sub_schema in properties.items():
-        with nctx.location(key):
+        with nctx.at(key):
             for value in cover_schema_iter(nctx, sub_schema):
                 yield NegativeValue(
                     {**template, key: value.value},
                     description=f"Object with invalid '{key}' value: {value.description}",
-                    location=nctx.current_location,
+                    location=nctx.current_path,
                     parameter=key,
                 )
 
@@ -784,12 +796,12 @@ def _negative_pattern_properties(
             key = ctx.generate_from(st.from_regex(pattern))
         except re.error:
             continue
-        with nctx.location(pattern):
+        with nctx.at(pattern):
             for value in cover_schema_iter(nctx, sub_schema):
                 yield NegativeValue(
                     {**template, key: value.value},
                     description=f"Object with invalid pattern key '{key}' ('{pattern}') value: {value.description}",
-                    location=nctx.current_location,
+                    location=nctx.current_path,
                 )
 
 
@@ -800,7 +812,7 @@ def _negative_items(ctx: CoverageContext, schema: dict[str, Any] | bool) -> Gene
         yield NegativeValue(
             [value.value],
             description=f"Array with invalid items: {value.description}",
-            location=nctx.current_location,
+            location=nctx.current_path,
         )
 
 
@@ -822,7 +834,7 @@ def _negative_pattern(
             )
         ),
         description=f"Value not matching the '{pattern}' pattern",
-        location=ctx.current_location,
+        location=ctx.current_path,
     )
 
 
@@ -836,13 +848,13 @@ def _negative_multiple_of(
     yield NegativeValue(
         ctx.generate_from_schema(_with_negated_key(schema, "multipleOf", multiple_of)),
         description=f"Non-multiple of {multiple_of}",
-        location=ctx.current_location,
+        location=ctx.current_path,
     )
 
 
 def _negative_unique_items(ctx: CoverageContext, schema: dict) -> Generator[GeneratedValue, None, None]:
     unique = ctx.generate_from_schema({**schema, "type": "array", "minItems": 1, "maxItems": 1})
-    yield NegativeValue(unique + unique, description="Non-unique items", location=ctx.current_location)
+    yield NegativeValue(unique + unique, description="Non-unique items", location=ctx.current_path)
 
 
 def _negative_required(
@@ -852,7 +864,7 @@ def _negative_required(
         yield NegativeValue(
             {k: v for k, v in template.items() if k != key},
             description=f"Missing required property: {key}",
-            location=ctx.current_location,
+            location=ctx.current_path,
             parameter=key,
         )
 
@@ -878,7 +890,7 @@ def _negative_format(ctx: CoverageContext, schema: dict, format: str) -> Generat
     yield NegativeValue(
         ctx.generate_from(strategy),
         description=f"Value not matching the '{format}' format",
-        location=ctx.current_location,
+        location=ctx.current_path,
     )
 
 
@@ -901,7 +913,7 @@ def _negative_type(ctx: CoverageContext, seen: set, ty: str | list[str]) -> Gene
         hashed = _to_hashable_key(value)
         if hashed in seen:
             continue
-        yield NegativeValue(value, description="Incorrect type", location=ctx.current_location)
+        yield NegativeValue(value, description="Incorrect type", location=ctx.current_path)
         seen.add(hashed)
 
 

{schemathesis-3.38.7 → schemathesis-3.38.8}/src/schemathesis/internal/checks.py

@@ -29,8 +29,14 @@ class PositiveDataAcceptanceConfig:
     allowed_statuses: list[str] = field(default_factory=lambda: ["2xx", "401", "403", "404"])
 
 
+@dataclass
+class MissingRequiredHeaderConfig:
+    allowed_statuses: list[str] = field(default_factory=lambda: ["406"])
+
+
 @dataclass
 class CheckConfig:
+    missing_required_header: MissingRequiredHeaderConfig = field(default_factory=MissingRequiredHeaderConfig)
     negative_data_rejection: NegativeDataRejectionConfig = field(default_factory=NegativeDataRejectionConfig)
     positive_data_acceptance: PositiveDataAcceptanceConfig = field(default_factory=PositiveDataAcceptanceConfig)
 

{schemathesis-3.38.7 → schemathesis-3.38.8}/src/schemathesis/models.py

@@ -622,6 +622,7 @@ class Case:
             cookies=fast_deepcopy(self.cookies),
             query=fast_deepcopy(self.query),
             body=fast_deepcopy(self.body),
+            meta=self.meta,
             generation_time=self.generation_time,
             id=self.id,
             _auth=self._auth,

{schemathesis-3.38.7 → schemathesis-3.38.8}/src/schemathesis/specs/openapi/checks.py

@@ -269,6 +269,20 @@ def positive_data_acceptance(ctx: CheckContext, response: GenericResponse, case:
     return None
 
 
+def missing_required_header(ctx: CheckContext, response: GenericResponse, case: Case) -> bool | None:
+    if (
+        case.meta
+        and case.meta.parameter_location == "header"
+        and case.meta.description
+        and case.meta.description.startswith("Missing ")
+    ):
+        config = ctx.config.missing_required_header
+        allowed_statuses = expand_status_codes(config.allowed_statuses or [])
+        if response.status_code not in allowed_statuses:
+            raise AssertionError(f"Unexpected response status for a missing header: {response.status_code}")
+    return None
+
+
 def has_only_additional_properties_in_non_body_parameters(case: Case) -> bool:
     # Check if the case contains only additional properties in query, headers, or cookies.
     # This function is used to determine if negation is solely in the form of extra properties,

{schemathesis-3.38.7 → schemathesis-3.38.8}/test/cli/__snapshots__/test_commands/test_run_output[args24].raw

@@ -24,6 +24,10 @@ Experimental options:
                                             schema-analysis, stateful-test-
                                             runner, stateful-only, coverage-
                                             phase, positive_data_acceptance]
+  --experimental-missing-required-header-allowed-statuses 
+                                            Comma-separated list of status codes
+                                            expected for test cases with a
+                                            missing required header
   --experimental-positive-data-acceptance-allowed-statuses 
                                             Comma-separated list of status codes
                                             considered as successful responses

{schemathesis-3.38.7 → schemathesis-3.38.8}/test/cli/test_commands.py

@@ -1959,7 +1959,6 @@ def test_long_operation_output(ctx, cli):
     result = cli.run(str(schema_path), "--dry-run")
     # Then this operation name should be truncated
     assert result.exit_code == ExitCode.OK
-    print(result.stdout)
     assert "GET /aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[...] . [ 50%]" in result.stdout
     assert "GET /aaaaaaaaaa .                                                         [100%]" in result.stdout
 

{schemathesis-3.38.7 → schemathesis-3.38.8}/test/coverage/test_combinations.py

@@ -65,17 +65,17 @@ def assert_not_conform(values: list, schema: dict):
 
 @pytest.fixture
 def ctx():
-    return CoverageContext()
+    return CoverageContext(location="query")
 
 
 @pytest.fixture
 def pctx():
-    return CoverageContext(data_generation_methods=[DataGenerationMethod.positive])
+    return CoverageContext(location="query", data_generation_methods=[DataGenerationMethod.positive])
 
 
 @pytest.fixture
 def nctx():
-    return CoverageContext(data_generation_methods=[DataGenerationMethod.negative])
+    return CoverageContext(location="query", data_generation_methods=[DataGenerationMethod.negative])
 
 
 @pytest.mark.parametrize(
@@ -1011,7 +1011,6 @@ def test_negative_combinators(nctx, schema, expected):
             assert_not_conform(covered, schema)
             break
     else:
-        print(covered)
         pytest.fail("Expected value didn't match")