Merge pull request #1737 from rackerlabs/python-tests

chore: enable additional Python code quality checks and fixes

Author: cardoe

python/cinder-understack/pyproject.toml

@@ -49,3 +49,9 @@ filterwarnings = "ignore::DeprecationWarning"
 # use our default and override anything we need specifically
 extend = "../pyproject.toml"
 target-version = "py312"
+
+[tool.ruff.lint.per-file-ignores]
+"cinder_understack/tests/*.py" = [
+    "S101",     # allow 'assert' for pytest
+    "PT009",    # OpenStack TestCase base class uses unittest-style assertions
+]

python/ironic-understack/ironic_understack/inspect_hook_update_baremetal_ports.py

@@ -1,5 +1,6 @@
 import re
 from typing import Any
+from typing import ClassVar
 
 from ironic import objects
 from ironic.common import exception
@@ -19,7 +20,7 @@ class InspectHookUpdateBaremetalPorts(base.InspectionHook):
 
     # "validate-interfaces" provides the all_interfaces field in plugin_data.
     # "parse-lldp" provides the parsed_lldp field in plugin_data.
-    dependencies = ["validate-interfaces", "parse-lldp"]
+    dependencies: ClassVar[list[str]] = ["validate-interfaces", "parse-lldp"]
 
     def __call__(self, task, inventory, plugin_data):
         """Update Ports' local_link_info and physnet based on LLDP data.

python/ironic-understack/ironic_understack/port_bios_name_hook.py

@@ -1,3 +1,5 @@
+from typing import ClassVar
+
 from ironic.drivers.modules.inspector.hooks import base
 from oslo_log import log as logging
 
@@ -22,7 +24,7 @@ class PortBiosNameHook(base.InspectionHook):
 
     # "ports" hook creates baremetal ports for each physical NIC, be sure to run
     # this first because we will only be updating ports that already exist:
-    dependencies = ["ports"]
+    dependencies: ClassVar[list[str]] = ["ports"]
 
     def __call__(self, task, inventory, plugin_data):
         """Populate the baremetal_port.extra.bios_name attribute."""

python/ironic-understack/ironic_understack/redfish_inspect_understack.py

@@ -105,7 +105,7 @@ def inspect_hardware(self, task):
             LOG.warning("No resource class matched for %s", task.node.uuid)
             return upstream_state
 
-        device_type, resource_class = match_result
+        _device_type, resource_class = match_result
         LOG.info("Matched %s to resource class %s", task.node.uuid, resource_class.name)
 
         task.node.resource_class = resource_class.name

python/ironic-understack/ironic_understack/resource_class.py

@@ -84,5 +84,5 @@ def classify(self, machine):
         if not match_result:
             raise NoMatchError(f"No resource class found for {machine}")
         else:
-            device_type, resource_class = match_result
+            _device_type, resource_class = match_result
             return resource_class.name

python/ironic-understack/ironic_understack/tests/test_portgroup_name_middleware.py

@@ -73,11 +73,11 @@ def test_invalid_number_above_range(self):
         assert str(PORT_CHANNEL_MAX) in error
 
     def test_invalid_number_zero(self):
-        is_valid, error = validate_portgroup_name("node01-port-channel0")
+        is_valid, _ = validate_portgroup_name("node01-port-channel0")
         assert is_valid is False
 
     def test_invalid_number_very_large(self):
-        is_valid, error = validate_portgroup_name("node01-port-channel99999")
+        is_valid, _ = validate_portgroup_name("node01-port-channel99999")
         assert is_valid is False
 
 

python/ironic-understack/ironic_understack/tests/test_vlan_group_name_convention.py

@@ -87,13 +87,13 @@ def test_vlan_group_name_invalid_format():
 
 
 def test_vlan_group_name_unknown_suffix():
-    with pytest.raises(TopologyError, match="suffix a1-1-99.abc1 is not present"):
+    with pytest.raises(TopologyError, match=r"suffix a1-1-99\.abc1 is not present"):
         vlan_group_names([port("a1-1-99.abc1")], mapping)
 
-    with pytest.raises(TopologyError, match="suffix a1-1-5f.abc1 is not present"):
+    with pytest.raises(TopologyError, match=r"suffix a1-1-5f\.abc1 is not present"):
         vlan_group_names([port("a1-1-5f.abc1")], mapping)
 
-    with pytest.raises(TopologyError, match="suffix a1-1-xyz.abc1 is not present"):
+    with pytest.raises(TopologyError, match=r"suffix a1-1-xyz\.abc1 is not present"):
         vlan_group_names([port("a1-1-xyz.abc1")], mapping)
 
 

python/neutron-understack/neutron_understack/routers.py

@@ -78,10 +78,7 @@ def is_only_router_port_on_network(
     )
 
     LOG.debug("Router ports found: %(ports)s", {"ports": other_router_ports})
-    if len(other_router_ports) > 1:
-        return False
-    else:
-        return True
+    return not len(other_router_ports) > 1
 
 
 def add_subport_to_trunk(shared_port: PortDict, segment: NetworkSegmentDict) -> None:
@@ -138,7 +135,7 @@ def fetch_or_create_router_segment(context: PortContext) -> NetworkSegmentDict:
 
 def ovn_client() -> OVNClient | None:
     """Retrieve the OVN client from the OVN ML2 plugin."""
-    global _cached_ovn_client
+    global _cached_ovn_client  # noqa: PLW0603
     if _cached_ovn_client:
         return _cached_ovn_client
 

python/neutron-understack/neutron_understack/tests/conftest.py

@@ -103,7 +103,7 @@ def network(project_id, network_id) -> Network:
 
 
 @pytest.fixture
-def patch_extend_subnet(mocker) -> None:
+def _patch_extend_subnet(mocker) -> None:
     """Ml2 Plugin extend subnet patch.
 
     This patch is needed as the Ml2Plugin's _make_subnet_dict method is calling
@@ -119,7 +119,7 @@ def patch_extend_subnet(mocker) -> None:
 
 
 @pytest.fixture
-def ml2_plugin(patch_extend_subnet) -> Ml2PluginNoInit:
+def ml2_plugin(_patch_extend_subnet) -> Ml2PluginNoInit:
     return Ml2PluginNoInit()
 
 
@@ -291,7 +291,7 @@ def understack_trunk_driver(understack_driver) -> UnderStackTrunkDriver:
 
 
 @pytest.fixture
-def ironic_baremetal_port_physical_network(mocker, understack_driver) -> None:
+def _ironic_baremetal_port_physical_network(mocker, understack_driver) -> None:
     mocker.patch.object(
         understack_driver.ironic_client,
         "baremetal_port_physical_network",
@@ -300,12 +300,12 @@ def ironic_baremetal_port_physical_network(mocker, understack_driver) -> None:
 
 
 @pytest.fixture(autouse=True)
-def undersync_sync_devices_patch(mocker, understack_driver) -> None:
+def _undersync_sync_devices_patch(mocker, understack_driver) -> None:
     mocker.patch.object(understack_driver.undersync, "sync_devices")
 
 
 @pytest.fixture
-def utils_fetch_subport_network_id_patch(mocker, network_id) -> None:
+def _utils_fetch_subport_network_id_patch(mocker, network_id) -> None:
     mocker.patch(
         "neutron_understack.utils.fetch_subport_network_id",
         return_value=str(network_id),
@@ -354,7 +354,7 @@ def oslo_config():
 
 
 @pytest.fixture
-def ml2_understack_conf(oslo_config, ucvni_group_id) -> None:
+def _ml2_understack_conf(oslo_config, ucvni_group_id) -> None:
     oslo_config.config(
         ucvni_group=str(ucvni_group_id),
         group="ml2_understack",

python/neutron-understack/neutron_understack/tests/test_neutron_understack_mech.py

@@ -10,7 +10,7 @@ def test_with_simple_port(self, understack_driver, port_context):
         understack_driver.undersync.sync_devices.assert_called_once()
 
 
-@pytest.mark.usefixtures("ironic_baremetal_port_physical_network")
+@pytest.mark.usefixtures("_ironic_baremetal_port_physical_network")
 class TestBindPort:
     def test_with_no_trunk(
         self,
@@ -44,7 +44,7 @@ def test_with_trunk_details(
 
 
 class TestCreateNetworkPostCommit:
-    @pytest.mark.usefixtures("ml2_understack_conf")
+    @pytest.mark.usefixtures("_ml2_understack_conf")
     def test_vxlan_network(
         self,
         mocker,