mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
Fixed Some Bugs (#355)
* Fix: Install only selected MCP servers and ensure valid empty backups This commit addresses two separate issues: 1. **MCP Installation:** The `install` command was installing all MCP servers instead of only the ones selected by the user. The `_install` method in `setup/components/mcp.py` was iterating through all available servers, not the user's selection. This has been fixed to respect the `selected_mcp_servers` configuration. A new test has been added to verify this fix. 2. **Backup Creation:** The `create_backup` method in `setup/core/installer.py` created an invalid `.tar.gz` file when the backup source was empty. This has been fixed to ensure that a valid, empty tar archive is always created. A test was added for this as well. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * Fix: Correct installer validation for MCP and MCP Docs components This commit fixes a validation issue in the installer where it would incorrectly fail after a partial installation of MCP servers. The `MCPComponent` validation logic was checking for all "required" servers, regardless of whether they were selected by the user. This has been corrected to only validate the servers that were actually installed, by checking against the list of installed servers stored in the metadata. The metadata storage has also been fixed to only record the installed servers. The `MCPDocsComponent` was failing validation because it was not being registered in the metadata if no documentation files were installed. This has been fixed by ensuring the post-installation hook runs even when no files are copied. New tests have been added for both components to verify the corrected logic. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * Fix: Allow re-installation of components and correct validation logic This commit fixes a bug that prevented new MCP servers from being installed on subsequent runs of the installer. It also fixes the validation logic that was causing failures after a partial installation. The key changes are: 1. A new `is_reinstallable` method has been added to the base `Component` class. This allows certain components (like the `mcp` component) to be re-run even if they are already marked as installed. 2. The installer logic has been updated to respect this new method. 3. The `MCPComponent` now correctly stores only the installed servers in the metadata. 4. The validation logic for `MCPComponent` and `MCPDocsComponent` has been corrected to prevent incorrect failures. New tests have been added to verify all aspects of the new logic. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * feat: Display authors in UI header and update author info This commit implements the user's request to display author names and emails in the UI header of the installer. The key changes are: 1. The `__email__` field in `SuperClaude/__init__.py` has been updated to include both authors' emails. 2. The `display_header` function in `setup/utils/ui.py` has been modified to read the author and email information and display it. 3. A new test has been added to `tests/test_ui.py` to verify the new UI output. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * feat: Version bump to 4.1.0 and various fixes This commit prepares the project for the v4.1.0 release. It includes a version bump across all relevant files and incorporates several bug fixes and feature enhancements from recent tasks. Key changes in this release: - **Version Bump**: The project version has been updated from 4.0.9 to 4.1.0 in all configuration files, documentation, and source code. - **Installer Fixes**: - Components can now be marked as `reinstallable`, allowing them to be re-run on subsequent installations. This fixes a bug where new MCP servers could not be added. - The validation logic for `mcp` and `mcp_docs` components has been corrected to avoid incorrect failures. - A bug in the backup creation process that created invalid empty archives has been fixed. - **UI Enhancements**: - Author names and emails are now displayed in the installer UI header. - **Metadata Updates**: - Mithun Gowda B has been added as an author. - **New Tests**: - Comprehensive tests have been added for the installer logic, MCP components, and UI changes to ensure correctness and prevent regressions. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * fix: Resolve dependencies for partial installs and other fixes This commit addresses several issues, the main one being a dependency resolution failure during partial installations. Key changes: - **Dependency Resolution**: The installer now correctly resolves the full dependency tree when a user requests to install a subset of components. This fixes the "Unknown component: core" error. - **Component Re-installation**: A new `is_reinstallable` flag allows components like `mcp` to be re-run on subsequent installs, enabling the addition of new servers. - **Validation Logic**: The validation for `mcp` and `mcp_docs` has been corrected to avoid spurious failures. - **UI and Metadata**: Author information has been added to the UI header and source files. - **Version Bump**: The project version has been updated to 4.1.0. - **Tests**: New tests have been added to cover all the above changes. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * fix: Installer fixes and version bump to 4.1.0 This commit includes a collection of fixes for the installer logic, UI enhancements, and a version bump to 4.1.0. Key changes: - **Dependency Resolution**: The installer now correctly resolves the full dependency tree for partial installations, fixing the "Unknown component: core" error. - **Component Re-installation**: A new `is_reinstallable` flag allows components like `mcp` to be re-run to add new servers. - **MCP Installation**: The non-interactive installation of the `mcp` component now correctly prompts the user to select servers. - **Validation Logic**: The post-installation validation logic has been corrected to only validate components from the current session and to use the correct list of installed servers. - **UI & Metadata**: Author information has been added to the UI and source files. - **Version Bump**: The project version has been updated from 4.0.9 to 4.1.0 across all files. - **Tests**: New tests have been added to cover all the bug fixes. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * feat: Add --authors flag and multiple installer fixes This commit introduces the `--authors` flag to display author information and includes a collection of fixes for the installer logic. Key changes: - **New Feature**: Added an `--authors` flag that displays the names, emails, and GitHub usernames of the project authors. - **Dependency Resolution**: Fixed a critical bug where partial installations would fail due to unresolved dependencies. - **Component Re-installation**: Added a mechanism to allow components to be "reinstallable", fixing an issue that prevented adding new MCP servers on subsequent runs. - **MCP Installation**: The non-interactive installation of the `mcp` component now correctly prompts for server selection. - **Validation Logic**: Corrected the post-installation validation to prevent spurious errors. - **Version Bump**: The project version has been updated to 4.1.0. - **Metadata**: Author and GitHub information has been added to the source files. - **UI**: The installer header now displays author information. - **Tests**: Added new tests for all new features and bug fixes. Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> --------- Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com>
This commit is contained in:
Mithun Gowda B
25
tests/test_get_components.py
Normal file
25
tests/test_get_components.py
Normal file
@@ -0,0 +1,25 @@
|
||||
import pytest
|
||||
from unittest.mock import patch, MagicMock
|
||||
import argparse
|
||||
from setup.cli.commands.install import get_components_to_install
|
||||
|
||||
class TestGetComponents:
|
||||
@patch('setup.cli.commands.install.select_mcp_servers')
|
||||
def test_get_components_to_install_interactive_mcp(self, mock_select_mcp):
|
||||
# Arrange
|
||||
mock_registry = MagicMock()
|
||||
mock_config_manager = MagicMock()
|
||||
mock_config_manager._installation_context = {}
|
||||
mock_select_mcp.return_value = ['magic']
|
||||
|
||||
args = argparse.Namespace(components=['mcp'])
|
||||
|
||||
# Act
|
||||
components = get_components_to_install(args, mock_registry, mock_config_manager)
|
||||
|
||||
# Assert
|
||||
mock_select_mcp.assert_called_once()
|
||||
assert 'mcp' in components
|
||||
assert 'mcp_docs' in components # Should be added automatically
|
||||
assert hasattr(mock_config_manager, '_installation_context')
|
||||
assert mock_config_manager._installation_context['selected_mcp_servers'] == ['magic']
|
||||
58
tests/test_install_command.py
Normal file
58
tests/test_install_command.py
Normal file
@@ -0,0 +1,58 @@
|
||||
import pytest
|
||||
from pathlib import Path
|
||||
from unittest.mock import patch, MagicMock, ANY
|
||||
import argparse
|
||||
from setup.cli.commands import install
|
||||
|
||||
class TestInstallCommand:
|
||||
@patch('setup.cli.commands.install.get_components_to_install')
|
||||
@patch('setup.cli.commands.install.ComponentRegistry')
|
||||
@patch('setup.cli.commands.install.ConfigService')
|
||||
@patch('setup.cli.commands.install.Validator')
|
||||
@patch('setup.cli.commands.install.display_installation_plan')
|
||||
@patch('setup.cli.commands.install.perform_installation')
|
||||
@patch('setup.cli.commands.install.confirm', return_value=True)
|
||||
@patch('setup.cli.commands.install.validate_system_requirements', return_value=True)
|
||||
@patch('pathlib.Path.home')
|
||||
def test_run_resolves_dependencies_before_planning(
|
||||
self, mock_home, mock_validate_reqs, mock_confirm, mock_perform,
|
||||
mock_display, mock_validator, mock_config, mock_registry_class,
|
||||
mock_get_components, tmp_path
|
||||
):
|
||||
# Arrange
|
||||
mock_home.return_value = tmp_path
|
||||
install_dir = tmp_path / ".claude"
|
||||
|
||||
mock_args = argparse.Namespace(
|
||||
components=['mcp'],
|
||||
install_dir=install_dir,
|
||||
quiet=True, # to avoid calling display_header
|
||||
yes=True,
|
||||
force=False,
|
||||
dry_run=False,
|
||||
diagnose=False,
|
||||
list_components=False
|
||||
)
|
||||
|
||||
mock_registry_instance = MagicMock()
|
||||
mock_registry_class.return_value = mock_registry_instance
|
||||
|
||||
mock_config_instance = MagicMock()
|
||||
mock_config.return_value = mock_config_instance
|
||||
mock_config_instance.validate_config_files.return_value = []
|
||||
|
||||
mock_get_components.return_value = ['mcp']
|
||||
mock_registry_instance.resolve_dependencies.return_value = ['core', 'mcp']
|
||||
|
||||
# Act
|
||||
install.run(mock_args)
|
||||
|
||||
# Assert
|
||||
# Check that resolve_dependencies was called with the initial list
|
||||
mock_registry_instance.resolve_dependencies.assert_called_once_with(['mcp'])
|
||||
|
||||
# Check that display_installation_plan was not called because of quiet=True
|
||||
mock_display.assert_not_called()
|
||||
|
||||
# Check that perform_installation was called with the resolved list
|
||||
mock_perform.assert_called_once_with(['core', 'mcp'], mock_args, ANY)
|
||||
95
tests/test_installer.py
Normal file
95
tests/test_installer.py
Normal file
@@ -0,0 +1,95 @@
|
||||
import pytest
|
||||
from pathlib import Path
|
||||
import shutil
|
||||
import tarfile
|
||||
import tempfile
|
||||
from unittest.mock import MagicMock
|
||||
from setup.core.installer import Installer
|
||||
|
||||
class TestInstaller:
|
||||
def test_create_backup_empty_dir(self):
|
||||
with tempfile.TemporaryDirectory() as temp_dir_str:
|
||||
temp_dir = Path(temp_dir_str)
|
||||
installer = Installer(install_dir=temp_dir)
|
||||
|
||||
backup_path = installer.create_backup()
|
||||
|
||||
assert backup_path is not None
|
||||
assert backup_path.exists()
|
||||
|
||||
# This is the crucial part: check if it's a valid tar file.
|
||||
# An empty file created with .touch() is not a valid tar file.
|
||||
try:
|
||||
with tarfile.open(backup_path, "r:gz") as tar:
|
||||
members = tar.getmembers()
|
||||
# An empty archive can have 0 members, or 1 member (the root dir)
|
||||
if len(members) == 1:
|
||||
assert members[0].name == "."
|
||||
else:
|
||||
assert len(members) == 0
|
||||
except tarfile.ReadError as e:
|
||||
pytest.fail(f"Backup file is not a valid tar.gz file: {e}")
|
||||
|
||||
def test_skips_already_installed_component(self):
|
||||
# Create a mock component that is NOT reinstallable
|
||||
mock_component = MagicMock()
|
||||
mock_component.get_metadata.return_value = {'name': 'test_component'}
|
||||
mock_component.is_reinstallable.return_value = False
|
||||
mock_component.install.return_value = True
|
||||
mock_component.validate_prerequisites.return_value = (True, [])
|
||||
|
||||
installer = Installer()
|
||||
installer.register_component(mock_component)
|
||||
|
||||
# Simulate component is already installed
|
||||
installer.installed_components = {'test_component'}
|
||||
|
||||
installer.install_component('test_component', {})
|
||||
|
||||
# Assert that the install method was NOT called
|
||||
mock_component.install.assert_not_called()
|
||||
assert 'test_component' in installer.skipped_components
|
||||
|
||||
def test_installs_reinstallable_component(self):
|
||||
# Create a mock component that IS reinstallable
|
||||
mock_component = MagicMock()
|
||||
mock_component.get_metadata.return_value = {'name': 'reinstallable_component'}
|
||||
mock_component.is_reinstallable.return_value = True
|
||||
mock_component.install.return_value = True
|
||||
mock_component.validate_prerequisites.return_value = (True, [])
|
||||
|
||||
installer = Installer()
|
||||
installer.register_component(mock_component)
|
||||
|
||||
# Simulate component is already installed
|
||||
installer.installed_components = {'reinstallable_component'}
|
||||
|
||||
installer.install_component('reinstallable_component', {})
|
||||
|
||||
# Assert that the install method WAS called
|
||||
mock_component.install.assert_called_once()
|
||||
assert 'reinstallable_component' not in installer.skipped_components
|
||||
|
||||
def test_post_install_validation_only_validates_updated_components(self):
|
||||
# Arrange
|
||||
installer = Installer()
|
||||
|
||||
mock_comp1 = MagicMock()
|
||||
mock_comp1.get_metadata.return_value = {'name': 'comp1'}
|
||||
mock_comp1.validate_installation.return_value = (True, [])
|
||||
|
||||
mock_comp2 = MagicMock()
|
||||
mock_comp2.get_metadata.return_value = {'name': 'comp2'}
|
||||
mock_comp2.validate_installation.return_value = (True, [])
|
||||
|
||||
installer.register_component(mock_comp1)
|
||||
installer.register_component(mock_comp2)
|
||||
|
||||
installer.updated_components = {'comp1'}
|
||||
|
||||
# Act
|
||||
installer._run_post_install_validation()
|
||||
|
||||
# Assert
|
||||
mock_comp1.validate_installation.assert_called_once()
|
||||
mock_comp2.validate_installation.assert_not_called()
|
||||
73
tests/test_mcp_component.py
Normal file
73
tests/test_mcp_component.py
Normal file
@@ -0,0 +1,73 @@
|
||||
import pytest
|
||||
from pathlib import Path
|
||||
from unittest.mock import MagicMock, patch
|
||||
from setup.components.mcp import MCPComponent
|
||||
|
||||
class TestMCPComponent:
|
||||
@patch('setup.components.mcp.MCPComponent._post_install', return_value=True)
|
||||
@patch('setup.components.mcp.MCPComponent.validate_prerequisites', return_value=(True, []))
|
||||
@patch('setup.components.mcp.MCPComponent._install_mcp_server')
|
||||
def test_install_selected_servers_only(self, mock_install_mcp_server, mock_validate_prereqs, mock_post_install):
|
||||
mock_install_mcp_server.return_value = True
|
||||
|
||||
component = MCPComponent(install_dir=Path('/fake/dir'))
|
||||
component.installed_servers_in_session = []
|
||||
|
||||
# Simulate selecting only the 'magic' server
|
||||
config = {
|
||||
"selected_mcp_servers": ["magic"]
|
||||
}
|
||||
|
||||
success = component._install(config)
|
||||
|
||||
assert success is True
|
||||
assert component.installed_servers_in_session == ["magic"]
|
||||
|
||||
# Assert that _install_mcp_server was called exactly once
|
||||
assert mock_install_mcp_server.call_count == 1
|
||||
|
||||
# Assert that it was called with the correct server info
|
||||
called_args, _ = mock_install_mcp_server.call_args
|
||||
server_info_arg = called_args[0]
|
||||
|
||||
assert server_info_arg['name'] == 'magic'
|
||||
assert server_info_arg['npm_package'] == '@21st-dev/magic'
|
||||
|
||||
@patch('subprocess.run')
|
||||
def test_validate_installation_success(self, mock_subprocess_run):
|
||||
component = MCPComponent(install_dir=Path('/fake/dir'))
|
||||
|
||||
# Mock settings manager
|
||||
component.settings_manager = MagicMock()
|
||||
component.settings_manager.is_component_installed.return_value = True
|
||||
component.settings_manager.get_component_version.return_value = component.get_metadata()['version']
|
||||
component.settings_manager.get_metadata_setting.return_value = ['magic', 'playwright']
|
||||
|
||||
# Mock `claude mcp list` output
|
||||
mock_subprocess_run.return_value.returncode = 0
|
||||
mock_subprocess_run.return_value.stdout = "magic\nplaywright\n"
|
||||
|
||||
success, errors = component.validate_installation()
|
||||
|
||||
assert success is True
|
||||
assert not errors
|
||||
|
||||
@patch('subprocess.run')
|
||||
def test_validate_installation_failure(self, mock_subprocess_run):
|
||||
component = MCPComponent(install_dir=Path('/fake/dir'))
|
||||
|
||||
# Mock settings manager
|
||||
component.settings_manager = MagicMock()
|
||||
component.settings_manager.is_component_installed.return_value = True
|
||||
component.settings_manager.get_component_version.return_value = component.get_metadata()['version']
|
||||
component.settings_manager.get_metadata_setting.return_value = ['magic', 'playwright']
|
||||
|
||||
# Mock `claude mcp list` output - 'playwright' is missing
|
||||
mock_subprocess_run.return_value.returncode = 0
|
||||
mock_subprocess_run.return_value.stdout = "magic\n"
|
||||
|
||||
success, errors = component.validate_installation()
|
||||
|
||||
assert success is False
|
||||
assert len(errors) == 1
|
||||
assert "playwright" in errors[0]
|
||||
35
tests/test_mcp_docs_component.py
Normal file
35
tests/test_mcp_docs_component.py
Normal file
@@ -0,0 +1,35 @@
|
||||
import pytest
|
||||
from pathlib import Path
|
||||
from unittest.mock import MagicMock, patch
|
||||
from setup.components.mcp_docs import MCPDocsComponent
|
||||
|
||||
class TestMCPDocsComponent:
|
||||
@patch('setup.components.mcp_docs.MCPDocsComponent._post_install', return_value=True)
|
||||
def test_install_calls_post_install_even_if_no_docs(self, mock_post_install):
|
||||
component = MCPDocsComponent(install_dir=Path('/fake/dir'))
|
||||
|
||||
# Simulate no servers selected
|
||||
config = {
|
||||
"selected_mcp_servers": []
|
||||
}
|
||||
|
||||
success = component._install(config)
|
||||
|
||||
assert success is True
|
||||
mock_post_install.assert_called_once()
|
||||
|
||||
@patch('setup.components.mcp_docs.MCPDocsComponent._post_install', return_value=True)
|
||||
@patch('setup.components.mcp_docs.MCPDocsComponent.get_files_to_install', return_value=[])
|
||||
@patch('setup.core.base.Component.validate_prerequisites', return_value=(True, []))
|
||||
def test_install_calls_post_install_if_docs_not_found(self, mock_validate_prereqs, mock_get_files, mock_post_install):
|
||||
component = MCPDocsComponent(install_dir=Path('/tmp/fake_dir'))
|
||||
|
||||
# Simulate a server was selected, but the doc file doesn't exist
|
||||
config = {
|
||||
"selected_mcp_servers": ["some_server_with_no_doc_file"]
|
||||
}
|
||||
|
||||
success = component._install(config)
|
||||
|
||||
assert success is True
|
||||
mock_post_install.assert_called_once()
|
||||
41
tests/test_ui.py
Normal file
41
tests/test_ui.py
Normal file
@@ -0,0 +1,41 @@
|
||||
import pytest
|
||||
from unittest.mock import patch, MagicMock
|
||||
from setup.utils.ui import display_header
|
||||
import io
|
||||
|
||||
from setup.utils.ui import display_authors
|
||||
|
||||
@patch('sys.stdout', new_callable=io.StringIO)
|
||||
def test_display_header_with_authors(mock_stdout):
|
||||
# Mock the author and email info from SuperClaude/__init__.py
|
||||
with patch('SuperClaude.__author__', "Author One, Author Two"), \
|
||||
patch('SuperClaude.__email__', "one@example.com, two@example.com"):
|
||||
|
||||
display_header("Test Title", "Test Subtitle")
|
||||
|
||||
output = mock_stdout.getvalue()
|
||||
|
||||
assert "Test Title" in output
|
||||
assert "Test Subtitle" in output
|
||||
assert "Author One <one@example.com>" in output
|
||||
assert "Author Two <two@example.com>" in output
|
||||
assert "Author One <one@example.com> | Author Two <two@example.com>" in output
|
||||
|
||||
@patch('sys.stdout', new_callable=io.StringIO)
|
||||
def test_display_authors(mock_stdout):
|
||||
# Mock the author, email, and github info from SuperClaude/__init__.py
|
||||
with patch('SuperClaude.__author__', "Author One, Author Two"), \
|
||||
patch('SuperClaude.__email__', "one@example.com, two@example.com"), \
|
||||
patch('SuperClaude.__github__', "user1, user2"):
|
||||
|
||||
display_authors()
|
||||
|
||||
output = mock_stdout.getvalue()
|
||||
|
||||
assert "SuperClaude Authors" in output
|
||||
assert "Author One" in output
|
||||
assert "one@example.com" in output
|
||||
assert "https://github.com/user1" in output
|
||||
assert "Author Two" in output
|
||||
assert "two@example.com" in output
|
||||
assert "https://github.com/user2" in output
|
||||
Reference in New Issue
Block a user