mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 14:02:43 +08:00
df4b657737
Bidirectional sync between a local directory and a Drive folder with diff detection (new_local, new_remote, modified, unchanged) and conflict resolution strategies (--on-conflict: remote-wins, local-wins, keep-both, ask). Key behaviors: - Type conflict detection: hard-fail when local file vs remote non-file or local directory vs remote file - Keep-both: rename local with __lark_<hash> suffix, then pull remote; occupied map includes localDirs to prevent suffix collision - Local-wins partial-success: prefer returned file_token on upload failure - Empty directory mirroring: pre-create local dirs on Drive via drivePushWalkLocal before scope preflight - Structured errors throughout (output.Errorf / output.ErrWithHint) Includes unit tests and E2E tests (dry-run + live workflow).
259 lines
8.1 KiB
Go
259 lines
8.1 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"
|
|
"github.com/tidwall/gjson"
|
|
)
|
|
|
|
// TestDrive_SyncDryRun locks in the request shape the +sync 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_SyncDryRun(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", "+sync",
|
|
"--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 := gjson.Get(out, "api.0.method").String(); got != "GET" {
|
|
t.Fatalf("method = %q, want GET\nstdout:\n%s", got, out)
|
|
}
|
|
if got := gjson.Get(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 := gjson.Get(out, "folder_token").String(); got != "fldcnE2E001" {
|
|
t.Fatalf("folder_token = %q, want fldcnE2E001\nstdout:\n%s", got, out)
|
|
}
|
|
desc := gjson.Get(out, "description").String()
|
|
if !strings.Contains(desc, "diff") {
|
|
t.Fatalf("description missing diff phrase, got %q\nstdout:\n%s", desc, out)
|
|
}
|
|
}
|
|
|
|
// TestDrive_SyncDryRunRejectsAbsoluteLocalDir confirms the path validator
|
|
// runs in the real binary's Validate stage and surfaces a structured error
|
|
// referencing --local-dir.
|
|
func TestDrive_SyncDryRunRejectsAbsoluteLocalDir(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", "+sync",
|
|
"--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_SyncDryRunRejectsMissingFolderToken confirms cobra's
|
|
// required-flag enforcement runs before our custom Validate.
|
|
func TestDrive_SyncDryRunRejectsMissingFolderToken(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", "+sync",
|
|
"--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)
|
|
}
|
|
}
|
|
|
|
// TestDrive_SyncDryRunAcceptsConflictStrategies verifies that all valid
|
|
// --on-conflict values pass Validate and produce a well-formed dry-run
|
|
// envelope.
|
|
func TestDrive_SyncDryRunAcceptsConflictStrategies(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{"remote-wins", "local-wins", "keep-both", "ask"} {
|
|
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", "+sync",
|
|
"--local-dir", "local",
|
|
"--folder-token", "fldcnE2E001",
|
|
"--on-conflict", strategy,
|
|
"--dry-run",
|
|
},
|
|
WorkDir: workDir,
|
|
DefaultAs: "user",
|
|
})
|
|
require.NoError(t, err)
|
|
result.AssertExitCode(t, 0)
|
|
|
|
out := result.Stdout
|
|
if got := gjson.Get(out, "api.0.method").String(); got != "GET" {
|
|
t.Fatalf("method = %q, want GET\nstdout:\n%s", got, out)
|
|
}
|
|
if got := gjson.Get(out, "folder_token").String(); got != "fldcnE2E001" {
|
|
t.Fatalf("folder_token = %q, want fldcnE2E001\nstdout:\n%s", got, out)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// TestDrive_SyncDryRunAcceptsDuplicateRemoteStrategies verifies that all
|
|
// valid --on-duplicate-remote values pass Validate.
|
|
func TestDrive_SyncDryRunAcceptsDuplicateRemoteStrategies(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{"fail", "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", "+sync",
|
|
"--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 := gjson.Get(out, "folder_token").String(); got != "fldcnE2E001" {
|
|
t.Fatalf("folder_token = %q, want fldcnE2E001\nstdout:\n%s", got, out)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// TestDrive_SyncDryRunAcceptsQuickFlag verifies that --quick passes Validate
|
|
// and produces a well-formed dry-run envelope.
|
|
func TestDrive_SyncDryRunAcceptsQuickFlag(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", "+sync",
|
|
"--local-dir", "local",
|
|
"--folder-token", "fldcnE2E001",
|
|
"--quick",
|
|
"--dry-run",
|
|
},
|
|
WorkDir: workDir,
|
|
DefaultAs: "user",
|
|
})
|
|
require.NoError(t, err)
|
|
result.AssertExitCode(t, 0)
|
|
|
|
out := result.Stdout
|
|
if got := gjson.Get(out, "api.0.method").String(); got != "GET" {
|
|
t.Fatalf("method = %q, want GET\nstdout:\n%s", got, out)
|
|
}
|
|
if got := gjson.Get(out, "folder_token").String(); got != "fldcnE2E001" {
|
|
t.Fatalf("folder_token = %q, want fldcnE2E001\nstdout:\n%s", got, out)
|
|
}
|
|
}
|