Files
gns3-server/tests/agent/mcp/test_skills.py
T
yueguobin 21fb84e91c fix(skills): load categories independently and support non-git checkouts
SkillsManager refused to start when the local skills directory was not a
git repository (cloning into a non-empty path fails), and reload_skills()
returned early when injection/ was missing, so device and feature skills
never loaded. reload_packet_analysis_protocols() had the opposite bug:
an empty result wiped the registry while still reporting success.

- initialize(): accept a non-empty directory without .git as a local-only
  source (skip automatic updates, keep loading files); degrade to local
  files when GitPython is unavailable.
- _update_if_needed(): re-create/clone when the local directory vanished
  or moved, instead of reusing a stale handle forever.
- reload_skills(): injection, device and feature load independently; a
  missing category keeps its previously loaded entries.
- reload_packet_analysis_protocols(): an empty/missing directory keeps
  the existing registry and reports failure.
- reload_skills_repository(): drop the console guard cache so
  config/console_guard.txt applies on reload.

MCP device_skill_get now exposes the category filter, documents the
single-file (topic-less) layout, and returns a sections list for
index/summary of skills that have no topics/issues. An uninitialized
skills repository fails with a clear error instead of an empty list.
2026-11-01 23:09:38 +08:00

122 lines
5.2 KiB
Python

#
# Copyright (C) 2026 GNS3 Technologies Inc.
# Author: Yue Guobin
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
"""
Unit tests for the MCP device skills tool (registry faked, no I/O).
"""
import pytest
from gns3server.agent.gns3_copilot.skills import registry as skills_registry
from gns3server.agent.mcp.skills import device_skills_handler
FAKE_SKILLS = {
"frr_vtysh": {
"name": "FRR",
"description": "vtysh console model",
"category": "device",
"topics": {"bgp": {"name": "BGP", "syntax": "router bgp <asn>"}},
},
"cisco_ios_telnet": {"name": "IOS", "description": "IOS quirks", "category": "device"},
"gns3_vpcs_telnet": {
"name": "VPCS",
"description": "VPCS syntax",
"category": "device",
"config_commands": {"ip": {"syntax": "ip <address>/<mask>"}},
},
"topology_planner": {"name": "Topology Planner", "description": "Planning", "category": "feature"},
}
@pytest.fixture(autouse=True)
def fake_registry(monkeypatch):
"""Deterministic skills registry — the real one depends on whether the
skills repository has been cloned on this machine."""
monkeypatch.setattr(skills_registry, "SKILLS_REGISTRY", FAKE_SKILLS)
class TestDeviceSkillsHandler:
def test_list(self):
result = device_skills_handler({"action": "list"}, {})
assert result["status"] == "ok"
assert result["count"] == 4
assert {s["device_type"] for s in result["skills"]} == set(FAKE_SKILLS)
def test_no_args_defaults_to_list(self):
result = device_skills_handler({}, {})
assert result["status"] == "ok" and result["count"] == 4
def test_list_filtered_by_category(self):
result = device_skills_handler({"action": "list", "category": "feature"}, {})
assert result["status"] == "ok"
assert [s["device_type"] for s in result["skills"]] == ["topology_planner"]
def test_get_by_key(self):
result = device_skills_handler({"device_type": "frr_vtysh"}, {})
assert result["status"] == "ok"
assert result["skill"]["name"] == "FRR"
def test_get_with_matching_category(self):
result = device_skills_handler({"device_type": "frr_vtysh", "category": "device"}, {})
assert result["status"] == "ok"
def test_get_with_wrong_category(self):
result = device_skills_handler({"device_type": "frr_vtysh", "category": "feature"}, {})
assert result["status"] == "failed"
assert "not in category" in result["error"]
def test_topic_body_only_on_explicit_request(self):
indexed = device_skills_handler({"device_type": "frr_vtysh"}, {})["skill"]
assert indexed["topics"]["bgp"] == "BGP" # index: names only, body withheld
topic = device_skills_handler({"device_type": "frr_vtysh", "topic": "bgp"}, {})["skill"]
assert topic["topic"] == {"bgp": {"name": "BGP", "syntax": "router bgp <asn>"}}
def test_index_sections_for_topicless_skill(self):
# Single-file skills have no topics; index names their sections
# instead of returning an empty shell.
result = device_skills_handler({"device_type": "gns3_vpcs_telnet", "detail": "index"}, {})
assert result["status"] == "ok"
assert result["skill"]["sections"] == ["config_commands"]
def test_unknown_key_lists_available(self):
# Not a key the list would return — the error carries the loaded
# keys anyway, so a stale caller can see what step 1 offers.
result = device_skills_handler({"device_type": "cisco_asa"}, {})
assert result["status"] == "failed"
assert "Unknown device_type" in result["error"]
assert set(result["available_device_types"]) == set(FAKE_SKILLS)
def test_missing_device_type(self):
result = device_skills_handler({"action": "get"}, {})
assert result["status"] == "failed"
assert "Provide device_type" in result["error"]
def test_uninitialized_repository_reports_failure(self, monkeypatch):
monkeypatch.setattr(skills_registry, "SKILLS_REGISTRY", {})
monkeypatch.setattr(skills_registry, "get_skills_manager", lambda: None)
result = device_skills_handler({"action": "list"}, {})
assert result["status"] == "failed"
assert "not initialized" in result["error"]
def test_empty_but_initialized_repository_lists_zero(self, monkeypatch):
monkeypatch.setattr(skills_registry, "SKILLS_REGISTRY", {})
monkeypatch.setattr(skills_registry, "get_skills_manager", object)
result = device_skills_handler({"action": "list"}, {})
assert result == {"status": "ok", "count": 0, "skills": []}