Added tests and Cursor install instuctions

dlrust · dlrust · commit 1f268f0aa071 · 2025-03-17T15:47:49.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,6 @@ wheels/
 
 # Virtual environments
 .venv
+
+# IDEs
+.cursor
diff --git a/README.md b/README.md
@@ -30,6 +30,12 @@ To use this server with the [Claude Desktop app](https://claude.ai/download), ad
 
 After updating the config, restart Claude Desktop.
 
+## Manual configuration for Cursor
+
+This MCP can also be used in cursor with a similar configuration from above added to your [Cursor](https://www.cursor.com/) global environment or to individual projects.
+
+Examples [here](https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers)
+
 ## Local development
 
 ### Clone the repo (or your fork)
@@ -103,4 +109,32 @@ This MCP provides the following tools for interacting with DevHub CMS:
 
 ## Usage with LLMs
 
-This MCP is designed to be used with Large Language Models that support the Model Context Protocol. It allows LLMs to manage content in DevHub CMS without needing direct API access integrated into the LLM natively.
+This MCP is designed to be used with Large Language Models that support the Model Context Protocol. It allows LLMs to manage content in DevHub CMS without needing direct API access integrated into the LLM natively.
+
+## Testing
+
+This package includes a test suite with mocked requests to the DevHub API, allowing you to test the functionality without making actual API calls.
+
+### Running Tests
+
+To run the tests, first install the package with test dependencies:
+
+```bash
+uv pip install -e ".[test]"
+```
+
+Run the tests with pytest:
+
+```bash
+pytest
+```
+
+For more detailed output and test coverage information:
+
+```bash
+pytest -v --cov=devhub_cms_mcp
+```
+
+### Test Structure
+
+- `tests/devhub_cms_mcp/test_mcp_integration.py`: Tests for MCP integration endpoints
diff --git a/pyproject.toml b/pyproject.toml
@@ -9,6 +9,13 @@ dependencies = [
     "requests-oauthlib>=2.0.0",
 ]
 
+[project.optional-dependencies]
+test = [
+    "pytest>=7.0.0",
+    "pytest-mock>=3.10.0",
+    "pytest-cov>=4.1.0",
+]
+
 [build-system]
 requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"
@@ -18,3 +25,8 @@ devhub-cms-mcp = "devhub_cms_mcp.server:main"
 
 [tool.setuptools]
 package-dir = {"" = "src"}
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+python_functions = "test_*"
diff --git a/src/devhub_cms_mcp/server.py b/src/devhub_cms_mcp/server.py
@@ -10,10 +10,14 @@
     "DevHub CMS MCP",
     description="Integration with DevHub CMS to manage content")
 
-devhub_api = OAuth1Session(
-    os.environ['DEVHUB_API_KEY'],
-    client_secret=os.environ['DEVHUB_API_SECRET'])
-base_url = '{}/api/v2/'.format(os.environ['DEVHUB_BASE_URL'])
+
+def get_client():
+    """Get DevHub API client and base_url."""
+    client = OAuth1Session(
+        os.environ['DEVHUB_API_KEY'],
+        client_secret=os.environ['DEVHUB_API_SECRET'])
+    base_url = '{}/api/v2/'.format(os.environ['DEVHUB_BASE_URL'])
+    return client, base_url
 
 
 @mcp.tool()
@@ -35,7 +39,8 @@ def get_hours_of_operation(location_id: int, hours_type: str = 'primary') -> lis
         location_id: DevHub Location ID
         hours_type: Defaults to 'primary' unless the user specifies a different type
     """
-    r = devhub_api.get('{}locations/{}'.format(base_url, location_id))
+    client, base_url = get_client()
+    r = client.get('{}locations/{}'.format(base_url, location_id))
     content = json.loads(r.content)
     return content['hours_by_type'].get(hours_type, [])
 
@@ -60,7 +65,8 @@ def update_hours(location_id: int, new_hours: list, hours_type: str = 'primary')
         new_hours: Structured format of the new hours
         hours_type: Defaults to 'primary' unless the user specifies a different type
     """
-    r = devhub_api.put(
+    client, base_url = get_client()
+    r = client.put(
         '{}locations/{}/'.format(base_url, location_id),
         json={
             'hours': [
@@ -85,14 +91,15 @@ def upload_image(base64_image_content: str, filename: str) -> str:
         base64_image_content: Base 64 encoded content of the image file
         filename: Filename including the extension
     """
+    client, base_url = get_client()
     payload = {
         'type': 'image',
         'upload': {
             'file': base64_image_content,
             'filename': filename,
         }
     }
-    r = devhub_api.post(
+    r = client.post(
         '{}images/'.format(base_url),
         json=payload,
     )
@@ -110,7 +117,8 @@ def get_blog_post(post_id: int) -> str:
     Args:
         post_id: Blog post id
     """
-    r = devhub_api.get('{}posts/{}/'.format(base_url, post_id))
+    client, base_url = get_client()
+    r = client.get('{}posts/{}/'.format(base_url, post_id))
     post = r.json()
     return f"""
 Post ID: {post['id']}
@@ -131,11 +139,13 @@ def create_blog_post(site_id: int, title: str, content: str) -> str:
         title: Blog post title
         content: HTML content of blog post. Should not include a <h1> tag, only h2+
     """
-    payload = {}
-    payload['site_id'] = site_id
-    payload['content'] = content
-    payload['title'] = title
-    r = devhub_api.post(
+    client, base_url = get_client()
+    payload = {
+        'content': content,
+        'site_id': site_id,
+        'title': title,
+    }
+    r = client.post(
         '{}posts/'.format(base_url),
         json=payload,
     )
@@ -159,12 +169,13 @@ def update_blog_post(post_id: int, title: str = None, content: str = None) -> st
         title: Blog post title
         content: HTML content of blog post. Should not include a <h1> tag, only h2+
     """
+    client, base_url = get_client()
     payload = {}
     if content:
         payload['content'] = content
     if title:
         payload['title'] = title
-    r = devhub_api.put(
+    r = client.put(
         '{}posts/{}/'.format(base_url, post_id),
         json=payload,
     )
@@ -188,7 +199,8 @@ def get_nearest_location(business_id: int, latitude: float, longitude: float) ->
         latitude: Latitude of the location
         longitude: Longitude of the location
     """
-    r = devhub_api.get('{}locations/'.format(base_url), params={
+    client, base_url = get_client()
+    r = client.get('{}locations/'.format(base_url), params={
         'business_id': business_id,
         'near_lat': latitude,
         'near_lon': longitude,
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -0,0 +1 @@
+# Tests package for devhub-cms-mcp
diff --git a/tests/devhub_cms_mcp/__init__.py b/tests/devhub_cms_mcp/__init__.py
@@ -0,0 +1 @@
+# Tests for devhub_cms_mcp package
diff --git a/tests/devhub_cms_mcp/test_mcp_integration.py b/tests/devhub_cms_mcp/test_mcp_integration.py
@@ -0,0 +1,193 @@
+import json
+import os
+import unittest
+from unittest.mock import patch, MagicMock
+
+from devhub_cms_mcp.server import get_hours_of_operation, update_hours, upload_image
+from devhub_cms_mcp.server import get_blog_post, create_blog_post, update_blog_post, get_nearest_location
+
+
+class TestMcpIntegration(unittest.TestCase):
+    """Tests for the DevHub CMS MCP integration."""
+
+    def setUp(self):
+        """Set up test environment with environment variables."""
+        os.environ['DEVHUB_API_KEY'] = 'test_key'
+        os.environ['DEVHUB_API_SECRET'] = 'test_secret'
+        os.environ['DEVHUB_BASE_URL'] = 'https://devhub.example.com'
+        
+    @patch('requests_oauthlib.OAuth1Session.get')
+    def test_get_hours_of_operation_endpoint(self, mock_get):
+        """Test get_hours_of_operation MCP endpoint."""
+        # Mock response
+        mock_response = MagicMock()
+        mock_response.content = json.dumps({
+            'hours_by_type': {
+                'primary': [
+                    [["09:00:00", "17:00:00"]],  # Monday
+                    [["09:00:00", "17:00:00"]],  # Tuesday
+                    [["09:00:00", "17:00:00"]],  # Wednesday
+                    [["09:00:00", "17:00:00"]],  # Thursday
+                    [["09:00:00", "17:00:00"]],  # Friday
+                    [],  # Saturday (closed)
+                    []   # Sunday (closed)
+                ]
+            }
+        }).encode()
+        mock_get.return_value = mock_response
+        
+        # Call function directly
+        result = get_hours_of_operation(location_id=123, hours_type='primary')
+        
+        # Verify response
+        self.assertEqual(len(result), 7)  # One entry per day
+        self.assertEqual(result[0], [["09:00:00", "17:00:00"]])  # Monday
+        
+    @patch('requests_oauthlib.OAuth1Session.put')
+    def test_update_hours_endpoint(self, mock_put):
+        """Test update_hours MCP endpoint."""
+        # Mock response
+        mock_response = MagicMock()
+        mock_response.content = json.dumps({
+            'success': True
+        }).encode()
+        mock_put.return_value = mock_response
+        
+        # Test data
+        new_hours = [
+            [["09:00:00", "17:00:00"]],  # Monday
+            [["09:00:00", "17:00:00"]],  # Tuesday
+            [["09:00:00", "17:00:00"]],  # Wednesday
+            [["09:00:00", "17:00:00"]],  # Thursday
+            [["09:00:00", "17:00:00"]],  # Friday
+            [["10:00:00", "15:00:00"]],  # Saturday
+            []                            # Sunday (closed)
+        ]
+        
+        # Call function directly
+        result = update_hours(location_id=123, new_hours=new_hours, hours_type="primary")
+        
+        # Verify response
+        self.assertEqual(result, 'Updated successfully')
+        
+    @patch('requests_oauthlib.OAuth1Session.post')
+    def test_upload_image_endpoint(self, mock_post):
+        """Test upload_image MCP endpoint."""
+        # Mock response
+        mock_response = MagicMock()
+        mock_response.json.return_value = {
+            'id': 456,
+            'absolute_path': '/media/uploads/image.jpg'
+        }
+        mock_post.return_value = mock_response
+        
+        # Call function directly
+        result = upload_image(
+            base64_image_content='base64encodedcontent',
+            filename='test.jpg'
+        )
+        
+        # Verify response
+        self.assertIn('Image ID: 456', result)
+        self.assertIn('/media/uploads/image.jpg', result)
+        
+    @patch('requests_oauthlib.OAuth1Session.get')
+    def test_get_blog_post_endpoint(self, mock_get):
+        """Test get_blog_post MCP endpoint."""
+        # Mock response
+        mock_response = MagicMock()
+        mock_response.json.return_value = {
+            'id': 789,
+            'title': 'Test Blog Post',
+            'date': '2025-03-17',
+            'content': '<p>This is a test blog post.</p>'
+        }
+        mock_get.return_value = mock_response
+        
+        # Call function directly
+        result = get_blog_post(post_id=789)
+        
+        # Verify response
+        self.assertIn('Post ID: 789', result)
+        self.assertIn('Title: Test Blog Post', result)
+        
+    @patch('requests_oauthlib.OAuth1Session.post')
+    def test_create_blog_post_endpoint(self, mock_post):
+        """Test create_blog_post MCP endpoint."""
+        # Mock response
+        mock_response = MagicMock()
+        mock_response.json.return_value = {
+            'id': 999,
+            'title': 'New Test Post',
+            'date': '2025-03-17',
+            'content': '<p>This is a new test blog post.</p>'
+        }
+        mock_post.return_value = mock_response
+        
+        # Call function directly
+        result = create_blog_post(
+            site_id=42,
+            title="New Test Post",
+            content="<p>This is a new test blog post.</p>"
+        )
+        
+        # Verify response
+        self.assertIn('Post ID: 999', result)
+        self.assertIn('Title: New Test Post', result)
+        
+    @patch('requests_oauthlib.OAuth1Session.put')
+    def test_update_blog_post_endpoint(self, mock_put):
+        """Test update_blog_post MCP endpoint."""
+        # Mock response
+        mock_response = MagicMock()
+        mock_response.json.return_value = {
+            'id': 789,
+            'title': 'Updated Test Post',
+            'date': '2025-03-17',
+            'content': '<p>This is an updated test blog post.</p>'
+        }
+        mock_put.return_value = mock_response
+        
+        # Call function directly
+        result = update_blog_post(
+            post_id=789,
+            title="Updated Test Post",
+            content="<p>This is an updated test blog post.</p>"
+        )
+        
+        # Verify response
+        self.assertIn('Post ID: 789', result)
+        self.assertIn('Title: Updated Test Post', result)
+        
+    @patch('requests_oauthlib.OAuth1Session.get')
+    def test_get_nearest_location_endpoint(self, mock_get):
+        """Test get_nearest_location MCP endpoint."""
+        # Mock response
+        mock_response = MagicMock()
+        mock_response.content = json.dumps({
+            'objects': [{
+                'id': 123,
+                'location_name': 'Test Location',
+                'location_url': 'https://example.com/location/123',
+                'street': '123 Main St',
+                'city': 'Test City',
+                'state': 'TS',
+                'country': 'Test Country'
+            }]
+        }).encode()
+        mock_get.return_value = mock_response
+        
+        # Call function directly
+        result = get_nearest_location(
+            business_id=42,
+            latitude=37.7749,
+            longitude=-122.4194
+        )
+        
+        # Verify response
+        self.assertIn('Location ID: 123', result)
+        self.assertIn('Location name: Test Location', result)
+
+
+if __name__ == '__main__':
+    unittest.main()
diff --git a/uv.lock b/uv.lock

-Original file line number
+Diff line change
 # Virtual environments
 .venv
++
 +# IDEs
 +.cursor