|
| 1 | +"""Tests for MCPHostConfigBackupManager. |
| 2 | +
|
| 3 | +This module contains tests for the MCP host configuration backup functionality, |
| 4 | +including backup creation, restoration, and management with host-agnostic design. |
| 5 | +""" |
| 6 | + |
| 7 | +import unittest |
| 8 | +import tempfile |
| 9 | +import shutil |
| 10 | +import json |
| 11 | +from pathlib import Path |
| 12 | +from datetime import datetime |
| 13 | +from unittest.mock import patch, Mock |
| 14 | + |
| 15 | +from wobble.decorators import regression_test, integration_test, slow_test |
| 16 | +from test_data_utils import MCPBackupTestDataLoader |
| 17 | + |
| 18 | +from hatch.mcp.backup import ( |
| 19 | + MCPHostConfigBackupManager, |
| 20 | + BackupInfo, |
| 21 | + BackupResult, |
| 22 | + BackupError |
| 23 | +) |
| 24 | + |
| 25 | + |
| 26 | +class TestMCPHostConfigBackupManager(unittest.TestCase): |
| 27 | + """Test MCPHostConfigBackupManager core functionality with host-agnostic design.""" |
| 28 | + |
| 29 | + def setUp(self): |
| 30 | + """Set up test environment with host-agnostic configurations.""" |
| 31 | + self.temp_dir = Path(tempfile.mkdtemp(prefix="test_mcp_backup_")) |
| 32 | + self.backup_root = self.temp_dir / "backups" |
| 33 | + self.config_dir = self.temp_dir / "configs" |
| 34 | + self.config_dir.mkdir(parents=True) |
| 35 | + |
| 36 | + # Initialize test data loader |
| 37 | + self.test_data = MCPBackupTestDataLoader() |
| 38 | + |
| 39 | + # Create host-agnostic test configuration files |
| 40 | + self.test_configs = {} |
| 41 | + for hostname in ['claude-desktop', 'vscode', 'cursor', 'lmstudio']: |
| 42 | + config_data = self.test_data.load_host_agnostic_config("simple_server") |
| 43 | + config_file = self.config_dir / f"{hostname}_config.json" |
| 44 | + with open(config_file, 'w') as f: |
| 45 | + json.dump(config_data, f, indent=2) |
| 46 | + self.test_configs[hostname] = config_file |
| 47 | + |
| 48 | + self.backup_manager = MCPHostConfigBackupManager(backup_root=self.backup_root) |
| 49 | + |
| 50 | + def tearDown(self): |
| 51 | + """Clean up test environment.""" |
| 52 | + shutil.rmtree(self.temp_dir, ignore_errors=True) |
| 53 | + |
| 54 | + @regression_test |
| 55 | + def test_backup_directory_creation(self): |
| 56 | + """Test automatic backup directory creation.""" |
| 57 | + self.assertTrue(self.backup_root.exists()) |
| 58 | + self.assertTrue(self.backup_root.is_dir()) |
| 59 | + |
| 60 | + @regression_test |
| 61 | + def test_create_backup_success_all_hosts(self): |
| 62 | + """Test successful backup creation for all supported host types.""" |
| 63 | + for hostname, config_file in self.test_configs.items(): |
| 64 | + with self.subTest(hostname=hostname): |
| 65 | + result = self.backup_manager.create_backup(config_file, hostname) |
| 66 | + |
| 67 | + # Validate BackupResult Pydantic model |
| 68 | + self.assertIsInstance(result, BackupResult) |
| 69 | + self.assertTrue(result.success) |
| 70 | + self.assertIsNotNone(result.backup_path) |
| 71 | + self.assertTrue(result.backup_path.exists()) |
| 72 | + self.assertGreater(result.backup_size, 0) |
| 73 | + self.assertEqual(result.original_size, result.backup_size) |
| 74 | + |
| 75 | + # Verify backup filename format (host-agnostic) |
| 76 | + expected_pattern = rf"mcp\.json\.{hostname}\.\d{{8}}_\d{{6}}_\d{{6}}" |
| 77 | + self.assertRegex(result.backup_path.name, expected_pattern) |
| 78 | + |
| 79 | + @regression_test |
| 80 | + def test_create_backup_nonexistent_file(self): |
| 81 | + """Test backup creation with nonexistent source file.""" |
| 82 | + nonexistent = self.config_dir / "nonexistent.json" |
| 83 | + result = self.backup_manager.create_backup(nonexistent, "claude-desktop") |
| 84 | + |
| 85 | + self.assertFalse(result.success) |
| 86 | + self.assertIsNotNone(result.error_message) |
| 87 | + self.assertIn("not found", result.error_message.lower()) |
| 88 | + |
| 89 | + @regression_test |
| 90 | + def test_backup_content_integrity_host_agnostic(self): |
| 91 | + """Test backup content matches original for any host configuration format.""" |
| 92 | + hostname = 'claude-desktop' |
| 93 | + config_file = self.test_configs[hostname] |
| 94 | + original_content = config_file.read_text() |
| 95 | + |
| 96 | + result = self.backup_manager.create_backup(config_file, hostname) |
| 97 | + |
| 98 | + self.assertTrue(result.success) |
| 99 | + backup_content = result.backup_path.read_text() |
| 100 | + self.assertEqual(original_content, backup_content) |
| 101 | + |
| 102 | + # Verify JSON structure is preserved (host-agnostic validation) |
| 103 | + original_json = json.loads(original_content) |
| 104 | + backup_json = json.loads(backup_content) |
| 105 | + self.assertEqual(original_json, backup_json) |
| 106 | + |
| 107 | + @regression_test |
| 108 | + def test_multiple_backups_same_host(self): |
| 109 | + """Test creating multiple backups for same host.""" |
| 110 | + hostname = 'vscode' |
| 111 | + config_file = self.test_configs[hostname] |
| 112 | + |
| 113 | + # Create first backup |
| 114 | + result1 = self.backup_manager.create_backup(config_file, hostname) |
| 115 | + self.assertTrue(result1.success) |
| 116 | + |
| 117 | + # Modify config and create second backup |
| 118 | + modified_config = self.test_data.load_host_agnostic_config("complex_server") |
| 119 | + with open(config_file, 'w') as f: |
| 120 | + json.dump(modified_config, f, indent=2) |
| 121 | + |
| 122 | + result2 = self.backup_manager.create_backup(config_file, hostname) |
| 123 | + self.assertTrue(result2.success) |
| 124 | + |
| 125 | + # Verify both backups exist and are different |
| 126 | + self.assertTrue(result1.backup_path.exists()) |
| 127 | + self.assertTrue(result2.backup_path.exists()) |
| 128 | + self.assertNotEqual(result1.backup_path, result2.backup_path) |
| 129 | + |
| 130 | + @regression_test |
| 131 | + def test_list_backups_empty(self): |
| 132 | + """Test listing backups when none exist.""" |
| 133 | + backups = self.backup_manager.list_backups("claude-desktop") |
| 134 | + self.assertEqual(len(backups), 0) |
| 135 | + |
| 136 | + @regression_test |
| 137 | + def test_list_backups_pydantic_validation(self): |
| 138 | + """Test listing backups returns valid Pydantic models.""" |
| 139 | + hostname = 'cursor' |
| 140 | + config_file = self.test_configs[hostname] |
| 141 | + |
| 142 | + # Create multiple backups |
| 143 | + self.backup_manager.create_backup(config_file, hostname) |
| 144 | + self.backup_manager.create_backup(config_file, hostname) |
| 145 | + |
| 146 | + backups = self.backup_manager.list_backups(hostname) |
| 147 | + self.assertEqual(len(backups), 2) |
| 148 | + |
| 149 | + # Verify BackupInfo Pydantic model validation |
| 150 | + for backup in backups: |
| 151 | + self.assertIsInstance(backup, BackupInfo) |
| 152 | + self.assertEqual(backup.hostname, hostname) |
| 153 | + self.assertIsInstance(backup.timestamp, datetime) |
| 154 | + self.assertTrue(backup.file_path.exists()) |
| 155 | + self.assertGreater(backup.file_size, 0) |
| 156 | + |
| 157 | + # Test Pydantic serialization |
| 158 | + backup_dict = backup.dict() |
| 159 | + self.assertIn('hostname', backup_dict) |
| 160 | + self.assertIn('timestamp', backup_dict) |
| 161 | + |
| 162 | + # Test JSON serialization |
| 163 | + backup_json = backup.json() |
| 164 | + self.assertIsInstance(backup_json, str) |
| 165 | + |
| 166 | + # Verify sorting (newest first) |
| 167 | + self.assertGreaterEqual(backups[0].timestamp, backups[1].timestamp) |
| 168 | + |
| 169 | + @regression_test |
| 170 | + def test_backup_validation_unsupported_hostname(self): |
| 171 | + """Test Pydantic validation rejects unsupported hostnames.""" |
| 172 | + config_file = self.test_configs['claude-desktop'] |
| 173 | + |
| 174 | + # Test with unsupported hostname |
| 175 | + result = self.backup_manager.create_backup(config_file, 'unsupported-host') |
| 176 | + |
| 177 | + self.assertFalse(result.success) |
| 178 | + self.assertIn('unsupported', result.error_message.lower()) |
| 179 | + |
| 180 | + @regression_test |
| 181 | + def test_multiple_hosts_isolation(self): |
| 182 | + """Test backup isolation between different host types.""" |
| 183 | + # Create backups for multiple hosts |
| 184 | + results = {} |
| 185 | + for hostname, config_file in self.test_configs.items(): |
| 186 | + results[hostname] = self.backup_manager.create_backup(config_file, hostname) |
| 187 | + self.assertTrue(results[hostname].success) |
| 188 | + |
| 189 | + # Verify separate backup directories |
| 190 | + for hostname in self.test_configs.keys(): |
| 191 | + backups = self.backup_manager.list_backups(hostname) |
| 192 | + self.assertEqual(len(backups), 1) |
| 193 | + |
| 194 | + # Verify backup isolation (different directories) |
| 195 | + backup_dir = backups[0].file_path.parent |
| 196 | + self.assertEqual(backup_dir.name, hostname) |
| 197 | + |
| 198 | + # Verify no cross-contamination |
| 199 | + for other_hostname in self.test_configs.keys(): |
| 200 | + if other_hostname != hostname: |
| 201 | + other_backups = self.backup_manager.list_backups(other_hostname) |
| 202 | + self.assertNotEqual( |
| 203 | + backups[0].file_path.parent, |
| 204 | + other_backups[0].file_path.parent |
| 205 | + ) |
| 206 | + |
| 207 | + @regression_test |
| 208 | + def test_clean_backups_older_than_days(self): |
| 209 | + """Test cleaning backups older than specified days.""" |
| 210 | + hostname = 'lmstudio' |
| 211 | + config_file = self.test_configs[hostname] |
| 212 | + |
| 213 | + # Create backup |
| 214 | + result = self.backup_manager.create_backup(config_file, hostname) |
| 215 | + self.assertTrue(result.success) |
| 216 | + |
| 217 | + # Mock old backup by modifying timestamp |
| 218 | + old_backup_path = result.backup_path.parent / "mcp.json.lmstudio.20200101_120000_000000" |
| 219 | + shutil.copy2(result.backup_path, old_backup_path) |
| 220 | + |
| 221 | + # Clean backups older than 1 day (should remove the old one) |
| 222 | + cleaned_count = self.backup_manager.clean_backups(hostname, older_than_days=1) |
| 223 | + |
| 224 | + # Verify old backup was cleaned |
| 225 | + self.assertGreater(cleaned_count, 0) |
| 226 | + self.assertFalse(old_backup_path.exists()) |
| 227 | + self.assertTrue(result.backup_path.exists()) # Recent backup should remain |
| 228 | + |
| 229 | + @regression_test |
| 230 | + def test_clean_backups_keep_count(self): |
| 231 | + """Test cleaning backups to keep only specified count.""" |
| 232 | + hostname = 'claude-desktop' |
| 233 | + config_file = self.test_configs[hostname] |
| 234 | + |
| 235 | + # Create multiple backups |
| 236 | + for i in range(5): |
| 237 | + self.backup_manager.create_backup(config_file, hostname) |
| 238 | + |
| 239 | + # Verify 5 backups exist |
| 240 | + backups_before = self.backup_manager.list_backups(hostname) |
| 241 | + self.assertEqual(len(backups_before), 5) |
| 242 | + |
| 243 | + # Clean to keep only 2 backups |
| 244 | + cleaned_count = self.backup_manager.clean_backups(hostname, keep_count=2) |
| 245 | + |
| 246 | + # Verify only 2 backups remain |
| 247 | + backups_after = self.backup_manager.list_backups(hostname) |
| 248 | + self.assertEqual(len(backups_after), 2) |
| 249 | + self.assertEqual(cleaned_count, 3) |
| 250 | + |
| 251 | + # Verify newest backups were kept |
| 252 | + for backup in backups_after: |
| 253 | + self.assertIn(backup, backups_before[:2]) # Should be the first 2 (newest) |
| 254 | + |
| 255 | + |
| 256 | +if __name__ == '__main__': |
| 257 | + unittest.main() |
0 commit comments