mirror of
https://mirror.skon.top/github.com/cft0808/edict
synced 2026-04-21 05:10:27 +08:00
260d5c9f9c
Two new test cases in test_sync_symlinks.py: 1. TestSyncScriptSymlink.test_skips_self_referential_via_directory_symlink Unit test: verifies _sync_script_symlink() returns False and leaves the real source file intact when dst_file is accessed through a directory-level symlink that points back to the project scripts/ dir. 2. TestSyncScriptsToWorkspaces.test_no_self_referential_symlinks_when_workspace_scripts_is_dir_symlink Integration test: simulates the install.sh scenario where workspace-main/scripts -> project/scripts, then confirms that sync_scripts_to_workspaces() does not convert any real source file into a self-referential symlink."
228 lines
9.0 KiB
Python
228 lines
9.0 KiB
Python
"""Tests for symlink-based script sync (fix for issue #56).
|
|
|
|
Verifies that ``sync_scripts_to_workspaces()`` creates symlinks instead of
|
|
physical copies, so ``__file__`` in workspace scripts resolves back to the
|
|
project ``scripts/`` directory.
|
|
"""
|
|
import os
|
|
import pathlib
|
|
import sys
|
|
import types
|
|
|
|
import pytest
|
|
|
|
# ── Bootstrap: make scripts/ importable ──────────────────────────
|
|
SCRIPTS = pathlib.Path(__file__).resolve().parent.parent / 'scripts'
|
|
sys.path.insert(0, str(SCRIPTS))
|
|
|
|
import sync_agent_config as sac # noqa: E402
|
|
|
|
|
|
# ────────────────────────────────────────────────────────────────
|
|
# Helper: patch BASE, _SOUL_DEPLOY_MAP, HOME to isolate tests
|
|
# ────────────────────────────────────────────────────────────────
|
|
|
|
@pytest.fixture
|
|
def project(tmp_path, monkeypatch):
|
|
"""Set up a minimal fake project tree and home dir."""
|
|
proj = tmp_path / 'project'
|
|
scripts = proj / 'scripts'
|
|
scripts.mkdir(parents=True)
|
|
data = proj / 'data'
|
|
data.mkdir()
|
|
(data / 'tasks_source.json').write_text('[]')
|
|
|
|
home = tmp_path / 'home'
|
|
home.mkdir()
|
|
|
|
# Create a couple of dummy scripts
|
|
(scripts / 'kanban_update.py').write_text('# kanban\n')
|
|
(scripts / 'refresh_live_data.py').write_text('# refresh\n')
|
|
(scripts / '__init__.py').write_text('') # should be skipped
|
|
|
|
# Patch module-level state
|
|
monkeypatch.setattr(sac, 'BASE', proj)
|
|
monkeypatch.setattr(sac, '_SOUL_DEPLOY_MAP', {'agent-a': 'aaa'})
|
|
monkeypatch.setattr(pathlib.Path, 'home', staticmethod(lambda: home))
|
|
|
|
return types.SimpleNamespace(root=proj, scripts=scripts, data=data, home=home)
|
|
|
|
|
|
# ── Tests ────────────────────────────────────────────────────────
|
|
|
|
class TestSyncScriptSymlink:
|
|
"""Unit tests for the helper ``_sync_script_symlink``."""
|
|
|
|
def test_creates_symlink(self, tmp_path):
|
|
src = tmp_path / 'src.py'
|
|
src.write_text('hello')
|
|
dst = tmp_path / 'dst.py'
|
|
|
|
created = sac._sync_script_symlink(src, dst)
|
|
|
|
assert created is True
|
|
assert dst.is_symlink()
|
|
assert dst.resolve() == src.resolve()
|
|
assert dst.read_text() == 'hello'
|
|
|
|
def test_idempotent_when_up_to_date(self, tmp_path):
|
|
src = tmp_path / 'src.py'
|
|
src.write_text('hello')
|
|
dst = tmp_path / 'dst.py'
|
|
|
|
sac._sync_script_symlink(src, dst)
|
|
created = sac._sync_script_symlink(src, dst)
|
|
|
|
assert created is False # already correct
|
|
|
|
def test_replaces_physical_copy(self, tmp_path):
|
|
"""A pre-existing physical copy should be replaced with a symlink."""
|
|
src = tmp_path / 'src.py'
|
|
src.write_text('v2')
|
|
dst = tmp_path / 'dst.py'
|
|
dst.write_text('v1') # physical copy, not a symlink
|
|
|
|
created = sac._sync_script_symlink(src, dst)
|
|
|
|
assert created is True
|
|
assert dst.is_symlink()
|
|
assert dst.resolve() == src.resolve()
|
|
|
|
def test_replaces_broken_symlink(self, tmp_path):
|
|
src = tmp_path / 'src.py'
|
|
src.write_text('ok')
|
|
dst = tmp_path / 'dst.py'
|
|
os.symlink('/no/such/file', dst) # broken link
|
|
|
|
created = sac._sync_script_symlink(src, dst)
|
|
|
|
assert created is True
|
|
assert dst.is_symlink()
|
|
assert dst.resolve() == src.resolve()
|
|
|
|
def test_skips_self_referential_via_directory_symlink(self, tmp_path):
|
|
"""Regression test for the bug where install.sh creates
|
|
workspace/scripts -> project/scripts (directory-level symlink).
|
|
|
|
When dst_file is accessed through a directory symlink that points back
|
|
to the same directory as src_file, dst_file.resolve() == src_resolved.
|
|
The function must detect this and return False without touching the file.
|
|
"""
|
|
# Simulate project/scripts/ with a real Python file
|
|
proj_scripts = tmp_path / 'project' / 'scripts'
|
|
proj_scripts.mkdir(parents=True)
|
|
real_file = proj_scripts / 'foo.py'
|
|
real_file.write_text('# real content\n')
|
|
|
|
# Simulate install.sh: workspace/scripts -> project/scripts
|
|
ws_scripts = tmp_path / 'workspace-main' / 'scripts'
|
|
ws_scripts.parent.mkdir(parents=True)
|
|
os.symlink(proj_scripts, ws_scripts) # directory-level symlink
|
|
|
|
# dst_file goes through the directory symlink
|
|
dst_file = ws_scripts / 'foo.py'
|
|
|
|
created = sac._sync_script_symlink(real_file, dst_file)
|
|
|
|
assert created is False, 'should skip when dst resolves to same real path as src'
|
|
assert real_file.is_file() and not real_file.is_symlink(), (
|
|
'src file must not be deleted or converted to a self-referential symlink'
|
|
)
|
|
assert real_file.read_text() == '# real content\n', 'src file content must be unchanged'
|
|
|
|
|
|
class TestSyncScriptsToWorkspaces:
|
|
"""Integration tests for the full ``sync_scripts_to_workspaces`` flow."""
|
|
|
|
def test_creates_symlinks_in_workspace(self, project):
|
|
sac.sync_scripts_to_workspaces()
|
|
|
|
ws = project.home / '.openclaw' / 'workspace-aaa' / 'scripts'
|
|
assert ws.is_dir()
|
|
|
|
kb = ws / 'kanban_update.py'
|
|
assert kb.is_symlink(), 'expected symlink, got physical file'
|
|
assert kb.resolve() == (project.scripts / 'kanban_update.py').resolve()
|
|
|
|
rf = ws / 'refresh_live_data.py'
|
|
assert rf.is_symlink()
|
|
|
|
def test_skips_dunder_files(self, project):
|
|
sac.sync_scripts_to_workspaces()
|
|
|
|
ws = project.home / '.openclaw' / 'workspace-aaa' / 'scripts'
|
|
assert not (ws / '__init__.py').exists()
|
|
|
|
def test_legacy_workspace_main(self, project):
|
|
sac.sync_scripts_to_workspaces()
|
|
|
|
ws_main = project.home / '.openclaw' / 'workspace-main' / 'scripts'
|
|
assert ws_main.is_dir()
|
|
|
|
kb = ws_main / 'kanban_update.py'
|
|
assert kb.is_symlink()
|
|
assert kb.resolve() == (project.scripts / 'kanban_update.py').resolve()
|
|
|
|
def test_idempotent_rerun(self, project):
|
|
sac.sync_scripts_to_workspaces()
|
|
sac.sync_scripts_to_workspaces() # second run should be a no-op
|
|
|
|
ws = project.home / '.openclaw' / 'workspace-aaa' / 'scripts'
|
|
kb = ws / 'kanban_update.py'
|
|
assert kb.is_symlink()
|
|
|
|
def test_replaces_old_physical_copies(self, project):
|
|
"""Simulate pre-existing physical copies (old behaviour) and verify
|
|
they get replaced by symlinks on the next sync run."""
|
|
ws = project.home / '.openclaw' / 'workspace-aaa' / 'scripts'
|
|
ws.mkdir(parents=True, exist_ok=True)
|
|
old_copy = ws / 'kanban_update.py'
|
|
old_copy.write_text('# stale physical copy')
|
|
|
|
sac.sync_scripts_to_workspaces()
|
|
|
|
assert old_copy.is_symlink(), 'old physical copy should be replaced'
|
|
assert old_copy.resolve() == (project.scripts / 'kanban_update.py').resolve()
|
|
|
|
def test_file_resolves_to_project_root(self, project):
|
|
"""The whole point of #56: __file__ should resolve to project scripts/,
|
|
so Path(__file__).resolve().parent.parent == project root."""
|
|
sac.sync_scripts_to_workspaces()
|
|
|
|
ws = project.home / '.openclaw' / 'workspace-aaa' / 'scripts'
|
|
ws_script = ws / 'kanban_update.py'
|
|
|
|
# Simulate what kanban_update.py does at import time
|
|
resolved = ws_script.resolve()
|
|
computed_base = resolved.parent.parent
|
|
assert computed_base == project.root, (
|
|
f'Expected {project.root}, got {computed_base}; '
|
|
'symlink should resolve __file__ back to project root'
|
|
)
|
|
|
|
def test_no_self_referential_symlinks_when_workspace_scripts_is_dir_symlink(
|
|
self, project, monkeypatch
|
|
):
|
|
"""Regression test for GitHub issue #217.
|
|
|
|
install.sh creates workspace-main/scripts as a directory-level symlink
|
|
pointing to the project scripts/ dir. sync_scripts_to_workspaces()
|
|
must not delete the real source files and create self-referential links.
|
|
"""
|
|
# Make workspace-main/scripts a directory symlink back to project scripts/
|
|
ws_main = project.home / '.openclaw' / 'workspace-main'
|
|
ws_main.mkdir(parents=True, exist_ok=True)
|
|
ws_main_scripts = ws_main / 'scripts'
|
|
os.symlink(project.scripts, ws_main_scripts) # directory-level symlink
|
|
|
|
sac.sync_scripts_to_workspaces()
|
|
|
|
# Source files must still be real files with their original content
|
|
for script in project.scripts.iterdir():
|
|
if script.suffix in ('.py', '.sh') and not script.stem.startswith('__'):
|
|
assert not script.is_symlink(), (
|
|
f'{script.name} was converted to a symlink — '
|
|
'self-referential symlink bug has regressed'
|
|
)
|
|
assert script.stat().st_size > 0, f'{script.name} content was lost'
|