mirror of
https://github.com/larksuite/cli.git
synced 2026-08-03 08:32:46 +08:00
* fix: unify dry-run output contract
* fix: address dry-run review feedback
* fix(dryrun): tighten preview contract and unify data shape
- transcribe HTTP method verbatim in previews (HEAD/OPTIONS were
reported as GET); reject an empty method in api with a typed error
- unify the dry-run data payload across api/service/shortcut paths:
{api, context?: {app_id, user_open_id}}; drop data.as — the envelope
top-level identity is the single identity source
- mark pretty dry-run stdout with '# dry-run: request not sent' so logs
that drop stderr still show it was a preview
- extract the shared preview builder, collapse PrintDryRunWithFile's
loose params into FileUploadMeta, and fail loudly on nil previews
- revert description-marker identity parsing: stale prose must not
override corrected accessTokens (blocks legal user calls on
images.create); identity gating keys off accessTokens only
- pin the new contracts with tests: verbatim method, three-way context
parity, nil-preview error, empty-context omission, marker line
* docs(agents): add typed-data, faithful-transcription, and contract-test conventions
- typed struct at the boundary over map[string]interface{} threading;
distinct types where values could swap silently (internal/meta.Token)
- transcribe input verbatim in previews/transformations; reject
unhonorable flag combinations with typed errors instead of silently
substituting behavior
- contract tests must fail when the implementation is reverted
* test: migrate dry-run tests grown on main to the envelope format
main gained raw-format dry-run readers while the PR was in flight
(wiki drive export #1802, drive list comments #1845, slash commands,
sheets history, docs fetch, mail draft-send/triage, vc meeting events).
Migrate them to the envelope accessors (clie2e.DryRunGet / data-wrapped
decoders) and drop the now-redundant DryRunData extractions in files
unified on DryRunGet.
---------
Co-authored-by: guokexin.02 <264159873+Tantanz20020918@users.noreply.github.com>
251 lines
7.9 KiB
Go
251 lines
7.9 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package drive
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
clie2e "github.com/larksuite/cli/tests/cli_e2e"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
// TestDrive_PullDryRun locks in the request shape the +pull shortcut emits
|
|
// under --dry-run: the real CLI binary is invoked end-to-end, so flag
|
|
// parsing, Validate (still runs in dry-run mode), and the dry-run renderer
|
|
// all execute. The printed envelope is then inspected for GET method,
|
|
// list-files URL, the folder_token parameter, and key phrases from Desc.
|
|
//
|
|
// Fake credentials are sufficient because --dry-run short-circuits before
|
|
// any real network call.
|
|
func TestDrive_PullDryRun(t *testing.T) {
|
|
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
|
|
t.Setenv("LARKSUITE_CLI_APP_ID", "app")
|
|
t.Setenv("LARKSUITE_CLI_APP_SECRET", "secret")
|
|
t.Setenv("LARKSUITE_CLI_BRAND", "feishu")
|
|
|
|
workDir := t.TempDir()
|
|
if err := os.MkdirAll(filepath.Join(workDir, "local"), 0o755); err != nil {
|
|
t.Fatalf("MkdirAll: %v", err)
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
t.Cleanup(cancel)
|
|
|
|
result, err := clie2e.RunCmd(ctx, clie2e.Request{
|
|
Args: []string{
|
|
"drive", "+pull",
|
|
"--local-dir", "local",
|
|
"--folder-token", "fldcnE2E001",
|
|
"--dry-run",
|
|
},
|
|
WorkDir: workDir,
|
|
DefaultAs: "user",
|
|
})
|
|
require.NoError(t, err)
|
|
result.AssertExitCode(t, 0)
|
|
|
|
out := result.Stdout
|
|
if got := clie2e.DryRunGet(out, "api.0.method").String(); got != "GET" {
|
|
t.Fatalf("method = %q, want GET\nstdout:\n%s", got, out)
|
|
}
|
|
if got := clie2e.DryRunGet(out, "api.0.url").String(); got != "/open-apis/drive/v1/files" {
|
|
t.Fatalf("url = %q, want /open-apis/drive/v1/files\nstdout:\n%s", got, out)
|
|
}
|
|
if got := clie2e.DryRunGet(out, "folder_token").String(); got != "fldcnE2E001" {
|
|
t.Fatalf("folder_token = %q, want fldcnE2E001\nstdout:\n%s", got, out)
|
|
}
|
|
desc := clie2e.DryRunGet(out, "description").String()
|
|
if !strings.Contains(desc, "list --folder-token") {
|
|
t.Fatalf("description missing list phrase, got %q\nstdout:\n%s", desc, out)
|
|
}
|
|
}
|
|
|
|
// TestDrive_PullDryRunRejectsAbsoluteLocalDir confirms the path validator
|
|
// runs in the real binary's Validate stage and surfaces a structured error
|
|
// referencing --local-dir.
|
|
func TestDrive_PullDryRunRejectsAbsoluteLocalDir(t *testing.T) {
|
|
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
|
|
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{
|
|
"drive", "+pull",
|
|
"--local-dir", "/etc",
|
|
"--folder-token", "fldcnE2E001",
|
|
"--dry-run",
|
|
},
|
|
WorkDir: t.TempDir(),
|
|
DefaultAs: "user",
|
|
})
|
|
require.NoError(t, err)
|
|
if result.ExitCode == 0 {
|
|
t.Fatalf("absolute --local-dir must be rejected, got exit=0\nstdout:\n%s", result.Stdout)
|
|
}
|
|
combined := result.Stdout + "\n" + result.Stderr
|
|
if !strings.Contains(combined, "--local-dir") {
|
|
t.Fatalf("expected --local-dir in error, got:\nstdout:\n%s\nstderr:\n%s", result.Stdout, result.Stderr)
|
|
}
|
|
}
|
|
|
|
// TestDrive_PullDryRunRejectsDeleteLocalWithoutYes locks in the safety
|
|
// guard: --delete-local without --yes must be refused upfront, even under
|
|
// --dry-run, so an unintended delete flag never silently slides through.
|
|
func TestDrive_PullDryRunRejectsDeleteLocalWithoutYes(t *testing.T) {
|
|
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
|
|
t.Setenv("LARKSUITE_CLI_APP_ID", "app")
|
|
t.Setenv("LARKSUITE_CLI_APP_SECRET", "secret")
|
|
t.Setenv("LARKSUITE_CLI_BRAND", "feishu")
|
|
|
|
workDir := t.TempDir()
|
|
if err := os.MkdirAll(filepath.Join(workDir, "local"), 0o755); err != nil {
|
|
t.Fatalf("MkdirAll: %v", err)
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
t.Cleanup(cancel)
|
|
|
|
result, err := clie2e.RunCmd(ctx, clie2e.Request{
|
|
Args: []string{
|
|
"drive", "+pull",
|
|
"--local-dir", "local",
|
|
"--folder-token", "fldcnE2E001",
|
|
"--delete-local",
|
|
"--dry-run",
|
|
},
|
|
WorkDir: workDir,
|
|
DefaultAs: "user",
|
|
})
|
|
require.NoError(t, err)
|
|
if result.ExitCode == 0 {
|
|
t.Fatalf("--delete-local without --yes must be rejected, got exit=0\nstdout:\n%s", result.Stdout)
|
|
}
|
|
combined := result.Stdout + "\n" + result.Stderr
|
|
if !strings.Contains(combined, "--yes") {
|
|
t.Fatalf("expected --yes hint in error, got:\nstdout:\n%s\nstderr:\n%s", result.Stdout, result.Stderr)
|
|
}
|
|
}
|
|
|
|
// TestDrive_PullDryRunRejectsMissingFolderToken confirms cobra's
|
|
// required-flag enforcement runs before our custom Validate.
|
|
func TestDrive_PullDryRunRejectsMissingFolderToken(t *testing.T) {
|
|
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
|
|
t.Setenv("LARKSUITE_CLI_APP_ID", "app")
|
|
t.Setenv("LARKSUITE_CLI_APP_SECRET", "secret")
|
|
t.Setenv("LARKSUITE_CLI_BRAND", "feishu")
|
|
|
|
workDir := t.TempDir()
|
|
if err := os.MkdirAll(filepath.Join(workDir, "local"), 0o755); err != nil {
|
|
t.Fatalf("MkdirAll: %v", err)
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
t.Cleanup(cancel)
|
|
|
|
result, err := clie2e.RunCmd(ctx, clie2e.Request{
|
|
Args: []string{
|
|
"drive", "+pull",
|
|
"--local-dir", "local",
|
|
"--dry-run",
|
|
},
|
|
WorkDir: workDir,
|
|
DefaultAs: "user",
|
|
})
|
|
require.NoError(t, err)
|
|
if result.ExitCode == 0 {
|
|
t.Fatalf("missing --folder-token must be rejected, got exit=0\nstdout:\n%s", result.Stdout)
|
|
}
|
|
combined := result.Stdout + "\n" + result.Stderr
|
|
if !strings.Contains(combined, "folder-token") {
|
|
t.Fatalf("expected folder-token in error, got:\nstdout:\n%s\nstderr:\n%s", result.Stdout, result.Stderr)
|
|
}
|
|
}
|
|
|
|
func TestDrive_PullDryRunAcceptsDuplicateRemoteStrategies(t *testing.T) {
|
|
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
|
|
t.Setenv("LARKSUITE_CLI_APP_ID", "app")
|
|
t.Setenv("LARKSUITE_CLI_APP_SECRET", "secret")
|
|
t.Setenv("LARKSUITE_CLI_BRAND", "feishu")
|
|
|
|
for _, strategy := range []string{"rename", "newest", "oldest"} {
|
|
t.Run(strategy, func(t *testing.T) {
|
|
workDir := t.TempDir()
|
|
if err := os.MkdirAll(filepath.Join(workDir, "local"), 0o755); err != nil {
|
|
t.Fatalf("MkdirAll: %v", err)
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
t.Cleanup(cancel)
|
|
|
|
result, err := clie2e.RunCmd(ctx, clie2e.Request{
|
|
Args: []string{
|
|
"drive", "+pull",
|
|
"--local-dir", "local",
|
|
"--folder-token", "fldcnE2E001",
|
|
"--on-duplicate-remote", strategy,
|
|
"--dry-run",
|
|
},
|
|
WorkDir: workDir,
|
|
DefaultAs: "user",
|
|
})
|
|
require.NoError(t, err)
|
|
result.AssertExitCode(t, 0)
|
|
|
|
out := result.Stdout
|
|
if got := clie2e.DryRunGet(out, "api.0.method").String(); got != "GET" {
|
|
t.Fatalf("method = %q, want GET\nstdout:\n%s", got, out)
|
|
}
|
|
if got := clie2e.DryRunGet(out, "folder_token").String(); got != "fldcnE2E001" {
|
|
t.Fatalf("folder_token = %q, want fldcnE2E001\nstdout:\n%s", got, out)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestDrive_PullDryRunAcceptsIfExistsSmart(t *testing.T) {
|
|
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
|
|
t.Setenv("LARKSUITE_CLI_APP_ID", "app")
|
|
t.Setenv("LARKSUITE_CLI_APP_SECRET", "secret")
|
|
t.Setenv("LARKSUITE_CLI_BRAND", "feishu")
|
|
|
|
workDir := t.TempDir()
|
|
if err := os.MkdirAll(filepath.Join(workDir, "local"), 0o755); err != nil {
|
|
t.Fatalf("MkdirAll: %v", err)
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
t.Cleanup(cancel)
|
|
|
|
result, err := clie2e.RunCmd(ctx, clie2e.Request{
|
|
Args: []string{
|
|
"drive", "+pull",
|
|
"--local-dir", "local",
|
|
"--folder-token", "fldcnE2E001",
|
|
"--if-exists", "smart",
|
|
"--dry-run",
|
|
},
|
|
WorkDir: workDir,
|
|
DefaultAs: "user",
|
|
})
|
|
require.NoError(t, err)
|
|
result.AssertExitCode(t, 0)
|
|
|
|
out := result.Stdout
|
|
if got := clie2e.DryRunGet(out, "api.0.method").String(); got != "GET" {
|
|
t.Fatalf("method = %q, want GET\nstdout:\n%s", got, out)
|
|
}
|
|
if got := clie2e.DryRunGet(out, "folder_token").String(); got != "fldcnE2E001" {
|
|
t.Fatalf("folder_token = %q, want fldcnE2E001\nstdout:\n%s", got, out)
|
|
}
|
|
}
|