robotframework-schemathesislibrary 0.9.0__py3-none-any.whl → 0.10.0__py3-none-any.whl

SchemathesisLibrary/__init__.py

@@ -31,7 +31,7 @@ from schemathesis.core import NotSet
 from schemathesis.core.result import Ok
 from schemathesis.core.transport import Response
 
-__version__ = "0.9.0"
+__version__ = "0.10.0"
 
 
 @dataclass
@@ -77,10 +77,42 @@ def from_case(case: Case) -> TestCaseData:
 
 
 class SchemathesisLibrary(DynamicCore):
+    """SchemathesisLibrary is a library for validating API cases using Schemathesis.
+
+    %TOC%
+
+    Example usage of the library and the `Call And Validate` keyword
+
+    Library must be imported with the `url` or `path` argument to specify the
+    OpenAPI schema. The library uses
+    [DataDriver|https://github.com/Snooz82/robotframework-datadriver] to generate
+    test cases from the OpenAPI schema by using
+    [Schemathesis|https://github.com/schemathesis/schemathesis/]. The library
+    creates test cases that takes one argument, `${case}`, which is a
+    Schemathesis
+    [Case|https://schemathesis.readthedocs.io/en/stable/reference/python/#schemathesis.Case]
+    object. The `Call And Validate` keyword can be used to call and validate
+    the case. The keyword will log the request and response details.
+
+    Example:
+    | *** Settings ***
+    | Library             SchemathesisLibrary    url=http://127.0.0.1/openapi.json
+    |
+    | Test Template       Wrapper
+    |
+    | *** Test Cases ***
+    | All Tests   # This test is deleted by DataDriver
+    |     Wrapper    test_case_1
+    |
+    | *** Keywords ***
+    | Wrapper
+    |     [Arguments]    ${case}
+    |     Call And Validate    ${case}
+    """
+
     ROBOT_LIBRARY_VERSION = __version__
     ROBOT_LISTENER_API_VERSION = 3
     ROBOT_LIBRARY_SCOPE = "TEST SUITE"
-    """SchemathesisLibrary is a library for validating API cases using Schemathesis."""
 
     def __init__(
         self,
@@ -90,6 +122,14 @@ class SchemathesisLibrary(DynamicCore):
         path: "Path|None" = None,
         url: "str|None" = None,
     ) -> None:
+        """The SchemathesisLibrary can be initialized with the following arguments:
+
+        | =Argument=                        | =Description= |
+        | `headers`                         | Optional HTTP headers to be used schema is downloaded from `url`. |
+        | `max_examples`                    | Maximum number of examples to generate for each operation. Default is 5. |
+        | `path`                            | Path to the OpenAPI schema file. Using either `path` or `url` is mandatory. |
+        | `url`                             | URL where the OpenAPI schema can be downloaded. |
+        """
         self.ROBOT_LIBRARY_LISTENER = self
         SchemathesisReader.options = Options(headers=headers, max_examples=max_examples, path=path, url=url)
         self.data_driver = DataDriver(reader_class=SchemathesisReader)
@@ -110,7 +150,11 @@ class SchemathesisLibrary(DynamicCore):
         base_url: "str|None" = None,
         headers: "dict[str, Any]|None" = None,
     ) -> Response:
-        """Validate a Schemathesis case."""
+        """Call and validate a Schemathesis case.
+
+        Example:
+        | ${response} =    Call And Validate Case    ${case}
+        """
         self.info(f"Case: {case.path} | {case.method} | {case.path_parameters}")
         self._log_case(case, headers)
         response = case.call_and_validate(base_url=base_url, headers=headers, auth=auth)
@@ -118,6 +162,43 @@ class SchemathesisLibrary(DynamicCore):
         self.debug(f"Response: {response.headers} | {response.status_code} | {response.text}")
         return response
 
+    @keyword
+    def call(
+        self,
+        case: Case,
+        *,
+        auth: "Any|None" = None,
+        base_url: "str|None" = None,
+        headers: "dict[str, Any]|None" = None,
+    ) -> Response:
+        """Call a Schemathesis case without validation.
+
+        The `Call` and `Validate Response` keywords can be used together
+        to call a case and validate the response.
+
+        Example:
+        | ${response} =    Call Case    ${case}
+        | Validate Response    ${case}    ${response}
+        """
+        self.info(f"Calling case: {case.path} | {case.method} | {case.path_parameters}")
+        self._log_case(case)
+        response = case.call(base_url=base_url, headers=headers, auth=auth)
+        self._log_request(response)
+        return response
+
+    @keyword
+    def validate_response(self, case: Case, response: Response) -> None:
+        """Validate a Schemathesis response.
+
+        The response is validated against the case's expectations.
+        The `Call` and `Validate Response` keywords can be used together
+        to call a case and validate the response. See the example from
+        `Call` keyword documentation.
+        """
+        self.info(f"Validating response: {response.status_code} | {response.headers}")
+        case.validate_response(response)
+        self.info("Response validation passed.")
+
     def info(self, message: str) -> None:
         logger.info(message)
 

{robotframework_schemathesislibrary-0.9.0.dist-info → robotframework_schemathesislibrary-0.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-schemathesislibrary
-Version: 0.9.0
+Version: 0.10.0
 Summary: Robot Framework SchemathesisLibrary to automatically create test cases from API specifications.
 Author-email: Tatu Aalto <aalto.tatu@gmail.com>
 License-Expression: Apache-2.0

robotframework_schemathesislibrary-0.10.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+SchemathesisLibrary/__init__.py,sha256=5djP2l57izkwadVfQxl2vr1kr2QRzv2zw_5uirdnz6E,9117
+robotframework_schemathesislibrary-0.10.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+robotframework_schemathesislibrary-0.10.0.dist-info/METADATA,sha256=qolKj68hIRLbNxj9nq7r9aUxdTIE6sLkqi_FXOiWMMs,2670
+robotframework_schemathesislibrary-0.10.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+robotframework_schemathesislibrary-0.10.0.dist-info/top_level.txt,sha256=bVGNag3IIuKRUVgjTtfRyDvyN3qRFYSSpmbCl5MBrUU,20
+robotframework_schemathesislibrary-0.10.0.dist-info/RECORD,,

robotframework_schemathesislibrary-0.9.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-SchemathesisLibrary/__init__.py,sha256=KqOh3P8dCWHqedP-mawSjoeiXh1d6SUI16W3UxPBOAg,5928
-robotframework_schemathesislibrary-0.9.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-robotframework_schemathesislibrary-0.9.0.dist-info/METADATA,sha256=711603PVQtLPiyzk-gvpxfFm_peQCkiGo67jj77DWzo,2669
-robotframework_schemathesislibrary-0.9.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-robotframework_schemathesislibrary-0.9.0.dist-info/top_level.txt,sha256=bVGNag3IIuKRUVgjTtfRyDvyN3qRFYSSpmbCl5MBrUU,20
-robotframework_schemathesislibrary-0.9.0.dist-info/RECORD,,