Add ruff and mypy into tox (#188)

* Add extra ruff checks

* Add mypy test target

* Add missing __init__ file

* Enable check_untyped_defs in mypy

Author: JohnGarbutt

capi_janitor/__init__.py

@@ -8,13 +8,13 @@
 import kopf
 import yaml
 
-import easykube  # type: ignore
+import easykube
 import httpx
 
 from . import openstack
 
-ekconfig = None
-ekclient = None
+ekconfig: easykube.Configuration
+ekclient: easykube.AsyncClient
 
 CAPO_API_GROUP = "infrastructure.cluster.x-k8s.io"
 FINALIZER = "janitor.capi.stackhpc.com"
@@ -310,7 +310,7 @@ async def wrapper(**kwargs):
                 kwargs["logger"].warn(str(exc))
                 backoff = exc.delay
             elif isinstance(
-                exc, (FinalizerStillPresentError, ResourcesStillPresentError)
+                exc, FinalizerStillPresentError | ResourcesStillPresentError
             ):
                 kwargs["logger"].warn(str(exc))
                 backoff = 5
@@ -319,6 +319,8 @@ async def wrapper(**kwargs):
                 # Calculate the backoff
                 backoff = RETRY_DEFAULT_DELAY
             # Wait for the backoff before annotating the resource
+            if backoff is None:
+                backoff = RETRY_DEFAULT_DELAY
             await asyncio.sleep(backoff)
             # Annotate the object with a random value to trigger another event
             try:

capi_janitor/openstack/operator.py

@@ -15,7 +15,7 @@ async def test_operator(self):
         mock_easykube = mock.AsyncMock(spec=easykube.AsyncClient)
         operator.ekclient = mock_easykube
 
-        await operator.on_cleanup()
+        await operator.on_cleanup()  # type: ignore
 
         mock_easykube.aclose.assert_awaited_once_with()
 

capi_janitor/tests/openstack/test_operator.py

@@ -23,3 +23,21 @@ builtins = ["_"]
 quote-style = "double"
 indent-style = "space"
 line-ending = "auto"
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # flake8-async
+    "ASYNC",
+    # pyupgrade
+    "UP",
+]
+
+[tool.mypy]
+follow_imports = "silent"
+warn_redundant_casts = true
+warn_unused_ignores = true
+check_untyped_defs = true

pyproject.toml

@@ -5,3 +5,5 @@ coverage>=4.0,!=4.4 # Apache-2.0
 stestr>=4.2.0 # Apache-2.0
 codespell
 types-PyYAML
+types-setuptools
+mypy

test-requirements.txt

@@ -1,6 +1,6 @@
 [tox]
 minversion = 4.0.0
-envlist = py3,ruff,codespell,pep8
+envlist = py3,ruff,codespell,pep8,mypy
 skipsdist = True
 
 [testenv]
@@ -45,6 +45,9 @@ commands =
     coverage xml -o cover/coverage.xml
     coverage report
 
+[testenv:mypy]
+commands = mypy {tox_root} {posargs}
+
 [flake8]
 # select only hacking errors
 select = H