Remove S101 Ruff Rule in tests (#29)

* Ignore: S101 ruff rule in tests

* Remove: unused variable

* Apply: ruff check

Author: paikend

pyproject.toml

@@ -39,7 +39,6 @@ python_functions = ["test_*"]
 [tool.ruff]
 line-length = 79
 exclude = [
-    "tests",
     "docs",
 ]
 
@@ -57,5 +56,10 @@ ignore = ["C901", "E501"]
 lines-after-imports = 2
 no-sections = true
 
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+    "S101",
+]
+
 [tool.ruff.lint.pydocstyle]
 convention = "google"

src/openstack_mcp_server/tools/__init__.py

@@ -6,8 +6,8 @@ def register_tool(mcp: FastMCP):
     Register Openstack MCP tools.
     """
     from .glance_tools import GlanceTools
-    from .nova_tools import NovaTools
     from .keystone_tools import KeystoneTools
+    from .nova_tools import NovaTools
 
     NovaTools().register_tools(mcp)
     GlanceTools().register_tools(mcp)

src/openstack_mcp_server/tools/keystone_tools.py

@@ -1,13 +1,15 @@
+from .base import get_openstack_conn
 from fastmcp import FastMCP
 from pydantic import BaseModel
-from .base import get_openstack_conn
+
 
 # NOTE: In openstacksdk, all of the fields are optional.
 # In this case, we are only using description field as optional.
 class Region(BaseModel):
     id: str
     description: str | None = None
 
+
 class KeystoneTools:
     """
     A class to encapsulate Keystone-related tools and utilities.
@@ -24,29 +26,30 @@ def register_tools(self, mcp: FastMCP):
     def get_regions(self) -> list[Region]:
         """
         Get the list of Keystone regions.
-        
+
         :return: A list of Region objects representing the regions.
         """
         conn = get_openstack_conn()
 
         region_list = []
         for region in conn.identity.regions():
-            region_list.append(Region(id=region.id, description=region.description))
-            
+            region_list.append(
+                Region(id=region.id, description=region.description)
+            )
+
         return region_list
-    
+
     def create_region(self, id: str, description: str | None = None) -> Region:
         """
         Create a new region.
-        
+
         :param id: The ID of the region.
         :param description: The description of the region. It can be None.
-        
+
         :return: The created Region object.
         """
         conn = get_openstack_conn()
 
         region = conn.identity.create_region(id=id, description=description)
 
         return Region(id=region.id, description=region.description)
-    

tests/conftest.py

@@ -10,7 +10,7 @@ def mock_get_openstack_conn():
     with patch(
         "openstack_mcp_server.tools.nova_tools.get_openstack_conn",
         return_value=mock_conn
-    ) as mock_func:
+    ):
         yield mock_conn
 
 
@@ -22,7 +22,7 @@ def mock_get_openstack_conn_glance():
     with patch(
         "openstack_mcp_server.tools.glance_tools.get_openstack_conn",
         return_value=mock_conn
-    ) as mock_func:
+    ):
         yield mock_conn
 
 @pytest.fixture
@@ -33,7 +33,7 @@ def mock_get_openstack_conn_keystone():
     with patch(
         "openstack_mcp_server.tools.keystone_tools.get_openstack_conn",
         return_value=mock_conn
-    ) as mock_func:
+    ):
         yield mock_conn
 
 @pytest.fixture
@@ -44,5 +44,5 @@ def mock_openstack_base():
     with patch(
         "openstack_mcp_server.tools.base.get_openstack_conn",
         return_value=mock_conn
-    ) as mock_func:
+    ):
         yield mock_conn

tests/tools/test_glance_tools.py

@@ -1,6 +1,5 @@
-import pytest
-from unittest.mock import Mock
 from openstack_mcp_server.tools.glance_tools import GlanceTools
+from unittest.mock import Mock
 
 
 class TestGlanceTools:
@@ -38,7 +37,9 @@ def test_get_glance_images_success(self, mock_get_openstack_conn_glance):
         # Verify mock calls
         mock_conn.image.images.assert_called_once()
 
-    def test_get_glance_images_empty_list(self, mock_get_openstack_conn_glance):
+    def test_get_glance_images_empty_list(
+        self, mock_get_openstack_conn_glance
+    ):
         """Test getting glance images when no images exist."""
         mock_conn = mock_get_openstack_conn_glance
 
@@ -53,7 +54,9 @@ def test_get_glance_images_empty_list(self, mock_get_openstack_conn_glance):
 
         mock_conn.image.images.assert_called_once()
 
-    def test_get_glance_images_with_empty_name(self, mock_get_openstack_conn_glance):
+    def test_get_glance_images_with_empty_name(
+        self, mock_get_openstack_conn_glance
+    ):
         """Test images with empty or None names."""
         mock_conn = mock_get_openstack_conn_glance
 
@@ -76,4 +79,4 @@ def test_get_glance_images_with_empty_name(self, mock_get_openstack_conn_glance)
         assert "normal-image (img-normal) - Status: active" in result
         assert " (img-empty-name) - Status: active" in result  # Empty name
 
-        mock_conn.image.images.assert_called_once()
+        mock_conn.image.images.assert_called_once()

tests/tools/test_keystone_tools.py

@@ -1,19 +1,20 @@
 import pytest
-from unittest.mock import Mock
 from openstack import exceptions
 from openstack_mcp_server.tools.keystone_tools import KeystoneTools, Region
+from unittest.mock import Mock
+
 
 class TestKeystoneTools:
     """Test cases for KeystoneTools class."""
 
     def get_keystone_tools(self) -> KeystoneTools:
         """Get an instance of KeystoneTools."""
         return KeystoneTools()
-    
+
     def test_get_regions_success(self, mock_get_openstack_conn_keystone):
         """Test getting keystone regions successfully."""
         mock_conn = mock_get_openstack_conn_keystone
-        
+
         # Create mock region objects
         mock_region1 = Mock()
         mock_region1.id = "RegionOne"
@@ -22,32 +23,34 @@ def test_get_regions_success(self, mock_get_openstack_conn_keystone):
         mock_region2 = Mock()
         mock_region2.id = "RegionTwo"
         mock_region2.description = "Region Two description"
-        
+
         # Configure mock region.regions()
         mock_conn.identity.regions.return_value = [mock_region1, mock_region2]
 
         # Test get_regions()
         keystone_tools = self.get_keystone_tools()
         result = keystone_tools.get_regions()
-        
+
         # Verify results
-        assert result == [Region(id="RegionOne", description="Region One description"),
-                          Region(id="RegionTwo", description="Region Two description")]
+        assert result == [
+            Region(id="RegionOne", description="Region One description"),
+            Region(id="RegionTwo", description="Region Two description"),
+        ]
 
         # Verify mock calls
         mock_conn.identity.regions.assert_called_once()
 
     def test_get_regions_empty_list(self, mock_get_openstack_conn_keystone):
         """Test getting keystone regions when there are no regions."""
         mock_conn = mock_get_openstack_conn_keystone
-        
+
         # Empty region list
         mock_conn.identity.regions.return_value = []
-        
+
         # Test get_regions()
         keystone_tools = self.get_keystone_tools()
         result = keystone_tools.get_regions()
-        
+
         # Verify results
         assert result == []
 
@@ -57,7 +60,7 @@ def test_get_regions_empty_list(self, mock_get_openstack_conn_keystone):
     def test_create_region_success(self, mock_get_openstack_conn_keystone):
         """Test creating a keystone region successfully."""
         mock_conn = mock_get_openstack_conn_keystone
-        
+
         # Create mock region object
         mock_region = Mock()
         mock_region.id = "RegionOne"
@@ -68,15 +71,23 @@ def test_create_region_success(self, mock_get_openstack_conn_keystone):
 
         # Test create_region()
         keystone_tools = self.get_keystone_tools()
-        result = keystone_tools.create_region(id="RegionOne", description="Region One description")
-        
+        result = keystone_tools.create_region(
+            id="RegionOne", description="Region One description"
+        )
+
         # Verify results
-        assert result == Region(id="RegionOne", description="Region One description")
+        assert result == Region(
+            id="RegionOne", description="Region One description"
+        )
 
         # Verify mock calls
-        mock_conn.identity.create_region.assert_called_once_with(id="RegionOne", description="Region One description")
-    
-    def test_create_region_without_description(self, mock_get_openstack_conn_keystone):
+        mock_conn.identity.create_region.assert_called_once_with(
+            id="RegionOne", description="Region One description"
+        )
+
+    def test_create_region_without_description(
+        self, mock_get_openstack_conn_keystone
+    ):
         """Test creating a keystone region without a description."""
         mock_conn = mock_get_openstack_conn_keystone
 
@@ -95,22 +106,32 @@ def test_create_region_without_description(self, mock_get_openstack_conn_keyston
         # Verify results
         assert result == Region(id="RegionOne")
 
-    def test_create_region_invalid_id_format(self, mock_get_openstack_conn_keystone):
+    def test_create_region_invalid_id_format(
+        self, mock_get_openstack_conn_keystone
+    ):
         """Test creating a keystone region with an invalid ID format."""
         mock_conn = mock_get_openstack_conn_keystone
 
         # Configure mock region.create_region() to raise an exception
-        mock_conn.identity.create_region.side_effect = exceptions.BadRequestException(
-            "Invalid input for field 'id': Expected string, got integer"
+        mock_conn.identity.create_region.side_effect = (
+            exceptions.BadRequestException(
+                "Invalid input for field 'id': Expected string, got integer"
+            )
         )
 
         # Test create_region()
         keystone_tools = self.get_keystone_tools()
 
         # Verify results
-        with pytest.raises(exceptions.BadRequestException, match="Invalid input for field 'id': Expected string, got integer"):
-            keystone_tools.create_region(id=1, description="Region One description")
+        with pytest.raises(
+            exceptions.BadRequestException,
+            match="Invalid input for field 'id': Expected string, got integer",
+        ):
+            keystone_tools.create_region(
+                id=1, description="Region One description"
+            )
 
         # Verify mock calls
-        mock_conn.identity.create_region.assert_called_once_with(id=1, description="Region One description") 
-    
+        mock_conn.identity.create_region.assert_called_once_with(
+            id=1, description="Region One description"
+        )