Files
freecad-robust-mcp-fc111/just/freecad.just
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

204 lines
7.8 KiB
Plaintext

# FreeCAD workbench and macro commands
# Usage: just freecad::run-gui, just freecad::install-workbench, etc.
# Project root directory (justfile_directory() returns the main justfile's directory)
project_root := justfile_directory()
# =============================================================================
# Running FreeCAD with MCP Bridge
# =============================================================================
# Run MCP bridge server in FreeCAD headless mode (blocking)
run-headless:
#!/usr/bin/env bash
set -euo pipefail
PROJECT_DIR="{{project_root}}"
# Use the blocking bridge script from the addon directory (source of truth)
SCRIPT_PATH="${PROJECT_DIR}/addon/FreecadRobustMCP/freecad_mcp_bridge/blocking_bridge.py"
# Find FreeCADCmd executable based on OS
FREECAD_CMD=""
if [[ "$OSTYPE" == "darwin"* ]]; then
# macOS: Check common locations
if [[ -x "/Applications/FreeCAD.app/Contents/Resources/bin/freecadcmd" ]]; then
FREECAD_CMD="/Applications/FreeCAD.app/Contents/Resources/bin/freecadcmd"
elif [[ -x "$HOME/Applications/FreeCAD.app/Contents/Resources/bin/freecadcmd" ]]; then
FREECAD_CMD="$HOME/Applications/FreeCAD.app/Contents/Resources/bin/freecadcmd"
fi
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
# Linux: Check common locations and PATH
if command -v freecadcmd &> /dev/null; then
FREECAD_CMD="freecadcmd"
elif command -v FreeCADCmd &> /dev/null; then
FREECAD_CMD="FreeCADCmd"
elif [[ -x "/usr/bin/freecadcmd" ]]; then
FREECAD_CMD="/usr/bin/freecadcmd"
elif [[ -x "/usr/local/bin/freecadcmd" ]]; then
FREECAD_CMD="/usr/local/bin/freecadcmd"
elif [[ -x "/opt/freecad/bin/FreeCADCmd" ]]; then
FREECAD_CMD="/opt/freecad/bin/FreeCADCmd"
fi
else
# Windows: Check common locations
if [[ -x "$PROGRAMFILES/FreeCAD 1.0/bin/FreeCADCmd.exe" ]]; then
FREECAD_CMD="$PROGRAMFILES/FreeCAD 1.0/bin/FreeCADCmd.exe"
elif [[ -x "$PROGRAMFILES/FreeCAD/bin/FreeCADCmd.exe" ]]; then
FREECAD_CMD="$PROGRAMFILES/FreeCAD/bin/FreeCADCmd.exe"
fi
fi
if [[ -z "$FREECAD_CMD" ]]; then
echo "ERROR: FreeCADCmd not found!"
echo ""
echo "Please install FreeCAD or set FREECAD_CMD environment variable:"
echo " export FREECAD_CMD=/path/to/FreeCADCmd"
echo " just freecad::run-headless"
echo ""
echo "Common locations:"
echo " macOS: /Applications/FreeCAD.app/Contents/Resources/bin/freecadcmd"
echo " Linux: /usr/bin/freecadcmd or freecadcmd"
echo " Windows: C:\\Program Files\\FreeCAD 1.0\\bin\\FreeCADCmd.exe"
exit 1
fi
echo "Using FreeCAD: $FREECAD_CMD"
echo ""
# Run FreeCADCmd with the blocking bridge script
"$FREECAD_CMD" "$SCRIPT_PATH"
# Run MCP bridge with custom FreeCAD path (blocking)
run-headless-custom freecad_cmd:
#!/usr/bin/env bash
set -euo pipefail
PROJECT_DIR="{{project_root}}"
SCRIPT_PATH="${PROJECT_DIR}/addon/FreecadRobustMCP/freecad_mcp_bridge/blocking_bridge.py"
if [[ ! -x "{{freecad_cmd}}" ]]; then
echo "ERROR: FreeCADCmd not found or not executable: {{freecad_cmd}}"
exit 1
fi
echo "Using FreeCAD: {{freecad_cmd}}"
echo ""
# Run FreeCADCmd with the blocking bridge script
"{{freecad_cmd}}" "$SCRIPT_PATH"
# Run FreeCAD GUI with MCP bridge (uses local source code for development)
# Note: Uses default ports (XML-RPC: 9875, Socket: 9876) regardless of workbench
# preferences. For custom ports, use the workbench GUI instead.
run-gui:
#!/usr/bin/env bash
set -euo pipefail
PROJECT_DIR="{{project_root}}"
# Use the shared startup script from the addon directory
STARTUP_SCRIPT="${PROJECT_DIR}/addon/FreecadRobustMCP/freecad_mcp_bridge/startup_bridge.py"
if [[ ! -f "$STARTUP_SCRIPT" ]]; then
echo "ERROR: Startup script not found: $STARTUP_SCRIPT"
exit 1
fi
# Find FreeCAD GUI executable based on OS
FREECAD_GUI=""
if [[ "$OSTYPE" == "darwin"* ]]; then
# macOS: Use 'open' command for .app bundles
if [[ -d "/Applications/FreeCAD.app" ]]; then
FREECAD_GUI="/Applications/FreeCAD.app"
elif [[ -d "$HOME/Applications/FreeCAD.app" ]]; then
FREECAD_GUI="$HOME/Applications/FreeCAD.app"
fi
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
# Linux: Check common locations and PATH
if command -v freecad &> /dev/null; then
FREECAD_GUI="freecad"
elif command -v FreeCAD &> /dev/null; then
FREECAD_GUI="FreeCAD"
elif [[ -x "/usr/bin/freecad" ]]; then
FREECAD_GUI="/usr/bin/freecad"
elif [[ -x "/usr/local/bin/freecad" ]]; then
FREECAD_GUI="/usr/local/bin/freecad"
elif [[ -x "/opt/freecad/bin/FreeCAD" ]]; then
FREECAD_GUI="/opt/freecad/bin/FreeCAD"
fi
else
# Windows: Check common locations
if [[ -x "$PROGRAMFILES/FreeCAD 1.0/bin/FreeCAD.exe" ]]; then
FREECAD_GUI="$PROGRAMFILES/FreeCAD 1.0/bin/FreeCAD.exe"
elif [[ -x "$PROGRAMFILES/FreeCAD/bin/FreeCAD.exe" ]]; then
FREECAD_GUI="$PROGRAMFILES/FreeCAD/bin/FreeCAD.exe"
fi
fi
if [[ -z "$FREECAD_GUI" ]]; then
echo "ERROR: FreeCAD not found!"
echo ""
echo "Please install FreeCAD or use:"
echo " just freecad::run-gui-custom /path/to/FreeCAD"
echo ""
echo "Common locations:"
echo " macOS: /Applications/FreeCAD.app"
echo " Linux: /usr/bin/freecad or freecad"
echo " Windows: C:\\Program Files\\FreeCAD 1.0\\bin\\FreeCAD.exe"
exit 1
fi
echo "Starting FreeCAD with MCP bridge..."
echo "Using FreeCAD: $FREECAD_GUI"
echo ""
# Launch FreeCAD with the startup script
if [[ "$OSTYPE" == "darwin"* ]]; then
# macOS: Use 'open' with --args to pass the script
open -a "$FREECAD_GUI" --args "$STARTUP_SCRIPT"
else
# Linux/Windows: Run directly with script as argument
"$FREECAD_GUI" "$STARTUP_SCRIPT" &
fi
echo "FreeCAD is starting..."
echo "The MCP bridge will start automatically once FreeCAD initializes."
echo ""
echo "Note: You can now start/restart your MCP client (Claude Code, etc.) to connect."
# Run FreeCAD GUI with custom path
run-gui-custom freecad_path:
#!/usr/bin/env bash
set -euo pipefail
PROJECT_DIR="{{project_root}}"
# Use the shared startup script from the addon directory
STARTUP_SCRIPT="${PROJECT_DIR}/addon/FreecadRobustMCP/freecad_mcp_bridge/startup_bridge.py"
if [[ ! -f "$STARTUP_SCRIPT" ]]; then
echo "ERROR: Startup script not found: $STARTUP_SCRIPT"
exit 1
fi
echo "Starting FreeCAD with MCP bridge..."
echo "Using FreeCAD: {{freecad_path}}"
echo ""
if [[ "$OSTYPE" == "darwin"* ]] && [[ "{{freecad_path}}" == *.app ]]; then
open -a "{{freecad_path}}" --args "$STARTUP_SCRIPT"
else
"{{freecad_path}}" "$STARTUP_SCRIPT" &
fi
echo "FreeCAD is starting with MCP bridge..."
# =============================================================================
# Deprecated Aliases (use install:: module instead)
# =============================================================================
# These are kept for backwards compatibility but will be removed in a future version.
# Use the new install:: module commands instead:
# just install::macro-cut (was: just freecad::install-cut-macro)
# just install::macro-export (was: just freecad::install-export-macro)
# just install::macro-all (was: just freecad::install-all-macros)
# just install::mcp-bridge-workbench (was: just freecad::install-workbench)
# just install::status (was: just freecad::mcp-status)