mirror of
https://gitea.com/gitea/tea.git
synced 2026-10-26 19:11:25 +01:00
refactor: add settings, transport and alias packages (#1122)
Part 1/5 of the tea 1.0 rewrite. **Stack** (split from #1121; each PR targets `main` and builds, tests and lints on its own — the shipped CLI only changes in part 5): 1. #1122 Toolchain and foundation packages ← this PR 2. #1123 Credentials and Git 3. #1124 Terminal 4. #1125 Services 5. #1126 CLI wiring, docs, removal of the old tree ## Changes - **build:** require Go 1.27; bump gofumpt and golangci-lint to releases that can read Go 1.27 export data (own commit). - `internal/clierr`: typed errors and executable exit codes. - `internal/version`: build version and tags. - `internal/filelock`: moved unchanged from `modules/filelock`. - `internal/aliases`: user-defined command aliases. - `internal/transport`: the HTTP client the Gitea SDK runs on (part 4): token, Sudo and SSH-signature auth, retries for safe reads, connect/TLS/response-header timeouts, typed API errors that keep Gitea's message, and a redacted request log for `--debug`; plus raw requests for `tea api`, signed downloads that follow object-storage redirects, and log streaming. - `internal/settings`: split `config.yml` / `hosts.yml` with locked transactions, plus remote URL parsing. Nothing imports these packages yet. Note: `flake.nix` now asks for `go_1_27`; the pinned nixpkgs in `flake.lock` predates Go 1.27 and still needs a `nix flake update nixpkgs`. Reviewed-on: https://gitea.com/gitea/tea/pulls/1122 Reviewed-by: TheFox0x7 <95654+thefox0x7@noreply.gitea.com>
This commit is contained in:
1 parent
bcd62a1fb2
commit
2b218a5bae
29 files changed
+2541
-77
No files matched your search
@@ -0,0 +1,137 @@
|
||||
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package settings
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"sync"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestLoadDoesNotCreateFiles(t *testing.T) {
|
||||
dir := filepath.Join(t.TempDir(), "missing")
|
||||
s := New(dir)
|
||||
snapshot, err := s.Load()
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "enabled", snapshot.Preferences.Prompt)
|
||||
_, err = os.Stat(dir)
|
||||
require.True(t, errors.Is(err, os.ErrNotExist))
|
||||
}
|
||||
|
||||
func TestLegacyAndMalformedFilesAreNeverOverwritten(t *testing.T) {
|
||||
for _, input := range []string{"logins: []\npreferences: {}\n", "version: '2'\n", "version: '1'\nunknown: true\n", "version: '1'\n---\nversion: '1'\n", "version: '1'\nprompt: nonsense\n", "bad: ["} {
|
||||
t.Run(input, func(t *testing.T) {
|
||||
s := New(t.TempDir())
|
||||
file := filepath.Join(s.Dir, "config.yml")
|
||||
require.NoError(t, os.WriteFile(file, []byte(input), 0o600))
|
||||
_, err := s.Load()
|
||||
require.Error(t, err)
|
||||
err = s.Update(TargetPreferences, func(snapshot *Snapshot) error { snapshot.Preferences.Editor = "vi"; return nil })
|
||||
require.Error(t, err)
|
||||
actual, err := os.ReadFile(file)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, input, string(actual))
|
||||
_, err = os.Stat(filepath.Join(s.Dir, "settings.lock"))
|
||||
require.True(t, errors.Is(err, os.ErrNotExist))
|
||||
})
|
||||
}
|
||||
t.Run("legacy tea.yml", func(t *testing.T) {
|
||||
home := t.TempDir()
|
||||
legacy := filepath.Join(home, ".tea", "tea.yml")
|
||||
require.NoError(t, os.MkdirAll(filepath.Dir(legacy), 0o700))
|
||||
require.NoError(t, os.WriteFile(legacy, []byte("logins: []\n"), 0o600))
|
||||
s := &Store{Dir: filepath.Join(home, "config", "tea"), LegacyPath: legacy}
|
||||
_, err := s.Load()
|
||||
require.ErrorIs(t, err, ErrLegacy)
|
||||
require.ErrorIs(t, s.Update(TargetPreferences, func(snapshot *Snapshot) error { snapshot.Preferences.Editor = "vi"; return nil }), ErrLegacy)
|
||||
_, err = os.Stat(s.Dir)
|
||||
require.True(t, errors.Is(err, os.ErrNotExist))
|
||||
})
|
||||
}
|
||||
|
||||
func TestNormalizeHost(t *testing.T) {
|
||||
for raw, want := range map[string]string{"https://EXAMPLE.org:443/": "https://example.org", "https://example.org:3000/gitea/": "https://example.org:3000/gitea", "http://example.org:80": "http://example.org", "https://[::1]:443/": "https://[::1]"} {
|
||||
actual, err := NormalizeHost(raw)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, want, actual)
|
||||
}
|
||||
for _, raw := range []string{"example.org", "ftp://example.org", "https://user:password@example.org", "https://example.org?q=1", "https://example.org/#fragment", "https://example.org/a%2fb"} {
|
||||
_, err := NormalizeHost(raw)
|
||||
require.Error(t, err, raw)
|
||||
}
|
||||
}
|
||||
|
||||
func TestConcurrentUpdatesAndHostSeparation(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
var wg sync.WaitGroup
|
||||
failures := make(chan error, 8)
|
||||
for i := range 8 {
|
||||
wg.Go(func() {
|
||||
store := New(dir)
|
||||
err := store.Update(TargetPreferences, func(snapshot *Snapshot) error {
|
||||
snapshot.Preferences.Aliases[string(rune('a'+i))] = "issue list"
|
||||
return nil
|
||||
})
|
||||
failures <- err
|
||||
})
|
||||
}
|
||||
wg.Wait()
|
||||
close(failures)
|
||||
for err := range failures {
|
||||
require.NoError(t, err)
|
||||
}
|
||||
store := New(dir)
|
||||
snapshot, err := store.Load()
|
||||
require.NoError(t, err)
|
||||
require.Len(t, snapshot.Preferences.Aliases, 8)
|
||||
require.NoError(t, store.Update(TargetHosts, func(s *Snapshot) error {
|
||||
s.Hosts.Hosts["https://example.org/base"] = Host{User: "alice", Users: map[string]Account{"alice": {AuthMethod: "token", CredentialStore: "file"}, "bob": {AuthMethod: "oauth", CredentialStore: "keyring"}}}
|
||||
return nil
|
||||
}))
|
||||
snapshot, err = store.Load()
|
||||
require.NoError(t, err)
|
||||
require.Len(t, snapshot.Hosts.Hosts, 1)
|
||||
data, err := os.ReadFile(filepath.Join(dir, "config.yml"))
|
||||
require.NoError(t, err)
|
||||
require.NotContains(t, string(data), "alice")
|
||||
info, err := os.Stat(filepath.Join(dir, "hosts.yml"))
|
||||
require.NoError(t, err)
|
||||
if runtime.GOOS != "windows" { // Windows reports 0666 regardless of the requested mode
|
||||
require.Equal(t, os.FileMode(0o600), info.Mode().Perm())
|
||||
}
|
||||
// A change to the file an update does not write fails instead of being dropped.
|
||||
require.Error(t, store.Update(TargetHosts, func(s *Snapshot) error { s.Preferences.Editor = "vi"; return nil }))
|
||||
require.Error(t, store.Update(TargetPreferences, func(s *Snapshot) error { delete(s.Hosts.Hosts, "https://example.org/base"); return nil }))
|
||||
snapshot, err = store.Load()
|
||||
require.NoError(t, err)
|
||||
require.Empty(t, snapshot.Preferences.Editor)
|
||||
require.Len(t, snapshot.Hosts.Hosts, 1)
|
||||
}
|
||||
|
||||
func TestUpdatePersistsOnlyExplicitPreferences(t *testing.T) {
|
||||
s := New(t.TempDir())
|
||||
require.NoError(t, s.Update(TargetPreferences, func(snapshot *Snapshot) error { snapshot.Preferences.Editor = "vi"; return nil }))
|
||||
snapshot, err := s.Load()
|
||||
require.NoError(t, err)
|
||||
require.True(t, snapshot.Configured["editor"])
|
||||
for _, key := range []string{"git_protocol", "prompt", "color", "aliases"} {
|
||||
require.False(t, snapshot.Configured[key], key)
|
||||
}
|
||||
require.Equal(t, Defaults().GitProtocol, snapshot.Preferences.GitProtocol)
|
||||
require.NoError(t, s.Update(TargetPreferences, func(snapshot *Snapshot) error { snapshot.Preferences.Color = "never"; return nil }))
|
||||
data, err := os.ReadFile(filepath.Join(s.Dir, "config.yml"))
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "version: \"1\"\neditor: vi\ncolor: never\n", string(data))
|
||||
}
|
||||
|
||||
func TestTokenlessAccounts(t *testing.T) {
|
||||
for method, want := range map[string]bool{AuthToken: false, AuthOAuth: false, AuthSSH: true, AuthHTTPSign: true} {
|
||||
require.Equal(t, want, Account{AuthMethod: method}.Tokenless(), method)
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user