mirror of
https://github.com/larksuite/cli.git
synced 2026-08-03 08:32:46 +08:00
37d490a198
* 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>
66 lines
2.0 KiB
Go
66 lines
2.0 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package sheets
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
"time"
|
|
|
|
clie2e "github.com/larksuite/cli/tests/cli_e2e"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/tidwall/gjson"
|
|
)
|
|
|
|
// TestSheets_GridlineDryRun pins the +sheet-show-gridline / +sheet-hide-gridline
|
|
// dry-run shape: each emits a single modify_workbook_structure invoke_write with
|
|
// the correct operation name. These are the shortcuts added in this branch, so
|
|
// AGENTS.md requires a dry-run E2E to catch a request-shape regression early
|
|
// (before the live call hits a real spreadsheet).
|
|
func TestSheets_GridlineDryRun(t *testing.T) {
|
|
setSheetsDryRunEnv(t)
|
|
|
|
tests := []struct {
|
|
name string
|
|
shortcut string
|
|
wantOpName string
|
|
}{
|
|
{name: "show", shortcut: "+sheet-show-gridline", wantOpName: "show_gridline"},
|
|
{name: "hide", shortcut: "+sheet-hide-gridline", wantOpName: "hide_gridline"},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
t.Cleanup(cancel)
|
|
|
|
result, err := clie2e.RunCmd(ctx, clie2e.Request{
|
|
Args: []string{
|
|
"sheets", tt.shortcut,
|
|
"--spreadsheet-token", "shtDryRun",
|
|
"--sheet-id", "sheet1",
|
|
"--dry-run",
|
|
},
|
|
DefaultAs: "user",
|
|
})
|
|
if result != nil {
|
|
result.Stdout = clie2e.DryRunData(result.Stdout)
|
|
}
|
|
require.NoError(t, err)
|
|
result.AssertExitCode(t, 0)
|
|
|
|
out := result.Stdout
|
|
|
|
require.Equal(t, "POST", gjson.Get(out, "api.0.method").String(), "stdout:\n%s", out)
|
|
require.Equal(t, "/open-apis/sheet_ai/v2/spreadsheets/shtDryRun/tools/invoke_write",
|
|
gjson.Get(out, "api.0.url").String(), "stdout:\n%s", out)
|
|
require.Equal(t, "modify_workbook_structure",
|
|
gjson.Get(out, "api.0.body.tool_name").String(), "stdout:\n%s", out)
|
|
input := gjson.Get(out, "api.0.body.input").String()
|
|
require.Contains(t, input, `"operation":"`+tt.wantOpName+`"`, "stdout:\n%s", out)
|
|
require.Contains(t, input, `"sheet_id":"sheet1"`, "stdout:\n%s", out)
|
|
})
|
|
}
|
|
}
|