Files
freecad-robust-mcp-fc111/tests/unit/test_server.py
T
8c338f6da7 feat: MCP Bridge Workbench, just command cleanup, testing, etc. (#24)
* fix: lots of fixes and name refactoring

* feat: Add workbench preferences

* fix: MCP bridge status widget and just command fixes

* fix(tests): Use the correct mesa-glx package

* fix(ci): Add fontconfig to GUI test dependencies

FreeCAD GUI was failing to start with:
"Fontconfig error: Cannot load default config file: No such file"

Added fontconfig and fonts-dejavu-core packages to the GUI test job
dependencies to resolve the font configuration issue.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(addon): Extract path utilities into shared module

Create path_utils.py module that consolidates duplicated path-finding
logic from commands.py and InitGui.py:
- get_addon_path(): Find addon directory with caching and fallbacks
- get_icon_path(): Get full path to an icon file
- get_icons_dir(): Get path to icons directory
- get_workbench_icon(): Get path to workbench main icon

This removes ~100 lines of duplicated code while preserving the same
behavior including _addon_path_cache and all fallback methods.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(addon): Prevent stale plugin state on startup failure

The StartMCPBridgeCommand.Activated method could leave _mcp_plugin in
a partially initialized state if FreecadMCPPlugin.start() failed after
the plugin was instantiated.

Changes:
- Create plugin in a local variable first
- Only assign to _mcp_plugin after start() succeeds
- Explicitly clear _mcp_plugin and _running_config in exception
  handlers to ensure clean state for subsequent retry attempts

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: Lot of broad improvements

* fix(ci): Use blocking headless_server.py for GUI tests

The GUI test was using startup_bridge.py which is non-blocking
(designed for interactive use). For CI, even in GUI mode, we need
the blocking headless_server.py that calls run_forever() to keep
FreeCAD running. GUI features are still available since we use
the 'freecad' executable instead of 'freecadcmd'.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(addon): Rename headless_server.py to blocking_bridge.py

The old name was misleading because:
- It works with both GUI (freecad) and headless (freecadcmd) modes
- The key characteristic is that it BLOCKS with run_forever()

New naming convention clarifies the difference:
- blocking_bridge.py: Starts bridge and blocks (for CI, servers)
- startup_bridge.py: Starts bridge and returns (for interactive GUI)

Updated all references across:
- GitHub workflow (macro-test.yaml)
- Just commands (freecad.just)
- Unit tests (test_addon_structure.py)
- Documentation (5 files)
- CLAUDE.md

Also improved the script to detect GUI mode dynamically using
FreeCAD.GuiUp and display the appropriate status message.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(just): Remove erroneous rm of startup_bridge.py on error

The startup script is now a permanent source file in the repository,
not a generated temporary file. The rm -f would have deleted source
code if FreeCAD wasn't found.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: General improvements

* fix: Lots of general fixes and only stable to PyPi

* fix: small cleanup

* fix: Small fixes and hopefully fixes the GUI tests

* fix: Add proper library paths for FreeCAD GUI in CI

- Create wrapper scripts instead of symlinks for AppImage binaries
- Set LD_LIBRARY_PATH, QT_PLUGIN_PATH for GUI mode
- Add diagnostic output to identify startup failures

* fix: Use apprun for GUI tests in CI

* fix: Improving Xvfb tests

* fix: GUI tests worlk

* chore: remove invalid --no-splash comments

* fix: ARM64 architecture support and other fixes

* fix: cleanup

* test: just commands test suite

* test: improve just command tests

* fix: more general improvements

* fix: more cleanup

* fix: more updates

* fix: small tweaks

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-10 15:26:33 -08:00

298 lines
10 KiB
Python

"""Tests for the main server module."""
import sys
from unittest.mock import AsyncMock, MagicMock, patch
import pytest
from freecad_mcp.config import FreecadMode
# Default argv for main() tests to avoid argparse errors
DEFAULT_ARGV: list[str] = ["freecad-mcp"]
class TestGetInstanceId:
"""Tests for get_instance_id function."""
def test_returns_string(self):
"""Instance ID should be a string."""
from freecad_mcp.server import get_instance_id
instance_id = get_instance_id()
assert isinstance(instance_id, str)
def test_returns_uuid_format(self):
"""Instance ID should be a valid UUID format."""
from freecad_mcp.server import get_instance_id
instance_id = get_instance_id()
# UUID format: 8-4-4-4-12 hex characters
parts = instance_id.split("-")
assert len(parts) == 5
assert len(parts[0]) == 8
assert len(parts[1]) == 4
assert len(parts[2]) == 4
assert len(parts[3]) == 4
assert len(parts[4]) == 12
def test_consistent_across_calls(self):
"""Instance ID should be consistent within a process."""
from freecad_mcp.server import get_instance_id
id1 = get_instance_id()
id2 = get_instance_id()
assert id1 == id2
class TestGetBridge:
"""Tests for get_bridge function."""
@pytest.mark.asyncio
async def test_raises_when_not_initialized(self):
"""Should raise RuntimeError when bridge is not initialized."""
import freecad_mcp.server as server_module
# Save original bridge
original_bridge = server_module._bridge
try:
# Set bridge to None
server_module._bridge = None
with pytest.raises(RuntimeError, match="not initialized"):
await server_module.get_bridge()
finally:
# Restore original bridge
server_module._bridge = original_bridge
@pytest.mark.asyncio
async def test_returns_bridge_when_initialized(self):
"""Should return bridge when it's initialized."""
import freecad_mcp.server as server_module
# Save original bridge
original_bridge = server_module._bridge
try:
# Set up mock bridge
mock_bridge = MagicMock()
server_module._bridge = mock_bridge
bridge = await server_module.get_bridge()
assert bridge is mock_bridge
finally:
# Restore original bridge
server_module._bridge = original_bridge
class TestLifespan:
"""Tests for the lifespan context manager."""
@pytest.mark.asyncio
async def test_embedded_mode_initialization(self):
"""Should initialize embedded bridge in embedded mode."""
import freecad_mcp.server as server_module
mock_config = MagicMock()
mock_config.mode = FreecadMode.EMBEDDED
mock_config.freecad_path = None
mock_embedded_bridge = AsyncMock()
mock_embedded_bridge.get_freecad_version = AsyncMock(
return_value={"version": "1.0.0", "gui_available": False}
)
with (
patch.object(server_module, "get_config", return_value=mock_config),
patch(
"freecad_mcp.bridge.embedded.EmbeddedBridge",
return_value=mock_embedded_bridge,
) as mock_embedded_class,
):
mock_server = MagicMock()
async with server_module.lifespan(mock_server):
# Bridge should be initialized
mock_embedded_class.assert_called_once_with(freecad_path=None)
mock_embedded_bridge.connect.assert_called_once()
# After exiting, disconnect should be called
mock_embedded_bridge.disconnect.assert_called_once()
@pytest.mark.asyncio
async def test_xmlrpc_mode_initialization(self):
"""Should initialize XML-RPC bridge in xmlrpc mode."""
import freecad_mcp.server as server_module
mock_config = MagicMock()
mock_config.mode = FreecadMode.XMLRPC
mock_config.socket_host = "localhost"
mock_config.xmlrpc_port = 9875
mock_xmlrpc_bridge = AsyncMock()
mock_xmlrpc_bridge.get_freecad_version = AsyncMock(
return_value={"version": "1.0.0", "gui_available": True}
)
with (
patch.object(server_module, "get_config", return_value=mock_config),
patch(
"freecad_mcp.bridge.xmlrpc.XmlRpcBridge",
return_value=mock_xmlrpc_bridge,
) as mock_xmlrpc_class,
):
mock_server = MagicMock()
async with server_module.lifespan(mock_server):
mock_xmlrpc_class.assert_called_once_with(host="localhost", port=9875)
mock_xmlrpc_bridge.connect.assert_called_once()
mock_xmlrpc_bridge.disconnect.assert_called_once()
@pytest.mark.asyncio
async def test_socket_mode_initialization(self):
"""Should initialize socket bridge in socket mode."""
import freecad_mcp.server as server_module
mock_config = MagicMock()
mock_config.mode = FreecadMode.SOCKET
mock_config.socket_host = "localhost"
mock_config.socket_port = 9876
mock_socket_bridge = AsyncMock()
mock_socket_bridge.get_freecad_version = AsyncMock(
return_value={"version": "1.0.0", "gui_available": True}
)
with (
patch.object(server_module, "get_config", return_value=mock_config),
patch(
"freecad_mcp.bridge.socket.SocketBridge",
return_value=mock_socket_bridge,
) as mock_socket_class,
):
mock_server = MagicMock()
async with server_module.lifespan(mock_server):
mock_socket_class.assert_called_once_with(host="localhost", port=9876)
mock_socket_bridge.connect.assert_called_once()
mock_socket_bridge.disconnect.assert_called_once()
@pytest.mark.asyncio
async def test_version_fetch_failure_logs_warning(self):
"""Should log warning if version fetch fails."""
import freecad_mcp.server as server_module
mock_config = MagicMock()
mock_config.mode = FreecadMode.EMBEDDED
mock_config.freecad_path = None
mock_bridge = AsyncMock()
mock_bridge.get_freecad_version = AsyncMock(
side_effect=Exception("Connection failed")
)
with (
patch.object(server_module, "get_config", return_value=mock_config),
patch(
"freecad_mcp.bridge.embedded.EmbeddedBridge",
return_value=mock_bridge,
),
patch.object(server_module.logger, "warning") as mock_warning,
):
mock_server = MagicMock()
async with server_module.lifespan(mock_server):
# Warning should be logged
mock_warning.assert_called_once()
assert "Could not get FreeCAD version" in str(mock_warning.call_args)
class TestRegisterAllComponents:
"""Tests for register_all_components function."""
def test_registers_tools(self):
"""Should register all tool categories."""
from freecad_mcp.server import mcp
# The function is called at module load, but we can verify
# that the mcp instance exists and has tools registered
assert mcp is not None
assert mcp.name == "freecad-mcp"
class TestMain:
"""Tests for main function."""
def test_main_prints_instance_id(self):
"""Main should print instance ID on startup."""
import freecad_mcp.server as server_module
from freecad_mcp.config import TransportType
mock_config = MagicMock()
mock_config.log_level = "INFO"
mock_config.mode = FreecadMode.EMBEDDED
mock_config.transport = TransportType.STDIO
with (
patch.object(sys, "argv", DEFAULT_ARGV),
patch.object(server_module, "get_config", return_value=mock_config),
patch.object(server_module.mcp, "run") as mock_run,
patch("builtins.print") as mock_print,
):
# Mock run to exit immediately
mock_run.return_value = None
server_module.main()
# Check that instance ID was printed
print_calls = [str(call) for call in mock_print.call_args_list]
assert any("FREECAD_MCP_INSTANCE_ID=" in call for call in print_calls)
def test_main_http_transport(self):
"""Main should start HTTP transport when configured."""
import freecad_mcp.server as server_module
from freecad_mcp.config import TransportType
mock_config = MagicMock()
mock_config.log_level = "INFO"
mock_config.mode = FreecadMode.EMBEDDED
mock_config.transport = TransportType.HTTP
mock_config.http_port = 8080
with (
patch.object(sys, "argv", DEFAULT_ARGV),
patch.object(server_module, "get_config", return_value=mock_config),
patch.object(server_module.mcp, "run") as mock_run,
patch("builtins.print"),
):
server_module.main()
# Should call run with HTTP transport settings
mock_run.assert_called_once()
call_kwargs = mock_run.call_args.kwargs
assert call_kwargs.get("transport") == "streamable-http"
assert call_kwargs.get("port") == 8080
def test_main_stdio_transport(self):
"""Main should start stdio transport by default."""
import freecad_mcp.server as server_module
from freecad_mcp.config import TransportType
mock_config = MagicMock()
mock_config.log_level = "INFO"
mock_config.mode = FreecadMode.EMBEDDED
mock_config.transport = TransportType.STDIO
with (
patch.object(sys, "argv", DEFAULT_ARGV),
patch.object(server_module, "get_config", return_value=mock_config),
patch.object(server_module.mcp, "run") as mock_run,
patch("builtins.print"),
):
server_module.main()
# Should call run without transport arguments (stdio is default)
mock_run.assert_called_once_with()