v0.1.4 (#27)

* changed version pinning (v0.1.1)

* fixed incorrect positional args (#23)

* fixed incorrect api path (#24)

* updated version

* updated changelog

* fixed conversion bug in _request

* cleanup and additional tests

* fixed an error in payload sanitization for put operations

* added tests for object crud operations

* added additional tests for helper functions

* added create_object test

* updated version to 0.1.4

Co-authored-by: Oliver Kaiser <ok@ong.at>

Author: kaisero

CHANGELOG.md

@@ -1,3 +1,14 @@
+# 0.1.4
+
+## Bugfixes
+
+Added a fix to correctly sanitize payloads for put operations
+Corrected cache_result condition that did not match correctly
+
+## Enhancements
+
+Added various tests for better qa
+
 # 0.1.3
 
 ## Bugfixes

Pipfile

@@ -23,6 +23,7 @@ mypy = "==0.770"
 pre-commit = "==2.2.0"
 pytest = "==5.4.1"
 pytest-cov = "==2.8.1"
+pytest-moc = "==3.2.0"
 pytest-runner = "==5.2"
 tox = "==3.14.6"
 twine = "==3.1.1"

fireREST/__init__.py

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+ # -*- coding: utf-8 -*-
 
 import json
 import logging
@@ -181,7 +181,7 @@ def _create(self, url: str, data: Dict, params=None):
         : param params: dict of parameters for http request
         : return: requests.Response object
         '''
-        data = self._sanitize(data)
+        data = self._sanitize('post', data)
         return self._request('post', url, params=params, data=data)
 
     def _update(self, url: str, data: Dict, params=None):
@@ -192,10 +192,10 @@ def _update(self, url: str, data: Dict, params=None):
         : param params: dict of parameters for http request
         : return: requests.Response object
         '''
-        data = self._sanitize(data)
-        return self._request(url, data=data, params=params)
+        data = self._sanitize('put', data)
+        return self._request('put', url, data=data, params=params)
 
-    def _sanitize(self, payload: Dict):
+    def _sanitize(self, method: str, payload: Dict):
         '''
         Prepare json object for api operation
         This is neccesarry since fmc api cannot handle json objects with some
@@ -206,10 +206,12 @@ def _sanitize(self, payload: Dict):
         sanitized_payload = deepcopy(payload)
         sanitized_payload.pop('metadata', None)
         sanitized_payload.pop('links', None)
-        sanitized_payload.pop('id', None)
+        if method == 'post':
+            sanitized_payload.pop('id', None)
         return sanitized_payload
 
-    @utils.cache_result
+    # @utils.cache_result
+    @utils.validate_object_type
     @utils.minimum_version_required('6.1.0')
     def get_object_id_by_name(self, object_type: str, object_name: str):
         '''

fireREST/decorators.py

@@ -46,18 +46,21 @@ def cache_result(f):
     decorator that applies functools lru_cache if cache is enabled in Client object
     '''
 
-    def enabled(*args, **kwargs):
-        return args[0].cache
-
-    if enabled:
+    def inner_function(f):
+        @lru_cache(maxsize=256)
+        def cache(*args, **kwargs):
+            return f(*args, **kwargs)
 
         @wraps(f)
         @lru_cache(maxsize=256)
         def wrapper(*args, **kwargs):
+            if args[0].cache is True:
+                return cache
             return f(*args, **kwargs)
 
         return wrapper
-    return f
+
+    return inner_function
 
 
 def log_request(action):

fireREST/utils.py

@@ -1 +1 @@
-__version__ = '0.1.3'
+__version__ = '0.1.4'

fireREST/version.py

@@ -21,4 +21,82 @@ def test_initialization(api, constants):
     assert api.protocol == expected_protocol
     assert api.verify_cert == expected_verify_cert
     assert api.timeout == expected_timeout
-    assert api.domain_name == expected_domain_name
+    assert api.domain_name == expected_domain_name
+
+
+def test_get_domain_id_by_name_with_correct_name(api):
+    expected_result = api.domain
+    actual_result = api.get_domain_id_by_name(api.domain_name)
+
+    assert expected_result == actual_result
+
+
+def test_get_domain_id_by_name_with_incorrect_name(api):
+    expected_result = None
+    actual_result = api.get_domain_id_by_name('NON-EXISTING-DOMAIN')
+
+    assert expected_result == actual_result
+
+
+def test_get_domain_name_by_id_with_correct_id(api):
+    expected_result = 'Global'
+    actual_result = api.get_domain_name_by_id(api.domain)
+
+    assert expected_result == actual_result
+
+
+def test_get_domain_name_by_id_with_incorrect_id(api):
+    expected_result = None
+    actual_result = api.get_domain_name_by_id('NON-EXISTING-DOMAIN-ID')
+
+    assert expected_result == actual_result
+
+
+def test_create_object(api):
+    payload = {
+        'name': 'firerest_test_netobj',
+        'value': '198.18.0.0/24',
+    }
+
+    actual_result = api.create_object('network', payload).status_code
+    expected_result = 201
+
+    assert expected_result == actual_result
+
+
+def test_get_object(api):
+    object_id = api.get_object_id_by_name('network', 'firerest_test_netobj')
+    expected_object = {
+        'id': object_id,
+        'name': 'firerest_test_netobj',
+        'value': '198.18.0.0/24',
+    }
+    actual_object = api.get_object('network', object_id)
+
+    assert expected_object['id'] == actual_object['id']
+    assert expected_object['name'] == actual_object['name']
+    assert expected_object['value'] == actual_object['value']
+
+
+def test_update_object(api):
+    expected_response = 200
+    expected_description = 'test_update_object'
+
+    object_id = api.get_object_id_by_name('network', 'firerest_test_netobj')
+    payload = api.get_object('network', object_id)
+    payload['description'] = expected_description
+
+    actual_response = api.update_object('network', object_id, payload).status_code
+    actual_description = api.get_object('network', object_id)['description']
+
+    assert expected_response == actual_response
+    assert expected_description == actual_description
+
+
+def test_delete_object(api):
+    object_id = api.get_object_id_by_name('network', 'firerest_test_netobj')
+
+    actual_result = api.delete_object('network', object_id).status_code
+    expected_result = 200
+
+    assert expected_result == actual_result

test/test_fireREST.py

@@ -4,7 +4,7 @@
 
 from uuid import uuid4
 
-from fireREST import utils
+from fireREST import exceptions, utils
 
 
 def test_is_uuid_with_valid_uuid():
@@ -17,7 +17,7 @@ def test_is_uuid_with_valid_uuid():
 
 
 def test_is_uuid_with_invalid_uuid():
-    invalid_uuid = str('override')
+    invalid_uuid = str('invalid-uuid')
     expected_result = False
 
     actual_result = utils.is_uuid(invalid_uuid)
@@ -26,9 +26,11 @@ def test_is_uuid_with_invalid_uuid():
 
 
 def test_is_getbyid_operation_with_valid_getbyid_operation():
-    valid_getbyid_operation = 'https://localhost' \
-                              '/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f' \
-                              '/object/networkgroups/A09351F4-691E-0ed3-0000-034359739130'
+    valid_getbyid_operation = (
+        'https://localhost'
+        '/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f'
+        '/object/networkgroups/A09351F4-691E-0ed3-0000-034359739130'
+    )
     expected_result = True
 
     actual_result = utils.is_getbyid_operation(valid_getbyid_operation)
@@ -37,9 +39,11 @@ def test_is_getbyid_operation_with_valid_getbyid_operation():
 
 
 def test_is_getbyid_operation_with_valid_getbyid_operation_with_params():
-    valid_getbyid_operation = 'https://localhost' \
-                              '/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f' \
-                              '/object/networkgroups/A09351F4-691E-0ed3-0000-034359739130?expanded=True'
+    valid_getbyid_operation = (
+        'https://localhost'
+        '/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f'
+        '/object/networkgroups/A09351F4-691E-0ed3-0000-034359739130?expanded=True'
+    )
     expected_result = True
 
     actual_result = utils.is_getbyid_operation(valid_getbyid_operation)
@@ -48,20 +52,40 @@ def test_is_getbyid_operation_with_valid_getbyid_operation_with_params():
 
 
 def test_is_getbyid_operation_with_invalid_getbyid_operation():
-    valid_getbyid_operation = 'https://localhost' \
-                              '/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f' \
-                              '/object/networkgroups/A09351F4-691E-0ed3-0000-034359739130/overrides'
+    valid_getbyid_operation = (
+        'https://localhost'
+        '/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f'
+        '/object/networkgroups/A09351F4-691E-0ed3-0000-034359739130/overrides'
+    )
     expected_result = False
 
     actual_result = utils.is_getbyid_operation(valid_getbyid_operation)
 
     assert expected_result == actual_result
 
 
-# def test_rate_limit_retry(api):
-#    for i in range(1, 121, 1):
-#        response = api.get_system_version()
-#
-#    expected_result = 200
-#
-#    assert expected_result == response.status_code
+def test_validate_data_with_supported_payload_size():
+    class ValidObject(object):
+        def __init__(self):
+            pass
+
+        def __sizeof__(self):
+            return 1024
+
+    expected_result = None
+    actual_result = utils.validate_data('post', ValidObject())
+
+    assert expected_result == actual_result
+
+
+def test_validate_data_with_unsupported_payload_size():
+    with pytest.raises(exceptions.PayloadLimitExceededError):
+
+        class ValidObject(object):
+            def __init__(self):
+                pass
+
+            def __sizeof__(self):
+                return 204800100
+
+        utils.validate_data('post', ValidObject())