robotframework-openapitools 0.2.3__tar.gz → 0.3.0__tar.gz

{robotframework_openapitools-0.2.3 → robotframework_openapitools-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-openapitools
-Version: 0.2.3
+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.3 → robotframework_openapitools-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name="robotframework-openapitools"
-version = "0.2.3"
+version = "0.3.0"
 description = "A set of Robot Framework libraries to test APIs for which the OAS is available."
 license = "Apache-2.0"
 authors = [

{robotframework_openapitools-0.2.3 → robotframework_openapitools-0.3.0}/src/OpenApiDriver/openapi_executors.py

@@ -20,7 +20,7 @@ run_keyword = BuiltIn().run_keyword
 logger = getLogger(__name__)
 
 
-@library(scope="TEST SUITE", doc_format="ROBOT")
+@library(scope="SUITE", doc_format="ROBOT")
 class OpenApiExecutors(OpenApiLibCore):  # pylint: disable=too-many-instance-attributes
     """Main class providing the keywords and core logic to perform endpoint validations."""
 
@@ -52,9 +52,13 @@ class OpenApiExecutors(OpenApiLibCore):  # pylint: disable=too-many-instance-att
             source=source,
             origin=origin,
             base_path=base_path,
+            response_validation=response_validation,
+            disable_server_validation=disable_server_validation,
             mappings_path=mappings_path,
             default_id_property_name=default_id_property_name,
+            invalid_property_default_response=invalid_property_default_response,
             faker_locale=faker_locale,
+            require_body_for_invalid_url=require_body_for_invalid_url,
             recursion_limit=recursion_limit,
             recursion_default=recursion_default,
             username=username,
@@ -67,10 +71,6 @@ class OpenApiExecutors(OpenApiLibCore):  # pylint: disable=too-many-instance-att
             cookies=cookies,
             proxies=proxies,
         )
-        self.response_validation = response_validation
-        self.disable_server_validation = disable_server_validation
-        self.require_body_for_invalid_url = require_body_for_invalid_url
-        self.invalid_property_default_response = invalid_property_default_response
 
     @keyword
     def test_unauthorized(self, path: str, method: str) -> None:

{robotframework_openapitools-0.2.3 → robotframework_openapitools-0.3.0}/src/OpenApiDriver/openapidriver.libspec

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<keywordspec name="OpenApiDriver" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-06-20T15:30:31+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py" lineno="352">
-<version>0.2.3</version>
+<keywordspec name="OpenApiDriver" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-08-09T12:54:30+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py" lineno="352">
+<version>0.3.0</version>
 <doc>&lt;p&gt;Visit the &lt;a href="https://github.com/MarketSquare/robotframework-openapidriver"&gt;library page&lt;/a&gt; for an introduction and examples.&lt;/p&gt;</doc>
 <tags>
 </tags>

{robotframework_openapitools-0.2.3 → robotframework_openapitools-0.3.0}/src/OpenApiDriver/openapidriver.py

@@ -134,7 +134,7 @@ from OpenApiDriver.openapi_executors import OpenApiExecutors, ValidationLevel
 from OpenApiDriver.openapi_reader import OpenApiReader
 
 
-@library(scope="TEST SUITE", doc_format="ROBOT")
+@library(scope="SUITE", doc_format="ROBOT")
 class OpenApiDriver(OpenApiExecutors, DataDriver):
     """
     Visit the [https://github.com/MarketSquare/robotframework-openapidriver | library page]

{robotframework_openapitools-0.2.3 → robotframework_openapitools-0.3.0}/src/OpenApiLibCore/openapi_libcore.libspec

@@ -1,13 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-06-20T15:30:30+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="430">
-<version>0.2.3</version>
+<keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-08-09T12:54:30+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="431">
+<version>0.3.0</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="438">
-<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">
+<init name="__init__" lineno="439">
+<arguments repr="source: str, origin: str = , base_path: str = , response_validation: ValidationLevel = WARN, disable_server_validation: bool = True, mappings_path: str | Path = , invalid_property_default_response: int = 422, default_id_property_name: str = id, faker_locale: str | List[str] | None = None, require_body_for_invalid_url: bool = False, 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>
 <type name="str" typedoc="string"/>
@@ -22,6 +22,16 @@
 <type name="str" typedoc="string"/>
 <default/>
 </arg>
+<arg kind="POSITIONAL_OR_NAMED" required="false" repr="response_validation: ValidationLevel = WARN">
+<name>response_validation</name>
+<type name="ValidationLevel" typedoc="ValidationLevel"/>
+<default>WARN</default>
+</arg>
+<arg kind="POSITIONAL_OR_NAMED" required="false" repr="disable_server_validation: bool = True">
+<name>disable_server_validation</name>
+<type name="bool" typedoc="boolean"/>
+<default>True</default>
+</arg>
 <arg kind="POSITIONAL_OR_NAMED" required="false" repr="mappings_path: str | Path = ">
 <name>mappings_path</name>
 <type name="Union" union="true">
@@ -51,6 +61,11 @@
 </type>
 <default>None</default>
 </arg>
+<arg kind="POSITIONAL_OR_NAMED" required="false" repr="require_body_for_invalid_url: bool = False">
+<name>require_body_for_invalid_url</name>
+<type name="bool" typedoc="boolean"/>
+<default>False</default>
+</arg>
 <arg kind="POSITIONAL_OR_NAMED" required="false" repr="recursion_limit: int = 1">
 <name>recursion_limit</name>
 <type name="int" typedoc="integer"/>
@@ -147,6 +162,17 @@
 &lt;p&gt;The server (and port) of the target server. E.g. &lt;code&gt;https://localhost:8000&lt;/code&gt;&lt;/p&gt;
 &lt;h4&gt;base_path&lt;/h4&gt;
 &lt;p&gt;The routing between &lt;code&gt;origin&lt;/code&gt; and the endpoints as found in the &lt;code&gt;paths&lt;/code&gt; section in the openapi document. E.g. &lt;code&gt;/petshop/v2&lt;/code&gt;.&lt;/p&gt;
+&lt;h3&gt;Test case execution&lt;/h3&gt;
+&lt;h4&gt;response_validation&lt;/h4&gt;
+&lt;p&gt;By default, a &lt;code&gt;WARN&lt;/code&gt; 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:&lt;/p&gt;
+&lt;ul&gt;
+&lt;li&gt;&lt;code&gt;DISABLED&lt;/code&gt;: All Response validation errors will be ignored&lt;/li&gt;
+&lt;li&gt;&lt;code&gt;INFO&lt;/code&gt;: Any Response validation erros will be logged at &lt;code&gt;INFO&lt;/code&gt; level&lt;/li&gt;
+&lt;li&gt;&lt;code&gt;WARN&lt;/code&gt;: Any Response validation erros will be logged at &lt;code&gt;WARN&lt;/code&gt; level&lt;/li&gt;
+&lt;li&gt;&lt;code&gt;STRICT&lt;/code&gt;: The Test Case will fail on any Response validation errors&lt;/li&gt;
+&lt;/ul&gt;
+&lt;h4&gt;disable_server_validation&lt;/h4&gt;
+&lt;p&gt;If enabled by setting this parameter to &lt;code&gt;True&lt;/code&gt;, 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 &lt;code&gt;localhost&lt;/code&gt; and &lt;code&gt;127.0.0.1&lt;/code&gt; are not considered the same by Response validation.&lt;/p&gt;
 &lt;h3&gt;API-specific configurations&lt;/h3&gt;
 &lt;h4&gt;mappings_path&lt;/h4&gt;
 &lt;p&gt;See &lt;a href="https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html"&gt;this page&lt;/a&gt; for an in-depth explanation.&lt;/p&gt;
@@ -157,6 +183,8 @@
 &lt;p&gt;If different property names are used for the unique identifier for different types of resources, an &lt;code&gt;ID_MAPPING&lt;/code&gt; can be implemented using the &lt;code&gt;mappings_path&lt;/code&gt;.&lt;/p&gt;
 &lt;h4&gt;faker_locale&lt;/h4&gt;
 &lt;p&gt;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.&lt;/p&gt;
+&lt;h4&gt;require_body_for_invalid_url&lt;/h4&gt;
+&lt;p&gt;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.&lt;/p&gt;
 &lt;h3&gt;Parsing parameters&lt;/h3&gt;
 &lt;h4&gt;recursion_limit&lt;/h4&gt;
 &lt;p&gt;The recursion depth to which to fully parse recursive references before the &lt;span class="name"&gt;recursion_default&lt;/span&gt; is used to end the recursion.&lt;/p&gt;
@@ -186,8 +214,8 @@
 </init>
 </inits>
 <keywords>
-<kw name="Authorized Request" lineno="1607">
-<arguments repr="url: str, method: str, params: Dict[str, Any] | None = None, headers: Dict[str, str] | None = None, json_data: Dict[str, Dict[str, JSON] | List[JSON] | str | int | float | bool | None] | List[Dict[str, JSON] | List[JSON] | str | int | float | bool | None] | str | int | float | bool | None = None">
+<kw name="Authorized Request" lineno="1683">
+<arguments repr="url: str, method: str, params: Dict[str, Any] | None = None, headers: Dict[str, str] | None = None, json_data: Dict[str, Dict[str, JSON] | List[JSON] | str | int | float | bool | None] | List[Dict[str, JSON] | List[JSON] | str | int | float | bool | None] | str | int | float | bool | None = None, data: Any = None, files: Any = None">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
 <type name="str" typedoc="string"/>
@@ -262,13 +290,24 @@
 </type>
 <default>None</default>
 </arg>
+<arg kind="POSITIONAL_OR_NAMED" required="false" repr="data: Any = None">
+<name>data</name>
+<type name="Any" typedoc="Any"/>
+<default>None</default>
+</arg>
+<arg kind="POSITIONAL_OR_NAMED" required="false" repr="files: Any = None">
+<name>files</name>
+<type name="Any" typedoc="Any"/>
+<default>None</default>
+</arg>
 </arguments>
 <returntype name="Response"/>
 <doc>&lt;p&gt;Perform a request using the security token or authentication set in the library.&lt;/p&gt;
+&lt;p&gt;&lt;span class="name"&gt;json_data&lt;/span&gt;, &lt;span class="name"&gt;data&lt;/span&gt; and &lt;span class="name"&gt;files&lt;/span&gt; are passed to &lt;span class="name"&gt;requests.request&lt;/span&gt;s &lt;span class="name"&gt;json&lt;/span&gt;, &lt;span class="name"&gt;data&lt;/span&gt; and &lt;span class="name"&gt;files&lt;/span&gt; parameters unaltered. See the requests documentation for details: &lt;a href="https://requests.readthedocs.io/en/latest/api/#requests.request"&gt;https://requests.readthedocs.io/en/latest/api/#requests.request&lt;/a&gt;&lt;/p&gt;
 &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="1511">
+<kw name="Ensure In Use" lineno="1587">
 <arguments repr="url: str, resource_relation: IdReference">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -282,7 +321,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="882">
+<kw name="Get Ids From Url" lineno="958">
 <arguments repr="url: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -295,7 +334,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="1288">
+<kw name="Get Invalid Json Data" lineno="1364">
 <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>
@@ -322,7 +361,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="1336">
+<kw name="Get Invalidated Parameters" lineno="1412">
 <arguments repr="status_code: int, request_data: RequestData">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="status_code: int">
 <name>status_code</name>
@@ -346,7 +385,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="1254">
+<kw name="Get Invalidated Url" lineno="1330">
 <arguments repr="valid_url: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="valid_url: str">
 <name>valid_url</name>
@@ -361,7 +400,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="1130">
+<kw name="Get Json Data For Dto Class" lineno="1206">
 <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>
@@ -395,7 +434,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="1555">
+<kw name="Get Json Data With Conflict" lineno="1631">
 <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>
@@ -421,7 +460,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="1276">
+<kw name="Get Parameterized Endpoint From Url" lineno="1352">
 <arguments repr="url: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -432,7 +471,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="922">
+<kw name="Get Request Data" lineno="998">
 <arguments repr="endpoint: str, method: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
 <name>endpoint</name>
@@ -447,7 +486,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="786">
+<kw name="Get Valid Id For Endpoint" lineno="862">
 <arguments repr="endpoint: str, method: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
 <name>endpoint</name>
@@ -467,7 +506,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="746">
+<kw name="Get Valid Url" lineno="822">
 <arguments repr="endpoint: str, method: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
 <name>endpoint</name>
@@ -484,7 +523,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="Perform Validated Request" lineno="1645">
+<kw name="Perform Validated Request" lineno="1730">
 <arguments repr="path: str, status_code: int, request_values: RequestValues, original_data: Dict[str, Any] | None = None">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
 <name>path</name>
@@ -513,19 +552,70 @@
 <doc>&lt;p&gt;This keyword first calls the Authorized Request keyword, then the Validate Response keyword and finally validates, for &lt;span class="name"&gt;DELETE&lt;/span&gt; operations, whether the target resource was indeed deleted (OK response) or not (error responses).&lt;/p&gt;</doc>
 <shortdoc>This keyword first calls the Authorized Request keyword, then the Validate Response keyword and finally validates, for `DELETE` operations, whether the target resource was indeed deleted (OK response) or not (error responses).</shortdoc>
 </kw>
-<kw name="Set Origin" lineno="607">
+<kw name="Set Auth" lineno="677">
+<arguments repr="auth: AuthBase">
+<arg kind="POSITIONAL_OR_NAMED" required="true" repr="auth: AuthBase">
+<name>auth</name>
+<type name="AuthBase"/>
+</arg>
+</arguments>
+<doc>&lt;p&gt;Set the &lt;span class="name"&gt;auth&lt;/span&gt; used for authentication after the library is imported.&lt;/p&gt;
+&lt;p&gt;After calling this keyword, subsequent requests will use the provided &lt;span class="name"&gt;auth&lt;/span&gt; instance.&lt;/p&gt;</doc>
+<shortdoc>Set the `auth` used for authentication after the library is imported.</shortdoc>
+</kw>
+<kw name="Set Basic Auth" lineno="665">
+<arguments repr="username: str, password: str">
+<arg kind="POSITIONAL_OR_NAMED" required="true" repr="username: str">
+<name>username</name>
+<type name="str" typedoc="string"/>
+</arg>
+<arg kind="POSITIONAL_OR_NAMED" required="true" repr="password: str">
+<name>password</name>
+<type name="str" typedoc="string"/>
+</arg>
+</arguments>
+<doc>&lt;p&gt;Set the &lt;span class="name"&gt;username&lt;/span&gt; and &lt;span class="name"&gt;password&lt;/span&gt; used for basic authentication after the library is imported.&lt;/p&gt;
+&lt;p&gt;After calling this keyword, subsequent requests will use the provided credentials.&lt;/p&gt;</doc>
+<shortdoc>Set the `username` and `password` used for basic authentication after the library is imported.</shortdoc>
+</kw>
+<kw name="Set Extra Headers" lineno="687">
+<arguments repr="extra_headers: Dict[str, str]">
+<arg kind="POSITIONAL_OR_NAMED" required="true" repr="extra_headers: Dict[str, str]">
+<name>extra_headers</name>
+<type name="Dict" typedoc="dictionary">
+<type name="str" typedoc="string"/>
+<type name="str" typedoc="string"/>
+</type>
+</arg>
+</arguments>
+<doc>&lt;p&gt;Set the &lt;span class="name"&gt;extra_headers&lt;/span&gt; used in requests after the library is imported.&lt;/p&gt;
+&lt;p&gt;After calling this keyword, subsequent requests will use the provided &lt;span class="name"&gt;extra_headers&lt;/span&gt;.&lt;/p&gt;</doc>
+<shortdoc>Set the `extra_headers` used in requests after the library is imported.</shortdoc>
+</kw>
+<kw name="Set Origin" lineno="642">
 <arguments repr="origin: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="origin: str">
 <name>origin</name>
 <type name="str" typedoc="string"/>
 </arg>
 </arguments>
-<doc>&lt;p&gt;Update the &lt;span class="name"&gt;origin&lt;/span&gt; after the library is imported.&lt;/p&gt;
+<doc>&lt;p&gt;Set the &lt;span class="name"&gt;origin&lt;/span&gt; after the library is imported.&lt;/p&gt;
 &lt;p&gt;This can be done during the &lt;span class="name"&gt;Suite setup&lt;/span&gt; when using DataDriver in situations where the OpenAPI document is available on disk but the target host address is not known before the test starts.&lt;/p&gt;
 &lt;p&gt;In combination with OpenApiLibCore, the &lt;span class="name"&gt;origin&lt;/span&gt; can be used at any point to target another server that hosts an API that complies to the same OAS.&lt;/p&gt;</doc>
-<shortdoc>Update the `origin` after the library is imported.</shortdoc>
+<shortdoc>Set the `origin` after the library is imported.</shortdoc>
 </kw>
-<kw name="Validate Resource Properties" lineno="1871">
+<kw name="Set Security Token" lineno="656">
+<arguments repr="security_token: str">
+<arg kind="POSITIONAL_OR_NAMED" required="true" repr="security_token: str">
+<name>security_token</name>
+<type name="str" typedoc="string"/>
+</arg>
+</arguments>
+<doc>&lt;p&gt;Set the &lt;span class="name"&gt;security_token&lt;/span&gt; after the library is imported.&lt;/p&gt;
+&lt;p&gt;After calling this keyword, subsequent requests will use the provided token.&lt;/p&gt;</doc>
+<shortdoc>Set the `security_token` after the library is imported.</shortdoc>
+</kw>
+<kw name="Validate Resource Properties" lineno="1966">
 <arguments repr="resource: Dict[str, Any], schema: Dict[str, Any]">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="resource: Dict[str, Any]">
 <name>resource</name>
@@ -545,7 +635,7 @@
 <doc>&lt;p&gt;Validate that the &lt;span class="name"&gt;resource&lt;/span&gt; does not contain any properties that are not defined in the &lt;span class="name"&gt;schema_properties&lt;/span&gt;.&lt;/p&gt;</doc>
 <shortdoc>Validate that the `resource` does not contain any properties that are not defined in the `schema_properties`.</shortdoc>
 </kw>
-<kw name="Validate Response" lineno="1719">
+<kw name="Validate Response" lineno="1804">
 <arguments repr="path: str, response: Response, original_data: Dict[str, Any] | None = None">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
 <name>path</name>
@@ -578,7 +668,7 @@
 &lt;/ul&gt;</doc>
 <shortdoc>Validate the `response` by performing the following validations: - validate the `response` against the openapi schema for the `endpoint` - validate that the response does not contain extra properties - validate that a href, if present, refers to the correct resource - validate that the value for a property that is in the response is equal to     the property value that was send - validate that no `original_data` is preserved when performing a PUT operation - validate that a PATCH operation only updates the provided properties</shortdoc>
 </kw>
-<kw name="Validate Send Response" lineno="1989">
+<kw name="Validate Send Response" lineno="2084">
 <arguments repr="response: Response, original_data: Dict[str, Any] | None = None">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="response: Response">
 <name>response</name>
@@ -649,6 +739,7 @@
 <usage>Get Json Data For Dto Class</usage>
 <usage>Get Json Data With Conflict</usage>
 <usage>Perform Validated Request</usage>
+<usage>Set Extra Headers</usage>
 <usage>Validate Resource Properties</usage>
 <usage>Validate Response</usage>
 <usage>Validate Send Response</usage>
@@ -746,7 +837,10 @@
 <usage>Get Valid Id For Endpoint</usage>
 <usage>Get Valid Url</usage>
 <usage>Perform Validated Request</usage>
+<usage>Set Basic Auth</usage>
+<usage>Set Extra Headers</usage>
 <usage>Set Origin</usage>
+<usage>Set Security Token</usage>
 <usage>Validate Resource Properties</usage>
 <usage>Validate Response</usage>
 <usage>Validate Send Response</usage>
@@ -765,5 +859,20 @@
 <usage>Get Invalidated Parameters</usage>
 </usages>
 </type>
+<type name="ValidationLevel" type="Enum">
+<doc>&lt;p&gt;The available levels for the response_validation parameter.&lt;/p&gt;</doc>
+<accepts>
+<type>string</type>
+</accepts>
+<usages>
+<usage>__init__</usage>
+</usages>
+<members>
+<member name="DISABLED" value="DISABLED"/>
+<member name="INFO" value="INFO"/>
+<member name="WARN" value="WARN"/>
+<member name="STRICT" value="STRICT"/>
+</members>
+</type>
 </typedocs>
 </keywordspec>

{robotframework_openapitools-0.2.3 → robotframework_openapitools-0.3.0}/src/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