mirror of
https://github.com/larksuite/cli.git
synced 2026-07-07 00:55:53 +08:00
a1506cdffb
Add docs +history-list, +history-revert, and +history-revert-status backed by docs_ai history OpenAPI endpoints. Document the safe history workflow and extend dry-run/live E2E coverage for the new shortcuts.
229 lines
6.7 KiB
Go
229 lines
6.7 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package docs
|
|
|
|
import (
|
|
"context"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
clie2e "github.com/larksuite/cli/tests/cli_e2e"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/tidwall/gjson"
|
|
)
|
|
|
|
func TestDocs_DryRunDefaultsToV2OpenAPI(t *testing.T) {
|
|
// Fake creds are enough — dry-run short-circuits before any real API call.
|
|
t.Setenv("LARKSUITE_CLI_APP_ID", "app")
|
|
t.Setenv("LARKSUITE_CLI_APP_SECRET", "secret")
|
|
t.Setenv("LARKSUITE_CLI_BRAND", "feishu")
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
t.Cleanup(cancel)
|
|
|
|
tests := []struct {
|
|
name string
|
|
args []string
|
|
wantContains []string
|
|
wantURL string
|
|
wantParams map[string]any
|
|
wantBody map[string]any
|
|
wantExtraParam string
|
|
wantRefLabel string
|
|
}{
|
|
{
|
|
name: "create",
|
|
args: []string{
|
|
"docs", "+create",
|
|
"--content", "<title>Dry Run</title><p>hello</p>",
|
|
"--dry-run",
|
|
},
|
|
wantContains: []string{"/open-apis/docs_ai/v1/documents"},
|
|
},
|
|
{
|
|
name: "create api-version v1 compatibility",
|
|
args: []string{
|
|
"docs", "+create",
|
|
"--api-version", "v1",
|
|
"--content", "<title>Dry Run</title><p>hello</p>",
|
|
"--dry-run",
|
|
},
|
|
wantContains: []string{"/open-apis/docs_ai/v1/documents"},
|
|
},
|
|
{
|
|
name: "fetch",
|
|
args: []string{
|
|
"docs", "+fetch",
|
|
"--doc", "doxcnDryRunE2E",
|
|
"--dry-run",
|
|
},
|
|
wantContains: []string{"/open-apis/docs_ai/v1/documents/doxcnDryRunE2E/fetch"},
|
|
wantExtraParam: `{"enable_user_cite_reference_map":true,"return_html5_block_data":true}`,
|
|
},
|
|
{
|
|
name: "update",
|
|
args: []string{
|
|
"docs", "+update",
|
|
"--doc", "doxcnDryRunE2E",
|
|
"--command", "append",
|
|
"--content", "<p>hello</p>",
|
|
"--dry-run",
|
|
},
|
|
wantContains: []string{"/open-apis/docs_ai/v1/documents/doxcnDryRunE2E"},
|
|
},
|
|
{
|
|
name: "update reference-map",
|
|
args: []string{
|
|
"docs", "+update",
|
|
"--doc", "doxcnDryRunE2E",
|
|
"--command", "append",
|
|
"--content", `<p><widget data-ref="r1"></widget></p>`,
|
|
"--reference-map", `{"widget":{"r1":{"label":"widget-ref-value"}}}`,
|
|
"--dry-run",
|
|
},
|
|
wantContains: []string{"/open-apis/docs_ai/v1/documents/doxcnDryRunE2E"},
|
|
wantRefLabel: "widget-ref-value",
|
|
},
|
|
{
|
|
name: "block_delete batch",
|
|
args: []string{
|
|
"docs", "+update",
|
|
"--doc", "doxcnDryRunE2E",
|
|
"--command", "block_delete",
|
|
"--block-id", "blkA,blkB,blkC",
|
|
"--dry-run",
|
|
},
|
|
wantContains: []string{"/open-apis/docs_ai/v1/documents/doxcnDryRunE2E"},
|
|
},
|
|
{
|
|
name: "history list",
|
|
args: []string{
|
|
"docs", "+history-list",
|
|
"--doc", "doxcnDryRunE2E",
|
|
"--page-size", "5",
|
|
"--page-token", "page_token_1",
|
|
"--dry-run",
|
|
},
|
|
wantURL: "/open-apis/docs_ai/v1/documents/doxcnDryRunE2E/histories",
|
|
wantParams: map[string]any{
|
|
"page_size": 5,
|
|
"page_token": "page_token_1",
|
|
},
|
|
},
|
|
{
|
|
name: "history revert",
|
|
args: []string{
|
|
"docs", "+history-revert",
|
|
"--doc", "doxcnDryRunE2E",
|
|
"--history-version-id", "42",
|
|
"--wait-timeout-ms", "0",
|
|
"--dry-run",
|
|
},
|
|
wantURL: "/open-apis/docs_ai/v1/documents/doxcnDryRunE2E/history/revert",
|
|
wantBody: map[string]any{
|
|
"history_version_id": "42",
|
|
"wait_timeout_ms": 0,
|
|
},
|
|
},
|
|
{
|
|
name: "history revert status",
|
|
args: []string{
|
|
"docs", "+history-revert-status",
|
|
"--doc", "doxcnDryRunE2E",
|
|
"--task-id", "task_1",
|
|
"--dry-run",
|
|
},
|
|
wantURL: "/open-apis/docs_ai/v1/documents/doxcnDryRunE2E/history/revert_status",
|
|
wantParams: map[string]any{
|
|
"task_id": "task_1",
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
result, err := clie2e.RunCmd(ctx, clie2e.Request{
|
|
Args: tt.args,
|
|
DefaultAs: "bot",
|
|
})
|
|
require.NoError(t, err)
|
|
result.AssertExitCode(t, 0)
|
|
|
|
combined := result.Stdout + "\n" + result.Stderr
|
|
for _, want := range append(tt.wantContains, "docs_ai/v1") {
|
|
if !strings.Contains(combined, want) {
|
|
t.Fatalf("dry-run output missing %q\nstdout:\n%s\nstderr:\n%s", want, result.Stdout, result.Stderr)
|
|
}
|
|
}
|
|
if strings.Contains(combined, "/mcp") || strings.Contains(combined, "MCP tool") {
|
|
t.Fatalf("dry-run output should not use MCP\nstdout:\n%s\nstderr:\n%s", result.Stdout, result.Stderr)
|
|
}
|
|
if strings.Contains(combined, "--api-version") {
|
|
t.Fatalf("dry-run output should not ask for --api-version\nstdout:\n%s\nstderr:\n%s", result.Stdout, result.Stderr)
|
|
}
|
|
if tt.wantURL != "" {
|
|
require.Equal(t, tt.wantURL, gjson.Get(result.Stdout, "api.0.url").String(), "stdout:\n%s", result.Stdout)
|
|
}
|
|
for key, want := range tt.wantParams {
|
|
assertDryRunField(t, result.Stdout, "api.0.params."+key, want)
|
|
}
|
|
for key, want := range tt.wantBody {
|
|
assertDryRunField(t, result.Stdout, "api.0.body."+key, want)
|
|
}
|
|
if tt.wantExtraParam != "" {
|
|
extraParam := gjson.Get(result.Stdout, "api.0.body.extra_param").String()
|
|
require.JSONEq(t, tt.wantExtraParam, extraParam, "stdout:\n%s", result.Stdout)
|
|
}
|
|
if tt.wantRefLabel != "" {
|
|
got := gjson.Get(result.Stdout, "api.0.body.reference_map.widget.r1.label").String()
|
|
require.Equal(t, tt.wantRefLabel, got, "stdout:\n%s", result.Stdout)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func assertDryRunField(t *testing.T, stdout, path string, want any) {
|
|
t.Helper()
|
|
|
|
got := gjson.Get(stdout, path)
|
|
require.True(t, got.Exists(), "%s missing in stdout:\n%s", path, stdout)
|
|
switch want := want.(type) {
|
|
case int:
|
|
require.Equal(t, int64(want), got.Int(), "%s in stdout:\n%s", path, stdout)
|
|
case string:
|
|
require.Equal(t, want, got.String(), "%s in stdout:\n%s", path, stdout)
|
|
default:
|
|
t.Fatalf("unsupported dry-run assertion type %T for %s", want, path)
|
|
}
|
|
}
|
|
|
|
func TestDocs_CreateTitleDryRunPrependsContent(t *testing.T) {
|
|
// Fake creds are enough — dry-run short-circuits before any real API call.
|
|
t.Setenv("LARKSUITE_CLI_APP_ID", "app")
|
|
t.Setenv("LARKSUITE_CLI_APP_SECRET", "secret")
|
|
t.Setenv("LARKSUITE_CLI_BRAND", "feishu")
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
t.Cleanup(cancel)
|
|
|
|
result, err := clie2e.RunCmd(ctx, clie2e.Request{
|
|
Args: []string{
|
|
"docs", "+create",
|
|
"--title", "Dry Run & Title",
|
|
"--doc-format", "markdown",
|
|
"--content", "## Body",
|
|
"--dry-run",
|
|
},
|
|
DefaultAs: "bot",
|
|
})
|
|
require.NoError(t, err)
|
|
result.AssertExitCode(t, 0)
|
|
|
|
out := result.Stdout
|
|
require.Equal(t, "/open-apis/docs_ai/v1/documents", gjson.Get(out, "api.0.url").String(), "stdout:\n%s", out)
|
|
require.Equal(t, "markdown", gjson.Get(out, "api.0.body.format").String(), "stdout:\n%s", out)
|
|
require.Equal(t, "<title>Dry Run & Title</title>\n## Body", gjson.Get(out, "api.0.body.content").String(), "stdout:\n%s", out)
|
|
}
|