feat: Add get regions and create region tool (#18)

* feat(keystone): implement get-regions tool (#14)

- Add get_regions tool
- Add get_regions test code

Author: S0okJu

src/openstack_mcp_server/tools/__init__.py

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

src/openstack_mcp_server/tools/keystone_tools.py

@@ -0,0 +1,52 @@
+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.
+    """
+
+    def register_tools(self, mcp: FastMCP):
+        """
+        Register Keystone-related tools with the FastMCP instance.
+        """
+
+        mcp.tool()(self.get_regions)
+        mcp.tool()(self.create_region)
+
+    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))
+            
+        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

@@ -25,6 +25,16 @@ def mock_get_openstack_conn_glance():
     ) as mock_func:
         yield mock_conn
 
+@pytest.fixture
+def mock_get_openstack_conn_keystone():
+    """Mock get_openstack_conn function for keystone_tools."""
+    mock_conn = Mock()
+    
+    with patch(
+        "openstack_mcp_server.tools.keystone_tools.get_openstack_conn",
+        return_value=mock_conn
+    ) as mock_func:
+        yield mock_conn
 
 @pytest.fixture
 def mock_openstack_base():

tests/tools/test_keystone_tools.py

@@ -0,0 +1,116 @@
+import pytest
+from unittest.mock import Mock
+from openstack import exceptions
+from openstack_mcp_server.tools.keystone_tools import KeystoneTools, Region
+
+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"
+        mock_region1.description = "Region One description"
+
+        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")]
+
+        # 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 == []
+
+        # Verify mock calls
+        mock_conn.identity.regions.assert_called_once()
+
+    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"
+        mock_region.description = "Region One description"
+
+        # Configure mock region.create_region()
+        mock_conn.identity.create_region.return_value = mock_region
+
+        # Test create_region()
+        keystone_tools = self.get_keystone_tools()
+        result = keystone_tools.create_region(id="RegionOne", description="Region One description")
+        
+        # Verify results
+        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):
+        """Test creating 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 = None
+
+        # Configure mock region.create_region()
+        mock_conn.identity.create_region.return_value = mock_region
+
+        # Test create_region()
+        keystone_tools = self.get_keystone_tools()
+        result = keystone_tools.create_region(id="RegionOne")
+
+        # Verify results
+        assert result == Region(id="RegionOne")
+
+    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"
+        )
+
+        # 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")
+
+        # Verify mock calls
+        mock_conn.identity.create_region.assert_called_once_with(id=1, description="Region One description") 
+