feat: Add region tools (#28)

* feat(keystone): Add delete_region tool(#14)

- Add delete_region tool
- Updated tests are passing

* feat(keystone): Add delete_region tool(#14)

- Add delete_region tool
- Updated tests are passing

* feat(keystone): Add update_region tool(#14)

- Add update_region tool
- Updated tests are passing

* fix(keystone): Change delete_region return type(#21)

- Change delete region return type: str -> None

* feat(keystone): Add get_region tool(#14)

- Add get_region tool
- Updated tests are passing

* feat(keystone): Add get_region tool(#14)

- Register tool

* feat(keystone): Move Region response to /response(#14)

* fix(keystone): Delete unnecessary comments(#14)

- Delete unnecessary comments: It could be None.
- Change delete_region return value comments: None

Author: S0okJu

src/openstack_mcp_server/tools/keystone_tools.py

@@ -1,13 +1,6 @@
 from .base import get_openstack_conn
+from .response.keystone import Region
 from fastmcp import FastMCP
-from pydantic import BaseModel
-
-
-# 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:
@@ -21,7 +14,10 @@ def register_tools(self, mcp: FastMCP):
         """
 
         mcp.tool()(self.get_regions)
+        mcp.tool()(self.get_region)
         mcp.tool()(self.create_region)
+        mcp.tool()(self.delete_region)
+        mcp.tool()(self.update_region)
 
     def get_regions(self) -> list[Region]:
         """
@@ -39,12 +35,26 @@ def get_regions(self) -> list[Region]:
 
         return region_list
 
-    def create_region(self, id: str, description: str | None = None) -> Region:
+    def get_region(self, id: str) -> Region:
+        """
+        Get a region.
+
+        :param id: The ID of the region. (required)
+
+        :return: The Region object.
+        """
+        conn = get_openstack_conn()
+
+        region = conn.identity.get_region(region=id)
+
+        return Region(id=region.id, description=region.description)
+
+    def create_region(self, id: str, description: str = "") -> Region:
         """
         Create a new region.
 
-        :param id: The ID of the region.
-        :param description: The description of the region. It can be None.
+        :param id: The ID of the region. (required)
+        :param description: The description of the region. (optional)
 
         :return: The created Region object.
         """
@@ -53,3 +63,37 @@ def create_region(self, id: str, description: str | None = None) -> Region:
         region = conn.identity.create_region(id=id, description=description)
 
         return Region(id=region.id, description=region.description)
+
+    def delete_region(self, id: str) -> None:
+        """
+        Delete a region.
+
+        :param id: The ID of the region. (required)
+
+        :return: None
+        """
+        conn = get_openstack_conn()
+
+        # ignore_missing is set to False to raise an exception if the region does not exist.
+        conn.identity.delete_region(region=id, ignore_missing=False)
+
+        return None
+
+    def update_region(self, id: str, description: str = "") -> Region:
+        """
+        Update a region.
+
+        :param id: The ID of the region. (required)
+        :param description: The string description of the region. (optional)
+
+        :return: The updated Region object.
+        """
+        conn = get_openstack_conn()
+
+        updated_region = conn.identity.update_region(
+            region=id, description=description
+        )
+
+        return Region(
+            id=updated_region.id, description=updated_region.description
+        )

src/openstack_mcp_server/tools/response/keystone.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel
+
+
+# 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 = ""

tests/tools/test_keystone_tools.py

@@ -94,7 +94,7 @@ def test_create_region_without_description(
         # Create mock region object
         mock_region = Mock()
         mock_region.id = "RegionOne"
-        mock_region.description = None
+        mock_region.description = ""
 
         # Configure mock region.create_region()
         mock_conn.identity.create_region.return_value = mock_region
@@ -132,6 +132,141 @@ def test_create_region_invalid_id_format(
             )
 
         # 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") 
+    
+    def test_delete_region_success(self, mock_get_openstack_conn_keystone):
+        """Test deleting a keystone region successfully."""
+        mock_conn = mock_get_openstack_conn_keystone
+
+        # Test delete_region()
+        keystone_tools = self.get_keystone_tools()
+        result = keystone_tools.delete_region(id="RegionOne")
+        
+        # Verify results
+        assert result == None
+        
+        # Verify mock calls
+        mock_conn.identity.delete_region.assert_called_once_with(region="RegionOne", ignore_missing=False)
+    
+    def test_delete_region_not_found(self, mock_get_openstack_conn_keystone):
+        """Test deleting a keystone region that does not exist."""
+        mock_conn = mock_get_openstack_conn_keystone
+
+        # Configure mock to raise NotFoundException
+        mock_conn.identity.delete_region.side_effect = exceptions.NotFoundException(
+            "Region 'RegionOne' not found"
         )
+
+        # Test delete_region()
+        keystone_tools = self.get_keystone_tools()
+        
+        # Verify exception is raised
+        with pytest.raises(exceptions.NotFoundException, match="Region 'RegionOne' not found"):
+            keystone_tools.delete_region(id="RegionOne")
+        
+        # Verify mock calls
+        mock_conn.identity.delete_region.assert_called_once_with(region="RegionOne", ignore_missing=False)
+    
+    def test_update_region_success(self, mock_get_openstack_conn_keystone):
+        """Test updating a keystone region successfully."""
+        mock_conn = mock_get_openstack_conn_keystone
+
+        # Create mock region object
+        mock_region = Mock()
+        mock_region.id = "RegionOne"
+        mock_region.description = "Region One description"
+
+        # Configure mock region.update_region()
+        mock_conn.identity.update_region.return_value = mock_region
+
+        # Test update_region()
+        keystone_tools = self.get_keystone_tools()
+        result = keystone_tools.update_region(id="RegionOne", description="Region One description")
+        
+        # Verify results
+        assert result == Region(id="RegionOne", description="Region One description")
+        
+        # Verify mock calls
+        mock_conn.identity.update_region.assert_called_once_with(region="RegionOne", description="Region One description")
+    
+    def test_update_region_without_description(self, mock_get_openstack_conn_keystone):
+        """Test updating a keystone region without a description."""
+        mock_conn = mock_get_openstack_conn_keystone
+
+        # Create mock region object
+        mock_region = Mock()
+        mock_region.id = "RegionOne"
+        mock_region.description = ""
+
+        # Configure mock region.update_region()
+        mock_conn.identity.update_region.return_value = mock_region
+
+        # Test update_region()
+        keystone_tools = self.get_keystone_tools()
+        result = keystone_tools.update_region(id="RegionOne")
+        
+        # Verify results
+        assert result == Region(id="RegionOne")
+        
+        # Verify mock calls
+        mock_conn.identity.update_region.assert_called_once_with(region="RegionOne", description="")
+    
+    def test_update_region_invalid_id_format(self, mock_get_openstack_conn_keystone):
+        """Test updating a keystone region with an invalid ID format."""
+        mock_conn = mock_get_openstack_conn_keystone
+
+        # Configure mock region.update_region() to raise an exception
+        mock_conn.identity.update_region.side_effect = exceptions.BadRequestException(
+            "Invalid input for field 'id': Expected string, got integer"
+        )
+
+        # Test update_region()
+        keystone_tools = self.get_keystone_tools()
+
+        # Verify exception is raised
+        with pytest.raises(exceptions.BadRequestException, match="Invalid input for field 'id': Expected string, got integer"):
+            keystone_tools.update_region(id=1, description="Region One description")
+        
+        # Verify mock calls
+        mock_conn.identity.update_region.assert_called_once_with(region=1, description="Region One description")
+    
+    def test_get_region_success(self, mock_get_openstack_conn_keystone):
+        """Test getting a keystone region successfully."""
+        mock_conn = mock_get_openstack_conn_keystone
+
+        # Create mock region object
+        mock_region = Mock()
+        mock_region.id = "RegionOne"
+        mock_region.description = "Region One description"
+        
+        # Configure mock region.get_region()
+        mock_conn.identity.get_region.return_value = mock_region
+
+        # Test get_region()
+        keystone_tools = self.get_keystone_tools()
+        result = keystone_tools.get_region(id="RegionOne")
+        
+        # Verify results
+        assert result == Region(id="RegionOne", description="Region One description")
+        
+        # Verify mock calls
+        mock_conn.identity.get_region.assert_called_once_with(region="RegionOne")
+    
+    def test_get_region_not_found(self, mock_get_openstack_conn_keystone):
+        """Test getting a keystone region that does not exist."""
+        mock_conn = mock_get_openstack_conn_keystone
+
+        # Configure mock to raise NotFoundException
+        mock_conn.identity.get_region.side_effect = exceptions.NotFoundException(
+            "Region 'RegionOne' not found"
+        )
+        
+        # Test get_region()
+        keystone_tools = self.get_keystone_tools()
+        
+        # Verify exception is raised
+        with pytest.raises(exceptions.NotFoundException, match="Region 'RegionOne' not found"):
+            keystone_tools.get_region(id="RegionOne")
+        
+        # Verify mock calls
+        mock_conn.identity.get_region.assert_called_once_with(region="RegionOne")