bb592a59a6
cli/acceptance/contract/:
envelope_test.go — 16 envelope golden cases (9 commands × {success/error
variants}; 3 cases dropped with rationale: doctor.success
non-offline has unstable timing detail; auth_login.* needs
stdin/keyring scaffold deferred to v0.2; context_use.error
needs leaf-local --json deferred to follow-up)
errorcodes_test.go — single-direction AST scan of cli/cmd/ extracting first
arg of cmdutil.NewError / cmdutil.Wrapf calls;
ClassifyHTTPError dynamic-classify bridged via
cmdutil.ClassifyHTTPErrorOutputs() per spec §4.3.
testdata/envelopes/ — 16 JSON golden files
helpers_test.go (PR-6 scaffold) extended:
runCmd now wires cobra Out/Err sinks (version uses c.OutOrStdout) AND
replicates cmd.Execute()'s error-envelope path so error-case goldens are
populated. Without this, every error scenario's golden was 0 bytes.
cli/cmd/root.go: mapCobraError → MapCobraError, wantsJSONOutput → WantsJSONOutput
(exported so the contract test helper can replicate Execute()'s
envelope-printing path without calling Execute() itself).
root_test.go updated to use new exported names.
.github/dependabot.yml (新增):gomod /cli + github-actions weekly,gh-style
ignore semver-major to avoid noise. Open-source
dependency safety,independent of release cadence.
v0.1 不发布到任何分发平台 (release infra 推迟到发布窗口 milestone)。
87 lines
3.1 KiB
Go
87 lines
3.1 KiB
Go
// Package xdg consolidates the XDG-rooted file path lookup and atomic-write
|
||
// idioms used by config / compat / secrets / future stores.
|
||
//
|
||
// Before extraction these patterns were copy-pasted across cli/internal/{config,
|
||
// compat, secrets}; reuse review surfaced 3× duplication of Path and 2× of the
|
||
// tmp+rename atomic-write recipe. Centralizing here means a single place to fix
|
||
// behavior (mode bits, fallback dirs, mkdir order, error wrapping) and one less
|
||
// thing to copy when v0.2 adds project-link / state stores.
|
||
package xdg
|
||
|
||
import (
|
||
"fmt"
|
||
"os"
|
||
"path/filepath"
|
||
|
||
"gopkg.in/yaml.v3"
|
||
)
|
||
|
||
// Path resolves an XDG-rooted file. envVar is one of "XDG_CONFIG_HOME" /
|
||
// "XDG_CACHE_HOME" / "XDG_DATA_HOME". fallbackDir is the dot-prefixed dir
|
||
// under $HOME used when the env var is unset (".config" / ".cache" / etc.).
|
||
// parts join under "weknora/" inside the chosen root.
|
||
//
|
||
// Honors the XDG vars on every OS (CLI convention — gh / kubectl / helm all
|
||
// do this even on macOS, where os.UserConfigDir would otherwise return
|
||
// ~/Library/Application Support).
|
||
func Path(envVar, fallbackDir string, parts ...string) (string, error) {
|
||
if x := os.Getenv(envVar); x != "" {
|
||
return filepath.Join(append([]string{x, "weknora"}, parts...)...), nil
|
||
}
|
||
home, err := os.UserHomeDir()
|
||
if err != nil {
|
||
return "", fmt.Errorf("locate home dir: %w", err)
|
||
}
|
||
return filepath.Join(append([]string{home, fallbackDir, "weknora"}, parts...)...), nil
|
||
}
|
||
|
||
// WriteAtomicYAML marshals v to YAML and writes it atomically at p with mode
|
||
// 0600 (user-only). Creates parent dirs with mode 0700. Atomicity via
|
||
// CreateTemp + chmod + rename so partial writes never expose a half-baked
|
||
// file and concurrent writers never trample each other's tmp.
|
||
//
|
||
// 0600 is the appropriate floor even for non-secret stores (cache, project
|
||
// link) since they may sit alongside secrets in the same dir tree.
|
||
//
|
||
// On any failure after the tmp is created, the tmp is cleaned up so we don't
|
||
// litter the dir with `*.tmp.NNNN` artifacts on crash / cross-device errors.
|
||
func WriteAtomicYAML(p string, v any) error {
|
||
dir := filepath.Dir(p)
|
||
if err := os.MkdirAll(dir, 0o700); err != nil {
|
||
return fmt.Errorf("mkdir %s: %w", dir, err)
|
||
}
|
||
data, err := yaml.Marshal(v)
|
||
if err != nil {
|
||
return fmt.Errorf("marshal: %w", err)
|
||
}
|
||
// CreateTemp picks a unique name in dir so concurrent calls never collide
|
||
// on a shared `<p>.tmp`. Pattern reserves the suffix slot.
|
||
tmp, err := os.CreateTemp(dir, filepath.Base(p)+".tmp.*")
|
||
if err != nil {
|
||
return fmt.Errorf("create tmp in %s: %w", dir, err)
|
||
}
|
||
tmpName := tmp.Name()
|
||
// Best-effort cleanup on any failure path; no-op once Rename succeeds.
|
||
committed := false
|
||
defer func() {
|
||
if !committed {
|
||
_ = os.Remove(tmpName)
|
||
}
|
||
}()
|
||
if _, err := tmp.Write(data); err != nil {
|
||
_ = tmp.Close()
|
||
return fmt.Errorf("write %s: %w", tmpName, err)
|
||
}
|
||
if err := tmp.Close(); err != nil {
|
||
return fmt.Errorf("close %s: %w", tmpName, err)
|
||
}
|
||
if err := os.Chmod(tmpName, 0o600); err != nil {
|
||
return fmt.Errorf("chmod %s: %w", tmpName, err)
|
||
}
|
||
if err := os.Rename(tmpName, p); err != nil {
|
||
return fmt.Errorf("rename %s -> %s: %w", tmpName, p, err)
|
||
}
|
||
committed = true
|
||
return nil
|
||
}
|