mirror of
https://github.com/alibaba/open-code-review.git
synced 2026-11-15 03:57:46 +08:00
pablo
742495ca61
* docs: use subtask instead of file/file-group in user-facing docs * docs: use subtask in scan --max-tools help
108 lines
3.9 KiB
Go
108 lines
3.9 KiB
Go
// SPDX-License-Identifier: Apache-2.0
|
|
// Copyright 2026 alibaba/open-code-review Contributors
|
|
|
|
package main
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
// TestCLIReferenceDocumentsSessionCompare pins that every locale of the CLI
|
|
// reference documents `ocr session compare`. The four files are hand-synced
|
|
// (see PR #920), so the usual failure is a new command landing in `en` only.
|
|
// ponytail: substring checks, not a markdown parse - the whole point is to
|
|
// catch a missing file, and a parser would not catch it any better.
|
|
func TestCLIReferenceDocumentsSessionCompare(t *testing.T) {
|
|
for _, locale := range []string{"en", "zh", "ja", "ru"} {
|
|
t.Run(locale, func(t *testing.T) {
|
|
path := filepath.Join("..", "..", "pages", "src", "content", "docs", locale, "cli-reference.md")
|
|
body, err := os.ReadFile(path)
|
|
if err != nil {
|
|
t.Fatalf("read %s: %v", path, err)
|
|
}
|
|
for _, want := range []string{
|
|
"`ocr session compare <before> <after>`", // command-summary table row
|
|
"### `ocr session compare`", // reference section
|
|
"`ocr session diff <before> <after>`", // alias
|
|
"not_reviewed", // the JSON bucket that is easy to forget
|
|
} {
|
|
if !strings.Contains(string(body), want) {
|
|
t.Errorf("%s: missing %q", path, want)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// TestCLIReferenceUsesSubtaskUnit pins that every locale of the CLI reference
|
|
// describes --concurrency/--timeout/--max-tools/--max-tokens/--no-filter in
|
|
// terms of a subtask, not a file or file group. The five files are
|
|
// hand-synced; the usual failure is one locale keeping the old unit.
|
|
func TestCLIReferenceUsesSubtaskUnit(t *testing.T) {
|
|
type localePin struct {
|
|
locale string
|
|
term string
|
|
}
|
|
pins := []localePin{
|
|
{locale: "en", term: "subtask"},
|
|
{locale: "zh", term: "子任务"}, // allow-non-english: locale subtask term from issue 1273
|
|
{locale: "ja", term: "サブタスク"}, // allow-non-english: locale subtask term from issue 1273
|
|
{locale: "ko", term: "서브태스크"}, // allow-non-english: locale subtask term from issue 1273
|
|
{locale: "ru", term: "подзадач"}, // allow-non-english: locale subtask stem from issue 1273
|
|
}
|
|
flagMarkers := []string{
|
|
"| `--no-filter` |",
|
|
"| `--concurrency <n>` |",
|
|
"| `--timeout <minutes>` |",
|
|
"| `--max-tools <n>` |",
|
|
"| `--max-tokens <n>` |",
|
|
}
|
|
leakedConcurrencyUnits := []string{
|
|
"file group", "file groups", "files reviewed", "file scans",
|
|
"文件组", "文件数", // allow-non-english: old zh file/file-group unit
|
|
"ファイルグループ", "ファイルの最大", // allow-non-english: old ja file/file-group unit
|
|
"파일 그룹", // allow-non-english: old ko file-group unit
|
|
"число файлов", "группу файлов", "группы файлов", // allow-non-english: old ru file/file-group unit
|
|
}
|
|
|
|
for _, pin := range pins {
|
|
t.Run(pin.locale, func(t *testing.T) {
|
|
path := filepath.Join("..", "..", "pages", "src", "content", "docs", pin.locale, "cli-reference.md")
|
|
raw, err := os.ReadFile(path)
|
|
if err != nil {
|
|
t.Fatalf("read %s: %v", path, err)
|
|
}
|
|
body := string(raw)
|
|
for _, marker := range flagMarkers {
|
|
row, ok := firstLineContaining(body, marker)
|
|
if !ok {
|
|
t.Errorf("%s: missing flag row %q", path, marker)
|
|
continue
|
|
}
|
|
if !strings.Contains(row, pin.term) {
|
|
t.Errorf("%s: row %q does not use %q", path, row, pin.term)
|
|
}
|
|
if marker == "| `--concurrency <n>` |" {
|
|
for _, leaked := range leakedConcurrencyUnits {
|
|
if strings.Contains(row, leaked) {
|
|
t.Errorf("%s: --concurrency still describes a file/file-group count (%q): %s", path, leaked, row)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func firstLineContaining(body, marker string) (string, bool) {
|
|
for _, line := range strings.Split(body, "\n") {
|
|
if strings.Contains(line, marker) {
|
|
return line, true
|
|
}
|
|
}
|
|
return "", false
|
|
}
|