實現 login 指令(#14):tea 相容組態管理

- internal/gitea/config.go:tea 組態的行級編輯引擎(新增/更新/
  設預設/移除),未知欄位與 preferences 區段逐字保留;原子寫入
  (暫存檔 + rename,0600)。
- internal/cli/login.go:teai login list/add/default/remove。add 先以
  token 呼叫 GET /user 驗證,成功才寫入並記下帳號;未給 --token 時
  自 stdin 讀一行;401 結束碼 3。未給 --name 時同站既有項目就地更新。
- 輸出欄位 name/url/user/default,永不輸出 token。
- 測試:編輯引擎 12 項、指令層 11 項(httptest 假 API),並以真 tea
  驗證 teai 寫出的組態可互通(tea whoami 讀出同帳號)。

Closes #14
This commit is contained in:
ceo
2026-09-10 09:32:53 +08:00
parent a7952c6834
commit f8fc16ae49
6 changed files with 1362 additions and 0 deletions
+5
View File
@@ -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: "顯示版本資訊",
+365
View File
@@ -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
}
+288
View File
@@ -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)
}
}