Merge #246

246: Standardize health method r=bidoubiwa a=alallema

Checking that method health() return `{'status': 'available'}`  and added isHealthy() method who return boolean value

meilisearch/integration-guides#55

Co-authored-by: alallema <[email protected]>

Author: bors[bot]

Diff for: meilisearch/client.py

@@ -1,7 +1,7 @@
 from meilisearch.index import Index
 from meilisearch.config import Config
 from meilisearch._httprequests import HttpRequests
-from meilisearch.errors import MeiliSearchApiError
+from meilisearch.errors import MeiliSearchApiError, MeiliSearchError
 
 class Client():
     """
@@ -161,6 +161,21 @@ def health(self):
         """
         return self.http.get(self.config.paths.health)
 
+    def is_healthy(self):
+        """Get health of the MeiliSearch server.
+
+        `200` HTTP status response when MeiliSearch is healthy.
+
+        Return
+        ------
+        health: True | False
+        """
+        try:
+            self.health()
+        except MeiliSearchError:
+            return False
+        return True
+
     def get_keys(self):
         """Get all keys.
 

Diff for: meilisearch/tests/client/test_client_health_meilisearch.py

@@ -1,5 +1,17 @@
+import meilisearch
 
 def test_health(client):
     """Tests checking the health of the MeiliSearch instance."""
     response = client.health()
     assert response['status'] == 'available'
+
+def test_is_healthy(client):
+    """Tests checking if is_healthy return true when MeiliSearch instance is available."""
+    response = client.is_healthy()
+    assert response is True
+
+def test_is_healthy_bad_route():
+    """Tests checking if is_healthy returns false when trying to reach a bad URL."""
+    client = meilisearch.Client("http://wrongurl:1234")
+    response = client.is_healthy()
+    assert response is False