mirror of
https://github.com/huggingface/diffusers.git
synced 2026-10-24 20:59:27 +03:00
3681e65996
* restructure guides as skill references * reorganize AGENTS.md and references * clean up * clean up * clean up * fix AGENTS.md references and add check_ai to Makefile * clean up * update paths * clean up
159 lines
6.5 KiB
Python
159 lines
6.5 KiB
Python
# Copyright 2026 The HuggingFace Team. All rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""Unit tests for ``diffusers.commands.skills``.
|
|
|
|
Exercises the install / discovery / agent-detection logic. The GitHub Contents API path
|
|
(``_fetch_json`` / ``_download_skill_bundle``) is left out — it needs the network.
|
|
"""
|
|
|
|
import json
|
|
from argparse import ArgumentParser
|
|
|
|
import pytest
|
|
|
|
from diffusers.commands.skills import (
|
|
_AGENT_ENV_TO_DIR,
|
|
_AGENTS_SKILLS_DIR,
|
|
_ALL_INSTALL_DIRS,
|
|
_CLAUDE_SKILLS_DIR,
|
|
_MANAGED_MARKER_FILE,
|
|
_PLUGIN_NAME,
|
|
SkillsCommand,
|
|
_detect_install_dirs,
|
|
_discover_installed,
|
|
_install_skill,
|
|
_skill_description,
|
|
)
|
|
|
|
|
|
def _parse_skills_args(argv):
|
|
parser = ArgumentParser()
|
|
SkillsCommand.register_subcommand(parser.add_subparsers())
|
|
return parser.parse_args(argv)
|
|
|
|
|
|
SAMPLE_BUNDLE = {
|
|
"SKILL.md": b"---\nname: example-skill\ndescription: An example skill.\n---\n\n# Example\n",
|
|
"extra.md": b"# Extra reference file\n",
|
|
"reference/script.py": b"print('hello from a nested reference')\n",
|
|
}
|
|
|
|
|
|
class TestInstallSkill:
|
|
def test_writes_bundle_and_marker(self, tmp_path):
|
|
location = _install_skill("example-skill", SAMPLE_BUNDLE, tmp_path, _CLAUDE_SKILLS_DIR, force=False)
|
|
skill_dir = tmp_path / _CLAUDE_SKILLS_DIR / _PLUGIN_NAME / "skills" / "example-skill"
|
|
assert location == skill_dir
|
|
assert (skill_dir / "SKILL.md").read_bytes() == SAMPLE_BUNDLE["SKILL.md"]
|
|
assert (skill_dir / "extra.md").read_bytes() == SAMPLE_BUNDLE["extra.md"]
|
|
assert (skill_dir / "reference" / "script.py").read_bytes() == SAMPLE_BUNDLE["reference/script.py"]
|
|
assert (skill_dir / _MANAGED_MARKER_FILE).exists()
|
|
|
|
def test_claude_install_writes_plugin_manifest(self, tmp_path):
|
|
_install_skill("example-skill", SAMPLE_BUNDLE, tmp_path, _CLAUDE_SKILLS_DIR, force=False)
|
|
manifest = tmp_path / _CLAUDE_SKILLS_DIR / _PLUGIN_NAME / ".claude-plugin" / "plugin.json"
|
|
assert json.loads(manifest.read_text())["name"] == _PLUGIN_NAME
|
|
|
|
def test_agents_install_stays_flat(self, tmp_path):
|
|
location = _install_skill("example-skill", SAMPLE_BUNDLE, tmp_path, _AGENTS_SKILLS_DIR, force=False)
|
|
assert location == tmp_path / _AGENTS_SKILLS_DIR / "example-skill"
|
|
assert not (tmp_path / _AGENTS_SKILLS_DIR / _PLUGIN_NAME).exists()
|
|
|
|
def test_errors_without_force_on_existing_dir(self, tmp_path):
|
|
_install_skill("example-skill", SAMPLE_BUNDLE, tmp_path, _CLAUDE_SKILLS_DIR, force=False)
|
|
with pytest.raises(SystemExit, match="Use --force to reinstall"):
|
|
_install_skill("example-skill", SAMPLE_BUNDLE, tmp_path, _CLAUDE_SKILLS_DIR, force=False)
|
|
|
|
def test_force_replaces_existing(self, tmp_path):
|
|
_install_skill("example-skill", SAMPLE_BUNDLE, tmp_path, _CLAUDE_SKILLS_DIR, force=False)
|
|
new_bundle = {"SKILL.md": b"different content"}
|
|
_install_skill("example-skill", new_bundle, tmp_path, _CLAUDE_SKILLS_DIR, force=True)
|
|
skill_dir = tmp_path / _CLAUDE_SKILLS_DIR / _PLUGIN_NAME / "skills" / "example-skill"
|
|
assert (skill_dir / "SKILL.md").read_bytes() == b"different content"
|
|
assert not (skill_dir / "extra.md").exists()
|
|
assert (skill_dir / _MANAGED_MARKER_FILE).exists()
|
|
|
|
|
|
class TestDetectInstallDirs:
|
|
def test_no_env_installs_everywhere(self, monkeypatch):
|
|
for var in _AGENT_ENV_TO_DIR:
|
|
monkeypatch.delenv(var, raising=False)
|
|
assert _detect_install_dirs() == _ALL_INSTALL_DIRS
|
|
|
|
@pytest.mark.parametrize(
|
|
("env_var", "expected"),
|
|
[
|
|
("CLAUDECODE", _CLAUDE_SKILLS_DIR),
|
|
("CLAUDE_CODE", _CLAUDE_SKILLS_DIR),
|
|
("CODEX_SANDBOX", _AGENTS_SKILLS_DIR),
|
|
("CURSOR_AI", _AGENTS_SKILLS_DIR),
|
|
],
|
|
)
|
|
def test_env_var_picks_specific_target(self, monkeypatch, env_var, expected):
|
|
for var in _AGENT_ENV_TO_DIR:
|
|
monkeypatch.delenv(var, raising=False)
|
|
monkeypatch.setenv(env_var, "1")
|
|
assert _detect_install_dirs() == (expected,)
|
|
|
|
|
|
class TestSkillDescription:
|
|
def test_reads_folded_block(self):
|
|
skill_md = "---\nname: demo\ndescription: >\n First line\n second line.\n---\n\n# Body\n"
|
|
assert _skill_description(skill_md) == "First line second line."
|
|
|
|
def test_reads_single_line(self):
|
|
assert _skill_description("---\nname: demo\ndescription: Does a thing.\n---\n") == "Does a thing."
|
|
|
|
def test_returns_empty_without_frontmatter(self):
|
|
assert _skill_description("# Just a heading\n") == ""
|
|
|
|
|
|
class TestTargetFlags:
|
|
@pytest.mark.parametrize(
|
|
("flag", "expected"),
|
|
[
|
|
("--claude", (_CLAUDE_SKILLS_DIR,)),
|
|
("--codex", (_AGENTS_SKILLS_DIR,)),
|
|
("--cursor", (_AGENTS_SKILLS_DIR,)),
|
|
],
|
|
)
|
|
def test_flag_pins_install_dirs(self, flag, expected):
|
|
args = _parse_skills_args(["skills", "add", "self-review", flag])
|
|
assert args.install_dirs == expected
|
|
|
|
def test_no_flag_defers_to_detection(self):
|
|
assert _parse_skills_args(["skills", "add", "self-review"]).install_dirs is None
|
|
|
|
def test_flags_are_mutually_exclusive(self):
|
|
with pytest.raises(SystemExit):
|
|
_parse_skills_args(["skills", "add", "self-review", "--claude", "--codex"])
|
|
|
|
|
|
class TestDiscoverInstalled:
|
|
def test_returns_managed_installs_from_all_paths(self, tmp_path):
|
|
_install_skill("skill-a", SAMPLE_BUNDLE, tmp_path, _CLAUDE_SKILLS_DIR, force=False)
|
|
_install_skill("skill-b", SAMPLE_BUNDLE, tmp_path, _AGENTS_SKILLS_DIR, force=False)
|
|
# User-placed skill without our marker — should be ignored.
|
|
unmanaged = tmp_path / _CLAUDE_SKILLS_DIR / _PLUGIN_NAME / "skills" / "user-placed"
|
|
unmanaged.mkdir(parents=True)
|
|
(unmanaged / "SKILL.md").write_bytes(b"user content")
|
|
|
|
assert _discover_installed(tmp_path) == [
|
|
(_CLAUDE_SKILLS_DIR, "skill-a"),
|
|
(_AGENTS_SKILLS_DIR, "skill-b"),
|
|
]
|
|
|
|
def test_returns_empty_when_no_skills_dir(self, tmp_path):
|
|
assert _discover_installed(tmp_path) == []
|