Merge pull request #2 from bj00rn/chore/upgrade-pyscaffold

Chore/upgrade pyscaffold

.gitignore

@@ -20,7 +20,6 @@ __pycache__/*
 .pydevproject
 .settings
 .idea
-.vscode
 tags
 
 # Package files

.pre-commit-config.yaml

@@ -9,9 +9,7 @@ repos:
   - id: trailing-whitespace
   - id: check-added-large-files
   - id: check-ast
-  - id: check-json
   - id: check-merge-conflict
-  - id: check-xml
   - id: check-yaml
   - id: debug-statements
   - id: end-of-file-fixer
@@ -74,3 +72,8 @@ repos:
       - id: commitlint
         stages: [commit-msg]
         additional_dependencies: ['conventional-changelog-conventionalcommits']
+
+- repo: https://gitlab.com/bmares/check-json5
+  rev: v1.0.0
+  hooks:
+  - id: check-json5

.vscode/launch.json

@@ -0,0 +1,30 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Test server",
+            "type": "python",
+            "request": "launch",
+            "module": "aiohttp.web",
+            "justMyCode": true,
+            "args": ["-H", "localhost", "-P", "3001", "tests.utils.test_server:run_server"]
+        },
+        {
+            "name": "Debug CLI",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/src/pysaleryd/skeleton.py",
+            "console": "integratedTerminal",
+            "justMyCode": true,
+            "args": [
+                "--host",
+                "localhost",
+                "--port",
+                "3001"
+            ]
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+    "esbonio.sphinx.confDir": "",
+    "python.testing.pytestEnabled": true,
+    "python.testing.pytestArgs": [
+        // Coverage is not supported by vscode:
+        // https://github.com/Microsoft/vscode-python/issues/693
+        // Note that this will make pytest fail if pytest-cov is not installed,
+        // if that's the case, then this option needs to be be removed (overrides
+        // can be set at a workspace level, it's up to you to decide what's the
+        // best approach). You might also prefer to only set this option
+        // per-workspace (wherever coverage is used).
+        "--no-cov",
+        "-o",
+        "log_cli=1",
+        "--timeout=30",
+        "--verbose"
+    ],
+}

.vscode/tasks.json

@@ -0,0 +1,13 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Run test server",
+            "type": "shell",
+            "command": "python",
+            "args": ["-m", "aiohttp.web", "-H", "localhost", "-P", "3001", "tests.utils.test_server:run_server"]
+        }
+    ]
+}

setup.cfg

@@ -98,6 +98,7 @@ norecursedirs =
     dist
     build
     .tox
+    tests/utils
 testpaths = tests
 # Use pytest markers to select/deselect specific tests
 # markers =

tests/conftest.py

@@ -1,12 +1,12 @@
 """
-    Dummy conftest.py for pysaleryd.
+    Configure testing
 """
 import asyncio
 
-import aiohttp
 import pytest
 import pytest_asyncio
 from aiohttp import web
+from utils.test_server import WebsocketView
 
 
 @pytest.fixture(scope="session")
@@ -18,29 +18,9 @@ def event_loop():
     loop.close()
 
 
-async def websocket_handler(request):
-    ws = web.WebSocketResponse()
-    await ws.prepare(request)
-
-    async def cleanup():
-        await ws.close(code=aiohttp.WSCloseCode.GOING_AWAY, message="Server shutdown")
-
-    try:
-        async for msg in ws:
-            if msg.type == aiohttp.WSMsgType.TEXT:
-                while True:
-                    await ws.send_str("#MF: 1+ 0+ 2+1\r")
-                    await asyncio.sleep(0.5)
-    finally:
-        await asyncio.shield(cleanup())
-
-    return ws
-
-
 @pytest_asyncio.fixture()
-async def ws_server(aiohttp_server: web.Server):
+async def ws_server(aiohttp_server: "web.Server"):
     """Websocket test server"""
     app = web.Application()
-
-    app.add_routes([web.get("/", websocket_handler)])
+    app.add_routes([web.view("/", WebsocketView)])
     return await aiohttp_server(app, port=3001)

tests/test_client.py

@@ -1,64 +1,42 @@
+"""Client tests"""
 import asyncio
+import typing
 
 import aiohttp
 import pytest
 import pytest_asyncio
 
 from pysaleryd.client import Client, State
 
+if typing.TYPE_CHECKING:
+    from aiohttp import web_server
+
 __author__ = "Björn Dalfors"
 __copyright__ = "Björn Dalfors"
 __license__ = "MIT"
 
 
-async def on_shutdown(app):
-    """Shutdown ws connections on shutdown"""
-    for ws in set(app["websockets"]):
-        try:
-            await ws.close(
-                code=aiohttp.WSCloseCode.GOING_AWAY, message="Server shutdown"
-            )
-        except Exception:
-            pass
-
-
-@pytest_asyncio.fixture
-async def hrv_client(ws_server):
+@pytest_asyncio.fixture(name="hrv_client")
+async def _hrv_client(ws_server):
     """HRV Client"""
-    try:
-        async with aiohttp.ClientSession() as session:
-            async with Client("localhost", 3001, session) as client:
-                yield client
-    except Exception:
-        pass
+    async with aiohttp.ClientSession() as session:
+        async with Client("localhost", 3001, session) as client:
+            yield client
 
 
 @pytest.mark.asyncio
-async def test_client_connect(hrv_client: Client):
+async def test_client_connect(hrv_client: "Client"):
     """test connect"""
     assert hrv_client.state == State.RUNNING
 
 
 @pytest.mark.asyncio
-async def test_client_connect_unsresponsive():
-    """test status when client is unresponsive"""
-    async with aiohttp.ClientSession() as session:
-        client = Client("localhost", 3002, session)
-        try:
-            await client.connect()
-        except Exception:  # noqa: W0718
-            pass
-
-        assert client.state == State.STOPPED
-
-
-@pytest.mark.asyncio
-async def test_handler(hrv_client: Client, mocker):
+async def test_handler(hrv_client: "Client", mocker):
     """Test handler callback"""
     handler = mocker.Mock()
 
     def broken_handler(data):
-        raise Exception()
+        raise Exception()  # pylint: disable=W0719
 
     hrv_client.add_handler(broken_handler)
     hrv_client.add_handler(handler)
@@ -67,15 +45,15 @@ def broken_handler(data):
 
 
 @pytest.mark.asyncio
-async def test_get_data(hrv_client: Client, mocker):
+async def test_get_data(hrv_client: "Client"):
     """Test get data"""
-    await asyncio.sleep(1)
+    await asyncio.sleep(5)
     assert isinstance(hrv_client.data, dict)
     assert any(hrv_client.data.keys())
 
 
 @pytest.mark.asyncio
-async def test_reconnect(hrv_client: Client, ws_server):
+async def test_reconnect(hrv_client: "Client", ws_server: "web_server.Server"):
     """Test reconnect"""
 
     async def has_state(state):
@@ -90,16 +68,16 @@ async def has_state(state):
 
 
 @pytest.mark.asyncio
-async def test_send_command(hrv_client: Client, mocker):
+async def test_send_command(hrv_client: "Client"):
     """Test send command"""
     await hrv_client.send_command("MF", "0")
 
 
 @pytest.mark.asyncio
-async def test_disconnect(hrv_client: Client, mocker):
+async def test_disconnect(hrv_client: "Client"):
     """Test send command"""
     hrv_client.disconnect()
     await asyncio.sleep(2)
     assert hrv_client.state == State.STOPPED
     await asyncio.sleep(2)
-    assert hrv_client._socket._ws.closed
+    assert hrv_client._socket._ws.closed  # pylint: disable=all

tests/test_utils.py → tests/test_parser.py

@@ -12,12 +12,13 @@
 _LOGGER = logging.getLogger(__name__)
 
 
-@pytest.fixture
-def parser() -> Parser:
+@pytest.fixture(name="parser")
+def _parser() -> Parser:
     return Parser()
 
 
 def test_parse_int_from_list_str(parser: Parser):
+    """Test parsing int list"""
     (key, value) = parser.from_str("#MF: 1+ 0+ 2+30\r")
     assert key == "MF"
     assert isinstance(value, list)
@@ -28,13 +29,15 @@ def test_parse_int_from_list_str(parser: Parser):
 
 
 def test_parse_int_from_str(parser: Parser):
+    """Test parsing int"""
     (key, value) = parser.from_str("#*XX:0\r")
     assert key == "*XX"
     assert isinstance(value, int)
     assert value == 0
 
 
 def test_parse_str_from_str(parser: Parser):
+    """Test parsing str"""
     (key, value) = parser.from_str("#*XX:xxx\r")
     assert key == "*XX"
     assert isinstance(value, str)
@@ -47,9 +50,6 @@ def test_parse_str_from_str(parser: Parser):
 
 
 def test_parse_error(parser: Parser):
-    did_throw = False
-    try:
+    """Test parse error"""
+    with pytest.raises(ParseError):
         parser.from_str("wer")
-    except ParseError:
-        did_throw = True
-    assert did_throw

tests/test_skeleton.py

@@ -1,3 +1,5 @@
+"""CLI Tests"""
+
 import pytest
 
 from pysaleryd.skeleton import main
@@ -8,7 +10,7 @@
 
 
 @pytest.mark.skip
-def test_main(capsys, ws_server):
+def test_main(capsys, ws_server):  # pylint: disable W0613
     """CLI Tests"""
     # capsys is a pytest fixture that allows asserts against stdout/stderr
     # https://docs.pytest.org/en/stable/capture.html