mirror of
https://github.com/larksuite/cli.git
synced 2026-09-14 18:42:53 +08:00
evandance
b07be60068
Emit structured validation, API, network, file, and internal error envelopes for Sheets shortcuts so users and agents can recover from failed spreadsheet workflows using stable type, subtype, param, and code fields. Add Sheets domain errscontract and golangci guards to prevent legacy envelope and common helper regressions.
71 lines
2.4 KiB
Go
71 lines
2.4 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package sheets
|
|
|
|
import (
|
|
"errors"
|
|
"os"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
"github.com/larksuite/cli/internal/cmdutil"
|
|
_ "github.com/larksuite/cli/internal/vfs/localfileio"
|
|
"github.com/larksuite/cli/shortcuts/common"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func newCSVGuardRuntime(csvVal string) *common.RuntimeContext {
|
|
cmd := &cobra.Command{Use: "test"}
|
|
cmd.Flags().String("csv", "", "")
|
|
cmd.ParseFlags(nil)
|
|
cmd.Flags().Set("csv", csvVal)
|
|
return &common.RuntimeContext{Cmd: cmd}
|
|
}
|
|
|
|
// TestGuardCSVValueIsNotFilePath verifies the guard flags a bare --csv value
|
|
// only when it names a real file (a forgotten @), while leaving genuine inline
|
|
// content alone — including the case the old name-shape heuristic got wrong:
|
|
// prose that merely ends in or mentions a filename.
|
|
func TestGuardCSVValueIsNotFilePath(t *testing.T) {
|
|
dir := t.TempDir()
|
|
cmdutil.TestChdir(t, dir)
|
|
if err := os.WriteFile("data.csv", []byte("a,b\n1,2\n"), 0644); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
// Bare value naming an existing file → guarded with a fix-it hint.
|
|
err := guardCSVValueIsNotFilePath(newCSVGuardRuntime("data.csv"))
|
|
if err == nil {
|
|
t.Fatal("expected guard error when --csv names an existing file")
|
|
}
|
|
if !strings.Contains(err.Error(), "existing file") || !strings.Contains(err.Error(), "@data.csv") {
|
|
t.Errorf("error should flag the file and suggest @data.csv, got: %v", err)
|
|
}
|
|
if p, ok := errs.ProblemOf(err); !ok || p.Category != errs.CategoryValidation || p.Subtype != errs.SubtypeInvalidArgument {
|
|
t.Errorf("problem = %+v, want validation/invalid_argument", p)
|
|
}
|
|
var ve *errs.ValidationError
|
|
if !errors.As(err, &ve) {
|
|
t.Fatalf("guard error = %T, want *errs.ValidationError", err)
|
|
}
|
|
if ve.Param != "--csv" {
|
|
t.Errorf("param = %q, want --csv", ve.Param)
|
|
}
|
|
|
|
// Content that is not a real file must pass through unchanged.
|
|
for _, v := range []string{
|
|
"改完记得更新config.json", // prose ending in a filename — not a real file
|
|
"remember to update data.csv", // mentions the real file but isn't its name
|
|
"a,b\n1,2", // multi-cell CSV
|
|
"hello world",
|
|
"nope.csv", // path-shaped but no such file
|
|
"",
|
|
} {
|
|
if err := guardCSVValueIsNotFilePath(newCSVGuardRuntime(v)); err != nil {
|
|
t.Errorf("content %q must pass through, got: %v", v, err)
|
|
}
|
|
}
|
|
}
|