diff --git a/README.md b/README.md index 4e13db9..94f8b80 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,7 @@ teai [全域選項] <命令> [參數] | 命令 | 對應 gitea.py | 說明 | | --- | --- | --- | +| `teai login list\|add\|default\|remove` | — | 管理 tea 相容登入組態(見下) | | `teai whoami` | `get_current_username` | 目前帳號 | | `teai orgs` | `for_all_organizations` | 我所屬的組織 | | `teai members [--has-work]` | `members [--has-work]` | Agents 團隊成員;`--has-work` 只列有未完成工作者 | @@ -103,6 +104,25 @@ teai next --output table # 人類可讀 } ``` +### `teai login` — 管理登入 + +teai 與 tea 共用同一份組態檔(`--config`/`TEA_CONFIG`,預設 `~/.config/tea/config.yml`)。 +寫入採行級編輯:只動目標項目的行,未知欄位(`ssh_*` 等)與 `preferences` 區段逐字保留, +不改壞 tea 也在使用的檔案;檔案權限 `0600`、暫存檔原子替換。 + +```sh +teai login list # 列出登入(一律不含 token) +teai login add [--url ] [--name <名稱>] [--default=false] [--token ] + # 先以 token 呼叫 GET /user 驗證,成功才寫入(並記下帳號) +teai login default <名稱> # 設定預設登入 +teai login remove <名稱> [--yes] # 移除登入;移除預設者時其餘第一筆自動遞補 +``` + +- `login add` 未給 `--token` 時自 stdin 讀一行,避免 token 進 shell 歷史;token 驗證失敗(401) + 不寫入,結束碼 3。 +- 未給 `--name` 時:同站(URL 主機相同)已有登入 → 就地更新該項目;否則以 URL 主機為名稱。 +- 輸出 JSON(`--output table` 供人工查看),欄位 `name`/`url`/`user`/`default`,**永不輸出 token**。 + ### `teai stalled [--hours N]` — 管理者巡邏 ```sh diff --git a/internal/cli/cli.go b/internal/cli/cli.go index 7b5040a..7c16996 100644 --- a/internal/cli/cli.go +++ b/internal/cli/cli.go @@ -89,6 +89,11 @@ type Env struct { // commands 是已註冊的子命令表。新增功能時在這裡註冊即可。 var commands = map[string]*command{ + "login": { + name: "login", + usage: "管理登入(list/add/default/remove)", + run: runLogin, + }, "version": { name: "version", usage: "顯示版本資訊", diff --git a/internal/cli/login.go b/internal/cli/login.go new file mode 100644 index 0000000..e861702 --- /dev/null +++ b/internal/cli/login.go @@ -0,0 +1,365 @@ +// login.go — teai login 指令:管理 tea 相容的登入組態。 +// +// teai 與 tea 共用同一份組態檔(README 設計原則 5),login 的職責是: +// 以 token 向站點驗證(GET /user),成功後才寫入組態並記下帳號。 +// token 只走記憶體與組態檔,不進輸出、日誌或錯誤訊息。 +// +// 子命令:list/add/default/remove。 +package cli + +import ( + "bufio" + "context" + "errors" + "flag" + "fmt" + "io" + "net/url" + "os" + "path/filepath" + "strings" + + "gitea.alterminal.com/alterminal/teai/internal/gitea" +) + +// loginStdin 是讀 token 與確認的輸入(測試可替換)。 +var loginStdin io.Reader = os.Stdin + +// loginConfigPath 回傳組態檔路徑:--config/TEA_CONFIG 優先,其次 +// ~/.config/tea/config.yml。找不到可用路徑回空字串。 +func loginConfigPath(g Globals) string { + if p := strings.TrimSpace(g.ConfigPath); p != "" { + return expandHome(p) + } + if p := os.Getenv("TEA_CONFIG"); strings.TrimSpace(p) != "" { + return expandHome(strings.TrimSpace(p)) + } + home, err := os.UserHomeDir() + if err != nil || home == "" { + return "" + } + return filepath.Join(home, ".config", "tea", "config.yml") +} + +// expandHome 展開路徑開頭的 ~。 +func expandHome(p string) string { + if p == "~" || strings.HasPrefix(p, "~/") { + if home, err := os.UserHomeDir(); err == nil { + return filepath.Join(home, strings.TrimPrefix(p, "~")) + } + } + return p +} + +// runLogin 是 teai login 的進入點:分派子命令。 +func runLogin(env *Env, args []string) error { + if len(args) == 0 { + return &ErrUsage{Msg: "login requires a subcommand: list, add, default, remove"} + } + sub, rest := args[0], args[1:] + switch sub { + case "list": + return runLoginList(env, rest) + case "add": + return runLoginAdd(env, rest) + case "default": + return runLoginDefault(env, rest) + case "remove": + return runLoginRemove(env, rest) + default: + return &ErrUsage{Msg: fmt.Sprintf("unknown login subcommand %q (want list, add, default, remove)", sub)} + } +} + +// loginFields 是輸出欄位(不含 token)。 +var loginFields = []gitea.Field{ + {Name: "name"}, + {Name: "url"}, + {Name: "user"}, + {Name: "default"}, +} + +// printLoginList 依格式輸出登入清單。 +func printLoginList(env *Env, logins []gitea.LoginEntry) error { + p := gitea.Printer{Format: env.Globals.Output, Out: env.Out} + rows := make([]gitea.Values, 0, len(logins)) + for _, l := range logins { + rows = append(rows, gitea.Values{l.Name, l.URL, l.User, l.Default}) + } + return p.PrintList(loginFields, rows) +} + +// runLoginList 列出組態中的登入(一律不含 token)。 +func runLoginList(env *Env, args []string) error { + fs := flag.NewFlagSet("teai login list", flag.ContinueOnError) + fs.SetOutput(env.Err) + if err := fs.Parse(args); err != nil { + return &ErrUsage{Msg: err.Error()} + } + if fs.NArg() > 0 { + return &ErrUsage{Msg: fmt.Sprintf("unexpected argument %q", fs.Arg(0))} + } + path := loginConfigPath(env.Globals) + if path == "" { + return fmt.Errorf("cannot determine config path") + } + logins, err := gitea.ListLoginsFile(path) + if err != nil { + return fmt.Errorf("read config %s: %w", path, err) + } + return printLoginList(env, logins) +} + +// runLoginAdd 新增或更新登入:先驗證 token(GET /user),成功才寫入。 +// +// token 來源:--token 旗標,或 stdin(預設未給旗標時讀一行, +// 避免 token 進 shell 歷史)。 +func runLoginAdd(env *Env, args []string) error { + fs := flag.NewFlagSet("teai login add", flag.ContinueOnError) + fs.SetOutput(env.Err) + urlFlag := fs.String("url", env.Globals.URL, "Gitea 站點網址") + nameFlag := fs.String("name", "", "登入名稱(省略時取 URL 主機)") + tokenFlag := fs.String("token", "", "API token(省略時自 stdin 讀一行)") + defaultFlag := fs.Bool("default", true, "設為預設登入") + if err := fs.Parse(args); err != nil { + return &ErrUsage{Msg: err.Error()} + } + if fs.NArg() > 0 { + return &ErrUsage{Msg: fmt.Sprintf("unexpected argument %q", fs.Arg(0))} + } + siteURL := strings.TrimSuffix(strings.TrimSpace(*urlFlag), "/") + if siteURL == "" { + return &ErrUsage{Msg: "--url must not be empty"} + } + + token := strings.TrimSpace(*tokenFlag) + if token == "" { + t, err := readLineFrom(loginStdin) + if err != nil { + return fmt.Errorf("read token from stdin: %w", err) + } + token = t + } + if token == "" { + return &ErrUsage{Msg: "token must not be empty"} + } + + path := loginConfigPath(env.Globals) + if path == "" { + return fmt.Errorf("cannot determine config path") + } + data, err := os.ReadFile(path) + if err != nil && !os.IsNotExist(err) { + return fmt.Errorf("read config %s: %w", path, err) + } + + name := strings.TrimSpace(*nameFlag) + if name == "" { + // 未指定名稱:同站(主機相同)已有登入就就地更新,避免重複項目。 + if existing, ok := findLoginByHost(data, siteURL); ok { + name = existing.Name + } else { + name = defaultLoginName(siteURL) + } + } + + // 先驗證再寫入:token 無效時不動組態檔。 + user, err := verifyToken(env, siteURL, token) + if err != nil { + return err + } + out, final, err := gitea.UpsertLogin(data, gitea.LoginEntry{ + Name: name, + URL: siteURL, + Token: token, + Default: *defaultFlag, + User: user, + }, *defaultFlag) + if err != nil { + return err + } + if err := gitea.SaveTeaConfigFile(path, out); err != nil { + return err + } + p := gitea.Printer{Format: env.Globals.Output, Out: env.Out} + return p.PrintOne(loginFields, gitea.Values{final.Name, final.URL, final.User, final.Default}) +} + +// readLineFrom 讀一行並去除頭尾空白;EOF 且無內容回空字串。 +func readLineFrom(r io.Reader) (string, error) { + line, err := bufio.NewReader(r).ReadString('\n') + if err != nil && err != io.EOF { + return "", err + } + return strings.TrimSpace(line), nil +} + +// verifyToken 以 token 呼叫 GET /user,回傳帳號名稱。 +// 401 特別標明是 token 遭拒,其餘依 *gitea.ErrAPI 對應結束碼 3。 +func verifyToken(env *Env, siteURL, token string) (string, error) { + c, err := gitea.New(siteURL, token, env.Globals.Timeout) + if err != nil { + return "", &ErrUsage{Msg: err.Error()} + } + ctx, cancel := context.WithTimeout(context.Background(), env.Globals.Timeout) + defer cancel() + var out struct { + Login string `json:"login"` + } + if err := c.GetJSON(ctx, "/user", &out); err != nil { + var api *gitea.ErrAPI + if errors.As(err, &api) && api.StatusCode == 401 { + // 包 %w 保留 *ErrAPI:結束碼對應 3(API 錯誤)。 + return "", fmt.Errorf("token rejected by %s: %w", siteURL, api) + } + return "", err + } + if out.Login == "" { + return "", fmt.Errorf("empty account name returned by %s", siteURL) + } + return out.Login, nil +} + +// runLoginDefault 設定預設登入。 +func runLoginDefault(env *Env, args []string) error { + fs := flag.NewFlagSet("teai login default", flag.ContinueOnError) + fs.SetOutput(env.Err) + if err := fs.Parse(args); err != nil { + return &ErrUsage{Msg: err.Error()} + } + if fs.NArg() != 1 { + return &ErrUsage{Msg: "login default requires exactly one login name"} + } + name := fs.Arg(0) + data, err := readLoginConfig(env, "login default") + if err != nil { + return err + } + entry, found := findLogin(data, name) + if !found { + return fmt.Errorf("gitea: login %q not found", name) + } + out, err := gitea.SetDefaultLogin(data, name) + if err != nil { + return err + } + if err := saveLoginConfig(env, out); err != nil { + return err + } + p := gitea.Printer{Format: env.Globals.Output, Out: env.Out} + return p.PrintOne(loginFields, gitea.Values{entry.Name, entry.URL, entry.User, true}) +} + +// runLoginRemove 移除登入;未加 --yes 時先確認。 +func runLoginRemove(env *Env, args []string) error { + fs := flag.NewFlagSet("teai login remove", flag.ContinueOnError) + fs.SetOutput(env.Err) + yesFlag := fs.Bool("yes", false, "跳過確認") + if err := fs.Parse(args); err != nil { + return &ErrUsage{Msg: err.Error()} + } + if fs.NArg() != 1 { + return &ErrUsage{Msg: "login remove requires exactly one login name"} + } + name := fs.Arg(0) + data, err := readLoginConfig(env, "login remove") + if err != nil { + return err + } + entry, found := findLogin(data, name) + if !found { + return fmt.Errorf("gitea: login %q not found", name) + } + if !*yesFlag { + confirmed, err := confirmRemove(env, entry) + if err != nil { + return err + } + if !confirmed { + fmt.Fprintln(env.Out, "cancelled") + return nil + } + } + out, promoted, err := gitea.RemoveLogin(data, name) + if err != nil { + return err + } + if err := saveLoginConfig(env, out); err != nil { + return err + } + if promoted != "" { + fmt.Fprintf(env.Err, "default login is now %q\n", promoted) + } + p := gitea.Printer{Format: env.Globals.Output, Out: env.Out} + return p.PrintOne(loginFields, gitea.Values{entry.Name, entry.URL, entry.User, false}) +} + +// confirmRemove 印出待移除項目(不含 token)並讀 y/yes 確認; +// 其他輸入(含 EOF)一律視為取消。 +func confirmRemove(env *Env, entry gitea.LoginEntry) (bool, error) { + fmt.Fprintf(env.Err, "remove login %q (url %s, user %s)? [y/N] ", entry.Name, entry.URL, entry.User) + line, err := readLineFrom(loginStdin) + if err != nil { + return false, fmt.Errorf("read confirmation: %w", err) + } + switch strings.ToLower(line) { + case "y", "yes": + return true, nil + default: + return false, nil + } +} + +// readLoginConfig 讀組態檔內容;路徑無法判定或讀取失敗時回錯。 +func readLoginConfig(env *Env, op string) ([]byte, error) { + path := loginConfigPath(env.Globals) + if path == "" { + return nil, fmt.Errorf("cannot determine config path") + } + data, err := os.ReadFile(path) + if err != nil { + return nil, fmt.Errorf("%s: read config %s: %w", op, path, err) + } + return data, nil +} + +// saveLoginConfig 原子寫回組態檔。 +func saveLoginConfig(env *Env, data []byte) error { + path := loginConfigPath(env.Globals) + if path == "" { + return fmt.Errorf("cannot determine config path") + } + return gitea.SaveTeaConfigFile(path, data) +} + +// findLoginByHost 在組態內容中找 URL 主機與 siteURL 相同的登入。 +func findLoginByHost(data []byte, siteURL string) (gitea.LoginEntry, bool) { + for _, l := range gitea.ListLogins(data) { + if gitea.HostOf(l.URL) == gitea.HostOf(siteURL) { + return l, true + } + } + return gitea.LoginEntry{}, false +} + +// findLogin 在組態內容中找指定名稱的登入。 +func findLogin(data []byte, name string) (gitea.LoginEntry, bool) { + for _, l := range gitea.ListLogins(data) { + if l.Name == name { + return l, true + } + } + return gitea.LoginEntry{}, false +} + +// defaultLoginName 以 URL 主機作為登入名稱(同 tea 的習慣)。 +func defaultLoginName(rawURL string) string { + s := rawURL + if !strings.Contains(s, "://") { + s = "https://" + s + } + if u, err := url.Parse(s); err == nil && u.Host != "" { + return u.Host + } + return rawURL +} diff --git a/internal/cli/login_test.go b/internal/cli/login_test.go new file mode 100644 index 0000000..aea20d9 --- /dev/null +++ b/internal/cli/login_test.go @@ -0,0 +1,288 @@ +// login_test.go 驗證 login 指令:list/add/default/remove 的輸出、 +// 驗證流程(先 GET /user 再寫入)、401 不寫檔、token 不外洩。 +package cli + +import ( + "fmt" + "net/http" + "net/http/httptest" + "os" + "path/filepath" + "strings" + "sync/atomic" + "testing" + + "gitea.alterminal.com/alterminal/teai/internal/gitea" +) + +// loginTestEnv 建立測試環境:臨時組態檔路徑 + 可替換的 stdin。 +func loginTestEnv(t *testing.T, configContent string) (args []string, configPath string) { + t.Helper() + dir := t.TempDir() + configPath = filepath.Join(dir, "config.yml") + if configContent != "" { + if err := os.WriteFile(configPath, []byte(configContent), 0o600); err != nil { + t.Fatal(err) + } + } + t.Setenv("TEA_CONFIG", configPath) + return []string{"--config", configPath}, configPath +} + +// newAPIServer 建立假的 Gitea API:/user 檢查 Authorization。 +func newAPIServer(t *testing.T, wantToken string, status int) (*httptest.Server, *atomic.Value) { + t.Helper() + var gotAuth atomic.Value + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + gotAuth.Store(r.Header.Get("Authorization")) + if r.URL.Path != "/api/v1/user" { + w.WriteHeader(http.StatusNotFound) + return + } + if status != 0 { + w.WriteHeader(status) + return + } + fmt.Fprint(w, `{"login":"ceo"}`) + })) + t.Cleanup(srv.Close) + return srv, &gotAuth +} + +func TestLoginListJSONNoToken(t *testing.T) { + prefix, _ := loginTestEnv(t, `logins: + - name: alterminal + url: https://gitea.alterminal.com + token: super-secret + default: true + user: ceo +`) + stdout, _, code := run(append(prefix, "login", "list")...) + if code != 0 { + t.Fatalf("code = %d", code) + } + if !strings.Contains(stdout, `"name":"alterminal"`) || !strings.Contains(stdout, `"user":"ceo"`) { + t.Fatalf("unexpected output: %s", stdout) + } + if strings.Contains(stdout, "super-secret") || strings.Contains(stdout, "token") { + t.Fatalf("token leaked: %s", stdout) + } +} + +func TestLoginListEmpty(t *testing.T) { + prefix, path := loginTestEnv(t, "") + if _, err := os.Stat(path); err == nil { + t.Fatal("precondition: config should not exist") + } + stdout, _, code := run(append(prefix, "login", "list")...) + if code != 0 { + t.Fatalf("code = %d", code) + } + if strings.TrimSpace(stdout) != "[]" { + t.Fatalf("want [], got %q", stdout) + } +} + +func TestLoginAddVerifiesThenWrites(t *testing.T) { + srv, gotAuth := newAPIServer(t, "tok-xyz", 0) + prefix, configPath := loginTestEnv(t, "") + stdout, _, code := run(append(prefix, + "--url", srv.URL, "login", "add", "--name", "test-site", "--token", "tok-xyz")...) + if code != 0 { + t.Fatalf("code = %d, stdout = %s", code, stdout) + } + if got := gotAuth.Load(); got != "token tok-xyz" { + t.Fatalf("server saw Authorization %v", got) + } + if !strings.Contains(stdout, `"name":"test-site"`) || !strings.Contains(stdout, `"user":"ceo"`) { + t.Fatalf("unexpected output: %s", stdout) + } + if strings.Contains(stdout, "tok-xyz") { + t.Fatalf("token leaked: %s", stdout) + } + // 寫入的組態可被解析,且欄位齊全。 + data, err := os.ReadFile(configPath) + if err != nil { + t.Fatal(err) + } + logins := gitea.ListLogins(data) + if len(logins) != 1 { + t.Fatalf("want 1 login, got %d:\n%s", len(logins), data) + } + l := logins[0] + if l.Name != "test-site" || l.URL != srv.URL || l.Token != "tok-xyz" || !l.Default || l.User != "ceo" { + t.Fatalf("entry mismatch: %+v", l) + } + info, _ := os.Stat(configPath) + if info.Mode().Perm() != 0o600 { + t.Fatalf("perm = %v", info.Mode().Perm()) + } +} + +func TestLoginAddTokenFromStdin(t *testing.T) { + srv, _ := newAPIServer(t, "stdin-tok", 0) + prefix, configPath := loginTestEnv(t, "") + old := loginStdin + loginStdin = strings.NewReader("stdin-tok\n") + defer func() { loginStdin = old }() + stdout, _, code := run(append(prefix, "--url", srv.URL, "login", "add")...) + if code != 0 { + t.Fatalf("code = %d, stdout = %s", code, stdout) + } + data, _ := os.ReadFile(configPath) + if l := gitea.ListLogins(data); len(l) != 1 || l[0].Token != "stdin-tok" { + t.Fatalf("stdin token not saved:\n%s", data) + } +} + +func TestLoginAddRejected401NoWrite(t *testing.T) { + srv, _ := newAPIServer(t, "", http.StatusUnauthorized) + prefix, configPath := loginTestEnv(t, `logins: + - name: keep + url: https://keep.example.com + token: keep-tok + default: true +`) + _, stderr, code := run(append(prefix, + "--url", srv.URL, "login", "add", "--token", "bad-tok")...) + if code != int(ExitAPI) { + t.Fatalf("401 should exit 3, got %d (stderr %s)", code, stderr) + } + if !strings.Contains(stderr, "401") { + t.Fatalf("stderr should mention 401: %s", stderr) + } + // 組態不受影響。 + data, _ := os.ReadFile(configPath) + if l := gitea.ListLogins(data); len(l) != 1 || l[0].Token != "keep-tok" { + t.Fatalf("config must be untouched:\n%s", data) + } +} + +func TestLoginAddUpdatesExistingInPlace(t *testing.T) { + srv, _ := newAPIServer(t, "new-tok", 0) + prefix, configPath := loginTestEnv(t, `logins: + - name: alterminal + url: `+srv.URL+` + token: old-tok + default: true + user: someone-else + ssh_key: "keep-me" +preferences: + editor: false +`) + stdout, _, code := run(append(prefix, "--url", srv.URL, "login", "add", "--token", "new-tok")...) + if code != 0 { + t.Fatalf("code = %d, out = %s", code, stdout) + } + data, _ := os.ReadFile(configPath) + s := string(data) + // 未給 --name:同站既有項目(name: alterminal)就地更新,不新增重複項目。 + if strings.Contains(stdout, `"name":"127.0.0.1:`) { + t.Fatalf("should reuse existing entry name, got %s", stdout) + } + if !strings.Contains(s, "- name: alterminal") { + t.Fatalf("existing entry name lost:\n%s", s) + } + if strings.Contains(s, "old-tok") || !strings.Contains(s, "token: new-tok") { + t.Fatalf("token not replaced:\n%s", s) + } + if !strings.Contains(s, `ssh_key: "keep-me"`) || !strings.Contains(s, "editor: false") { + t.Fatalf("unrelated content lost:\n%s", s) + } + if !strings.Contains(s, "user: ceo") { + t.Fatalf("user not refreshed:\n%s", s) + } +} + +func TestLoginDefaultAndRemove(t *testing.T) { + cfg := `logins: + - name: a + url: https://a.example.com + token: ta + default: true + - name: b + url: https://b.example.com + token: tb + default: false +` + prefix, configPath := loginTestEnv(t, cfg) + stdout, _, code := run(append(prefix, "login", "default", "b")...) + if code != 0 || !strings.Contains(stdout, `"name":"b"`) { + t.Fatalf("default failed: code=%d out=%s", code, stdout) + } + data, _ := os.ReadFile(configPath) + if l := gitea.ListLogins(data); !l[1].Default || l[0].Default { + t.Fatalf("default not switched:\n%s", data) + } + + // remove --yes:移除預設者 b,a 遞補。 + stdout, _, code = run(append(prefix, "login", "remove", "--yes", "b")...) + if code != 0 || !strings.Contains(stdout, `"name":"b"`) { + t.Fatalf("remove failed: code=%d out=%s", code, stdout) + } + data, _ = os.ReadFile(configPath) + if l := gitea.ListLogins(data); len(l) != 1 || l[0].Name != "a" || !l[0].Default { + t.Fatalf("promote failed:\n%s", data) + } +} + +func TestLoginRemoveAsksConfirmation(t *testing.T) { + prefix, _ := loginTestEnv(t, `logins: + - name: a + url: https://a.example.com + token: ta + default: true +`) + old := loginStdin + loginStdin = strings.NewReader("n\n") + defer func() { loginStdin = old }() + _, _, code := run(append(prefix, "login", "remove", "a")...) + if code != 0 { + t.Fatalf("cancel should still exit 0, got %d", code) + } + // 取消:檔案不變(token 仍在)。 + data, _ := os.ReadFile(filepath.Dir(prefix[1]) + "/config.yml") + if !strings.Contains(string(data), "token: ta") { + t.Fatalf("cancelled remove must not write:\n%s", data) + } +} + +func TestLoginUnknownSubcommandUsage(t *testing.T) { + prefix, _ := loginTestEnv(t, "") + _, stderr, code := run(append(prefix, "login", "bogus")...) + if code != int(ExitUsage) { + t.Fatalf("want exit 2, got %d", code) + } + if !strings.Contains(stderr, "unknown login subcommand") { + t.Fatalf("stderr: %s", stderr) + } +} + +func TestLoginNoSubcommandUsage(t *testing.T) { + prefix, _ := loginTestEnv(t, "") + _, stderr, code := run(append(prefix, "login")...) + if code != int(ExitUsage) { + t.Fatalf("want exit 2, got %d", code) + } + if !strings.Contains(stderr, "subcommand") { + t.Fatalf("stderr: %s", stderr) + } +} + +func TestLoginRemoveNotFound(t *testing.T) { + prefix, _ := loginTestEnv(t, "logins: []\n") + _, stderr, code := run(append(prefix, "login", "remove", "--yes", "ghost")...) + if code != int(ExitInternal) { + t.Fatalf("want exit 1, got %d", code) + } + if !strings.Contains(stderr, `login "ghost" not found`) { + t.Fatalf("stderr: %s", stderr) + } +} + +func TestLoginRegisteredInUsage(t *testing.T) { + stdout, _, code := run() + if code != 0 || !strings.Contains(stdout, "login") { + t.Fatalf("usage should list login: %s", stdout) + } +} diff --git a/internal/gitea/config.go b/internal/gitea/config.go new file mode 100644 index 0000000..1788984 --- /dev/null +++ b/internal/gitea/config.go @@ -0,0 +1,421 @@ +// config.go — tea 相容登入組態的讀取與行級編輯。 +// +// teai 與 tea 共用同一份組態檔(README 設計原則 5),因此寫入採「行級編輯」: +// 只修改目標登入項目的所屬行,其餘內容(未知欄位、註解、preferences 區段、 +// 空行與縮排)逐字保留,避免改壞 tea 也在使用的檔案。新增項目依 tea 實際 +// 寫出的欄位順序輸出,讓檔案外觀與 tea 一致。 +// +// token 值只會進出這個套件的資料結構與組態檔本身,永遠不出現在錯誤訊息。 +package gitea + +import ( + "fmt" + "os" + "path/filepath" + "regexp" + "slices" + "strconv" + "strings" +) + +// LoginEntry 是組態檔中的一筆登入資料(編輯用,含 tea 的 user 欄位)。 +type LoginEntry struct { + Name string + URL string + Token string + Default bool + User string +} + +// loginItemSpan 標記 logins 清單中一個項目在檔案中的行範圍 [start, end)。 +type loginItemSpan struct { + name string + start int + end int +} + +// configDoc 是解析後的組態檔:原始行與 logins 項目的位置資訊。 +type configDoc struct { + lines []string + items []loginItemSpan + loginsHeader int // 「logins:」所在行;-1 表示沒有 + itemIndent string // 項目行的縮排(取第一個項目);預設四格空白 +} + +// parseConfigDoc 掃描組態內容,定位 logins 清單與各項目的行範圍。 +// 只認識 tea 實際寫出的格式:頂層 `logins:` 加縮排的 `- key: value` 項目; +// 其餘行原樣保留在 lines 中。 +func parseConfigDoc(data []byte) configDoc { + doc := configDoc{lines: splitLines(data), loginsHeader: -1, itemIndent: " "} + inLogins := false + cur := -1 + for i, raw := range doc.lines { + line := raw + trimmed := strings.TrimSpace(line) + if trimmed == "" || strings.HasPrefix(trimmed, "#") { + continue + } + indent := line[:len(line)-len(strings.TrimLeft(line, " "))] + if indent == "" { + if inLogins && doc.loginsHeader >= 0 { + // 離開 logins 區段;listEnd 由最後一個項目的 end 決定,這裡不用記。 + } + inLogins = strings.HasPrefix(trimmed, "logins:") + if inLogins && doc.loginsHeader < 0 { + doc.loginsHeader = i + } + cur = -1 + continue + } + if !inLogins { + continue + } + if strings.HasPrefix(trimmed, "- ") || trimmed == "-" { + if cur >= 0 { + doc.items[cur].end = i + } + doc.items = append(doc.items, loginItemSpan{start: i, end: i + 1}) + cur = len(doc.items) - 1 + if len(doc.items) == 1 { + doc.itemIndent = indent + } + if rest := strings.TrimSpace(strings.TrimPrefix(trimmed, "-")); rest != "" { + if key, value, ok := strings.Cut(rest, ":"); ok && strings.TrimSpace(key) == "name" { + doc.items[cur].name = unquoteYAML(strings.TrimSpace(value)) + } + } + continue + } + if cur >= 0 { + doc.items[cur].end = i + 1 + } + } + return doc +} + +// findItem 依名稱找項目;找不到回 -1。 +func (d configDoc) findItem(name string) int { + for i, it := range d.items { + if it.name == name { + return i + } + } + return -1 +} + +// fieldIndent 回傳項目內屬性行的縮排(項目縮排 + 兩格,tea 的格式)。 +func (d configDoc) fieldIndent() string { + return d.itemIndent + " " +} + +// entryAt 取某個項目的完整欄位值。 +func (d configDoc) entryAt(it loginItemSpan) LoginEntry { + var e LoginEntry + apply := func(kv string) { + key, value, ok := strings.Cut(kv, ":") + if !ok { + return + } + key = strings.TrimSpace(key) + value = unquoteYAML(strings.TrimSpace(value)) + switch key { + case "name": + e.Name = value + case "url": + e.URL = value + case "token": + e.Token = value + case "default": + e.Default = value == "true" + case "user": + e.User = value + } + } + first := strings.TrimSpace(d.lines[it.start]) + if rest := strings.TrimSpace(strings.TrimPrefix(first, "-")); rest != "" { + apply(rest) + } + for i := it.start + 1; i < it.end; i++ { + if kv := strings.TrimSpace(d.lines[i]); kv != "" && !strings.HasPrefix(kv, "#") { + apply(kv) + } + } + return e +} + +// ListLogins 回傳組態內容中的所有登入(依檔案順序)。 +func ListLogins(data []byte) []LoginEntry { + doc := parseConfigDoc(data) + out := make([]LoginEntry, 0, len(doc.items)) + for _, it := range doc.items { + out = append(out, doc.entryAt(it)) + } + return out +} + +// ListLoginsFile 讀取組態檔並列出登入;檔案不存在視為空清單(非錯誤)。 +func ListLoginsFile(path string) ([]LoginEntry, error) { + data, err := os.ReadFile(path) + if err != nil { + if os.IsNotExist(err) { + return nil, nil + } + return nil, err + } + return ListLogins(data), nil +} + +// UpsertLogin 新增或更新名為 e.Name 的登入。 +// +// 已存在則就地更新 url/token/user/default(保留其他欄位與行);不存在則 +// 依 tea 的欄位順序插入新項目。makeDefault 為 true 時將其設為預設並取消 +// 其他登入的預設旗標;新增後若成為唯一登入也自動成為預設。 +// 回傳新內容與最終生效的項目值。 +func UpsertLogin(data []byte, e LoginEntry, makeDefault bool) ([]byte, LoginEntry, error) { + if strings.TrimSpace(e.Name) == "" { + return nil, LoginEntry{}, fmt.Errorf("gitea: login name must not be empty") + } + if strings.TrimSpace(e.URL) == "" { + return nil, LoginEntry{}, fmt.Errorf("gitea: login url must not be empty") + } + if e.Token == "" { + return nil, LoginEntry{}, fmt.Errorf("gitea: login token must not be empty") + } + doc := parseConfigDoc(data) + idx := doc.findItem(e.Name) + if idx >= 0 { + existing := doc.entryAt(doc.items[idx]) + wantDefault := existing.Default || makeDefault + it := doc.items[idx] + lines := doc.lines + // 就地替換各欄位;缺少的欄位補在項目結尾。 + for _, kv := range []struct{ key, value string }{ + {"name", yamlScalar(e.Name)}, + {"url", yamlScalar(e.URL)}, + {"token", yamlScalar(e.Token)}, + {"user", yamlScalar(e.User)}, + {"default", strconv.FormatBool(wantDefault)}, + } { + lines = setFieldInItem(lines, it, kv.key, kv.value, doc.fieldIndent()) + } + out := joinLines(lines) + if wantDefault { + var err error + out, err = SetDefaultLogin(out, e.Name) + if err != nil { + return nil, LoginEntry{}, err + } + } + final := existing + final.URL, final.Token, final.User = e.URL, e.Token, e.User + final.Default = wantDefault + return out, final, nil + } + + // 新增項目。 + wantDefault := makeDefault || len(doc.items) == 0 + block := newLoginBlock(doc.itemIndent, e.Name, e.URL, e.Token, wantDefault, e.User) + var lines []string + var insertAt int + if doc.loginsHeader < 0 { + if len(doc.lines) == 0 { + lines = []string{"logins:"} + } else { + lines = append(slices.Clone(doc.lines), "", "logins:") + } + insertAt = len(lines) + } else { + lines = slices.Clone(doc.lines) + // 「logins: []」是空清單的串流寫法,直接接項目會變無效 YAML;改回區段寫法。 + if len(doc.items) == 0 && strings.TrimSpace(lines[doc.loginsHeader]) == "logins: []" { + lines[doc.loginsHeader] = "logins:" + } + if len(doc.items) > 0 { + insertAt = doc.items[len(doc.items)-1].end + } else { + insertAt = doc.loginsHeader + 1 + } + } + out := append(slices.Clone(lines[:insertAt]), block...) + out = append(out, lines[insertAt:]...) + data2 := joinLines(out) + if wantDefault { + var err error + data2, err = SetDefaultLogin(data2, e.Name) + if err != nil { + return nil, LoginEntry{}, err + } + } + return data2, LoginEntry{ + Name: e.Name, + URL: e.URL, + Token: e.Token, + Default: wantDefault, + User: e.User, + }, nil +} + +// SetDefaultLogin 把名為 name 的登入設為預設,其餘一律取消預設。 +func SetDefaultLogin(data []byte, name string) ([]byte, error) { + doc := parseConfigDoc(data) + idx := doc.findItem(name) + if idx < 0 { + return nil, fmt.Errorf("gitea: login %q not found", name) + } + lines := doc.lines + // 反序處理:前面的插入不影響後面已算好的行範圍,這裡的反序則保證 + // 後方項目的插入/修改不會推移前方項目的範圍。 + for i := len(doc.items) - 1; i >= 0; i-- { + want := "false" + if i == idx { + want = "true" + } + lines = setFieldInItem(lines, doc.items[i], "default", want, doc.fieldIndent()) + } + return joinLines(lines), nil +} + +// RemoveLogin 移除名為 name 的登入。若被移除者是預設且還有其他登入, +// 剩下的第一筆自動遞補為預設。回傳新內容與遞補後的預設名稱(無則空字串)。 +func RemoveLogin(data []byte, name string) ([]byte, string, error) { + doc := parseConfigDoc(data) + idx := doc.findItem(name) + if idx < 0 { + return nil, "", fmt.Errorf("gitea: login %q not found", name) + } + removed := doc.entryAt(doc.items[idx]) + it := doc.items[idx] + lines := slices.Delete(slices.Clone(doc.lines), it.start, it.end) + out := joinLines(lines) + promoted := "" + if removed.Default { + rest := ListLogins(out) + if len(rest) > 0 { + promoted = rest[0].Name + var err error + out, err = SetDefaultLogin(out, promoted) + if err != nil { + return nil, "", err + } + } + } + return out, promoted, nil +} + +// setFieldInItem 把項目內 key 的值換成 value,保留該行的原始縮排; +// key 不存在時以 fieldIndent 插在項目結尾。回傳新的行切片。 +func setFieldInItem(lines []string, it loginItemSpan, key, value, fieldIndent string) []string { + first := lines[it.start] + trimmed := strings.TrimSpace(first) + if rest := strings.TrimSpace(strings.TrimPrefix(trimmed, "-")); rest != "" { + if k, _, ok := strings.Cut(rest, ":"); ok && strings.TrimSpace(k) == key { + prefix := first[:strings.Index(first, "-")] + "- " + lines[it.start] = prefix + key + ": " + value + return lines + } + } + for i := it.start + 1; i < it.end; i++ { + t := strings.TrimSpace(lines[i]) + if k, _, ok := strings.Cut(t, ":"); ok && strings.TrimSpace(k) == key { + indent := lines[i][:len(lines[i])-len(strings.TrimLeft(lines[i], " "))] + lines[i] = indent + key + ": " + value + return lines + } + } + out := append(slices.Clone(lines[:it.end]), fieldIndent+key+": "+value) + return append(out, lines[it.end:]...) +} + +// newLoginBlock 產生 tea 格式的新登入項目(欄位順序與 tea 實際寫出的一致)。 +func newLoginBlock(itemIndent, name, url, token string, isDefault bool, user string) []string { + f := itemIndent + " " + return []string{ + itemIndent + "- name: " + yamlScalar(name), + f + "url: " + yamlScalar(url), + f + "token: " + yamlScalar(token), + f + "default: " + strconv.FormatBool(isDefault), + f + `ssh_host: ""`, + f + `ssh_key: ""`, + f + "insecure: false", + f + `ssh_certificate_principal: ""`, + f + "ssh_agent: false", + f + `ssh_key_agent_pub: ""`, + f + "version_check: false", + f + "user: " + yamlScalar(user), + f + "created: 0", + } +} + +// plainScalar 是可以不加引號直接寫出的 YAML 純量。 +var plainScalar = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9._:/~+=@-]*$`) + +// yamlScalar 把值寫成 YAML 純量:安全字元集直接輸出,其餘加雙引號。 +func yamlScalar(s string) string { + if plainScalar.MatchString(s) { + return s + } + return strconv.Quote(s) +} + +// HostOf 取 URL 的主機部分(連埠,小寫);解析失敗回空字串。 +// 供比對「同一站點」的登入時使用。 +func HostOf(rawURL string) string { return hostOf(rawURL) } + +// splitLines 把內容拆成行(去掉行尾換行與 CR)。 +func splitLines(data []byte) []string { + if len(data) == 0 { + return nil + } + s := strings.TrimSuffix(string(data), "\n") + if s == "" { + return []string{""} + } + return strings.Split(s, "\n") +} + +// joinLines 把行組回內容,保證以單一換行結尾。 +func joinLines(lines []string) []byte { + if len(lines) == 0 { + return nil + } + s := strings.Join(lines, "\n") + if !strings.HasSuffix(s, "\n") { + s += "\n" + } + return []byte(s) +} + +// SaveTeaConfigFile 把組態內容原子寫入 path:先寫同目錄暫存檔(0600), +// 再 rename 取代,避免半寫入狀態。必要時建立上層目錄(0700)。 +func SaveTeaConfigFile(path string, data []byte) error { + dir := filepath.Dir(path) + if err := os.MkdirAll(dir, 0o700); err != nil { + return fmt.Errorf("gitea: create config dir: %w", err) + } + tmp, err := os.CreateTemp(dir, ".config-*.yml") + if err != nil { + return fmt.Errorf("gitea: create temp file: %w", err) + } + tmpName := tmp.Name() + defer func() { + if tmpName != "" { + _ = os.Remove(tmpName) + } + }() + if _, err := tmp.Write(data); err != nil { + tmp.Close() + return fmt.Errorf("gitea: write temp file: %w", err) + } + if err := tmp.Chmod(0o600); err != nil { + tmp.Close() + return fmt.Errorf("gitea: chmod temp file: %w", err) + } + if err := tmp.Close(); err != nil { + return fmt.Errorf("gitea: close temp file: %w", err) + } + if err := os.Rename(tmpName, path); err != nil { + return fmt.Errorf("gitea: rename config: %w", err) + } + tmpName = "" // 已改名成功,不必清理。 + return nil +} diff --git a/internal/gitea/config_test.go b/internal/gitea/config_test.go new file mode 100644 index 0000000..0815761 --- /dev/null +++ b/internal/gitea/config_test.go @@ -0,0 +1,263 @@ +// config_test.go 驗證 tea 相容組態的行級編輯:新增、更新、設預設、 +// 移除,以及「未知欄位與其他區段逐字保留」的關鍵性質。 +package gitea + +import ( + "bytes" + "os" + "path/filepath" + "strings" + "testing" +) + +// realWorldTeaConfig 是 tea 實際寫出的組態(含 ssh_* 等未知欄位與 preferences)。 +const realWorldTeaConfig = `logins: + - name: alterminal + url: https://gitea.alterminal.com + token: tok-1 + default: true + ssh_host: "" + ssh_key: "" + insecure: false + ssh_certificate_principal: "" + ssh_agent: false + ssh_key_agent_pub: "" + version_check: false + user: ceo + created: 0 +preferences: + editor: false + flag_defaults: + remote: "" +` + +func TestListLoginsParsesAllEntries(t *testing.T) { + logins := ListLogins([]byte(realWorldTeaConfig)) + if len(logins) != 1 { + t.Fatalf("want 1 login, got %d", len(logins)) + } + l := logins[0] + if l.Name != "alterminal" || l.URL != "https://gitea.alterminal.com" || l.Token != "tok-1" || !l.Default || l.User != "ceo" { + t.Fatalf("unexpected entry: %+v", l) + } +} + +func TestUpsertLoginUpdatesExistingPreservesRest(t *testing.T) { + out, final, err := UpsertLogin([]byte(realWorldTeaConfig), LoginEntry{ + Name: "alterminal", URL: "https://gitea.alterminal.com", Token: "tok-2", User: "ceo", + }, false) + if err != nil { + t.Fatal(err) + } + s := string(out) + // 更新 token、保留其他欄位。 + if !strings.Contains(s, "token: tok-2") || strings.Contains(s, "tok-1") { + t.Fatalf("token not updated:\n%s", s) + } + for _, want := range []string{ + "ssh_host: \"\"", "insecure: false", "ssh_key_agent_pub: \"\"", + "user: ceo", "created: 0", "default: true", + "preferences:", "editor: false", "flag_defaults:", `remote: ""`, + } { + if !strings.Contains(s, want) { + t.Fatalf("missing %q after edit:\n%s", want, s) + } + } + if final.Default != true { + t.Fatalf("existing default should stay default, got %+v", final) + } + // 編輯後仍可解析出正確值。 + logins := ListLogins(out) + if len(logins) != 1 || logins[0].Token != "tok-2" || !logins[0].Default { + t.Fatalf("reparse mismatch: %+v", logins) + } +} + +func TestUpsertLoginAppendsNewAndMakesDefault(t *testing.T) { + out, final, err := UpsertLogin([]byte(realWorldTeaConfig), LoginEntry{ + Name: "second", URL: "https://git.example.com", Token: "tok-b", User: "bob", + }, true) + if err != nil { + t.Fatal(err) + } + logins := ListLogins(out) + if len(logins) != 2 { + t.Fatalf("want 2 logins, got %d:\n%s", len(logins), out) + } + if logins[0].Default || !logins[1].Default { + t.Fatalf("only the new login should be default: %+v", logins) + } + if logins[1].Name != "second" || logins[1].Token != "tok-b" || logins[1].User != "bob" { + t.Fatalf("new entry mismatch: %+v", logins[1]) + } + if !final.Default { + t.Fatalf("final should be default: %+v", final) + } + // tea 的欄位順序仍在。 + s := string(out) + if !strings.Contains(s, " - name: second\n") { + t.Fatalf("new item not appended in tea style:\n%s", s) + } +} + +func TestUpsertLoginFirstEverLoginCreatesSection(t *testing.T) { + out, final, err := UpsertLogin(nil, LoginEntry{ + Name: "only", URL: "https://gitea.alterminal.com", Token: "tok", User: "ceo", + }, false) + if err != nil { + t.Fatal(err) + } + logins := ListLogins(out) + if len(logins) != 1 || !logins[0].Default || logins[0].Token != "tok" { + t.Fatalf("first login should auto-default: %s", out) + } + if !final.Default { + t.Fatalf("final should be default: %+v", final) + } + if !strings.HasPrefix(string(out), "logins:\n") { + t.Fatalf("section not created:\n%s", out) + } +} + +func TestUpsertLoginRejectsBadInput(t *testing.T) { + cases := []LoginEntry{ + {Name: "", URL: "https://x", Token: "t"}, + {Name: "n", URL: " ", Token: "t"}, + {Name: "n", URL: "https://x", Token: ""}, + } + for _, e := range cases { + if _, _, err := UpsertLogin(nil, e, true); err == nil { + t.Errorf("UpsertLogin(%+v) should fail", e) + } + } +} + +func TestSetDefaultLoginSwitchesFlag(t *testing.T) { + cfg := `logins: + - name: a + url: https://a.example.com + token: ta + default: true + - name: b + url: https://b.example.com + token: tb + default: false +` + out, err := SetDefaultLogin([]byte(cfg), "b") + if err != nil { + t.Fatal(err) + } + logins := ListLogins(out) + if logins[0].Default || !logins[1].Default { + t.Fatalf("default flag not switched:\n%s", out) + } + // b 之後的內容(如有)不受影響。 + if !strings.Contains(string(out), "token: ta") || !strings.Contains(string(out), "token: tb") { + t.Fatalf("tokens lost:\n%s", out) + } +} + +func TestSetDefaultLoginUnknownNameErrors(t *testing.T) { + if _, err := SetDefaultLogin([]byte(realWorldTeaConfig), "nope"); err == nil { + t.Fatal("unknown name should error") + } +} + +func TestRemoveLoginPromotesNextDefault(t *testing.T) { + // 第二個登入放在 logins 區段內(preferences 之前)。 + cfg := `logins: + - name: alterminal + url: https://gitea.alterminal.com + token: tok-1 + default: true + user: ceo + - name: backup + url: https://backup.example.com + token: tb + default: false +preferences: + editor: false +` + out, promoted, err := RemoveLogin([]byte(cfg), "alterminal") + if err != nil { + t.Fatal(err) + } + if promoted != "backup" { + t.Fatalf("promoted = %q, want backup:\n%s", promoted, out) + } + logins := ListLogins(out) + if len(logins) != 1 || logins[0].Name != "backup" || !logins[0].Default { + t.Fatalf("remaining login mismatch: %+v", logins) + } + if strings.Contains(string(out), "tok-1") || strings.Contains(string(out), "name: alterminal") { + t.Fatalf("login not fully removed:\n%s", out) + } +} + +func TestRemoveLoginLastOne(t *testing.T) { + out, promoted, err := RemoveLogin([]byte(realWorldTeaConfig), "alterminal") + if err != nil || promoted != "" { + t.Fatalf("want clean removal, promoted=%q err=%v", promoted, err) + } + if strings.Contains(string(out), "alterminal") { + t.Fatalf("login not removed:\n%s", out) + } + if !strings.Contains(string(out), "preferences:") { + t.Fatalf("preferences section lost:\n%s", out) + } +} + +func TestSaveTeaConfigFileAtomicAndMode(t *testing.T) { + dir := t.TempDir() + path := filepath.Join(dir, "tea", "config.yml") + if err := SaveTeaConfigFile(path, []byte("logins: []\n")); err != nil { + t.Fatal(err) + } + info, err := os.Stat(path) + if err != nil { + t.Fatal(err) + } + if info.Mode().Perm() != 0o600 { + t.Fatalf("perm = %v, want 0600", info.Mode().Perm()) + } + // 再寫一次(覆蓋既有檔),不留暫存殘檔。 + if err := SaveTeaConfigFile(path, []byte("logins: []\n# v2\n")); err != nil { + t.Fatal(err) + } + entries, _ := os.ReadDir(filepath.Dir(path)) + if len(entries) != 1 { + for _, e := range entries { + t.Logf("leftover: %s", e.Name()) + } + t.Fatalf("want exactly 1 file, got %d", len(entries)) + } + data, _ := os.ReadFile(path) + if !bytes.Contains(data, []byte("# v2")) { + t.Fatalf("overwrite failed: %s", data) + } +} + +func TestSplitJoinLinesRoundTrip(t *testing.T) { + original := "a\nb\n" + got := string(joinLines(splitLines([]byte(original)))) + if got != original { + t.Fatalf("round trip: %q", got) + } + if joinLines(splitLines(nil)) != nil { + t.Fatal("nil input should stay nil") + } +} + +func TestYamlScalarQuoting(t *testing.T) { + cases := map[string]string{ + "https://gitea.alterminal.com": "https://gitea.alterminal.com", // 含 : 與 / 的純量在 YAML 合法,不必引號 + "tok-abc_123": "tok-abc_123", + "has space": `"has space"`, + "ceo": "ceo", + } + for in, want := range cases { + if got := yamlScalar(in); got != want { + t.Errorf("yamlScalar(%q) = %s, want %s", in, got, want) + } + } +}