mirror of
https://github.com/larksuite/cli.git
synced 2026-09-14 18:42:53 +08:00
SunPeiYang996
a6f3e635d4
* feat(docs): add local authoring and resource workflows Add docs +script workflows for isolated draft initialization and tolerant XML/Markdown profiling. Support local and remote document resources across create and update flows with safe, bounded-concurrency uploads, binding verification, and cleanup. Synchronize shared credential-source selection during concurrent uploads, refresh lark-doc guidance, and expand unit, dry-run, and live E2E coverage. * docs(lark-doc): clarify genre reference paths * fix(docs): address PR validation feedback * docs(lark-doc): clarify remote image handling * feat: streamline docs draft workflow * fix(docs): clarify script input and resource cleanup * fix(docs): align script dry-run test with auth flow * fix(docs): authenticate local script e2e test * fix(docs): refine script diagnostics and image preflight * fix(docs): align draft workspace cleanup with VFS * fix(docs): route workspace cleanup through FileIO * docs(lark-doc): simplify profile check guidance
110 lines
3.5 KiB
Go
110 lines
3.5 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package docs
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
"time"
|
|
|
|
clie2e "github.com/larksuite/cli/tests/cli_e2e"
|
|
"github.com/larksuite/cli/tests/cli_e2e/drive"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/tidwall/gjson"
|
|
)
|
|
|
|
// TestDocs_CreateAndFetchWorkflow tests the create and fetch lifecycle.
|
|
func TestDocs_CreateAndFetchWorkflowAsBot(t *testing.T) {
|
|
clie2e.SkipWithoutTenantAccessToken(t)
|
|
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
|
|
t.Cleanup(cancel)
|
|
|
|
parentT := t
|
|
suffix := clie2e.GenerateSuffix()
|
|
folderName := "lark-cli-e2e-docs-folder-" + suffix
|
|
docTitle := "lark-cli-e2e-docs-" + suffix
|
|
docContent := "# Test Document\n\nThis document was created by lark-cli e2e test."
|
|
|
|
const defaultAs = "bot"
|
|
folderToken := drive.CreateDriveFolder(t, parentT, ctx, folderName, defaultAs, "")
|
|
var docToken string
|
|
|
|
t.Run("create", func(t *testing.T) {
|
|
docToken = createDocWithRetry(t, parentT, ctx, folderToken, docTitle, docContent, defaultAs)
|
|
})
|
|
|
|
t.Run("fetch", func(t *testing.T) {
|
|
require.NotEmpty(t, docToken, "document token should be created before fetch")
|
|
|
|
result, err := clie2e.RunCmd(ctx, clie2e.Request{
|
|
Args: []string{
|
|
"docs", "+fetch",
|
|
"--doc", docToken,
|
|
"--doc-format", "markdown",
|
|
},
|
|
DefaultAs: defaultAs,
|
|
})
|
|
require.NoError(t, err)
|
|
result.AssertExitCode(t, 0)
|
|
result.AssertStdoutStatus(t, true)
|
|
content := gjson.Get(result.Stdout, "data.document.content").String()
|
|
assert.Contains(t, content, docTitle)
|
|
assert.Contains(t, content, "This document was created by lark-cli e2e test.")
|
|
})
|
|
|
|
t.Run("script parse by token", func(t *testing.T) {
|
|
require.NotEmpty(t, docToken, "document token should be created before script parse")
|
|
|
|
result, err := clie2e.RunCmd(ctx, clie2e.Request{
|
|
Args: []string{
|
|
"docs", "+script",
|
|
"--command", "parse",
|
|
"--doc", docToken,
|
|
},
|
|
DefaultAs: defaultAs,
|
|
})
|
|
require.NoError(t, err)
|
|
result.AssertExitCode(t, 0)
|
|
result.AssertStdoutStatus(t, true)
|
|
assert.Positive(t, gjson.Get(result.Stdout, "data.profile.word_count").Int())
|
|
assert.Positive(t, gjson.Get(result.Stdout, "data.profile.block_count").Int())
|
|
})
|
|
}
|
|
|
|
func TestDocs_CreateAndFetchWorkflowAsUser(t *testing.T) {
|
|
clie2e.SkipWithoutUserToken(t)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
|
|
t.Cleanup(cancel)
|
|
|
|
parentT := t
|
|
suffix := clie2e.GenerateSuffix()
|
|
folderName := "lark-cli-e2e-user-docs-folder-" + suffix
|
|
docTitle := "lark-cli-e2e-user-docs-" + suffix
|
|
docContent := "# User Test Document\n\nCreated with user access token."
|
|
var docToken string
|
|
const defaultAs = "user"
|
|
folderToken := drive.CreateDriveFolder(t, parentT, ctx, folderName, defaultAs, "")
|
|
|
|
t.Run("create as user", func(t *testing.T) {
|
|
docToken = createDocWithRetry(t, parentT, ctx, folderToken, docTitle, docContent, defaultAs)
|
|
})
|
|
|
|
t.Run("fetch as user", func(t *testing.T) {
|
|
require.NotEmpty(t, docToken, "document token should be created before fetch")
|
|
|
|
result, err := clie2e.RunCmd(ctx, clie2e.Request{
|
|
Args: []string{"docs", "+fetch", "--doc", docToken, "--doc-format", "markdown"},
|
|
DefaultAs: defaultAs,
|
|
})
|
|
require.NoError(t, err)
|
|
result.AssertExitCode(t, 0)
|
|
result.AssertStdoutStatus(t, true)
|
|
content := gjson.Get(result.Stdout, "data.document.content").String()
|
|
assert.Contains(t, content, docTitle)
|
|
assert.Contains(t, content, "Created with user access token.")
|
|
})
|
|
}
|