An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作
TypeScript agentic-aiai-agentknowledge-baselocal-firstmarkdownmcpmindmapnote-takingself-hostedsiyuanworkspace
// SiYuan - https://github.com/siyuan-note/siyuan
// Copyright (c) 2020-present, b3log.org
// SPDX-License-Identifier: AGPL-3.0-or-later
package api
import (
"encoding/json"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"slices"
"strings"
"testing"
"github.com/gin-gonic/gin"
"github.com/siyuan-note/siyuan/kernel/apicontract"
"github.com/siyuan-note/siyuan/kernel/model"
"github.com/siyuan-note/siyuan/kernel/util"
)
func TestRejectMobileWorkspaceBaseDir(t *testing.T) {
_, workspaceBaseDir := prepareMobileWorkspaceBaseDirTest(t)
response := rejectMobileWorkspaceBaseDirResponse[apicontract.Null](workspaceBaseDir)
if response == nil {
t.Fatal("mobile workspace base dir should be rejected")
}
if got := response.Code(); -1 != got {
t.Fatalf("unexpected result code: got %d, want -1", got)
}
if !isInvalidWorkspacePath(workspaceBaseDir) {
t.Fatal("mobile workspace base dir should be excluded from workspace discovery")
}
}
func TestGetMobileWorkspacesExcludesBaseDir(t *testing.T) {
packageDir, workspaceBaseDir := prepareMobileWorkspaceBaseDirTest(t)
otherWorkspaceDir := filepath.Join(packageDir, "Todo")
for _, dir := range []string{util.WorkspaceDir, otherWorkspaceDir} {
if err := os.MkdirAll(dir, 0755); err != nil {
t.Fatal(err)
}
}
gin.SetMode(gin.TestMode)
engine := gin.New()
engine.GET("/api/system/getMobileWorkspaces", getMobileWorkspaces)
recorder := httptest.NewRecorder()
request := httptest.NewRequest(http.MethodGet, "http://127.0.0.1/api/system/getMobileWorkspaces", nil)
engine.ServeHTTP(recorder, request)
response := &struct {
Code int `json:"code"`
Data []string `json:"data"`
}{}
if err := json.Unmarshal(recorder.Body.Bytes(), response); err != nil {
t.Fatalf("unmarshal getMobileWorkspaces response failed: %s", err)
}
if 0 != response.Code {
t.Fatalf("getMobileWorkspaces failed: %s", recorder.Body.String())
}
if slices.Contains(response.Data, workspaceBaseDir) {
t.Fatalf("mobile workspace base dir must not be discoverable: %v", response.Data)
}
if !slices.Contains(response.Data, otherWorkspaceDir) {
t.Fatalf("regular sibling workspace should remain discoverable: %v", response.Data)
}
}
func TestRemoveWorkspaceDirPhysicallyProtectsBaseDir(t *testing.T) {
_, workspaceBaseDir := prepareMobileWorkspaceBaseDirTest(t)
marker := filepath.Join(workspaceBaseDir, "marker")
if err := os.WriteFile(marker, []byte("test"), 0644); err != nil {
t.Fatal(err)
}
gin.SetMode(gin.TestMode)
engine := gin.New()
engine.POST("/api/system/removeWorkspaceDirPhysically", removeWorkspaceDirPhysically)
recorder := httptest.NewRecorder()
request := httptest.NewRequest(http.MethodPost, "http://127.0.0.1/api/system/removeWorkspaceDirPhysically",
strings.NewReader(`{"path":"`+filepath.ToSlash(workspaceBaseDir)+`"}`))
request.Header.Set("Content-Type", "application/json")
engine.ServeHTTP(recorder, request)
response := &struct {
Code int `json:"code"`
}{}
if err := json.Unmarshal(recorder.Body.Bytes(), response); err != nil {
t.Fatalf("unmarshal removeWorkspaceDirPhysically response failed: %s", err)
}
if -1 != response.Code {
t.Fatalf("mobile workspace base dir removal was accepted: %s", recorder.Body.String())
}
if _, err := os.Stat(marker); err != nil {
t.Fatalf("mobile workspace base dir content must remain unchanged: %s", err)
}
}
func TestRemoveWorkspaceDirPhysicallyRemovesRegisteredWorkspace(t *testing.T) {
tests := []struct {
name string
initialized bool
hasOrdinaryFile bool
shouldBeRemoved bool
}{
{name: "initialized workspace", initialized: true, shouldBeRemoved: true},
{name: "empty workspace", shouldBeRemoved: true},
{name: "non-empty ordinary directory", hasOrdinaryFile: true},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
rootDir := t.TempDir()
homeDir := filepath.Join(rootDir, "home")
workspaceConfDir := filepath.Join(homeDir, ".config", "siyuan")
currentWorkspaceDir := filepath.Join(rootDir, "current")
targetWorkspaceDir := filepath.Join(rootDir, "target")
for _, dir := range []string{workspaceConfDir, targetWorkspaceDir} {
if err := os.MkdirAll(dir, 0755); err != nil {
t.Fatal(err)
}
}
if test.initialized {
confDir := filepath.Join(targetWorkspaceDir, "conf")
if err := os.MkdirAll(confDir, 0755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(confDir, "conf.json"), []byte(`{"kernelVersion":"test"}`), 0644); err != nil {
t.Fatal(err)
}
}
if test.hasOrdinaryFile {
if err := os.WriteFile(filepath.Join(targetWorkspaceDir, "file.txt"), []byte("test"), 0644); err != nil {
t.Fatal(err)
}
}
originalContainer, originalHomeDir, originalWorkspaceDir := util.Container, util.HomeDir, util.WorkspaceDir
util.Container = util.ContainerStd
util.HomeDir = homeDir
util.WorkspaceDir = currentWorkspaceDir
t.Cleanup(func() {
util.Container, util.HomeDir, util.WorkspaceDir = originalContainer, originalHomeDir, originalWorkspaceDir
})
if err := util.WriteWorkspacePaths([]string{targetWorkspaceDir}); err != nil {
t.Fatal(err)
}
gin.SetMode(gin.TestMode)
engine := gin.New()
engine.POST("/api/system/removeWorkspaceDirPhysically", removeWorkspaceDirPhysically)
recorder := httptest.NewRecorder()
request := httptest.NewRequest(http.MethodPost, "http://127.0.0.1/api/system/removeWorkspaceDirPhysically",
strings.NewReader(`{"path":"`+filepath.ToSlash(targetWorkspaceDir)+`"}`))
request.Header.Set("Content-Type", "application/json")
engine.ServeHTTP(recorder, request)
response := &struct {
Code int `json:"code"`
}{}
if err := json.Unmarshal(recorder.Body.Bytes(), response); err != nil {
t.Fatalf("unmarshal removeWorkspaceDirPhysically response failed: %s", err)
}
if test.shouldBeRemoved && 0 != response.Code {
t.Fatalf("removeWorkspaceDirPhysically failed: %s", recorder.Body.String())
}
if !test.shouldBeRemoved && -1 != response.Code {
t.Fatalf("ordinary directory removal was accepted: %s", recorder.Body.String())
}
_, statErr := os.Stat(targetWorkspaceDir)
if test.shouldBeRemoved && !os.IsNotExist(statErr) {
t.Fatalf("workspace directory should be removed: %v", statErr)
}
if !test.shouldBeRemoved && statErr != nil {
t.Fatalf("ordinary directory should remain unchanged: %v", statErr)
}
workspacePathsData, err := os.ReadFile(filepath.Join(workspaceConfDir, "workspace.json"))
if err != nil {
t.Fatal(err)
}
var workspacePaths []string
if err = json.Unmarshal(workspacePathsData, &workspacePaths); err != nil {
t.Fatal(err)
}
if slices.Contains(workspacePaths, targetWorkspaceDir) == test.shouldBeRemoved {
t.Fatalf("unexpected registered workspaces: %v", workspacePaths)
}
})
}
}
func prepareMobileWorkspaceBaseDirTest(t *testing.T) (packageDir, workspaceBaseDir string) {
t.Helper()
packageDir = t.TempDir()
workspaceBaseDir = filepath.Join(packageDir, "files")
if err := os.MkdirAll(workspaceBaseDir, 0755); err != nil {
t.Fatal(err)
}
originalContainer, originalHomeDir, originalWorkspaceDir := util.Container, util.HomeDir, util.WorkspaceDir
originalConf := model.Conf
originalEnglishLang, hadEnglishLang := util.Langs["en"]
util.Container = util.ContainerAndroid
util.HomeDir = filepath.Join(workspaceBaseDir, "home")
util.WorkspaceDir = filepath.Join(packageDir, "1")
model.Conf = model.NewAppConf()
model.Conf.Lang = "en"
util.Langs["en"] = map[int]string{274: "Please create a new folder as the workspace"}
t.Cleanup(func() {
util.Container, util.HomeDir, util.WorkspaceDir = originalContainer, originalHomeDir, originalWorkspaceDir
model.Conf = originalConf
if hadEnglishLang {
util.Langs["en"] = originalEnglishLang
} else {
delete(util.Langs, "en")
}
})
return packageDir, workspaceBaseDir
}