mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-22 15:25:09 +00:00
f0704ebb22
* feat(skills)!: promote Skills Repository out of experimental The registry-backed Skills Repository (crewai skill create/publish/ install/list, @org/name refs, global cache) is now mainline: - CLI: `crewai skill ...` is a top-level group; the CREWAI_EXPERIMENTAL gate and the now-empty `crewai experimental` group are removed. - Runtime: registry.py, cache.py, and events.py move from crewai.experimental.skills into crewai.skills next to the loader; the require_experimental_skills() gate is gone. crewai.experimental.skills remains as a deprecated re-export shim. - Docs: concepts/skills now leads with the CLI workflow and documents the create -> publish -> install lifecycle. Linear: n/a (requested promotion) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * feat(skills): org-scoped publish only + docs in all languages Skills are always scoped to the publishing organization, like tools: drop the --public/--private flags from `crewai skill publish` and always send is_public=False to the registry. CLI tests assert the flag is rejected and the API never receives a public publish. Translate the new CLI-first Quick Start and the create -> publish -> install lifecycle section into ar, pt-BR, and ko concepts/skills docs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(skills): address review comments on the promotion PR - Back-compat shim now aliases the old submodules in sys.modules so `crewai.experimental.skills.registry/cache/events` imports (and patch targets) resolve to the real crewai.skills modules, not just the package-root re-exports. - `crewai skill publish` actually enforces the git-state check that --force claims to skip: unsynced repos block publishing (mirroring tool publish); standalone skill dirs outside any git repo publish without a check. - Explicit UTF-8 encoding on SKILL.md and cache-metadata reads/writes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(skills): fail closed when git state cannot be validated on publish Follow deploy's pattern: construct git.Repository(fetch=False) and only treat "not a Git repository" as skippable — any other git error (fetch/auth/misconfiguration) now blocks publish with a --force escape hatch instead of silently bypassing the sync check. Also single-style imports in the shim test (CodeQL) with the dotted shim import covered via importlib. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(skills): fetch before sync check on publish; bump mcp past advisories Publish now refreshes remote-tracking refs (repository.fetch()) before is_synced(), so ahead/behind is judged against the actual remote rather than stale local refs; a failing fetch blocks publish with the --force escape hatch. Adds a fail-closed test for fetch errors. Raise mcp to >=1.28.1,<2 (locks 1.28.1): the ~=1.26.0 pin blocked GHSA-hvrp-rf83-w775 / GHSA-jpw9-pfvf-9f58 (fixed 1.27.2) and GHSA-vj7q-gjh5-988w (fixed 1.28.1), which were failing pip-audit on this PR. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Vinicius Brasil <vini@hey.com>
272 lines
11 KiB
Python
272 lines
11 KiB
Python
"""Tests for SkillCommand CLI."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import io
|
|
import os
|
|
import tempfile
|
|
import zipfile
|
|
from contextlib import contextmanager
|
|
from datetime import datetime, timedelta
|
|
from pathlib import Path
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import pytest
|
|
|
|
from crewai_cli.shared.token_manager import TokenManager
|
|
|
|
|
|
@contextmanager
|
|
def in_temp_dir():
|
|
original = os.getcwd()
|
|
with tempfile.TemporaryDirectory() as td:
|
|
os.chdir(td)
|
|
try:
|
|
yield td
|
|
finally:
|
|
os.chdir(original)
|
|
|
|
|
|
@pytest.fixture
|
|
def skill_command():
|
|
with tempfile.TemporaryDirectory() as temp_dir:
|
|
with patch.object(
|
|
TokenManager, "_get_secure_storage_path", return_value=Path(temp_dir)
|
|
):
|
|
TokenManager().save_tokens(
|
|
"test-token", (datetime.now() + timedelta(seconds=36000)).timestamp()
|
|
)
|
|
from crewai_cli.skills.main import SkillCommand
|
|
cmd = SkillCommand()
|
|
yield cmd
|
|
|
|
|
|
class TestSkillCreate:
|
|
def test_create_in_project(self, skill_command, tmp_path):
|
|
with in_temp_dir():
|
|
Path("pyproject.toml").write_text("[tool.poetry]\nname = 'test'\n")
|
|
skill_command.create("my-skill")
|
|
assert Path("skills/my-skill/SKILL.md").exists()
|
|
assert Path("skills/my-skill/scripts").is_dir()
|
|
assert Path("skills/my-skill/references").is_dir()
|
|
assert Path("skills/my-skill/assets").is_dir()
|
|
|
|
def test_create_outside_project(self, skill_command, tmp_path):
|
|
with in_temp_dir():
|
|
skill_command.create("standalone-skill", in_project=False)
|
|
assert Path("standalone-skill/SKILL.md").exists()
|
|
|
|
def test_create_adds_name_to_skill_md(self, skill_command):
|
|
with in_temp_dir():
|
|
skill_command.create("hello-world", in_project=False)
|
|
content = Path("hello-world/SKILL.md").read_text()
|
|
assert "name: hello-world" in content
|
|
assert "version: 0.1.0" in content
|
|
|
|
def test_create_fails_if_dir_exists(self, skill_command):
|
|
with in_temp_dir():
|
|
Path("existing-skill").mkdir()
|
|
with pytest.raises(SystemExit):
|
|
skill_command.create("existing-skill", in_project=False)
|
|
|
|
|
|
class TestSkillInstall:
|
|
def _zip_skill(self, name: str) -> bytes:
|
|
buf = io.BytesIO()
|
|
with zipfile.ZipFile(buf, "w") as zf:
|
|
zf.writestr("SKILL.md", f"---\nname: {name}\ndescription: Test.\n---\nInstructions.")
|
|
return buf.getvalue()
|
|
|
|
def test_install_invalid_ref_no_at(self, skill_command):
|
|
with pytest.raises(SystemExit):
|
|
skill_command.install("acme/my-skill")
|
|
|
|
def test_install_invalid_ref_no_slash(self, skill_command):
|
|
with pytest.raises(SystemExit):
|
|
skill_command.install("@acmeskill")
|
|
|
|
def test_install_404(self, skill_command):
|
|
mock_resp = MagicMock()
|
|
mock_resp.status_code = 404
|
|
skill_command.plus_api_client.get_skill = MagicMock(return_value=mock_resp)
|
|
|
|
with pytest.raises(SystemExit):
|
|
skill_command.install("@acme/ghost")
|
|
|
|
def test_install_in_project(self, skill_command):
|
|
import base64
|
|
archive = self._zip_skill("my-skill")
|
|
encoded = "data:application/zip;base64," + base64.b64encode(archive).decode()
|
|
|
|
mock_resp = MagicMock()
|
|
mock_resp.status_code = 200
|
|
mock_resp.json.return_value = {"file": encoded, "version": "1.0.0"}
|
|
skill_command.plus_api_client.get_skill = MagicMock(return_value=mock_resp)
|
|
|
|
with in_temp_dir():
|
|
Path("pyproject.toml").write_text("[tool]\n")
|
|
skill_command.install("@acme/my-skill")
|
|
assert Path("skills/my-skill/SKILL.md").exists()
|
|
|
|
|
|
class TestSkillPublish:
|
|
def test_publish_no_skill_md(self, skill_command):
|
|
with in_temp_dir():
|
|
with pytest.raises(SystemExit):
|
|
skill_command.publish(org="acme")
|
|
|
|
def test_publish_missing_version(self, skill_command):
|
|
with in_temp_dir():
|
|
Path("SKILL.md").write_text(
|
|
"---\nname: my-skill\ndescription: Test.\n---\nInstructions."
|
|
)
|
|
with pytest.raises(SystemExit):
|
|
skill_command.publish(org="acme")
|
|
|
|
def test_publish_missing_name(self, skill_command):
|
|
with in_temp_dir():
|
|
Path("SKILL.md").write_text(
|
|
"---\ndescription: Test.\nversion: 1.0.0\n---\nInstructions."
|
|
)
|
|
with pytest.raises(SystemExit):
|
|
skill_command.publish(org="acme")
|
|
|
|
def test_publish_no_org(self, skill_command):
|
|
with in_temp_dir():
|
|
Path("SKILL.md").write_text(
|
|
"---\nname: my-skill\nversion: 1.0.0\ndescription: Test.\n---\nInstructions."
|
|
)
|
|
with patch.object(skill_command, "plus_api_client") as mock_client:
|
|
mock_resp = MagicMock()
|
|
mock_resp.is_success = True
|
|
mock_resp.status_code = 200
|
|
mock_resp.json.return_value = {}
|
|
mock_client.publish_skill.return_value = mock_resp
|
|
with patch("crewai_cli.skills.main.Settings") as mock_settings_cls:
|
|
mock_settings_cls.return_value.org_name = None
|
|
mock_settings_cls.return_value.enterprise_base_url = None
|
|
with pytest.raises(SystemExit):
|
|
skill_command.publish(org=None)
|
|
|
|
def test_publish_calls_api(self, skill_command):
|
|
with in_temp_dir():
|
|
Path("SKILL.md").write_text(
|
|
"---\nname: my-skill\ndescription: A test skill.\nmetadata:\n version: 1.0.0\n---\nInstructions."
|
|
)
|
|
mock_resp = MagicMock()
|
|
mock_resp.is_success = True
|
|
mock_resp.status_code = 200
|
|
mock_resp.json.return_value = {}
|
|
skill_command.plus_api_client.publish_skill = MagicMock(return_value=mock_resp)
|
|
with patch("crewai_cli.skills.main.Settings") as mock_settings_cls:
|
|
mock_settings_cls.return_value.org_name = "acme"
|
|
mock_settings_cls.return_value.enterprise_base_url = None
|
|
|
|
skill_command.publish(org="acme")
|
|
|
|
skill_command.plus_api_client.publish_skill.assert_called_once()
|
|
call_kwargs = skill_command.plus_api_client.publish_skill.call_args
|
|
assert call_kwargs.kwargs["name"] == "my-skill"
|
|
assert call_kwargs.kwargs["version"] == "1.0.0"
|
|
# Skills are always org-scoped; there is no public visibility.
|
|
assert call_kwargs.kwargs["is_public"] is False
|
|
|
|
def test_publish_blocked_when_git_not_synced(self, skill_command):
|
|
with in_temp_dir():
|
|
Path("SKILL.md").write_text(
|
|
"---\nname: my-skill\ndescription: A test skill.\nmetadata:\n version: 1.0.0\n---\nInstructions."
|
|
)
|
|
skill_command.plus_api_client.publish_skill = MagicMock()
|
|
with patch("crewai_cli.skills.main.git.Repository") as mock_repo_cls:
|
|
mock_repo_cls.return_value.is_synced.return_value = False
|
|
with pytest.raises(SystemExit):
|
|
skill_command.publish(org="acme")
|
|
skill_command.plus_api_client.publish_skill.assert_not_called()
|
|
|
|
def test_publish_force_skips_git_check(self, skill_command):
|
|
with in_temp_dir():
|
|
Path("SKILL.md").write_text(
|
|
"---\nname: my-skill\ndescription: A test skill.\nmetadata:\n version: 1.0.0\n---\nInstructions."
|
|
)
|
|
mock_resp = MagicMock()
|
|
mock_resp.is_success = True
|
|
mock_resp.status_code = 200
|
|
mock_resp.json.return_value = {}
|
|
skill_command.plus_api_client.publish_skill = MagicMock(return_value=mock_resp)
|
|
with (
|
|
patch("crewai_cli.skills.main.git.Repository") as mock_repo_cls,
|
|
patch("crewai_cli.skills.main.Settings") as mock_settings_cls,
|
|
):
|
|
mock_settings_cls.return_value.org_name = "acme"
|
|
mock_settings_cls.return_value.enterprise_base_url = None
|
|
skill_command.publish(org="acme", force=True)
|
|
mock_repo_cls.assert_not_called()
|
|
skill_command.plus_api_client.publish_skill.assert_called_once()
|
|
|
|
def test_publish_blocked_when_fetch_fails(self, skill_command):
|
|
"""A failing remote fetch must fail closed, not silently skip syncing."""
|
|
with in_temp_dir():
|
|
Path("SKILL.md").write_text(
|
|
"---\nname: my-skill\ndescription: A test skill.\nmetadata:\n version: 1.0.0\n---\nInstructions."
|
|
)
|
|
skill_command.plus_api_client.publish_skill = MagicMock()
|
|
with patch("crewai_cli.skills.main.git.Repository") as mock_repo_cls:
|
|
mock_repo_cls.return_value.fetch.side_effect = ValueError(
|
|
"Git fetch failed with exit code 128"
|
|
)
|
|
with pytest.raises(SystemExit):
|
|
skill_command.publish(org="acme")
|
|
skill_command.plus_api_client.publish_skill.assert_not_called()
|
|
|
|
def test_publish_blocked_when_git_state_cannot_be_validated(self, skill_command):
|
|
"""Git errors other than 'not a repo' must fail closed, not skip the check."""
|
|
with in_temp_dir():
|
|
Path("SKILL.md").write_text(
|
|
"---\nname: my-skill\ndescription: A test skill.\nmetadata:\n version: 1.0.0\n---\nInstructions."
|
|
)
|
|
skill_command.plus_api_client.publish_skill = MagicMock()
|
|
with patch(
|
|
"crewai_cli.skills.main.git.Repository",
|
|
side_effect=ValueError("Git fetch failed with exit code 128"),
|
|
):
|
|
with pytest.raises(SystemExit):
|
|
skill_command.publish(org="acme")
|
|
skill_command.plus_api_client.publish_skill.assert_not_called()
|
|
|
|
def test_publish_proceeds_outside_git_repo(self, skill_command):
|
|
with in_temp_dir():
|
|
Path("SKILL.md").write_text(
|
|
"---\nname: my-skill\ndescription: A test skill.\nmetadata:\n version: 1.0.0\n---\nInstructions."
|
|
)
|
|
mock_resp = MagicMock()
|
|
mock_resp.is_success = True
|
|
mock_resp.status_code = 200
|
|
mock_resp.json.return_value = {}
|
|
skill_command.plus_api_client.publish_skill = MagicMock(return_value=mock_resp)
|
|
with (
|
|
patch(
|
|
"crewai_cli.skills.main.git.Repository",
|
|
side_effect=ValueError("not a Git repository"),
|
|
),
|
|
patch("crewai_cli.skills.main.Settings") as mock_settings_cls,
|
|
):
|
|
mock_settings_cls.return_value.org_name = "acme"
|
|
mock_settings_cls.return_value.enterprise_base_url = None
|
|
skill_command.publish(org="acme")
|
|
skill_command.plus_api_client.publish_skill.assert_called_once()
|
|
|
|
|
|
class TestSkillListCached:
|
|
def test_list_cached_empty(self, skill_command, capsys):
|
|
with in_temp_dir():
|
|
skill_command.list_cached()
|
|
|
|
def test_list_cached_shows_project_skills(self, skill_command, capsys):
|
|
with in_temp_dir():
|
|
skill_dir = Path("skills/my-skill")
|
|
skill_dir.mkdir(parents=True)
|
|
(skill_dir / "SKILL.md").write_text(
|
|
"---\nname: my-skill\nversion: 0.5.0\ndescription: A skill.\n---\nBody."
|
|
)
|
|
skill_command.list_cached()
|