Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

test: use real workspace skill services (#43562)

Asuka Minato17383fb3df2f
diff --git a/api/tests/unit_tests/controllers/console/workspace/test_skills.py b/api/tests/unit_tests/controllers/console/workspace/test_skills.py
index 060d78e7a21..0ed28c0f3f3 100644
--- a/api/tests/unit_tests/controllers/console/workspace/test_skills.py
+++ b/api/tests/unit_tests/controllers/console/workspace/test_skills.py
@@ -2,13 +2,15 @@ from __future__ import annotations
import io
from collections.abc import Callable
+from dataclasses import dataclass, field
from inspect import signature
from inspect import unwrap as inspect_unwrap
from typing import cast
-from unittest.mock import MagicMock, PropertyMock, patch
+from unittest.mock import PropertyMock, patch
import pytest
-from flask import Flask
+from flask import Flask, Response
+from sqlalchemy.orm import Session
from controllers.console import console_ns
from controllers.console.workspace.skills import (
@@ -33,7 +35,53 @@ from controllers.console.workspace.skills import (
)
from controllers.inner_api.plugin.skills import PublishedSkillPullApi
from machinery.context import RequestContext
-from services.skill_management_service import SkillAssistAttachmentPayload, SkillManagementServiceError
+from services.skill_management_service import (
+ DraftSkillArchive,
+ PublishedSkillArchive,
+ SkillAssistAttachmentPayload,
+ SkillDraftFileCheckPayload,
+ SkillDraftFileOperationPayload,
+ SkillDraftTreePayload,
+ SkillFileContent,
+ SkillImportPayload,
+ SkillManagementService,
+ SkillManagementServiceError,
+ SkillMetadataPayload,
+ SkillPublishPayload,
+ SkillRestorePayload,
+ SkillVersionUpdatePayload,
+)
+
+
+@dataclass(frozen=True)
+class RecordedCall:
+ args: tuple[object, ...]
+ kwargs: dict[str, object]
+
+
+@dataclass
+class CallRecorder:
+ result: object = None
+ error: Exception | None = None
+ calls: list[RecordedCall] = field(default_factory=list)
+
+ def __call__(self, *args: object, **kwargs: object) -> object:
+ self.calls.append(RecordedCall(args=args, kwargs=kwargs))
+ if self.error is not None:
+ raise self.error
+ return self.result
+
+
+def _recording_service(
+ method_name: str,
+ *,
+ result: object = None,
+ error: Exception | None = None,
+) -> tuple[SkillManagementService, CallRecorder]:
+ service = SkillManagementService(session=Session())
+ recorder = CallRecorder(result=result, error=error)
+ setattr(service, method_name, recorder)
+ return service, recorder
def unwrap[ReturnT](func: Callable[..., ReturnT]) -> Callable[..., ReturnT]:
@@ -43,7 +91,8 @@ def unwrap[ReturnT](func: Callable[..., ReturnT]) -> Callable[..., ReturnT]:
if len(parameters) > 1 and parameters[1].name == "session":
def invoke(*args: object, **kwargs: object) -> ReturnT:
- return unwrapped(args[0], MagicMock(), *args[1:], **kwargs)
+ with Session() as session:
+ return unwrapped(args[0], session, *args[1:], **kwargs)
return invoke
return unwrapped
@@ -103,8 +152,7 @@ def _skill_detail() -> dict[str, object]:
def test_create_skill_validates_payload_and_returns_detail(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillsApi()
method = unwrap(api.post)
- service = MagicMock()
- service.create_skill.return_value = _skill_detail()
+ service, create_skill = _recording_service("create_skill", result=_skill_detail())
with (
app.test_request_context("/", method="POST"),
@@ -116,9 +164,9 @@ def test_create_skill_validates_payload_and_returns_detail(app: Flask, request_c
assert status == 201
assert payload["id"] == "skill-1"
assert payload["files"][0]["path"] == "SKILL.md"
- service.create_skill.assert_called_once()
- assert service.create_skill.call_args.kwargs["tenant_id"] == "tenant-1"
- assert service.create_skill.call_args.kwargs["user_id"] == "user-1"
+ assert len(create_skill.calls) == 1
+ assert create_skill.calls[0].kwargs["tenant_id"] == "tenant-1"
+ assert create_skill.calls[0].kwargs["user_id"] == "user-1"
@pytest.mark.parametrize("side_effect", [ValueError("bad payload"), SkillManagementServiceError("skill_error", "bad")])
@@ -129,8 +177,7 @@ def test_create_skill_maps_validation_and_service_errors(
) -> None:
api = WorkspaceSkillsApi()
method = unwrap(api.post)
- service = MagicMock()
- service.create_skill.side_effect = side_effect
+ service, _ = _recording_service("create_skill", error=side_effect)
with (
app.test_request_context("/", method="POST"),
@@ -162,7 +209,7 @@ def test_list_skills_uses_default_pagination_when_query_omits_page_and_limit(
) -> None:
api = WorkspaceSkillsApi()
method = unwrap(api.get)
- service = MagicMock()
+ service, list_skills = _recording_service("list_skills")
list_response: dict[str, object] = {
"data": [],
"has_more": False,
@@ -170,7 +217,7 @@ def test_list_skills_uses_default_pagination_when_query_omits_page_and_limit(
"page": 1,
"total": 0,
}
- service.list_skills.return_value = list_response
+ list_skills.result = list_response
with (
app.test_request_context("/?keyword=finance&tag=ops&tag=", method="GET"),
@@ -185,21 +232,20 @@ def test_list_skills_uses_default_pagination_when_query_omits_page_and_limit(
"page": 1,
"total": 0,
}
- service.list_skills.assert_called_once_with(
- tenant_id="tenant-1",
- keyword="finance",
- page=1,
- limit=20,
- tags=["ops"],
- )
+ assert list_skills.calls == [
+ RecordedCall(
+ args=(),
+ kwargs={"tenant_id": "tenant-1", "keyword": "finance", "page": 1, "limit": 20, "tags": ["ops"]},
+ )
+ ]
def test_list_skills_passes_explicit_pagination(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillsApi()
method = unwrap(api.get)
- service = MagicMock()
+ service, list_skills = _recording_service("list_skills")
list_response: dict[str, object] = {"data": [], "has_more": False, "limit": 10, "page": 2, "total": 0}
- service.list_skills.return_value = list_response
+ list_skills.result = list_response
with (
app.test_request_context("/?limit=10&page=2", method="GET"),
@@ -209,20 +255,27 @@ def test_list_skills_passes_explicit_pagination(app: Flask, request_context: Req
assert payload["limit"] == 10
assert payload["page"] == 2
- service.list_skills.assert_called_once_with(tenant_id="tenant-1", keyword=None, page=2, limit=10, tags=[])
+ assert list_skills.calls == [
+ RecordedCall(
+ args=(),
+ kwargs={"tenant_id": "tenant-1", "keyword": None, "page": 2, "limit": 10, "tags": []},
+ )
+ ]
def test_upload_skill_file_returns_tool_file_metadata(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillFileUploadApi()
method = unwrap(api.post)
- service = MagicMock()
- service.upload_file.return_value = {
- "id": "tool-file-1",
- "name": "policy.md",
- "mime_type": "text/markdown",
- "size": 12,
- "hash": "hash",
- }
+ service, upload_file = _recording_service(
+ "upload_file",
+ result={
+ "id": "tool-file-1",
+ "name": "policy.md",
+ "mime_type": "text/markdown",
+ "size": 12,
+ "hash": "hash",
+ },
+ )
with (
app.test_request_context(
@@ -237,13 +290,18 @@ def test_upload_skill_file_returns_tool_file_metadata(app: Flask, request_contex
assert status == 201
assert payload["id"] == "tool-file-1"
- service.upload_file.assert_called_once_with(
- tenant_id="tenant-1",
- user_id="user-1",
- filename="policy.md",
- content=b"Policy text.",
- mime_type="text/markdown",
- )
+ assert upload_file.calls == [
+ RecordedCall(
+ args=(),
+ kwargs={
+ "tenant_id": "tenant-1",
+ "user_id": "user-1",
+ "filename": "policy.md",
+ "content": b"Policy text.",
+ "mime_type": "text/markdown",
+ },
+ )
+ ]
def test_upload_skill_file_requires_file(app: Flask, request_context: RequestContext) -> None:
@@ -276,8 +334,7 @@ def test_upload_skill_file_requires_filename(app: Flask, request_context: Reques
def test_import_skill_uploads_zip(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillImportApi()
method = unwrap(api.post)
- service = MagicMock()
- service.import_skill.return_value = _skill_detail()
+ service, import_skill = _recording_service("import_skill", result=_skill_detail())
with (
app.test_request_context(
@@ -292,11 +349,13 @@ def test_import_skill_uploads_zip(app: Flask, request_context: RequestContext) -
assert status == 201
assert payload["id"] == "skill-1"
- call = service.import_skill.call_args.kwargs
+ call = import_skill.calls[0].kwargs
assert call["tenant_id"] == "tenant-1"
assert call["user_id"] == "user-1"
- assert call["payload"].content == b"zip-bytes"
- assert call["payload"].filename == "skill.zip"
+ service_payload = call["payload"]
+ assert isinstance(service_payload, SkillImportPayload)
+ assert service_payload.content == b"zip-bytes"
+ assert service_payload.filename == "skill.zip"
def test_import_skill_requires_file(app: Flask, request_context: RequestContext) -> None:
@@ -313,8 +372,9 @@ def test_import_skill_requires_file(app: Flask, request_context: RequestContext)
def test_import_skill_maps_service_error(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillImportApi()
method = unwrap(api.post)
- service = MagicMock()
- service.import_skill.side_effect = SkillManagementServiceError("invalid_skill_archive", "invalid archive")
+ service, _ = _recording_service(
+ "import_skill", error=SkillManagementServiceError("invalid_skill_archive", "invalid archive")
+ )
with (
app.test_request_context(
@@ -334,8 +394,7 @@ def test_import_skill_maps_service_error(app: Flask, request_context: RequestCon
def test_get_skill_detail_returns_files(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillApi()
method = unwrap(api.get)
- service = MagicMock()
- service.get_skill.return_value = _skill_detail()
+ service, get_skill = _recording_service("get_skill", result=_skill_detail())
with (
app.test_request_context("/", method="GET"),
@@ -345,14 +404,15 @@ def test_get_skill_detail_returns_files(app: Flask, request_context: RequestCont
assert payload["id"] == "skill-1"
assert payload["files"][0]["path"] == "SKILL.md"
- service.get_skill.assert_called_once_with(tenant_id="tenant-1", skill_id="skill-1")
+ assert get_skill.calls == [RecordedCall(args=(), kwargs={"tenant_id": "tenant-1", "skill_id": "skill-1"})]
def test_get_skill_detail_maps_service_error(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillApi()
method = unwrap(api.get)
- service = MagicMock()
- service.get_skill.side_effect = SkillManagementServiceError("skill_not_found", "skill not found", status_code=404)
+ service, _ = _recording_service(
+ "get_skill", error=SkillManagementServiceError("skill_not_found", "skill not found", status_code=404)
+ )
with (
app.test_request_context("/", method="GET"),
@@ -367,8 +427,9 @@ def test_get_skill_detail_maps_service_error(app: Flask, request_context: Reques
def test_update_skill_metadata_validates_payload(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillApi()
method = unwrap(api.patch)
- service = MagicMock()
- service.update_metadata.return_value = {key: value for key, value in _skill_detail().items() if key != "files"}
+ service, update_metadata = _recording_service(
+ "update_metadata", result={key: value for key, value in _skill_detail().items() if key != "files"}
+ )
with (
app.test_request_context("/", method="PATCH"),
@@ -383,11 +444,13 @@ def test_update_skill_metadata_validates_payload(app: Flask, request_context: Re
payload = method(api, request_context, "skill-1")
assert payload["display_name"] == "Finance SOP"
- call = service.update_metadata.call_args.kwargs
+ call = update_metadata.calls[0].kwargs
assert call["tenant_id"] == "tenant-1"
assert call["user_id"] == "user-1"
assert call["skill_id"] == "skill-1"
- assert call["payload"].tags == ["finance"]
+ service_payload = call["payload"]
+ assert isinstance(service_payload, SkillMetadataPayload)
+ assert service_payload.tags == ["finance"]
@pytest.mark.parametrize(
@@ -401,8 +464,7 @@ def test_update_skill_metadata_maps_service_errors(
) -> None:
api = WorkspaceSkillApi()
method = unwrap(api.patch)
- service = MagicMock()
- service.update_metadata.side_effect = side_effect
+ service, _ = _recording_service("update_metadata", error=side_effect)
with (
app.test_request_context("/", method="PATCH"),
@@ -418,8 +480,7 @@ def test_update_skill_metadata_maps_service_errors(
def test_delete_skill_passes_confirmation_name(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillApi()
method = unwrap(api.delete)
- service = MagicMock()
- service.delete_skill.return_value = {"id": "skill-1", "deleted": True}
+ service, delete_skill = _recording_service("delete_skill", result={"id": "skill-1", "deleted": True})
with (
app.test_request_context("/", method="DELETE"),
@@ -434,21 +495,24 @@ def test_delete_skill_passes_confirmation_name(app: Flask, request_context: Requ
payload = method(api, request_context, "skill-1")
assert payload == {"id": "skill-1", "deleted": True}
- service.delete_skill.assert_called_once_with(
- tenant_id="tenant-1",
- skill_id="skill-1",
- confirmation_name="finance-sop",
- )
+ assert delete_skill.calls == [
+ RecordedCall(
+ args=(),
+ kwargs={"tenant_id": "tenant-1", "skill_id": "skill-1", "confirmation_name": "finance-sop"},
+ )
+ ]
def test_delete_skill_maps_service_error(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillApi()
method = unwrap(api.delete)
- service = MagicMock()
- service.delete_skill.side_effect = SkillManagementServiceError(
- "skill_referenced",
- "skill is referenced",
- status_code=409,
+ service, _ = _recording_service(
+ "delete_skill",
+ error=SkillManagementServiceError(
+ "skill_referenced",
+ "skill is referenced",
+ status_code=409,
+ ),
)
with (
@@ -465,8 +529,7 @@ def test_delete_skill_maps_service_error(app: Flask, request_context: RequestCon
def test_duplicate_skill_returns_new_detail(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillDuplicateApi()
method = unwrap(api.post)
- service = MagicMock()
- service.duplicate_skill.return_value = _skill_detail()
+ service, duplicate_skill = _recording_service("duplicate_skill", result=_skill_detail())
with (
app.test_request_context("/", method="POST"),
@@ -476,17 +539,21 @@ def test_duplicate_skill_returns_new_detail(app: Flask, request_context: Request
assert status == 201
assert payload["id"] == "skill-1"
- service.duplicate_skill.assert_called_once_with(tenant_id="tenant-1", user_id="user-1", skill_id="skill-1")
+ assert duplicate_skill.calls == [
+ RecordedCall(args=(), kwargs={"tenant_id": "tenant-1", "user_id": "user-1", "skill_id": "skill-1"})
+ ]
def test_duplicate_skill_maps_service_error(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillDuplicateApi()
method = unwrap(api.post)
- service = MagicMock()
- service.duplicate_skill.side_effect = SkillManagementServiceError(
- "skill_not_found",
- "skill not found",
- status_code=404,
+ service, _ = _recording_service(
+ "duplicate_skill",
+ error=SkillManagementServiceError(
+ "skill_not_found",
+ "skill not found",
+ status_code=404,
+ ),
)
with (
@@ -502,11 +569,13 @@ def test_duplicate_skill_maps_service_error(app: Flask, request_context: Request
def test_export_skill_returns_archive_response(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillExportApi()
method = unwrap(api.get)
- service = MagicMock()
- service.export_draft_archive.return_value = MagicMock(
- payload=b"zip-bytes",
- mime_type="application/zip",
- filename="finance-sop.zip",
+ service, export_draft_archive = _recording_service(
+ "export_draft_archive",
+ result=DraftSkillArchive(
+ payload=b"zip-bytes",
+ mime_type="application/zip",
+ filename="finance-sop.zip",
+ ),
)
with (
@@ -520,17 +589,21 @@ def test_export_skill_returns_archive_response(app: Flask, request_context: Requ
assert response.headers["Content-Disposition"].startswith("attachment;")
response.direct_passthrough = False
assert response.get_data() == b"zip-bytes"
- service.export_draft_archive.assert_called_once_with(tenant_id="tenant-1", skill_id="skill-1")
+ assert export_draft_archive.calls == [
+ RecordedCall(args=(), kwargs={"tenant_id": "tenant-1", "skill_id": "skill-1"})
+ ]
def test_export_skill_maps_service_error(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillExportApi()
method = unwrap(api.get)
- service = MagicMock()
- service.export_draft_archive.side_effect = SkillManagementServiceError(
- "skill_not_found",
- "skill not found",
- status_code=404,
+ service, _ = _recording_service(
+ "export_draft_archive",
+ error=SkillManagementServiceError(
+ "skill_not_found",
+ "skill not found",
+ status_code=404,
+ ),
)
with (
@@ -546,11 +619,13 @@ def test_export_skill_maps_service_error(app: Flask, request_context: RequestCon
def test_inner_api_pulls_published_skill_archive(app: Flask) -> None:
api = PublishedSkillPullApi()
method = unwrap(api.get)
- service = MagicMock()
- service.pull_published_archive.return_value = MagicMock(
- payload=b"zip-bytes",
- mime_type="application/zip",
- filename="finance-sop.zip",
+ service, pull_published_archive = _recording_service(
+ "pull_published_archive",
+ result=PublishedSkillArchive(
+ payload=b"zip-bytes",
+ mime_type="application/zip",
+ filename="finance-sop.zip",
+ ),
)
with (
@@ -563,7 +638,9 @@ def test_inner_api_pulls_published_skill_archive(app: Flask) -> None:
assert response.mimetype == "application/zip"
response.direct_passthrough = False
assert response.get_data() == b"zip-bytes"
- service.pull_published_archive.assert_called_once_with(tenant_id="tenant-1", skill_id="skill-1")
+ assert pull_published_archive.calls == [
+ RecordedCall(args=(), kwargs={"tenant_id": "tenant-1", "skill_id": "skill-1"})
+ ]
def test_inner_api_pull_maps_missing_tenant_to_invalid_request(app: Flask) -> None:
@@ -580,27 +657,29 @@ def test_inner_api_pull_maps_missing_tenant_to_invalid_request(app: Flask) -> No
def test_get_agent_skill_bindings_returns_card_data(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceAgentSkillBindingsApi()
method = unwrap(api.get)
- service = MagicMock()
- service.list_agent_bindings.return_value = {
- "agent_id": "agent-1",
- "skill_ids": ["skill-1"],
- "data": [
- {
- "id": "skill-1",
- "priority": 0,
- "name": "finance-sop",
- "display_name": "Finance SOP",
- "icon": "📄",
- "description": "Handle finance.",
- "tags": ["Finance"],
- "status": "published",
- "file_count": 2,
- "latest_published_version_id": "version-1",
- "latest_published_at": 123,
- "updated_at": 124,
- }
- ],
- }
+ service, list_agent_bindings = _recording_service(
+ "list_agent_bindings",
+ result={
+ "agent_id": "agent-1",
+ "skill_ids": ["skill-1"],
+ "data": [
+ {
+ "id": "skill-1",
+ "priority": 0,
+ "name": "finance-sop",
+ "display_name": "Finance SOP",
+ "icon": "📄",
+ "description": "Handle finance.",
+ "tags": ["Finance"],
+ "status": "published",
+ "file_count": 2,
+ "latest_published_version_id": "version-1",
+ "latest_published_at": 123,
+ "updated_at": 124,
+ }
+ ],
+ },
+ )
with (
app.test_request_context("/", method="GET"),
@@ -611,7 +690,7 @@ def test_get_agent_skill_bindings_returns_card_data(app: Flask, request_context:
assert payload["skill_ids"] == ["skill-1"]
assert payload["data"][0]["display_name"] == "Finance SOP"
assert payload["data"][0]["file_count"] == 2
- service.list_agent_bindings.assert_called_once_with(tenant_id="tenant-1", agent_id="agent-1")
+ assert list_agent_bindings.calls == [RecordedCall(args=(), kwargs={"tenant_id": "tenant-1", "agent_id": "agent-1"})]
def test_patch_skill_file_operation_validates_payload_and_returns_detail(
@@ -619,8 +698,7 @@ def test_patch_skill_file_operation_validates_payload_and_returns_detail(
) -> None:
api = WorkspaceSkillFilesApi()
method = unwrap(api.patch)
- service = MagicMock()
- service.apply_draft_file_operation.return_value = _skill_detail()
+ service, apply_draft_file_operation = _recording_service("apply_draft_file_operation", result=_skill_detail())
request_payload = {
"operation": "upsert_text",
"path": "references/policy.md",
@@ -635,22 +713,26 @@ def test_patch_skill_file_operation_validates_payload_and_returns_detail(
payload = method(api, request_context, "skill-1")
assert payload["id"] == "skill-1"
- service.apply_draft_file_operation.assert_called_once()
- call = service.apply_draft_file_operation.call_args.kwargs
+ assert len(apply_draft_file_operation.calls) == 1
+ call = apply_draft_file_operation.calls[0].kwargs
assert call["tenant_id"] == "tenant-1"
assert call["user_id"] == "user-1"
assert call["skill_id"] == "skill-1"
- assert call["payload"].operation == "upsert_text"
+ service_payload = call["payload"]
+ assert isinstance(service_payload, SkillDraftFileOperationPayload)
+ assert service_payload.operation == "upsert_text"
def test_patch_skill_file_operation_returns_error_details(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillFilesApi()
method = unwrap(api.patch)
- service = MagicMock()
- service.apply_draft_file_operation.side_effect = SkillManagementServiceError(
- "missing_skill_name",
- "SKILL.md frontmatter name is required",
- details={"path": "SKILL.md", "field": "name", "line": 2},
+ service, _ = _recording_service(
+ "apply_draft_file_operation",
+ error=SkillManagementServiceError(
+ "missing_skill_name",
+ "SKILL.md frontmatter name is required",
+ details={"path": "SKILL.md", "field": "name", "line": 2},
+ ),
)
with (
@@ -676,19 +758,21 @@ def test_patch_skill_file_operation_returns_error_details(app: Flask, request_co
def test_check_skill_files_validates_payload_and_returns_results(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillFilesCheckApi()
method = unwrap(api.post)
- service = MagicMock()
- service.check_draft_files.return_value = {
- "data": {
- "policy.md": {
- "path": "references/policy.md",
- "filename": "policy.md",
- "extension": ".md",
- "mime_type": "text/markdown",
- "size": 12,
- "errors": list[dict[str, str]](),
- }
+ service, check_draft_files = _recording_service(
+ "check_draft_files",
+ result={
+ "data": {
+ "policy.md": {
+ "path": "references/policy.md",
+ "filename": "policy.md",
+ "extension": ".md",
+ "mime_type": "text/markdown",
+ "size": 12,
+ "errors": list[dict[str, str]](),
+ }
+ },
},
- }
+ )
with (
app.test_request_context("/", method="POST"),
@@ -704,11 +788,13 @@ def test_check_skill_files_validates_payload_and_returns_results(app: Flask, req
assert payload["data"]["policy.md"]["path"] == "references/policy.md"
assert payload["data"]["policy.md"]["errors"] == []
- service.check_draft_files.assert_called_once()
- call = service.check_draft_files.call_args.kwargs
+ assert len(check_draft_files.calls) == 1
+ call = check_draft_files.calls[0].kwargs
assert call["tenant_id"] == "tenant-1"
assert call["skill_id"] == "skill-1"
- assert call["payload"].files[0].filename == "policy.md"
+ service_payload = call["payload"]
+ assert isinstance(service_payload, SkillDraftFileCheckPayload)
+ assert service_payload.files[0].filename == "policy.md"
def test_replace_skill_draft_tree_validates_payload_and_returns_detail(
@@ -716,8 +802,7 @@ def test_replace_skill_draft_tree_validates_payload_and_returns_detail(
) -> None:
api = WorkspaceSkillFilesApi()
method = unwrap(api.put)
- service = MagicMock()
- service.replace_draft_tree.return_value = _skill_detail()
+ service, replace_draft_tree = _recording_service("replace_draft_tree", result=_skill_detail())
with (
app.test_request_context("/", method="PUT"),
@@ -732,24 +817,28 @@ def test_replace_skill_draft_tree_validates_payload_and_returns_detail(
payload = method(api, request_context, "skill-1")
assert payload["id"] == "skill-1"
- call = service.replace_draft_tree.call_args.kwargs
+ call = replace_draft_tree.calls[0].kwargs
assert call["tenant_id"] == "tenant-1"
assert call["user_id"] == "user-1"
assert call["skill_id"] == "skill-1"
- assert call["payload"].files[0].path == "SKILL.md"
+ service_payload = call["payload"]
+ assert isinstance(service_payload, SkillDraftTreePayload)
+ assert service_payload.files[0].path == "SKILL.md"
def test_preview_skill_file_validates_query(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillFilePreviewApi()
method = unwrap(api.get)
- service = MagicMock()
- service.preview_file.return_value = {
- "path": "SKILL.md",
- "mime_type": "text/markdown",
- "content": "# Body",
- "size": 6,
- "hash": "hash",
- }
+ service, preview_file = _recording_service(
+ "preview_file",
+ result={
+ "path": "SKILL.md",
+ "mime_type": "text/markdown",
+ "content": "# Body",
+ "size": 6,
+ "hash": "hash",
+ },
+ )
with (
app.test_request_context("/?path=SKILL.md&version_id=version-1", method="GET"),
@@ -758,22 +847,33 @@ def test_preview_skill_file_validates_query(app: Flask, request_context: Request
payload = method(api, request_context, "skill-1")
assert payload["content"] == "# Body"
- service.preview_file.assert_called_once_with(
- tenant_id="tenant-1",
- skill_id="skill-1",
- path="SKILL.md",
- version_id="version-1",
- )
+ assert preview_file.calls == [
+ RecordedCall(
+ args=(),
+ kwargs={
+ "tenant_id": "tenant-1",
+ "skill_id": "skill-1",
+ "path": "SKILL.md",
+ "version_id": "version-1",
+ },
+ )
+ ]
def test_pull_skill_file_content_returns_download(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillFileContentApi()
method = unwrap(api.get)
- service = MagicMock()
- service.pull_file.return_value = MagicMock(
- payload=b"# Body",
- mime_type="text/markdown",
- filename="SKILL.md",
+ service, pull_file = _recording_service(
+ "pull_file",
+ result=SkillFileContent(
+ filename="SKILL.md",
+ path="SKILL.md",
+ mime_type="text/markdown",
+ payload=b"# Body",
+ content="# Body",
+ size=6,
+ hash="hash",
+ ),
)
with (
@@ -787,19 +887,18 @@ def test_pull_skill_file_content_returns_download(app: Flask, request_context: R
assert response.headers["Content-Disposition"].startswith("attachment;")
response.direct_passthrough = False
assert response.get_data() == b"# Body"
- service.pull_file.assert_called_once_with(
- tenant_id="tenant-1",
- skill_id="skill-1",
- path="SKILL.md",
- version_id=None,
- )
+ assert pull_file.calls == [
+ RecordedCall(
+ args=(),
+ kwargs={"tenant_id": "tenant-1", "skill_id": "skill-1", "path": "SKILL.md", "version_id": None},
+ )
+ ]
def test_list_skill_tags_returns_filter_options(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillTagsApi()
method = unwrap(api.get)
- service = MagicMock()
- service.list_tags.return_value = {"data": [{"tag": "finance", "count": 2}]}
+ service, list_tags = _recording_service("list_tags", result={"data": [{"tag": "finance", "count": 2}]})
with (
app.test_request_context("/", method="GET"),
@@ -808,26 +907,28 @@ def test_list_skill_tags_returns_filter_options(app: Flask, request_context: Req
payload = method(api, request_context)
assert payload == {"data": [{"tag": "finance", "count": 2}]}
- service.list_tags.assert_called_once_with(tenant_id="tenant-1")
+ assert list_tags.calls == [RecordedCall(args=(), kwargs={"tenant_id": "tenant-1"})]
def test_publish_skill_validates_payload(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillPublishApi()
method = unwrap(api.post)
- service = MagicMock()
- service.publish_skill.return_value = {
- "id": "version-1",
- "skill_id": "skill-1",
- "version_number": 1,
- "version_name": "Initial",
- "publish_note": "Initial",
- "hash_code": "hash-code",
- "archive_size": 123,
- "published_by": "user-1",
- "published_by_name": "Li Wei",
- "is_latest": True,
- "created_at": 1,
- }
+ service, publish_skill = _recording_service(
+ "publish_skill",
+ result={
+ "id": "version-1",
+ "skill_id": "skill-1",
+ "version_number": 1,
+ "version_name": "Initial",
+ "publish_note": "Initial",
+ "hash_code": "hash-code",
+ "archive_size": 123,
+ "published_by": "user-1",
+ "published_by_name": "Li Wei",
+ "is_latest": True,
+ "created_at": 1,
+ },
+ )
with (
app.test_request_context("/", method="POST"),
@@ -837,17 +938,19 @@ def test_publish_skill_validates_payload(app: Flask, request_context: RequestCon
payload = method(api, request_context, "skill-1")
assert payload["id"] == "version-1"
- call = service.publish_skill.call_args.kwargs
+ call = publish_skill.calls[0].kwargs
assert call["tenant_id"] == "tenant-1"
assert call["user_id"] == "user-1"
assert call["skill_id"] == "skill-1"
- assert call["payload"].publish_note == "Initial"
+ service_payload = call["payload"]
+ assert isinstance(service_payload, SkillPublishPayload)
+ assert service_payload.publish_note == "Initial"
def test_restore_skill_version_validates_payload(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillRestoreApi()
method = unwrap(api.post)
- service = MagicMock()
+ service, restore_version = _recording_service("restore_version")
empty_tags: list[object] = []
empty_files: list[object] = []
restored_skill: dict[str, object] = {
@@ -871,7 +974,7 @@ def test_restore_skill_version_validates_payload(app: Flask, request_context: Re
"updated_at": 2,
"files": empty_files,
}
- service.restore_version.return_value = restored_skill
+ restore_version.result = restored_skill
with (
app.test_request_context("/", method="POST"),
@@ -881,27 +984,31 @@ def test_restore_skill_version_validates_payload(app: Flask, request_context: Re
payload = method(api, request_context, "skill-1")
assert payload["latest_published_version_id"] == "version-1"
- call = service.restore_version.call_args.kwargs
+ call = restore_version.calls[0].kwargs
assert call["tenant_id"] == "tenant-1"
assert call["user_id"] == "user-1"
assert call["skill_id"] == "skill-1"
- assert call["payload"].version_id == "version-1"
+ service_payload = call["payload"]
+ assert isinstance(service_payload, SkillRestorePayload)
+ assert service_payload.version_id == "version-1"
def test_list_skill_references_returns_reference_data(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillReferencesApi()
method = unwrap(api.get)
- service = MagicMock()
- service.list_skill_references.return_value = {
- "data": [
- {
- "type": "agent",
- "agent_id": "agent-1",
- "name": "Agent",
- "display_name": "Agent",
- }
- ],
- }
+ service, list_skill_references = _recording_service(
+ "list_skill_references",
+ result={
+ "data": [
+ {
+ "type": "agent",
+ "agent_id": "agent-1",
+ "name": "Agent",
+ "display_name": "Agent",
+ }
+ ],
+ },
+ )
with (
app.test_request_context("/", method="GET"),
@@ -910,30 +1017,34 @@ def test_list_skill_references_returns_reference_data(app: Flask, request_contex
payload = method(api, request_context, "skill-1")
assert payload["data"][0]["agent_id"] == "agent-1"
- service.list_skill_references.assert_called_once_with(tenant_id="tenant-1", skill_id="skill-1")
+ assert list_skill_references.calls == [
+ RecordedCall(args=(), kwargs={"tenant_id": "tenant-1", "skill_id": "skill-1"})
+ ]
def test_list_skill_versions_returns_version_page(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillVersionsApi()
method = unwrap(api.get)
- service = MagicMock()
- service.list_versions.return_value = {
- "data": [
- {
- "id": "version-1",
- "skill_id": "skill-1",
- "version_number": 1,
- "version_name": "Initial",
- "publish_note": "Initial",
- "hash_code": "hash-code",
- "archive_size": 123,
- "published_by": "user-1",
- "published_by_name": "Li Wei",
- "is_latest": True,
- "created_at": 1,
- }
- ],
- }
+ service, list_versions = _recording_service(
+ "list_versions",
+ result={
+ "data": [
+ {
+ "id": "version-1",
+ "skill_id": "skill-1",
+ "version_number": 1,
+ "version_name": "Initial",
+ "publish_note": "Initial",
+ "hash_code": "hash-code",
+ "archive_size": 123,
+ "published_by": "user-1",
+ "published_by_name": "Li Wei",
+ "is_latest": True,
+ "created_at": 1,
+ }
+ ],
+ },
+ )
with (
app.test_request_context("/", method="GET"),
@@ -942,13 +1053,13 @@ def test_list_skill_versions_returns_version_page(app: Flask, request_context: R
payload = method(api, request_context, "skill-1")
assert payload["data"][0]["id"] == "version-1"
- service.list_versions.assert_called_once_with(tenant_id="tenant-1", skill_id="skill-1")
+ assert list_versions.calls == [RecordedCall(args=(), kwargs={"tenant_id": "tenant-1", "skill_id": "skill-1"})]
def test_get_skill_version_returns_version_detail(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillVersionApi()
method = unwrap(api.get)
- service = MagicMock()
+ service, get_version = _recording_service("get_version")
version_response: dict[str, object] = {
"id": "version-1",
"skill_id": "skill-1",
@@ -975,7 +1086,7 @@ def test_get_skill_version_returns_version_detail(app: Flask, request_context: R
}
],
}
- service.get_version.return_value = version_response
+ get_version.result = version_response
with (
app.test_request_context("/", method="GET"),
@@ -984,30 +1095,30 @@ def test_get_skill_version_returns_version_detail(app: Flask, request_context: R
payload = method(api, request_context, "skill-1", "version-1")
assert payload["files"][0]["content"] == "# Version"
- service.get_version.assert_called_once_with(
- tenant_id="tenant-1",
- skill_id="skill-1",
- version_id="version-1",
- )
+ assert get_version.calls == [
+ RecordedCall(args=(), kwargs={"tenant_id": "tenant-1", "skill_id": "skill-1", "version_id": "version-1"})
+ ]
def test_patch_skill_version_renames_version(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillVersionApi()
method = unwrap(api.patch)
- service = MagicMock()
- service.update_version.return_value = {
- "id": "version-1",
- "skill_id": "skill-1",
- "version_number": 1,
- "version_name": "Approval threshold",
- "publish_note": "",
- "hash_code": "hash-code",
- "archive_size": 123,
- "published_by": "user-1",
- "published_by_name": "Li Wei",
- "is_latest": True,
- "created_at": 1,
- }
+ service, update_version = _recording_service(
+ "update_version",
+ result={
+ "id": "version-1",
+ "skill_id": "skill-1",
+ "version_number": 1,
+ "version_name": "Approval threshold",
+ "publish_note": "",
+ "hash_code": "hash-code",
+ "archive_size": 123,
+ "published_by": "user-1",
+ "published_by_name": "Li Wei",
+ "is_latest": True,
+ "created_at": 1,
+ },
+ )
with (
app.test_request_context("/", method="PATCH"),
@@ -1022,19 +1133,23 @@ def test_patch_skill_version_renames_version(app: Flask, request_context: Reques
payload = method(api, request_context, "skill-1", "version-1")
assert payload["version_name"] == "Approval threshold"
- service.update_version.assert_called_once()
- assert service.update_version.call_args.kwargs["payload"].version_name == "Approval threshold"
+ assert len(update_version.calls) == 1
+ service_payload = update_version.calls[0].kwargs["payload"]
+ assert isinstance(service_payload, SkillVersionUpdatePayload)
+ assert service_payload.version_name == "Approval threshold"
def test_delete_skill_version_returns_new_latest(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillVersionApi()
method = unwrap(api.delete)
- service = MagicMock()
- service.delete_version.return_value = {
- "id": "version-2",
- "deleted": True,
- "latest_published_version_id": "version-1",
- }
+ service, delete_version = _recording_service(
+ "delete_version",
+ result={
+ "id": "version-2",
+ "deleted": True,
+ "latest_published_version_id": "version-1",
+ },
+ )
with (
app.test_request_context("/", method="DELETE"),
@@ -1043,21 +1158,26 @@ def test_delete_skill_version_returns_new_latest(app: Flask, request_context: Re
payload = method(api, request_context, "skill-1", "version-2")
assert payload == {"id": "version-2", "deleted": True, "latest_published_version_id": "version-1"}
- service.delete_version.assert_called_once_with(
- tenant_id="tenant-1",
- user_id="user-1",
- skill_id="skill-1",
- version_id="version-2",
- )
+ assert delete_version.calls == [
+ RecordedCall(
+ args=(),
+ kwargs={
+ "tenant_id": "tenant-1",
+ "user_id": "user-1",
+ "skill_id": "skill-1",
+ "version_id": "version-2",
+ },
+ )
+ ]
def test_skill_assistant_runs_agent_app_stream(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillAssistMessageApi()
method = unwrap(api.post)
- service = MagicMock()
- action_stream = MagicMock()
- service.create_assistant_action_stream.return_value = action_stream
- compact_response = MagicMock()
+ action_stream = iter([{"event": "done"}])
+ service, create_assistant_action_stream = _recording_service("create_assistant_action_stream", result=action_stream)
+ compact_response = Response("compact")
+ compact_generate_response = CallRecorder(result=compact_response)
with (
app.test_request_context("/", method="POST"),
@@ -1078,32 +1198,34 @@ def test_skill_assistant_runs_agent_app_stream(app: Flask, request_context: Requ
},
),
patch("controllers.console.workspace.skills.SkillManagementService", return_value=service),
- patch(
- "controllers.console.workspace.skills.helper.compact_generate_response",
- return_value=compact_response,
- ) as compact_generate_response,
+ patch("controllers.console.workspace.skills.helper.compact_generate_response", new=compact_generate_response),
):
response = method(api, request_context, "skill-1")
assert response is compact_response
- service.create_assistant_action_stream.assert_called_once_with(
- tenant_id="tenant-1",
- skill_id="skill-1",
- user_id="user-1",
- message="Create an approval checklist.",
- attachments=[
- SkillAssistAttachmentPayload(
- tool_file_id="tool-file-1",
- name="requirements.md",
- mime_type="text/markdown",
- size=128,
- )
- ],
- history=[],
- model_payload=None,
- target_path=None,
- )
- compact_generate_response.assert_called_once_with(action_stream)
+ assert create_assistant_action_stream.calls == [
+ RecordedCall(
+ args=(),
+ kwargs={
+ "tenant_id": "tenant-1",
+ "skill_id": "skill-1",
+ "user_id": "user-1",
+ "message": "Create an approval checklist.",
+ "attachments": [
+ SkillAssistAttachmentPayload(
+ tool_file_id="tool-file-1",
+ name="requirements.md",
+ mime_type="text/markdown",
+ size=128,
+ )
+ ],
+ "history": [],
+ "model_payload": None,
+ "target_path": None,
+ },
+ )
+ ]
+ assert compact_generate_response.calls == [RecordedCall(args=(action_stream,), kwargs={})]
@pytest.mark.parametrize("payload", [{}, {"message": "x", "unknown": True}])
@@ -1128,10 +1250,12 @@ def test_skill_assistant_rejects_invalid_payload(
def test_skill_assistant_maps_service_error(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillAssistMessageApi()
method = unwrap(api.post)
- service = MagicMock()
- service.create_assistant_action_stream.side_effect = SkillManagementServiceError(
- "model_provider_not_configured",
- "model provider not configured",
+ service, _ = _recording_service(
+ "create_assistant_action_stream",
+ error=SkillManagementServiceError(
+ "model_provider_not_configured",
+ "model provider not configured",
+ ),
)
with (
@@ -1159,7 +1283,6 @@ def test_skill_file_write_methods_map_conflicts(
payload: dict[str, object],
) -> None:
api = WorkspaceSkillFilesApi()
- service = MagicMock()
conflict = SkillManagementServiceError(
"skill_conflict",
"skill has been modified by another user",
@@ -1167,10 +1290,10 @@ def test_skill_file_write_methods_map_conflicts(
)
if method_name == "patch":
method = unwrap(api.patch)
- service.apply_draft_file_operation.side_effect = conflict
+ service, _ = _recording_service("apply_draft_file_operation", error=conflict)
else:
method = unwrap(api.put)
- service.replace_draft_tree.side_effect = conflict
+ service, _ = _recording_service("replace_draft_tree", error=conflict)
with (
app.test_request_context("/", method=method_name.upper()),
@@ -1186,8 +1309,7 @@ def test_skill_file_write_methods_map_conflicts(
def test_replace_skill_draft_tree_maps_value_error(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillFilesApi()
method = unwrap(api.put)
- service = MagicMock()
- service.replace_draft_tree.side_effect = ValueError("bad path")
+ service, _ = _recording_service("replace_draft_tree", error=ValueError("bad path"))
with (
app.test_request_context("/", method="PUT"),
@@ -1217,8 +1339,9 @@ def test_preview_skill_file_rejects_invalid_query(
def test_preview_skill_file_maps_service_error(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillFilePreviewApi()
method = unwrap(api.get)
- service = MagicMock()
- service.preview_file.side_effect = SkillManagementServiceError("file_not_found", "file not found", status_code=404)
+ service, _ = _recording_service(
+ "preview_file", error=SkillManagementServiceError("file_not_found", "file not found", status_code=404)
+ )
with (
app.test_request_context("/?path=SKILL.md", method="GET"),
@@ -1247,8 +1370,9 @@ def test_pull_skill_file_content_rejects_invalid_query(
def test_pull_skill_file_content_maps_service_error(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillFileContentApi()
method = unwrap(api.get)
- service = MagicMock()
- service.pull_file.side_effect = SkillManagementServiceError("file_not_found", "file not found", status_code=404)
+ service, _ = _recording_service(
+ "pull_file", error=SkillManagementServiceError("file_not_found", "file not found", status_code=404)
+ )
with (
app.test_request_context("/?path=SKILL.md", method="GET"),
@@ -1277,8 +1401,9 @@ def test_publish_skill_rejects_invalid_payload(app: Flask, request_context: Requ
def test_publish_skill_maps_service_error(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillPublishApi()
method = unwrap(api.post)
- service = MagicMock()
- service.publish_skill.side_effect = SkillManagementServiceError("missing_skill_name", "name required")
+ service, _ = _recording_service(
+ "publish_skill", error=SkillManagementServiceError("missing_skill_name", "name required")
+ )
with (
app.test_request_context("/", method="POST"),
@@ -1308,11 +1433,13 @@ def test_restore_skill_version_rejects_invalid_payload(app: Flask, request_conte
def test_restore_skill_version_maps_service_error(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceSkillRestoreApi()
method = unwrap(api.post)
- service = MagicMock()
- service.restore_version.side_effect = SkillManagementServiceError(
- "version_not_found",
- "version not found",
- status_code=404,
+ service, _ = _recording_service(
+ "restore_version",
+ error=SkillManagementServiceError(
+ "version_not_found",
+ "version not found",
+ status_code=404,
+ ),
)
with (
@@ -1329,9 +1456,9 @@ def test_restore_skill_version_maps_service_error(app: Flask, request_context: R
def test_agent_skill_bindings_replaces_bound_skills(app: Flask, request_context: RequestContext) -> None:
api = WorkspaceAgentSkillBindingsApi()
method = unwrap(api.put)
- service = MagicMock()
+ service, replace_agent_bindings = _recording_service("replace_agent_bindings")
bindings_response: dict[str, object] = {"agent_id": "agent-1", "skill_ids": ["skill-1"], "data": []}
- service.replace_agent_bindings.return_value = bindings_response
+ replace_agent_bindings.result = bindings_response
with (
app.test_request_context("/", method="PUT"),
@@ -1341,12 +1468,17 @@ def test_agent_skill_bindings_replaces_bound_skills(app: Flask, request_context:
payload = method(api, request_context, "agent-1")
assert payload["skill_ids"] == ["skill-1"]
- service.replace_agent_bindings.assert_called_once_with(
- tenant_id="tenant-1",
- user_id="user-1",
- agent_id="agent-1",
- skill_ids=["skill-1"],
- )
+ assert replace_agent_bindings.calls == [
+ RecordedCall(
+ args=(),
+ kwargs={
+ "tenant_id": "tenant-1",
+ "user_id": "user-1",
+ "agent_id": "agent-1",
+ "skill_ids": ["skill-1"],
+ },
+ )
+ ]
def test_agent_skill_bindings_rejects_invalid_payload(app: Flask, request_context: RequestContext) -> None:
diff --git a/api/tests/unit_tests/core/rag/extractor/test_word_extractor.py b/api/tests/unit_tests/core/rag/extractor/test_word_extractor.py
index 06191857dec..1790ba35c4a 100644
--- a/api/tests/unit_tests/core/rag/extractor/test_word_extractor.py
+++ b/api/tests/unit_tests/core/rag/extractor/test_word_extractor.py
@@ -229,7 +229,7 @@ def test_extract_images_from_docx_uses_internal_files_url(monkeypatch: pytest.Mo
def test_extract_hyperlinks(monkeypatch: pytest.MonkeyPatch, unbound_session: Session):
- # Mock db and storage to avoid issues during image extraction (even if no images are present)
+ # Patch db and storage to avoid issues during image extraction (even if no images are present)
apply_config_overrides(monkeypatch, FILES_URL="http://files.local", STORAGE_TYPE="local")
doc = Document()