Merge pull request #334 from julienbourdeau/feat/build-community-PRs

Build community PRs

Author: julienbourdeau

.travis.yml

@@ -1,25 +1,26 @@
+language: python
+
 branches:
   only:
     - master
 
 sudo: false
 
+python:
+  - "2.7"
+  - "3.4"
+  - "3.5"
+  - "3.6"
+
 before_script:
   - wget https://storage.googleapis.com/appengine-sdks/featured/google_appengine_1.9.27.zip
   - unzip -q google_appengine_1.9.27.zip
+  - wget https://alg.li/algolia-keys && chmod +x algolia-keys
 
 install:
   - pip install --upgrade pip
   - if [[ $TOXENV == 'py32' ]]; then pip install -I 'virtualenv<14.0'; fi
   - pip install tox-travis
 
 script:
-  - tox
-
-language: python
-
-python:
-  - "2.7"
-  - "3.4"
-  - "3.5"
-  - "3.6"
+  - if [ "$TRAVIS_PULL_REQUEST" != "false" ] && [[ ! "$TRAVIS_PULL_REQUEST_SLUG" =~ ^algolia\/ ]]; then eval $(./algolia-keys export) tox; else tox; fi

tests/conftest.py

@@ -6,7 +6,7 @@
 
 @pytest.fixture
 def mcm_client():
-    return create_client('ALGOLIA_APPLICATION_ID_MCM', 'ALGOLIA_API_KEY_MCM')
+    return create_client('ALGOLIA_APP_ID_MCM', 'ALGOLIA_API_KEY_MCM')
 
 
 @pytest.fixture

tests/helpers.py

@@ -10,22 +10,25 @@ def check_credentials():
     credentials = [
         'ALGOLIA_APPLICATION_ID',
         'ALGOLIA_API_KEY',
-        'ALGOLIA_API_KEY_SEARCH',
-        'ALGOLIA_APPLICATION_ID_MCM',
+        'ALGOLIA_SEARCH_API_KEY',
+        'ALGOLIA_APP_ID_MCM',
         'ALGOLIA_API_KEY_MCM'
     ]
 
     for credential in credentials:
         if credential not in os.environ:
-            print('environement variable {} not defined'.format(credential))
+            print('environment variable {} not defined'.format(credential))
             assert False
 
 
+is_community = 'IS_COMMUNITY' in os.environ
+
+
 def index_name():
     name = 'algolia-python{}'.format(randint(1, 100000))
 
     if 'TRAVIS' in os.environ:
-        name = '{}_travis-{}'.format(name, os.environ['TRAVIS_JOB_NUMBER'])
+        name = 'TRAVIS_PYTHON_{}_id-{}'.format(name, os.environ['TRAVIS_JOB_NUMBER'])
 
     return name
 

tests/test_MCM.py

@@ -1,11 +1,15 @@
 from __future__ import unicode_literals
 import os
 import time
+import pytest
 from algoliasearch.helpers import PY2
+from .helpers import is_community
 
 STR_TYPE = unicode if PY2 else str
 
 
+@pytest.mark.skipif(is_community,
+                    reason='MCM methods cannot be tested by the community')
 def uniq_user_id():
     name = 'python-client'
     if 'TRAVIS' not in os.environ:
@@ -14,6 +18,8 @@ def uniq_user_id():
     return '{}-travis-{}'.format(name, job)
 
 
+@pytest.mark.skipif(is_community,
+                    reason='MCM methods cannot be tested by the community')
 def test_1_list_clusters(mcm_client):
     answer = mcm_client.list_clusters()
 
@@ -26,6 +32,8 @@ def test_1_list_clusters(mcm_client):
     assert isinstance(answer['clusters'][0]['dataSize'], int)
 
 
+@pytest.mark.skipif(is_community,
+                    reason='MCM methods cannot be tested by the community')
 def test_2_assign_user_id(mcm_client):
     name = mcm_client.list_clusters()['clusters'][0]['clusterName']
     answer = mcm_client.assign_user_id(uniq_user_id(), name)
@@ -36,6 +44,8 @@ def test_2_assign_user_id(mcm_client):
     time.sleep(2) # Sleep to let the cluster publish the change
 
 
+@pytest.mark.skipif(is_community,
+                    reason='MCM methods cannot be tested by the community')
 def test_3_list_user_ids(mcm_client):
     answer = mcm_client.list_user_ids()
 
@@ -48,6 +58,8 @@ def test_3_list_user_ids(mcm_client):
     assert isinstance(answer['userIDs'][0]['dataSize'], int)
 
 
+@pytest.mark.skipif(is_community,
+                    reason='MCM methods cannot be tested by the community')
 def test_4_get_top_user_id(mcm_client):
     cluster_name = mcm_client.list_clusters()['clusters'][0]['clusterName']
     answer = mcm_client.get_top_user_id()
@@ -60,6 +72,9 @@ def test_4_get_top_user_id(mcm_client):
     assert isinstance(answer['topUsers'][cluster_name][0]['nbRecords'], int)
     assert isinstance(answer['topUsers'][cluster_name][0]['dataSize'], int)
 
+
+@pytest.mark.skipif(is_community,
+                    reason='MCM methods cannot be tested by the community')
 def test_5_get_user_id(mcm_client):
     answer = mcm_client.get_user_id(uniq_user_id())
 
@@ -69,6 +84,9 @@ def test_5_get_user_id(mcm_client):
     assert isinstance(answer['nbRecords'], int)
     assert isinstance(answer['dataSize'], int)
 
+
+@pytest.mark.skipif(is_community,
+                    reason='MCM methods cannot be tested by the community')
 def test_6_search_user_ids(mcm_client):
     clusterName = mcm_client.list_clusters()['clusters'][0]['clusterName']
     answer = mcm_client.search_user_ids(uniq_user_id(), clusterName, 0, 1000)
@@ -85,6 +103,9 @@ def test_6_search_user_ids(mcm_client):
     assert isinstance(answer['hits'][0]['nbRecords'], int)
     assert isinstance(answer['hits'][0]['dataSize'], int)
 
+
+@pytest.mark.skipif(is_community,
+                    reason='MCM methods cannot be tested by the community')
 def test_7_remove_user_id(mcm_client):
     answer = mcm_client.remove_user_id(uniq_user_id())
 

tests/test_compat.py

@@ -1,4 +1,6 @@
-from .helpers import wait_key, wait_missing_key
+from .helpers import wait_key, wait_missing_key, is_community
+import pytest
+
 
 def test_addObject(index):
     task = index.addObject({'name': 'Paris'}, 'a')
@@ -131,6 +133,8 @@ def test_deleteByQuery(rw_index):
     assert res['nbHits'] < 5
 
 
+@pytest.mark.skipif(is_community,
+                    reason='API keys methods cannot be tested by the community')
 def test_user_key(rw_index):
     new_key = rw_index.addUserKey(['search'])
     wait_key(rw_index, new_key['key'])

tests/test_index.py

@@ -436,11 +436,11 @@ def test_search_with_short_secured_api_key(ro_index):
 
     try:
         secured_api_key = ro_index.client.generate_secured_api_key(
-            os.environ['ALGOLIA_API_KEY_SEARCH'],
+            os.environ['ALGOLIA_SEARCH_API_KEY'],
             dict(filters=''),
         )
     except:
-        raise RuntimeError("ALGOLIA_API_KEY_SEARCH must be set")
+        raise RuntimeError("ALGOLIA_SEARCH_API_KEY must be set")
 
     assert len(secured_api_key) < MAX_API_KEY_LENGTH
 
@@ -456,11 +456,11 @@ def test_search_with_long_secured_api_key(ro_index):
     tags = set('x{0}'.format(100000 + i) for i in range(1000))
     try:
         secured_api_key = ro_index.client.generate_secured_api_key(
-            os.environ['ALGOLIA_API_KEY_SEARCH'],
+            os.environ['ALGOLIA_SEARCH_API_KEY'],
             dict(filters=' OR '.join(tags)),
         )
     except:
-        raise RuntimeError("ALGOLIA_API_KEY_SEARCH must be set")
+        raise RuntimeError("ALGOLIA_SEARCH_API_KEY must be set")
 
     assert len(secured_api_key) > MAX_API_KEY_LENGTH
     ro_index.client.api_key = secured_api_key

tests/test_keys.py

@@ -1,11 +1,17 @@
+from .helpers import is_community
+import pytest
 from .helpers import wait_key, wait_missing_key
 
 
+@pytest.mark.skipif(is_community,
+                    reason='API keys methods cannot be tested by the community')
 def test_list_user_keys(client):
     res = client.list_user_keys()
     assert 'keys' in res
 
 
+@pytest.mark.skipif(is_community,
+                    reason='API keys methods cannot be tested by the community')
 def test_add_user_keys(client):
     keys = []
 
@@ -28,6 +34,8 @@ def test_add_user_keys(client):
         client.delete_user_key(key)
 
 
+@pytest.mark.skipif(is_community,
+                    reason='API keys methods cannot be tested by the community')
 def test_get_user_key(client):
     res = client.add_user_key(['search'])
     key = res['key']
@@ -40,6 +48,8 @@ def test_get_user_key(client):
     client.delete_user_key(key)
 
 
+@pytest.mark.skipif(is_community,
+                    reason='API keys methods cannot be tested by the community')
 def test_update_user_keys(client):
     keys = []
 
@@ -81,6 +91,8 @@ def test_update_user_keys(client):
     for key in keys:
         client.delete_user_key(key)
 
+@pytest.mark.skipif(is_community,
+                    reason='API keys methods cannot be tested by the community')
 def test_delete_user_keys(client):
     res = client.add_user_key(['search'])
     key = res['key']
@@ -94,11 +106,15 @@ def test_delete_user_keys(client):
     assert key not in res_keys
 
 
+@pytest.mark.skipif(is_community,
+                    reason='API keys methods cannot be tested by the community')
 def test_index_list_user_keys(ro_index):
     res = ro_index.list_user_keys()
     assert 'keys' in res
 
 
+@pytest.mark.skipif(is_community,
+                    reason='API keys methods cannot be tested by the community')
 def test_index_add_user_keys(index):
     keys = []
 
@@ -121,6 +137,8 @@ def test_index_add_user_keys(index):
         index.delete_user_key(key)
 
 
+@pytest.mark.skipif(is_community,
+                    reason='API keys methods cannot be tested by the community')
 def test_index_get_user_key(index):
     res = index.add_user_key(['search'])
     key = res['key']
@@ -133,6 +151,8 @@ def test_index_get_user_key(index):
     index.delete_user_key(key)
 
 
+@pytest.mark.skipif(is_community,
+                    reason='API keys methods cannot be tested by the community')
 def test_index_update_user_keys(index):
     keys = []
 
@@ -175,6 +195,8 @@ def test_index_update_user_keys(index):
         index.delete_user_key(key)
 
 
+@pytest.mark.skipif(is_community,
+                    reason='API keys methods cannot be tested by the community')
 def test_index_delete_user_keys(index):
     res = index.add_user_key(['search'])
     key = res['key']

tox.ini

@@ -19,7 +19,7 @@ passenv =
     ALGOLIA*
     APPENGINE*
     TRAVIS*
-
+    IS_COMMUNITY
 commands = pytest tests
 
 # Appengine settings.
@@ -40,6 +40,7 @@ deps =
 passenv =
     ALGOLIA*
     TRAVIS*
+    IS_COMMUNITY
 commands =
     coverage run --branch --source=algoliasearch -m pytest tests
     coverage report
@@ -56,6 +57,7 @@ deps =
 passenv =
     ALGOLIA*
     TRAVIS*
+    IS_COMMUNITY
 commands =
     coverage run --branch --source=algoliasearch -m pytest tests
     coverage report