Merge pull request #108 from MarketSquare/98_add_keywords_to_simplify_making_requests

98 add keywords to simplify making requests

Author: robinmackaij

docs/releases.md

@@ -8,6 +8,12 @@
     - The `Relations` still need to be reworked to align with this change.
 - Refactored retrieving / loading of the OpenAPI spec.
     - This closes [issue #93: SSL error even if cert / verify is set](https://github.com/MarketSquare/robotframework-openapitools/issues/93).
+- Added keywords to make it easier to work with the `RequestValues` object:
+    - `Get Request Values Object` can be used to create a `RequestValues` instance from pre-defined values (where `Get Request Values` generates all values automatically).
+    - `Perform Authorized Request` is functionally the same as exisiting `Authorized Request` keyword, but it accepts a `RequestValues` instance as argument.
+    - `Validated Request` is functionally the same as the existing `Perform Validated Request` keyword, but it accepts the data as separate arguments instead of the `RequestValues`.
+    - `Convert Request Values To Dict` can be used to get a (Python) dict represenation of a `RequestValues` object that can be used with e.g. the Collections keywords for working with dictionaries.
+    - Thise closes [issue #98: Add keywords to simplify using Authorized Request and Perform Validated Request](https://github.com/MarketSquare/robotframework-openapitools/issues/98).
 - Improved handling of `treat_as_mandatory` on a `PropertyValueConstraint`.
 - Added support for using `IGNORE` as `invalid_value` on a `PropertyValueConstraint`.
 

src/OpenApiDriver/openapi_executors.py

@@ -22,7 +22,6 @@
 from OpenApiLibCore import (
     OpenApiLibCore,
     RequestData,
-    RequestValues,
     ValidationLevel,
 )
 from OpenApiLibCore.annotations import JSON
@@ -78,7 +77,7 @@ def _run_keyword(
 
 @overload
 def _run_keyword(
-    keyword_name: Literal["perform_validated_request"], *args: object
+    keyword_name: Literal["validated_request"], *args: object
 ) -> None: ...  # pragma: no cover
 
 
@@ -303,16 +302,14 @@ def test_endpoint(self, path: str, method: str, status_code: int) -> None:
                     f"No relation found to cause status_code {status_code}."
                 )
         _run_keyword(
-            "perform_validated_request",
+            "validated_request",
             path,
             status_code,
-            RequestValues(
-                url=url,
-                method=method,
-                params=params,
-                headers=headers,
-                json_data=json_data,
-            ),
+            url,
+            method,
+            params,
+            headers,
+            json_data,
             original_data,
         )
         if status_code < int(HTTPStatus.MULTIPLE_CHOICES) and (
@@ -335,16 +332,14 @@ def test_endpoint(self, path: str, method: str, status_code: int) -> None:
             if method == "PATCH":
                 original_data = self.get_original_data(url=url)
             _run_keyword(
-                "perform_validated_request",
+                "validated_request",
                 path,
                 status_code,
-                RequestValues(
-                    url=url,
-                    method=method,
-                    params=params,
-                    headers=headers,
-                    json_data=json_data,
-                ),
+                url,
+                method,
+                params,
+                headers,
+                json_data,
                 original_data,
             )
 

src/OpenApiLibCore/__init__.py

@@ -40,6 +40,8 @@
     "set_auth",
     "set_extra_headers",
     "get_request_values",
+    "get_request_values_object",
+    "convert_request_values_to_dict",
     "get_request_data",
     "get_invalid_body_data",
     "get_invalidated_parameters",
@@ -51,6 +53,8 @@
     "get_invalidated_url",
     "ensure_in_use",
     "authorized_request",
+    "perform_authorized_request",
+    "validated_request",
     "perform_validated_request",
     "validate_response_using_validator",
     "assert_href_to_resource_is_valid",

src/OpenApiLibCore/openapi_libcore.py

@@ -243,7 +243,12 @@ def get_request_values(
         method: str,
         overrides: Mapping[str, JSON] = default_json_mapping,
     ) -> RequestValues:
-        """Return an object with all (valid) request values needed to make a request."""
+        """
+        Return an object with all (valid) request values needed to make a request.
+
+        The `overrides` dictionary can be used to pass specific values for parameters
+        instead of having them be generated automatically.
+        """
         json_data: JSON = {}
 
         url = _run_keyword("get_valid_url", path)
@@ -454,15 +459,11 @@ def authorized_request(  # pylint: disable=too-many-arguments
         files: Any = None,
     ) -> Response:
         """
-        Perform a request using the security token or authentication set in the library.
+        See the `Perform Authorized Request` keyword.
 
-        `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
+        The difference between these keywords is that this keyword accepts separate
+        arguments where `Perform Validated Request` accepts a `RequestValues` object
+        (see the `Get Request Values` keyword for details).
         """
         headers = deepcopy(headers) if headers else {}
         if self.extra_headers:
@@ -489,8 +490,120 @@ def authorized_request(  # pylint: disable=too-many-arguments
         logger.debug(f"Response text: {response.text}")
         return response
 
+    @keyword
+    def perform_authorized_request(
+        self,
+        request_values: RequestValues,
+        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
+
+        See also `Authorized Request` and `Get Request Values`.
+
+        > Note: provided username / password or auth objects take precedence over token
+            based security
+        """
+        return self.authorized_request(
+            url=request_values.url,
+            method=request_values.method,
+            params=request_values.params,
+            headers=request_values.headers,
+            json_data=request_values.json_data,
+            data=data,
+            files=files,
+        )
+
+    @keyword
+    def get_request_values_object(
+        self,
+        url: str,
+        method: str,
+        params: dict[str, JSON] = {},
+        headers: dict[str, str] = {},
+        json_data: JSON = None,
+    ) -> RequestValues:
+        """
+        This keyword can be used to instantiate a RequestValues object that can be used
+        with the `Perform Authorized Request` and `Perform Validated Request` keywords.
+
+        This is a utility keyword that can make certain test cases or keywords more
+        concise, but logging and debugging information will be more limited.
+
+        See also the `Get Request Values` keyword.
+        """
+        # RequestValues has methods that perform mutations on its values, so
+        # deepcopy to prevent mutation by reference.
+        params = deepcopy(params) if params else {}
+        headers = deepcopy(headers) if headers else {}
+        json_data = deepcopy(json_data)
+        return RequestValues(
+            url=url,
+            method=method,
+            params=params,
+            headers=headers,
+            json_data=json_data,
+        )
+
+    @keyword
+    def convert_request_values_to_dict(
+        self, request_values: RequestValues
+    ) -> dict[str, JSON]:
+        """Convert a RequestValues object to a dictionary."""
+        return {
+            "url": request_values.url,
+            "method": request_values.method,
+            "params": request_values.params,
+            "headers": request_values.headers,
+            "json_data": request_values.json_data,
+        }
+
     # endregion
     # region: validation keywords
+    @keyword
+    def validated_request(
+        self,
+        path: str,
+        status_code: int,
+        url: str,
+        method: str,
+        params: dict[str, JSON] = {},
+        headers: dict[str, str] = {},
+        json_data: JSON = None,
+        original_data: Mapping[str, JSON] = default_json_mapping,
+    ) -> None:
+        """
+        See the `Perform Validated Request` keyword.
+
+        The difference between these keywords is that this keyword accepts separate
+        arguments where `Perform Validated Request` accepts a `RequestValues` object
+        (see the `Get Request Values` keyword for details).
+        """
+        # RequestValues has methods that perform mutations on its values, so
+        # deepcopy to prevent mutation by reference.
+        params = deepcopy(params) if params else {}
+        headers = deepcopy(headers) if headers else {}
+        json_data = deepcopy(json_data)
+        request_values = RequestValues(
+            url=url,
+            method=method,
+            params=params,
+            headers=headers,
+            json_data=json_data,
+        )
+        _validation.perform_validated_request(
+            path=path,
+            status_code=status_code,
+            request_values=request_values,
+            original_data=original_data,
+        )
+
     @keyword
     def perform_validated_request(
         self,
@@ -503,6 +616,8 @@ def perform_validated_request(
         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).
+
+        See also `Validated Request` and `Get Request Values`.
         """
         _validation.perform_validated_request(
             path=path,

tests/libcore/suites/test_request_values.robot

@@ -0,0 +1,46 @@
+*** Settings ***
+Variables       ${ROOT}/tests/variables.py
+Library         Collections
+Library         OpenApiLibCore
+...                 source=${ORIGIN}/openapi.json
+...                 origin=${ORIGIN}
+...                 base_path=${EMPTY}
+...                 mappings_path=${ROOT}/tests/user_implemented/custom_user_mappings.py
+
+Test Tags       rf7
+
+
+*** Variables ***
+${ORIGIN}       http://localhost:8000
+
+
+*** Test Cases ***
+Test Requests Using RequestValues
+    ${request_values}=    Get Request Values    path=/employees    method=POST
+    ${request_values_dict}=    Convert Request Values To Dict    ${request_values}
+
+    ${response_using_request_values}=    Perform Authorized Request    request_values=${request_values}
+    Should Be Equal As Integers    ${response_using_request_values.status_code}    201
+
+    ${response_using_dict}=    Authorized Request    &{request_values_dict}
+    Should Be Equal As Integers    ${response_using_dict.status_code}    201
+
+    VAR    ${response_dict_using_request_values}=    ${response_using_request_values.json()}
+    VAR    ${response_dict_using_request_values_dict}=    ${response_using_dict.json()}
+
+    Should Not Be Equal
+    ...    ${response_dict_using_request_values}[identification]
+    ...    ${response_dict_using_request_values_dict}[identification]
+    Should Not Be Equal
+    ...    ${response_dict_using_request_values}[employee_number]
+    ...    ${response_dict_using_request_values_dict}[employee_number]
+
+    Remove From Dictionary    ${response_dict_using_request_values}    identification    employee_number
+    Remove From Dictionary    ${response_dict_using_request_values_dict}    identification    employee_number
+
+    Should Be Equal    ${response_dict_using_request_values}    ${response_dict_using_request_values_dict}
+
+    ${request_values_object}=    Get Request Values Object    &{request_values_dict}
+
+    Perform Validated Request    path=/employees    status_code=201    request_values=${request_values_object}
+    Validated Request    path=/employees    status_code=201    &{request_values_dict}