robotframework-openapitools 1.0.0b5__py3-none-any.whl → 1.0.1__py3-none-any.whl

OpenApiLibCore/openapi_libcore.py

@@ -1,123 +1,3 @@
-"""
-# OpenApiLibCore for Robot Framework
-
-The OpenApiLibCore library is a utility library that is meant to simplify creation
-of other Robot Framework libraries for API testing based on the information in
-an OpenAPI document (also known as Swagger document).
-This document explains how to use the OpenApiLibCore library.
-
-My RoboCon 2022 talk about OpenApiDriver and OpenApiLibCore can be found
-[here](https://www.youtube.com/watch?v=7YWZEHxk9Ps)
-
-For more information about Robot Framework, see http://robotframework.org.
-
----
-
-> Note: OpenApiLibCore is still being developed so there are currently
-restrictions / limitations that you may encounter when using this library to run
-tests against an API. See [Limitations](#limitations) for details.
-
----
-
-## Installation
-
-If you already have Python >= 3.8 with pip installed, you can simply run:
-
-`pip install --upgrade robotframework-openapi-libcore`
-
----
-
-## OpenAPI (aka Swagger)
-
-The OpenAPI Specification (OAS) defines a standard, language-agnostic interface
-to RESTful APIs, see https://swagger.io/specification/
-
-The OpenApiLibCore implements a number of Robot Framework keywords that make it
-easy to interact with an OpenAPI implementation by using the information in the
-openapi document (Swagger file), for examply by automatic generation of valid values
-for requests based on the schema information in the document.
-
-> Note: OpenApiLibCore is designed for APIs based on the OAS v3
-The library has not been tested for APIs based on the OAS v2.
-
----
-
-## Getting started
-
-Before trying to use the keywords exposed by OpenApiLibCore on the target API
-it's recommended to first ensure that the openapi document for the API is valid
-under the OpenAPI Specification.
-
-This can be done using the command line interface of a package that is installed as
-a prerequisite for OpenApiLibCore.
-Both a local openapi.json or openapi.yaml file or one hosted by the API server
-can be checked using the `prance validate <reference_to_file>` shell command:
-
-```shell
-prance validate --backend=openapi-spec-validator http://localhost:8000/openapi.json
-Processing "http://localhost:8000/openapi.json"...
- -> Resolving external references.
-Validates OK as OpenAPI 3.0.2!
-
-prance validate --backend=openapi-spec-validator /tests/files/petstore_openapi.yaml
-Processing "/tests/files/petstore_openapi.yaml"...
- -> Resolving external references.
-Validates OK as OpenAPI 3.0.2!
-```
-
-You'll have to change the url or file reference to the location of the openapi
-document for your API.
-
-> Note: Although recursion is technically allowed under the OAS, tool support is limited
-and changing the OAS to not use recursion is recommended.
-OpenApiLibCore has limited support for parsing OpenAPI documents with
-recursion in them. See the `recursion_limit` and `recursion_default` parameters.
-
-If the openapi document passes this validation, the next step is trying to do a test
-run with a minimal test suite.
-The example below can be used, with `source`, `origin` and `path` altered to
-fit your situation.
-
-``` robotframework
-*** Settings ***
-Library            OpenApiLibCore
-...                    source=http://localhost:8000/openapi.json
-...                    origin=http://localhost:8000
-
-*** Test Cases ***
-Getting Started
-    ${url}=    Get Valid Url    path=/employees/{employee_id}
-
-```
-
-Running the above suite for the first time may result in an error / failed test.
-You should look at the Robot Framework `log.html` to determine the reasons
-for the failing tests.
-Depending on the reasons for the failures, different solutions are possible.
-
-Details about the OpenApiLibCore library parameters and keywords that you may need can be found
-[here](https://marketsquare.github.io/robotframework-openapi-libcore/openapi_libcore.html).
-
-The OpenApiLibCore also support handling of relations between resources within the scope
-of the API being validated as well as handling dependencies on resources outside the
-scope of the API. In addition there is support for handling restrictions on the values
-of parameters and properties.
-
-Details about the `mappings_path` variable usage can be found
-[here](https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html).
-
----
-
-## Limitations
-
-There are currently a number of limitations to supported API structures, supported
-data types and properties. The following list details the most important ones:
-- Only JSON request and response bodies are supported.
-- No support for per-endpoint authorization levels.
-- Parsing of OAS 3.1 documents is supported by the parsing tools, but runtime behavior is untested.
-
-"""
-
 import json as _json
 import sys
 from collections.abc import Mapping, MutableMapping
@@ -165,21 +45,18 @@ from OpenApiLibCore.parameter_utils import (
 )
 from OpenApiLibCore.protocols import ResponseValidatorType
 from OpenApiLibCore.request_data import RequestData, RequestValues
+from openapitools_docs.docstrings import (
+    OPENAPILIBCORE_INIT_DOCSTRING,
+    OPENAPILIBCORE_LIBRARY_DOCSTRING,
+)
 
 run_keyword = BuiltIn().run_keyword
 default_str_mapping: Mapping[str, str] = MappingProxyType({})
 default_json_mapping: Mapping[str, JSON] = MappingProxyType({})
 
 
-@library(scope="SUITE", doc_format="ROBOT")
+@library(scope="SUITE", doc_format="HTML")
 class OpenApiLibCore:  # pylint: disable=too-many-public-methods
-    """
-    Main class providing the keywords and core logic to interact with an OpenAPI server.
-
-    Visit the [https://github.com/MarketSquare/robotframework-openapi-libcore | library page]
-    for an introduction.
-    """
-
     def __init__(  # noqa: PLR0913, pylint: disable=dangerous-default-value
         self,
         source: str,
@@ -204,126 +81,6 @@ class OpenApiLibCore:  # pylint: disable=too-many-public-methods
         cookies: MutableMapping[str, str] | CookieJar | None = None,
         proxies: MutableMapping[str, str] | None = None,
     ) -> None:
-        """
-        == Base parameters ==
-
-        === source ===
-        An absolute path to an openapi.json or openapi.yaml file or an url to such a file.
-
-        === origin ===
-        The server (and port) of the target server. E.g. ``https://localhost:8000``
-
-        === base_path ===
-        The routing between ``origin`` and the paths as found in the ``paths``
-        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 ===
-        See [https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html | this page]
-        for an in-depth explanation.
-
-        === invalid_property_default_response ===
-        The default response code for requests with a JSON body that does not comply
-        with the schema.
-        Example: a value outside the specified range or a string value
-        for a property defined as integer in the schema.
-
-        === default_id_property_name ===
-        The default name for the property that identifies a resource (i.e. a unique
-        entity) within the API.
-        The default value for this property name is ``id``.
-        If the target API uses a different name for all the resources within the API,
-        you can configure it globally using this property.
-
-        If different property names are used for the unique identifier for different
-        types of resources, an ``ID_MAPPING`` can be implemented using the ``mappings_path``.
-
-        === faker_locale ===
-        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 ===
-        The recursion depth to which to fully parse recursive references before the
-        `recursion_default` is used to end the recursion.
-
-        === recursion_default ===
-        The value that is used instead of the referenced schema when the
-        `recursion_limit` has been reached.
-        The default `{}` represents an empty object in JSON.
-        Depending on schema definitions, this may cause schema validation errors.
-        If this is the case, 'None' (``${NONE}`` in Robot Framework) or an empty list
-        can be tried as an alternative.
-
-        == Security-related parameters ==
-        _Note: these parameters are equivalent to those in the ``requests`` library._
-
-        === username ===
-        The username to be used for Basic Authentication.
-
-        === password ===
-        The password to be used for Basic Authentication.
-
-        === security_token ===
-        The token to be used for token based security using the ``Authorization`` header.
-
-        === auth ===
-        A [https://requests.readthedocs.io/en/latest/api/#authentication | requests ``AuthBase`` instance]
-        to be used for authentication instead of the ``username`` and ``password``.
-
-        === cert ===
-        The SSL certificate to use with all requests.
-        If string: the path to ssl client cert file (.pem).
-        If tuple: the ('cert', 'key') pair.
-
-        === verify_tls ===
-        Whether or not to verify the TLS / SSL certificate of the server.
-        If boolean: whether or not to verify the server TLS certificate.
-        If string: path to a CA bundle to use for verification.
-
-        === extra_headers ===
-        A dictionary with extra / custom headers that will be send with every request.
-        This parameter can be used to send headers that are not documented in the
-        openapi document or to provide an API-key.
-
-        === cookies ===
-        A dictionary or
-        [https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar | CookieJar object]
-        to send with all requests.
-
-        === proxies ===
-        A dictionary of 'protocol': 'proxy url' to use for all requests.
-        """
         self._source = source
         self._origin = origin
         self._base_path = base_path
@@ -912,3 +669,8 @@ class OpenApiLibCore:  # pylint: disable=too-many-public-methods
 
     def read_paths(self) -> dict[str, PathItemObject]:
         return self.openapi_spec.paths
+
+    __init__.__doc__ = OPENAPILIBCORE_INIT_DOCSTRING
+
+
+OpenApiLibCore.__doc__ = OPENAPILIBCORE_LIBRARY_DOCSTRING

openapi_libgen/__init__.py

@@ -0,0 +1,3 @@
+from openapitools_docs.docstrings import OPENAPILIBGEN_DOCUMENTATION
+
+__doc__ = OPENAPILIBGEN_DOCUMENTATION

openapi_libgen/generator.py

@@ -8,8 +8,6 @@ from openapi_libgen.spec_parser import get_keyword_data
 from OpenApiLibCore.models import OpenApiObject
 
 HERE = Path(__file__).parent.resolve()
-INIT_TEMPLATE_PATH = HERE / "templates/__init__.jinja"
-LIBRARY_TEMPLATE_PATH = HERE / "templates/library.jinja"
 
 
 def load_openapi_spec(