robotframework-openapitools 0.2.2__py3-none-any.whl → 0.3.0__py3-none-any.whl

OpenApiLibCore/openapi_libcore.py

@@ -149,6 +149,7 @@ from openapi_core.contrib.requests import (
     RequestsOpenAPIResponse,
 )
 from openapi_core.exceptions import OpenAPIError
+from openapi_core.templating.paths.exceptions import ServerNotFound
 from openapi_core.validation.exceptions import ValidationError
 from openapi_core.validation.response.exceptions import ResponseValidationError
 from openapi_core.validation.schemas.exceptions import InvalidSchemaValue
@@ -157,8 +158,8 @@ from prance.util.url import ResolutionError
 from requests import Response, Session
 from requests.auth import AuthBase, HTTPBasicAuth
 from requests.cookies import RequestsCookieJar as CookieJar
-from robot.api import Failure
 from robot.api.deco import keyword, library
+from robot.api.exceptions import Failure
 from robot.libraries.BuiltIn import BuiltIn
 
 from OpenApiLibCore import value_utils
@@ -426,7 +427,7 @@ class RequestData:
         return {k: v for k, v in self.headers.items() if k in required_parameters}
 
 
-@library(scope="TEST SUITE", doc_format="ROBOT")
+@library(scope="SUITE", doc_format="ROBOT")
 class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
     """
     Main class providing the keywords and core logic to interact with an OpenAPI server.
@@ -440,10 +441,13 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         source: str,
         origin: str = "",
         base_path: str = "",
+        response_validation: ValidationLevel = ValidationLevel.WARN,
+        disable_server_validation: bool = True,
         mappings_path: Union[str, Path] = "",
         invalid_property_default_response: int = 422,
         default_id_property_name: str = "id",
         faker_locale: Optional[Union[str, List[str]]] = None,
+        require_body_for_invalid_url: bool = False,
         recursion_limit: int = 1,
         recursion_default: Any = {},
         username: str = "",
@@ -470,6 +474,25 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         section in the openapi document.
         E.g. ``/petshop/v2``.
 
+        == Test case execution ==
+
+        === response_validation ===
+         By default, a ``WARN`` is logged when the Response received after a Request does not
+         comply with the schema as defined in the openapi document for the given operation. The
+         following values are supported:
+
+         - ``DISABLED``: All Response validation errors will be ignored
+         - ``INFO``: Any Response validation erros will be logged at ``INFO`` level
+         - ``WARN``: Any Response validation erros will be logged at ``WARN`` level
+         - ``STRICT``: The Test Case will fail on any Response validation errors
+
+         === disable_server_validation ===
+         If enabled by setting this parameter to ``True``, the Response validation will also
+         include possible errors for Requests made to a server address that is not defined in
+         the list of servers in the openapi document. This generally means that if there is a
+         mismatch, every Test Case will raise this error. Note that ``localhost`` and
+         ``127.0.0.1`` are not considered the same by Response validation.
+
         == API-specific configurations ==
 
         === mappings_path ===
@@ -496,6 +519,14 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         A locale string or list of locale strings to pass to the Faker library to be
         used in generation of string data for supported format types.
 
+        === require_body_for_invalid_url ===
+         When a request is made against an invalid url, this usually is because of a "404" request;
+         a request for a resource that does not exist. Depending on API implementation, when a
+         request with a missing or invalid request body is made on a non-existent resource,
+         either a 404 or a 422 or 400 Response is normally returned. If the API being tested
+         processes the request body before checking if the requested resource exists, set
+         this parameter to True.
+
         == Parsing parameters ==
 
         === recursion_limit ===
@@ -552,6 +583,8 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         self._source = source
         self._origin = origin
         self._base_path = base_path
+        self.response_validation = response_validation
+        self.disable_server_validation = disable_server_validation
         self._recursion_limit = recursion_limit
         self._recursion_default = recursion_default
         self.session = Session()
@@ -559,7 +592,7 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         # if multiple are provided, username and password take precedence
         self.security_token = security_token
         self.auth = auth
-        if username and password:
+        if username:
             self.auth = HTTPBasicAuth(username, password)
         # Robot Framework does not allow users to create tuples and requests
         # does not accept lists, so perform the conversion here
@@ -596,8 +629,10 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
             )
         if faker_locale:
             FAKE.set_locale(locale=faker_locale)
+        self.require_body_for_invalid_url = require_body_for_invalid_url
         # update the globally available DEFAULT_ID_PROPERTY_NAME to the provided value
         DEFAULT_ID_PROPERTY_NAME.id_property_name = default_id_property_name
+        self._server_validation_warning_logged = False
 
     @property
     def origin(self) -> str:
@@ -606,7 +641,7 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
     @keyword
     def set_origin(self, origin: str) -> None:
         """
-        Update the `origin` after the library is imported.
+        Set the `origin` after the library is imported.
 
         This can be done during the `Suite setup` when using DataDriver in situations
         where the OpenAPI document is available on disk but the target host address is
@@ -617,6 +652,47 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         """
         self._origin = origin
 
+    @keyword
+    def set_security_token(self, security_token: str) -> None:
+        """
+        Set the `security_token` after the library is imported.
+
+        After calling this keyword, subsequent requests will use the provided token.
+        """
+        self.security_token = security_token
+
+    @keyword
+    def set_basic_auth(self, username: str, password: str) -> None:
+        """
+        Set the `username` and `password` used for basic
+        authentication after the library is imported.
+
+        After calling this keyword, subsequent requests
+        will use the provided credentials.
+        """
+        if username:
+            self.auth = HTTPBasicAuth(username, password)
+
+    @keyword
+    def set_auth(self, auth: AuthBase) -> None:
+        """
+        Set the `auth` used for authentication after the library is imported.
+
+        After calling this keyword, subsequent requests
+        will use the provided `auth` instance.
+        """
+        self.auth = auth
+
+    @keyword
+    def set_extra_headers(self, extra_headers: Dict[str, str]) -> None:
+        """
+        Set the `extra_headers` used in requests after the library is imported.
+
+        After calling this keyword, subsequent requests
+        will use the provided `extra_headers`.
+        """
+        self.extra_headers = extra_headers
+
     @property
     def base_url(self) -> str:
         return f"{self.origin}{self._base_path}"
@@ -1611,10 +1687,17 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         params: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
         json_data: Optional[JSON] = None,
+        data: Any = None,
+        files: Any = None,
     ) -> Response:
         """
         Perform a request using the security token or authentication set in the library.
 
+        `json_data`, `data` and `files` are passed to `requests.request`s `json`,
+        `data` and `files` parameters unaltered.
+        See the requests documentation for details:
+        https://requests.readthedocs.io/en/latest/api/#requests.request
+
         > Note: provided username / password or auth objects take precedence over token
             based security
         """
@@ -1632,6 +1715,8 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
             params=params,
             headers=headers,
             json=json_data,
+            data=data,
+            files=files,
             cookies=self.cookies,
             auth=self.auth,
             proxies=self.proxies,
@@ -1841,7 +1926,7 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
                 request=RequestsOpenAPIRequest(response.request),
                 response=RequestsOpenAPIResponse(response),
             )
-        except ResponseValidationError as exception:
+        except (ResponseValidationError, ServerNotFound) as exception:
             errors: List[InvalidSchemaValue] = exception.__cause__
             validation_errors: Optional[List[ValidationError]] = getattr(
                 errors, "schema_errors", None
@@ -1856,6 +1941,16 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
             else:
                 error_message = str(exception)
 
+            if isinstance(exception, ServerNotFound):
+                if not self._server_validation_warning_logged:
+                    logger.warning(
+                        f"ServerNotFound was raised during response validation. "
+                        f"Due to this, no full response validation will be performed."
+                        f"\nThe original error was: {error_message}"
+                    )
+                    self._server_validation_warning_logged = True
+                if self.disable_server_validation:
+                    return
             if response.status_code == self.invalid_property_default_response:
                 logger.debug(error_message)
                 return

{robotframework_openapitools-0.2.2.dist-info → robotframework_openapitools-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-openapitools
-Version: 0.2.2
+Version: 0.3.0
 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.2.2.dist-info → robotframework_openapitools-0.3.0.dist-info}/RECORD

@@ -1,15 +1,15 @@
 OpenApiDriver/__init__.py,sha256=34h5RkB8nBNRKPId4r_B_xzcgXJYD3m2QYwIaPfpv80,1331
-OpenApiDriver/openapi_executors.py,sha256=7zjvMzkKY-IknTWZABZZoMNguMqXVn3gNiiljDQ9VyQ,12260
+OpenApiDriver/openapi_executors.py,sha256=g7DsTRYC37LQm816U8Y3jy4_VjKighdAGqwgjcm_HnY,12247
 OpenApiDriver/openapi_reader.py,sha256=4kSM-hFd54ws-jq88inbienkaoC5sSDwfRuxLrHP7aA,4652
-OpenApiDriver/openapidriver.libspec,sha256=JuR4-Feq6xy3WQZn0xe8U9jA0rVnnvfvLN-3X6YwDjY,28322
-OpenApiDriver/openapidriver.py,sha256=QRFcF1q9x88rqsD7XzBN25wPYqTbZldK4rSvpEdhQHo,15214
+OpenApiDriver/openapidriver.libspec,sha256=4GkssGoKEPcBK1ORo3O2QNPpqpkuOrz_Oki0r1WsPio,27059
+OpenApiDriver/openapidriver.py,sha256=HD2t32pU0RokKbf2VopjxlArIVoh_-fLcwiJmfQ2MJM,15209
 OpenApiDriver/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 OpenApiLibCore/__init__.py,sha256=CGZRj3Vh4TZ76LOLWJOrBFr27QYWVXsO1imLqH-aP9E,1604
 OpenApiLibCore/dto_base.py,sha256=qAPSLnrs1n_sbfe1z-3EPV31Q7dMe0Nno2XRFmrYl9A,11792
 OpenApiLibCore/dto_utils.py,sha256=maYX9QqPaJtiEo8vIFQLsT2FOT-LUGVnNcVaca4zCDk,2903
 OpenApiLibCore/oas_cache.py,sha256=Qg_Is5pAJZjZu5VmwEEarQs8teKrh3Y2psCcpDLU5Y4,379
-OpenApiLibCore/openapi_libcore.libspec,sha256=qgCF2aJGNWUgSX6-xjHQ2-DvknFGcA-1CnvU3VHCRzA,39801
-OpenApiLibCore/openapi_libcore.py,sha256=BVBaeqv_ZgPw5332BmNeTjONdpL73dXPcf8w1bWtvBA,86685
+OpenApiLibCore/openapi_libcore.libspec,sha256=L-Mcs6bUn4db2jXkwg9DPFco06KkVksYz0u7jMpfTJw,45934
+OpenApiLibCore/openapi_libcore.py,sha256=YkuznUzlfxPu0hoW_EDhdjQC37sttGBnWee04NBwTHk,91076
 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.2.2.dist-info/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-robotframework_openapitools-0.2.2.dist-info/METADATA,sha256=9b-sj3qOnu_xXjxDj5Ad-9Vp5RIIBvd-fav5IVCqk6I,1610
-robotframework_openapitools-0.2.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-robotframework_openapitools-0.2.2.dist-info/RECORD,,
+robotframework_openapitools-0.3.0.dist-info/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+robotframework_openapitools-0.3.0.dist-info/METADATA,sha256=XZJh7znjyzNIkKGG0k4Q4YGADOaZhAgrEWPaTMS63CI,1610
+robotframework_openapitools-0.3.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+robotframework_openapitools-0.3.0.dist-info/RECORD,,