Test test_is_healthy_bad_route hangs

[sanders41]

I noticed that the test_is_healthy_bad_route test can hang the test suite for several minutes while it waits for the request to time out. There is nothing wrong with the test itself, the issue is requests takes a long time to timeout.

The hanging issue in this test can be solved by either setting the timeout to 1 (or some other low number) in the client or by patching requests to return the error right away. Is there any interest in implementing one of these options, and if so which would be the preference? I'm happy to open a PR for either option if you like the idea.

meilisearch-python/meilisearch/tests/client/test_client_health_meilisearch.py

Lines 13 to 17 in edf4b4d

	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

[bidoubiwa]

Oh interesting. I'm wondering if we should

1. Set de timeout for this specific function to low
2. Give de timeout as a function parameter and a low default vallue
3. Leave de source code as it is but change the timeout in the test
4. ..?

how would you do the following?

patching requests to return the error right away.

Finally, which one do you prefer?

[sanders41]

The patched version would look like:

from unittest.mock import patch

import requests

@patch("requests.get")
def test_is_healthy_bad_route(mock_get):
    """Tests checking if is_healthy returns false when trying to reach a bad URL."""
    mock_get.side_effect = requests.exceptions.ConnectionError()
    client = meilisearch.Client("http://wrongurl:1234")
    response = client.is_healthy()
    assert response is False

and the timeout version would be:

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", timeout=1)
    response = client.is_healthy()
    assert response is False

The end result in this test would be the same so I don't have a big preference for one over the other. I would probably choose the timeout just because it is less lines of code.

[bidoubiwa]

I agree the second one is better.
I misunderstood your first message. I thought you asked if the behavior of is_healthy should have. Or if it should respond directly if it is healthy or not. But maybe this deserves its own issue!

So yes! Thanks a lot :) The second suggestion is the best.