Fix CI (#16)

- Locked down versions
- Making sure matchers work

Author: JasonStoltz

.circleci/config.yml

@@ -1,12 +1,11 @@
 ---
-
 version: 2.1
 
 executors:
-  python-27: {docker: [{image: 'python:2.7'}]}
-  python-35: {docker: [{image: 'python:3.5'}]}
-  python-36: {docker: [{image: 'python:3.6'}]}
-  python-37: {docker: [{image: 'python:3.7'}]}
+  python-27: { docker: [{ image: "python:2.7.16" }] }
+  python-35: { docker: [{ image: "python:3.5.7" }] }
+  python-36: { docker: [{ image: "python:3.6.9" }] }
+  python-37: { docker: [{ image: "python:3.7.4" }] }
 
 jobs:
   build:
@@ -16,31 +15,31 @@ jobs:
     executor: << parameters.executor >>
     working_directory: ~/repo
     steps:
-    - checkout
-    - restore_cache:
-        keys:
-        - v1-dependencies-{{ .Environment.CIRCLE_JOB }}-{{ checksum "requirements.txt" }}
-    - run:
-        name: install dependencies
-        command: |
-          pip install virtualenv
-          virtualenv venv
-          . venv/bin/activate
-          python setup.py install
-    - save_cache:
-        paths:
-        - ./venv
-        key: v1-dependencies-{{ .Environment.CIRCLE_JOB }}-{{ checksum "requirements.txt" }}
-    - run:
-        name: run tests
-        command: |
-          . venv/bin/activate
-          python setup.py test
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ .Environment.CIRCLE_JOB }}-{{ checksum "requirements.txt" }}
+      - run:
+          name: install dependencies
+          command: |
+            pip install virtualenv
+            virtualenv venv
+            . venv/bin/activate
+            python setup.py install
+      - save_cache:
+          paths:
+            - ./venv
+          key: v1-dependencies-{{ .Environment.CIRCLE_JOB }}-{{ checksum "requirements.txt" }}
+      - run:
+          name: run tests
+          command: |
+            . venv/bin/activate
+            python setup.py test
 
 workflows:
   run-tests:
     jobs:
-    - build: {name: run-tests-python-2.7, executor: python-27}
-    - build: {name: run-tests-python-3.5, executor: python-35}
-    - build: {name: run-tests-python-3.6, executor: python-36}
-    - build: {name: run-tests-python-3.7, executor: python-37}
+      - build: { name: run-tests-python-2.7, executor: python-27 }
+      - build: { name: run-tests-python-3.5, executor: python-35 }
+      - build: { name: run-tests-python-3.6, executor: python-36 }
+      - build: { name: run-tests-python-3.7, executor: python-37 }

tests/test_client.py

@@ -1,9 +1,11 @@
 from unittest import TestCase
 import requests_mock
+import json
 
 from elastic_app_search import Client
 from elastic_app_search.exceptions import InvalidDocument
 
+
 class TestClient(TestCase):
 
     def setUp(self):
@@ -16,15 +18,18 @@ def setUp(self):
         )
 
     def test_deprecated_init_support_with_old_names(self):
-        self.client = Client(account_host_key='host_identifier', api_key='api_key')
+        self.client = Client(
+            account_host_key='host_identifier', api_key='api_key')
         self.assertEqual(self.client.account_host_key, 'host_identifier')
 
     def test_deprecated_init_support_with_new_names(self):
-        self.client = Client(host_identifier='host_identifier', api_key='api_key')
+        self.client = Client(
+            host_identifier='host_identifier', api_key='api_key')
         self.assertEqual(self.client.account_host_key, 'host_identifier')
 
     def test_deprecated_init_support_with_positional(self):
-        self.client = Client('host_identifier', 'api_key', 'example.com', False)
+        self.client = Client('host_identifier', 'api_key',
+                             'example.com', False)
         self.assertEqual(self.client.account_host_key, 'host_identifier')
 
     def test_host_identifier_is_optional(self):
@@ -41,7 +46,8 @@ def test_index_document_processing_error(self):
         error = 'some processing error'
         stubbed_return = [{'id': 'something', 'errors': [error]}]
         with requests_mock.Mocker() as m:
-            m.register_uri('POST', self.document_index_url, json=stubbed_return, status_code=200)
+            m.register_uri('POST', self.document_index_url,
+                           json=stubbed_return, status_code=200)
 
             with self.assertRaises(InvalidDocument) as context:
                 self.client.index_document(self.engine_name, invalid_document)
@@ -52,38 +58,44 @@ def test_index_document_no_error_key_in_response(self):
         stubbed_return = [{'id': 'auto generated', 'errors': []}]
 
         with requests_mock.Mocker() as m:
-            m.register_uri('POST', self.document_index_url, json=stubbed_return, status_code=200)
-            response = self.client.index_document(self.engine_name, document_without_id)
+            m.register_uri('POST', self.document_index_url,
+                           json=stubbed_return, status_code=200)
+            response = self.client.index_document(
+                self.engine_name, document_without_id)
             self.assertEqual(response, {'id': 'auto generated'})
 
     def test_index_documents(self):
         id = 'INscMGmhmX4'
         valid_document = {'id': id}
-        other_document = { 'body': 'some value' }
+        other_document = {'body': 'some value'}
 
         expected_return = [
             {'id': id, 'errors': []},
             {'id': 'some autogenerated id', 'errors': []}
         ]
 
         with requests_mock.Mocker() as m:
-            m.register_uri('POST', self.document_index_url, json=expected_return, status_code=200)
-            response = self.client.index_documents(self.engine_name, [valid_document, other_document])
+            m.register_uri('POST', self.document_index_url,
+                           json=expected_return, status_code=200)
+            response = self.client.index_documents(
+                self.engine_name, [valid_document, other_document])
             self.assertEqual(response, expected_return)
 
     def test_update_documents(self):
         id = 'INscMGmhmX4'
         valid_document = {'id': id}
-        other_document = { 'body': 'some value' }
+        other_document = {'body': 'some value'}
 
         expected_return = [
             {'id': id, 'errors': []},
             {'id': 'some autogenerated id', 'errors': []}
         ]
 
         with requests_mock.Mocker() as m:
-            m.register_uri('PATCH', self.document_index_url, json=expected_return, status_code=200)
-            response = self.client.update_documents(self.engine_name, [valid_document, other_document])
+            m.register_uri('PATCH', self.document_index_url,
+                           json=expected_return, status_code=200)
+            response = self.client.update_documents(
+                self.engine_name, [valid_document, other_document])
             self.assertEqual(response, expected_return)
 
     def test_get_documents(self):
@@ -98,7 +110,8 @@ def test_get_documents(self):
         ]
 
         with requests_mock.Mocker() as m:
-            m.register_uri('GET', self.document_index_url, json=expected_return, status_code=200)
+            m.register_uri('GET', self.document_index_url,
+                           json=expected_return, status_code=200)
             response = self.client.get_documents(self.engine_name, [id])
             self.assertEqual(response, expected_return)
 
@@ -113,14 +126,19 @@ def test_list_documents(self):
             }
         }
 
+        def match_request_text(request):
+            data = json.loads(request.text)
+            return data["page"]["current"] == 1 and data["page"]["size"] == 20
+
         with requests_mock.Mocker() as m:
-            url = "{}/engines/{}/documents/list".format(self.client.session.base_url, self.engine_name)
+            url = "{}/engines/{}/documents/list".format(
+                self.client.session.base_url, self.engine_name)
             m.register_uri('GET',
-                url,
-                additional_matcher=lambda x: x.text == '{"page": {"current": 1, "size": 20}}',
-                json=expected_return,
-                status_code=200
-            )
+                           url,
+                           additional_matcher=match_request_text,
+                           json=expected_return,
+                           status_code=200
+                           )
 
             response = self.client.list_documents(self.engine_name)
             self.assertEqual(response, expected_return)
@@ -132,7 +150,8 @@ def test_destroy_documents(self):
         ]
 
         with requests_mock.Mocker() as m:
-            m.register_uri('DELETE', self.document_index_url, json=expected_return, status_code=200)
+            m.register_uri('DELETE', self.document_index_url,
+                           json=expected_return, status_code=200)
             response = self.client.destroy_documents(self.engine_name, [id])
             self.assertEqual(response, expected_return)
 
@@ -142,12 +161,13 @@ def test_get_schema(self):
         }
 
         with requests_mock.Mocker() as m:
-            url = "{}/engines/{}/schema".format(self.client.session.base_url, self.engine_name)
+            url = "{}/engines/{}/schema".format(
+                self.client.session.base_url, self.engine_name)
             m.register_uri('GET',
-                url,
-                json=expected_return,
-                status_code=200
-            )
+                           url,
+                           json=expected_return,
+                           status_code=200
+                           )
 
             response = self.client.get_schema(self.engine_name)
             self.assertEqual(response, expected_return)
@@ -159,29 +179,35 @@ def test_update_schema(self):
         }
 
         with requests_mock.Mocker() as m:
-            url = "{}/engines/{}/schema".format(self.client.session.base_url, self.engine_name)
+            url = "{}/engines/{}/schema".format(
+                self.client.session.base_url, self.engine_name)
             m.register_uri('POST',
-                url,
-                json=expected_return,
-                status_code=200
-            )
+                           url,
+                           json=expected_return,
+                           status_code=200
+                           )
 
-            response = self.client.update_schema(self.engine_name, expected_return)
+            response = self.client.update_schema(
+                self.engine_name, expected_return)
             self.assertEqual(response, expected_return)
 
     def test_list_engines(self):
         expected_return = [
-            { 'name': 'myawesomeengine' }
+            {'name': 'myawesomeengine'}
         ]
 
+        def match_request_text(request):
+            data = json.loads(request.text)
+            return data["page"]["current"] == 1 and data["page"]["size"] == 20
+
         with requests_mock.Mocker() as m:
             url = "{}/{}".format(self.client.session.base_url, 'engines')
             m.register_uri('GET',
-                url,
-                additional_matcher=lambda x: x.text == '{"page": {"current": 1, "size": 20}}',
-                json=expected_return,
-                status_code=200
-            )
+                           url,
+                           additional_matcher=match_request_text,
+                           json=expected_return,
+                           status_code=200
+                           )
             response = self.client.list_engines()
             self.assertEqual(response, expected_return)
 
@@ -190,12 +216,16 @@ def test_list_engines_with_paging(self):
             {'name': 'myawesomeengine'}
         ]
 
+        def match_request_text(request):
+            data = json.loads(request.text)
+            return data["page"]["current"] == 10 and data["page"]["size"] == 2
+
         with requests_mock.Mocker() as m:
             url = "{}/{}".format(self.client.session.base_url, 'engines')
             m.register_uri(
                 'GET',
                 url,
-                additional_matcher=lambda x: x.text == '{"page": {"current": 10, "size": 2}}',
+                additional_matcher=match_request_text,
                 json=expected_return,
                 status_code=200
             )
@@ -205,7 +235,7 @@ def test_list_engines_with_paging(self):
     def test_get_engine(self):
         engine_name = 'myawesomeengine'
         expected_return = [
-            { 'name': engine_name }
+            {'name': engine_name}
         ]
 
         with requests_mock.Mocker() as m:
@@ -234,7 +264,8 @@ def test_destroy_engine(self):
             url = "{}/{}/{}".format(self.client.session.base_url,
                                     'engines',
                                     engine_name)
-            m.register_uri('DELETE', url, json=expected_return, status_code=200)
+            m.register_uri('DELETE', url, json=expected_return,
+                           status_code=200)
             response = self.client.destroy_engine(engine_name)
             self.assertEqual(response, expected_return)
 
@@ -278,10 +309,15 @@ def test_list_synonym_sets(self):
                 self.client.session.base_url,
                 self.engine_name
             )
+
+            def match_request_text(request):
+                data = json.loads(request.text)
+                return data["page"]["current"] == 1 and data["page"]["size"] == 20
+
             m.register_uri(
                 'GET',
                 url,
-                additional_matcher=lambda x: x.text == '{"page": {"current": 1, "size": 20}}',
+                additional_matcher=match_request_text,
                 json=expected_return,
                 status_code=200
             )
@@ -404,7 +440,7 @@ def test_destroy_synonym_set(self):
 
     def test_search(self):
         query = 'query'
-        expected_return = { 'meta': {}, 'results': []}
+        expected_return = {'meta': {}, 'results': []}
 
         with requests_mock.Mocker() as m:
             url = "{}/{}".format(
@@ -416,7 +452,8 @@ def test_search(self):
             self.assertEqual(response, expected_return)
 
     def test_multi_search(self):
-        expected_return = [{ 'meta': {}, 'results': []}, { 'meta': {}, 'results': []}]
+        expected_return = [{'meta': {}, 'results': []},
+                           {'meta': {}, 'results': []}]
 
         with requests_mock.Mocker() as m:
             url = "{}/{}".format(
@@ -429,15 +466,16 @@ def test_multi_search(self):
 
     def test_query_suggestion(self):
         query = 'query'
-        expected_return = { 'meta': {}, 'results': {}}
+        expected_return = {'meta': {}, 'results': {}}
 
         with requests_mock.Mocker() as m:
             url = "{}/{}".format(
                 self.client.session.base_url,
                 "engines/{}/query_suggestion".format(self.engine_name)
             )
             m.register_uri('GET', url, json=expected_return, status_code=200)
-            response = self.client.query_suggestion(self.engine_name, query, {})
+            response = self.client.query_suggestion(
+                self.engine_name, query, {})
             self.assertEqual(response, expected_return)
 
     def test_click(self):
@@ -447,4 +485,5 @@ def test_click(self):
                 "engines/{}/click".format(self.engine_name)
             )
             m.register_uri('POST', url, json={}, status_code=200)
-            self.client.click(self.engine_name, {'query': 'cat', 'document_id': 'INscMGmhmX4'})
+            self.client.click(self.engine_name, {
+                              'query': 'cat', 'document_id': 'INscMGmhmX4'})