Refactor Tests for test_client directory

Author: V1NAY8

test_elasticsearch/test_async/test_server/test_clients.py

@@ -29,15 +29,10 @@ async def test_indices_analyze(self, async_client):
 
 
 class TestBulk:
-    async def test_bulk_works_with_string_body(self, async_client):
-        docs = '{ "index" : { "_index" : "bulk_test_index", "_id" : "1" } }\n{"answer": 42}'
-        response = await async_client.bulk(body=docs)
-
-        assert response["errors"] is False
-        assert len(response["items"]) == 1
+    docs = '{ "index" : { "_index" : "bulk_test_index", "_id" : "1" } }\n{"answer": 42}'
 
-    async def test_bulk_works_with_bytestring_body(self, async_client):
-        docs = b'{ "index" : { "_index" : "bulk_test_index", "_id" : "2" } }\n{"answer": 42}'
+    @pytest.mark.parametrize("docs", [docs, docs.encode("utf-8")])
+    async def test_bulk_works_with_string_bytestring_body(self, docs, async_client):
         response = await async_client.bulk(body=docs)
 
         assert response["errors"] is False

test_elasticsearch/test_client/__init__.py

@@ -17,52 +17,9 @@
 
 from __future__ import unicode_literals
 
-from elasticsearch.client import Elasticsearch, _normalize_hosts
+from elasticsearch.client import Elasticsearch
 
-from ..test_cases import ElasticsearchTestCase, TestCase
-
-
-class TestNormalizeHosts(TestCase):
-    def test_none_uses_defaults(self):
-        self.assertEqual([{}], _normalize_hosts(None))
-
-    def test_strings_are_used_as_hostnames(self):
-        self.assertEqual([{"host": "elastic.co"}], _normalize_hosts(["elastic.co"]))
-
-    def test_strings_are_parsed_for_port_and_user(self):
-        self.assertEqual(
-            [
-                {"host": "elastic.co", "port": 42},
-                {"host": "elastic.co", "http_auth": "user:secre]"},
-            ],
-            _normalize_hosts(["elastic.co:42", "user:secre%5D@elastic.co"]),
-        )
-
-    def test_strings_are_parsed_for_scheme(self):
-        self.assertEqual(
-            [
-                {"host": "elastic.co", "port": 42, "use_ssl": True},
-                {
-                    "host": "elastic.co",
-                    "http_auth": "user:secret",
-                    "use_ssl": True,
-                    "port": 443,
-                    "url_prefix": "/prefix",
-                },
-            ],
-            _normalize_hosts(
-                ["https://elastic.co:42", "https://user:secret@elastic.co/prefix"]
-            ),
-        )
-
-    def test_dicts_are_left_unchanged(self):
-        self.assertEqual(
-            [{"host": "local", "extra": 123}],
-            _normalize_hosts([{"host": "local", "extra": 123}]),
-        )
-
-    def test_single_string_is_wrapped_in_list(self):
-        self.assertEqual([{"host": "elastic.co"}], _normalize_hosts("elastic.co"))
+from ..test_cases import ElasticsearchTestCase
 
 
 class TestClient(ElasticsearchTestCase):

test_elasticsearch/test_client/common.py

@@ -0,0 +1,46 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
+from collections import defaultdict
+from typing import TYPE_CHECKING
+
+from elasticsearch.connection import Connection
+
+if TYPE_CHECKING:
+    from elasticsearch import Elasticsearch
+
+
+class DummyTransport(Connection):
+    def __init__(self, hosts, **kwargs):
+        self.hosts = hosts
+        self.responses = kwargs.pop("responses", None)
+        self.call_count = 0
+        self.calls = defaultdict(list)
+
+    def perform_request(self, method, url, params=None, headers=None, body=None):
+        resp = 200, {}
+        if self.responses:
+            resp = self.responses[self.call_count]
+        self.call_count += 1
+        self.calls[(method, url)].append((params, headers, body))
+        return resp
+
+
+def assert_helper(client: "Elasticsearch", method: str, url: str) -> None:
+    calls = client.transport.calls
+    assert 1 == len(calls)
+    assert (method, url) in calls

test_elasticsearch/test_client/test_cluster.py

@@ -15,30 +15,38 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
-from test_elasticsearch.test_cases import ElasticsearchTestCase
-
-
-class TestCluster(ElasticsearchTestCase):
-    def test_stats_without_node_id(self):
-        self.client.cluster.stats()
-        self.assert_url_called("GET", "/_cluster/stats")
-
-    def test_stats_with_node_id(self):
-        self.client.cluster.stats("node-1")
-        self.assert_url_called("GET", "/_cluster/stats/nodes/node-1")
-
-        self.client.cluster.stats(node_id="node-2")
-        self.assert_url_called("GET", "/_cluster/stats/nodes/node-2")
-
-    def test_state_with_index_without_metric_defaults_to_all(self):
-        self.client.cluster.state()
-        self.assert_url_called("GET", "/_cluster/state")
-
-        self.client.cluster.state(metric="cluster_name")
-        self.assert_url_called("GET", "/_cluster/state/cluster_name")
-
-        self.client.cluster.state(index="index-1")
-        self.assert_url_called("GET", "/_cluster/state/_all/index-1")
-
-        self.client.cluster.state(index="index-1", metric="cluster_name")
-        self.assert_url_called("GET", "/_cluster/state/cluster_name/index-1")
+import pytest
+
+from elasticsearch.client import Elasticsearch
+
+from .common import DummyTransport, assert_helper
+
+
+class TestCluster:
+    @pytest.mark.parametrize("node_id", [None, "node-1", "node-2"])
+    def test_stats_node_id(self, node_id):
+        client = Elasticsearch(transport_class=DummyTransport)
+        client.cluster.stats(node_id=node_id)
+        url = "/_cluster/stats"
+        if node_id:
+            url += f"/nodes/{node_id}"
+        assert_helper(client, "GET", url)
+
+    @pytest.mark.parametrize(
+        ["index", "metric", "url_suffix"],
+        [
+            (None, None, None),
+            (None, "cluster_name", "/cluster_name"),
+            ("index-1", None, "/_all/index-1"),
+            ("index-1", "cluster_name", "/cluster_name/index-1"),
+        ],
+    )
+    def test_state_with_index_without_metric_defaults_to_all(
+        self, index, metric, url_suffix
+    ):
+        client = Elasticsearch(transport_class=DummyTransport)
+        client.cluster.state(index=index, metric=metric)
+        url = "/_cluster/state"
+        if url_suffix:
+            url += url_suffix
+        assert_helper(client, "GET", url)

test_elasticsearch/test_client/test_indices.py

@@ -15,23 +15,31 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
-from test_elasticsearch.test_cases import ElasticsearchTestCase
+import pytest
 
+from elasticsearch.client import Elasticsearch
 
-class TestIndices(ElasticsearchTestCase):
+from .common import DummyTransport, assert_helper
+
+
+class TestIndices:
     def test_create_one_index(self):
-        self.client.indices.create("test-index")
-        self.assert_url_called("PUT", "/test-index")
+        client = Elasticsearch(transport_class=DummyTransport)
+        client.indices.create("test-index")
+        assert_helper(client, "PUT", "/test-index")
 
     def test_delete_multiple_indices(self):
-        self.client.indices.delete(["test-index", "second.index", "third/index"])
-        self.assert_url_called("DELETE", "/test-index,second.index,third%2Findex")
+        client = Elasticsearch(transport_class=DummyTransport)
+        client.indices.delete(["test-index", "second.index", "third/index"])
+        assert_helper(client, "DELETE", "/test-index,second.index,third%2Findex")
 
     def test_exists_index(self):
-        self.client.indices.exists("second.index,third/index")
-        self.assert_url_called("HEAD", "/second.index,third%2Findex")
+        client = Elasticsearch(transport_class=DummyTransport)
+        client.indices.exists("second.index,third/index")
+        assert_helper(client, "HEAD", "/second.index,third%2Findex")
 
-    def test_passing_empty_value_for_required_param_raises_exception(self):
-        self.assertRaises(ValueError, self.client.indices.exists, index=None)
-        self.assertRaises(ValueError, self.client.indices.exists, index=[])
-        self.assertRaises(ValueError, self.client.indices.exists, index="")
+    @pytest.mark.parametrize("index", [None, [], ""])
+    def test_passing_empty_value_for_required_param_raises_exception(self, index):
+        client = Elasticsearch(transport_class=DummyTransport)
+        with pytest.raises(ValueError):
+            client.indices.exists(index=index)

test_elasticsearch/test_client/test_overrides.py

@@ -16,55 +16,46 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
-from test_elasticsearch.test_cases import ElasticsearchTestCase
-
-
-class TestOverriddenUrlTargets(ElasticsearchTestCase):
-    def test_create(self):
-        self.client.create(index="test-index", id="test-id", body={})
-        self.assert_url_called("PUT", "/test-index/_create/test-id")
-
-        self.client.create(
-            index="test-index", doc_type="test-type", id="test-id", body={}
-        )
-        self.assert_url_called("PUT", "/test-index/test-type/test-id/_create")
-
-    def test_delete(self):
-        self.client.delete(index="test-index", id="test-id")
-        self.assert_url_called("DELETE", "/test-index/_doc/test-id")
-
-        self.client.delete(index="test-index", doc_type="test-type", id="test-id")
-        self.assert_url_called("DELETE", "/test-index/test-type/test-id")
-
-    def test_index(self):
-        self.client.index(index="test-index", body={})
-        self.assert_url_called("POST", "/test-index/_doc")
-
-        self.client.index(index="test-index", id="test-id", body={})
-        self.assert_url_called("PUT", "/test-index/_doc/test-id")
-
-    def test_update(self):
-        self.client.update(index="test-index", id="test-id", body={})
-        self.assert_url_called("POST", "/test-index/_update/test-id")
-
-        self.client.update(
-            index="test-index", doc_type="test-type", id="test-id", body={}
-        )
-        self.assert_url_called("POST", "/test-index/test-type/test-id/_update")
-
-    def test_cluster_state(self):
-        self.client.cluster.state()
-        self.assert_url_called("GET", "/_cluster/state")
-
-        self.client.cluster.state(index="test-index")
-        self.assert_url_called("GET", "/_cluster/state/_all/test-index")
-
-        self.client.cluster.state(index="test-index", metric="test-metric")
-        self.assert_url_called("GET", "/_cluster/state/test-metric/test-index")
-
-    def test_cluster_stats(self):
-        self.client.cluster.stats()
-        self.assert_url_called("GET", "/_cluster/stats")
-
-        self.client.cluster.stats(node_id="test-node")
-        self.assert_url_called("GET", "/_cluster/stats/nodes/test-node")
+import pytest
+
+from elasticsearch.client import Elasticsearch
+
+from .common import DummyTransport, assert_helper
+
+
+class TestOverriddenUrlTargets:
+    @pytest.mark.parametrize(
+        ["doc_type", "url_suffix"],
+        [(None, "/_create/test-id"), ("test-type", "/test-type/test-id/_create")],
+    )
+    def test_create(self, doc_type, url_suffix):
+        client = Elasticsearch(transport_class=DummyTransport)
+        client.create(index="test-index", doc_type=doc_type, id="test-id", body={})
+        assert_helper(client, "PUT", "/test-index" + url_suffix)
+
+    @pytest.mark.parametrize(
+        ["doc_type", "url_suffix"],
+        [(None, "/_doc/test-id"), ("test-type", "/test-type/test-id")],
+    )
+    def test_delete(self, doc_type, url_suffix):
+        client = Elasticsearch(transport_class=DummyTransport)
+        client.delete(index="test-index", doc_type=doc_type, id="test-id")
+        assert_helper(client, "DELETE", "/test-index" + url_suffix)
+
+    @pytest.mark.parametrize(
+        ["doc_type", "url_suffix"],
+        [(None, "/_update/test-id"), ("test-type", "/test-type/test-id/_update")],
+    )
+    def test_update(self, doc_type, url_suffix):
+        client = Elasticsearch(transport_class=DummyTransport)
+        client.update(index="test-index", doc_type=doc_type, id="test-id", body={})
+        assert_helper(client, "POST", "/test-index" + url_suffix)
+
+    @pytest.mark.parametrize(
+        ["request_method", "id", "url_suffix"],
+        [("POST", None, ""), ("PUT", "test-id", "/test-id")],
+    )
+    def test_index(self, request_method, id, url_suffix):
+        client = Elasticsearch(transport_class=DummyTransport)
+        client.index(index="test-index", id=id, body={})
+        assert_helper(client, request_method, "/test-index/_doc" + url_suffix)

test_elasticsearch/test_client/test_utils.py

@@ -18,12 +18,49 @@
 
 from __future__ import unicode_literals
 
+from elasticsearch.client import _normalize_hosts
 from elasticsearch.client.utils import _bulk_body, _escape, _make_path, query_params
 from elasticsearch.compat import PY2
 
 from ..test_cases import SkipTest, TestCase
 
 
+class TestNormalizeHosts:
+    def test_none_uses_defaults(self):
+        assert [{}] == _normalize_hosts(None)
+
+    def test_strings_are_used_as_hostnames(self):
+        assert [{"host": "elastic.co"}] == _normalize_hosts(["elastic.co"])
+
+    def test_strings_are_parsed_for_port_and_user(self):
+        assert [
+            {"host": "elastic.co", "port": 42},
+            {"host": "elastic.co", "http_auth": "user:secre]"},
+        ] == _normalize_hosts(["elastic.co:42", "user:secre%5D@elastic.co"])
+
+    def test_strings_are_parsed_for_scheme(self):
+        assert [
+            {"host": "elastic.co", "port": 42, "use_ssl": True},
+            {
+                "host": "elastic.co",
+                "http_auth": "user:secret",
+                "use_ssl": True,
+                "port": 443,
+                "url_prefix": "/prefix",
+            },
+        ] == _normalize_hosts(
+            ["https://elastic.co:42", "https://user:secret@elastic.co/prefix"]
+        )
+
+    def test_dicts_are_left_unchanged(self):
+        assert [{"host": "local", "extra": 123}] == _normalize_hosts(
+            [{"host": "local", "extra": 123}]
+        )
+
+    def test_single_string_is_wrapped_in_list(self):
+        assert [{"host": "elastic.co"}] == _normalize_hosts("elastic.co")
+
+
 class TestQueryParams(TestCase):
     def setup_method(self, _):
         self.calls = []