autopoll unit test improvements + cleanup + comments (#42)

Author: kp-cat

configcatclient/__init__.py

@@ -58,7 +58,7 @@ def create_client_with_auto_poll(sdk_key, poll_interval_seconds=60, max_init_wai
     :param connect_timeout_seconds: The number of seconds to wait for the server to make the initial connection
     (i.e. completing the TCP connection handshake). Default: 10 seconds.
     :param read_timeout_seconds: The number of seconds to wait for the server to respond before giving up. Default: 30 seconds.
-    :param flag_overrides: An FlagOverrides implementation used to override feature flags & settings.
+    :param flag_overrides: A FlagOverrides implementation used to override feature flags & settings.
     :param data_governance:
     Default: Global. Set this parameter to be in sync with the Data Governance preference on the Dashboard: \n
     https://app.configcat.com/organization/data-governance \n
@@ -104,7 +104,7 @@ def create_client_with_lazy_load(sdk_key, cache_time_to_live_seconds=60, config_
     :param connect_timeout_seconds: The number of seconds to wait for the server to make the initial connection
     (i.e. completing the TCP connection handshake). Default: 10 seconds.
     :param read_timeout_seconds: The number of seconds to wait for the server to respond before giving up. Default: 30 seconds.
-    :param flag_overrides: An FlagOverrides implementation used to override feature flags & settings.
+    :param flag_overrides: A FlagOverrides implementation used to override feature flags & settings.
     :param data_governance:
     Default: Global. Set this parameter to be in sync with the Data Governance preference on the Dashboard: \n
     https://app.configcat.com/organization/data-governance \n
@@ -144,7 +144,7 @@ def create_client_with_manual_poll(sdk_key, config_cache=None,
     :param connect_timeout_seconds: The number of seconds to wait for the server to make the initial connection
     (i.e. completing the TCP connection handshake). Default: 10 seconds.
     :param read_timeout_seconds: The number of seconds to wait for the server to respond before giving up. Default: 30 seconds.
-    :param flag_overrides: An FlagOverrides implementation used to override feature flags & settings.
+    :param flag_overrides: A FlagOverrides implementation used to override feature flags & settings.
     :param data_governance:
     Default: Global. Set this parameter to be in sync with the Data Governance preference on the Dashboard: \n
     https://app.configcat.com/organization/data-governance \n

configcatclient/configcatclient.py

@@ -81,7 +81,7 @@ def __init__(self,
         else:
             self._override_data_source = None
 
-        self._config_cache = options.config_cache if options.config_cache is not None else NullConfigCache()
+        config_cache = options.config_cache if options.config_cache is not None else NullConfigCache()
 
         if self._override_data_source and self._override_data_source.get_behaviour() == OverrideBehaviour.LocalOnly:
             self._config_fetcher = None
@@ -99,7 +99,7 @@ def __init__(self,
                                                  self._hooks,
                                                  self._config_fetcher,
                                                  self.log,
-                                                 self._config_cache,
+                                                 config_cache,
                                                  options.offline)
 
     def get_value(self, key, default_value, user=None):
@@ -139,8 +139,8 @@ def get_value_details(self, key, default_value, user=None):
         """
         settings, fetch_time = self.__get_settings()
         if settings is None:
-            message = 'Evaluating get_value(\'{}\') failed. Cache is empty. ' \
-                      'Returning default_value in your get_value call: [{}].'.format(key, str(default_value))
+            message = 'Evaluating get_value_details(\'{}\') failed. Cache is empty. ' \
+                      'Returning default_value in your get_value_details call: [{}].'.format(key, str(default_value))
             self.log.error(message)
             details = EvaluationDetails.from_error(key, default_value, message)
             self._hooks.invoke_on_flag_evaluated(details)

configcatclient/configcatoptions.py

@@ -86,13 +86,6 @@ def __init__(self,
                  default_user=None,
                  hooks=None,
                  offline=False):
-        """
-        Default: `DataGovernance.Global`. Set this parameter to be in sync with the
-        Data Governance preference on the [Dashboard](https://app.configcat.com/organization/data-governance).
-        (Only Organization Admins have access)
-        """
-        self.data_governance = data_governance
-
         # The base ConfigCat CDN url.
         self.base_url = base_url
 
@@ -117,6 +110,11 @@ def __init__(self,
         # Feature flag and setting overrides.
         self.flag_overrides = flag_overrides
 
+        # Default: `DataGovernance.Global`. Set this parameter to be in sync with the
+        # Data Governance preference on the [Dashboard](https://app.configcat.com/organization/data-governance).
+        # (Only Organization Admins have access)
+        self.data_governance = data_governance
+
         # The default user, used as fallback when there's no user parameter is passed to the getValue() method.
         self.default_user = default_user
 

configcatclient/configentry.py

@@ -27,9 +27,9 @@ def is_empty(self):
 
     def to_json(self):
         return {
+            ConfigEntry.CONFIG: self.config,
             ConfigEntry.ETAG: self.etag,
-            ConfigEntry.FETCH_TIME: self.fetch_time,
-            ConfigEntry.CONFIG: self.config
+            ConfigEntry.FETCH_TIME: self.fetch_time
         }
 
 

configcatclient/configfetcher.py

@@ -41,19 +41,19 @@ def __init__(self, status, entry, error=None, is_transient_error=False):
 
     def is_fetched(self):
         """Gets whether a new configuration value was fetched or not.
-        :return: True if a new configuration value was fetched, otherwise false.
+        :return: True if a new configuration value was fetched, otherwise False.
         """
         return self._status == Status.Fetched
 
     def is_not_modified(self):
         """Gets whether the fetch resulted a '304 Not Modified' or not.
-        :return: True if the fetch resulted a '304 Not Modified' code, otherwise false.
+        :return: True if the fetch resulted a '304 Not Modified' code, otherwise False.
         """
         return self._status == Status.NotModified
 
     def is_failed(self):
         """Gets whether the fetch failed or not.
-        :return: True if the fetch failed, otherwise false.
+        :return: True if the fetch failed, otherwise False.
         """
         return self._status == Status.Failure
 

configcatclient/interfaces.py

@@ -20,33 +20,6 @@ def set(self, key, value):
         """
 
 
-class CachePolicy(object):
-    """
-    Cache policy interface
-    """
-    __metaclass__ = ABCMeta
-
-    @abstractmethod
-    def get(self):
-        """
-        :returns the config json object from the cache, fetch time of the config
-        """
-
-    @abstractmethod
-    def force_refresh(self):
-        """
-
-        :return:
-        """
-
-    @abstractmethod
-    def stop(self):
-        """
-
-        :return:
-        """
-
-
 class ConfigCatClientException(Exception):
     """
     Generic ConfigCatClientException

configcatclienttests/test_autopollingcachepolicy.py

@@ -228,6 +228,9 @@ def test_return_cached_config_when_cache_is_not_expired(self):
 
         time.sleep(3)
 
+        settings, _ = cache_policy.get_settings()
+
+        self.assertEqual('testValue', settings.get('testKey').get(VALUE))
         self.assertEqual(config_fetcher.get_call_count, 1)
         self.assertEqual(config_fetcher.get_fetch_count, 1)
         cache_policy.close()
@@ -295,6 +298,8 @@ def test_online_offline(self):
 
             cache_policy.set_offline()
             self.assertTrue(cache_policy.is_offline())
+            settings, _ = cache_policy.get_settings()
+            self.assertEqual('testValue', settings.get('testStringKey').get(VALUE))
             self.assertEqual(2, request_get.call_count)
 
             time.sleep(2)
@@ -323,16 +328,23 @@ def test_init_offline(self):
                                          Hooks(), config_fetcher, log, NullConfigCache(), True)
 
             self.assertTrue(cache_policy.is_offline())
+            settings, _ = cache_policy.get_settings()
+            self.assertIsNone(settings)
             self.assertEqual(0, request_get.call_count)
 
             time.sleep(2)
 
+            settings, _ = cache_policy.get_settings()
+            self.assertIsNone(settings)
             self.assertEqual(0, request_get.call_count)
+
             cache_policy.set_online()
             self.assertFalse(cache_policy.is_offline())
 
             time.sleep(2.5)
 
+            settings, _ = cache_policy.get_settings()
+            self.assertEqual('testValue', settings.get('testStringKey').get(VALUE))
             self.assertGreaterEqual(request_get.call_count, 2)
             cache_policy.close()