schemathesis 3.26.2__py3-none-any.whl → 3.27.0__py3-none-any.whl

schemathesis/runner/impl/core.py

@@ -21,6 +21,8 @@ from jsonschema.exceptions import SchemaError as JsonSchemaError
 from jsonschema.exceptions import ValidationError
 from requests.auth import HTTPDigestAuth, _basic_auth_str
 
+from schemathesis.transports import RequestsTransport
+
 from ... import failures, hooks
 from ..._compat import MultipleFailures
 from ..._hypothesis import (
@@ -849,7 +851,7 @@ def _network_test(
         response = case.call(**kwargs)
     except CheckFailed as exc:
         check_name = "request_timeout"
-        requests_kwargs = case.as_requests_kwargs(base_url=case.get_full_base_url(), headers=headers)
+        requests_kwargs = RequestsTransport().serialize_case(case, base_url=case.get_full_base_url(), headers=headers)
         request = requests.Request(**requests_kwargs).prepare()
         elapsed = cast(float, timeout)  # It is defined and not empty, since the exception happened
         check_result = result.add_failure(
@@ -939,14 +941,14 @@ def _wsgi_test(
     feedback: Feedback,
     max_response_time: int | None,
 ) -> WSGIResponse:
+    from ...transports.responses import WSGIResponse
+
     with catching_logs(LogCaptureHandler(), level=logging.DEBUG) as recorded:
-        start = time.monotonic()
         hook_context = HookContext(operation=case.operation)
-        kwargs = {"headers": headers}
+        kwargs: dict[str, Any] = {"headers": headers}
         hooks.dispatch("process_call_kwargs", hook_context, case, kwargs)
-        response = case.call_wsgi(**kwargs)
-        elapsed = time.monotonic() - start
-    context = TargetContext(case=case, response=response, response_time=elapsed)
+        response = cast(WSGIResponse, case.call(**kwargs))
+    context = TargetContext(case=case, response=response, response_time=response.elapsed.total_seconds())
     run_targets(targets, context)
     result.logs.extend(recorded.records)
     status = Status.success
@@ -967,7 +969,7 @@ def _wsgi_test(
     finally:
         feedback.add_test_case(case, response)
         if store_interactions:
-            result.store_wsgi_response(case, response, headers, elapsed, status, check_results)
+            result.store_wsgi_response(case, response, headers, response.elapsed.total_seconds(), status, check_results)
     return response
 
 
@@ -1037,7 +1039,7 @@ def _asgi_test(
     hook_context = HookContext(operation=case.operation)
     kwargs: dict[str, Any] = {"headers": headers}
     hooks.dispatch("process_call_kwargs", hook_context, case, kwargs)
-    response = case.call_asgi(**kwargs)
+    response = case.call(**kwargs)
     context = TargetContext(case=case, response=response, response_time=response.elapsed.total_seconds())
     run_targets(targets, context)
     status = Status.success

schemathesis/runner/serialization.py

@@ -4,28 +4,30 @@ They all consist of primitive types and don't have references to schemas, app, e
 """
 
 from __future__ import annotations
+
 import logging
 import re
+import textwrap
 from dataclasses import dataclass, field
-from typing import Any, TYPE_CHECKING, cast
+from typing import TYPE_CHECKING, Any, cast
 
-from ..transports import serialize_payload
 from ..code_samples import get_excluded_headers
 from ..exceptions import (
+    BodyInGetRequestError,
+    DeadlineExceeded,
     FailureContext,
     InternalError,
-    make_unique_by_key,
-    format_exception,
-    extract_requests_exception_details,
-    RuntimeErrorType,
-    DeadlineExceeded,
-    OperationSchemaError,
-    BodyInGetRequestError,
     InvalidRegularExpression,
+    OperationSchemaError,
+    RuntimeErrorType,
     SerializationError,
     UnboundPrefixError,
+    extract_requests_exception_details,
+    format_exception,
+    make_unique_by_key,
 )
 from ..models import Case, Check, Interaction, Request, Response, Status, TestResult
+from ..transports import serialize_payload
 
 if TYPE_CHECKING:
     import hypothesis.errors
@@ -108,6 +110,7 @@ class SerializedCheck:
     @classmethod
     def from_check(cls, check: Check) -> SerializedCheck:
         import requests
+
         from ..transports.responses import WSGIResponse
 
         if check.response is not None:
@@ -140,6 +143,25 @@ class SerializedCheck:
             history=history,
         )
 
+    @property
+    def title(self) -> str:
+        if self.context is not None:
+            return self.context.title
+        return f"Custom check failed: `{self.name}`"
+
+    @property
+    def formatted_message(self) -> str | None:
+        if self.context is not None:
+            if self.context.message:
+                message = self.context.message
+            else:
+                message = None
+        else:
+            message = self.message
+        if message is not None:
+            message = textwrap.indent(message, prefix="    ")
+        return message
+
 
 def _get_headers(headers: dict[str, Any] | CaseInsensitiveDict) -> dict[str, str]:
     return {key: value[0] for key, value in headers.items() if key not in get_excluded_headers()}
@@ -203,8 +225,8 @@ class SerializedError:
 
     @classmethod
     def from_exception(cls, exception: Exception) -> SerializedError:
-        import requests
         import hypothesis.errors
+        import requests
         from hypothesis import HealthCheck
 
         title = "Runtime Error"

schemathesis/schemas.py

@@ -8,11 +8,13 @@ They give only static definitions of paths.
 """
 
 from __future__ import annotations
+
 from collections.abc import Mapping, MutableMapping
 from contextlib import nullcontext
 from dataclasses import dataclass, field
 from functools import lru_cache
 from typing import (
+    TYPE_CHECKING,
     Any,
     Callable,
     ContextManager,
@@ -22,7 +24,6 @@ from typing import (
     NoReturn,
     Sequence,
     TypeVar,
-    TYPE_CHECKING,
 )
 from urllib.parse import quote, unquote, urljoin, urlparse, urlsplit, urlunsplit
 
@@ -30,23 +31,23 @@ import hypothesis
 from hypothesis.strategies import SearchStrategy
 from pyrate_limiter import Limiter
 
-from .constants import NOT_SET
+from ._dependency_versions import IS_PYRATE_LIMITER_ABOVE_3
 from ._hypothesis import create_test
 from .auths import AuthStorage
 from .code_samples import CodeSampleStyle
+from .constants import NOT_SET
+from .exceptions import OperationSchemaError, UsageError
 from .generation import (
     DEFAULT_DATA_GENERATION_METHODS,
     DataGenerationMethod,
     DataGenerationMethodInput,
     GenerationConfig,
 )
-from ._dependency_versions import IS_PYRATE_LIMITER_ABOVE_3
-from .exceptions import OperationSchemaError, UsageError
 from .hooks import HookContext, HookDispatcher, HookScope, dispatch
-from .internal.result import Result, Ok
+from .internal.result import Ok, Result
 from .models import APIOperation, Case
-from .stateful.state_machine import APIStateMachine
 from .stateful import Stateful, StatefulTest
+from .stateful.state_machine import APIStateMachine
 from .types import (
     Body,
     Cookies,
@@ -58,9 +59,10 @@ from .types import (
     PathParameters,
     Query,
 )
-from .utils import PARAMETRIZE_MARKER, GivenInput, given_proxy, combine_strategies
+from .utils import PARAMETRIZE_MARKER, GivenInput, combine_strategies, given_proxy
 
 if TYPE_CHECKING:
+    from .transports import Transport
     from .transports.responses import GenericResponse
 
 
@@ -75,6 +77,7 @@ def get_full_path(base_path: str, path: str) -> str:
 @dataclass(eq=False)
 class BaseSchema(Mapping):
     raw_schema: dict[str, Any]
+    transport: Transport
     location: str | None = None
     base_url: str | None = None
     method: Filter | None = None
@@ -346,6 +349,7 @@ class BaseSchema(Mapping):
             code_sample_style=code_sample_style,  # type: ignore
             rate_limiter=rate_limiter,  # type: ignore
             sanitize_output=sanitize_output,  # type: ignore
+            transport=self.transport,
         )
 
     def get_local_hook_dispatcher(self) -> HookDispatcher | None:

schemathesis/specs/graphql/loaders.py

@@ -234,6 +234,7 @@ def from_dict(
     :return: GraphQLSchema
     """
     from .schemas import GraphQLSchema
+    from ... import transports
 
     _code_sample_style = CodeSampleStyle.from_str(code_sample_style)
     hook_context = HookContext()
@@ -252,6 +253,7 @@ def from_dict(
         code_sample_style=_code_sample_style,
         rate_limiter=rate_limiter,
         sanitize_output=sanitize_output,
+        transport=transports.get(app),
     )  # type: ignore
     dispatch("after_load_schema", hook_context, instance)
     return instance

schemathesis/specs/graphql/schemas.py

@@ -20,7 +20,6 @@ from typing import (
 from urllib.parse import urlsplit, urlunsplit
 
 import graphql
-import requests
 from graphql import GraphQLNamedType
 from hypothesis import strategies as st
 from hypothesis.strategies import SearchStrategy
@@ -60,39 +59,15 @@ class RootType(enum.Enum):
 
 @dataclass(repr=False)
 class GraphQLCase(Case):
-    def as_requests_kwargs(self, base_url: str | None = None, headers: dict[str, str] | None = None) -> dict[str, Any]:
-        final_headers = self._get_headers(headers)
+    def _get_url(self, base_url: str | None) -> str:
         base_url = self._get_base_url(base_url)
         # Replace the path, in case if the user provided any path parameters via hooks
         parts = list(urlsplit(base_url))
         parts[2] = self.formatted_path
-        kwargs: dict[str, Any] = {
-            "method": self.method,
-            "url": urlunsplit(parts),
-            "headers": final_headers,
-            "cookies": self.cookies,
-            "params": self.query,
-        }
-        # There is no direct way to have bytes here, but it is a useful pattern to support.
-        # It also unifies GraphQLCase with its Open API counterpart where bytes may come from external examples
-        if isinstance(self.body, bytes):
-            kwargs["data"] = self.body
-            # Assume that the payload is JSON, not raw GraphQL queries
-            kwargs["headers"].setdefault("Content-Type", "application/json")
-        else:
-            kwargs["json"] = {"query": self.body}
-        return kwargs
-
-    def as_werkzeug_kwargs(self, headers: dict[str, str] | None = None) -> dict[str, Any]:
-        final_headers = self._get_headers(headers)
-        return {
-            "method": self.method,
-            "path": self.operation.schema.get_full_path(self.formatted_path),
-            # Convert to a regular dictionary, as we use `CaseInsensitiveDict` which is not supported by Werkzeug
-            "headers": dict(final_headers),
-            "query_string": self.query,
-            "json": {"query": self.body},
-        }
+        return urlunsplit(parts)
+
+    def _get_body(self) -> Body | NotSet:
+        return self.body if isinstance(self.body, (NotSet, bytes)) else {"query": self.body}
 
     def validate_response(
         self,
@@ -107,15 +82,6 @@ class GraphQLCase(Case):
         checks = tuple(check for check in checks if check not in excluded_checks)
         return super().validate_response(response, checks, code_sample_style=code_sample_style)
 
-    def call_asgi(
-        self,
-        app: Any = None,
-        base_url: str | None = None,
-        headers: dict[str, str] | None = None,
-        **kwargs: Any,
-    ) -> requests.Response:
-        return super().call_asgi(app=app, base_url=base_url, headers=headers, **kwargs)
-
 
 C = TypeVar("C", bound=Case)
 
@@ -287,7 +253,7 @@ class GraphQLSchema(BaseSchema):
             cookies=cookies,
             query=query,
             body=body,
-            media_type=media_type,
+            media_type=media_type or "application/json",
             generation_time=0.0,
         )
 
@@ -373,6 +339,7 @@ def get_case_strategy(
         operation=operation,
         data_generation_method=data_generation_method,
         generation_time=time.monotonic() - start,
+        media_type="application/json",
     )  # type: ignore
     context = auths.AuthContext(
         operation=operation,

schemathesis/specs/openapi/loaders.py

@@ -304,6 +304,7 @@ def from_dict(
     :param dict raw_schema: A schema to load.
     """
     from .schemas import OpenApi30, SwaggerV20
+    from ... import transports
 
     if not isinstance(raw_schema, dict):
         raise SchemaError(SchemaErrorType.OPEN_API_INVALID_SCHEMA, SCHEMA_INVALID_ERROR)
@@ -338,6 +339,7 @@ def from_dict(
             location=location,
             rate_limiter=rate_limiter,
             sanitize_output=sanitize_output,
+            transport=transports.get(app),
         )
         dispatch("after_load_schema", hook_context, instance)
         return instance
@@ -379,6 +381,7 @@ def from_dict(
             location=location,
             rate_limiter=rate_limiter,
             sanitize_output=sanitize_output,
+            transport=transports.get(app),
         )
         dispatch("after_load_schema", hook_context, instance)
         return instance

schemathesis/stateful/state_machine.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import time
 import re
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Any, Callable, ClassVar
+from typing import TYPE_CHECKING, Any, ClassVar
 
 from hypothesis.errors import InvalidDefinition
 from hypothesis.stateful import RuleBasedStateMachine
@@ -189,13 +189,12 @@ class APIStateMachine(RuleBasedStateMachine):
         :return: Response from the application under test.
 
         Note that WSGI/ASGI applications are detected automatically in this method. Depending on the result of this
-        detection the state machine will call ``call``, ``call_wsgi`` or ``call_asgi`` methods.
+        detection the state machine will call the ``call`` method.
 
         Usually, you don't need to override this method unless you are building a different state machine on top of this
         one and want to customize the transport layer itself.
         """
-        method = self._get_call_method(case)
-        return method(**kwargs)
+        return case.call(**kwargs)
 
     def get_call_kwargs(self, case: Case) -> dict[str, Any]:
         """Create custom keyword arguments that will be passed to the :meth:`Case.call` method.
@@ -214,15 +213,6 @@ class APIStateMachine(RuleBasedStateMachine):
         """
         return {}
 
-    def _get_call_method(self, case: Case) -> Callable:
-        if case.app is not None:
-            from starlette.applications import Starlette
-
-            if isinstance(case.app, Starlette):
-                return case.call_asgi
-            return case.call_wsgi
-        return case.call
-
     def validate_response(
         self, response: GenericResponse, case: Case, additional_checks: tuple[CheckFunction, ...] = ()
     ) -> None:

schemathesis/transports/__init__.py

@@ -1,5 +1,311 @@
+from __future__ import annotations
+
 import base64
+import time
+from contextlib import contextmanager
+from dataclasses import dataclass
+from datetime import timedelta
+from typing import TYPE_CHECKING, Any, Generator, Protocol, TypeVar, cast
+from urllib.parse import urlparse
+
+from .. import failures
+from .._dependency_versions import IS_WERKZEUG_ABOVE_3
+from ..constants import DEFAULT_RESPONSE_TIMEOUT
+from ..exceptions import get_timeout_error
+from ..serializers import SerializerContext
+from ..types import Cookies, NotSet
+
+if TYPE_CHECKING:
+    import requests
+    import werkzeug
+    from _typeshed.wsgi import WSGIApplication
+    from starlette_testclient._testclient import ASGI2App, ASGI3App
+
+    from ..models import Case
+    from .responses import WSGIResponse
 
 
 def serialize_payload(payload: bytes) -> str:
     return base64.b64encode(payload).decode()
+
+
+def get(app: Any) -> Transport:
+    """Get transport to send the data to the application."""
+    from starlette.applications import Starlette
+
+    if app is None:
+        return RequestsTransport()
+    if isinstance(app, Starlette):
+        return ASGITransport(app=app)
+    return WSGITransport(app=app)
+
+
+S = TypeVar("S", contravariant=True)
+R = TypeVar("R", covariant=True)
+
+
+class Transport(Protocol[S, R]):
+    def serialize_case(
+        self,
+        case: Case,
+        *,
+        base_url: str | None = None,
+        headers: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+        cookies: dict[str, Any] | None = None,
+    ) -> dict[str, Any]:
+        raise NotImplementedError
+
+    def send(
+        self,
+        case: Case,
+        *,
+        session: S | None = None,
+        base_url: str | None = None,
+        headers: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+        cookies: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> R:
+        raise NotImplementedError
+
+
+class RequestsTransport:
+    def serialize_case(
+        self,
+        case: Case,
+        *,
+        base_url: str | None = None,
+        headers: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+        cookies: dict[str, Any] | None = None,
+    ) -> dict[str, Any]:
+        final_headers = case._get_headers(headers)
+        if case.media_type and case.media_type != "multipart/form-data" and not isinstance(case.body, NotSet):
+            # `requests` will handle multipart form headers with the proper `boundary` value.
+            if "content-type" not in final_headers:
+                final_headers["Content-Type"] = case.media_type
+        url = case._get_url(base_url)
+        serializer = case._get_serializer()
+        if serializer is not None and not isinstance(case.body, NotSet):
+            context = SerializerContext(case=case)
+            extra = serializer.as_requests(context, case._get_body())
+        else:
+            extra = {}
+        if case._auth is not None:
+            extra["auth"] = case._auth
+        additional_headers = extra.pop("headers", None)
+        if additional_headers:
+            # Additional headers, needed for the serializer
+            for key, value in additional_headers.items():
+                final_headers.setdefault(key, value)
+        data = {
+            "method": case.method,
+            "url": url,
+            "cookies": case.cookies,
+            "headers": final_headers,
+            "params": case.query,
+            **extra,
+        }
+        if params is not None:
+            _merge_dict_to(data, "params", params)
+        if cookies is not None:
+            _merge_dict_to(data, "cookies", cookies)
+        return data
+
+    def send(
+        self,
+        case: Case,
+        *,
+        session: requests.Session | None = None,
+        base_url: str | None = None,
+        headers: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+        cookies: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> requests.Response:
+        import requests
+        from urllib3.exceptions import ReadTimeoutError
+
+        data = self.serialize_case(case, base_url=base_url, headers=headers, params=params, cookies=cookies)
+        data.update(kwargs)
+        data.setdefault("timeout", DEFAULT_RESPONSE_TIMEOUT / 1000)
+        if session is None:
+            validate_vanilla_requests_kwargs(data)
+            session = requests.Session()
+            close_session = True
+        else:
+            close_session = False
+        verify = data.get("verify", True)
+        try:
+            with case.operation.schema.ratelimit():
+                response = session.request(**data)  # type: ignore
+        except (requests.Timeout, requests.ConnectionError) as exc:
+            if isinstance(exc, requests.ConnectionError):
+                if not isinstance(exc.args[0], ReadTimeoutError):
+                    raise
+                req = requests.Request(
+                    method=data["method"].upper(),
+                    url=data["url"],
+                    headers=data["headers"],
+                    files=data.get("files"),
+                    data=data.get("data") or {},
+                    json=data.get("json"),
+                    params=data.get("params") or {},
+                    auth=data.get("auth"),
+                    cookies=data["cookies"],
+                    hooks=data.get("hooks"),
+                )
+                request = session.prepare_request(req)
+            else:
+                request = cast(requests.PreparedRequest, exc.request)
+            timeout = 1000 * data["timeout"]  # It is defined and not empty, since the exception happened
+            code_message = case._get_code_message(case.operation.schema.code_sample_style, request, verify=verify)
+            message = f"The server failed to respond within the specified limit of {timeout:.2f}ms"
+            raise get_timeout_error(timeout)(
+                f"\n\n1. {failures.RequestTimeout.title}\n\n{message}\n\n{code_message}",
+                context=failures.RequestTimeout(message=message, timeout=timeout),
+            ) from None
+        response.verify = verify  # type: ignore[attr-defined]
+        if close_session:
+            session.close()
+        return response
+
+
+def _merge_dict_to(data: dict[str, Any], data_key: str, new: dict[str, Any]) -> None:
+    original = data[data_key] or {}
+    for key, value in new.items():
+        original[key] = value
+    data[data_key] = original
+
+
+def validate_vanilla_requests_kwargs(data: dict[str, Any]) -> None:
+    """Check arguments for `requests.Session.request`.
+
+    Some arguments can be valid for cases like ASGI integration, but at the same time they won't work for the regular
+    `requests` calls. In such cases we need to avoid an obscure error message, that comes from `requests`.
+    """
+    url = data["url"]
+    if not urlparse(url).netloc:
+        raise RuntimeError(
+            "The URL should be absolute, so Schemathesis knows where to send the data. \n"
+            f"If you use the ASGI integration, please supply your test client "
+            f"as the `session` argument to `call`.\nURL: {url}"
+        )
+
+
+@dataclass
+class ASGITransport(RequestsTransport):
+    app: ASGI2App | ASGI3App
+
+    def send(
+        self,
+        case: Case,
+        *,
+        session: requests.Session | None = None,
+        base_url: str | None = None,
+        headers: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+        cookies: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> requests.Response:
+        from starlette_testclient import TestClient as ASGIClient
+
+        if base_url is None:
+            base_url = case.get_full_base_url()
+        with ASGIClient(self.app) as client:
+            return super().send(
+                case, session=client, base_url=base_url, headers=headers, params=params, cookies=cookies, **kwargs
+            )
+
+
+@dataclass
+class WSGITransport:
+    app: WSGIApplication
+
+    def serialize_case(
+        self,
+        case: Case,
+        *,
+        base_url: str | None = None,
+        headers: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+        cookies: dict[str, Any] | None = None,
+    ) -> dict[str, Any]:
+        final_headers = case._get_headers(headers)
+        if case.media_type and not isinstance(case.body, NotSet):
+            # If we need to send a payload, then the Content-Type header should be set
+            final_headers["Content-Type"] = case.media_type
+        extra: dict[str, Any]
+        serializer = case._get_serializer()
+        if serializer is not None and not isinstance(case.body, NotSet):
+            context = SerializerContext(case=case)
+            extra = serializer.as_werkzeug(context, case._get_body())
+        else:
+            extra = {}
+        data = {
+            "method": case.method,
+            "path": case.operation.schema.get_full_path(case.formatted_path),
+            # Convert to a regular dictionary, as we use `CaseInsensitiveDict` which is not supported by Werkzeug
+            "headers": dict(final_headers),
+            "query_string": case.query,
+            **extra,
+        }
+        if params is not None:
+            _merge_dict_to(data, "query_string", params)
+        return data
+
+    def send(
+        self,
+        case: Case,
+        *,
+        session: Any = None,
+        base_url: str | None = None,
+        headers: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+        cookies: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> WSGIResponse:
+        import requests
+        import werkzeug
+
+        from .responses import WSGIResponse
+
+        application = kwargs.pop("app", self.app) or self.app
+        data = self.serialize_case(case, headers=headers, params=params)
+        data.update(kwargs)
+        client = werkzeug.Client(application, WSGIResponse)
+        cookies = {**(case.cookies or {}), **(cookies or {})}
+        with cookie_handler(client, cookies), case.operation.schema.ratelimit():
+            start = time.monotonic()
+            response = client.open(**data)
+            elapsed = time.monotonic() - start
+        requests_kwargs = RequestsTransport().serialize_case(
+            case,
+            base_url=case.get_full_base_url(),
+            headers=headers,
+            params=params,
+            cookies=cookies,
+        )
+        response.request = requests.Request(**requests_kwargs).prepare()
+        response.elapsed = timedelta(seconds=elapsed)
+        return response
+
+
+@contextmanager
+def cookie_handler(client: werkzeug.Client, cookies: Cookies | None) -> Generator[None, None, None]:
+    """Set cookies required for a call."""
+    if not cookies:
+        yield
+    else:
+        for key, value in cookies.items():
+            if IS_WERKZEUG_ABOVE_3:
+                client.set_cookie(key=key, value=value, domain="localhost")
+            else:
+                client.set_cookie("localhost", key=key, value=value)
+        yield
+        for key in cookies:
+            if IS_WERKZEUG_ABOVE_3:
+                client.delete_cookie(key=key, domain="localhost")
+            else:
+                client.delete_cookie("localhost", key=key)