Merge pull request #49 from algolia/fix-build

Fix CI with a more accurate wait for keys updates

Author: LeoErcolanelli

tests/helpers.py

@@ -3,6 +3,7 @@
 from __future__ import unicode_literals
 
 import os
+import time
 from random import randint
 
 from faker import Factory
@@ -36,7 +37,7 @@ def generate_id(self):
                 return str(new_id)
 
 
-def get_api_client():    
+def get_api_client():
     if 'APPENGINE_RUNTIME' in os.environ:
         from google.appengine.api import apiproxy_stub_map 
         from google.appengine.api import urlfetch_stub
@@ -51,3 +52,25 @@ def safe_index_name(name):
         return name
     job = os.environ['TRAVIS_JOB_NUMBER']
     return '{0}_travis-{1}'.format(name, job)
+
+
+def wait_key(index, key, block=None):
+    for i in range(60):
+        try:
+            k = index.get_user_key_acl(key)
+            if block is None or block(k):
+                return
+        except:
+            pass
+        # Not found.
+        time.sleep(1)
+
+
+def wait_missing_key(index, key):
+    for i in range(60):
+        try:
+            index.get_user_key_acl(key)
+            time.sleep(1)
+        except:
+            # Not found.
+            return

tests/test_keys.py

@@ -15,6 +15,7 @@
 from .helpers import safe_index_name
 from .helpers import get_api_client
 from .helpers import FakeData
+from .helpers import wait_key, wait_missing_key
 
 
 class KeyTest(unittest.TestCase):
@@ -64,7 +65,7 @@ def test_add_user_keys(self):
     def test_get_user_key(self):
         res = self.client.add_user_key(['search'])
         key = res['key']
-        time.sleep(5)
+        wait_key(self.client, key)
 
         res = self.client.get_user_key_acl(key)
         self.assertEqual(res['value'], key)
@@ -79,28 +80,30 @@ def test_update_user_keys(self):
             res = self.client.add_user_key(['search'])
             keys.append(res['key'])
 
-        time.sleep(5)
+        for k in keys:
+            wait_key(self.client, k)
 
         res = self.client.update_user_key(keys[0], ['addObject'],
                                           max_queries_per_ip_per_hour=5)
         self.assertGreater(len(res['key']), 0)
-        time.sleep(5)
+        wait_key(self.client, keys[0], lambda k: k['acl'] == ['addObject'])
         res = self.client.get_user_key_acl(keys[0])
         self.assertSetEqual(set(res['acl']), set(['addObject']))
         self.assertEqual(res['maxQueriesPerIPPerHour'], 5)
 
         res = self.client.update_user_key(keys[1], ['deleteObject'],
                                           max_hits_per_query=10)
         self.assertGreater(len(res['key']), 0)
-        time.sleep(5)
+
+        wait_key(self.client, keys[1], lambda k: k['acl'] == ['deleteObject'])
         res = self.client.get_user_key_acl(keys[1])
         self.assertSetEqual(set(res['acl']), set(['deleteObject']))
         self.assertEqual(res['maxHitsPerQuery'], 10)
 
         res = self.client.update_user_key(keys[2], ['settings', 'search'],
                                           validity=60)
         self.assertGreater(len(res['key']), 0)
-        time.sleep(5)
+        wait_key(self.client, keys[2], lambda k: set(k['acl']) == set(['settings', 'search']))
         res = self.client.get_user_key_acl(keys[2])
         self.assertSetEqual(set(res['acl']), set(['settings', 'search']))
         self.assertIn('validity', res)
@@ -112,10 +115,10 @@ def test_update_user_keys(self):
     def test_delete_user_keys(self):
         res = self.client.add_user_key(['search'])
         key = res['key']
-        time.sleep(5)
+        wait_key(self.client, res['key'])
 
         self.client.delete_user_key(key)
-        time.sleep(5)
+        wait_missing_key(self.client, res['key'])
 
         res = self.client.list_user_keys()
         res_keys = [elt['value'] for elt in res['keys']]
@@ -150,7 +153,7 @@ def test_index_add_user_keys(self):
     def test_index_get_user_key(self):
         res = self.index.add_user_key(['search'])
         key = res['key']
-        time.sleep(5)
+        wait_key(self.index, res['key'])
 
         res = self.index.get_user_key_acl(key)
         self.assertEqual(res['value'], key)
@@ -165,28 +168,29 @@ def test_index_update_user_keys(self):
             res = self.index.add_user_key(['search'])
             keys.append(res['key'])
 
-        time.sleep(5)
+        for k in keys:
+            wait_key(self.index, k)
 
         res = self.index.update_user_key(keys[0], ['addObject'],
                                          max_queries_per_ip_per_hour=5)
         self.assertGreater(len(res['key']), 0)
-        time.sleep(5)
+        wait_key(self.index, keys[0], lambda k: k['acl'] == ['addObject'])
         res = self.index.get_user_key_acl(keys[0])
         self.assertSetEqual(set(res['acl']), set(['addObject']))
         self.assertEqual(res['maxQueriesPerIPPerHour'], 5)
 
         res = self.index.update_user_key(keys[1], ['deleteObject'],
                                          max_hits_per_query=10)
         self.assertGreater(len(res['key']), 0)
-        time.sleep(5)
+        wait_key(self.index, keys[1], lambda k: k['acl'] == ['deleteObject'])
         res = self.index.get_user_key_acl(keys[1])
         self.assertSetEqual(set(res['acl']), set(['deleteObject']))
         self.assertEqual(res['maxHitsPerQuery'], 10)
 
         res = self.index.update_user_key(keys[2], ['settings', 'search'],
                                          validity=60)
         self.assertGreater(len(res['key']), 0)
-        time.sleep(5)
+        wait_key(self.index, keys[2], lambda k: set(k['acl']) == set(['search', 'settings']))
         res = self.index.get_user_key_acl(keys[2])
         self.assertSetEqual(set(res['acl']), set(['settings', 'search']))
         self.assertIn('validity', res)
@@ -198,10 +202,10 @@ def test_index_update_user_keys(self):
     def test_index_delete_user_keys(self):
         res = self.index.add_user_key(['search'])
         key = res['key']
-        time.sleep(5)
+        wait_key(self.index, res['key'])
 
         self.index.delete_user_key(key)
-        time.sleep(5)
+        wait_missing_key(self.index, res['key'])
 
         res = self.index.list_user_keys()
         res_keys = [elt['value'] for elt in res['keys']]

tests/test_old_compat.py

@@ -9,6 +9,8 @@
 
 from algoliasearch import algoliasearch
 
+from .helpers import wait_key, wait_missing_key
+
 
 def safe_index_name(name):
     if 'TRAVIS' not in os.environ:
@@ -240,7 +242,7 @@ def test_user_key(self):
         self.index.waitTask(task['taskID'])
         res = self.index.listUserKeys()
         newKey = self.index.addUserKey(['search'])
-        time.sleep(5)
+        wait_key(self.index, newKey['key'])
         self.assertTrue(newKey['key'] != "")
         resAfter = self.index.listUserKeys()
         is_present = False
@@ -250,7 +252,7 @@ def test_user_key(self):
         key = self.index.getUserKeyACL(newKey['key'])
         self.assertEquals(key['acl'][0], 'search')
         task = self.index.deleteUserKey(newKey['key'])
-        time.sleep(5)
+        wait_missing_key(self.index, newKey['key'])
         resEnd = self.index.listUserKeys()
         is_present = False
         for it in resEnd['keys']:
@@ -259,7 +261,7 @@ def test_user_key(self):
 
         res = self.client.listUserKeys()
         newKey = self.client.addUserKey(['search'])
-        time.sleep(5)
+        wait_key(self.client, newKey['key'])
         self.assertTrue(newKey['key'] != "")
         resAfter = self.client.listUserKeys()
         is_present = False
@@ -269,7 +271,7 @@ def test_user_key(self):
         key = self.client.getUserKeyACL(newKey['key'])
         self.assertEquals(key['acl'][0], 'search')
         task = self.client.deleteUserKey(newKey['key'])
-        time.sleep(5)
+        wait_missing_key(self.client, newKey['key'])
         resEnd = self.client.listUserKeys()
         is_present = False
         for it in resEnd['keys']: