robotframework-openapitools 1.0.0b1__tar.gz → 1.0.0b3__tar.gz

{robotframework_openapitools-1.0.0b1 → robotframework_openapitools-1.0.0b3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: robotframework-openapitools
-Version: 1.0.0b1
+Version: 1.0.0b3
 Summary: A set of Robot Framework libraries to test APIs for which the OAS is available.
 License: Apache License
                                     Version 2.0, January 2004
@@ -235,3 +235,99 @@ OpenApiTools is a set of libraries centered around the OpenAPI Specification:
 - [OpenApiDriver](./driver.md)
 - [OpenApiLibCore](./libcore.md)
 
+
+## New in OpenApiTools v1.0.0
+
+Inspired by the work Bartlomiej and Mateusz did on #roboswag, I've created a CLI tool that generates a fully functional Robot Framework (Python) library that builds on OpenApiLibCore for automatic request data generation and request execution.
+
+### So how does it work?
+After installing / updating to the v1.0.0 beta (`pip install robotframework-openapitools==1.0.0b3`) , there's a new CLI command available in your (virtual) environment: `generate-library`. You'll have to provide a path to the openapi spec (json or yaml, can be a url or path to the file), provide a path to where to generate the library and (optionally) a name for the library:
+
+```
+$ generate-library
+Please provide a source for the generation:
+$ http://127.0.0.1:8000/openapi.json
+Please provide a path to where the library will be generated:
+$ ./generated
+Please provide a name for the library [default: FastAPI]:
+$ My Generated Library
+generated/MyGeneratedLibrary/__init__.py created
+generated/MyGeneratedLibrary/my_generated_library.py created
+```
+
+> Note: there's currently 2 environment variables that are taken into account by the generator; USE_SUMMARY_AS_KEYWORD_NAME can result in nicer keyword names (but: uniqueness is not guaranteed, so you might need to rename some of the generated keywords manually) and EXPAND_BODY_ARGUMENTS is what a recent poll in #api-testing was about.
+
+If the location where the library is located is in your Python search path, you'll be able to use it like a regular Robot Framework library (in fact, it's a drop-in replacement for OpenApiLibCore):
+
+```{robot}
+*** Settings ***
+Library         MyGeneratedLibrary
+...                 source=${ORIGIN}/openapi.json
+...                 origin=${ORIGIN}
+...                 base_path=${EMPTY}
+...                 mappings_path=${ROOT}/tests/user_implemented/custom_user_mappings.py
+Variables       ${ROOT}/tests/variables.py
+
+
+*** Variables ***
+${ORIGIN}=      http://localhost:8000
+
+
+*** Test Cases ***
+Test Generated Keywords: Get Employees
+    ${response}=    Get Employees
+    Should Be Equal As Integers    ${response.status_code}    200
+
+Test Generated Keywords: Post Employee
+    VAR    &{body}    name=Robin the Robot
+    ${response}=    Post Employee    body=${body}
+    # ${response}=    Post Employee    name=Robin the Robot
+    Should Be Equal As Integers    ${response.status_code}    201
+    Should Be Equal    ${response.json()}[name]    Robin the Robot
+
+Test Generated Keywords: Get Employee
+    ${response}=    Get Employee
+    Should Be Equal As Integers    ${response.status_code}    200
+
+Test Generated Keywords: Patch Employee
+    ${employee_id}=    Get Valid Id For Path    path=/employees/{employee_id}
+    VAR    &{body}    date_of_birth=2021-12-31
+    ${response}=    Patch Employee    employee_id=${employee_id}    body=${body}
+    # ${response}=    Patch Employee    employee_id=${employee_id}    date_of_birth=2021-12-31
+    Should Be Equal As Integers    ${response.status_code}    403
+
+Test Generated Keywords: Post WageGroup
+    VAR    &{body}    hourly_rate=99.99
+    ${response}=    Post Wagegroup    body=${body}
+    # ${response}=    Post Wagegroup    hourly_rate=99.99
+    Should Be Equal As Integers    ${response.status_code}    201
+    Should Be Equal As Numbers    ${response.json()}[hourly-rate]    99.99
+
+Test Generated Keywords: Get Energy Label
+    ${response}=    Get Energy Label
+    ...    zipcode=1111AA
+    ...    home_number=10
+    ...    extension=too long to be acceptable
+    ...    validate_against_schema=${FALSE}
+    Should Be Equal As Integers    ${response.status_code}    422
+
+    VAR    @{omit}    extension
+    ${response}=    Get Energy Label
+    ...    zipcode=1111AA
+    ...    home_number=10
+    ...    extension=too long to be acceptable
+    ...    omit_parameters=${omit}
+    Should Be Equal As Integers    ${response.status_code}    200
+```
+
+### Contributions and feedback
+
+So now I need your feedback! Does the library generator work for your openapi spec? Does the library work / do all the generated keywords work? Please let me know of any issues you run into!
+Things I'd like to address / improve before an official release:
+- parameters with union types (e.g. int or float) are currently annotated as Any.
+- support for lists / arrays is limited (i.e. not supported as body)
+- objects / dicts are currently only typed as dict; I'm looking into TypedDict annotation for better auto-complete / auto-conversion
+- a documentation rework
+
+  Subscribe to https://app.slack.com/client/T07PJQ9S7/CKK0X68KD for updates
+

robotframework_openapitools-1.0.0b3/docs/README.md

@@ -0,0 +1,102 @@
+# OpenApiTools for Robot Framework
+
+OpenApiTools is a set of libraries centered around the OpenAPI Specification:
+
+- [OpenApiDriver](./driver.md)
+- [OpenApiLibCore](./libcore.md)
+
+
+## New in OpenApiTools v1.0.0
+
+Inspired by the work Bartlomiej and Mateusz did on #roboswag, I've created a CLI tool that generates a fully functional Robot Framework (Python) library that builds on OpenApiLibCore for automatic request data generation and request execution.
+
+### So how does it work?
+After installing / updating to the v1.0.0 beta (`pip install robotframework-openapitools==1.0.0b3`) , there's a new CLI command available in your (virtual) environment: `generate-library`. You'll have to provide a path to the openapi spec (json or yaml, can be a url or path to the file), provide a path to where to generate the library and (optionally) a name for the library:
+
+```
+$ generate-library
+Please provide a source for the generation:
+$ http://127.0.0.1:8000/openapi.json
+Please provide a path to where the library will be generated:
+$ ./generated
+Please provide a name for the library [default: FastAPI]:
+$ My Generated Library
+generated/MyGeneratedLibrary/__init__.py created
+generated/MyGeneratedLibrary/my_generated_library.py created
+```
+
+> Note: there's currently 2 environment variables that are taken into account by the generator; USE_SUMMARY_AS_KEYWORD_NAME can result in nicer keyword names (but: uniqueness is not guaranteed, so you might need to rename some of the generated keywords manually) and EXPAND_BODY_ARGUMENTS is what a recent poll in #api-testing was about.
+
+If the location where the library is located is in your Python search path, you'll be able to use it like a regular Robot Framework library (in fact, it's a drop-in replacement for OpenApiLibCore):
+
+```{robot}
+*** Settings ***
+Library         MyGeneratedLibrary
+...                 source=${ORIGIN}/openapi.json
+...                 origin=${ORIGIN}
+...                 base_path=${EMPTY}
+...                 mappings_path=${ROOT}/tests/user_implemented/custom_user_mappings.py
+Variables       ${ROOT}/tests/variables.py
+
+
+*** Variables ***
+${ORIGIN}=      http://localhost:8000
+
+
+*** Test Cases ***
+Test Generated Keywords: Get Employees
+    ${response}=    Get Employees
+    Should Be Equal As Integers    ${response.status_code}    200
+
+Test Generated Keywords: Post Employee
+    VAR    &{body}    name=Robin the Robot
+    ${response}=    Post Employee    body=${body}
+    # ${response}=    Post Employee    name=Robin the Robot
+    Should Be Equal As Integers    ${response.status_code}    201
+    Should Be Equal    ${response.json()}[name]    Robin the Robot
+
+Test Generated Keywords: Get Employee
+    ${response}=    Get Employee
+    Should Be Equal As Integers    ${response.status_code}    200
+
+Test Generated Keywords: Patch Employee
+    ${employee_id}=    Get Valid Id For Path    path=/employees/{employee_id}
+    VAR    &{body}    date_of_birth=2021-12-31
+    ${response}=    Patch Employee    employee_id=${employee_id}    body=${body}
+    # ${response}=    Patch Employee    employee_id=${employee_id}    date_of_birth=2021-12-31
+    Should Be Equal As Integers    ${response.status_code}    403
+
+Test Generated Keywords: Post WageGroup
+    VAR    &{body}    hourly_rate=99.99
+    ${response}=    Post Wagegroup    body=${body}
+    # ${response}=    Post Wagegroup    hourly_rate=99.99
+    Should Be Equal As Integers    ${response.status_code}    201
+    Should Be Equal As Numbers    ${response.json()}[hourly-rate]    99.99
+
+Test Generated Keywords: Get Energy Label
+    ${response}=    Get Energy Label
+    ...    zipcode=1111AA
+    ...    home_number=10
+    ...    extension=too long to be acceptable
+    ...    validate_against_schema=${FALSE}
+    Should Be Equal As Integers    ${response.status_code}    422
+
+    VAR    @{omit}    extension
+    ${response}=    Get Energy Label
+    ...    zipcode=1111AA
+    ...    home_number=10
+    ...    extension=too long to be acceptable
+    ...    omit_parameters=${omit}
+    Should Be Equal As Integers    ${response.status_code}    200
+```
+
+### Contributions and feedback
+
+So now I need your feedback! Does the library generator work for your openapi spec? Does the library work / do all the generated keywords work? Please let me know of any issues you run into!
+Things I'd like to address / improve before an official release:
+- parameters with union types (e.g. int or float) are currently annotated as Any.
+- support for lists / arrays is limited (i.e. not supported as body)
+- objects / dicts are currently only typed as dict; I'm looking into TypedDict annotation for better auto-complete / auto-conversion
+- a documentation rework
+
+  Subscribe to https://app.slack.com/client/T07PJQ9S7/CKK0X68KD for updates

{robotframework_openapitools-1.0.0b1 → robotframework_openapitools-1.0.0b3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name="robotframework-openapitools"
-version = "1.0.0b1"
+version = "1.0.0b3"
 description = "A set of Robot Framework libraries to test APIs for which the OAS is available."
 authors = [
     {name = "Robin Mackaij", email = "r.a.mackaij@gmail.com"},

{robotframework_openapitools-1.0.0b1 → robotframework_openapitools-1.0.0b3}/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="2025-04-01T12:12:33+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py" lineno="358">
-<version>1.0.0b1</version>
+<keywordspec name="OpenApiDriver" type="LIBRARY" format="HTML" scope="SUITE" generated="2025-04-10T08:09:09+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py" lineno="358">
+<version>1.0.0b2</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-1.0.0b1 → robotframework_openapitools-1.0.0b3}/src/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="2025-04-01T12:12:26+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="174">
-<version>1.0.0b1</version>
+<keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2025-04-10T08:09:02+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="170">
+<version>1.0.0b2</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="182">
+<init name="__init__" lineno="178">
 <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] = , require_body_for_invalid_url: bool = False, recursion_limit: int = 1, recursion_default: dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None = {}, username: str = , password: str = , security_token: str = , auth: AuthBase | None = None, cert: str | tuple[str, str] = , verify_tls: bool | str = True, extra_headers: Mapping[str, str] = {}, cookies: MutableMapping[str, str] | RequestsCookieJar | None = None, proxies: MutableMapping[str, str] | None = None">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="source: str">
 <name>source</name>
@@ -222,7 +222,7 @@
 </init>
 </inits>
 <keywords>
-<kw name="Assert Href To Resource Is Valid" lineno="742">
+<kw name="Assert Href To Resource Is Valid" lineno="735">
 <arguments repr="href: str, referenced_resource: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None]">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="href: str">
 <name>href</name>
@@ -253,7 +253,7 @@
 <doc>&lt;p&gt;Attempt to GET the resource referenced by the &lt;span class="name"&gt;href&lt;/span&gt; and validate it's equal to the provided &lt;span class="name"&gt;referenced_resource&lt;/span&gt; object / dictionary.&lt;/p&gt;</doc>
 <shortdoc>Attempt to GET the resource referenced by the `href` and validate it's equal to the provided `referenced_resource` object / dictionary.</shortdoc>
 </kw>
-<kw name="Authorized Request" lineno="659">
+<kw name="Authorized Request" lineno="655">
 <arguments repr="url: str, method: str, params: dict[str, Any] | None = None, headers: dict[str, str] | None = None, json_data: dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None = None, data: Any | None = None, files: Any | None = None">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -327,7 +327,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="644">
+<kw name="Ensure In Use" lineno="640">
 <arguments repr="url: str, resource_relation: IdReference">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -341,7 +341,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="609">
+<kw name="Get Ids From Url" lineno="605">
 <arguments repr="url: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -354,7 +354,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="506">
+<kw name="Get Invalid Json Data" lineno="502">
 <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>
@@ -395,7 +395,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="529">
+<kw name="Get Invalidated Parameters" lineno="525">
 <arguments repr="status_code: int, request_data: RequestData">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="status_code: int">
 <name>status_code</name>
@@ -433,7 +433,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="619">
+<kw name="Get Invalidated Url" lineno="615">
 <arguments repr="valid_url: str, path: str = , expected_status_code: int = 404">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="valid_url: str">
 <name>valid_url</name>
@@ -455,7 +455,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 if no PathPropertiesConstraint is mapped for the `"get"` operation on the mapped `path` and `expected_status_code`. If a PathPropertiesConstraint is mapped, the `invalid_value` is returned.</shortdoc>
 </kw>
-<kw name="Get Json Data For Dto Class" lineno="489">
+<kw name="Get Json Data For Dto Class" lineno="485">
 <arguments repr="schema: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None], dto_class: type[Dto], operation_id: str = ">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="schema: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None]">
 <name>schema</name>
@@ -508,7 +508,7 @@
 <doc>&lt;p&gt;Generate valid (json-compatible) data for the &lt;span class="name"&gt;dto_class&lt;/span&gt;.&lt;/p&gt;</doc>
 <shortdoc>Generate valid (json-compatible) data for the `dto_class`.</shortdoc>
 </kw>
-<kw name="Get Json Data With Conflict" lineno="545">
+<kw name="Get Json Data With Conflict" lineno="541">
 <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>
@@ -548,7 +548,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 Path From Url" lineno="595">
+<kw name="Get Parameterized Path From Url" lineno="591">
 <arguments repr="url: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -559,7 +559,7 @@
 <doc>&lt;p&gt;Return the path 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 path as found in the `paths` section based on the given `url`.</shortdoc>
 </kw>
-<kw name="Get Request Data" lineno="478">
+<kw name="Get Request Data" lineno="474">
 <arguments repr="path: str, method: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
 <name>path</name>
@@ -574,7 +574,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 Request Values" lineno="437">
+<kw name="Get Request Values" lineno="433">
 <arguments repr="path: str, method: str, overrides: Mapping[str, object] = {}">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
 <name>path</name>
@@ -597,7 +597,7 @@
 <doc>&lt;p&gt;Return an object with all (valid) request values needed to make a request.&lt;/p&gt;</doc>
 <shortdoc>Return an object with all (valid) request values needed to make a request.</shortdoc>
 </kw>
-<kw name="Get Valid Id For Path" lineno="583">
+<kw name="Get Valid Id For Path" lineno="579">
 <arguments repr="path: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
 <name>path</name>
@@ -613,7 +613,7 @@
 &lt;p&gt;To prevent resource conflicts with other test cases, a new resource is created (by a POST operation) if possible.&lt;/p&gt;</doc>
 <shortdoc>Support keyword that returns the `id` for an existing resource at `path`.</shortdoc>
 </kw>
-<kw name="Get Valid Url" lineno="564">
+<kw name="Get Valid Url" lineno="560">
 <arguments repr="path: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
 <name>path</name>
@@ -626,7 +626,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-openapitools/advanced_use.html"&gt;here&lt;/a&gt;.&lt;/p&gt;</doc>
 <shortdoc>This keyword returns a valid url for the given `path`.</shortdoc>
 </kw>
-<kw name="Perform Validated Request" lineno="708">
+<kw name="Perform Validated Request" lineno="704">
 <arguments repr="path: str, status_code: int, request_values: RequestValues, original_data: Mapping[str, object] = {}">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
 <name>path</name>
@@ -652,7 +652,7 @@
 <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 Auth" lineno="415">
+<kw name="Set Auth" lineno="411">
 <arguments repr="auth: AuthBase">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="auth: AuthBase">
 <name>auth</name>
@@ -663,7 +663,7 @@
 &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="403">
+<kw name="Set Basic Auth" lineno="399">
 <arguments repr="username: str, password: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="username: str">
 <name>username</name>
@@ -678,7 +678,7 @@
 &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="425">
+<kw name="Set Extra Headers" lineno="421">
 <arguments repr="extra_headers: dict[str, str]">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="extra_headers: dict[str, str]">
 <name>extra_headers</name>
@@ -692,7 +692,7 @@
 &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="380">
+<kw name="Set Origin" lineno="376">
 <arguments repr="origin: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="origin: str">
 <name>origin</name>
@@ -704,7 +704,7 @@
 &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>Set the `origin` after the library is imported.</shortdoc>
 </kw>
-<kw name="Set Security Token" lineno="394">
+<kw name="Set Security Token" lineno="390">
 <arguments repr="security_token: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="security_token: str">
 <name>security_token</name>
@@ -715,7 +715,7 @@
 &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="786">
+<kw name="Validate Resource Properties" lineno="779">
 <arguments repr="resource: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None], schema: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None]">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="resource: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None]">
 <name>resource</name>
@@ -763,7 +763,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="757">
+<kw name="Validate Response" lineno="750">
 <arguments repr="path: str, response: Response, original_data: Mapping[str, object] = {}">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
 <name>path</name>
@@ -793,21 +793,17 @@
 &lt;/ul&gt;</doc>
 <shortdoc>Validate the `response` by performing the following validations: - validate the `response` against the openapi schema for the `path` - 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 Response Using Validator" lineno="728">
-<arguments repr="request: RequestsOpenAPIRequest, response: RequestsOpenAPIResponse">
-<arg kind="POSITIONAL_OR_NAMED" required="true" repr="request: RequestsOpenAPIRequest">
-<name>request</name>
-<type name="RequestsOpenAPIRequest"/>
-</arg>
-<arg kind="POSITIONAL_OR_NAMED" required="true" repr="response: RequestsOpenAPIResponse">
+<kw name="Validate Response Using Validator" lineno="724">
+<arguments repr="response: Response">
+<arg kind="POSITIONAL_OR_NAMED" required="true" repr="response: Response">
 <name>response</name>
-<type name="RequestsOpenAPIResponse"/>
+<type name="Response"/>
 </arg>
 </arguments>
-<doc>&lt;p&gt;Validate the &lt;span class="name"&gt;response&lt;/span&gt; for a given &lt;span class="name"&gt;request&lt;/span&gt; against the OpenAPI Spec that is loaded during library initialization.&lt;/p&gt;</doc>
-<shortdoc>Validate the `response` for a given `request` against the OpenAPI Spec that is loaded during library initialization.</shortdoc>
+<doc>&lt;p&gt;Validate the &lt;span class="name"&gt;response&lt;/span&gt; against the OpenAPI Spec that is loaded during library initialization.&lt;/p&gt;</doc>
+<shortdoc>Validate the `response` against the OpenAPI Spec that is loaded during library initialization.</shortdoc>
 </kw>
-<kw name="Validate Send Response" lineno="800">
+<kw name="Validate Send Response" lineno="793">
 <arguments repr="response: Response, original_data: Mapping[str, object] = {}">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="response: Response">
 <name>response</name>

{robotframework_openapitools-1.0.0b1 → robotframework_openapitools-1.0.0b3}/src/OpenApiLibCore/openapi_libcore.py

@@ -128,10 +128,6 @@ from types import MappingProxyType
 from typing import Any, Generator
 
 from openapi_core import Config, OpenAPI, Spec
-from openapi_core.contrib.requests import (
-    RequestsOpenAPIRequest,
-    RequestsOpenAPIResponse,
-)
 from openapi_core.validation.exceptions import ValidationError
 from prance import ResolvingParser
 from prance.util.url import ResolutionError
@@ -725,15 +721,12 @@ class OpenApiLibCore:  # pylint: disable=too-many-public-methods
         )
 
     @keyword
-    def validate_response_using_validator(
-        self, request: RequestsOpenAPIRequest, response: RequestsOpenAPIResponse
-    ) -> None:
+    def validate_response_using_validator(self, response: Response) -> None:
         """
-        Validate the `response` for a given `request` against the OpenAPI Spec that is
+        Validate the `response` against the OpenAPI Spec that is
         loaded during library initialization.
         """
         val.validate_response_using_validator(
-            request=request,
             response=response,
             response_validator=self.response_validator,
         )

{robotframework_openapitools-1.0.0b1 → robotframework_openapitools-1.0.0b3}/src/OpenApiLibCore/parameter_utils.py

@@ -7,7 +7,9 @@ from typing import Generator
 
 from OpenApiLibCore.annotations import JSON
 
-PARAMETER_REGISTRY: dict[str, str] = {"body": "body"}
+PARAMETER_REGISTRY: dict[str, str] = {
+    "body": "body",
+}
 
 
 def get_oas_name_from_safe_name(safe_name: str) -> str:

{robotframework_openapitools-1.0.0b1 → robotframework_openapitools-1.0.0b3}/src/OpenApiLibCore/request_data.py

@@ -40,6 +40,12 @@ class RequestValues:
         self.override_header_value(name=name, value=value)
         self.override_param_value(name=name, value=value)
 
+    def remove_parameters(self, parameters: list[str]) -> None:
+        for parameter in parameters:
+            _ = self.params.pop(parameter, None)
+            _ = self.headers.pop(parameter, None)
+            _ = self.json_data.pop(parameter, None)
+
 
 @dataclass
 class RequestData:

{robotframework_openapitools-1.0.0b1 → robotframework_openapitools-1.0.0b3}/src/OpenApiLibCore/validation.py

@@ -383,11 +383,12 @@ def validate_send_response(
 
 
 def validate_response_using_validator(
-    request: RequestsOpenAPIRequest,
-    response: RequestsOpenAPIResponse,
+    response: Response,
     response_validator: ResponseValidatorType,
 ) -> None:
-    response_validator(request=request, response=response)
+    openapi_request = RequestsOpenAPIRequest(response.request)
+    openapi_response = RequestsOpenAPIResponse(response)
+    response_validator(request=openapi_request, response=openapi_response)
 
 
 def _validate_response(
@@ -400,8 +401,7 @@ def _validate_response(
 ) -> None:
     try:
         validate_response_using_validator(
-            RequestsOpenAPIRequest(response.request),
-            RequestsOpenAPIResponse(response),
+            response=response,
             response_validator=response_validator,
         )
     except (ResponseValidationError, ServerNotFound) as exception:

{robotframework_openapitools-1.0.0b1 → robotframework_openapitools-1.0.0b3}/src/openapi_libgen/spec_parser.py

@@ -13,14 +13,20 @@ KEYWORD_TEMPLATE = r"""@keyword
     {signature}
         {body}"""
 
-SIGNATURE_TEMPLATE = r"def {keyword_name}(self{arguments}) -> Response:"
+SIGNATURE_TEMPLATE = r"def {keyword_name}(self{arguments}, validate_against_schema: bool = True) -> Response:"
 
 BODY_TEMPLATE_ = r"""overrides = {key: value for key, value in locals().items() if value is not UNSET and key != "self"}
+        _ = overrides.pop("validate_against_schema", None)
+        omit_list = overrides.pop("omit_parameters", [])
         body_data = overrides.pop("body", {})
         overrides.update(body_data)
         updated_path: str = substitute_path_parameters(path="{path_value}", substitution_dict=overrides)
         request_values: RequestValues = self.get_request_values(path=f"{updated_path}", method="{method_value}", overrides=overrides)
-        return self._perform_request(request_values=request_values)"""
+        request_values.remove_parameters(parameters=omit_list)
+        response = self._perform_request(request_values=request_values)
+        if validate_against_schema:
+            run_keyword('validate_response_using_validator', response)
+        return response"""
 
 
 class BodyTemplate(Template):
@@ -34,11 +40,13 @@ BODY_TEMPLATE = BodyTemplate(BODY_TEMPLATE_)
 class OperationDetails:
     path: str
     method: str
-    operation_id: str
     parameters: list[dict[str, Any]]
     request_body: dict[str, Any]
     summary: str
     description: str
+    operation_id: str | None = (
+        None  # operationId MUST be unique within the spec, so no default ""
+    )
 
 
 @dataclass
@@ -59,7 +67,7 @@ def get_path_items(paths: dict[str, Any]) -> Generator[OperationDetails, None, N
             operation_details = OperationDetails(
                 path=path,
                 method=method,
-                operation_id=method_item["operationId"],
+                operation_id=method_item.get("operationId", None),
                 parameters=method_item.get("parameters", []),
                 request_body=method_item.get("requestBody", {}),
                 summary=method_item.get("summary"),
@@ -108,10 +116,14 @@ def get_keyword_signature(operation_details: OperationDetails) -> str:
         keyword_name = remove_unsafe_characters_from_string(
             operation_details.summary
         ).lower()
-    else:
+    elif operation_details.operation_id:
         keyword_name = remove_unsafe_characters_from_string(
             operation_details.operation_id
         ).lower()
+    else:
+        keyword_name = remove_unsafe_characters_from_string(
+            f"{operation_details.method}_{operation_details.path}"
+        )
 
     parameters = get_parameter_details(operation_details=operation_details)
     path_parameters = [p for p in parameters if p.type == "path"]
@@ -198,6 +210,9 @@ def get_keyword_signature(operation_details: OperationDetails) -> str:
         argument = f", {safe_name}: {annotation}"
         arguments += argument
 
+    if arguments:
+        arguments += ", omit_parameters: Iterable[str] = frozenset()"
+
     return SIGNATURE_TEMPLATE.format(keyword_name=keyword_name, arguments=arguments)
 
 

{robotframework_openapitools-1.0.0b1 → robotframework_openapitools-1.0.0b3}/src/openapi_libgen/templates/library.jinja

@@ -1,5 +1,5 @@
 # pyright: reportArgumentType=false
-from typing import Any
+from typing import Any, Iterable
 
 from requests import Response
 from robot.api.deco import keyword, library

robotframework_openapitools-1.0.0b1/docs/README.md

@@ -1,6 +0,0 @@
-# OpenApiTools for Robot Framework
-
-OpenApiTools is a set of libraries centered around the OpenAPI Specification:
-
-- [OpenApiDriver](./driver.md)
-- [OpenApiLibCore](./libcore.md)