From 1b783c9bdeea6ea893a4842368d7cc8d09f875f1 Mon Sep 17 00:00:00 2001
From: Malte Franken <exxamalte@users.noreply.github.com>
Date: Tue, 9 Jan 2024 20:35:27 +1100
Subject: [PATCH] Migrate to pytest (#42)

* add test requirements

* add pytest configuration

* add requirements

* refactoring ci process

* fix typo

* use async pytest

* add pytest libraries

* add pytest libraries

* remove unnecessary file

* remove event_loop fixture

* migrated to different http mock library
---
 .github/workflows/ci.yaml  |  23 +++++---
 pyproject.toml             |   5 ++
 requirements-test.txt      |   6 +++
 requirements.txt           |   3 ++
 tests/conftest.py          |  10 ++++
 tests/test_feed.py         | 105 +++++++++++++++++--------------------
 tests/test_feed_manager.py |  68 +++++++++++-------------
 tox.ini                    |  40 --------------
 8 files changed, 118 insertions(+), 142 deletions(-)
 create mode 100644 requirements-test.txt
 create mode 100644 requirements.txt
 create mode 100644 tests/conftest.py
 delete mode 100644 tox.ini

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index df3e225..312489e 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -12,7 +12,7 @@ jobs:
     name: Python ${{ matrix.python-version }}
     runs-on: ubuntu-latest
     env:
-      USING_COVERAGE: '3.8'
+      USING_COVERAGE: '3.10'
     strategy:
       fail-fast: true
       matrix:
@@ -28,13 +28,22 @@ jobs:
           python -VV
           python -m site
           python -m pip install --upgrade pip setuptools wheel
-          python -m pip install --upgrade coverage[toml] virtualenv tox tox-gh-actions
-      - name: "Run tox targets for ${{ matrix.python-version }}"
-        run: "python -m tox"
-      - name: "Combine coverage"
-        if: "contains(env.USING_COVERAGE, matrix.python-version)"
+          python -m pip install -r requirements.txt
+          python -m pip install -r requirements-test.txt
+      - name: "Run tests for ${{ matrix.python-version }}"
         run: |
-          set -xe
+          pip install pytest-cov
+          pip install coverage
+          pytest \
+            -qq \
+            --timeout=9 \
+            --durations=10 \
+            -n auto \
+            --cov aio_geojson_client \
+            --cov-report xml \
+            -o console_output_style=count \
+            -p no:sugar \
+            tests
           python -m coverage xml
       - name: "Upload coverage to Codecov"
         if: "contains(env.USING_COVERAGE, matrix.python-version)"
diff --git a/pyproject.toml b/pyproject.toml
index 4cea53a..9f01eba 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,3 +4,8 @@ target-version = ['py38', 'py39', 'py310', 'py311']
 [tool.isort]
 profile = "black"
 src_paths = ["aio_geojson_client", "tests"]
+
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]
diff --git a/requirements-test.txt b/requirements-test.txt
new file mode 100644
index 0000000..925d447
--- /dev/null
+++ b/requirements-test.txt
@@ -0,0 +1,6 @@
+pytest-asyncio
+pytest-timeout
+pytest-xdist
+pytest-cov
+mock
+aioresponses
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..060d88f
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,3 @@
+aiohttp>=3.7.4,<4
+geojson>=2.4.0
+haversine>=1.0.1
diff --git a/tests/conftest.py b/tests/conftest.py
new file mode 100644
index 0000000..6cf4a6a
--- /dev/null
+++ b/tests/conftest.py
@@ -0,0 +1,10 @@
+"""Configuration for tests."""
+import pytest
+from aioresponses import aioresponses
+
+
+@pytest.fixture
+def mock_aioresponse():
+    """Return aioresponse fixture."""
+    with aioresponses() as m:
+        yield m
diff --git a/tests/test_feed.py b/tests/test_feed.py
index 62a65ba..88fdfd3 100644
--- a/tests/test_feed.py
+++ b/tests/test_feed.py
@@ -1,5 +1,6 @@
 """Test for the generic geojson feed."""
 import asyncio
+from http import HTTPStatus
 from unittest.mock import MagicMock
 
 import aiohttp
@@ -15,18 +16,16 @@
 
 
 @pytest.mark.asyncio
-async def test_update_ok(aresponses, event_loop):
+async def test_update_ok(mock_aioresponse):
     """Test updating feed is ok."""
     home_coordinates = (-31.0, 151.0)
-    aresponses.add(
-        "test.url",
-        "/testpath",
-        "get",
-        aresponses.Response(text=load_fixture("generic_feed_1.json"), status=200),
+    mock_aioresponse.get(
+        "http://test.url/testpath",
+        status=HTTPStatus.OK,
+        body=load_fixture("generic_feed_1.json"),
     )
 
-    async with aiohttp.ClientSession(loop=event_loop) as websession:
-
+    async with aiohttp.ClientSession(loop=asyncio.get_running_loop()) as websession:
         feed = MockGeoJsonFeed(websession, home_coordinates, "http://test.url/testpath")
         assert (
             repr(feed) == "<MockGeoJsonFeed(home=(-31.0, 151.0), "
@@ -67,17 +66,16 @@ async def test_update_ok(aresponses, event_loop):
 
 
 @pytest.mark.asyncio
-async def test_update_ok_with_filtering(aresponses, event_loop):
+async def test_update_ok_with_filtering(mock_aioresponse):
     """Test updating feed is ok."""
     home_coordinates = (-37.0, 150.0)
-    aresponses.add(
-        "test.url",
-        "/testpath",
-        "get",
-        aresponses.Response(text=load_fixture("generic_feed_1.json"), status=200),
+    mock_aioresponse.get(
+        "http://test.url/testpath",
+        status=HTTPStatus.OK,
+        body=load_fixture("generic_feed_1.json"),
     )
 
-    async with aiohttp.ClientSession(loop=event_loop) as websession:
+    async with aiohttp.ClientSession(loop=asyncio.get_running_loop()) as websession:
         feed = MockGeoJsonFeed(
             websession, home_coordinates, "http://test.url/testpath", filter_radius=90.0
         )
@@ -91,17 +89,16 @@ async def test_update_ok_with_filtering(aresponses, event_loop):
 
 
 @pytest.mark.asyncio
-async def test_update_ok_with_filter_override(aresponses, event_loop):
+async def test_update_ok_with_filter_override(mock_aioresponse):
     """Test updating feed is ok."""
     home_coordinates = (-37.0, 150.0)
-    aresponses.add(
-        "test.url",
-        "/testpath",
-        "get",
-        aresponses.Response(text=load_fixture("generic_feed_1.json"), status=200),
+    mock_aioresponse.get(
+        "http://test.url/testpath",
+        status=HTTPStatus.OK,
+        body=load_fixture("generic_feed_1.json"),
     )
 
-    async with aiohttp.ClientSession(loop=event_loop) as websession:
+    async with aiohttp.ClientSession(loop=asyncio.get_running_loop()) as websession:
         feed = MockGeoJsonFeed(
             websession, home_coordinates, "http://test.url/testpath", filter_radius=60.0
         )
@@ -117,18 +114,16 @@ async def test_update_ok_with_filter_override(aresponses, event_loop):
 
 
 @pytest.mark.asyncio
-async def test_update_geometries(aresponses, event_loop):
+async def test_update_geometries(mock_aioresponse):
     """Test updating feed is ok."""
     home_coordinates = (-31.0, 151.0)
-    aresponses.add(
-        "test.url",
-        "/testpath",
-        "get",
-        aresponses.Response(text=load_fixture("generic_feed_3.json"), status=200),
+    mock_aioresponse.get(
+        "http://test.url/testpath",
+        status=HTTPStatus.OK,
+        body=load_fixture("generic_feed_3.json"),
     )
 
-    async with aiohttp.ClientSession(loop=event_loop) as websession:
-
+    async with aiohttp.ClientSession(loop=asyncio.get_running_loop()) as websession:
         feed = MockGeoJsonFeed(websession, home_coordinates, "http://test.url/testpath")
         assert (
             repr(feed) == "<MockGeoJsonFeed(home=(-31.0, 151.0), "
@@ -165,11 +160,11 @@ async def test_update_geometries(aresponses, event_loop):
 
 
 @pytest.mark.asyncio
-async def test_update_with_client_exception(event_loop):
+async def test_update_with_client_exception():
     """Test updating feed results in error."""
     home_coordinates = (-31.0, 151.0)
 
-    async with aiohttp.ClientSession(loop=event_loop):
+    async with aiohttp.ClientSession(loop=asyncio.get_running_loop()):
         mock_websession = MagicMock()
         mock_websession.request.side_effect = ClientOSError
         feed = MockGeoJsonFeed(
@@ -181,12 +176,12 @@ async def test_update_with_client_exception(event_loop):
 
 
 @pytest.mark.asyncio
-async def test_update_with_request_exception(aresponses, event_loop):
+async def test_update_with_request_exception(mock_aioresponse):
     """Test updating feed results in error."""
     home_coordinates = (-31.0, 151.0)
-    aresponses.add("test.url", "/badpath", "get", aresponses.Response(status=404))
+    mock_aioresponse.get("http://test.url/testpath", status=HTTPStatus.NOT_FOUND)
 
-    async with aiohttp.ClientSession(loop=event_loop) as websession:
+    async with aiohttp.ClientSession(loop=asyncio.get_running_loop()) as websession:
         feed = MockGeoJsonFeed(websession, home_coordinates, "http://test.url/badpath")
         status, entries = await feed.update()
         assert status == UPDATE_ERROR
@@ -194,14 +189,14 @@ async def test_update_with_request_exception(aresponses, event_loop):
 
 
 @pytest.mark.asyncio
-async def test_update_with_json_decode_error(aresponses, event_loop):
+async def test_update_with_json_decode_error(mock_aioresponse):
     """Test updating feed raises exception."""
     home_coordinates = (-31.0, 151.0)
-    aresponses.add(
-        "test.url", "/badjson", "get", aresponses.Response(text="NOT JSON", status=200)
+    mock_aioresponse.get(
+        "http://test.url/badjson", status=HTTPStatus.OK, body="NOT JSON"
     )
 
-    async with aiohttp.ClientSession(loop=event_loop) as websession:
+    async with aiohttp.ClientSession(loop=asyncio.get_running_loop()) as websession:
         feed = MockGeoJsonFeed(websession, home_coordinates, "http://test.url/badjson")
         status, entries = await feed.update()
         assert status == UPDATE_ERROR
@@ -209,11 +204,11 @@ async def test_update_with_json_decode_error(aresponses, event_loop):
 
 
 @pytest.mark.asyncio
-async def test_update_with_timeout_error(event_loop):
+async def test_update_with_timeout_error():
     """Test updating feed results in timeout error."""
     home_coordinates = (-31.0, 151.0)
 
-    async with aiohttp.ClientSession(loop=event_loop):
+    async with aiohttp.ClientSession(loop=asyncio.get_running_loop()):
         mock_websession = MagicMock()
         mock_websession.request.side_effect = asyncio.TimeoutError
         feed = MockGeoJsonFeed(
@@ -225,18 +220,16 @@ async def test_update_with_timeout_error(event_loop):
 
 
 @pytest.mark.asyncio
-async def test_update_ok_feed_feature(aresponses, event_loop):
+async def test_update_ok_feed_feature(mock_aioresponse):
     """Test updating feed is ok."""
     home_coordinates = (-31.0, 151.0)
-    aresponses.add(
-        "test.url",
-        "/testpath",
-        "get",
-        aresponses.Response(text=load_fixture("generic_feed_4.json"), status=200),
+    mock_aioresponse.get(
+        "http://test.url/testpath",
+        status=HTTPStatus.OK,
+        body=load_fixture("generic_feed_4.json"),
     )
 
-    async with aiohttp.ClientSession(loop=event_loop) as websession:
-
+    async with aiohttp.ClientSession(loop=asyncio.get_running_loop()) as websession:
         feed = MockGeoJsonFeed(websession, home_coordinates, "http://test.url/testpath")
         assert (
             repr(feed) == "<MockGeoJsonFeed(home=(-31.0, 151.0), "
@@ -257,18 +250,16 @@ async def test_update_ok_feed_feature(aresponses, event_loop):
 
 
 @pytest.mark.asyncio
-async def test_unsupported_object(aresponses, event_loop, caplog):
+async def test_unsupported_object(mock_aioresponse, caplog):
     """Test updating feed is ok."""
     home_coordinates = (-31.0, 151.0)
-    aresponses.add(
-        "test.url",
-        "/testpath",
-        "get",
-        aresponses.Response(text=load_fixture("generic_feed_5.json"), status=200),
+    mock_aioresponse.get(
+        "http://test.url/testpath",
+        status=HTTPStatus.OK,
+        body=load_fixture("generic_feed_5.json"),
     )
 
-    async with aiohttp.ClientSession(loop=event_loop) as websession:
-
+    async with aiohttp.ClientSession(loop=asyncio.get_running_loop()) as websession:
         feed = MockGeoJsonFeed(websession, home_coordinates, "http://test.url/testpath")
         assert (
             repr(feed) == "<MockGeoJsonFeed(home=(-31.0, 151.0), "
diff --git a/tests/test_feed_manager.py b/tests/test_feed_manager.py
index 7a2718d..90a03e7 100644
--- a/tests/test_feed_manager.py
+++ b/tests/test_feed_manager.py
@@ -1,7 +1,10 @@
 """Test for the generic geojson feed manager."""
+import asyncio
+from http import HTTPStatus
+
 import aiohttp
-import pytest
 import mock as async_mock
+import pytest
 
 from aio_geojson_client.consts import UPDATE_OK_NO_DATA
 from aio_geojson_client.feed_manager import FeedManagerBase
@@ -11,18 +14,16 @@
 
 
 @pytest.mark.asyncio
-async def test_feed_manager(aresponses, event_loop):
+async def test_feed_manager(mock_aioresponse):
     """Test the feed manager."""
     home_coordinates = (-31.0, 151.0)
-    aresponses.add(
-        "test.url",
-        "/testpath",
-        "get",
-        aresponses.Response(text=load_fixture("generic_feed_1.json"), status=200),
+    mock_aioresponse.get(
+        "http://test.url/testpath",
+        status=HTTPStatus.OK,
+        body=load_fixture("generic_feed_1.json"),
     )
 
-    async with aiohttp.ClientSession(loop=event_loop) as websession:
-
+    async with aiohttp.ClientSession(loop=asyncio.get_running_loop()) as websession:
         feed = MockGeoJsonFeed(websession, home_coordinates, "http://test.url/testpath")
 
         # This will just record calls and keep track of external ids.
@@ -91,11 +92,10 @@ async def _remove_entity(external_id):
         updated_entity_external_ids.clear()
         removed_entity_external_ids.clear()
 
-        aresponses.add(
-            "test.url",
-            "/testpath",
-            "get",
-            aresponses.Response(text=load_fixture("generic_feed_2.json"), status=200),
+        mock_aioresponse.get(
+            "http://test.url/testpath",
+            status=HTTPStatus.OK,
+            body=load_fixture("generic_feed_2.json"),
         )
 
         await feed_manager.update()
@@ -121,7 +121,8 @@ async def _remove_entity(external_id):
         removed_entity_external_ids.clear()
 
         with async_mock.patch(
-            "aio_geojson_client.feed.GeoJsonFeed._fetch", new_callable=async_mock.AsyncMock
+            "aio_geojson_client.feed.GeoJsonFeed._fetch",
+            new_callable=async_mock.AsyncMock,
         ) as mock_fetch:
             mock_fetch.return_value = (UPDATE_OK_NO_DATA, None)
 
@@ -138,11 +139,8 @@ async def _remove_entity(external_id):
         updated_entity_external_ids.clear()
         removed_entity_external_ids.clear()
 
-        aresponses.add(
-            "test.url",
-            "/testpath",
-            "get",
-            aresponses.Response(status=500),
+        mock_aioresponse.get(
+            "http://test.url/testpath", status=HTTPStatus.INTERNAL_SERVER_ERROR
         )
 
         await feed_manager.update()
@@ -158,11 +156,10 @@ async def _remove_entity(external_id):
         updated_entity_external_ids.clear()
         removed_entity_external_ids.clear()
 
-        aresponses.add(
-            "test.url",
-            "/testpath",
-            "get",
-            aresponses.Response(text=load_fixture("generic_feed_1.json"), status=200),
+        mock_aioresponse.get(
+            "http://test.url/testpath",
+            status=HTTPStatus.OK,
+            body=load_fixture("generic_feed_1.json"),
         )
         await feed_manager.update_override(
             filter_overrides=GeoJsonFeedFilterDefinition(radius=750.0)
@@ -175,18 +172,16 @@ async def _remove_entity(external_id):
 
 
 @pytest.mark.asyncio
-async def test_feed_manager_with_status_callback(aresponses, event_loop):
+async def test_feed_manager_with_status_callback(mock_aioresponse):
     """Test the feed manager."""
     home_coordinates = (-31.0, 151.0)
-    aresponses.add(
-        "test.url",
-        "/testpath",
-        "get",
-        aresponses.Response(text=load_fixture("generic_feed_1.json"), status=200),
+    mock_aioresponse.get(
+        "http://test.url/testpath",
+        status=HTTPStatus.OK,
+        body=load_fixture("generic_feed_1.json"),
     )
 
-    async with aiohttp.ClientSession(loop=event_loop) as websession:
-
+    async with aiohttp.ClientSession(loop=asyncio.get_running_loop()) as websession:
         feed = MockGeoJsonFeed(websession, home_coordinates, "http://test.url/testpath")
 
         # This will just record calls and keep track of external ids.
@@ -251,11 +246,8 @@ async def _status(status_details):
         removed_entity_external_ids.clear()
         status_update.clear()
 
-        aresponses.add(
-            "test.url",
-            "/testpath",
-            "get",
-            aresponses.Response(status=500),
+        mock_aioresponse.get(
+            "http://test.url/testpath", status=HTTPStatus.INTERNAL_SERVER_ERROR
         )
 
         await feed_manager.update()
diff --git a/tox.ini b/tox.ini
deleted file mode 100644
index eccb51c..0000000
--- a/tox.ini
+++ /dev/null
@@ -1,40 +0,0 @@
-[tox]
-envlist = py38, py39, py310, py311, cov, cov_local
-skip_missing_interpreters = True
-ignore_basepython_conflict = True
-
-[gh-actions]
-python =
-    3.8: cov
-    3.9: py39
-    3.10: py310
-    3.11: py311
-
-[testenv]
-deps=
-    pytest
-    mock
-    aresponses
-commands=pytest
-
-[testenv:cov]
-basepython=python3.8
-deps=
-    pytest
-    pytest-cov
-    mock
-    aresponses
-commands=
-    pytest --cov --cov-report= {posargs}
-
-[testenv:cov_local]
-basepython=python3.8
-deps=
-    pytest
-    pytest-cov
-    mock
-    aresponses
-commands=
-    pytest --cov --cov-report=
-    coverage report
-    coverage html