All checks were successful
check / check (push) Successful in 43s
Bumps golangci-lint from v2.1.6 (digest-only pin in the `Dockerfile` lint stage) to v2.12.2, pinned by tag and digest (Debian-based image). Replaces `.golangci.yml` with the canonical strict config: all linters enabled except the standard disable list (`exhaustruct`, `depguard`, `godot`, `wsl`, `wrapcheck`, `varnamelen`), `lll` at 88, `funlen` 80/50, `cyclop` 15, `dupl` 100, and test files are now linted (the old config had `tests: false`, an enable-only list of ~20 linters, `lll` 120, and a blanket exclusion of `internal/macse`). The stricter config surfaced ~1550 findings, all fixed: - `wsl_v5` (439) / `nlreturn` (24): blank-line insertions - `lll` (309): line wrapping at 88 columns; long literals split with `+` concatenation, values unchanged - `noinlineerr` (130): `if err := ...` split into assignment plus check - `paralleltest` (116): `t.Parallel()` added to tests without shared state; reasoned `//nolint` where `t.Setenv` or shared fixtures forbid it - `err113` (97): package-level sentinel errors (new `internal/vault/errors.go`), `%w` wrapping, `errors.Is` - `perfsprint` (74) / `modernize` (39) / `intrange`: `strconv`, `errors.New`, `slices.Contains`, `any`, `SplitSeq` - `goconst` (40) / `dupword` (41) / `testifylint` (42) / `thelper` (33): constants, assertion fixes, `t.Helper()` - `noctx` (22): `exec.CommandContext` for gpg/CLI invocations - `testpackage` (18): black-box tests moved to `_test` packages where they use only exported identifiers; white-box files carry a reasoned `//nolint` - `funlen`/`cyclop`/`gocognit`/`nestif`/`dupl`: behavior-preserving helper extraction - assorted singletons: `gosec`, `gosmopolitan`, `funcorder`, `nonamedreturns`, `makezero`, `prealloc`, `godox`, `nolintlint`, `ireturn`, `nilnil`, `gochecknoinits` ## User-visible strings **None changed.** Every error message this branch composes is byte-identical to the one `main` composes. The `err113` sentinels are shaped so `fmt.Errorf` reassembles the original text around them: the sentinel carries the fixed words and the caller supplies the interpolated value in the position it has always occupied. Where the value sits mid-sentence the sentinel holds only a fragment (e.g. `vault.ErrVaultNotFound` is `"does not exist"`, composed by its caller as `vault <name> does not exist`); each such sentinel documents the message it participates in. Verified mechanically, not by inspection: every `fmt.Errorf` and `errors.New` call site in both trees is parsed, the `Error()` text of any sentinel passed to `%w` is substituted in, and the resulting sets of composed message templates are compared. All 350 templates `main` produces are still produced, character for character. The set of lost or altered messages is empty. ## `unlocker list` `findUnlockerIDByMetadata` returns `(string, error)` rather than signalling failure with an empty ID, so an unreadable `unlockers.d` is no longer indistinguishable from "no matching entry". `UnlockersList` skips such an entry with a warning naming the directory — its behavior before the scan was extracted into a helper — instead of emitting a row under a synthesized fallback ID that no `unlocker remove` or `unlocker select` can match and that suppresses the current-unlocker marker. The duplicate-check and shell-completion callers skip on the same condition, matching their pre-extraction behavior. Covered by `internal/cli/unlockers_list_test.go`. `TODO.md` records the change plus follow-ups (version-completion TODOs formerly in code comments, darwin-gated files exceeding 88 columns that Linux CI does not lint). `make check` is green and the pinned v2.12.2 image reports `0 issues.` Note the test suite needs the memlock ulimit from `script/cibuild` for the 10MB memguard test; that requirement is pre-existing. Not changed: `script/bootstrap` installs golangci-lint via the system package manager (no version pin to bump), and `script/lint` invokes whatever `golangci-lint` is on PATH. golangci-lint v2.12 deprecates `gomodguard` in favor of `gomodguard_v2` (warning only); the canonical config owns that decision. Co-authored-by: sneak <sneak@sneak.berlin> Reviewed-on: #29 Co-authored-by: clawbot <clawbot@noreply.example.org> Co-committed-by: clawbot <clawbot@noreply.example.org>
176 lines
4.9 KiB
Go
176 lines
4.9 KiB
Go
package cli
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"log"
|
|
"path/filepath"
|
|
"runtime"
|
|
"strings"
|
|
"time"
|
|
|
|
"git.eeqj.de/sneak/secret/internal/vault"
|
|
"github.com/dustin/go-humanize"
|
|
"github.com/fatih/color"
|
|
"github.com/spf13/afero"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// Version info - these are set at build time
|
|
var (
|
|
Version = "dev" //nolint:gochecknoglobals // Set at build time
|
|
GitCommit = "unknown" //nolint:gochecknoglobals // Set at build time
|
|
)
|
|
|
|
// InfoOutput represents the system information for JSON output
|
|
type InfoOutput struct {
|
|
Version string `json:"version"`
|
|
GitCommit string `json:"gitCommit"`
|
|
Author string `json:"author"`
|
|
License string `json:"license"`
|
|
GoVersion string `json:"goVersion"`
|
|
DataDirectory string `json:"dataDirectory"`
|
|
CurrentVault string `json:"currentVault"`
|
|
NumVaults int `json:"numVaults"`
|
|
NumSecrets int `json:"numSecrets"`
|
|
TotalSize int64 `json:"totalSizeBytes"`
|
|
OldestSecret time.Time `json:"oldestSecret"`
|
|
LatestSecret time.Time `json:"latestSecret"`
|
|
}
|
|
|
|
// newInfoCmd returns the info command
|
|
func newInfoCmd() *cobra.Command {
|
|
cli, err := NewCLIInstance()
|
|
if err != nil {
|
|
log.Fatalf("failed to initialize CLI: %v", err)
|
|
}
|
|
|
|
var jsonOutput bool
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "info",
|
|
Short: "Display system information",
|
|
Long: "Display information about the secret system including " +
|
|
"version, vault statistics, and storage usage",
|
|
RunE: func(cmd *cobra.Command, _ []string) error {
|
|
return cli.Info(cmd, jsonOutput)
|
|
},
|
|
}
|
|
|
|
cmd.Flags().BoolVar(&jsonOutput, "json", false, "Output in JSON format")
|
|
|
|
return cmd
|
|
}
|
|
|
|
// Info displays system information
|
|
func (cli *Instance) Info(cmd *cobra.Command, jsonOutput bool) error {
|
|
info := InfoOutput{
|
|
Version: Version,
|
|
GitCommit: GitCommit,
|
|
Author: "Jeffrey Paul <sneak@sneak.berlin>",
|
|
License: "WTFPL",
|
|
GoVersion: runtime.Version(),
|
|
DataDirectory: cli.stateDir,
|
|
}
|
|
|
|
// Get current vault
|
|
currentVault, err := vault.GetCurrentVault(cli.fs, cli.stateDir)
|
|
if err == nil {
|
|
info.CurrentVault = currentVault.Name
|
|
}
|
|
|
|
// Count vaults
|
|
vaultsDir := filepath.Join(cli.stateDir, "vaults.d")
|
|
|
|
vaultEntries, err := afero.ReadDir(cli.fs, vaultsDir)
|
|
if err == nil {
|
|
for _, entry := range vaultEntries {
|
|
if entry.IsDir() {
|
|
info.NumVaults++
|
|
}
|
|
}
|
|
}
|
|
|
|
// Gather statistics from all vaults
|
|
if info.NumVaults > 0 {
|
|
totalSecrets, totalSize, oldestTime, latestTime, _ := gatherVaultStats(
|
|
cli.fs, vaultsDir)
|
|
info.NumSecrets = totalSecrets
|
|
info.TotalSize = totalSize
|
|
|
|
if !oldestTime.IsZero() {
|
|
info.OldestSecret = oldestTime
|
|
}
|
|
|
|
if !latestTime.IsZero() {
|
|
info.LatestSecret = latestTime
|
|
}
|
|
}
|
|
|
|
if jsonOutput {
|
|
encoder := json.NewEncoder(cmd.OutOrStdout())
|
|
encoder.SetIndent("", " ")
|
|
|
|
return encoder.Encode(info)
|
|
}
|
|
|
|
// Pretty print with colors and emoji
|
|
return prettyPrintInfo(cmd.OutOrStdout(), info)
|
|
}
|
|
|
|
// prettyPrintInfo formats and prints the info in a pretty format
|
|
func prettyPrintInfo(w io.Writer, info InfoOutput) error {
|
|
const separatorLength = 40
|
|
|
|
bold := color.New(color.Bold)
|
|
green := color.New(color.FgGreen)
|
|
cyan := color.New(color.FgCyan)
|
|
yellow := color.New(color.FgYellow)
|
|
magenta := color.New(color.FgMagenta)
|
|
|
|
_, _ = fmt.Fprintln(w)
|
|
_, _ = bold.Fprintln(w, "🔐 Secret System Information")
|
|
_, _ = fmt.Fprintln(w, strings.Repeat("─", separatorLength))
|
|
|
|
_, _ = fmt.Fprintf(w, "📦 Version: %s\n", green.Sprint(info.Version))
|
|
_, _ = fmt.Fprintf(w, "🔧 Git Commit: %s\n", cyan.Sprint(info.GitCommit))
|
|
_, _ = fmt.Fprintf(w, "👤 Author: %s\n", cyan.Sprint(info.Author))
|
|
_, _ = fmt.Fprintf(w, "📜 License: %s\n", cyan.Sprint(info.License))
|
|
_, _ = fmt.Fprintf(w, "🐹 Go Version: %s\n", cyan.Sprint(info.GoVersion))
|
|
_, _ = fmt.Fprintf(w, "📁 Data Directory: %s\n", yellow.Sprint(info.DataDirectory))
|
|
|
|
if info.CurrentVault != "" {
|
|
_, _ = fmt.Fprintf(w, "🗄️ Current Vault: %s\n", magenta.Sprint(info.CurrentVault))
|
|
} else {
|
|
_, _ = fmt.Fprintf(w, "🗄️ Current Vault: %s\n", color.RedString("(none)"))
|
|
}
|
|
|
|
_, _ = fmt.Fprintln(w, strings.Repeat("─", separatorLength))
|
|
|
|
_, _ = fmt.Fprintf(w, "🗂️ Vaults: %s\n", bold.Sprint(info.NumVaults))
|
|
|
|
_, _ = fmt.Fprintf(w, "🔑 Secrets: %s\n", bold.Sprint(info.NumSecrets))
|
|
|
|
if info.TotalSize >= 0 {
|
|
_, _ = fmt.Fprintf(w, "💾 Total Size: %s\n",
|
|
bold.Sprint(humanize.Bytes(uint64(info.TotalSize))))
|
|
} else {
|
|
_, _ = fmt.Fprintf(w, "💾 Total Size: %s\n", bold.Sprint("0 B"))
|
|
}
|
|
|
|
if !info.OldestSecret.IsZero() {
|
|
_, _ = fmt.Fprintf(w, "🕰️ Oldest Secret: %s\n",
|
|
info.OldestSecret.Format("2006-01-02 15:04:05"))
|
|
}
|
|
|
|
if !info.LatestSecret.IsZero() {
|
|
_, _ = fmt.Fprintf(w, "✨ Latest Secret: %s\n",
|
|
info.LatestSecret.Format("2006-01-02 15:04:05"))
|
|
}
|
|
|
|
_, _ = fmt.Fprintln(w)
|
|
|
|
return nil
|
|
}
|