schemathesis 3.25.5__py3-none-any.whl → 4.0.0a1__py3-none-any.whl

schemathesis/specs/graphql/__init__.py

@@ -1 +0,0 @@
-from .loaders import from_asgi, from_dict, from_file, from_path, from_url, from_wsgi

schemathesis/specs/graphql/_cache.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ...schemas import APIOperation, APIOperationMap
+
+
+@dataclass
+class OperationCache:
+    _maps: dict[str, APIOperationMap] = field(default_factory=dict)
+    _operations: dict[str, APIOperation] = field(default_factory=dict)
+
+    def get_map(self, key: str) -> APIOperationMap | None:
+        return self._maps.get(key)
+
+    def insert_map(self, key: str, value: APIOperationMap) -> None:
+        self._maps[key] = value
+
+    def get_operation(self, key: str) -> APIOperation | None:
+        return self._operations.get(key)
+
+    def insert_operation(self, key: str, value: APIOperation) -> None:
+        self._operations[key] = value

schemathesis/specs/graphql/nodes.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:

schemathesis/specs/graphql/scalars.py

@@ -3,8 +3,7 @@ from __future__ import annotations
 from functools import lru_cache
 from typing import TYPE_CHECKING
 
-
-from ...exceptions import UsageError
+from schemathesis.core.errors import IncorrectUsage
 
 if TYPE_CHECKING:
     import graphql
@@ -22,18 +21,21 @@ def scalar(name: str, strategy: st.SearchStrategy[graphql.ValueNode]) -> None:
     from hypothesis.strategies import SearchStrategy
 
     if not isinstance(name, str):
-        raise UsageError(f"Scalar name {name!r} must be a string")
+        raise IncorrectUsage(f"Scalar name {name!r} must be a string")
     if not isinstance(strategy, SearchStrategy):
-        raise UsageError(f"{strategy!r} must be a Hypothesis strategy which generates AST nodes matching this scalar")
+        raise IncorrectUsage(
+            f"{strategy!r} must be a Hypothesis strategy which generates AST nodes matching this scalar"
+        )
     CUSTOM_SCALARS[name] = strategy
 
 
 @lru_cache
 def get_extra_scalar_strategies() -> dict[str, st.SearchStrategy]:
     """Get all extra GraphQL strategies."""
-    from . import nodes
     from hypothesis import strategies as st
 
+    from . import nodes
+
     dates = st.dates().map(str)
     times = st.times().map("%sZ".__mod__)
 

schemathesis/specs/graphql/schemas.py

@@ -1,54 +1,56 @@
 from __future__ import annotations
 
 import enum
+import time
 from dataclasses import dataclass, field
 from difflib import get_close_matches
 from enum import unique
+from types import SimpleNamespace
 from typing import (
+    TYPE_CHECKING,
     Any,
     Callable,
     Generator,
-    Sequence,
-    TypeVar,
-    cast,
-    TYPE_CHECKING,
-    NoReturn,
-    MutableMapping,
     Iterator,
+    Mapping,
+    NoReturn,
+    Union,
+    cast,
 )
-from urllib.parse import urlsplit, urlunsplit
+from urllib.parse import urlsplit
 
 import graphql
-import requests
-from graphql import GraphQLNamedType
 from hypothesis import strategies as st
-from hypothesis.strategies import SearchStrategy
 from hypothesis_graphql import strategies as gql_st
 from requests.structures import CaseInsensitiveDict
 
-from ..openapi.constants import LOCATION_TO_CONTAINER
-from ... import auths
-from ...auths import AuthStorage
-from ...checks import not_a_server_error
-from ...constants import NOT_SET
-from ...exceptions import OperationSchemaError, OperationNotFound
-from ...generation import DataGenerationMethod, GenerationConfig
-from ...hooks import (
-    GLOBAL_HOOK_DISPATCHER,
-    HookContext,
-    HookDispatcher,
-    apply_to_all_dispatchers,
-    should_skip_operation,
+from schemathesis.core import NOT_SET, NotSet, Specification
+from schemathesis.core.errors import InvalidSchema, OperationNotFound
+from schemathesis.core.result import Ok, Result
+from schemathesis.generation.case import Case
+from schemathesis.generation.meta import (
+    CaseMetadata,
+    ComponentInfo,
+    ComponentKind,
+    ExplicitPhaseData,
+    GeneratePhaseData,
+    GenerationInfo,
+    PhaseInfo,
+    TestPhase,
 )
-from ...internal.result import Ok, Result
-from ...models import APIOperation, Case, CheckFunction, OperationDefinition
-from ...schemas import BaseSchema, APIOperationMap
-from ...stateful import Stateful, StatefulTest
-from ...types import Body, Cookies, Headers, NotSet, PathParameters, Query
+
+from ... import auths
+from ...generation import GenerationConfig, GenerationMode
+from ...hooks import HookContext, HookDispatcher, apply_to_all_dispatchers
+from ...schemas import APIOperation, APIOperationMap, ApiOperationsCount, BaseSchema, OperationDefinition
+from ..openapi.constants import LOCATION_TO_CONTAINER
+from ._cache import OperationCache
 from .scalars import CUSTOM_SCALARS, get_extra_scalar_strategies
 
 if TYPE_CHECKING:
-    from ...transports.responses import GenericResponse
+    from hypothesis.strategies import SearchStrategy
+
+    from schemathesis.auths import AuthStorage
 
 
 @unique
@@ -58,73 +60,13 @@ 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)
-        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},
-        }
-
-    def validate_response(
-        self,
-        response: GenericResponse,
-        checks: tuple[CheckFunction, ...] = (),
-        additional_checks: tuple[CheckFunction, ...] = (),
-        excluded_checks: tuple[CheckFunction, ...] = (),
-        code_sample_style: str | None = None,
-    ) -> None:
-        checks = checks or (not_a_server_error,)
-        checks += additional_checks
-        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)
-
-
-@dataclass
 class GraphQLOperationDefinition(OperationDefinition):
     field_name: str
     type_: graphql.GraphQLType
     root_type: RootType
 
+    def _repr_pretty_(self, *args: Any, **kwargs: Any) -> None: ...
+
     @property
     def is_query(self) -> bool:
         return self.root_type == RootType.QUERY
@@ -136,9 +78,37 @@ class GraphQLOperationDefinition(OperationDefinition):
 
 @dataclass
 class GraphQLSchema(BaseSchema):
+    _operation_cache: OperationCache = field(default_factory=OperationCache)
+
     def __repr__(self) -> str:
         return f"<{self.__class__.__name__}>"
 
+    def __iter__(self) -> Iterator[str]:
+        schema = self.client_schema
+        for operation_type in (
+            schema.query_type,
+            schema.mutation_type,
+        ):
+            if operation_type is not None:
+                yield operation_type.name
+
+    def _get_operation_map(self, key: str) -> APIOperationMap:
+        cache = self._operation_cache
+        map = cache.get_map(key)
+        if map is not None:
+            return map
+        schema = self.client_schema
+        for root_type, operation_type in (
+            (RootType.QUERY, schema.query_type),
+            (RootType.MUTATION, schema.mutation_type),
+        ):
+            if operation_type and operation_type.name == key:
+                map = APIOperationMap(self, {})
+                map._data = FieldMap(map, root_type, operation_type)
+                cache.insert_map(key, map)
+                return map
+        raise KeyError(key)
+
     def on_missing_operation(self, item: str, exc: KeyError) -> NoReturn:
         raw_schema = self.raw_schema["__schema"]
         type_names = [type_def["name"] for type_def in raw_schema.get("types", [])]
@@ -148,25 +118,12 @@ class GraphQLSchema(BaseSchema):
             message += f". Did you mean `{matches[0]}`?"
         raise OperationNotFound(message=message, item=item) from exc
 
-    def _store_operations(
-        self, operations: Generator[Result[APIOperation, OperationSchemaError], None, None]
-    ) -> dict[str, APIOperationMap]:
-        output: dict[str, APIOperationMap] = {}
-        for result in operations:
-            if isinstance(result, Ok):
-                operation = result.ok()
-                definition = cast(GraphQLOperationDefinition, operation.definition)
-                type_name = definition.type_.name if isinstance(definition.type_, GraphQLNamedType) else "Unknown"
-                for_type = output.setdefault(type_name, APIOperationMap(FieldMap()))
-                for_type[definition.field_name] = operation
-        return output
-
     def get_full_path(self, path: str) -> str:
         return self.base_path
 
     @property
-    def verbose_name(self) -> str:
-        return "GraphQL"
+    def specification(self) -> Specification:
+        return Specification.graphql(version="")
 
     @property
     def client_schema(self) -> graphql.GraphQLSchema:
@@ -183,18 +140,30 @@ class GraphQLSchema(BaseSchema):
     def _get_base_path(self) -> str:
         return cast(str, urlsplit(self.location).path)
 
-    @property
-    def operations_count(self) -> int:
+    def _do_count_operations(self) -> ApiOperationsCount:
+        counter = ApiOperationsCount()
         raw_schema = self.raw_schema["__schema"]
-        total = 0
+        dummy_operation = APIOperation(
+            base_url=self.get_base_url(),
+            path=self.base_path,
+            label="",
+            method="POST",
+            schema=self,
+            definition=None,  # type: ignore
+        )
+
         for type_name in ("queryType", "mutationType"):
             type_def = raw_schema.get(type_name)
             if type_def is not None:
                 query_type_name = type_def["name"]
                 for type_def in raw_schema.get("types", []):
                     if type_def["name"] == query_type_name:
-                        total += len(type_def["fields"])
-        return total
+                        for field in type_def["fields"]:
+                            counter.total += 1
+                            dummy_operation.label = f"{query_type_name}.{field['name']}"
+                            if not self._should_skip(dummy_operation):
+                                counter.selected += 1
+        return counter
 
     @property
     def links_count(self) -> int:
@@ -202,8 +171,8 @@ class GraphQLSchema(BaseSchema):
         return 0
 
     def get_all_operations(
-        self, hooks: HookDispatcher | None = None
-    ) -> Generator[Result[APIOperation, OperationSchemaError], None, None]:
+        self, generation_config: GenerationConfig | None = None
+    ) -> Generator[Result[APIOperation, InvalidSchema], None, None]:
         schema = self.client_schema
         for root_type, operation_type in (
             (RootType.QUERY, schema.query_type),
@@ -211,114 +180,136 @@ class GraphQLSchema(BaseSchema):
         ):
             if operation_type is None:
                 continue
-            for field_name, definition in operation_type.fields.items():
-                operation: APIOperation = APIOperation(
-                    base_url=self.get_base_url(),
-                    path=self.base_path,
-                    verbose_name=f"{operation_type.name}.{field_name}",
-                    method="POST",
-                    app=self.app,
-                    schema=self,
-                    # Parameters are not yet supported
-                    definition=GraphQLOperationDefinition(
-                        raw=definition,
-                        resolved=definition,
-                        scope="",
-                        parameters=[],
-                        type_=operation_type,
-                        field_name=field_name,
-                        root_type=root_type,
-                    ),
-                    case_cls=GraphQLCase,
-                )
-                context = HookContext(operation=operation)
-                if (
-                    should_skip_operation(GLOBAL_HOOK_DISPATCHER, context)
-                    or should_skip_operation(self.hooks, context)
-                    or (hooks and should_skip_operation(hooks, context))
-                ):
+            for field_name, field_ in operation_type.fields.items():
+                operation = self._build_operation(root_type, operation_type, field_name, field_)
+                if self._should_skip(operation):
                     continue
                 yield Ok(operation)
 
+    def _should_skip(
+        self,
+        operation: APIOperation,
+        _ctx_cache: SimpleNamespace = SimpleNamespace(operation=None),
+    ) -> bool:
+        _ctx_cache.operation = operation
+        return not self.filter_set.match(_ctx_cache)
+
+    def _build_operation(
+        self,
+        root_type: RootType,
+        operation_type: graphql.GraphQLObjectType,
+        field_name: str,
+        field: graphql.GraphQlField,
+    ) -> APIOperation:
+        return APIOperation(
+            base_url=self.get_base_url(),
+            path=self.base_path,
+            label=f"{operation_type.name}.{field_name}",
+            method="POST",
+            app=self.app,
+            schema=self,
+            # Parameters are not yet supported
+            definition=GraphQLOperationDefinition(
+                raw=field,
+                resolved=field,
+                scope="",
+                type_=operation_type,
+                field_name=field_name,
+                root_type=root_type,
+            ),
+        )
+
     def get_case_strategy(
         self,
         operation: APIOperation,
         hooks: HookDispatcher | None = None,
         auth_storage: AuthStorage | None = None,
-        data_generation_method: DataGenerationMethod = DataGenerationMethod.default(),
+        generation_mode: GenerationMode = GenerationMode.default(),
         generation_config: GenerationConfig | None = None,
         **kwargs: Any,
     ) -> SearchStrategy:
-        return get_case_strategy(
+        return graphql_cases(
             operation=operation,
-            client_schema=self.client_schema,
             hooks=hooks,
             auth_storage=auth_storage,
-            data_generation_method=data_generation_method,
+            generation_mode=generation_mode,
             generation_config=generation_config or self.generation_config,
             **kwargs,
         )
 
-    def get_strategies_from_examples(self, operation: APIOperation) -> list[SearchStrategy[Case]]:
-        return []
-
-    def get_stateful_tests(
-        self, response: GenericResponse, operation: APIOperation, stateful: Stateful | None
-    ) -> Sequence[StatefulTest]:
+    def get_strategies_from_examples(self, operation: APIOperation, **kwargs: Any) -> list[SearchStrategy[Case]]:
         return []
 
     def make_case(
         self,
         *,
-        case_cls: type[C],
         operation: APIOperation,
-        path_parameters: PathParameters | None = None,
-        headers: Headers | None = None,
-        cookies: Cookies | None = None,
-        query: Query | None = None,
-        body: Body | NotSet = NOT_SET,
+        method: str | None = None,
+        path: str | None = None,
+        path_parameters: dict[str, Any] | None = None,
+        headers: dict[str, Any] | None = None,
+        cookies: dict[str, Any] | None = None,
+        query: dict[str, Any] | None = None,
+        body: list | dict[str, Any] | str | int | float | bool | bytes | NotSet = NOT_SET,
         media_type: str | None = None,
-    ) -> C:
-        return case_cls(
+        meta: CaseMetadata | None = None,
+    ) -> Case:
+        return Case(
             operation=operation,
+            method=method or operation.method.upper(),
+            path=path or operation.path,
             path_parameters=path_parameters,
             headers=CaseInsensitiveDict(headers) if headers is not None else headers,
             cookies=cookies,
             query=query,
             body=body,
-            media_type=media_type,
+            media_type=media_type or "application/json",
+            meta=meta,
         )
 
     def get_tags(self, operation: APIOperation) -> list[str] | None:
         return None
 
+    def validate(self) -> None:
+        return None
+
 
 @dataclass
-class FieldMap(MutableMapping):
+class FieldMap(Mapping):
     """Container for accessing API operations.
 
     Provides a more specific error message if API operation is not found.
     """
 
-    data: dict[str, APIOperation] = field(default_factory=dict)
-
-    def __setitem__(self, key: str, value: APIOperation) -> None:
-        self.data[key] = value
+    _parent: APIOperationMap
+    _root_type: RootType
+    _operation_type: graphql.GraphQLObjectType
 
-    def __delitem__(self, key: str) -> None:
-        del self.data[key]
+    __slots__ = ("_parent", "_root_type", "_operation_type")
 
     def __len__(self) -> int:
-        return len(self.data)
+        return len(self._operation_type.fields)
 
     def __iter__(self) -> Iterator[str]:
-        return iter(self.data)
+        return iter(self._operation_type.fields)
+
+    def _init_operation(self, field_name: str) -> APIOperation:
+        schema = cast(GraphQLSchema, self._parent._schema)
+        cache = schema._operation_cache
+        operation = cache.get_operation(field_name)
+        if operation is not None:
+            return operation
+        operation_type = self._operation_type
+        field_ = operation_type.fields[field_name]
+        operation = schema._build_operation(self._root_type, operation_type, field_name, field_)
+        cache.insert_operation(field_name, operation)
+        return operation
 
     def __getitem__(self, item: str) -> APIOperation:
         try:
-            return self.data[item]
+            return self._init_operation(item)
         except KeyError as exc:
-            field_names = [operation.definition.field_name for operation in self.data.values()]  # type: ignore[attr-defined]
+            field_names = list(self._operation_type.fields)
             matches = get_close_matches(item, field_names)
             message = f"`{item}` field not found"
             if matches:
@@ -327,48 +318,77 @@ class FieldMap(MutableMapping):
 
 
 @st.composite  # type: ignore
-def get_case_strategy(
+def graphql_cases(
     draw: Callable,
+    *,
     operation: APIOperation,
-    client_schema: graphql.GraphQLSchema,
     hooks: HookDispatcher | None = None,
-    auth_storage: AuthStorage | None = None,
-    data_generation_method: DataGenerationMethod = DataGenerationMethod.default(),
-    generation_config: GenerationConfig | None = None,
-    **kwargs: Any,
+    auth_storage: auths.AuthStorage | None = None,
+    generation_mode: GenerationMode = GenerationMode.default(),
+    generation_config: GenerationConfig,
+    path_parameters: NotSet | dict[str, Any] = NOT_SET,
+    headers: NotSet | dict[str, Any] = NOT_SET,
+    cookies: NotSet | dict[str, Any] = NOT_SET,
+    query: NotSet | dict[str, Any] = NOT_SET,
+    body: Any = NOT_SET,
+    media_type: str | None = None,
+    phase: TestPhase = TestPhase.GENERATE,
 ) -> Any:
+    start = time.monotonic()
     definition = cast(GraphQLOperationDefinition, operation.definition)
     strategy_factory = {
         RootType.QUERY: gql_st.queries,
         RootType.MUTATION: gql_st.mutations,
     }[definition.root_type]
     hook_context = HookContext(operation)
-    generation_config = generation_config or GenerationConfig()
     custom_scalars = {**get_extra_scalar_strategies(), **CUSTOM_SCALARS}
     strategy = strategy_factory(
-        client_schema,
+        operation.schema.client_schema,  # type: ignore[attr-defined]
         fields=[definition.field_name],
         custom_scalars=custom_scalars,
         print_ast=_noop,  # type: ignore
         allow_x00=generation_config.allow_x00,
+        allow_null=generation_config.graphql_allow_null,
         codec=generation_config.codec,
     )
     strategy = apply_to_all_dispatchers(operation, hook_context, hooks, strategy, "body").map(graphql.print_ast)
     body = draw(strategy)
 
-    path_parameters_ = _generate_parameter("path", draw, operation, hook_context, hooks)
-    headers_ = _generate_parameter("header", draw, operation, hook_context, hooks)
-    cookies_ = _generate_parameter("cookie", draw, operation, hook_context, hooks)
-    query_ = _generate_parameter("query", draw, operation, hook_context, hooks)
-
-    instance = GraphQLCase(
+    path_parameters_ = _generate_parameter("path", path_parameters, draw, operation, hook_context, hooks)
+    headers_ = _generate_parameter("header", headers, draw, operation, hook_context, hooks)
+    cookies_ = _generate_parameter("cookie", cookies, draw, operation, hook_context, hooks)
+    query_ = _generate_parameter("query", query, draw, operation, hook_context, hooks)
+
+    _phase_data = {
+        TestPhase.EXPLICIT: ExplicitPhaseData(),
+        TestPhase.GENERATE: GeneratePhaseData(),
+    }[phase]
+    phase_data = cast(Union[ExplicitPhaseData, GeneratePhaseData], _phase_data)
+    instance = operation.Case(
         path_parameters=path_parameters_,
         headers=headers_,
         cookies=cookies_,
         query=query_,
         body=body,
-        operation=operation,
-        data_generation_method=data_generation_method,
+        meta=CaseMetadata(
+            generation=GenerationInfo(
+                time=time.monotonic() - start,
+                mode=generation_mode,
+            ),
+            phase=PhaseInfo(name=phase, data=phase_data),
+            components={
+                kind: ComponentInfo(mode=generation_mode)
+                for kind, value in [
+                    (ComponentKind.QUERY, query_),
+                    (ComponentKind.PATH_PARAMETERS, path_parameters_),
+                    (ComponentKind.HEADERS, headers_),
+                    (ComponentKind.COOKIES, cookies_),
+                    (ComponentKind.BODY, body),
+                ]
+                if value is not NOT_SET
+            },
+        ),
+        media_type=media_type or "application/json",
     )  # type: ignore
     context = auths.AuthContext(
         operation=operation,
@@ -379,11 +399,19 @@ def get_case_strategy(
 
 
 def _generate_parameter(
-    location: str, draw: Callable, operation: APIOperation, context: HookContext, hooks: HookDispatcher | None
+    location: str,
+    explicit: NotSet | dict[str, Any],
+    draw: Callable,
+    operation: APIOperation,
+    context: HookContext,
+    hooks: HookDispatcher | None,
 ) -> Any:
     # Schemathesis does not generate anything but `body` for GraphQL, hence use `None`
     container = LOCATION_TO_CONTAINER[location]
-    strategy = apply_to_all_dispatchers(operation, context, hooks, st.none(), container)
+    if isinstance(explicit, NotSet):
+        strategy = apply_to_all_dispatchers(operation, context, hooks, st.none(), container)
+    else:
+        strategy = apply_to_all_dispatchers(operation, context, hooks, st.just(explicit), container)
     return draw(strategy)