Add tests for helper functions

Author: mredolatti

splitapiclient/main/sync_apiclient.py

@@ -27,7 +27,7 @@ def __init__(self, config):
             self._base_url = config['base_url']
             self._apikey = config['apikey']
         else:
-            missing = [i not in config for i in ['base_url', 'apikey']]
+            missing = [i for i in ['base_url', 'apikey'] if i not in config]
             raise InsufficientConfigArgumentsException(
                 'The following keys must be present in the config dict: %s'
                 % ','.join(missing)

splitapiclient/resources/attribute.py

@@ -16,9 +16,11 @@ class Attribute(BaseResource):
         'isSearchable': 'bool',
     }
 
-    def __init__(self, data, client=None):
+    def __init__(self, data=None, client=None):
         '''
         '''
+        if not data:
+            data = {}
         BaseResource.__init__(self, data.get('id'), client)
         self._traffic_type_id = data.get('trafficTypeId')
         self._display_name = data.get('displayName')

splitapiclient/resources/environment.py

@@ -12,9 +12,11 @@ class Environment(BaseResource):
         'name': 'string',
     }
 
-    def __init__(self, data, client=None):
+    def __init__(self, data=None, client=None):
         '''
         '''
+        if not data:
+            data = {}
         BaseResource.__init__(self, data.get('id'), client)
         self._name = data.get('name')
 

splitapiclient/resources/identity.py

@@ -15,9 +15,11 @@ class Identity(BaseResource):
         'organizationId': 'string',
     }
 
-    def __init__(self, data, client=None):
+    def __init__(self, data=None, client=None):
         '''
         '''
+        if not data:
+            data = {}
         BaseResource.__init__(self, None, client)
         self._traffic_type_id = data.get('trafficTypeId')
         self._key = data.get('key')

splitapiclient/resources/traffic_type.py

@@ -12,10 +12,12 @@ class TrafficType(BaseResource):
         'displayAttributeId': 'string'
     }
 
-    def __init__(self, data, client=None):
+    def __init__(self, data=None, client=None):
         '''
         Constructor
         '''
+        if not data:
+            data = {}
         BaseResource.__init__(self, data.get('id'), client)
         self._name = data.get('name')
         self._display_attribute_id = data.get('displayAttributeId')

splitapiclient/tests/resources/test_attribute.py

@@ -41,7 +41,7 @@ def test_constructor(self, mocker):
     def test_getters_and_setters(self):
         '''
         '''
-        attr1 = Attribute({})
+        attr1 = Attribute()
         attr1.id = 'a'
         attr1.traffic_type_id = 'b'
         attr1.display_name = 'c'

splitapiclient/tests/resources/test_environment.py

@@ -35,7 +35,7 @@ def test_constructor(self, mocker):
     def test_getters_and_setters(self):
         '''
         '''
-        env1 = Environment({})
+        env1 = Environment()
         env1.id = 'a'
         env1.name = 'b'
 

splitapiclient/tests/resources/test_identity.py

@@ -35,7 +35,7 @@ def test_constructor(self, mocker):
     def test_getters_and_setters(self):
         '''
         '''
-        identity1 = Identity({})
+        identity1 = Identity()
         identity1.id = 'a'
         identity1.key = 'b'
         identity1.traffic_type_id = 'c'

splitapiclient/tests/resources/test_traffic_type.py

@@ -38,7 +38,7 @@ def test_constructor(self, mocker):
     def test_getters_and_setters(self):
         '''
         '''
-        tt1 = TrafficType({})
+        tt1 = TrafficType()
         tt1.id = 'a'
         tt1.name = 'b'
         tt1.display_attribute_id = 'c'

splitapiclient/tests/util/test_helpers.py

@@ -0,0 +1,79 @@
+from __future__ import absolute_import, division, print_function, \
+    unicode_literals
+
+from splitapiclient.util.exceptions import InvalidArgumentException, \
+    ClientRequiredError, InvalidModelException
+from splitapiclient.resources.base_resource import BaseResource
+from splitapiclient.resources import Attribute, Environment, Identity, TrafficType
+from splitapiclient.main.apiclient import BaseApiClient
+from splitapiclient.http_clients.base_client import BaseHttpClient
+from splitapiclient.microclients.attribute_microclient import AttributeMicroClient
+from splitapiclient.microclients.environment_microclient import EnvironmentMicroClient
+from splitapiclient.microclients.identity_microclient import IdentityMicroClient
+from splitapiclient.microclients.traffic_type_microclient import TrafficTypeMicroClient
+from splitapiclient.main.sync_apiclient import SyncApiClient
+from splitapiclient.util import helpers
+import pytest
+
+
+class TestHelperFuntions:
+    '''
+    '''
+
+    def test_require_client(self, mocker):
+        '''
+        '''
+        httpclient = mocker.Mock(spec=BaseHttpClient)
+        apiclient = SyncApiClient({'base_url': 'http://test', 'apikey': '123'})
+
+        models = ['Attribute', 'Environment', 'Identity', 'TrafficType']
+        microclients = [
+            AttributeMicroClient,
+            EnvironmentMicroClient,
+            IdentityMicroClient,
+            TrafficTypeMicroClient,
+        ]
+        # Test an exception is thrown if no client is passed
+        for m in models:
+            with pytest.raises(ClientRequiredError):
+                helpers.require_client(m, None, None)
+
+        # Test that an invalid model raises an exception
+        with pytest.raises(InvalidModelException):
+            helpers.require_client('invalidModel', None, None)
+
+        # Test that passing httpClient and no apiclient works
+        for i, m in enumerate(models):
+            c = helpers.require_client(m, httpclient, None)
+            assert isinstance(c, microclients[i])
+
+        # Test that passing ApiClient and no httpclient works
+        for i, m in enumerate(models):
+            c = helpers.require_client(m, None, apiclient)
+            assert isinstance(c, microclients[i])
+
+        # Test that passing both clients works
+        for i, m in enumerate(models):
+            c = helpers.require_client(m, httpclient, apiclient)
+            assert isinstance(c, microclients[i])
+
+    def test_as_dict(self, mocker):
+        '''
+        '''
+        model_instances = [
+            Attribute(),
+            Identity(),
+            Environment(),
+            TrafficType()
+        ]
+
+        # Test it works for all subclasses of BaseResource
+        for instance in model_instances:
+            assert isinstance(helpers.as_dict(instance), dict)
+
+        # Test it works for dictionaries
+        assert isinstance(helpers.as_dict(dict()), dict)
+
+        # Test if fails for anything other thatn those 2 cases
+        with pytest.raises(InvalidArgumentException):
+            helpers.as_dict('a string')