Merge pull request #4 from cloudblue/feaure/increase-code-coverage

Feature/Increase Code Coverage.

Author: marcserrat

connect/devops_testing/asserts.py

@@ -1,14 +1,11 @@
 import operator
+from typing import Any
 
 from connect.devops_testing.utils import find_by_id
 
 __operators = {
     '==': operator.eq,
     '!=': operator.ne,
-    '<': operator.gt,
-    '<=': operator.ge,
-    '>': operator.lt,
-    '>=': operator.le,
     'in': operator.contains,
 }
 
@@ -17,157 +14,109 @@ def request_status(request: dict, expected: str):
     assert request['status'] == expected
 
 
-def task_response_status(task_response, expected):
+def task_response_status(task_response, expected: str):
     assert task_response.status == expected
 
 
 def asset_status(request: dict, expected: str):
     assert request['asset']['status'] == expected
 
 
-def asset_params_value(request: dict, param_id: str, operator: str, expected: str):
+def asset_params_value(request: dict, param_id: str, operator: str, expected: Any):
     fn = __operators.get(operator)
     param = find_by_id(request['asset']['params'], param_id)
     assert fn(param['value'], expected)
 
 
-def asset_params_value_equal(request: dict, param_id: str, expected: str):
+def asset_params_value_equal(request: dict, param_id: str, expected: Any):
     asset_params_value(request, param_id, '==', expected)
 
 
-def asset_params_value_not_equal(request: dict, param_id: str, expected: str):
+def asset_params_value_not_equal(request: dict, param_id: str, expected: Any):
     asset_params_value(request, param_id, '!=', expected)
 
 
-def asset_params_value_greater(request: dict, param_id: str, expected: str):
+def asset_params_value_greater(request: dict, param_id: str, expected: Any):
     asset_params_value(request, param_id, '<', expected)
 
 
-def asset_params_value_greater_or_equal(request: dict, param_id: str, expected: str):
+def asset_params_value_greater_or_equal(request: dict, param_id: str, expected: Any):
     asset_params_value(request, param_id, '<=', expected)
 
 
-def asset_params_value_lesser(request: dict, param_id: str, expected: str):
+def asset_params_value_lesser(request: dict, param_id: str, expected: Any):
     asset_params_value(request, param_id, '>', expected)
 
 
-def asset_params_value_lesser_or_equal(request: dict, param_id: str, expected: str):
+def asset_params_value_lesser_or_equal(request: dict, param_id: str, expected: Any):
     asset_params_value(request, param_id, '>=', expected)
 
 
-def asset_params_value_contains(request: dict, param_id: str, expected):
+def asset_params_value_contains(request: dict, param_id: str, expected: Any):
     fn = __operators.get('in')
     param = find_by_id(request['asset']['params'], param_id)
     assert fn(expected, param['value'])
 
 
-def asset_params_value_error(request: dict, param_id: str, operator: str, expected: str):
+def asset_params_value_error(request: dict, param_id: str, operator: str, expected: Any):
     fn = __operators.get(operator)
     param = find_by_id(request['asset']['params'], param_id)
     assert fn(param['value_error'], expected)
 
 
-def asset_params_value_equal_error(request: dict, param_id: str, expected: str):
+def asset_params_value_equal_error(request: dict, param_id: str, expected: Any):
     asset_params_value_error(request, param_id, '==', expected)
 
 
-def asset_params_value_not_equal_error(request: dict, param_id: str, expected: str):
+def asset_params_value_not_equal_error(request: dict, param_id: str, expected: Any):
     asset_params_value_error(request, param_id, '!=', expected)
 
 
-def asset_params_value_greater_error(request: dict, param_id: str, expected: str):
-    asset_params_value_error(request, param_id, '<', expected)
-
-
-def asset_params_value_greater_or_equal_error(request: dict, param_id: str, expected: str):
-    asset_params_value_error(request, param_id, '<=', expected)
-
-
-def asset_params_value_lesser_error(request: dict, param_id: str, expected: str):
-    asset_params_value_error(request, param_id, '>', expected)
-
-
-def asset_params_value_lesser_or_equal_error(request: dict, param_id: str, expected: str):
-    asset_params_value_error(request, param_id, '>=', expected)
-
-
-def asset_params_value_contains_error(request: dict, param_id: str, expected):
+def asset_params_value_contains_error(request: dict, param_id: str, expected: Any):
     fn = __operators.get('in')
     param = find_by_id(request['asset']['params'], param_id)
     assert fn(expected, param['value_error'])
 
 
-def tcr_status(expected: str, request: dict):
+def tcr_status(request: dict, expected: str):
     assert request['configuration']['status'] == expected
 
 
-def tcr_params_value(request: dict, param_id: str, operator: str, expected: str):
+def tcr_params_value(request: dict, param_id: str, operator: str, expected: Any):
     fn = __operators.get(operator)
     param = find_by_id(request['configuration']['params'], param_id)
     assert fn(param['value'], expected)
 
 
-def tcr_params_value_equal(request: dict, param_id: str, expected: str):
+def tcr_params_value_equal(request: dict, param_id: str, expected: Any):
     tcr_params_value(request, param_id, '==', expected)
 
 
-def tcr_params_value_not_equal(request: dict, param_id: str, expected: str):
+def tcr_params_value_not_equal(request: dict, param_id: str, expected: Any):
     tcr_params_value(request, param_id, '!=', expected)
 
 
-def tcr_params_value_greater(request: dict, param_id: str, expected: str):
-    tcr_params_value(request, param_id, '<', expected)
-
-
-def tcr_params_value_greater_or_equal(request: dict, param_id: str, expected: str):
-    tcr_params_value(request, param_id, '<=', expected)
-
-
-def tcr_params_value_lesser(request: dict, param_id: str, expected: str):
-    tcr_params_value(request, param_id, '>', expected)
-
-
-def tcr_params_value_lesser_or_equal(request: dict, param_id: str, expected: str):
-    tcr_params_value(request, param_id, '>=', expected)
-
-
-def tcr_params_value_contains(request: dict, param_id: str, expected: str):
+def tcr_params_value_contains(request: dict, param_id: str, expected: Any):
     fn = __operators.get('in')
     param = find_by_id(request['configuration']['params'], param_id)
     assert fn(expected, param['value'])
 
 
-def tcr_params_value_error(request: dict, param_id: str, operator: str, expected: str):
+def tcr_params_value_error(request: dict, param_id: str, operator: str, expected: Any):
     fn = __operators.get(operator)
     param = find_by_id(request['configuration']['params'], param_id)
     assert fn(param['value_error'], expected)
 
 
-def tcr_params_value_equal_error(request: dict, param_id: str, expected: str):
+def tcr_params_value_equal_error(request: dict, param_id: str, expected: Any):
     tcr_params_value_error(request, param_id, '==', expected)
 
 
-def tcr_params_value_not_equal_error(request: dict, param_id: str, expected: str):
+def tcr_params_value_not_equal_error(request: dict, param_id: str, expected: Any):
     tcr_params_value_error(request, param_id, '!=', expected)
 
 
-def tcr_params_value_greater_error(request: dict, param_id: str, expected: str):
-    tcr_params_value_error(request, param_id, '<', expected)
-
-
-def tcr_params_value_greater_or_equal_error(request: dict, param_id: str, expected: str):
-    tcr_params_value_error(request, param_id, '<=', expected)
-
-
-def tcr_params_value_lesser_error(request: dict, param_id: str, expected: str):
-    tcr_params_value_error(request, param_id, '>', expected)
-
-
-def tcr_params_value_lesser_or_equal_error(request: dict, param_id: str, expected: str):
-    tcr_params_value_error(request, param_id, '>=', expected)
-
-
-def tcr_params_value_contains_error(request: dict, param_id: str, expected: str):
+def tcr_params_value_contains_error(request: dict, param_id: str, expected: Any):
     fn = __operators.get('in')
     param = find_by_id(request['configuration']['params'], param_id)
     assert fn(expected, param['value_error'])

connect/devops_testing/bdd/fixures.py

@@ -3,14 +3,16 @@
 from connect.devops_testing.fixures import make_request_builder, make_request_dispatcher
 
 
-def use_connect_request_dispatcher(context: Context):
+def use_connect_request_dispatcher(context: Context, use_specs: bool = True):
     """
     Provides a connect request provider into the behave Context object.
 
     :param context: Context
+    :param use_specs: bool True to initialize the Open API Specification
+                      live connection
     :return: None
     """
-    context.connect = make_request_dispatcher()
+    context.connect = make_request_dispatcher(use_specs=use_specs)
     context.request = None
 
 

connect/devops_testing/fixures.py

@@ -1,5 +1,6 @@
 from typing import Optional
 
+from connect.client import ConnectClient
 from connect.devops_testing.request import Builder, Dispatcher
 
 import os
@@ -8,29 +9,11 @@
 __CONNECT_API_URL = 'CONNECT_API_URL'
 
 
-def __get_credentials_from_env(
-    api_key: Optional[str] = None,
-    api_url: Optional[str] = None,
-) -> dict:
-    """
-    Retrieve credentials from environment.
-
-    :param api_key: str
-    :param api_url: str
-    :return: dict
-    """
-    if api_key is None:
-        api_key = os.getenv(key=__CONNECT_API_KEY, default='unavailable')
-
-    if api_url is None:
-        api_url = os.getenv(key=__CONNECT_API_URL, default='unavailable')
-
-    return {'api_key': api_key, 'api_url': api_url}
-
-
 def make_request_dispatcher(
-    api_key: Optional[str] = None,
-    api_url: Optional[str] = None,
+        api_key: Optional[str] = None,
+        api_url: Optional[str] = None,
+        client: ConnectClient = None,
+        use_specs: bool = True,
 ) -> Dispatcher:
     """
     Initializes a Dispatcher service.
@@ -39,15 +22,38 @@ def make_request_dispatcher(
     - CONNECT_API_KEY
     - CONNECT_API_URL
 
+    :return: Dispatcher
+    :param api_key: Optional[str] The Connect API Key.
+    :param api_url: Optional[str] The Connect API Url endpoint.
+    :param client: ConnectClient Optional Connect Open API Client already
+                   instantiated if this value is provided the api_key and
+                   api_url will be omitted as they are not used.
+    :param use_specs: bool True to initialize the Open API Specification
+                      live connection
     :return: Dispatcher
     """
-    return Dispatcher.init(**__get_credentials_from_env(api_key, api_url))
+    if client is None:
+        if api_key is None:
+            api_key = os.getenv(key=__CONNECT_API_KEY, default='unavailable')
+
+        if api_url is None:
+            api_url = os.getenv(key=__CONNECT_API_URL, default='unavailable')
+
+        client = ConnectClient(
+            api_key=api_key,
+            endpoint=api_url,
+            use_specs=use_specs,
+        )
+
+    return Dispatcher(client=client)
 
 
 def make_request_builder(path: Optional[str] = None) -> Builder:
     """
     Provides a Connect Request Builder
 
+    :param path: Optional[str] The optional file path to a
+                 connect json request sample.
     :return: Builder
     """
     return Builder() if path is None else Builder.from_file(path)