Skip to content

fix(sandbox): let later overlay tools replace earlier packages #1604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
josescuderoh wants to merge 1 commit into
base: main
Choose a base branch
from
+84 −7
Open

fix(sandbox): let later overlay tools replace earlier packages #1604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions services/sandbox/install_tool_shims.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,11 +156,13 @@ def _copy_published_tools(tool_dir: Path, published: Path) -> None:
if tool_name in blocklist:
continue
if tool_name in existing:
previous = existing[tool_name]
print(
f"skipping duplicate tool {tool_name}: {package_dir} conflicts with {existing[tool_name]}",
f"shadowing tool {tool_name}: {package_dir} replaces {previous}",
file=sys.stderr,
)
continue
if previous.exists() or previous.is_symlink():
_remove_path(previous)
relative_package_dir = package_dir.relative_to(published)
target = tool_dir / relative_package_dir
if target.exists() or target.is_symlink():
Expand Down
85 changes: 80 additions & 5 deletions services/sandbox/test_install_tool_shims.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@


class CopyPublishedToolsTest(unittest.TestCase):
def test_copies_tool_dirs_and_skips_duplicate_names(self) -> None:
def test_copies_tool_dirs_and_later_source_replaces_duplicate_names(self) -> None:
with tempfile.TemporaryDirectory() as tmp:
root = Path(tmp)
published = root / "published"
Expand All @@ -41,15 +41,38 @@ def test_copies_tool_dirs_and_skips_duplicate_names(self) -> None:
(target / "research" / "sensortower" / "pyproject.toml").read_text(),
"base\n",
)
self.assertIn("skipping duplicate tool websearch", stderr.getvalue())
self.assertIn("shadowing tool websearch", stderr.getvalue())
self.assertEqual(
(target / "research" / "websearch" / "pyproject.toml").read_text(),
"old project\n",
"new project\n",
)
self.assertEqual((target / "research" / "websearch" / "old.py").read_text(), "old\n")
self.assertFalse((target / "research" / "websearch" / "new.py").exists())
self.assertFalse((target / "research" / "websearch" / "old.py").exists())
self.assertEqual((target / "research" / "websearch" / "new.py").read_text(), "new\n")
self.assertEqual((target / "research" / "company" / "pyproject.toml").read_text(), "company\n")

def test_later_source_replaces_duplicate_in_a_different_category(self) -> None:
with tempfile.TemporaryDirectory() as tmp:
root = Path(tmp)
published = root / "published"
target = root / "target"

(target / "observability" / "datadog").mkdir(parents=True)
(target / "observability" / "datadog" / "pyproject.toml").write_text("base\n")
(target / "observability" / "datadog" / "base.py").write_text("base\n")

(published / "datadog").mkdir(parents=True)
(published / "datadog" / "pyproject.toml").write_text("overlay\n")
(published / "datadog" / "overlay.py").write_text("overlay\n")

stderr = io.StringIO()
with contextlib.redirect_stderr(stderr):
install_tool_shims._copy_published_tools(target, published)

self.assertIn("shadowing tool datadog", stderr.getvalue())
self.assertFalse((target / "observability" / "datadog").exists())
self.assertEqual((target / "datadog" / "pyproject.toml").read_text(), "overlay\n")
self.assertEqual((target / "datadog" / "overlay.py").read_text(), "overlay\n")

def test_tool_allowlist_restricts_installed_tools(self) -> None:
with tempfile.TemporaryDirectory() as tmp:
root = Path(tmp)
Expand Down Expand Up @@ -390,6 +413,58 @@ def test_call_runner_loads_hyphenated_tool_as_normalized_package(self) -> None:


class RefreshInstallTest(unittest.TestCase):
def test_refresh_later_source_replaces_earlier_package(self) -> None:
with tempfile.TemporaryDirectory() as tmp:
root = Path(tmp)
dest = root / "dest"
dest.mkdir()
(dest / install_tool_shims.TOOLS_METADATA_NAME).write_text(
json.dumps(
{
"sources": [
{
"source": "repo_cache",
"repo": "paradigmxyz/centaur",
"repo_cache_repo_path": str(root / "base"),
"source_subdir": "tools",
},
{
"source": "repo_cache",
"repo": "example/overlay",
"repo_cache_repo_path": str(root / "overlay"),
"source_subdir": "tools",
},
]
}
)
+ "\n"
)

base_pkg = root / "base" / "tools" / "observability" / "datadog"
base_pkg.mkdir(parents=True)
(base_pkg / "pyproject.toml").write_text(
'[project]\nname = "datadog"\n\n[project.scripts]\ndatadog = "datadog.cli:app"\n'
)
(base_pkg / "base.py").write_text("base\n")

overlay_pkg = root / "overlay" / "tools" / "datadog"
overlay_pkg.mkdir(parents=True)
(overlay_pkg / "pyproject.toml").write_text(
'[project]\nname = "datadog"\n\n[project.scripts]\ndatadog = "datadog.cli:app"\n'
)
(overlay_pkg / "overlay.py").write_text("overlay\n")

stderr = io.StringIO()
with contextlib.redirect_stderr(stderr):
self.assertTrue(install_tool_shims._refresh_tool_dir(dest))

self.assertIn("shadowing tool datadog", stderr.getvalue())
self.assertFalse((dest / "observability" / "datadog").exists())
self.assertEqual((dest / "datadog" / "overlay.py").read_text(), "overlay\n")
scripts = install_tool_shims._discover_scripts([dest])
self.assertEqual(scripts["datadog"]["project_dir"], str(dest / "datadog"))
self.assertEqual(scripts["datadog"]["package"], "datadog")

def test_install_removes_stale_generated_shims(self) -> None:
with tempfile.TemporaryDirectory() as tmp:
root = Path(tmp)
Expand Down