Merge pull request #4015 from mulkieran/replace-linters-and-formatters-with-ruff

mulkieran · web-flow · commit 3d68ff7ecebe · 2026-04-29T15:13:42.000-04:00
Replace linters and formatters with ruff
diff --git a/.githooks/pre-commit b/.githooks/pre-commit
@@ -13,6 +13,4 @@ make fmt-ci &&
 	make tmtlint &&
 	make check-typos || exit 1
 
-export PYTHONPATH=$PWD/tests/client-dbus/src
-
 cd tests/client-dbus && make fmt-ci && make lint || exit 1
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -44,7 +44,6 @@ jobs:
       - name: Install dependencies for Fedora
         run: >
           dnf install -y
-          black
           clang
           curl
           cryptsetup-devel
@@ -53,7 +52,6 @@ jobs:
           libblkid-devel
           make
           ncurses
-          python3-isort
           systemd-devel
       - uses: dtolnay/rust-toolchain@master
         with:
diff --git a/.github/workflows/support.yml b/.github/workflows/support.yml
@@ -39,7 +39,6 @@ jobs:
         include:
           - dependencies: >
               libatomic
-              pylint
               python3-dbus-client-gen
               python3-dbus-python-client-gen
               python3-justbytes
@@ -48,11 +47,10 @@ jobs:
               python3-semantic_version
               python3-setuptools
               python3-tenacity
-            task: >
-              PATH=${PATH}:/github/home/.local/bin
-              PYTHONPATH=./src make -f Makefile lint
+              ruff
+            task: PATH=${PATH}:/github/home/.local/bin make -f Makefile lint
             working-directory: ./tests/client-dbus
-          - dependencies: black python3-isort
+          - dependencies: ruff
             task: make -f Makefile fmt-ci
             working-directory: ./tests/client-dbus
           - dependencies: yamllint tmt
diff --git a/tests/client-dbus/.isort.cfg b/tests/client-dbus/.isort.cfg
diff --git a/tests/client-dbus/Makefile b/tests/client-dbus/Makefile
@@ -2,8 +2,7 @@ UNITTEST_OPTS = --verbose
 
 .PHONY: lint
 lint:
-	pylint src/stratisd_client_dbus --ignore=_introspect.py
-	pylint tests --disable=R0801
+	ruff check
 	pyright
 
 .PHONY: startup-tests
@@ -20,13 +19,13 @@ extend-tests:
 
 .PHONY: fmt
 fmt:
-	isort src tests
-	black .
+	ruff check --fix --select I
+	ruff format
 
 .PHONY: fmt-ci
 fmt-ci:
-	isort --diff --check-only src tests
-	black . --check
+	ruff check --select I
+	ruff format --check
 
 .PHONY: tang-tests
 tang-tests:
diff --git a/tests/client-dbus/pyproject.toml b/tests/client-dbus/pyproject.toml
@@ -0,0 +1,13 @@
+[tool.ruff]
+target-version = "py312"
+line-length = 88
+
+[tool.ruff.lint]
+select = ["PL"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["dbus_client_gen", "dbus_python_client_gen"]
+split-on-trailing-comma = false
+
+[tool.ruff.format]
+skip-magic-trailing-comma = true
diff --git a/tests/client-dbus/src/stratisd_client_dbus/_connection.py b/tests/client-dbus/src/stratisd_client_dbus/_connection.py
@@ -26,8 +26,6 @@ class Bus:
     Our bus.
     """
 
-    # pylint: disable=too-few-public-methods
-
     _BUS = None
 
     @staticmethod
diff --git a/tests/client-dbus/tests/misc/test_predict.py b/tests/client-dbus/tests/misc/test_predict.py
@@ -58,7 +58,7 @@ def _call_predict_usage_pool(
         if command.returncode != 0:
             raise RuntimeError(
                 f"Invocation of {_STRATIS_PREDICT_USAGE} returned an error: "
-                f"{command.returncode,}, {errs}"
+                f"{command.returncode}, {errs}"
             )
         prediction = json.loads(outs)
 
@@ -112,10 +112,7 @@ def test_prediction(self):
             encrypted, device_sizes, fs_sizes=None, overprovision=overprovisioned
         )
         pool_result_post = _call_predict_usage_pool(
-            encrypted,
-            device_sizes,
-            fs_sizes=fs_sizes,
-            overprovision=overprovisioned,
+            encrypted, device_sizes, fs_sizes=fs_sizes, overprovision=overprovisioned
         )
 
         filesystem_result = _call_predict_usage_filesystem(
diff --git a/tests/client-dbus/tests/udev/_utils.py b/tests/client-dbus/tests/udev/_utils.py
@@ -73,11 +73,10 @@ def random_string(length):
     :param length: Length of random part of string
     :return: String
     """
-    return f'stratis_{"".join(random.choice(string.ascii_uppercase) for _ in range(length))}'
+    return f"stratis_{''.join(random.choice(string.ascii_uppercase) for _ in range(length))}"
 
 
-# pylint: disable=too-many-statements
-def create_pool(
+def create_pool(  # noqa: PLR0915
     name, devices, *, key_description=None, clevis_info=None, overprovision=True
 ):
     """
@@ -119,11 +118,7 @@ def create_legacy_pool():
                     else:
                         cmdline.extend(["--thumbprint", thp])
 
-            with subprocess.Popen(
-                cmdline,
-                text=True,
-                stdin=subprocess.PIPE,
-            ) as process:
+            with subprocess.Popen(cmdline, text=True, stdin=subprocess.PIPE) as process:
                 process.stdin.write(  # pyright: ignore [reportOptionalMemberAccess]
                     f"Yes{os.linesep}"
                 )
@@ -137,7 +132,7 @@ def create_legacy_pool():
             newly_created = True
 
         i = 0
-        while get_pools(name) == [] and i < 5:
+        while get_pools(name) == [] and i < 5:  # noqa PLR2004
             i += 1
             time.sleep(1)
         (pool_object_path, _) = next(iter(get_pools(name)))
@@ -165,13 +160,10 @@ def create_v2_pool():
                 dbus_slot = (True, slot)
 
             if pin == "tang":
-                (pin, config) = (
-                    "tang",
-                    json.dumps(
-                        {"url": tang_url, "stratis:tang:trust_url": True}
-                        if thp is None
-                        else {"url": tang_url, "thp": thp}
-                    ),
+                config = json.dumps(
+                    {"url": tang_url, "stratis:tang:trust_url": True}
+                    if thp is None
+                    else {"url": tang_url, "thp": thp}
                 )
             else:
                 raise RuntimeError(
@@ -350,8 +342,8 @@ def wait_for_udev(fs_type, expected_paths):
 
     except RetryError as err:
         raise RuntimeError(
-            f'Found unexpected devnodes: expected devnodes: {", ".join(expected_devnodes)} '
-            f'!= found_devnodes: {", ".join(err.last_attempt.result())}'
+            f"Found unexpected devnodes: expected devnodes: {', '.join(expected_devnodes)} "
+            f"!= found_devnodes: {', '.join(err.last_attempt.result())}"
         ) from err
 
 
@@ -389,9 +381,8 @@ def start_service(self):
         if next(processes("stratisd"), None) is not None:
             raise RuntimeError("A stratisd process is already running")
 
-        service = subprocess.Popen(  # pylint: disable=consider-using-with
-            [x for x in _STRATISD.split(" ") if x != ""],
-            text=True,
+        service = subprocess.Popen(
+            [x for x in _STRATISD.split(" ") if x != ""], text=True
         )
 
         try:
@@ -462,10 +453,7 @@ def __enter__(self):
                 with open(temp_file.name, "r", encoding="utf-8") as fd_for_dbus:
                     (_, return_code, message) = Manager.Methods.SetKey(
                         get_object(TOP_OBJECT),
-                        {
-                            "key_desc": key_desc,
-                            "key_fd": fd_for_dbus.fileno(),
-                        },
+                        {"key_desc": key_desc, "key_fd": fd_for_dbus.fileno()},
                     )
 
                 if return_code != StratisdErrors.OK:
diff --git a/tests/client-dbus/tests/udev/test_dump.py b/tests/client-dbus/tests/udev/test_dump.py
@@ -99,7 +99,4 @@ def test_only_pool(self):
             result = _call_stratis_dumpmetadata(
                 devnodes[2], print_bytes=True, only="pool"
             )
-            self.assertGreater(
-                len(json.loads(result)),
-                0,
-            )
+            self.assertGreater(len(json.loads(result)), 0)
diff --git a/tests/client-dbus/tests/udev/test_extend.py b/tests/client-dbus/tests/udev/test_extend.py
@@ -52,9 +52,7 @@ def test_failed_extend_regression(self):
 
             self.wait_for_pools(0)
             (_, (pool_object_path, _)) = create_pool(
-                "testpool",
-                devnodes[:2],
-                key_description=([(key_description, None)]),
+                "testpool", devnodes[:2], key_description=([(key_description, None)])
             )
             self.wait_for_pools(1)
 
diff --git a/tests/client-dbus/tests/udev/test_predict.py b/tests/client-dbus/tests/udev/test_predict.py
@@ -94,8 +94,7 @@ def _call_blockdev_size(dev):
     :rtype: str
     """
     with subprocess.Popen(
-        ["/usr/sbin/blockdev", "--getsize64", dev],
-        stdout=subprocess.PIPE,
+        ["/usr/sbin/blockdev", "--getsize64", dev], stdout=subprocess.PIPE
     ) as command:
         outs, _ = command.communicate()
 
@@ -121,11 +120,7 @@ def _possibly_add_filesystems(pool_object_path, *, fs_specs=None):
         if not real:
             raise RuntimeError("Failed to get pool usage before creating filesystems.")
 
-        (
-            _,
-            return_code,
-            message,
-        ) = Pool.Methods.CreateFilesystems(
+        (_, return_code, message) = Pool.Methods.CreateFilesystems(
             pool_proxy,
             {
                 "specs": map(
@@ -214,10 +209,7 @@ def _check_prediction(self, prediction, mopool):
         if not success:
             raise RuntimeError("Pool's TotalPhysicalUsed property was invalid.")
 
-        (used_prediction, total_prediction) = (
-            prediction["used"],
-            prediction["total"],
-        )
+        (used_prediction, total_prediction) = (prediction["used"], prediction["total"])
 
         self.assertEqual(
             mopool.TotalPhysicalSize(),
diff --git a/tests/client-dbus/tests/udev/test_revert.py b/tests/client-dbus/tests/udev/test_revert.py
@@ -66,7 +66,7 @@ def read_file(self, mountdir, filename):
         with open(os.path.join(mountdir, filename), encoding="utf-8") as fd:
             self.assertEqual(fd.read(), filename)
 
-    def test_revert(self):  # pylint: disable=too-many-locals
+    def test_revert(self):
         """
         Schedule a revert and verify that it has succeeded when the pool is
         restarted.
@@ -145,11 +145,7 @@ def test_revert(self):  # pylint: disable=too-many-locals
 
             # Now stop the pool, which should tear down the devices
             (_, return_code, message) = Manager.Methods.StopPool(
-                get_object(TOP_OBJECT),
-                {
-                    "id": pool_name,
-                    "id_type": "name",
-                },
+                get_object(TOP_OBJECT), {"id": pool_name, "id_type": "name"}
             )
 
             if return_code != 0:
@@ -182,7 +178,7 @@ def test_revert(self):  # pylint: disable=too-many-locals
 
             subprocess.check_call([_UMOUNT, mountdir])
 
-    def test_revert_snapshot_chain(self):  # pylint: disable=too-many-locals
+    def test_revert_snapshot_chain(self):
         """
         Make a chain of snapshots, schedule excess reverts and verify that
         those yield an error, and then revert the middle link.
@@ -266,11 +262,7 @@ def test_revert_snapshot_chain(self):  # pylint: disable=too-many-locals
 
             # Now stop the pool, which should tear down the devices
             (_, return_code, message) = Manager.Methods.StopPool(
-                get_object(TOP_OBJECT),
-                {
-                    "id": pool_name,
-                    "id_type": "name",
-                },
+                get_object(TOP_OBJECT), {"id": pool_name, "id_type": "name"}
             )
 
             if return_code != 0:
diff --git a/tests/client-dbus/tests/udev/test_start.py b/tests/client-dbus/tests/udev/test_start.py
@@ -55,9 +55,7 @@ def test_failed_start_regression(self):
 
             self.wait_for_pools(0)
             (_, (pool_object_path, _)) = create_pool(
-                "testpool",
-                devnodes[:2],
-                key_description=([(key_description, None)]),
+                "testpool", devnodes[:2], key_description=([(key_description, None)])
             )
             self.wait_for_pools(1)
 
@@ -67,20 +65,13 @@ def test_failed_start_regression(self):
             self.assertEqual(rc, StratisdErrors.OK, msg=message)
 
             ((b, _), rc, message) = Manager.Methods.StopPool(
-                get_object(TOP_OBJECT),
-                {
-                    "id": "testpool",
-                    "id_type": "name",
-                },
+                get_object(TOP_OBJECT), {"id": "testpool", "id_type": "name"}
             )
             self.assertEqual(b, True)
             self.assertEqual(rc, StratisdErrors.OK, msg=message)
 
             (_, rc, message) = Manager.Methods.UnsetKey(
-                get_object(TOP_OBJECT),
-                {
-                    "key_desc": "testkey",
-                },
+                get_object(TOP_OBJECT), {"key_desc": "testkey"}
             )
             self.assertEqual(rc, StratisdErrors.OK, msg=message)
 
@@ -99,11 +90,7 @@ def test_failed_start_regression(self):
             (out_side, in_side) = os.pipe()
             os.write(in_side, b"testkey")
             (_, rc, message) = Manager.Methods.SetKey(
-                get_object(TOP_OBJECT),
-                {
-                    "key_desc": "testkey",
-                    "key_fd": out_side,
-                },
+                get_object(TOP_OBJECT), {"key_desc": "testkey", "key_fd": out_side}
             )
             self.assertEqual(rc, StratisdErrors.OK, msg=message)
 
@@ -148,11 +135,7 @@ def cache_removal(self, key_spec=None):
             assert bool(Pool.Properties.HasCache.Get(get_object(pool_object_path)))
 
             ((b, _), rc, message) = Manager.Methods.StopPool(
-                get_object(TOP_OBJECT),
-                {
-                    "id": "testpool",
-                    "id_type": "name",
-                },
+                get_object(TOP_OBJECT), {"id": "testpool", "id_type": "name"}
             )
             self.assertEqual(b, True)
             self.assertEqual(rc, StratisdErrors.OK, msg=message)
diff --git a/tests/client-dbus/tests/udev/test_startup.py b/tests/client-dbus/tests/udev/test_startup.py
@@ -48,11 +48,7 @@ def test_unique_instance(self):
             env = dict(os.environ)
             env["RUST_LOG"] = env.get("RUST_LOG", "") + ",nix::fcntl=debug"
             with subprocess.Popen(
-                [STRATISD],
-                stderr=subprocess.STDOUT,
-                text=True,
-                close_fds=True,
-                env=env,
+                [STRATISD], stderr=subprocess.STDOUT, text=True, close_fds=True, env=env
             ) as process:
                 (_, _) = process.communicate()
                 self.assertEqual(process.returncode, 1)
diff --git a/tests/client-dbus/tests/udev/test_udev.py b/tests/client-dbus/tests/udev/test_udev.py

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ def _call_predict_usage_pool(`
`58`	`58`	`if command.returncode != 0:`
`59`	`59`	`raise RuntimeError(`
`60`	`60`	`f"Invocation of {_STRATIS_PREDICT_USAGE} returned an error: "`
`61`		`- f"{command.returncode,}, {errs}"`
	`61`	`+ f"{command.returncode}, {errs}"`
`62`	`62`	`)`
`63`	`63`	`prediction = json.loads(outs)`
`64`	`64`
`@@ -112,10 +112,7 @@ def test_prediction(self):`
`112`	`112`	`encrypted, device_sizes, fs_sizes=None, overprovision=overprovisioned`
`113`	`113`	`)`
`114`	`114`	`pool_result_post = _call_predict_usage_pool(`
`115`		`- encrypted,`
`116`		`- device_sizes,`
`117`		`- fs_sizes=fs_sizes,`
`118`		`- overprovision=overprovisioned,`
	`115`	`+ encrypted, device_sizes, fs_sizes=fs_sizes, overprovision=overprovisioned`
`119`	`116`	`)`
`120`	`117`
`121`	`118`	`filesystem_result = _call_predict_usage_filesystem(`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,4 @@ def test_only_pool(self):`
`99`	`99`	`result = _call_stratis_dumpmetadata(`
`100`	`100`	`devnodes[2], print_bytes=True, only="pool"`
`101`	`101`	`)`
`102`		`- self.assertGreater(`
`103`		`- len(json.loads(result)),`
`104`		`- 0,`
`105`		`- )`
	`102`	`+ self.assertGreater(len(json.loads(result)), 0)`