Compare commits
2 Commits
queue/321-
...
dispatch/2
| Author | SHA1 | Date | |
|---|---|---|---|
| 65b2e53440 | |||
| 4d19f9013d |
298
tests/test_skill_manager_pokayoke.py
Normal file
298
tests/test_skill_manager_pokayoke.py
Normal file
@@ -0,0 +1,298 @@
|
||||
"""Tests for poka-yoke skill edit revert and validate action."""
|
||||
|
||||
import json
|
||||
import os
|
||||
import shutil
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
from unittest.mock import patch
|
||||
|
||||
import pytest
|
||||
|
||||
|
||||
@pytest.fixture()
|
||||
def isolated_skills_dir(tmp_path, monkeypatch):
|
||||
"""Point SKILLS_DIR at a temp directory for test isolation."""
|
||||
skills_dir = tmp_path / "skills"
|
||||
skills_dir.mkdir()
|
||||
monkeypatch.setattr("tools.skill_manager_tool.SKILLS_DIR", skills_dir)
|
||||
monkeypatch.setattr("tools.skills_tool.SKILLS_DIR", skills_dir)
|
||||
# Also patch skill discovery so _find_skill and validate look in our temp dir
|
||||
monkeypatch.setattr(
|
||||
"agent.skill_utils.get_all_skills_dirs",
|
||||
lambda: [skills_dir],
|
||||
)
|
||||
return skills_dir
|
||||
|
||||
|
||||
_VALID_SKILL = """\
|
||||
---
|
||||
name: test-skill
|
||||
description: A test skill for unit tests.
|
||||
---
|
||||
|
||||
# Test Skill
|
||||
|
||||
Instructions here.
|
||||
"""
|
||||
|
||||
|
||||
def _create_test_skill(skills_dir: Path, name: str = "test-skill", content: str = _VALID_SKILL):
|
||||
skill_dir = skills_dir / name
|
||||
skill_dir.mkdir(parents=True, exist_ok=True)
|
||||
(skill_dir / "SKILL.md").write_text(content)
|
||||
return skill_dir
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# _edit_skill revert on failure
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestEditRevert:
|
||||
def test_edit_preserves_original_on_invalid_frontmatter(self, isolated_skills_dir):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
bad_content = "---\nname: test-skill\n---\n" # missing description
|
||||
result = json.loads(skill_manage("edit", "test-skill", content=bad_content))
|
||||
assert result["success"] is False
|
||||
assert "Original file preserved" in result["error"]
|
||||
# Original should be untouched
|
||||
original = (isolated_skills_dir / "test-skill" / "SKILL.md").read_text()
|
||||
assert "A test skill" in original
|
||||
|
||||
def test_edit_preserves_original_on_empty_body(self, isolated_skills_dir):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
bad_content = "---\nname: test-skill\ndescription: ok\n---\n"
|
||||
result = json.loads(skill_manage("edit", "test-skill", content=bad_content))
|
||||
assert result["success"] is False
|
||||
assert "Original file preserved" in result["error"]
|
||||
original = (isolated_skills_dir / "test-skill" / "SKILL.md").read_text()
|
||||
assert "Instructions here" in original
|
||||
|
||||
def test_edit_reverts_on_write_error(self, isolated_skills_dir, monkeypatch):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
|
||||
def boom(*a, **kw):
|
||||
raise OSError("disk full")
|
||||
|
||||
monkeypatch.setattr("tools.skill_manager_tool._atomic_write_text", boom)
|
||||
result = json.loads(skill_manage("edit", "test-skill", content=_VALID_SKILL))
|
||||
assert result["success"] is False
|
||||
assert "write error" in result["error"].lower()
|
||||
assert "Original file preserved" in result["error"]
|
||||
|
||||
def test_edit_reverts_on_security_scan_block(self, isolated_skills_dir, monkeypatch):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
monkeypatch.setattr(
|
||||
"tools.skill_manager_tool._security_scan_skill",
|
||||
lambda path: "Blocked: suspicious content",
|
||||
)
|
||||
new_content = "---\nname: test-skill\ndescription: updated\n---\n\n# Updated\n"
|
||||
result = json.loads(skill_manage("edit", "test-skill", content=new_content))
|
||||
assert result["success"] is False
|
||||
assert "Original file preserved" in result["error"]
|
||||
original = (isolated_skills_dir / "test-skill" / "SKILL.md").read_text()
|
||||
assert "A test skill" in original
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# _patch_skill revert on failure
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestPatchRevert:
|
||||
def test_patch_preserves_original_on_no_match(self, isolated_skills_dir):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
result = json.loads(skill_manage(
|
||||
"patch", "test-skill",
|
||||
old_string="NONEXISTENT_TEXT",
|
||||
new_string="replacement",
|
||||
))
|
||||
assert result["success"] is False
|
||||
assert "Original file preserved" in result["error"]
|
||||
original = (isolated_skills_dir / "test-skill" / "SKILL.md").read_text()
|
||||
assert "Instructions here" in original
|
||||
|
||||
def test_patch_preserves_original_on_broken_frontmatter(self, isolated_skills_dir):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
# Patch that would remove the frontmatter closing ---
|
||||
result = json.loads(skill_manage(
|
||||
"patch", "test-skill",
|
||||
old_string="description: A test skill for unit tests.",
|
||||
new_string="", # removing description
|
||||
))
|
||||
assert result["success"] is False
|
||||
assert "Original file preserved" in result["error"]
|
||||
original = (isolated_skills_dir / "test-skill" / "SKILL.md").read_text()
|
||||
assert "A test skill" in original
|
||||
|
||||
def test_patch_reverts_on_write_error(self, isolated_skills_dir, monkeypatch):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
|
||||
def boom(*a, **kw):
|
||||
raise OSError("disk full")
|
||||
|
||||
monkeypatch.setattr("tools.skill_manager_tool._atomic_write_text", boom)
|
||||
result = json.loads(skill_manage(
|
||||
"patch", "test-skill",
|
||||
old_string="Instructions here.",
|
||||
new_string="New instructions.",
|
||||
))
|
||||
assert result["success"] is False
|
||||
assert "write error" in result["error"].lower()
|
||||
assert "Original file preserved" in result["error"]
|
||||
|
||||
def test_patch_reverts_on_security_scan_block(self, isolated_skills_dir, monkeypatch):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
monkeypatch.setattr(
|
||||
"tools.skill_manager_tool._security_scan_skill",
|
||||
lambda path: "Blocked: malicious code",
|
||||
)
|
||||
result = json.loads(skill_manage(
|
||||
"patch", "test-skill",
|
||||
old_string="Instructions here.",
|
||||
new_string="New instructions.",
|
||||
))
|
||||
assert result["success"] is False
|
||||
assert "Original file preserved" in result["error"]
|
||||
original = (isolated_skills_dir / "test-skill" / "SKILL.md").read_text()
|
||||
assert "Instructions here" in original
|
||||
|
||||
def test_patch_successful_writes_new_content(self, isolated_skills_dir):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
result = json.loads(skill_manage(
|
||||
"patch", "test-skill",
|
||||
old_string="Instructions here.",
|
||||
new_string="Updated instructions.",
|
||||
))
|
||||
assert result["success"] is True
|
||||
content = (isolated_skills_dir / "test-skill" / "SKILL.md").read_text()
|
||||
assert "Updated instructions" in content
|
||||
assert "Instructions here" not in content
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# _write_file revert on failure
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestWriteFileRevert:
|
||||
def test_write_file_reverts_on_security_scan_block(self, isolated_skills_dir, monkeypatch):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
monkeypatch.setattr(
|
||||
"tools.skill_manager_tool._security_scan_skill",
|
||||
lambda path: "Blocked: malicious",
|
||||
)
|
||||
result = json.loads(skill_manage(
|
||||
"write_file", "test-skill",
|
||||
file_path="references/notes.md",
|
||||
file_content="# Some notes",
|
||||
))
|
||||
assert result["success"] is False
|
||||
assert "Original file preserved" in result["error"]
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# validate action
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestValidateAction:
|
||||
def test_validate_passes_on_good_skill(self, isolated_skills_dir):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
result = json.loads(skill_manage("validate", "test-skill"))
|
||||
assert result["success"] is True
|
||||
assert result["errors"] == 0
|
||||
assert result["results"][0]["valid"] is True
|
||||
|
||||
def test_validate_finds_missing_description(self, isolated_skills_dir):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
bad = "---\nname: bad-skill\n---\n\nBody here.\n"
|
||||
_create_test_skill(isolated_skills_dir, name="bad-skill", content=bad)
|
||||
result = json.loads(skill_manage("validate", "bad-skill"))
|
||||
assert result["success"] is False
|
||||
assert result["errors"] == 1
|
||||
issues = result["results"][0]["issues"]
|
||||
assert any("description" in i.lower() for i in issues)
|
||||
|
||||
def test_validate_finds_empty_body(self, isolated_skills_dir):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
empty_body = "---\nname: empty-skill\ndescription: test\n---\n"
|
||||
_create_test_skill(isolated_skills_dir, name="empty-skill", content=empty_body)
|
||||
result = json.loads(skill_manage("validate", "empty-skill"))
|
||||
assert result["success"] is False
|
||||
issues = result["results"][0]["issues"]
|
||||
assert any("empty body" in i.lower() for i in issues)
|
||||
|
||||
def test_validate_all_skills(self, isolated_skills_dir):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
_create_test_skill(isolated_skills_dir, name="good-1")
|
||||
_create_test_skill(isolated_skills_dir, name="good-2")
|
||||
bad = "---\nname: bad\n---\n\nBody.\n"
|
||||
_create_test_skill(isolated_skills_dir, name="bad", content=bad)
|
||||
|
||||
result = json.loads(skill_manage("validate", ""))
|
||||
assert result["total"] == 3
|
||||
assert result["errors"] == 1
|
||||
|
||||
def test_validate_nonexistent_skill(self, isolated_skills_dir):
|
||||
from tools.skill_manager_tool import skill_manage
|
||||
|
||||
result = json.loads(skill_manage("validate", "nonexistent"))
|
||||
assert result["success"] is False
|
||||
assert "not found" in result["error"].lower()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Modification log
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestModificationLog:
|
||||
def test_edit_logs_on_success(self, isolated_skills_dir):
|
||||
from tools.skill_manager_tool import skill_manage, _MOD_LOG_FILE
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
new = "---\nname: test-skill\ndescription: updated\n---\n\n# Updated\n"
|
||||
skill_manage("edit", "test-skill", content=new)
|
||||
assert _MOD_LOG_FILE.exists()
|
||||
lines = _MOD_LOG_FILE.read_text().strip().split("\n")
|
||||
entry = json.loads(lines[-1])
|
||||
assert entry["action"] == "edit"
|
||||
assert entry["success"] is True
|
||||
assert entry["skill"] == "test-skill"
|
||||
|
||||
def test_patch_logs_on_failure(self, isolated_skills_dir):
|
||||
from tools.skill_manager_tool import skill_manage, _MOD_LOG_FILE
|
||||
|
||||
_create_test_skill(isolated_skills_dir)
|
||||
monkeypatch = None # just use no-match to trigger failure
|
||||
skill_manage(
|
||||
"patch", "test-skill",
|
||||
old_string="NONEXISTENT",
|
||||
new_string="replacement",
|
||||
)
|
||||
# Failure before write — no log entry expected since file never changed
|
||||
# But the failure path in patch returns early before logging
|
||||
# (the log only fires on write-side errors, not match errors)
|
||||
# This is correct behavior — no write happened, nothing to log
|
||||
@@ -40,10 +40,55 @@ import shutil
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
from hermes_constants import get_hermes_home
|
||||
from typing import Dict, Any, Optional
|
||||
from typing import Dict, Any, Optional, Tuple
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
# Skill modification log file — stores before/after snapshots for audit trail
|
||||
_MOD_LOG_DIR = get_hermes_home() / "cron" / "output"
|
||||
_MOD_LOG_FILE = get_hermes_home() / "skills" / ".modification_log.jsonl"
|
||||
|
||||
|
||||
def _log_skill_modification(
|
||||
action: str,
|
||||
skill_name: str,
|
||||
target_file: str,
|
||||
original_content: str,
|
||||
new_content: str,
|
||||
success: bool,
|
||||
error: str = None,
|
||||
) -> None:
|
||||
"""Log a skill modification with before/after snapshot for audit trail.
|
||||
|
||||
Appends JSONL entries to ~/.hermes/skills/.modification_log.jsonl.
|
||||
Failures in logging are silently swallowed — logging must never
|
||||
break the primary operation.
|
||||
"""
|
||||
try:
|
||||
import time
|
||||
entry = {
|
||||
"timestamp": time.time(),
|
||||
"action": action,
|
||||
"skill": skill_name,
|
||||
"file": target_file,
|
||||
"success": success,
|
||||
"original_len": len(original_content) if original_content else 0,
|
||||
"new_len": len(new_content) if new_content else 0,
|
||||
}
|
||||
if error:
|
||||
entry["error"] = error
|
||||
# Truncate snapshots to 2KB each for log hygiene
|
||||
if original_content:
|
||||
entry["original_preview"] = original_content[:2048]
|
||||
if new_content:
|
||||
entry["new_preview"] = new_content[:2048]
|
||||
|
||||
_MOD_LOG_FILE.parent.mkdir(parents=True, exist_ok=True)
|
||||
with open(_MOD_LOG_FILE, "a", encoding="utf-8") as f:
|
||||
f.write(json.dumps(entry, ensure_ascii=False) + "\n")
|
||||
except Exception:
|
||||
logger.debug("Failed to write skill modification log", exc_info=True)
|
||||
|
||||
# Import security scanner — agent-created skills get the same scrutiny as
|
||||
# community hub installs.
|
||||
try:
|
||||
@@ -92,11 +137,6 @@ VALID_NAME_RE = re.compile(r'^[a-z0-9][a-z0-9._-]*$')
|
||||
ALLOWED_SUBDIRS = {"references", "templates", "scripts", "assets"}
|
||||
|
||||
|
||||
def check_skill_manage_requirements() -> bool:
|
||||
"""Skill management has no external requirements -- always available."""
|
||||
return True
|
||||
|
||||
|
||||
# =============================================================================
|
||||
# Validation helpers
|
||||
# =============================================================================
|
||||
@@ -224,13 +264,15 @@ def _validate_file_path(file_path: str) -> Optional[str]:
|
||||
Validate a file path for write_file/remove_file.
|
||||
Must be under an allowed subdirectory and not escape the skill dir.
|
||||
"""
|
||||
from tools.path_security import has_traversal_component
|
||||
|
||||
if not file_path:
|
||||
return "file_path is required."
|
||||
|
||||
normalized = Path(file_path)
|
||||
|
||||
# Prevent path traversal
|
||||
if ".." in normalized.parts:
|
||||
if has_traversal_component(file_path):
|
||||
return "Path traversal ('..') is not allowed."
|
||||
|
||||
# Must be under an allowed subdirectory
|
||||
@@ -245,6 +287,17 @@ def _validate_file_path(file_path: str) -> Optional[str]:
|
||||
return None
|
||||
|
||||
|
||||
def _resolve_skill_target(skill_dir: Path, file_path: str) -> Tuple[Optional[Path], Optional[str]]:
|
||||
"""Resolve a supporting-file path and ensure it stays within the skill directory."""
|
||||
from tools.path_security import validate_within_dir
|
||||
|
||||
target = skill_dir / file_path
|
||||
error = validate_within_dir(target, skill_dir)
|
||||
if error:
|
||||
return None, error
|
||||
return target, None
|
||||
|
||||
|
||||
def _atomic_write_text(file_path: Path, content: str, encoding: str = "utf-8") -> None:
|
||||
"""
|
||||
Atomically write text content to a file.
|
||||
@@ -339,31 +392,45 @@ def _create_skill(name: str, content: str, category: str = None) -> Dict[str, An
|
||||
|
||||
|
||||
def _edit_skill(name: str, content: str) -> Dict[str, Any]:
|
||||
"""Replace the SKILL.md of any existing skill (full rewrite)."""
|
||||
"""Replace the SKILL.md of any existing skill (full rewrite).
|
||||
|
||||
Poka-yoke: validates before writing, uses atomic write, and reverts
|
||||
to the original file on any failure.
|
||||
"""
|
||||
err = _validate_frontmatter(content)
|
||||
if err:
|
||||
return {"success": False, "error": err}
|
||||
return {"success": False, "error": f"Edit failed: {err} Original file preserved."}
|
||||
|
||||
err = _validate_content_size(content)
|
||||
if err:
|
||||
return {"success": False, "error": err}
|
||||
return {"success": False, "error": f"Edit failed: {err} Original file preserved."}
|
||||
|
||||
existing = _find_skill(name)
|
||||
if not existing:
|
||||
return {"success": False, "error": f"Skill '{name}' not found. Use skills_list() to see available skills."}
|
||||
|
||||
skill_md = existing["path"] / "SKILL.md"
|
||||
# Back up original content for rollback
|
||||
# Snapshot original for rollback
|
||||
original_content = skill_md.read_text(encoding="utf-8") if skill_md.exists() else None
|
||||
_atomic_write_text(skill_md, content)
|
||||
|
||||
try:
|
||||
_atomic_write_text(skill_md, content)
|
||||
except Exception as exc:
|
||||
_log_skill_modification("edit", name, "SKILL.md", original_content, content, False, str(exc))
|
||||
return {
|
||||
"success": False,
|
||||
"error": f"Edit failed: write error: {exc}. Original file preserved.",
|
||||
}
|
||||
|
||||
# Security scan — roll back on block
|
||||
scan_error = _security_scan_skill(existing["path"])
|
||||
if scan_error:
|
||||
if original_content is not None:
|
||||
_atomic_write_text(skill_md, original_content)
|
||||
return {"success": False, "error": scan_error}
|
||||
_log_skill_modification("edit", name, "SKILL.md", original_content, content, False, scan_error)
|
||||
return {"success": False, "error": f"Edit failed: {scan_error} Original file preserved."}
|
||||
|
||||
_log_skill_modification("edit", name, "SKILL.md", original_content, content, True)
|
||||
return {
|
||||
"success": True,
|
||||
"message": f"Skill '{name}' updated.",
|
||||
@@ -380,6 +447,9 @@ def _patch_skill(
|
||||
) -> Dict[str, Any]:
|
||||
"""Targeted find-and-replace within a skill file.
|
||||
|
||||
Poka-yoke: validates old_string matches BEFORE writing, validates the
|
||||
result AFTER matching but BEFORE writing, and reverts on any failure.
|
||||
|
||||
Defaults to SKILL.md. Use file_path to patch a supporting file instead.
|
||||
Requires a unique match unless replace_all is True.
|
||||
"""
|
||||
@@ -399,7 +469,9 @@ def _patch_skill(
|
||||
err = _validate_file_path(file_path)
|
||||
if err:
|
||||
return {"success": False, "error": err}
|
||||
target = skill_dir / file_path
|
||||
target, err = _resolve_skill_target(skill_dir, file_path)
|
||||
if err:
|
||||
return {"success": False, "error": err}
|
||||
else:
|
||||
# Patching SKILL.md
|
||||
target = skill_dir / "SKILL.md"
|
||||
@@ -415,7 +487,7 @@ def _patch_skill(
|
||||
# from exact-match failures on minor formatting mismatches.
|
||||
from tools.fuzzy_match import fuzzy_find_and_replace
|
||||
|
||||
new_content, match_count, match_error = fuzzy_find_and_replace(
|
||||
new_content, match_count, _strategy, match_error = fuzzy_find_and_replace(
|
||||
content, old_string, new_string, replace_all
|
||||
)
|
||||
if match_error:
|
||||
@@ -423,7 +495,7 @@ def _patch_skill(
|
||||
preview = content[:500] + ("..." if len(content) > 500 else "")
|
||||
return {
|
||||
"success": False,
|
||||
"error": match_error,
|
||||
"error": f"Patch failed: {match_error} Original file preserved.",
|
||||
"file_preview": preview,
|
||||
}
|
||||
|
||||
@@ -431,7 +503,7 @@ def _patch_skill(
|
||||
target_label = "SKILL.md" if not file_path else file_path
|
||||
err = _validate_content_size(new_content, label=target_label)
|
||||
if err:
|
||||
return {"success": False, "error": err}
|
||||
return {"success": False, "error": f"Patch failed: {err} Original file preserved."}
|
||||
|
||||
# If patching SKILL.md, validate frontmatter is still intact
|
||||
if not file_path:
|
||||
@@ -439,18 +511,27 @@ def _patch_skill(
|
||||
if err:
|
||||
return {
|
||||
"success": False,
|
||||
"error": f"Patch would break SKILL.md structure: {err}",
|
||||
"error": f"Patch failed: would break SKILL.md structure: {err} Original file preserved.",
|
||||
}
|
||||
|
||||
original_content = content # for rollback
|
||||
_atomic_write_text(target, new_content)
|
||||
try:
|
||||
_atomic_write_text(target, new_content)
|
||||
except Exception as exc:
|
||||
_log_skill_modification("patch", name, target_label, original_content, new_content, False, str(exc))
|
||||
return {
|
||||
"success": False,
|
||||
"error": f"Patch failed: write error: {exc}. Original file preserved.",
|
||||
}
|
||||
|
||||
# Security scan — roll back on block
|
||||
scan_error = _security_scan_skill(skill_dir)
|
||||
if scan_error:
|
||||
_atomic_write_text(target, original_content)
|
||||
return {"success": False, "error": scan_error}
|
||||
_log_skill_modification("patch", name, target_label, original_content, new_content, False, scan_error)
|
||||
return {"success": False, "error": f"Patch failed: {scan_error} Original file preserved."}
|
||||
|
||||
_log_skill_modification("patch", name, target_label, original_content, new_content, True)
|
||||
return {
|
||||
"success": True,
|
||||
"message": f"Patched {'SKILL.md' if not file_path else file_path} in skill '{name}' ({match_count} replacement{'s' if match_count > 1 else ''}).",
|
||||
@@ -478,7 +559,10 @@ def _delete_skill(name: str) -> Dict[str, Any]:
|
||||
|
||||
|
||||
def _write_file(name: str, file_path: str, file_content: str) -> Dict[str, Any]:
|
||||
"""Add or overwrite a supporting file within any skill directory."""
|
||||
"""Add or overwrite a supporting file within any skill directory.
|
||||
|
||||
Poka-yoke: reverts to original on failure.
|
||||
"""
|
||||
err = _validate_file_path(file_path)
|
||||
if err:
|
||||
return {"success": False, "error": err}
|
||||
@@ -499,17 +583,27 @@ def _write_file(name: str, file_path: str, file_content: str) -> Dict[str, Any]:
|
||||
}
|
||||
err = _validate_content_size(file_content, label=file_path)
|
||||
if err:
|
||||
return {"success": False, "error": err}
|
||||
return {"success": False, "error": f"Write failed: {err} Original file preserved."}
|
||||
|
||||
existing = _find_skill(name)
|
||||
if not existing:
|
||||
return {"success": False, "error": f"Skill '{name}' not found. Create it first with action='create'."}
|
||||
|
||||
target = existing["path"] / file_path
|
||||
target, err = _resolve_skill_target(existing["path"], file_path)
|
||||
if err:
|
||||
return {"success": False, "error": err}
|
||||
target.parent.mkdir(parents=True, exist_ok=True)
|
||||
# Back up for rollback
|
||||
# Snapshot for rollback
|
||||
original_content = target.read_text(encoding="utf-8") if target.exists() else None
|
||||
_atomic_write_text(target, file_content)
|
||||
|
||||
try:
|
||||
_atomic_write_text(target, file_content)
|
||||
except Exception as exc:
|
||||
_log_skill_modification("write_file", name, file_path, original_content, file_content, False, str(exc))
|
||||
return {
|
||||
"success": False,
|
||||
"error": f"Write failed: {exc}. Original file preserved.",
|
||||
}
|
||||
|
||||
# Security scan — roll back on block
|
||||
scan_error = _security_scan_skill(existing["path"])
|
||||
@@ -518,8 +612,10 @@ def _write_file(name: str, file_path: str, file_content: str) -> Dict[str, Any]:
|
||||
_atomic_write_text(target, original_content)
|
||||
else:
|
||||
target.unlink(missing_ok=True)
|
||||
return {"success": False, "error": scan_error}
|
||||
_log_skill_modification("write_file", name, file_path, original_content, file_content, False, scan_error)
|
||||
return {"success": False, "error": f"Write failed: {scan_error} Original file preserved."}
|
||||
|
||||
_log_skill_modification("write_file", name, file_path, original_content, file_content, True)
|
||||
return {
|
||||
"success": True,
|
||||
"message": f"File '{file_path}' written to skill '{name}'.",
|
||||
@@ -538,7 +634,9 @@ def _remove_file(name: str, file_path: str) -> Dict[str, Any]:
|
||||
return {"success": False, "error": f"Skill '{name}' not found."}
|
||||
skill_dir = existing["path"]
|
||||
|
||||
target = skill_dir / file_path
|
||||
target, err = _resolve_skill_target(skill_dir, file_path)
|
||||
if err:
|
||||
return {"success": False, "error": err}
|
||||
if not target.exists():
|
||||
# List what's actually there for the model to see
|
||||
available = []
|
||||
@@ -554,6 +652,8 @@ def _remove_file(name: str, file_path: str) -> Dict[str, Any]:
|
||||
"available_files": available if available else None,
|
||||
}
|
||||
|
||||
# Snapshot for potential undo
|
||||
removed_content = target.read_text(encoding="utf-8")
|
||||
target.unlink()
|
||||
|
||||
# Clean up empty subdirectories
|
||||
@@ -561,12 +661,96 @@ def _remove_file(name: str, file_path: str) -> Dict[str, Any]:
|
||||
if parent != skill_dir and parent.exists() and not any(parent.iterdir()):
|
||||
parent.rmdir()
|
||||
|
||||
_log_skill_modification("remove_file", name, file_path, removed_content, None, True)
|
||||
return {
|
||||
"success": True,
|
||||
"message": f"File '{file_path}' removed from skill '{name}'.",
|
||||
}
|
||||
|
||||
|
||||
def _validate_skill(name: str = None) -> Dict[str, Any]:
|
||||
"""Validate one or all skills for structural integrity.
|
||||
|
||||
Checks: valid YAML frontmatter, non-empty body, required fields
|
||||
(name, description), and file readability.
|
||||
|
||||
Pass name=None to validate all skills.
|
||||
"""
|
||||
from agent.skill_utils import get_all_skills_dirs
|
||||
|
||||
results = []
|
||||
errors = 0
|
||||
|
||||
dirs_to_scan = get_all_skills_dirs()
|
||||
for skills_dir in dirs_to_scan:
|
||||
if not skills_dir.exists():
|
||||
continue
|
||||
for skill_md in skills_dir.rglob("SKILL.md"):
|
||||
skill_name = skill_md.parent.name
|
||||
if name and skill_name != name:
|
||||
continue
|
||||
|
||||
issues = []
|
||||
try:
|
||||
content = skill_md.read_text(encoding="utf-8")
|
||||
except Exception as exc:
|
||||
issues.append(f"Cannot read file: {exc}")
|
||||
results.append({"skill": skill_name, "path": str(skill_md), "valid": False, "issues": issues})
|
||||
errors += 1
|
||||
continue
|
||||
|
||||
# Check frontmatter
|
||||
fm_err = _validate_frontmatter(content)
|
||||
if fm_err:
|
||||
issues.append(fm_err)
|
||||
|
||||
# Check YAML parse and required fields
|
||||
if content.startswith("---"):
|
||||
import re as _re
|
||||
end_match = _re.search(r'\n---\s*\n', content[3:])
|
||||
if end_match:
|
||||
yaml_content = content[3:end_match.start() + 3]
|
||||
try:
|
||||
parsed = yaml.safe_load(yaml_content)
|
||||
if isinstance(parsed, dict):
|
||||
if not parsed.get("name"):
|
||||
issues.append("Missing 'name' in frontmatter")
|
||||
if not parsed.get("description"):
|
||||
issues.append("Missing 'description' in frontmatter")
|
||||
else:
|
||||
issues.append("Frontmatter is not a YAML mapping")
|
||||
except yaml.YAMLError as e:
|
||||
issues.append(f"YAML parse error: {e}")
|
||||
else:
|
||||
issues.append("Frontmatter not properly closed")
|
||||
else:
|
||||
issues.append("File does not start with YAML frontmatter (---)")
|
||||
|
||||
# Check body is non-empty
|
||||
if content.startswith("---"):
|
||||
import re as _re
|
||||
end_match = _re.search(r'\n---\s*\n', content[3:])
|
||||
if end_match:
|
||||
body = content[end_match.end() + 3:].strip()
|
||||
if not body:
|
||||
issues.append("Empty body after frontmatter")
|
||||
|
||||
valid = len(issues) == 0
|
||||
if not valid:
|
||||
errors += 1
|
||||
results.append({"skill": skill_name, "path": str(skill_md), "valid": valid, "issues": issues})
|
||||
|
||||
if name and not results:
|
||||
return {"success": False, "error": f"Skill '{name}' not found."}
|
||||
|
||||
return {
|
||||
"success": errors == 0,
|
||||
"total": len(results),
|
||||
"errors": errors,
|
||||
"results": results,
|
||||
}
|
||||
|
||||
|
||||
# =============================================================================
|
||||
# Main entry point
|
||||
# =============================================================================
|
||||
@@ -589,19 +773,19 @@ def skill_manage(
|
||||
"""
|
||||
if action == "create":
|
||||
if not content:
|
||||
return json.dumps({"success": False, "error": "content is required for 'create'. Provide the full SKILL.md text (frontmatter + body)."}, ensure_ascii=False)
|
||||
return tool_error("content is required for 'create'. Provide the full SKILL.md text (frontmatter + body).", success=False)
|
||||
result = _create_skill(name, content, category)
|
||||
|
||||
elif action == "edit":
|
||||
if not content:
|
||||
return json.dumps({"success": False, "error": "content is required for 'edit'. Provide the full updated SKILL.md text."}, ensure_ascii=False)
|
||||
return tool_error("content is required for 'edit'. Provide the full updated SKILL.md text.", success=False)
|
||||
result = _edit_skill(name, content)
|
||||
|
||||
elif action == "patch":
|
||||
if not old_string:
|
||||
return json.dumps({"success": False, "error": "old_string is required for 'patch'. Provide the text to find."}, ensure_ascii=False)
|
||||
return tool_error("old_string is required for 'patch'. Provide the text to find.", success=False)
|
||||
if new_string is None:
|
||||
return json.dumps({"success": False, "error": "new_string is required for 'patch'. Use empty string to delete matched text."}, ensure_ascii=False)
|
||||
return tool_error("new_string is required for 'patch'. Use empty string to delete matched text.", success=False)
|
||||
result = _patch_skill(name, old_string, new_string, file_path, replace_all)
|
||||
|
||||
elif action == "delete":
|
||||
@@ -609,18 +793,21 @@ def skill_manage(
|
||||
|
||||
elif action == "write_file":
|
||||
if not file_path:
|
||||
return json.dumps({"success": False, "error": "file_path is required for 'write_file'. Example: 'references/api-guide.md'"}, ensure_ascii=False)
|
||||
return tool_error("file_path is required for 'write_file'. Example: 'references/api-guide.md'", success=False)
|
||||
if file_content is None:
|
||||
return json.dumps({"success": False, "error": "file_content is required for 'write_file'."}, ensure_ascii=False)
|
||||
return tool_error("file_content is required for 'write_file'.", success=False)
|
||||
result = _write_file(name, file_path, file_content)
|
||||
|
||||
elif action == "remove_file":
|
||||
if not file_path:
|
||||
return json.dumps({"success": False, "error": "file_path is required for 'remove_file'."}, ensure_ascii=False)
|
||||
return tool_error("file_path is required for 'remove_file'.", success=False)
|
||||
result = _remove_file(name, file_path)
|
||||
|
||||
elif action == "validate":
|
||||
result = _validate_skill(name if name else None)
|
||||
|
||||
else:
|
||||
result = {"success": False, "error": f"Unknown action '{action}'. Use: create, edit, patch, delete, write_file, remove_file"}
|
||||
result = {"success": False, "error": f"Unknown action '{action}'. Use: create, edit, patch, delete, write_file, remove_file, validate"}
|
||||
|
||||
if result.get("success"):
|
||||
try:
|
||||
@@ -638,38 +825,40 @@ def skill_manage(
|
||||
|
||||
SKILL_MANAGE_SCHEMA = {
|
||||
"name": "skill_manage",
|
||||
"description": (
|
||||
"Manage skills (create, update, delete). Skills are your procedural "
|
||||
"memory — reusable approaches for recurring task types. "
|
||||
"New skills go to ~/.hermes/skills/; existing skills can be modified wherever they live.\n\n"
|
||||
"Actions: create (full SKILL.md + optional category), "
|
||||
"patch (old_string/new_string — preferred for fixes), "
|
||||
"edit (full SKILL.md rewrite — major overhauls only), "
|
||||
"delete, write_file, remove_file.\n\n"
|
||||
"Create when: complex task succeeded (5+ calls), errors overcome, "
|
||||
"user-corrected approach worked, non-trivial workflow discovered, "
|
||||
"or user asks you to remember a procedure.\n"
|
||||
"Update when: instructions stale/wrong, OS-specific failures, "
|
||||
"missing steps or pitfalls found during use. "
|
||||
"If you used a skill and hit issues not covered by it, patch it immediately.\n\n"
|
||||
"After difficult/iterative tasks, offer to save as a skill. "
|
||||
"Skip for simple one-offs. Confirm with user before creating/deleting.\n\n"
|
||||
"Good skills: trigger conditions, numbered steps with exact commands, "
|
||||
"pitfalls section, verification steps. Use skill_view() to see format examples."
|
||||
),
|
||||
"description": (
|
||||
"Manage skills (create, update, delete, validate). Skills are your procedural "
|
||||
"memory \u2014 reusable approaches for recurring task types. "
|
||||
"New skills go to ~/.hermes/skills/; existing skills can be modified wherever they live.\n\n"
|
||||
"Actions: create (full SKILL.md + optional category), "
|
||||
"patch (old_string/new_string \u2014 preferred for fixes), "
|
||||
"edit (full SKILL.md rewrite \u2014 major overhauls only), "
|
||||
"delete, write_file, remove_file, "
|
||||
"validate (check all skills for structural integrity).\n\n"
|
||||
"Create when: complex task succeeded (5+ calls), errors overcome, "
|
||||
"user-corrected approach worked, non-trivial workflow discovered, "
|
||||
"or user asks you to remember a procedure.\n"
|
||||
"Update when: instructions stale/wrong, OS-specific failures, "
|
||||
"missing steps or pitfalls found during use. "
|
||||
"If you used a skill and hit issues not covered by it, patch it immediately.\n\n"
|
||||
"After difficult/iterative tasks, offer to save as a skill. "
|
||||
"Skip for simple one-offs. Confirm with user before creating/deleting.\n\n"
|
||||
"Good skills: trigger conditions, numbered steps with exact commands, "
|
||||
"pitfalls section, verification steps. Use skill_view() to see format examples."
|
||||
),
|
||||
"parameters": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"action": {
|
||||
"type": "string",
|
||||
"enum": ["create", "patch", "edit", "delete", "write_file", "remove_file"],
|
||||
"enum": ["create", "patch", "edit", "delete", "write_file", "remove_file", "validate"],
|
||||
"description": "The action to perform."
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": (
|
||||
"Skill name (lowercase, hyphens/underscores, max 64 chars). "
|
||||
"Must match an existing skill for patch/edit/delete/write_file/remove_file."
|
||||
"Required for create/patch/edit/delete/write_file/remove_file. "
|
||||
"Optional for validate: omit to check all skills, provide to check one."
|
||||
)
|
||||
},
|
||||
"content": {
|
||||
@@ -727,7 +916,7 @@ SKILL_MANAGE_SCHEMA = {
|
||||
|
||||
|
||||
# --- Registry ---
|
||||
from tools.registry import registry
|
||||
from tools.registry import registry, tool_error
|
||||
|
||||
registry.register(
|
||||
name="skill_manage",
|
||||
|
||||
Reference in New Issue
Block a user