Improve tox.ini autofix (#194)

* Improve autofixing bits in tox

* Removing openstack hacking style for now

* Fix up missing black and ruff config

* Fix code coverage upload name

* Fix up ruff and black config

* Add README note on testing

* Add notes about running autofix last

* Add TODO around removing black in the future

* Fix typo picked up by codespell

Author: JohnGarbutt

.github/workflows/tox.yaml

@@ -41,5 +41,5 @@ jobs:
     - name: Archive code coverage results
       uses: actions/upload-artifact@v4
       with:
-        name: code-coverage-report
+        name: "code-coverage-report-${{ matrix.python-version }}"
         path: cover/

README.md

@@ -24,6 +24,26 @@ helm upgrade \
   --install
 ```
 
+## Tox for unittests and linting
+
+We use tox to run unit tests and linters across the code.
+To run all the checks, including efforts to automatically
+fix linting issues, please run:
+
+```sh
+tox
+```
+
+You can run individual unit tests by running:
+
+```sh
+tox -e py3 -- <name-of-unit-test>
+```
+
+Note, failures on your initial tox run may be automatically
+fixed, where possible. So your second tox run may pass.
+This way we can run the default tox target in CI.
+
 ## Configuration
 
 `cluster-api-janitor-openstack` will always clean up

capi_janitor/openstack/openstack.py

@@ -4,7 +4,6 @@
 import urllib.parse
 
 import httpx
-
 from easykube import rest
 
 

capi_janitor/openstack/operator.py

@@ -5,11 +5,10 @@
 import random
 import string
 
-import kopf
-import yaml
-
 import easykube
 import httpx
+import kopf
+import yaml
 
 from . import openstack
 
@@ -47,9 +46,7 @@ async def on_startup(**kwargs):
 
 @kopf.on.cleanup()
 async def on_cleanup(**kwargs):
-    """
-    Runs on operator shutdown.
-    """
+    """Runs on operator shutdown."""
     # Make sure that the easykube client is shut down properly
     await ekclient.aclose()
 
@@ -105,7 +102,6 @@ async def secgroups_for_cluster(resource, cluster):
 
 async def filtered_volumes_for_cluster(resource, cluster):
     """Async iterator for volumes belonging to the specified cluster."""
-
     async for vol in resource.list():
         # CSI Cinder sets metadata on the volumes that we can look for
         owner = vol.metadata.get("cinder.csi.openstack.org/cluster")
@@ -162,7 +158,6 @@ async def purge_openstack_resources(
     logger, clouds, cloud_name, cacert, name, include_volumes, include_appcred
 ):
     """Cleans up the OpenStack resources created by the OCCM and CSI for a cluster."""
-
     # Use the credential to delete external resources as required
     async with openstack.Cloud.from_clouds(clouds, cloud_name, cacert) as cloud:
         if not cloud.is_authenticated:
@@ -360,7 +355,6 @@ async def _on_openstackcluster_event_impl(
     name, namespace, meta, labels, spec, logger, **kwargs
 ):
     """Executes whenever an event occurs for an OpenStack cluster."""
-
     # Get the resource for manipulating OpenStackClusters at the preferred version
     openstackclusters = await _get_os_cluster_client()
 
@@ -375,7 +369,10 @@ async def _on_openstackcluster_event_impl(
     if not meta.get("deletionTimestamp"):
         if FINALIZER not in finalizers:
             await patch_finalizers(
-                openstackclusters, name, namespace, finalizers + [FINALIZER]
+                openstackclusters,
+                name,
+                namespace,
+                [*finalizers, FINALIZER],
             )
             logger.info("added janitor finalizer to cluster")
         return

capi_janitor/tests/openstack/test_operator.py

@@ -1,13 +1,12 @@
 import base64
 import unittest
 from unittest import mock
-import yaml
 
 import easykube
 import httpx
+import yaml
 
-from capi_janitor.openstack import openstack
-from capi_janitor.openstack import operator
+from capi_janitor.openstack import openstack, operator
 from capi_janitor.openstack.operator import OPENSTACK_USER_VOLUMES_RECLAIM_PROPERTY
 
 

pyproject.toml

@@ -1,43 +1,40 @@
 [tool.ruff]
-# Match Black's style
 line-length = 88
-target-version = "py312"  # adjust to your minimum supported Python version
+target-version = "py312"
 
-# Match Flake8/hacking exclude patterns
-exclude = [
-  ".venv",
-  ".git",
-  ".tox",
-  "dist",
-  "doc",
-  "build",
-  "*egg",
-  "*lib/python*"
-]
-
-# For OpenStack/_-based i18n
-builtins = ["_"]
-
-# Optional: format with Ruff (in place of Black)
 [tool.ruff.format]
-quote-style = "double"
-indent-style = "space"
-line-ending = "auto"
+line-ending = "lf"
 
 [tool.ruff.lint]
 select = [
     # pycodestyle
     "E",
     # Pyflakes
     "F",
+    # flake8-builtins
+    "A",
+    # Ruff rules
+    "RUF",
     # flake8-async
     "ASYNC",
     # pyupgrade
     "UP",
+    # tidy imports
+    "TID",
+    # sorted imports
+    "I",
+    # check complexity
+    "C90",
+    # pep8 naming
+    "N",
 ]
 
 [tool.mypy]
 follow_imports = "silent"
 warn_redundant_casts = true
 warn_unused_ignores = true
 check_untyped_defs = true
+
+[tool.ruff.lint.mccabe]
+# Flag errors (`C901`) whenever the complexity level exceeds 5.
+max-complexity = 14

test-requirements.txt

@@ -1,9 +1,8 @@
-hacking>=6.1.0,<7.1 # Apache-2.0
-
 ruff~=0.11.9
 coverage>=4.0,!=4.4 # Apache-2.0
 stestr>=4.2.0 # Apache-2.0
 codespell
 types-PyYAML
 types-setuptools
 mypy
+black~=25.1.0

tox.ini

@@ -1,6 +1,8 @@
 [tox]
 minversion = 4.0.0
-envlist = py3,ruff,codespell,pep8,mypy
+# We run autofix last, to ensure CI fails,
+# even though we do our best to autofix locally
+envlist = py3,ruff,black,codespell,mypy,autofix
 skipsdist = True
 
 [testenv]
@@ -15,11 +17,17 @@ deps = -r{toxinidir}/requirements.txt
        -r{toxinidir}/test-requirements.txt
 commands = stestr run {posargs}
 
-[testenv:pep8]
+[testenv:autofix]
 commands =
+    black {tox_root}
     ruff format {tox_root}
     codespell {tox_root} -w
-    flake8 {postargs}
+    ruff check {tox_root} --fix
+
+[testenv:black]
+# TODO: understand why ruff doesn't fix
+# line lengths as well as black does
+commands = black {tox_root} --check
 
 [testenv:codespell]
 commands = codespell {posargs}
@@ -46,11 +54,3 @@ commands =
 
 [testenv:mypy]
 commands = mypy {tox_root} {posargs}
-
-[flake8]
-# select only hacking errors
-select = H
-show-source = True
-ignore = H102
-builtins = _
-exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build