Merge pull request #5 from cloudblue/feature/assert-improvement-and-readme-update

Feature/Asserts improvements and README updates.

Author: marcserrat

README.md

@@ -1,7 +1,19 @@
 # Connect DevOps Testing Library
 
+![pyversions](https://img.shields.io/pypi/pyversions/connect-devops-testing-library.svg) [![PyPi Status](https://img.shields.io/pypi/v/connect-devops-testing-library.svg)](https://pypi.org/project/connect-devops-testing-library/) [![Build Status](https://github.com/cloudblue/connect-devops-testing-library/actions/workflows/test.yml/badge.svg)](https://github.com/cloudblue/connect-devops-testing-library/actions/workflows/test.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=connect-devops-testing-library&metric=alert_status)](https://sonarcloud.io/dashboard?id=connect-devops-testing-library)
+
 Testing library to ease Connect EaaS Processors development.
 
+## Install
+
+`Connect DevOps Testing Library` can be installed from [pypi.org](https://pypi.org/project/connect-devops-testing-library/) using pip:
+
+```bash
+$ pip install connect-devops-testing-library
+```
+
+## Usage
+
 DevOps Testing Library has a small request builder to ease the manipulation of the connect requests during testing:
 
 ````python
@@ -90,7 +102,7 @@ def test_should_approve_purchase_request_successfully():
 
 Once the request is dispatched the Dispatcher will reload the request again every `10` seconds a maximum of `20` 
 attempts. If the request has not been processed the asserts may fail. The wait time between request reload can be 
-configured directly in the `.provision_request(api_key=, api_url=)` method call.
+configured directly in the `.provision_request(timeout=10, max_attempt=20)` method call.
 
 Obviously, some Connect processors may take a lot of time to process a request, for those type of processors this kind
 of end-to-end test is not suitable.
@@ -145,3 +157,7 @@ def step_impl(context):
 ```
 
 The `@when("subscription request is processed")` is provided by the DevOps Testing Library.
+
+## License
+
+`Connect DevOps Testing Library` is released under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

connect/devops_testing/asserts.py

@@ -11,21 +11,29 @@
 
 
 def request_status(request: dict, expected: str):
-    assert request['status'] == expected
+    assert request.get('status') == expected
+
+
+def request_reason(request: dict, expected: str):
+    assert request.get('reason') == expected
+
+
+def request_note(request: dict, expected: str):
+    assert request.get('note') == 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
+    assert request.get('asset', {}).get('status') == expected
 
 
 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)
+    param = find_by_id(request.get('asset', {}).get('params', []), param_id, {})
+    assert fn(param.get('value'), expected)
 
 
 def asset_params_value_equal(request: dict, param_id: str, expected: Any):
@@ -36,32 +44,16 @@ 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: Any):
-    asset_params_value(request, param_id, '<', expected)
-
-
-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: Any):
-    asset_params_value(request, param_id, '>', expected)
-
-
-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: Any):
     fn = __operators.get('in')
-    param = find_by_id(request['asset']['params'], param_id)
+    param = find_by_id(request.get('asset', {}).get('params', []), param_id, {})
     assert fn(expected, param['value'])
 
 
 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)
+    param = find_by_id(request.get('asset', {}).get('params', []), param_id, {})
+    assert fn(param.get('value_error'), expected)
 
 
 def asset_params_value_equal_error(request: dict, param_id: str, expected: Any):
@@ -74,18 +66,18 @@ def asset_params_value_not_equal_error(request: dict, param_id: str, expected: A
 
 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'])
+    param = find_by_id(request.get('asset', {}).get('params', []), param_id, {})
+    assert fn(param.get('value_error'), expected)
 
 
 def tcr_status(request: dict, expected: str):
-    assert request['configuration']['status'] == expected
+    assert request.get('configuration', {}).get('status') == expected
 
 
 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)
+    param = find_by_id(request.get('configuration', {}).get('params', []), param_id, {})
+    assert fn(param.get('value'), expected)
 
 
 def tcr_params_value_equal(request: dict, param_id: str, expected: Any):
@@ -98,14 +90,14 @@ def tcr_params_value_not_equal(request: dict, param_id: str, expected: Any):
 
 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'])
+    param = find_by_id(request.get('configuration', {}).get('params', []), param_id, {})
+    assert fn(param.get('value'), expected)
 
 
 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)
+    param = find_by_id(request.get('configuration', {}).get('params', []), param_id, {})
+    assert fn(param.get('value_error'), expected)
 
 
 def tcr_params_value_equal_error(request: dict, param_id: str, expected: Any):
@@ -118,5 +110,5 @@ def tcr_params_value_not_equal_error(request: dict, param_id: str, expected: Any
 
 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'])
+    param = find_by_id(request.get('configuration', {}).get('params', []), param_id, {})
+    assert fn(param.get('value_error'), expected)

connect/devops_testing/utils.py

@@ -1,13 +1,14 @@
 from typing import List, Optional
 
 
-def find_by_id(collection: List, element_id: str) -> Optional[dict]:
+def find_by_id(collection: List, element_id: str, default: Optional[dict] = None) -> Optional[dict]:
     """
     Searches for a parameter/item with the given ``id`` within the ``list``.
 
     :param collection: The list of parameters/items to search.
     :param element_id: The id of the parameter/item to find.
-    :return: The parameter/list, or ``None`` if it was not found.
+    :param default: Default value to return if item is not found.
+    :return: The parameter/list, or ``default`` if it was not found.
     """
     filtered = list(filter(lambda element: element['id'] == element_id, collection))
-    return filtered[0] if filtered else None
+    return filtered[0] if filtered else default

tests/test_asserts.py

@@ -3,6 +3,8 @@
 asset_request = {
     'status': 'approved',
     'type': 'purchase',
+    'reason': 'some reason',
+    'note': 'some note',
     'asset': {
         'status': 'active',
         'params': [
@@ -36,6 +38,14 @@ def __init__(self, status: str):
     asserts.task_response_status(TaskResponse('success'), 'success')
 
 
+def test_should_assert_request_note():
+    asserts.request_note(asset_request, 'some note')
+
+
+def test_should_assert_request_reason():
+    asserts.request_reason(asset_request, 'some reason')
+
+
 def test_should_assert_asset_status():
     asserts.asset_status(asset_request, 'active')
 
@@ -49,7 +59,7 @@ def test_should_assert_asset_params_value_not_equal():
 
 
 def test_should_assert_asset_params_value_contains():
-    asserts.asset_params_value_contains(asset_request, 'ID', ['value'])
+    asserts.asset_params_value_contains(asset_request, 'ID', 'value')
 
 
 def test_should_assert_asset_params_value_equal_error():
@@ -61,7 +71,8 @@ def test_should_assert_asset_params_value_not_equal_error():
 
 
 def test_should_assert_asset_params_value_contains_error():
-    asserts.asset_params_value_contains_error(asset_request, 'ID', ['some error'])
+    asserts.asset_params_value_contains_error(asset_request, 'ID', 'some error')
+    asserts.asset_params_value_contains_error(asset_request, 'ID', 'some')
 
 
 def test_should_assert_tcr_status():
@@ -77,7 +88,7 @@ def test_should_assert_tcr_params_value_not_equal():
 
 
 def test_should_assert_tcr_params_value_contains():
-    asserts.tcr_params_value_contains(config_request, 'ID', ['value'])
+    asserts.tcr_params_value_contains(config_request, 'ID', 'value')
 
 
 def test_should_assert_tcr_params_value_equal_error():
@@ -89,4 +100,5 @@ def test_should_assert_tcr_params_value_not_equal_error():
 
 
 def test_should_assert_tcr_params_value_contains_error():
-    asserts.tcr_params_value_contains_error(config_request, 'ID', ['some error'])
+    asserts.tcr_params_value_contains_error(config_request, 'ID', 'some error')
+    asserts.tcr_params_value_contains_error(config_request, 'ID', 'some')