From 04f6efe74972889eb8ee7edfdbd422147175fbb1 Mon Sep 17 00:00:00 2001 From: Benjamin Wohlwend Date: Tue, 27 Oct 2020 08:35:52 +0100 Subject: [PATCH] remove elasticsearch-async tests (#949) elasticsearch-async has been deprecated and its functionality brought into elasticsearch-py proper (tests for that can be found in async_elasticsearch_client_tests.py). Since version 3.7 of aiohttp, the tests fail and can't easily be fixed. We plan to remove support for this module anyway in version 6.0 of the agent, so it's an acceptable quick fix to remove testing for the module now already. --- tests/docker-compose.yml | 2 +- .../elasticsearch_async_client_tests.py | 197 ------------------ tests/requirements/reqs-elasticsearch-6.txt | 1 - tests/requirements/reqs-elasticsearch-7.txt | 1 - 4 files changed, 1 insertion(+), 200 deletions(-) delete mode 100644 tests/instrumentation/asyncio_tests/elasticsearch_async_client_tests.py diff --git a/tests/docker-compose.yml b/tests/docker-compose.yml index da5ae9fb41..5640fd8651 100644 --- a/tests/docker-compose.yml +++ b/tests/docker-compose.yml @@ -78,7 +78,7 @@ services: - pyesdata6:/usr/share/elasticsearch/data elasticsearch7: - image: docker.elastic.co/elasticsearch/elasticsearch:7.1.0 + image: docker.elastic.co/elasticsearch/elasticsearch:7.9.0 healthcheck: test: ["CMD", "curl", "-f", "http://localhost:9200"] environment: diff --git a/tests/instrumentation/asyncio_tests/elasticsearch_async_client_tests.py b/tests/instrumentation/asyncio_tests/elasticsearch_async_client_tests.py deleted file mode 100644 index 2b8d67a5df..0000000000 --- a/tests/instrumentation/asyncio_tests/elasticsearch_async_client_tests.py +++ /dev/null @@ -1,197 +0,0 @@ -# BSD 3-Clause License -# -# Copyright (c) 2019, Elasticsearch BV -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# * Redistributions of source code must retain the above copyright notice, this -# list of conditions and the following disclaimer. -# -# * Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# * Neither the name of the copyright holder nor the names of its -# contributors may be used to endorse or promote products derived from -# this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -import pytest # isort:skip - -pytest.importorskip("elasticsearch_async") # isort:skip - -import os - -from elasticsearch import VERSION as ES_VERSION -from elasticsearch_async import AsyncElasticsearch - -from elasticapm.conf.constants import TRANSACTION - -pytestmark = [pytest.mark.elasticsearch, pytest.mark.asyncio, pytest.mark.integrationtest] - -if "ES_URL" not in os.environ: - pytestmark.append(pytest.mark.skip("Skipping elasticsearch test, no ES_URL environment variable")) - - -document_type = "_doc" if ES_VERSION[0] >= 6 else "doc" - - -@pytest.fixture -async def elasticsearch_async(request): - """Elasticsearch client fixture.""" - client = AsyncElasticsearch(hosts=os.environ["ES_URL"]) - try: - yield client - finally: - await client.indices.delete(index="*") - await client.transport.close() - - -async def test_ping(instrument, elasticapm_client, elasticsearch_async): - elasticapm_client.begin_transaction("test") - result = await elasticsearch_async.ping() - elasticapm_client.end_transaction("test", "OK") - - transaction = elasticapm_client.events[TRANSACTION][0] - spans = elasticapm_client.spans_for_transaction(transaction) - assert len(spans) == 1 - span = spans[0] - assert span["name"] == "ES HEAD /" - assert span["type"] == "db" - assert span["subtype"] == "elasticsearch" - assert span["action"] == "query" - assert span["sync"] is False - - -async def test_info(instrument, elasticapm_client, elasticsearch_async): - elasticapm_client.begin_transaction("test") - result = await elasticsearch_async.info() - elasticapm_client.end_transaction("test", "OK") - - transaction = elasticapm_client.events[TRANSACTION][0] - - spans = elasticapm_client.spans_for_transaction(transaction) - assert len(spans) == 1 - span = spans[0] - assert span["name"] == "ES GET /" - assert span["type"] == "db" - assert span["subtype"] == "elasticsearch" - assert span["action"] == "query" - assert span["sync"] is False - - -async def test_create(instrument, elasticapm_client, elasticsearch_async): - elasticapm_client.begin_transaction("test") - if ES_VERSION[0] < 5: - r1 = await elasticsearch_async.create("tweets", document_type, {"user": "kimchy", "text": "hola"}, 1) - elif ES_VERSION[0] < 7: - r1 = await elasticsearch_async.create("tweets", document_type, 1, body={"user": "kimchy", "text": "hola"}) - else: - r1 = await elasticsearch_async.create("tweets", 1, body={"user": "kimchy", "text": "hola"}) - r2 = await elasticsearch_async.create( - index="tweets", doc_type=document_type, id=2, body={"user": "kimchy", "text": "hola"}, refresh=True - ) - elasticapm_client.end_transaction("test", "OK") - - transaction = elasticapm_client.events[TRANSACTION][0] - - spans = elasticapm_client.spans_for_transaction(transaction) - assert len(spans) == 2 - - for i, span in enumerate(spans): - if ES_VERSION[0] >= 5: - assert span["name"] in ( - "ES PUT /tweets/%s/%d/_create" % (document_type, i + 1), - "ES PUT /tweets/_create/%d" % (i + 1), - ) - else: - assert span["name"] == "ES PUT /tweets/%s/%d" % (document_type, i + 1) - assert span["type"] == "db" - assert span["subtype"] == "elasticsearch" - assert span["action"] == "query" - assert span["context"]["db"]["type"] == "elasticsearch" - assert "statement" not in span["context"]["db"] - - -async def test_search_body(instrument, elasticapm_client, elasticsearch_async): - await elasticsearch_async.create( - index="tweets", doc_type=document_type, id=1, body={"user": "kimchy", "text": "hola", "userid": 1}, refresh=True - ) - elasticapm_client.begin_transaction("test") - search_query = {"query": {"term": {"user": "kimchy"}}, "sort": ["userid"]} - result = await elasticsearch_async.search(body=search_query, params=None) - elasticapm_client.end_transaction("test", "OK") - - transaction = elasticapm_client.events[TRANSACTION][0] - assert result["hits"]["hits"][0]["_source"] == {"user": "kimchy", "text": "hola", "userid": 1} - spans = elasticapm_client.spans_for_transaction(transaction) - assert len(spans) == 1 - span = spans[0] - # Depending on ES_VERSION, could be /_all/_search or /_search, and GET or POST - assert span["name"] in ("ES GET /_search", "ES GET /_all/_search", "ES POST /_search") - assert span["type"] == "db" - assert span["subtype"] == "elasticsearch" - assert span["action"] == "query" - assert span["context"]["db"]["type"] == "elasticsearch" - assert ( - span["context"]["db"]["statement"] == '{"sort": ["userid"], "query": {"term": {"user": "kimchy"}}}' - or span["context"]["db"]["statement"] == '{"query": {"term": {"user": "kimchy"}}, "sort": ["userid"]}' - ) - assert span["sync"] is False - - -async def test_count_body(instrument, elasticapm_client, elasticsearch_async): - await elasticsearch_async.create( - index="tweets", doc_type=document_type, id=1, body={"user": "kimchy", "text": "hola"}, refresh=True - ) - elasticapm_client.begin_transaction("test") - search_query = {"query": {"term": {"user": "kimchy"}}} - result = await elasticsearch_async.count(body=search_query) - elasticapm_client.end_transaction("test", "OK") - - transaction = elasticapm_client.events[TRANSACTION][0] - assert result["count"] == 1 - spans = elasticapm_client.spans_for_transaction(transaction) - assert len(spans) == 1 - span = spans[0] - assert span["name"] in ("ES GET /_count", "ES POST /_count", "ES GET /_all/_count") - assert span["type"] == "db" - assert span["subtype"] == "elasticsearch" - assert span["action"] == "query" - assert span["context"]["db"]["type"] == "elasticsearch" - assert span["context"]["db"]["statement"] == '{"query": {"term": {"user": "kimchy"}}}' - assert span["sync"] is False - - -@pytest.mark.skipif(ES_VERSION[0] < 5, reason="unsupported method") -async def test_delete_by_query_body(instrument, elasticapm_client, elasticsearch_async): - await elasticsearch_async.create( - index="tweets", doc_type=document_type, id=1, body={"user": "kimchy", "text": "hola"}, refresh=True - ) - elasticapm_client.begin_transaction("test") - result = await elasticsearch_async.delete_by_query(index="tweets", body={"query": {"term": {"user": "kimchy"}}}) - elasticapm_client.end_transaction("test", "OK") - - transaction = elasticapm_client.events[TRANSACTION][0] - spans = elasticapm_client.spans_for_transaction(transaction) - - span = spans[0] - assert span["name"] == "ES POST /tweets/_delete_by_query" - assert span["type"] == "db" - assert span["subtype"] == "elasticsearch" - assert span["action"] == "query" - assert span["context"]["db"]["type"] == "elasticsearch" - assert span["context"]["db"]["statement"] == '{"query": {"term": {"user": "kimchy"}}}' - assert span["sync"] is False diff --git a/tests/requirements/reqs-elasticsearch-6.txt b/tests/requirements/reqs-elasticsearch-6.txt index c56a948224..ad34285bca 100644 --- a/tests/requirements/reqs-elasticsearch-6.txt +++ b/tests/requirements/reqs-elasticsearch-6.txt @@ -1,3 +1,2 @@ elasticsearch>=6.0,<7.0 -elasticsearch-async ; python_version >= '3.7' -r reqs-base.txt diff --git a/tests/requirements/reqs-elasticsearch-7.txt b/tests/requirements/reqs-elasticsearch-7.txt index 7b30f34998..5fa4e0a258 100644 --- a/tests/requirements/reqs-elasticsearch-7.txt +++ b/tests/requirements/reqs-elasticsearch-7.txt @@ -1,4 +1,3 @@ elasticsearch>=7.0,<8.0 -elasticsearch-async ; python_version >= '3.7' aiohttp ; python_version >= '3.6' -r reqs-base.txt