mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-09-14 16:08:41 +00:00
* fix(skills): accept portable frontmatter forms * fix(skills): normalize portable tool names * Safely preserve parenthesized portable skill tool patterns Portable Agent Skills declarations such as Bash(tvly *) contain spaces inside a command pattern. Keep those patterns as single literal entries while preserving exact names from the existing YAML-list form, so skill loading no longer fragments valid metadata or rewrites mixed-case MCP tools. Constraint: DeerFlow's current skill policy matches exact tool names and does not inspect Bash arguments Constraint: Agent Skills scalar syntax uses whitespace-separated entries with parenthesized command patterns Rejected: raw.split() | fragments Bash(tvly *) into unrelated tool names Rejected: normalize YAML-list entries | breaks case-sensitive MCP/runtime tool names Rejected: map Bash(...) to bash | broadens command-scoped declarations into unrestricted shell access Confidence: high Scope-risk: narrow Reversibility: clean Directive: Keep Bash(...) entries literal and inactive until DeerFlow has an explicit command-pattern authorization model Tested: 175 focused parser, validation, installer, review, loader, and tool-policy tests; Ruff check and format; compileall; git diff --check Not-tested: Full backend suite stopped at pre-existing Windows mode assertion test_runtime_config_store_file_is_owner_only Related: #4912 * Preserve exact custom tool names in portable skill parsing Portable scalar frontmatter needs alias normalization for known DeerFlow-compatible names, but generic case conversion corrupts MCP and custom tool identifiers. The tokenizer also treated quoted or escaped parentheses as structural delimiters, rejecting valid command patterns. Preserve unknown names and parse quoted or escaped patterns without broadening Bash(...) into bash. Constraint: Runtime skill policy uses exact tool-name matching Constraint: Parenthesized patterns remain literal because argument-level authorization is not implemented Rejected: Generic CamelCase-to-snake_case for every scalar | rewrites custom/MCP names Rejected: Map Bash(...) to bash | broadens command-scoped declarations into unrestricted shell access Confidence: high Scope-risk: narrow Reversibility: clean Directive: Add an explicit alias before supporting another portable tool name; keep command-pattern authorization separate Tested: 225 skills tests passed, 1 skipped; Ruff check; Ruff format --check; compileall; git diff --check Not-tested: Full backend suite remains affected by unrelated Windows permissions/path and missing Lark CLI tests Related: #4984; #4912 * Preserve case-sensitive exact tool authorities Case-folding a scalar declaration before alias lookup can turn literal write into write_file, substituting a different runtime authority. Keep exact portable spellings as aliases and preserve lowercase, custom, and MCP names; strengthen activation coverage for spaced Bash patterns and command fragments. Constraint: Runtime skill policy uses exact tool-name matching Constraint: Bash(...) remains literal and inactive because command-pattern authorization is not implemented Rejected: Case-insensitive alias lookup | maps lowercase runtime tools onto built-in authorities Rejected: Broaden the parser into command-pattern authorization | outside this PR's scope Confidence: high Scope-risk: narrow Reversibility: clean Directive: Add aliases only for documented portable spellings; preserve all other scalar names verbatim Tested: 226 skills tests passed, 1 skipped; Ruff check; Ruff format --check; compileall; git diff --check Not-tested: Full backend suite remains affected by unrelated Windows permissions/path and missing Lark CLI tests; GitNexus index refresh remains stale Related: #4984; #5016297602 * Support portable Glob and Grep skill aliases Portable Agent Skills commonly declare Glob and Grep, but DeerFlow exposes the runtime tools as glob and grep. Add explicit exact-spelling aliases and activation coverage so imported skills retain search-tool access without broad normalization. Constraint: Runtime skill policy uses exact tool-name matching Constraint: Alias conversion is limited to documented portable spellings Rejected: Case-fold all scalar names | can substitute custom or MCP authorities Rejected: Map arbitrary names by convention | breaks exact runtime compatibility Confidence: high Scope-risk: narrow Reversibility: clean Directive: Keep the alias table explicit and preserve unknown scalar names verbatim Tested: 228 skills tests passed, 1 skipped; Ruff check; Ruff format --check; compileall; git diff --check Not-tested: Full backend suite has unrelated environment failures on Windows; GitNexus index reports stale line mappings Related: #4984; #5026257899 --------- Co-authored-by: kriptoburak <kriptoburak@users.noreply.github.com>
154 lines
6.2 KiB
Python
154 lines
6.2 KiB
Python
"""Tests for recursive skills loading."""
|
|
|
|
from pathlib import Path
|
|
from types import SimpleNamespace
|
|
|
|
import pytest
|
|
|
|
from deerflow.config.skills_config import SkillsConfig
|
|
from deerflow.skills.storage import get_or_new_skill_storage
|
|
from deerflow.skills.storage.local_skill_storage import LocalSkillStorage
|
|
|
|
|
|
def _write_skill(skill_dir: Path, name: str, description: str) -> None:
|
|
"""Write a minimal SKILL.md for tests."""
|
|
skill_dir.mkdir(parents=True, exist_ok=True)
|
|
content = f"---\nname: {name}\ndescription: {description}\n---\n\n# {name}\n"
|
|
(skill_dir / "SKILL.md").write_text(content, encoding="utf-8")
|
|
|
|
|
|
def test_get_skills_root_path_points_to_current_project_skills(tmp_path: Path, monkeypatch):
|
|
"""get_skills_root_path() should point to the caller project skills directory."""
|
|
monkeypatch.delenv("DEER_FLOW_SKILLS_PATH", raising=False)
|
|
monkeypatch.delenv("DEER_FLOW_PROJECT_ROOT", raising=False)
|
|
monkeypatch.chdir(tmp_path)
|
|
(tmp_path / "skills").mkdir()
|
|
|
|
app_config = SimpleNamespace(skills=SkillsConfig())
|
|
path = get_or_new_skill_storage(app_config=app_config).get_skills_root_path()
|
|
assert path == tmp_path / "skills"
|
|
|
|
|
|
def test_get_skills_root_path_honors_env_override(tmp_path: Path, monkeypatch):
|
|
"""DEER_FLOW_SKILLS_PATH should override the caller project skills directory."""
|
|
skills_root = tmp_path / "team-skills"
|
|
monkeypatch.setenv("DEER_FLOW_SKILLS_PATH", str(skills_root))
|
|
|
|
app_config = SimpleNamespace(skills=SkillsConfig())
|
|
path = get_or_new_skill_storage(app_config=app_config).get_skills_root_path()
|
|
assert path == skills_root
|
|
|
|
|
|
def test_load_skills_discovers_nested_skills_and_sets_container_paths(tmp_path: Path):
|
|
"""Nested skills should be discovered recursively with correct container paths."""
|
|
skills_root = tmp_path / "skills"
|
|
|
|
_write_skill(skills_root / "public" / "root-skill", "root-skill", "Root skill")
|
|
_write_skill(skills_root / "public" / "parent" / "child-skill", "child-skill", "Child skill")
|
|
_write_skill(skills_root / "custom" / "team" / "helper", "team-helper", "Team helper")
|
|
|
|
skills = get_or_new_skill_storage(skills_path=skills_root).load_skills(enabled_only=False)
|
|
by_name = {skill.name: skill for skill in skills}
|
|
|
|
assert {"root-skill", "child-skill", "team-helper"} <= set(by_name)
|
|
|
|
root_skill = by_name["root-skill"]
|
|
child_skill = by_name["child-skill"]
|
|
team_skill = by_name["team-helper"]
|
|
|
|
assert root_skill.skill_path == "root-skill"
|
|
assert root_skill.get_container_file_path() == "/mnt/skills/public/root-skill/SKILL.md"
|
|
|
|
assert child_skill.skill_path == "parent/child-skill"
|
|
assert child_skill.get_container_file_path() == "/mnt/skills/public/parent/child-skill/SKILL.md"
|
|
|
|
assert team_skill.skill_path == "team/helper"
|
|
assert team_skill.get_container_file_path() == "/mnt/skills/custom/team/helper/SKILL.md"
|
|
|
|
|
|
def test_local_storage_accepts_external_custom_skill_directory_symlink(tmp_path: Path):
|
|
skills_root = tmp_path / "skills"
|
|
external_file = tmp_path / "external-skills" / "external-skill" / "SKILL.md"
|
|
external_file.parent.mkdir(parents=True)
|
|
external_file.write_text("---\nname: external-skill\ndescription: An external skill\n---\n", encoding="utf-8")
|
|
|
|
linked_dir = skills_root / "custom" / "external-skill"
|
|
linked_file = linked_dir / "SKILL.md"
|
|
linked_dir.parent.mkdir(parents=True)
|
|
try:
|
|
linked_dir.symlink_to(external_file.parent, target_is_directory=True)
|
|
except OSError as exc:
|
|
if getattr(exc, "winerror", None) == 1314:
|
|
pytest.skip("Windows symlink creation requires SeCreateSymbolicLinkPrivilege")
|
|
raise
|
|
|
|
storage = LocalSkillStorage(host_path=str(skills_root))
|
|
|
|
assert storage.validate_skill_file_path(linked_file) == external_file
|
|
|
|
|
|
def test_load_skills_discovers_parenthesized_portable_allowed_tools(tmp_path: Path):
|
|
skills_root = tmp_path / "skills"
|
|
skill_dir = skills_root / "custom" / "tavily-cli"
|
|
skill_dir.mkdir(parents=True)
|
|
(skill_dir / "SKILL.md").write_text(
|
|
"---\nname: tavily-cli\ndescription: Tavily CLI\nallowed-tools: Bash(tvly *)\n---\n\n# Tavily CLI\n",
|
|
encoding="utf-8",
|
|
)
|
|
|
|
skills = get_or_new_skill_storage(skills_path=skills_root).load_skills(enabled_only=False)
|
|
|
|
skill = next(skill for skill in skills if skill.name == "tavily-cli")
|
|
assert skill.allowed_tools == ("Bash(tvly *)",)
|
|
|
|
|
|
def test_load_skills_stops_at_skill_package_boundary(tmp_path: Path):
|
|
"""SKILL.md files inside an existing skill package are support data, not skills."""
|
|
skills_root = tmp_path / "skills"
|
|
|
|
_write_skill(skills_root / "public" / "reviewer", "reviewer", "Reviews skills")
|
|
_write_skill(
|
|
skills_root / "public" / "reviewer" / "evals" / "fixtures" / "injection",
|
|
"injection-example",
|
|
"Calibration fixture",
|
|
)
|
|
_write_skill(
|
|
skills_root / "public" / "reviewer" / "examples" / "helper",
|
|
"nested-example",
|
|
"Nested package example",
|
|
)
|
|
|
|
skills = get_or_new_skill_storage(skills_path=skills_root).load_skills(enabled_only=False)
|
|
|
|
assert {skill.name for skill in skills} == {"reviewer"}
|
|
|
|
|
|
def test_load_skills_skips_hidden_directories(tmp_path: Path):
|
|
"""Hidden directories should be excluded from recursive discovery."""
|
|
skills_root = tmp_path / "skills"
|
|
|
|
_write_skill(skills_root / "public" / "visible" / "ok-skill", "ok-skill", "Visible skill")
|
|
_write_skill(
|
|
skills_root / "public" / "visible" / ".hidden" / "secret-skill",
|
|
"secret-skill",
|
|
"Hidden skill",
|
|
)
|
|
|
|
skills = get_or_new_skill_storage(skills_path=skills_root).load_skills(enabled_only=False)
|
|
names = {skill.name for skill in skills}
|
|
|
|
assert "ok-skill" in names
|
|
assert "secret-skill" not in names
|
|
|
|
|
|
def test_load_skills_prefers_custom_over_public_with_same_name(tmp_path: Path):
|
|
skills_root = tmp_path / "skills"
|
|
_write_skill(skills_root / "public" / "shared-skill", "shared-skill", "Public version")
|
|
_write_skill(skills_root / "custom" / "shared-skill", "shared-skill", "Custom version")
|
|
|
|
skills = get_or_new_skill_storage(skills_path=skills_root).load_skills(enabled_only=False)
|
|
shared = next(skill for skill in skills if skill.name == "shared-skill")
|
|
|
|
assert shared.category == "custom"
|
|
assert shared.description == "Custom version"
|