Switch to pytest-asyncio's strict mode for async tests (#1782)

* Switch to pytest-asyncio's strict mode for async tests

* add one missing test

* use 'sync' as sync I/O marker

Author: miguelgrinberg

setup.cfg

@@ -11,4 +11,5 @@ filterwarnings =
     error
     ignore:Legacy index templates are deprecated in favor of composable templates.:elasticsearch.exceptions.ElasticsearchWarning
     ignore:datetime.datetime.utcfromtimestamp\(\) is deprecated and scheduled for removal in a future version..*:DeprecationWarning
-asyncio_mode = auto
+markers =
+    sync: mark a test as performing I/O without asyncio.

tests/_async/test_document.py

@@ -21,6 +21,7 @@
 from datetime import datetime
 from hashlib import md5
 
+import pytest
 from pytest import raises
 
 from elasticsearch_dsl import (
@@ -570,18 +571,21 @@ def test_meta_fields_can_be_set_directly_in_init():
     assert md.meta.id is p
 
 
+@pytest.mark.asyncio
 async def test_save_no_index(async_mock_client):
     md = MyDoc()
     with raises(ValidationException):
         await md.save(using="mock")
 
 
+@pytest.mark.asyncio
 async def test_delete_no_index(async_mock_client):
     md = MyDoc()
     with raises(ValidationException):
         await md.delete(using="mock")
 
 
+@pytest.mark.asyncio
 async def test_update_no_fields():
     md = MyDoc()
     with raises(IllegalOperation):

tests/_async/test_index.py

@@ -18,6 +18,7 @@
 import string
 from random import choice
 
+import pytest
 from pytest import raises
 
 from elasticsearch_dsl import (
@@ -188,6 +189,7 @@ def test_index_template_can_have_order():
     assert {"index_patterns": ["i-*"], "order": 2} == it.to_dict()
 
 
+@pytest.mark.asyncio
 async def test_index_template_save_result(async_mock_client):
     it = AsyncIndexTemplate("test-template", "test-*")
 

tests/_async/test_search.py

@@ -17,6 +17,7 @@
 
 from copy import deepcopy
 
+import pytest
 from pytest import raises, warns
 
 from elasticsearch_dsl import A, AsyncEmptySearch, AsyncSearch, Document, Q, query
@@ -29,6 +30,7 @@ def test_expand__to_dot_is_respected():
     assert {"query": {"match": {"a__b": 42}}} == s.to_dict()
 
 
+@pytest.mark.asyncio
 async def test_execute_uses_cache():
     s = AsyncSearch()
     r = object()
@@ -37,6 +39,7 @@ async def test_execute_uses_cache():
     assert r is await s.execute()
 
 
+@pytest.mark.asyncio
 async def test_cache_can_be_ignored(async_mock_client):
     s = AsyncSearch(using="mock")
     r = object()
@@ -46,6 +49,7 @@ async def test_cache_can_be_ignored(async_mock_client):
     async_mock_client.search.assert_awaited_once_with(index=None, body={})
 
 
+@pytest.mark.asyncio
 async def test_iter_iterates_over_hits():
     s = AsyncSearch()
     s._response = [1, 2, 3]
@@ -514,6 +518,7 @@ def test_from_dict_doesnt_need_query():
     assert {"size": 5} == s.to_dict()
 
 
+@pytest.mark.asyncio
 async def test_params_being_passed_to_search(async_mock_client):
     s = AsyncSearch(using="mock")
     s = s.params(routing="42")
@@ -605,6 +610,7 @@ def test_exclude():
     } == s.to_dict()
 
 
+@pytest.mark.asyncio
 async def test_delete_by_query(async_mock_client):
     s = AsyncSearch(using="mock").query("match", lang="java")
     await s.delete()
@@ -689,6 +695,7 @@ def test_rescore_query_to_dict():
     }
 
 
+@pytest.mark.asyncio
 async def test_empty_search():
     s = AsyncEmptySearch(index="index-name")
     s = s.query("match", lang="java")

tests/_async/test_update_by_query.py

@@ -17,6 +17,8 @@
 
 from copy import deepcopy
 
+import pytest
+
 from elasticsearch_dsl import AsyncUpdateByQuery, Q
 from elasticsearch_dsl.response import UpdateByQueryResponse
 
@@ -136,6 +138,7 @@ def test_from_dict_doesnt_need_query():
     assert {"script": {"source": "test"}} == ubq.to_dict()
 
 
+@pytest.mark.asyncio
 async def test_params_being_passed_to_search(async_mock_client):
     ubq = AsyncUpdateByQuery(using="mock")
     ubq = ubq.params(routing="42")

tests/_sync/test_document.py

@@ -21,6 +21,7 @@
 from datetime import datetime
 from hashlib import md5
 
+import pytest
 from pytest import raises
 
 from elasticsearch_dsl import (
@@ -570,18 +571,21 @@ def test_meta_fields_can_be_set_directly_in_init():
     assert md.meta.id is p
 
 
+@pytest.mark.sync
 def test_save_no_index(mock_client):
     md = MyDoc()
     with raises(ValidationException):
         md.save(using="mock")
 
 
+@pytest.mark.sync
 def test_delete_no_index(mock_client):
     md = MyDoc()
     with raises(ValidationException):
         md.delete(using="mock")
 
 
+@pytest.mark.sync
 def test_update_no_fields():
     md = MyDoc()
     with raises(IllegalOperation):

tests/_sync/test_index.py

@@ -18,6 +18,7 @@
 import string
 from random import choice
 
+import pytest
 from pytest import raises
 
 from elasticsearch_dsl import Date, Document, Index, IndexTemplate, Text, analyzer
@@ -181,6 +182,7 @@ def test_index_template_can_have_order():
     assert {"index_patterns": ["i-*"], "order": 2} == it.to_dict()
 
 
+@pytest.mark.sync
 def test_index_template_save_result(mock_client):
     it = IndexTemplate("test-template", "test-*")
 

tests/_sync/test_search.py

@@ -17,6 +17,7 @@
 
 from copy import deepcopy
 
+import pytest
 from pytest import raises, warns
 
 from elasticsearch_dsl import A, Document, EmptySearch, Q, Search, query
@@ -29,6 +30,7 @@ def test_expand__to_dot_is_respected():
     assert {"query": {"match": {"a__b": 42}}} == s.to_dict()
 
 
+@pytest.mark.sync
 def test_execute_uses_cache():
     s = Search()
     r = object()
@@ -37,6 +39,7 @@ def test_execute_uses_cache():
     assert r is s.execute()
 
 
+@pytest.mark.sync
 def test_cache_can_be_ignored(mock_client):
     s = Search(using="mock")
     r = object()
@@ -46,6 +49,7 @@ def test_cache_can_be_ignored(mock_client):
     mock_client.search.assert_called_once_with(index=None, body={})
 
 
+@pytest.mark.sync
 def test_iter_iterates_over_hits():
     s = Search()
     s._response = [1, 2, 3]
@@ -514,6 +518,7 @@ def test_from_dict_doesnt_need_query():
     assert {"size": 5} == s.to_dict()
 
 
+@pytest.mark.sync
 def test_params_being_passed_to_search(mock_client):
     s = Search(using="mock")
     s = s.params(routing="42")
@@ -603,6 +608,7 @@ def test_exclude():
     } == s.to_dict()
 
 
+@pytest.mark.sync
 def test_delete_by_query(mock_client):
     s = Search(using="mock").query("match", lang="java")
     s.delete()
@@ -687,6 +693,7 @@ def test_rescore_query_to_dict():
     }
 
 
+@pytest.mark.sync
 def test_empty_search():
     s = EmptySearch(index="index-name")
     s = s.query("match", lang="java")

tests/_sync/test_update_by_query.py

@@ -17,6 +17,8 @@
 
 from copy import deepcopy
 
+import pytest
+
 from elasticsearch_dsl import Q, UpdateByQuery
 from elasticsearch_dsl.response import UpdateByQueryResponse
 
@@ -136,6 +138,7 @@ def test_from_dict_doesnt_need_query():
     assert {"script": {"source": "test"}} == ubq.to_dict()
 
 
+@pytest.mark.sync
 def test_params_being_passed_to_search(mock_client):
     ubq = UpdateByQuery(using="mock")
     ubq = ubq.params(routing="42")

tests/test_integration/_async/test_analysis.py

@@ -15,9 +15,12 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+import pytest
+
 from elasticsearch_dsl import analyzer, token_filter, tokenizer
 
 
+@pytest.mark.asyncio
 async def test_simulate_with_just__builtin_tokenizer(async_client):
     a = analyzer("my-analyzer", tokenizer="keyword")
     tokens = (await a.async_simulate("Hello World!", using=async_client)).tokens
@@ -26,6 +29,7 @@ async def test_simulate_with_just__builtin_tokenizer(async_client):
     assert tokens[0].token == "Hello World!"
 
 
+@pytest.mark.asyncio
 async def test_simulate_complex(async_client):
     a = analyzer(
         "my-analyzer",
@@ -39,6 +43,7 @@ async def test_simulate_complex(async_client):
     assert ["this", "works"] == [t.token for t in tokens]
 
 
+@pytest.mark.asyncio
 async def test_simulate_builtin(async_client):
     a = analyzer("my-analyzer", "english")
     tokens = (await a.async_simulate("fixes running")).tokens