test improvement in progress

Author: eskombro

meilisearch/index.py

@@ -3,7 +3,7 @@
 from time import sleep
 from meilisearch._httprequests import HttpRequests
 
-# pylint: disable=R0904
+# pylint: disable=too-many-public-methods
 class Index():
     """
     Indexes routes wrapper

meilisearch/tests/test_accept_new_fields_meilisearch.py

@@ -2,19 +2,28 @@
 from meilisearch.tests import BASE_URL, MASTER_KEY
 
 class TestAcceptNewFields:
+
+    """ TESTS: acceptNewFields setting """
+
     client = meilisearch.Client(BASE_URL, MASTER_KEY)
     index = client.create_index(uid='indexUID')
     new_accept_new_fields = True
 
     def teardown_class(self):
         self.index.delete()
 
-    def test_update_accept_new_fields(self):
-        response = self.index.update_accept_new_fields(self.new_accept_new_fields)
-        assert isinstance(response, object)
-        assert 'updateId' in response
-
     def test_get_accept_new_fields(self):
+        """ Test the default behaviour of getting acceptNewFields setting """
         response = self.index.get_accept_new_fields()
         assert isinstance(response, object)
         assert response == self.new_accept_new_fields
+
+    def test_update_accept_new_fields(self):
+        """ Test the changing the acceptNewFields value in MeiliSearch """
+        response = self.index.update_accept_new_fields(not self.new_accept_new_fields)
+        assert isinstance(response, object)
+        assert 'updateId' in response
+        update = self.index.wait_for_pending_update(response['updateId'])
+        assert update['status'] == 'processed'
+        response = self.index.get_accept_new_fields()
+        assert response == (not self.new_accept_new_fields)

meilisearch/tests/test_client_meilisearch.py

@@ -4,18 +4,26 @@
 
 class TestClient:
 
-    """ Client """
+    """ TESTS: Client class """
+
     @staticmethod
     def test_get_client():
         """Tests a call to get a client instance of MeiliSearch"""
         client = meilisearch.Client(BASE_URL, MASTER_KEY)
         assert client.config
-        response = client.get_indexes()
-        assert isinstance(response, list)
+        response = client.health()
+        assert response.status_code == 200
 
     @staticmethod
     def test_get_client_without_master_key():
-        """Tests a call to get a client instance of MeiliSearch"""
+        """Tests to get a client instance of MeiliSearch without MASTER KEY"""
         client = meilisearch.Client(BASE_URL)
         with pytest.raises(Exception):
-            client.get_indexes()
+            client.get_version()
+
+    @staticmethod
+    def test_get_client_with_wrong_master_key():
+        """Tests to get a client instance of MeiliSearch with an invalid MASTER KEY"""
+        client = meilisearch.Client(BASE_URL, MASTER_KEY + "123")
+        with pytest.raises(Exception):
+            client.get_version()

meilisearch/tests/test_displayed_attributes_meilisearch.py

@@ -1,32 +1,50 @@
-import time
+import json
 import meilisearch
 from meilisearch.tests import BASE_URL, MASTER_KEY
 
 class TestSearchableAttributes:
+
+    """ TESTS: displayedAttributes setting """
+
     client = meilisearch.Client(BASE_URL, MASTER_KEY)
     index = None
-    new_displayed_attributes = ['title']
+    displayed_attributes = ['id', 'release_date', 'title', 'poster', 'overview']
 
     def setup_class(self):
         self.index = self.client.create_index(uid='indexUID')
 
     def teardown_class(self):
         self.index.delete()
 
-    def test_update_displayed_attributes(self):
-        response = self.index.update_displayed_attributes(self.new_displayed_attributes)
-        assert isinstance(response, object)
-        assert 'updateId' in response
-
     def test_get_displayed_attributes(self):
+        """Tests a call to get displayedAttributes before and after indexig a dataset"""
         response = self.index.get_displayed_attributes()
         assert isinstance(response, object)
-        assert response == self.new_displayed_attributes
+        assert response == []
+        json_file = open('./datasets/small_movies.json')
+        data = json.load(json_file)
+        response = self.index.add_documents(data, primary_key='id')
+        self.index.wait_for_pending_update(response['updateId'])
+        get_attributes = self.index.get_displayed_attributes()
+        for attribute in self.displayed_attributes:
+            assert attribute in get_attributes
+
+    def test_update_displayed_attributes(self):
+        """Tests the modification of displayedAttributes"""
+        get_attributes = self.index.get_displayed_attributes()
+        response = self.index.update_displayed_attributes(get_attributes[1:])
+        self.index.wait_for_pending_update(response['updateId'])
+        get_attributes_new = self.index.get_displayed_attributes()
+        assert len(get_attributes_new) == len(self.displayed_attributes) - 1
+        assert get_attributes[0] not in get_attributes_new
 
     def test_reset_displayed_attributes(self):
+        """Tests the reset of displayedAttributes to default values (in dataset)"""
         response = self.index.reset_displayed_attributes()
         assert isinstance(response, object)
         assert 'updateId' in response
-        time.sleep(0.1)
-        response = self.index.get_displayed_attributes()
-        assert isinstance(response, list)
+        self.index.wait_for_pending_update(response['updateId'])
+        get_attributes = self.index.get_displayed_attributes()
+        assert len(get_attributes) == len(self.displayed_attributes)
+        for attribute in self.displayed_attributes:
+            assert attribute in get_attributes

meilisearch/tests/test_distinct_attribute_meilisearch.py

@@ -1,8 +1,10 @@
-import time
 import meilisearch
 from meilisearch.tests import BASE_URL, MASTER_KEY
 
 class TestDistinctAttribute:
+
+    """ TESTS: distinctAttribute setting """
+
     client = meilisearch.Client(BASE_URL, MASTER_KEY)
     index = None
     new_distinct_attribute = 'title'
@@ -14,20 +16,27 @@ def setup_class(self):
     def teardown_class(self):
         self.index.delete()
 
+    def test_get_distinct_attribute(self):
+        """Tests a call to get distinctAttribute geting `None`(null) default value"""
+        response = self.index.get_distinct_attribute()
+        assert isinstance(response, object)
+        assert response == self.default_distinct_attribute
+
     def test_update_distinct_attribute(self):
+        """Tests a call to set a custom distinctAttribute and checks it has ben set in MeiliSearch"""
         response = self.index.update_distinct_attribute(self.new_distinct_attribute)
         assert isinstance(response, object)
         assert 'updateId' in response
-
-    def test_get_distinct_attribute(self):
+        self.index.wait_for_pending_update(response['updateId'])
         response = self.index.get_distinct_attribute()
         assert isinstance(response, object)
         assert response == self.new_distinct_attribute
 
     def test_reset_distinct_attribute(self):
+        """Tests a call to reset distinctAttribute geting `None`(null) default value again"""
         response = self.index.reset_distinct_attribute()
         assert isinstance(response, object)
         assert 'updateId' in response
-        time.sleep(0.1)
+        self.index.wait_for_pending_update(response['updateId'])
         response = self.index.get_distinct_attribute()
         assert response == self.default_distinct_attribute

setup.py

@@ -1,5 +1,4 @@
-import setuptools
-from setuptools import setup
+from setuptools import setup, find_packages
 
 with open("README.md", "r") as fh:
     long_description = fh.read()
@@ -16,7 +15,7 @@
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/meilisearch/meilisearch-python",
-    packages=["meilisearch"],
+    packages=find_packages(),
     project_urls={"Documentation": "https://docs.meilisearch.com/",},
     keywords="search python meilisearch",
     platform="any",