Fixes flacky tests

Author: nunomaduro

algoliasearch/http/hosts.py

@@ -1,6 +1,6 @@
 from random import shuffle
 
-from typing import List
+from typing import List, Optional
 
 
 class Host(object):
@@ -41,12 +41,12 @@ def __init__(self, hosts):
                              reverse=True)
 
     def read(self):
-        # type: () -> HostsCollection
+        # type: () -> List[Host]
 
         return [host for host in self._hosts if host.accept & CallType.READ]
 
     def write(self):
-        # type: () -> HostsCollection
+        # type: () -> List[Host]
 
         return [host for host in self._hosts if host.accept & CallType.WRITE]
 

algoliasearch/http/transporter.py

@@ -1,7 +1,6 @@
 import time
 
-from typing import Optional, Union, Dict, Any
-
+from typing import Optional, Union, Dict, Any, List
 from algoliasearch.exceptions import (
     AlgoliaUnreachableHostException,
     RequestException
@@ -56,7 +55,7 @@ def read(self, verb, path, data, request_options):
         return self.request(verb, hosts, path, data, request_options, timeout)
 
     def request(self, verb, hosts, path, data, request_options, timeout):
-        # type: (str, list, int, str, Optional[Union[dict, list]], RequestOptions, int) -> dict # noqa: E501
+        # type: (str, List[Host], str, Optional[Union[dict, list]], RequestOptions, int) -> dict # noqa: E501
 
         if isinstance(data, dict):
             data.update(request_options.data)
@@ -76,7 +75,7 @@ def request(self, verb, hosts, path, data, request_options, timeout):
         return self.retry(hosts, request, relative_url)
 
     def retry(self, hosts, request, relative_url):
-        # type: (list, Request, str) -> dict
+        # type: (List[Host], Request, str) -> dict
 
         for host in self._retry_strategy.valid_hosts(hosts):
 

tests/features/http/test_requester.py

@@ -20,5 +20,7 @@ def test_http_error_exception(self):
 
         exception = cm.exception
         self.assertEqual(exception.status_code, 400)
-        self.assertEqual(str(exception),
-                         'Invalid object attributes: zadaz near line:1 column:8')
+        self.assertEqual(
+            str(exception),
+            'Invalid object attributes: zadaz near line:1 column:8'
+        )

tests/features/test_analytics_client.py

@@ -5,11 +5,12 @@
 
 from algoliasearch.exceptions import RequestException
 from tests.helpers.factory import Factory as F
+from tests.helpers.misc import RetryableClient
 
 
 class TestAnalyticsClient(unittest.TestCase):
     def setUp(self):
-        self.client = F.analytics_client()
+        self.client = RetryableClient(F.analytics_client())
         self.index = F.index(self._testMethodName)
         self.index2 = F.index('{}2'.format(self._testMethodName))
 

tests/features/test_search_client.py

@@ -143,9 +143,12 @@ def test_mcm(self):
 
         mcm.assign_user_id(user_id, clusters[0]['clusterName'])
 
-        self.assertEqual(
-            mcm.search_user_ids(user_id)['hits'][0]['userID'],
-            user_id
+        users_ids = [user['userID'] for user in
+                     mcm.search_user_ids(user_id)['hits']]
+
+        self.assertIn(
+            user_id,
+            users_ids
         )
 
         users = mcm.list_user_ids()

tests/helpers/factory.py

@@ -170,7 +170,7 @@ def rule(data=None, object_id=True):
     def decide(client):
 
         if os.environ.get('TEST_TYPE', False) == 'async':
-            from tests.fixtures.sync_decorator import SyncDecorator
+            from tests.helpers.misc_async import SyncDecorator
 
             return SyncDecorator(client)
 

tests/helpers/misc.py

@@ -0,0 +1,30 @@
+import time
+
+from algoliasearch.exceptions import RequestException
+
+
+class RetryableClient:
+
+    def __init__(self, base):
+
+        self._base = base
+
+    def __getattr__(self, name):
+
+        method = getattr(self._base, name)
+
+        def closure(*args, **kwargs):
+            result = None
+
+            while result is None:
+
+                try:
+                    result = method(*args, **kwargs)
+                except RequestException as e:
+                    if str(e) != 'Too Many Requests':
+                        raise e
+                    time.sleep(1)
+
+            return result
+
+        return closure

tests/fixtures/sync_decorator.py tests/helpers/misc_async.pytests/fixtures/sync_decorator.py renamed to tests/helpers/misc_async.py

@@ -1,6 +1,8 @@
 import asyncio
+import time
 import types
 
+from algoliasearch.exceptions import RequestException
 from algoliasearch.iterators import Iterator
 
 
@@ -15,9 +17,11 @@ def __init__(self, base):
         self._base = base
 
     def close(self):
+
         return self._base.close()
 
     def __getattr__(self, name):
+
         method = getattr(self._base, name)
 
         if not callable(method):
@@ -57,6 +61,7 @@ def user(self, user_token):
     def iterator_to_array(self, iterator):
 
         def closure():
+
             objects = []
 
             while True:

tox.ini

@@ -6,7 +6,6 @@ envlist =
     py{34,35,36,37}-async
     lint
     type
-    coverage
 
 [testenv]
 whitelist_externals = /bin/sh
@@ -28,10 +27,3 @@ description = static analysis checker
 basepython = python3.7
 commands = mypy --config-file mypy.ini -p algoliasearch --disallow-untyped-calls
 deps = -rrequirements/requirements-static-type-checker.txt
-
-[testenv:coverage]
-whitelist_externals = /bin/sh
-description = coverage checker
-basepython = python3.7
-commands = coverage: sh tests/run_tests_coverage.sh
-deps = -rrequirements/requirements-testing.txt