robotframework-openapitools 0.1.3__py3-none-any.whl → 0.2.1__py3-none-any.whl

OpenApiLibCore/openapi_libcore.libspec

@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-04-05T14:47:48+00:00" specversion="5" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="377">
-<version>0.1.3</version>
+<keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-04-18T10:17:56+00:00" specversion="5" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="415">
+<version>0.2.1</version>
 <doc>&lt;p&gt;Main class providing the keywords and core logic to interact with an OpenAPI server.&lt;/p&gt;
 &lt;p&gt;Visit the &lt;a href="https://github.com/MarketSquare/robotframework-openapi-libcore"&gt;library page&lt;/a&gt; for an introduction.&lt;/p&gt;</doc>
 <tags>
 </tags>
 <inits>
-<init name="__init__" lineno="385">
+<init name="__init__" lineno="423">
 <arguments repr="source: str, origin: str = , base_path: str = , mappings_path: str | Path = , invalid_property_default_response: int = 422, default_id_property_name: str = id, faker_locale: str | List[str] | None = None, recursion_limit: int = 1, recursion_default: Any = {}, username: str = , password: str = , security_token: str = , auth: AuthBase | None = None, cert: str | Tuple[str, str] | None = None, verify_tls: bool | str | None = True, extra_headers: Dict[str, str] | None = None, cookies: Dict[str, str] | RequestsCookieJar | None = None, proxies: Dict[str, str] | None = None">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="source: str">
 <name>source</name>
@@ -144,7 +144,7 @@
 </init>
 </inits>
 <keywords>
-<kw name="Authorized Request" lineno="1490">
+<kw name="Authorized Request" lineno="1591">
 <arguments repr="url: str, method: str, params: Dict[str, Any] | None = None, headers: Dict[str, str] | None = None, json_data: Dict[str, Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | List[Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | str | int | float | bool | None = None">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -174,7 +174,7 @@
 &lt;p&gt;&amp;gt; Note: provided username / password or auth objects take precedence over token based security&lt;/p&gt;</doc>
 <shortdoc>Perform a request using the security token or authentication set in the library.</shortdoc>
 </kw>
-<kw name="Ensure In Use" lineno="1394">
+<kw name="Ensure In Use" lineno="1495">
 <arguments repr="url: str, resource_relation: IdReference">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -188,7 +188,7 @@
 <doc>&lt;p&gt;Ensure that the (right-most) &lt;span class="name"&gt;id&lt;/span&gt; of the resource referenced by the &lt;span class="name"&gt;url&lt;/span&gt; is used by the resource defined by the &lt;span class="name"&gt;resource_relation&lt;/span&gt;.&lt;/p&gt;</doc>
 <shortdoc>Ensure that the (right-most) `id` of the resource referenced by the `url` is used by the resource defined by the `resource_relation`.</shortdoc>
 </kw>
-<kw name="Get Ids From Url" lineno="783">
+<kw name="Get Ids From Url" lineno="866">
 <arguments repr="url: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -198,7 +198,7 @@
 <doc>&lt;p&gt;Perform a GET request on the &lt;span class="name"&gt;url&lt;/span&gt; and return the list of resource &lt;span class="name"&gt;ids&lt;/span&gt; from the response.&lt;/p&gt;</doc>
 <shortdoc>Perform a GET request on the `url` and return the list of resource `ids` from the response.</shortdoc>
 </kw>
-<kw name="Get Invalid Json Data" lineno="1171">
+<kw name="Get Invalid Json Data" lineno="1272">
 <arguments repr="url: str, method: str, status_code: int, request_data: RequestData">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -221,7 +221,7 @@
 &lt;p&gt;&amp;gt; Note: applicable UniquePropertyValueConstraint and IdReference Relations are considered before changes to &lt;span class="name"&gt;json_data&lt;/span&gt; are made.&lt;/p&gt;</doc>
 <shortdoc>Return `json_data` based on the `dto` on the `request_data` that will cause the provided `status_code` for the `method` operation on the `url`.</shortdoc>
 </kw>
-<kw name="Get Invalidated Parameters" lineno="1219">
+<kw name="Get Invalidated Parameters" lineno="1320">
 <arguments repr="status_code: int, request_data: RequestData">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="status_code: int">
 <name>status_code</name>
@@ -235,7 +235,7 @@
 <doc>&lt;p&gt;Returns a version of &lt;span class="name"&gt;params, headers&lt;/span&gt; as present on &lt;span class="name"&gt;request_data&lt;/span&gt; that has been modified to cause the provided &lt;span class="name"&gt;status_code&lt;/span&gt;.&lt;/p&gt;</doc>
 <shortdoc>Returns a version of `params, headers` as present on `request_data` that has been modified to cause the provided `status_code`.</shortdoc>
 </kw>
-<kw name="Get Invalidated Url" lineno="1137">
+<kw name="Get Invalidated Url" lineno="1238">
 <arguments repr="valid_url: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="valid_url: str">
 <name>valid_url</name>
@@ -246,7 +246,7 @@
 &lt;p&gt;Raises ValueError if the valid_url cannot be invalidated.&lt;/p&gt;</doc>
 <shortdoc>Return an url with all the path parameters in the `valid_url` replaced by a random UUID.</shortdoc>
 </kw>
-<kw name="Get Json Data For Dto Class" lineno="1031">
+<kw name="Get Json Data For Dto Class" lineno="1114">
 <arguments repr="schema: Dict[str, Any], dto_class: Dto | Type[Dto], operation_id: str = ">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="schema: Dict[str, Any]">
 <name>schema</name>
@@ -265,7 +265,7 @@
 <doc>&lt;p&gt;Generate a valid (json-compatible) dict for all the &lt;span class="name"&gt;dto_class&lt;/span&gt; properties.&lt;/p&gt;</doc>
 <shortdoc>Generate a valid (json-compatible) dict for all the `dto_class` properties.</shortdoc>
 </kw>
-<kw name="Get Json Data With Conflict" lineno="1438">
+<kw name="Get Json Data With Conflict" lineno="1539">
 <arguments repr="url: str, method: str, dto: Dto, conflict_status_code: int">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -287,7 +287,7 @@
 <doc>&lt;p&gt;Return &lt;span class="name"&gt;json_data&lt;/span&gt; based on the &lt;span class="name"&gt;UniquePropertyValueConstraint&lt;/span&gt; that must be returned by the &lt;span class="name"&gt;get_relations&lt;/span&gt; implementation on the &lt;span class="name"&gt;dto&lt;/span&gt; for the given &lt;span class="name"&gt;conflict_status_code&lt;/span&gt;.&lt;/p&gt;</doc>
 <shortdoc>Return `json_data` based on the `UniquePropertyValueConstraint` that must be returned by the `get_relations` implementation on the `dto` for the given `conflict_status_code`.</shortdoc>
 </kw>
-<kw name="Get Parameterized Endpoint From Url" lineno="1159">
+<kw name="Get Parameterized Endpoint From Url" lineno="1260">
 <arguments repr="url: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -297,7 +297,7 @@
 <doc>&lt;p&gt;Return the endpoint as found in the &lt;span class="name"&gt;paths&lt;/span&gt; section based on the given &lt;span class="name"&gt;url&lt;/span&gt;.&lt;/p&gt;</doc>
 <shortdoc>Return the endpoint as found in the `paths` section based on the given `url`.</shortdoc>
 </kw>
-<kw name="Get Request Data" lineno="823">
+<kw name="Get Request Data" lineno="906">
 <arguments repr="endpoint: str, method: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
 <name>endpoint</name>
@@ -311,7 +311,7 @@
 <doc>&lt;p&gt;Return an object with valid request data for body, headers and query params.&lt;/p&gt;</doc>
 <shortdoc>Return an object with valid request data for body, headers and query params.</shortdoc>
 </kw>
-<kw name="Get Valid Id For Endpoint" lineno="687">
+<kw name="Get Valid Id For Endpoint" lineno="770">
 <arguments repr="endpoint: str, method: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
 <name>endpoint</name>
@@ -326,7 +326,7 @@
 &lt;p&gt;To prevent resource conflicts with other test cases, a new resource is created (POST) if possible.&lt;/p&gt;</doc>
 <shortdoc>Support keyword that returns the `id` for an existing resource at `endpoint`.</shortdoc>
 </kw>
-<kw name="Get Valid Url" lineno="647">
+<kw name="Get Valid Url" lineno="730">
 <arguments repr="endpoint: str, method: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
 <name>endpoint</name>
@@ -342,7 +342,7 @@
 &lt;p&gt;&amp;gt; Note: if valid ids cannot be retrieved within the scope of the API, the &lt;span class="name"&gt;PathPropertiesConstraint&lt;/span&gt; Relation can be used. More information can be found &lt;a href="https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html"&gt;here&lt;/a&gt;.&lt;/p&gt;</doc>
 <shortdoc>This keyword returns a valid url for the given `endpoint` and `method`.</shortdoc>
 </kw>
-<kw name="Set Origin" lineno="554">
+<kw name="Set Origin" lineno="592">
 <arguments repr="origin: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="origin: str">
 <name>origin</name>

OpenApiLibCore/openapi_libcore.py

@@ -127,8 +127,19 @@ from functools import cached_property
 from itertools import zip_longest
 from logging import getLogger
 from pathlib import Path
-from random import choice
-from typing import Any, Dict, List, Optional, Set, Tuple, Type, Union
+from random import choice, sample
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    Generator,
+    List,
+    Optional,
+    Set,
+    Tuple,
+    Type,
+    Union,
+)
 from uuid import uuid4
 
 from openapi_core import Config, OpenAPI, Spec
@@ -358,6 +369,33 @@ class RequestData:
                 required_properties_dict[key] = value
         return required_properties_dict
 
+    def get_minimal_body_dict(self) -> Dict[str, Any]:
+        required_properties_dict = self.get_required_properties_dict()
+
+        min_properties = self.dto_schema.get("minProperties", 0)
+        number_of_optional_properties_to_add = min_properties - len(
+            required_properties_dict
+        )
+
+        if number_of_optional_properties_to_add < 1:
+            return required_properties_dict
+
+        optional_properties_dict = {
+            k: v
+            for k, v in self.dto.as_dict().items()
+            if k not in required_properties_dict
+        }
+        optional_properties_to_keep = sample(
+            sorted(optional_properties_dict), number_of_optional_properties_to_add
+        )
+        optional_properties_dict = {
+            k: v
+            for k, v in optional_properties_dict.items()
+            if k in optional_properties_to_keep
+        }
+
+        return {**required_properties_dict, **optional_properties_dict}
+
     def get_required_params(self) -> Dict[str, str]:
         """Get the params dict containing only the required query parameters."""
         required_parameters = [
@@ -570,7 +608,8 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
 
     @cached_property
     def validation_spec(self) -> Spec:
-        return Spec.from_dict(self.openapi_spec)
+        _, validation_spec, _ = self._load_specs_and_validator()
+        return validation_spec
 
     @property
     def openapi_spec(self) -> Dict[str, Any]:
@@ -580,13 +619,43 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
 
     @cached_property
     def _openapi_spec(self) -> Dict[str, Any]:
-        parser = self._load_parser()
+        parser, _, _ = self._load_specs_and_validator()
         return parser.specification
 
-    def read_paths(self) -> Dict[str, Any]:
-        return self.openapi_spec["paths"]
+    @cached_property
+    def response_validator(
+        self,
+    ) -> Callable[[RequestsOpenAPIRequest, RequestsOpenAPIResponse], None]:
+        _, _, response_validator = self._load_specs_and_validator()
+        return response_validator
+
+    def _get_json_types_from_spec(self, spec: Dict[str, Any]) -> Set[str]:
+        json_types: Set[str] = set(self._get_json_types(spec))
+        return {json_type for json_type in json_types if json_type is not None}
 
-    def _load_parser(self) -> ResolvingParser:
+    def _get_json_types(self, item: Any) -> Generator[str, None, None]:
+        if isinstance(item, dict):
+            content_dict = item.get("content")
+            if content_dict is None:
+                for value in item.values():
+                    yield from self._get_json_types(value)
+
+            else:
+                for content_type in content_dict:
+                    if "json" in content_type:
+                        yield content_type
+
+        if isinstance(item, list):
+            for list_item in item:
+                yield from self._get_json_types(list_item)
+
+    def _load_specs_and_validator(
+        self,
+    ) -> Tuple[
+        ResolvingParser,
+        Spec,
+        Callable[[RequestsOpenAPIRequest, RequestsOpenAPIResponse], None],
+    ]:
         try:
 
             def recursion_limit_handler(
@@ -599,7 +668,10 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
             # will have a global scope due to how the Python import system works. This
             # ensures that in a Suite of Suites where multiple Suites use the same
             # `source`, that OAS is only parsed / loaded once.
-            parser = PARSER_CACHE.get(self._source, None)
+            parser, validation_spec, response_validator = PARSER_CACHE.get(
+                self._source, (None, None, None)
+            )
+
             if parser is None:
                 parser = ResolvingParser(
                     self._source,
@@ -613,9 +685,25 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
                         "Source was loaded, but no specification was present after parsing."
                     )
 
-                PARSER_CACHE[self._source] = parser
+                validation_spec = Spec.from_dict(parser.specification)
+
+                json_types_from_spec: Set[str] = self._get_json_types_from_spec(
+                    parser.specification
+                )
+                extra_deserializers = {
+                    json_type: _json.loads for json_type in json_types_from_spec
+                }
+                config = Config(extra_media_type_deserializers=extra_deserializers)
+                openapi = OpenAPI(spec=validation_spec, config=config)
+                response_validator = openapi.validate_response
+
+                PARSER_CACHE[self._source] = (
+                    parser,
+                    validation_spec,
+                    response_validator,
+                )
 
-            return parser
+            return parser, validation_spec, response_validator
 
         except ResolutionError as exception:
             BuiltIn().fatal_error(
@@ -633,15 +721,10 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         Validate the reponse for a given request against the OpenAPI Spec that is
         loaded during library initialization.
         """
-        if response.content_type == "application/json":
-            config = None
-        else:
-            extra_deserializer = {response.content_type: _json.loads}
-            config = Config(extra_media_type_deserializers=extra_deserializer)
+        self.response_validator(request=request, response=response)
 
-        OpenAPI(spec=self.validation_spec, config=config).validate_response(
-            request, response
-        )
+    def read_paths(self) -> Dict[str, Any]:
+        return self.openapi_spec["paths"]
 
     @keyword
     def get_valid_url(self, endpoint: str, method: str) -> str:
@@ -1083,7 +1166,27 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
 
         json_data: Dict[str, Any] = {}
 
+        property_names = []
         for property_name in schema.get("properties", []):
+            if constrained_values := get_constrained_values(property_name):
+                # do not add properties that are configured to be ignored
+                if IGNORE in constrained_values:
+                    continue
+            property_names.append(property_name)
+
+        max_properties = schema.get("maxProperties")
+        if max_properties and len(property_names) > max_properties:
+            required_properties = schema.get("required", [])
+            number_of_optional_properties = max_properties - len(required_properties)
+            optional_properties = [
+                name for name in property_names if name not in required_properties
+            ]
+            selected_optional_properties = sample(
+                optional_properties, number_of_optional_properties
+            )
+            property_names = required_properties + selected_optional_properties
+
+        for property_name in property_names:
             properties_schema = schema["properties"][property_name]
 
             property_type = properties_schema.get("type")
@@ -1102,9 +1205,6 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
             if properties_schema.get("readOnly", False):
                 continue
             if constrained_values := get_constrained_values(property_name):
-                # do not add properties that are configured to be ignored
-                if IGNORE in constrained_values:
-                    continue
                 json_data[property_name] = choice(constrained_values)
                 continue
             if (
@@ -1131,6 +1231,7 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
                 json_data[property_name] = [array_data]
                 continue
             json_data[property_name] = value_utils.get_valid_value(properties_schema)
+
         return json_data
 
     @keyword

{robotframework_openapitools-0.1.3.dist-info → robotframework_openapitools-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-openapitools
-Version: 0.1.3
+Version: 0.2.1
 Summary: A set of Robot Framework libraries to test APIs for which the OAS is available.
 Home-page: https://github.com/MarketSquare/robotframework-openapitools
 License: Apache-2.0

{robotframework_openapitools-0.1.3.dist-info → robotframework_openapitools-0.2.1.dist-info}/RECORD

@@ -1,15 +1,15 @@
 OpenApiDriver/__init__.py,sha256=34h5RkB8nBNRKPId4r_B_xzcgXJYD3m2QYwIaPfpv80,1331
-OpenApiDriver/openapi_executors.py,sha256=xVF12OUR2Swi9VnQauST0WcT2zO4LWvL5bELNqAkM1E,31970
+OpenApiDriver/openapi_executors.py,sha256=XEuHUD-3mBNb8WNK8gmJoYkz2HAjzS-K9oQ0FTmgOoc,32851
 OpenApiDriver/openapi_reader.py,sha256=4kSM-hFd54ws-jq88inbienkaoC5sSDwfRuxLrHP7aA,4652
-OpenApiDriver/openapidriver.libspec,sha256=Po-Zqvpp4XO1iuoLikW1ruAcRdn40JbCzx0AdskfQ1k,27138
-OpenApiDriver/openapidriver.py,sha256=7FNVTWhjvQ_Xa-mXGbkA2O6N63cVSJ-BdlBKoemiB4Q,15546
+OpenApiDriver/openapidriver.libspec,sha256=3yU3o0AhCFulFWmmFwW-w0LY7GQaYSaU8er64Dr8cCA,28323
+OpenApiDriver/openapidriver.py,sha256=QRFcF1q9x88rqsD7XzBN25wPYqTbZldK4rSvpEdhQHo,15214
 OpenApiDriver/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 OpenApiLibCore/__init__.py,sha256=TOeGg8q0V8BNvdP9tEPE2MRQm7XyS1VzC5AP8y_qOPg,1591
-OpenApiLibCore/dto_base.py,sha256=Y0QYyC4-vJCwwZcxut5OpuPziSb-wQKwV8wqel6Wohk,12080
+OpenApiLibCore/dto_base.py,sha256=L1jKJLOthqL7jjdfZ6HDmM3t967UiH7RWkvsAu6NURg,11794
 OpenApiLibCore/dto_utils.py,sha256=maYX9QqPaJtiEo8vIFQLsT2FOT-LUGVnNcVaca4zCDk,2903
-OpenApiLibCore/oas_cache.py,sha256=XTji4fGM8fl4qoAYBa8WEXwVTyH70Te9a4-hYT0F87w,112
-OpenApiLibCore/openapi_libcore.libspec,sha256=XXiCinBVYubHIxpoASB5Us_MiUnmMUV9LI8ztpVF0QY,33102
-OpenApiLibCore/openapi_libcore.py,sha256=DH3q0Fn_FGc_fm_pcQdpvWxTrE6zw2gSMObPDw-4ack,62223
+OpenApiLibCore/oas_cache.py,sha256=Qg_Is5pAJZjZu5VmwEEarQs8teKrh3Y2psCcpDLU5Y4,379
+OpenApiLibCore/openapi_libcore.libspec,sha256=9Kn1CGzUoIL1uzb5cpjQrJS7ZKxjHAvRqADzCzdGlKQ,33102
+OpenApiLibCore/openapi_libcore.py,sha256=GHuhcpMiDNGCy-0pmTB5WRbUDzK8wpL5O07lZo0kPVQ,65826
 OpenApiLibCore/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 OpenApiLibCore/value_utils.py,sha256=wO5ssYTuk4YWWMJb0kl5n20X2r0NG55FXvgLqQd8qvw,18145
 roboswag/__init__.py,sha256=-8ql4wuY_ftOZRdCxSmBCMW3WpDk7Ir__st9xcb9qCI,223
@@ -35,7 +35,7 @@ roboswag/validate/__init__.py,sha256=stpgQmvZvqlqPBjZ3Vxhd3wbX_Nb85jyIbj44_EhK_w
 roboswag/validate/core.py,sha256=CfUEhkXPFAzIppRSiGyh62j4BYW4vkjIXWEzRcJFD6o,84
 roboswag/validate/schema.py,sha256=jyD44GcYU_JQLw5hb1wK-DwxOsbJ-FstoNHwIVVMqoo,711
 roboswag/validate/text_response.py,sha256=P7WEC6ot1OG3YDEXRtmOwIFwki8jgq8fMb-L77X4vIo,527
-robotframework_openapitools-0.1.3.dist-info/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-robotframework_openapitools-0.1.3.dist-info/METADATA,sha256=mA6B3a1yiaGocKPt3nBBKolaO_ye6M0k8cQHn_UGcV4,1610
-robotframework_openapitools-0.1.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-robotframework_openapitools-0.1.3.dist-info/RECORD,,
+robotframework_openapitools-0.2.1.dist-info/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+robotframework_openapitools-0.2.1.dist-info/METADATA,sha256=tT_w_nW-DgGsHRjhoWUQxRg92sQTdjTG7gzdPf19ndE,1610
+robotframework_openapitools-0.2.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+robotframework_openapitools-0.2.1.dist-info/RECORD,,