Compare commits

..
4 Commits
Author SHA1 Message Date
Sebastian Unterschütz 7f53b90266 feat: search multiple NetBox instances with isolated host identities
Release / release (push) Successful in 5m16s
2026-10-27 23:14:42 +01:00
Sebastian Unterschütz a2a6dd7591 chore(deps): update github.com/charmbracelet/ultraviolet digest to a45b7c8
Release / release (push) Successful in 5m7s
2026-10-27 22:44:00 +01:00
Sebastian Unterschütz 79c0027833 fix(deps): migrate Charm to v2 and require Go 1.27.3
Release / release (push) Successful in 6m16s
2026-10-27 22:29:54 +01:00
Sebastian Unterschütz fa7446e5f7 Fix host resolution and concurrent cache updates 2026-10-27 22:23:59 +01:00
34 changed files with 2158 additions and 281 deletions

No files matched your search

+27
View File
@@ -1,5 +1,32 @@
# Changelog
## v0.0.20
- Configure multiple named NetBox instances and search them together in parallel.
- Add, edit, and remove instances in the interactive setup wizard while retaining legacy single-instance configuration support.
- Display instance-qualified hostnames and support `instance/hostname` for SSH, completion, aliases, and notes.
- Keep credentials, IP resolution, comments, cache entries, and local notes tied to the correct instance.
- Preserve partial interactive search results with an outage warning; reject incomplete full refreshes and ambiguous direct connections.
- Add `cache refresh --instance NAME` and isolate caches when configured endpoints change.
- Add regression tests covering duplicate names and IDs across instances, outages, SSH routing, notes, aliases, and configuration round trips.
## v0.0.19
- Update Ultraviolet to commit `a45b7c8`.
## v0.0.18
- Require Go 1.27.3 and migrate Bubbles, Bubble Tea, Huh, and Lip Gloss to their v2 modules under `charm.land`.
- Update TUI rendering and keyboard events for Bubble Tea v2 while preserving alternate-screen behavior.
- Route paste events to the focused editor, size input fields explicitly, and keep host lists within the terminal height.
- Reject ambiguous cached shortcuts and skip duplicate hostnames during cache refresh.
- Use paginated, unambiguous host lookups for SSH connections.
- Accept shortcut domains with or without a leading dot during cold lookups.
- Parse combined SSH options and preserve explicit users and ports supplied through `-o`.
- Merge cache changes under a file lock to preserve updates from concurrent processes.
- Honor configured resolver strategies during refresh and remove entries that no longer resolve safely.
- Check the host kind before reusing a cached IP for a TUI selection.
## v0.0.17
- Update Go module dependencies to the latest versions within their existing module paths, including used transitive test dependencies.
+43 -2
View File
@@ -103,7 +103,7 @@ Re-run it at any time to change settings without editing the file manually:
netssh configure
```
The wizard walks through NetBox connection, SSH defaults, resolver strategies, cache TTL, and an optional command alias,
The wizard lets you add, edit, and remove named NetBox instances, then walks through SSH defaults, resolver strategies, cache TTL, and an optional command alias,
then saves to `~/.config/netssh.yaml`.
### Manual config
@@ -142,7 +142,44 @@ shortcuts:
strip_hyphens: false # if true, fsn1-web01 → fsn1web01 (cache-only resolution)
```
Any value can be overridden with environment variables (`NETSSH_NETBOX_URL`, `NETSSH_NETBOX_TOKEN`, etc.).
Single-instance and shared settings can be overridden with environment variables (`NETSSH_NETBOX_URL`, `NETSSH_NETBOX_TOKEN`, etc.).
### Multiple NetBox instances
Use `netssh configure` to manage instances, or replace the `netbox:` section with a `netboxes:` list:
```yaml
netboxes:
- name: office
url: https://netbox.office.example
token: nbt_office-token
- name: lab
url: https://netbox.lab.example
token: nbt_lab-token
```
Names must be unique and contain only letters, digits, underscores, or hyphens. Names are normalized to lowercase. Each instance has its own token and optional `token_version`; SSH, resolver, and shortcut settings apply to all instances. Configure either `netbox:` or `netboxes:`. Existing single-instance files continue to work; the wizard migrates them to a named `default` instance when saved.
The legacy `NETSSH_NETBOX_URL` and `NETSSH_NETBOX_TOKEN` variables apply to single-instance configuration. They are ignored when the file contains only a named `netboxes:` list.
Each NetBox keeps its own inventory of devices and virtual machines; either inventory may be empty. The interactive search queries all instances in parallel, including when one already has cached matches. Results show the instance as part of the hostname, for example `office/web01`. If an instance is unavailable, available results and cached hosts remain visible with a warning.
```sh
netssh # search all instances interactively
netssh office/web01 # choose an instance explicitly
netssh admin@lab/web01 uptime
netssh web01 # accepted only if the live lookup is unambiguous
netssh cache refresh # refresh all instances
netssh cache refresh --instance lab # refresh just one instance
netssh notes set office/web01 "Office maintenance"
netssh notes show lab/web01 --netbox --kind device
```
For direct connections without an instance prefix, every instance must be reachable to verify uniqueness. A qualified target queries only its own instance and can use a fresh cached IP while other instances are offline. Qualified shortcuts such as `office/web01` also support configured domain suffixes and hyphen folding.
Cache entries and generated aliases retain the instance name (`office_web01` and `lab_web01`). Named-instance caches live in a configuration-specific subdirectory beneath the configured cache path, so changing an endpoint cannot reuse another server's cached IPs. Run `netssh cache refresh` after adding or changing instances. A failed full refresh leaves the cache and its refresh timestamp unchanged; a per-instance refresh preserves the other instances and does not mark the whole cache as refreshed.
Local notes remain keyed by the NetBox URL, host kind, and canonical hostname. Migrating a single instance or renaming it preserves its notes. Use `instance/hostname` and `--kind` for uncached local notes; these operations work offline. NetBox comments and interface/IP lookups always use the selected instance's credentials.
### Short command alias
@@ -250,6 +287,8 @@ Resolution order:
2. **Domain expansion** — if the input contains no dot, each configured domain is appended and tried (`web01` → `web01.example.com`). If no cache hit, NetBox is queried with the expanded name.
3. **Hyphen folding** (`strip_hyphens: true`) — hyphens are inserted back before looking up in the cache (`fsn1web01` → `fsn1-web01.example.com`). This only works when the host is already cached; run `netssh cache refresh` first.
Domains may be configured with or without a leading dot. If several cached hosts normalize to the same shortcut, the connection is rejected; use the full hostname. Live host lookups check every result page and reject duplicate exact names.
| Input | Config | Resolved as |
|-------|--------|-------------|
| `web01` | `domains: [.example.com]` | `web01.example.com` |
@@ -401,6 +440,8 @@ netssh search app- # prints matching hostnames, one per line
Strategies are tried in the configured order; the first to succeed wins.
Cache refresh uses the same strategies as a direct connection. To allow the primary IP as a fallback, include `primary_ip` in the strategy list. Hosts that cannot be resolved, or have ambiguous names in the refresh results, are removed from the cache and reported as warnings.
| Name | Description |
|------|-------------|
| `primary_ip` | Returns the `primary_ip4` (or `primary_ip6`) set in NetBox. No extra API call. |
+197
View File
@@ -0,0 +1,197 @@
package main
import (
"context"
"encoding/json"
"errors"
"fmt"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"strconv"
"strings"
"testing"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
)
type connectionTestHost struct {
ID int `json:"id"`
Name string `json:"name"`
PrimaryIP4 *struct {
Address string `json:"address"`
} `json:"primary_ip4,omitempty"`
}
func connectionTestServer(t *testing.T, devices, vms []connectionTestHost) *httptest.Server {
t.Helper()
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
var hosts []connectionTestHost
switch r.URL.Path {
case "/api/dcim/devices/":
hosts = devices
case "/api/virtualization/virtual-machines/":
hosts = vms
case "/api/ipam/ip-addresses/":
fmt.Fprint(w, `{"count":0,"results":[]}`)
return
default:
http.NotFound(w, r)
return
}
query := strings.ToLower(r.URL.Query().Get("name__ic"))
matched := make([]connectionTestHost, 0)
for _, host := range hosts {
if strings.Contains(strings.ToLower(host.Name), query) {
matched = append(matched, host)
}
}
offset, _ := strconv.Atoi(r.URL.Query().Get("offset"))
limit, _ := strconv.Atoi(r.URL.Query().Get("limit"))
if limit <= 0 {
limit = 50
}
start, end := min(offset, len(matched)), min(offset+limit, len(matched))
json.NewEncoder(w).Encode(map[string]any{"count": len(matched), "results": matched[start:end]})
}))
t.Cleanup(srv.Close)
return srv
}
func TestFindSSHHostBeyondFirstPage(t *testing.T) {
var devices []connectionTestHost
for i := range 50 {
devices = append(devices, connectionTestHost{ID: i + 1, Name: fmt.Sprintf("web-extra-%02d", i)})
}
devices = append(devices, connectionTestHost{ID: 51, Name: "web"})
srv := connectionTestServer(t, devices, nil)
host, err := findSSHHost(context.Background(), netbox.NewClient(srv.URL, "token", 0), "web", nil)
if err != nil || host.ID != 51 {
t.Fatalf("host beyond first page not resolved: %+v, %v", host, err)
}
}
func TestFindSSHHostDomainExpansion(t *testing.T) {
for _, domain := range []string{"example.com", ".example.com", " .example.com "} {
t.Run(domain, func(t *testing.T) {
srv := connectionTestServer(t, []connectionTestHost{{ID: 1, Name: "web.example.com"}}, nil)
host, err := findSSHHost(context.Background(), netbox.NewClient(srv.URL, "token", 0), "web", []string{domain})
if err != nil || host.Name != "web.example.com" {
t.Fatalf("domain expansion failed: %+v, %v", host, err)
}
})
}
}
func TestFindSSHHostRejectsAmbiguity(t *testing.T) {
srv := connectionTestServer(t, []connectionTestHost{{ID: 1, Name: "web"}, {ID: 2, Name: "web.example.com"}}, []connectionTestHost{{ID: 3, Name: "web"}})
_, err := findSSHHost(context.Background(), netbox.NewClient(srv.URL, "token", 0), "web", []string{"example.com"})
if err == nil || errors.Is(err, netbox.ErrHostNotFound) || !strings.Contains(err.Error(), "2 exact matches") {
t.Fatalf("ambiguous name accepted or expanded: %v", err)
}
}
func TestFindSSHHostDoesNotHideAPIErrors(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
http.Error(w, "unavailable", http.StatusServiceUnavailable)
}))
defer srv.Close()
_, err := findSSHHost(context.Background(), netbox.NewClient(srv.URL, "token", 0), "web", []string{"example.com"})
if err == nil || errors.Is(err, netbox.ErrHostNotFound) {
t.Fatalf("API failure hidden as missing host: %v", err)
}
}
func TestFindSSHHostNotFound(t *testing.T) {
srv := connectionTestServer(t, nil, nil)
_, err := findSSHHost(context.Background(), netbox.NewClient(srv.URL, "token", 0), "missing", []string{"example.com"})
if !errors.Is(err, netbox.ErrHostNotFound) {
t.Fatalf("want missing-host error, got %v", err)
}
}
func TestCacheRefreshHonorsResolverAndRemovesUnsafeEntries(t *testing.T) {
for _, tc := range []struct {
name, strategies string
wantCached bool
}{
{"management only", "[management_subnet]", false},
{"explicit primary fallback", "[management_subnet, primary_ip]", true},
} {
t.Run(tc.name, func(t *testing.T) {
host := connectionTestHost{ID: 1, Name: "web", PrimaryIP4: &struct {
Address string `json:"address"`
}{Address: "192.0.2.1/24"}}
srv := connectionTestServer(t, []connectionTestHost{host}, nil)
path := prepareRefreshTest(t, srv.URL, tc.strategies)
c := cache.New(path, 3600)
c.Upsert(cache.Entry{Name: "web", IP: "192.0.2.99", Kind: "device"})
if err := c.Save(); err != nil {
t.Fatal(err)
}
cmd := rootCmd()
cmd.SetArgs([]string{"cache", "refresh"})
if err := cmd.Execute(); err != nil {
t.Fatal(err)
}
if err := c.Load(); err != nil {
t.Fatal(err)
}
got, fresh := c.Get("web")
if tc.wantCached {
if !fresh || got.IP != "192.0.2.1" {
t.Fatalf("explicit fallback failed: %+v", got)
}
} else if got.Name != "" {
t.Fatalf("unsafe primary IP retained: %+v", got)
}
})
}
}
func TestCacheRefreshSkipsAmbiguousNames(t *testing.T) {
host := connectionTestHost{ID: 1, Name: "web", PrimaryIP4: &struct {
Address string `json:"address"`
}{Address: "192.0.2.1/24"}}
vm := host
vm.ID = 2
srv := connectionTestServer(t, []connectionTestHost{host}, []connectionTestHost{vm})
path := prepareRefreshTest(t, srv.URL, "[primary_ip]")
c := cache.New(path, 3600)
c.Upsert(cache.Entry{Name: "web", IP: "192.0.2.99", Kind: "device"})
if err := c.Save(); err != nil {
t.Fatal(err)
}
cmd := rootCmd()
cmd.SetArgs([]string{"cache", "refresh"})
if err := cmd.Execute(); err != nil {
t.Fatal(err)
}
if err := c.Load(); err != nil {
t.Fatal(err)
}
if len(c.All()) != 0 {
t.Fatalf("ambiguous host cached: %+v", c.All())
}
}
func prepareRefreshTest(t *testing.T, baseURL, strategies string) string {
t.Helper()
configDir := t.TempDir()
t.Setenv("HOME", t.TempDir())
t.Setenv("XDG_CONFIG_HOME", configDir)
t.Setenv("XDG_CACHE_HOME", t.TempDir())
path := filepath.Join(t.TempDir(), "hosts.json")
t.Setenv("NETSSH_CACHE_PATH", path)
t.Setenv("NETSSH_NETBOX_URL", baseURL)
t.Setenv("NETSSH_NETBOX_TOKEN", "token")
t.Setenv("NETSSH_SHELL_ALIAS", "")
data := fmt.Sprintf("resolver:\n strategies: %s\n management_subnets: [10.0.0.0/8]\n", strategies)
if err := os.WriteFile(filepath.Join(configDir, "netssh.yaml"), []byte(data), 0o600); err != nil {
t.Fatal(err)
}
return path
}
+32
View File
@@ -0,0 +1,32 @@
package main
import (
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/shortcuts"
)
func newNetBoxClient(cfg *config.Config) *netbox.Client {
if len(cfg.NetBoxes) > 0 {
sources := make([]netbox.Source, 0, len(cfg.NetBoxes))
for _, source := range cfg.NetBoxes {
sources = append(sources, netbox.Source{Name: source.Name, URL: source.URL, Token: source.Token, TokenVersion: source.TokenVersion})
}
return netbox.NewMultiClient(sources)
}
if cfg.NetBox.URL == "" {
return nil
}
return netbox.NewClient(cfg.NetBox.URL, cfg.NetBox.Token, cfg.NetBox.TokenVersion)
}
func normalizeTarget(cfg config.ShortcutsConfig, qualified bool) func(string) string {
return func(target string) string {
source, name := netbox.SplitTarget(target)
name = shortcuts.Normalize(name, cfg)
if qualified && source != "" {
return source + "/" + name
}
return name
}
}
+208
View File
@@ -0,0 +1,208 @@
package main
import (
"bytes"
"fmt"
"net/http"
"net/http/httptest"
"os"
"os/exec"
"path/filepath"
"strings"
"testing"
"time"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
)
func prepareInstancesTest(t *testing.T, officeURL, labURL string) *config.Config {
t.Helper()
dir := t.TempDir()
t.Setenv("HOME", t.TempDir())
t.Setenv("XDG_CONFIG_HOME", dir)
t.Setenv("XDG_CACHE_HOME", t.TempDir())
t.Setenv("NETSSH_NETBOX_URL", "")
t.Setenv("NETSSH_NETBOX_TOKEN", "")
t.Setenv("NETSSH_CACHE_PATH", filepath.Join(t.TempDir(), "hosts.json"))
t.Setenv("NETSSH_SHELL_ALIAS", "")
data := fmt.Sprintf("netboxes:\n - name: office\n url: %q\n token: office-token\n - name: lab\n url: %q\n token: lab-token\nresolver:\n strategies: [primary_ip]\n", officeURL, labURL)
if err := os.WriteFile(filepath.Join(dir, "netssh.yaml"), []byte(data), 0o600); err != nil {
t.Fatal(err)
}
cfg, err := config.Load()
if err != nil {
t.Fatal(err)
}
return cfg
}
func multiHost(name, ip string) connectionTestHost {
return connectionTestHost{ID: 1, Name: name, PrimaryIP4: &struct {
Address string `json:"address"`
}{Address: ip + "/24"}}
}
func TestRefreshStoresSameHostnameFromBothInstances(t *testing.T) {
office := connectionTestServer(t, []connectionTestHost{multiHost("web", "10.0.0.1")}, nil)
lab := connectionTestServer(t, []connectionTestHost{multiHost("web", "10.0.0.2")}, nil)
cfg := prepareInstancesTest(t, office.URL, lab.URL)
cmd := rootCmd()
cmd.SetArgs([]string{"cache", "refresh"})
if err := cmd.Execute(); err != nil {
t.Fatal(err)
}
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
if err := c.Load(); err != nil {
t.Fatal(err)
}
for name, ip := range map[string]string{"office/web": "10.0.0.1", "lab/web": "10.0.0.2"} {
got, fresh := c.Get(name)
if !fresh || got.IP != ip {
t.Fatalf("cache source collision: %+v, fresh=%v", got, fresh)
}
}
if len(c.All()) != 2 || c.NeedsRefresh(time.Hour) {
t.Fatal("full refresh is incomplete")
}
}
func TestRefreshFailureAndPerInstanceRefresh(t *testing.T) {
office := connectionTestServer(t, []connectionTestHost{multiHost("web", "10.0.0.1")}, nil)
failed := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { http.Error(w, "offline", 503) }))
defer failed.Close()
cfg := prepareInstancesTest(t, office.URL, failed.URL)
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
c.Upsert(cache.Entry{Name: "lab/old", Kind: "device", IP: "10.0.0.2"})
if err := c.Save(); err != nil {
t.Fatal(err)
}
cmd := rootCmd()
cmd.SetArgs([]string{"cache", "refresh"})
if err := cmd.Execute(); err == nil {
t.Fatal("failed instance marked as full refresh")
}
if err := c.Load(); err != nil {
t.Fatal(err)
}
if len(c.All()) != 1 || !c.NeedsRefresh(time.Hour) {
t.Fatal("partial refresh changed cache or full-refresh stamp")
}
cmd = rootCmd()
cmd.SetArgs([]string{"cache", "refresh", "--instance", "office"})
if err := cmd.Execute(); err != nil {
t.Fatal(err)
}
if err := c.Load(); err != nil {
t.Fatal(err)
}
if len(c.All()) != 2 || !c.NeedsRefresh(time.Hour) {
t.Fatal("per-instance refresh lost other source or updated full stamp")
}
}
func TestLocalNotesCLIKeepsInstancesSeparate(t *testing.T) {
cfg := prepareInstancesTest(t, "https://office.example", "https://lab.example")
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
for _, name := range []string{"office/web", "lab/web"} {
c.Upsert(cache.Entry{Name: name, Kind: "device", IP: "10.0.0.1"})
}
if err := c.Save(); err != nil {
t.Fatal(err)
}
run := func(args ...string) (string, error) {
var out bytes.Buffer
cmd := rootCmd()
cmd.SetArgs(append([]string{"notes"}, args...))
cmd.SetOut(&out)
cmd.SetErr(&out)
err := cmd.Execute()
return out.String(), err
}
for _, source := range []string{"office", "lab"} {
if _, err := run("set", source+"/web", source+" note"); err != nil {
t.Fatal(err)
}
}
for _, source := range []string{"office", "lab"} {
got, err := run("show", source+"/web")
if err != nil || got != source+" note" {
t.Fatalf("CLI notes crossed sources: %q, %v", got, err)
}
}
if _, err := run("set", "web", "wrong note"); err == nil {
t.Fatal("ambiguous note target accepted")
}
}
func TestMultiInstanceWrapperHelper(t *testing.T) {
if target := os.Getenv("NETSSH_TEST_MULTI_TARGET"); target != "" {
runSSHWrapper([]string{target})
return
}
}
func TestWrapperRoutesQualifiedTargetsAndRejectsAmbiguity(t *testing.T) {
office := connectionTestServer(t, []connectionTestHost{multiHost("web", "10.0.0.1")}, nil)
lab := connectionTestServer(t, []connectionTestHost{multiHost("web", "10.0.0.2")}, nil)
cfg := prepareInstancesTest(t, office.URL, lab.URL)
c := cache.New(cfg.CachePath(), 3600)
if err := c.SetRefreshed(); err != nil {
t.Fatal(err)
}
bin := t.TempDir()
if err := os.WriteFile(filepath.Join(bin, "ssh"), []byte("#!/bin/sh\nprintf '%s\\n' \"$@\"\n"), 0o755); err != nil {
t.Fatal(err)
}
for target, want := range map[string]string{"office/web": "10.0.0.1", "lab/web": "10.0.0.2", "web": "ambiguous"} {
cmd := exec.Command(os.Args[0], "-test.run=^TestMultiInstanceWrapperHelper$")
cmd.Env = append(os.Environ(), "NETSSH_TEST_MULTI_TARGET="+target, "PATH="+bin+":"+os.Getenv("PATH"))
out, err := cmd.CombinedOutput()
if want == "ambiguous" {
if err == nil || !strings.Contains(string(out), "2 exact matches") {
t.Fatalf("ambiguous connection accepted: %s, %v", out, err)
}
} else if err != nil || !strings.Contains(string(out), want+"\n") {
t.Fatalf("wrong SSH destination for %s: %s, %v", target, out, err)
}
}
}
func TestQualifiedShortcutDoesNotMatchOtherInstance(t *testing.T) {
cfg := config.ShortcutsConfig{Domains: []string{".example.com"}, StripHyphens: true}
normalize := normalizeTarget(cfg, true)
if normalize("office/web-01.example.com") != normalize("office/web01") {
t.Fatal("qualified shortcut does not normalize")
}
if normalize("office/web01") == normalize("lab/web01") {
t.Fatal("qualified shortcut lost instance")
}
}
func TestRefreshCachesIndependentDevicesAndVMs(t *testing.T) {
office := connectionTestServer(t, []connectionTestHost{multiHost("router", "10.1.0.1")}, []connectionTestHost{multiHost("app", "10.1.0.2")})
lab := connectionTestServer(t, []connectionTestHost{multiHost("switch", "10.2.0.1")}, []connectionTestHost{multiHost("test-vm", "10.2.0.2")})
cfg := prepareInstancesTest(t, office.URL, lab.URL)
cmd := rootCmd()
cmd.SetArgs([]string{"cache", "refresh"})
if err := cmd.Execute(); err != nil {
t.Fatal(err)
}
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
if err := c.Load(); err != nil {
t.Fatal(err)
}
want := map[string]struct{ kind, ip string }{
"office/router": {"device", "10.1.0.1"}, "office/app": {"vm", "10.1.0.2"},
"lab/switch": {"device", "10.2.0.1"}, "lab/test-vm": {"vm", "10.2.0.2"},
}
if len(c.All()) != len(want) {
t.Fatalf("missing inventory entries: %+v", c.All())
}
for name, entry := range want {
got, fresh := c.Get(name)
if !fresh || got.Kind != entry.kind || got.IP != entry.ip {
t.Fatalf("wrong cached host %s: %+v", name, got)
}
}
}
+108 -85
View File
@@ -2,6 +2,7 @@ package main
import (
"context"
"errors"
"fmt"
"os"
"os/exec"
@@ -12,7 +13,7 @@ import (
"text/tabwriter"
"time"
tea "github.com/charmbracelet/bubbletea"
tea "charm.land/bubbletea/v2"
"github.com/spf13/cobra"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
@@ -22,7 +23,6 @@ import (
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/notes"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/resolver"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/setup"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/shortcuts"
internalssh "git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/ssh"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/tui"
)
@@ -65,7 +65,7 @@ func loadConfigOrSetup() *config.Config {
if err != nil {
fatalf("config: %v", err)
}
if cfg.NetBox.URL == "" {
if !cfg.HasNetBox() {
fmt.Fprintln(os.Stderr, "No configuration found. Starting setup…")
if err := setup.RunWizard(cfg); err != nil {
fatalf("setup: %v", err)
@@ -102,12 +102,15 @@ func runSSHWrapper(args []string) {
parsed.DestIdx += 2
}
c := cache.New(cfg.Cache.Path, cfg.Cache.TTL)
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
_ = c.Load()
maybeBackgroundRefresh(cfg, c)
source, _ := netbox.SplitTarget(parsed.Host)
useCache := len(cfg.NetBoxes) == 0 || source != ""
// Cache hit with a fresh TTL — connect directly without querying NetBox.
if entry, fresh := c.Get(parsed.Host); fresh {
if entry, fresh := c.Get(parsed.Host); fresh && useCache {
c.MarkUsed(parsed.Host)
_ = c.Save()
connect(entry.IP, parsed, args)
@@ -118,9 +121,13 @@ func runSSHWrapper(args []string) {
// If a stale match is found, use the canonical name for the NetBox re-fetch below.
lookupHost := parsed.Host
shortcutsEnabled := len(cfg.Shortcuts.Domains) > 0 || cfg.Shortcuts.StripHyphens
if shortcutsEnabled {
normalize := shortcuts.MakeNormalizer(cfg.Shortcuts)
if entry, found, fresh := c.GetByShortcut(lookupHost, normalize); found {
if cached, _ := c.Get(lookupHost); shortcutsEnabled && cached.Name == "" && useCache {
normalize := normalizeTarget(cfg.Shortcuts, source != "")
entry, found, fresh, err := c.GetByShortcut(lookupHost, normalize)
if err != nil {
fatalf("%v", err)
}
if found {
if fresh {
c.MarkUsed(entry.Name)
_ = c.Save()
@@ -132,50 +139,33 @@ func runSSHWrapper(args []string) {
}
}
if cfg.NetBox.URL == "" {
if !cfg.HasNetBox() {
fatalf("netbox.url is not configured (~/.config/netssh.yaml)")
}
nbClient := netbox.NewClient(cfg.NetBox.URL, cfg.NetBox.Token, cfg.NetBox.TokenVersion)
nbClient := newNetBoxClient(cfg)
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
entries, err := nbClient.Search(ctx, lookupHost, netbox.SearchOptions{})
target, err := findSSHHost(ctx, nbClient, lookupHost, cfg.Shortcuts.Domains)
if errors.Is(err, netbox.ErrHostNotFound) && !useCache && shortcutsEnabled {
entry, found, _, cacheErr := c.GetByShortcut(parsed.Host, normalizeTarget(cfg.Shortcuts, false))
if cacheErr != nil {
fatalf("%v", cacheErr)
}
if found {
target, err = findSSHHost(ctx, nbClient, entry.Name, cfg.Shortcuts.Domains)
}
}
if err != nil {
fatalf("NetBox search failed: %v", err)
fatalf("NetBox: %v", err)
}
var target *netbox.HostEntry
for i, e := range entries {
if strings.EqualFold(e.Name, lookupHost) {
target = &entries[i]
break
}
}
// Domain expansion: if still no match and the input has no dots, try appending
// each configured domain suffix and re-querying NetBox.
if target == nil && !strings.Contains(parsed.Host, ".") && len(cfg.Shortcuts.Domains) > 0 {
for _, domain := range cfg.Shortcuts.Domains {
expanded := parsed.Host + domain
expandedEntries, searchErr := nbClient.Search(ctx, expanded, netbox.SearchOptions{})
if searchErr != nil {
continue
}
for i, e := range expandedEntries {
if strings.EqualFold(e.Name, expanded) {
target = &expandedEntries[i]
break
}
}
if target != nil {
break
}
}
}
if target == nil {
fatalf("host %q not found in NetBox", parsed.Host)
if cached, fresh := c.Get(target.Target()); fresh && cached.Kind == target.Kind {
c.MarkUsed(target.Target())
_ = c.Save()
connect(cached.IP, parsed, args)
return
}
chain, err := resolver.New(cfg.Resolver)
@@ -183,18 +173,38 @@ func runSSHWrapper(args []string) {
fatalf("resolver: %v", err)
}
ip, err := chain.Resolve(ctx, target, nbClient)
ip, err := chain.Resolve(ctx, &target, nbClient)
if err != nil {
fatalf("IP resolution for %q: %v", parsed.Host, err)
}
c.Upsert(cache.Entry{Name: target.Name, IP: ip, Kind: target.Kind, Tags: target.Tags})
c.MarkUsed(target.Name)
c.Upsert(cache.Entry{Name: target.Target(), IP: ip, Kind: target.Kind, Tags: target.Tags})
c.MarkUsed(target.Target())
_ = c.Save()
connect(ip, parsed, args)
}
// findSSHHost uses the paginated, ambiguity-checking lookup for connection
// targets. Only a genuine missing host permits trying configured suffixes.
func findSSHHost(ctx context.Context, client *netbox.Client, name string, domains []string) (netbox.HostEntry, error) {
target, err := client.FindHost(ctx, name, "")
if !errors.Is(err, netbox.ErrHostNotFound) || strings.Contains(name, ".") {
return target, err
}
for _, domain := range domains {
domain = strings.TrimPrefix(strings.TrimSpace(domain), ".")
if domain == "" {
continue
}
target, err = client.FindHost(ctx, name+"."+domain, "")
if !errors.Is(err, netbox.ErrHostNotFound) {
return target, err
}
}
return netbox.HostEntry{}, fmt.Errorf("%w: %q", netbox.ErrHostNotFound, name)
}
func connect(ip string, parsed *internalssh.ParsedArgs, originalArgs []string) {
newArgs := internalssh.ReplaceHost(originalArgs, parsed.DestIdx, ip)
if err := internalssh.Exec(newArgs); err != nil {
@@ -206,18 +216,18 @@ func connect(ip string, parsed *internalssh.ParsedArgs, originalArgs []string) {
func runTUI() {
cfg := loadConfigOrSetup()
c := cache.New(cfg.Cache.Path, cfg.Cache.TTL)
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
_ = c.Load()
maybeBackgroundRefresh(cfg, c)
var nbClient *netbox.Client
if cfg.NetBox.URL != "" {
nbClient = netbox.NewClient(cfg.NetBox.URL, cfg.NetBox.Token, cfg.NetBox.TokenVersion)
if cfg.HasNetBox() {
nbClient = newNetBoxClient(cfg)
}
m := tui.New(nbClient, c, cfg.SSH.DefaultUser, cfg.SSH.DefaultPort)
m.SetNotes(notes.New(cfg.NetBox.URL, nbClient))
p := tea.NewProgram(m, tea.WithAltScreen())
p := tea.NewProgram(m)
final, err := p.Run()
if err != nil {
fatalf("TUI: %v", err)
@@ -233,7 +243,7 @@ func runTUI() {
}
// Revalidate stale or live TUI results through the configured resolver chain.
if cached, fresh := c.Get(host.Name); fresh {
if cached, fresh := c.Get(host.Name); fresh && cached.Kind == host.Kind {
host.IP = cached.IP
} else {
if nbClient == nil {
@@ -253,7 +263,7 @@ func runTUI() {
if err != nil {
fatalf("IP resolution: %v", err)
}
c.Upsert(cache.Entry{Name: target.Name, IP: host.IP, Kind: target.Kind, Tags: target.Tags})
c.Upsert(cache.Entry{Name: target.Target(), IP: host.IP, Kind: target.Kind, Tags: target.Tags})
}
fmt.Fprintf(os.Stderr, "Connecting to %s (%s)…\n", host.Name, host.IP)
@@ -298,7 +308,7 @@ func rootCmd() *cobra.Command {
if err != nil {
return nil, cobra.ShellCompDirectiveError
}
c := cache.New(cfg.Cache.Path, cfg.Cache.TTL)
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
_ = c.Load()
var completions []cobra.Completion
@@ -411,9 +421,9 @@ func configureCmd() *cobra.Command {
Use: "configure",
Short: "Interactively configure netssh",
RunE: func(cmd *cobra.Command, args []string) error {
cfg, _ := config.Load()
if cfg == nil {
cfg = &config.Config{}
cfg, err := config.Load()
if err != nil {
return err
}
return setup.RunWizard(cfg)
},
@@ -430,7 +440,7 @@ func searchCmd() *cobra.Command {
if err != nil {
return err
}
c := cache.New(cfg.Cache.Path, cfg.Cache.TTL)
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
if err := c.Load(); err != nil {
return err
}
@@ -464,7 +474,7 @@ func cacheListCmd() *cobra.Command {
if err != nil {
return err
}
c := cache.New(cfg.Cache.Path, cfg.Cache.TTL)
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
if err := c.Load(); err != nil {
return err
}
@@ -490,7 +500,7 @@ func cacheClearCmd() *cobra.Command {
if err != nil {
return err
}
c := cache.New(cfg.Cache.Path, cfg.Cache.TTL)
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
c.Clear()
if err := c.Save(); err != nil {
return err
@@ -502,7 +512,7 @@ func cacheClearCmd() *cobra.Command {
}
func cacheRefreshCmd() *cobra.Command {
var filterTag, filterKind string
var filterTag, filterKind, filterInstance string
cmd := &cobra.Command{
Use: "refresh",
Short: "Re-fetch all known hosts from NetBox",
@@ -511,21 +521,28 @@ func cacheRefreshCmd() *cobra.Command {
if err != nil {
return err
}
if cfg.NetBox.URL == "" {
if !cfg.HasNetBox() {
return fmt.Errorf("netbox.url is not configured")
}
nbClient := netbox.NewClient(cfg.NetBox.URL, cfg.NetBox.Token, cfg.NetBox.TokenVersion)
nbClient := newNetBoxClient(cfg)
ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second)
defer cancel()
opts := netbox.SearchOptions{Tag: filterTag, Kind: filterKind}
entries, err := nbClient.SearchAll(ctx, "", opts)
query := ""
if filterInstance != "" {
if !nbClient.MultipleSources() {
return fmt.Errorf("--instance requires named netboxes configuration")
}
query = filterInstance + "/"
}
entries, err := nbClient.SearchAll(ctx, query, opts)
if err != nil {
return fmt.Errorf("NetBox: %w", err)
}
c := cache.New(cfg.Cache.Path, cfg.Cache.TTL)
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
_ = c.Load()
chain, err := resolver.New(cfg.Resolver)
@@ -533,32 +550,37 @@ func cacheRefreshCmd() *cobra.Command {
return fmt.Errorf("resolver: %w", err)
}
written := 0
nameCounts := make(map[string]int)
for _, e := range entries {
nameCounts[strings.ToLower(e.Target())]++
}
for i := range entries {
e := &entries[i]
if nameCounts[strings.ToLower(e.Target())] > 1 {
c.Delete(e.Target())
fmt.Fprintf(os.Stderr, "warning: skipping ambiguous hostname %q\n", e.Name)
continue
}
var ip string
if chain != nil {
if resolved, err := chain.Resolve(ctx, e, nbClient); err == nil {
ip = resolved
ip, err := chain.Resolve(ctx, e, nbClient)
if err != nil {
// Do not turn a failed configured strategy into a fresh
// primary-IP cache hit that bypasses the resolver.
if ctx.Err() != nil {
return ctx.Err()
}
c.Delete(e.Target())
fmt.Fprintf(os.Stderr, "warning: skipping %s: %v\n", e.Name, err)
continue
}
if ip == "" {
ip = e.PrimaryIP4
}
if ip == "" {
ip = e.PrimaryIP6
}
if ip != "" {
c.Upsert(cache.Entry{Name: e.Name, IP: ip, Kind: e.Kind, Tags: e.Tags})
written++
}
c.Upsert(cache.Entry{Name: e.Target(), IP: ip, Kind: e.Kind, Tags: e.Tags})
written++
}
if err := c.Save(); err != nil {
return err
}
if filterTag == "" && filterKind == "" {
if filterTag == "" && filterKind == "" && filterInstance == "" {
if err := c.SetRefreshed(); err != nil {
fmt.Fprintf(os.Stderr, "warning: could not update refresh timestamp: %v\n", err)
}
@@ -574,6 +596,7 @@ func cacheRefreshCmd() *cobra.Command {
}
cmd.Flags().StringVar(&filterTag, "tag", "", "Filter by NetBox tag slug (e.g. prod)")
cmd.Flags().StringVar(&filterKind, "kind", "", "Filter by kind: device or vm")
cmd.Flags().StringVar(&filterInstance, "instance", "", "Refresh only this named NetBox instance")
return cmd
}
@@ -602,7 +625,7 @@ Or use in a script:
if err != nil {
return err
}
c := cache.New(cfg.Cache.Path, cfg.Cache.TTL)
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
if err := c.Load(); err != nil {
return err
}
@@ -647,7 +670,7 @@ func shellInitCmd() *cobra.Command {
if err != nil {
return nil
}
c := cache.New(cfg.Cache.Path, cfg.Cache.TTL)
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
_ = c.Load()
// Regenerate alias files from the current cache every shell start
@@ -708,8 +731,8 @@ After installation, reload your profile or open a new shell.`,
// Generate the aliases file immediately so it is ready on the next shell start.
cfg, cfgErr := config.Load()
if cfgErr == nil && cfg.NetBox.URL != "" {
c := cache.New(cfg.Cache.Path, cfg.Cache.TTL)
if cfgErr == nil && cfg.HasNetBox() {
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
if _ = c.Load(); true {
if entries := buildAliasEntries(c, *cfg); len(entries) > 0 {
if err := hook.WriteAliasFiles(entries); err != nil {
@@ -761,7 +784,7 @@ func hookUninstallCmd() *cobra.Command {
// maybeBackgroundRefresh starts a background `netssh cache refresh` if the cache
// has not been fully refreshed within the last 24 hours.
func maybeBackgroundRefresh(cfg *config.Config, c *cache.Cache) {
if cfg.NetBox.URL == "" {
if !cfg.HasNetBox() {
return
}
if !c.NeedsRefresh(24 * time.Hour) {
+17 -7
View File
@@ -34,11 +34,11 @@ func notesCmd() *cobra.Command {
return err
}
var client *netbox.Client
if cfg.NetBox.URL != "" {
client = netbox.NewClient(cfg.NetBox.URL, cfg.NetBox.Token, cfg.NetBox.TokenVersion)
if cfg.HasNetBox() {
client = newNetBoxClient(cfg)
}
host := netbox.HostEntry{Name: args[0], Kind: kind}
c := cache.New(cfg.Cache.Path, cfg.Cache.TTL)
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
if err := c.Load(); err != nil {
return err
}
@@ -46,13 +46,23 @@ func notesCmd() *cobra.Command {
if !remote {
cached = c.All()
}
query := host.Name
source, rawName := netbox.SplitTarget(query)
var matches []cache.Entry
for _, entry := range cached {
if strings.EqualFold(entry.Name, host.Name) && (kind == "" || kind == entry.Kind) {
host.Name = entry.Name
host.Kind = entry.Kind
break
_, entryName := netbox.SplitTarget(entry.Name)
if (kind == "" || kind == entry.Kind) && (strings.EqualFold(entry.Name, query) || (source == "" && strings.EqualFold(entryName, rawName))) {
matches = append(matches, entry)
}
}
if len(matches) > 1 {
return fmt.Errorf("ambiguous hostname %q; use instance/hostname", query)
}
if len(matches) == 1 {
host.Name = matches[0].Name
host.Kind = matches[0].Kind
}
if !remote && host.Kind == "" {
return fmt.Errorf("host is not cached; specify --kind device or --kind vm")
}
+11 -14
View File
@@ -1,44 +1,41 @@
module git.zb-server.de/Sebi/ssh-netbox-wrapper
go 1.26.3
go 1.27.3
require (
github.com/charmbracelet/bubbles v1.0.0
github.com/charmbracelet/bubbletea v1.3.10
github.com/charmbracelet/huh v1.0.0
github.com/charmbracelet/lipgloss v1.1.0
charm.land/bubbles/v2 v2.2.1
charm.land/bubbletea/v2 v2.1.0
charm.land/huh/v2 v2.0.3
charm.land/lipgloss/v2 v2.0.6
github.com/spf13/cobra v1.10.2
github.com/spf13/viper v1.21.0
golang.org/x/sys v0.49.0
)
require (
github.com/atotto/clipboard v0.1.4 // indirect
github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
github.com/aymanbagabas/go-udiff v0.4.1 // indirect
github.com/catppuccin/go v0.3.0 // indirect
github.com/charmbracelet/colorprofile v0.4.3 // indirect
github.com/charmbracelet/ultraviolet v0.0.0-20261023060817-a45b7c86333f // indirect
github.com/charmbracelet/x/ansi v0.11.9 // indirect
github.com/charmbracelet/x/cellbuf v0.0.15 // indirect
github.com/charmbracelet/x/exp/golden v0.1.0 // indirect
github.com/charmbracelet/x/exp/ordered v0.1.0 // indirect
github.com/charmbracelet/x/exp/strings v0.1.0 // indirect
github.com/charmbracelet/x/term v0.2.2 // indirect
github.com/charmbracelet/x/termios v0.1.1 // indirect
github.com/charmbracelet/x/windows v0.2.2 // indirect
github.com/charmbracelet/x/xpty v0.1.4 // indirect
github.com/clipperhouse/displaywidth v0.11.0 // indirect
github.com/clipperhouse/uax29/v2 v2.7.0 // indirect
github.com/dustin/go-humanize v1.1.0 // indirect
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect
github.com/fsnotify/fsnotify v1.10.1 // indirect
github.com/go-viper/mapstructure/v2 v2.5.0 // indirect
github.com/google/go-cmp v0.7.0 // indirect
github.com/inconshreveable/mousetrap v1.1.0 // indirect
github.com/lucasb-eyer/go-colorful v1.4.1 // indirect
github.com/mattn/go-isatty v0.0.24 // indirect
github.com/mattn/go-localereader v0.0.1 // indirect
github.com/mattn/go-runewidth v0.0.31 // indirect
github.com/mitchellh/hashstructure/v2 v2.0.2 // indirect
github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 // indirect
github.com/muesli/cancelreader v0.2.2 // indirect
github.com/muesli/termenv v0.16.0 // indirect
github.com/pelletier/go-toml/v2 v2.4.3 // indirect
github.com/rivo/uniseg v0.4.7 // indirect
github.com/rogpeppe/go-internal v1.16.0 // indirect
@@ -51,6 +48,6 @@ require (
github.com/subosito/gotenv v1.6.0 // indirect
github.com/xo/terminfo v1.2.0 // indirect
go.yaml.in/yaml/v3 v3.0.5 // indirect
golang.org/x/sys v0.49.0 // indirect
golang.org/x/sync v0.24.0 // indirect
golang.org/x/text v0.43.0 // indirect
)
+16 -23
View File
@@ -1,37 +1,39 @@
charm.land/bubbles/v2 v2.2.1 h1:Fq1+qm5hV6GkvzLQDhCBpXXE5tLgvh1PRriCLwSvIQU=
charm.land/bubbles/v2 v2.2.1/go.mod h1:wdMgn+sje1KNXdwFizIWjbf328fIUBxqEmJ/vYPo8yc=
charm.land/bubbletea/v2 v2.1.0 h1:A9fj9h5LFrvQhQHFNggp8K8rvY6CUfgn9dMbb6p2HIw=
charm.land/bubbletea/v2 v2.1.0/go.mod h1:xWHeyxIX9/wiFU2kgPW04ojOZyTzrWf+8lGjUCaftiU=
charm.land/huh/v2 v2.0.3 h1:2cJsMqEPwSywGHvdlKsJyQKPtSJLVnFKyFbsYZTlLkU=
charm.land/huh/v2 v2.0.3/go.mod h1:93eEveeeqn47MwiC3tf+2atZ2l7Is88rAtmZNZ8x9Wc=
charm.land/lipgloss/v2 v2.0.6 h1:EaGKeuA8FvF+v2BT5VmZd2LoYLaMZJXA5n34th8nCIQ=
charm.land/lipgloss/v2 v2.0.6/go.mod h1:ipDDJNSGa1hlwDtSfW1s2/xR8Vdhbut4PXh2zEKZd0Q=
github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ=
github.com/MakeNowJust/heredoc v1.0.0/go.mod h1:mG5amYoWBHf8vpLOuehzbGGw0EHxpZZ6lCpQ4fNJ8LE=
github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4=
github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
github.com/aymanbagabas/go-udiff v0.4.1 h1:OEIrQ8maEeDBXQDoGCbbTTXYJMYRCRO1fnodZ12Gv5o=
github.com/aymanbagabas/go-udiff v0.4.1/go.mod h1:0L9PGwj20lrtmEMeyw4WKJ/TMyDtvAoK9bf2u/mNo3w=
github.com/catppuccin/go v0.3.0 h1:d+0/YicIq+hSTo5oPuRi5kOpqkVA5tAsU6dNhvRu+aY=
github.com/catppuccin/go v0.3.0/go.mod h1:8IHJuMGaUUjQM82qBrGNBv7LFq6JI3NnQCF6MOlZjpc=
github.com/charmbracelet/bubbles v1.0.0 h1:12J8/ak/uCZEMQ6KU7pcfwceyjLlWsDLAxB5fXonfvc=
github.com/charmbracelet/bubbles v1.0.0/go.mod h1:9d/Zd5GdnauMI5ivUIVisuEm3ave1XwXtD1ckyV6r3E=
github.com/charmbracelet/bubbletea v1.3.10 h1:otUDHWMMzQSB0Pkc87rm691KZ3SWa4KUlvF9nRvCICw=
github.com/charmbracelet/bubbletea v1.3.10/go.mod h1:ORQfo0fk8U+po9VaNvnV95UPWA1BitP1E0N6xJPlHr4=
github.com/charmbracelet/colorprofile v0.4.3 h1:QPa1IWkYI+AOB+fE+mg/5/4HRMZcaXex9t5KX76i20Q=
github.com/charmbracelet/colorprofile v0.4.3/go.mod h1:/zT4BhpD5aGFpqQQqw7a+VtHCzu+zrQtt1zhMt9mR4Q=
github.com/charmbracelet/huh v1.0.0 h1:wOnedH8G4qzJbmhftTqrpppyqHakl/zbbNdXIWJyIxw=
github.com/charmbracelet/huh v1.0.0/go.mod h1:5YVc+SlZ1IhQALxRPpkGwwEKftN/+OlJlnJYlDRFqN4=
github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY=
github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30=
github.com/charmbracelet/ultraviolet v0.0.0-20261023060817-a45b7c86333f h1:D2JpB65eehsnkEwEG401dMBSNYtTDgvKXZZSl7ZCxWI=
github.com/charmbracelet/ultraviolet v0.0.0-20261023060817-a45b7c86333f/go.mod h1:aJDVk+WOVM1K04rdc/71PMPoUGfjxjhvXfP3Pjz1Zio=
github.com/charmbracelet/x/ansi v0.11.9 h1:kIrqLBxtTVbLyyHO2Evoi93EjQo1mylWmpNEsfPxXAM=
github.com/charmbracelet/x/ansi v0.11.9/go.mod h1:DG/hpOnaI2QJ/KMMqLL2h0KVhluuJLazf8973P+Vy5w=
github.com/charmbracelet/x/cellbuf v0.0.15 h1:ur3pZy0o6z/R7EylET877CBxaiE1Sp1GMxoFPAIztPI=
github.com/charmbracelet/x/cellbuf v0.0.15/go.mod h1:J1YVbR7MUuEGIFPCaaZ96KDl5NoS0DAWkskup+mOY+Q=
github.com/charmbracelet/x/conpty v0.2.0 h1:eKtA2hm34qNfgJCDp/M6Dc0gLy7e07YEK4qAdNGOvVY=
github.com/charmbracelet/x/conpty v0.2.0/go.mod h1:fexgUnVrZgw8scD49f6VSi0Ggj9GWYIrpedRthAwW/8=
github.com/charmbracelet/x/exp/golden v0.1.0 h1:qgUxGaHX4I8Fg077vD+54+qFmDWrgO19lTCQLblHWko=
github.com/charmbracelet/x/exp/golden v0.1.0/go.mod h1:6fMpcW6iwN/kX+xJ52eqVWsDiBTe0UJD24JLoHFe+P0=
github.com/charmbracelet/x/exp/ordered v0.1.0 h1:55/qLwjIh0gL0Vni+QAWk7T/qRVP6sBf+2agPBgnOFE=
github.com/charmbracelet/x/exp/ordered v0.1.0/go.mod h1:5UHwmG+is5THxMyCJHNPCn2/ecI07aKNrW+LcResjJ8=
github.com/charmbracelet/x/exp/strings v0.1.0 h1:i69S2XI7uG1u4NLGeJPSYU++Nmjvpo9nwd6aoEm7gkA=
github.com/charmbracelet/x/exp/strings v0.1.0/go.mod h1:/ehtMPNh9K4odGFkqYJKpIYyePhdp1hLBRvyY4bWkH8=
github.com/charmbracelet/x/term v0.2.2 h1:xVRT/S2ZcKdhhOuSP4t5cLi5o+JxklsoEObBSgfgZRk=
github.com/charmbracelet/x/term v0.2.2/go.mod h1:kF8CY5RddLWrsgVwpw4kAa6TESp6EB5y3uxGLeCqzAI=
github.com/charmbracelet/x/termios v0.1.1 h1:o3Q2bT8eqzGnGPOYheoYS8eEleT5ZVNYNy8JawjaNZY=
github.com/charmbracelet/x/termios v0.1.1/go.mod h1:rB7fnv1TgOPOyyKRJ9o+AsTU/vK5WHJ2ivHeut/Pcwo=
github.com/charmbracelet/x/windows v0.2.2 h1:IofanmuvaxnKHuV04sC0eBy/smG6kIKrWG2/jYn2GuM=
github.com/charmbracelet/x/windows v0.2.2/go.mod h1:/8XtdKZzedat74NQFn0NGlGL4soHB0YQZrETF96h75k=
github.com/charmbracelet/x/xpty v0.1.4 h1:4jaW7u+8AHQMxesiVc+zUMsspu7GyDwtJO+gy/tFtW4=
github.com/charmbracelet/x/xpty v0.1.4/go.mod h1:7t8P7BpPiolHJ1pLzz7/4ujDbD+sUxI9yA3CBOLOIcU=
github.com/clipperhouse/displaywidth v0.11.0 h1:lBc6kY44VFw+TDx4I8opi/EtL9m20WSEFgwIwO+UVM8=
@@ -43,8 +45,6 @@ github.com/creack/pty v1.1.24 h1:bJrF4RRfyJnbTJqzRLHzcGaZK1NeM5kTC9jGgovnR1s=
github.com/creack/pty v1.1.24/go.mod h1:08sCNb52WyoAwi2QDyzUCTgcvVFhUzewun7wtTfvcwE=
github.com/dustin/go-humanize v1.1.0 h1:dbKTrvD0klcbBV/h4AWJdMuZogJACoMlvWIWZ5b2xWg=
github.com/dustin/go-humanize v1.1.0/go.mod h1:hc1CvRkJMsgxqjmjMQF3QNRAZBwY8AXBAzKYoSX9sFI=
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6baUTXGLOoWe4PQhGxaX0KpnayAqC48p4=
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f/go.mod h1:vw97MGsxSvLiUE2X8qFplwetxpGLQrlU1Q9AUEIzCaM=
github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8=
github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0=
github.com/fsnotify/fsnotify v1.10.1 h1:b0/UzAf9yR5rhf3RPm9gf3ehBPpf0oZKIjtpKrx59Ho=
@@ -63,20 +63,12 @@ github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0
github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
github.com/lucasb-eyer/go-colorful v1.4.1 h1:1EO+WB73+EH8EVbzlrG3KLAfEypQWVHIBqlTf+2hNss=
github.com/lucasb-eyer/go-colorful v1.4.1/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
github.com/mattn/go-isatty v0.0.24 h1:tGZZoVgT/KiqK1c8ocVLeDS8BSWMRd47J3Lbz7vsReI=
github.com/mattn/go-isatty v0.0.24/go.mod h1:nMCL3Zebbrt45jsMDgnfIwz6ydEQApk5oEI3HqDio6A=
github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4=
github.com/mattn/go-localereader v0.0.1/go.mod h1:8fBrzywKY7BI3czFoHkuzRoWE9C+EiG4R1k4Cjx5p88=
github.com/mattn/go-runewidth v0.0.31 h1:1oCV4ReTlosDBc6rYRw5cL8S/4y8iv5oRl4SJ5IBgwo=
github.com/mattn/go-runewidth v0.0.31/go.mod h1:3qAiGCV4Koz/yuveO58qUefmUTRm8r0IGEXZ9jeHp/8=
github.com/mitchellh/hashstructure/v2 v2.0.2 h1:vGKWl0YJqUNxE8d+h8f6NJLcCJrgbhC4NcD46KavDd4=
github.com/mitchellh/hashstructure/v2 v2.0.2/go.mod h1:MG3aRVU/N29oo/V/IhBX8GR/zz4kQkprJgF2EVszyDE=
github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 h1:ZK8zHtRHOkbHy6Mmr5D264iyp3TiX5OmNcI5cIARiQI=
github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6/go.mod h1:CJlz5H+gyd6CUWT45Oy4q24RdLyn7Md9Vj2/ldJBSIo=
github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA=
github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo=
github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc=
github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk=
github.com/pelletier/go-toml/v2 v2.4.3 h1:GTRvJQutkOSftxIFD5xw9aepkYNuPWmVJpffdDPYVpY=
github.com/pelletier/go-toml/v2 v2.4.3/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
@@ -108,7 +100,8 @@ github.com/xo/terminfo v1.2.0/go.mod h1:lGzkSo8Fe7IRh/w+Gqz7n5mDog4FVXCj3gy/DYTB
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
go.yaml.in/yaml/v3 v3.0.5 h1:N6y/pJk8buWs9NY5ERU2HSMfm+IuD/OtfdAnq6kESPw=
go.yaml.in/yaml/v3 v3.0.5/go.mod h1:HVTZu1O7/Vkt2N+BFy8Zza+lnLsABggaTM2ZpNIGuKg=
golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sync v0.24.0 h1:iqiDrGoDgyuvAKrhLQthUEzU/R378N78gXbBjxed7oA=
golang.org/x/sync v0.24.0/go.mod h1:sUUOizhqBxiL6pEWpqNLUiaJn1ShEbZ6BBqskPbjZm0=
golang.org/x/sys v0.49.0 h1:XbzkgYJHdqh/8m2Uu0W/dQv8nktxx4BFHp1M0gROTXA=
golang.org/x/sys v0.49.0/go.mod h1:hNLxWAXmnKAxqDtdwIYC4bM9oQPEecfsnNMuSxOs3og=
golang.org/x/text v0.43.0 h1:1QivrlhwAsnMOcqgOdl9my7s9OyZl8O5/UGUTJVXoWc=
+106 -16
View File
@@ -2,13 +2,17 @@ package cache
import (
"encoding/json"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/storage"
"fmt"
"os"
"path/filepath"
"sort"
"strings"
"sync"
"time"
"golang.org/x/sys/unix"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/storage"
)
type Entry struct {
@@ -20,8 +24,18 @@ type Entry struct {
LastUsed time.Time `json:"last_used,omitempty"`
}
type changeKind uint8
const (
upsertChange changeKind = iota
deleteChange
usageChange
)
type Cache struct {
mu sync.RWMutex
dirty map[string]changeKind
cleared bool
entries map[string]Entry
path string
ttl time.Duration
@@ -39,6 +53,7 @@ func New(path string, ttlSeconds int) *Cache {
}
return &Cache{
entries: make(map[string]Entry),
dirty: make(map[string]changeKind),
path: path,
ttl: time.Duration(ttlSeconds) * time.Second,
refreshStamp: stamp,
@@ -94,6 +109,8 @@ func (c *Cache) Load() error {
return err
}
c.dirty = make(map[string]changeKind)
c.cleared = false
c.entries = make(map[string]Entry, len(df.Entries))
for _, e := range df.Entries {
c.entries[e.Name] = e
@@ -101,23 +118,80 @@ func (c *Cache) Load() error {
return nil
}
// Save merges only local changes under a process-wide file lock. Atomic rename
// alone prevents torn JSON but cannot prevent lost updates from another process.
func (c *Cache) Save() error {
c.mu.RLock()
df := diskFormat{Entries: make([]Entry, 0, len(c.entries))}
for _, e := range c.entries {
df.Entries = append(df.Entries, e)
}
c.mu.RUnlock()
c.mu.Lock()
defer c.mu.Unlock()
if err := os.MkdirAll(filepath.Dir(c.path), 0o755); err != nil {
return err
}
lock, err := os.OpenFile(c.path+".lock", os.O_CREATE|os.O_RDWR, 0o600)
if err != nil {
return err
}
defer lock.Close()
if err := unix.Flock(int(lock.Fd()), unix.LOCK_EX); err != nil {
return err
}
defer unix.Flock(int(lock.Fd()), unix.LOCK_UN)
merged := make(map[string]Entry)
if !c.cleared {
data, err := os.ReadFile(c.path)
if err != nil && !os.IsNotExist(err) {
return err
}
if err == nil {
var df diskFormat
if err := json.Unmarshal(data, &df); err != nil {
return err
}
for _, e := range df.Entries {
merged[e.Name] = e
}
}
}
for name, change := range c.dirty {
if change == deleteChange {
delete(merged, name)
continue
}
e := c.entries[name]
old, exists := merged[name]
if change == usageChange && !exists {
// A connection finishing after a refresh or clear must not
// restore an entry that the other process removed.
continue
}
if exists {
lastUsed := e.LastUsed
if change == usageChange || old.CachedAt.After(e.CachedAt) {
e = old
}
if old.LastUsed.After(lastUsed) {
lastUsed = old.LastUsed
}
e.LastUsed = lastUsed
}
merged[name] = e
}
df := diskFormat{Entries: make([]Entry, 0, len(merged))}
for _, e := range merged {
df.Entries = append(df.Entries, e)
}
sort.Slice(df.Entries, func(i, j int) bool { return df.Entries[i].Name < df.Entries[j].Name })
data, err := json.MarshalIndent(df, "", " ")
if err != nil {
return err
}
return storage.WriteFile(c.path, data, 0o600)
if err := storage.WriteFile(c.path, data, 0o600); err != nil {
return err
}
c.entries = merged
c.dirty = make(map[string]changeKind)
c.cleared = false
return nil
}
func (c *Cache) Upsert(e Entry) {
@@ -127,9 +201,18 @@ func (c *Cache) Upsert(e Entry) {
e.LastUsed = old.LastUsed
}
c.entries[e.Name] = e
c.dirty[e.Name] = upsertChange
c.mu.Unlock()
}
// Delete removes an entry when a refresh can no longer resolve it safely.
func (c *Cache) Delete(name string) {
c.mu.Lock()
defer c.mu.Unlock()
delete(c.entries, name)
c.dirty[name] = deleteChange
}
// MarkUsed records the current time as LastUsed for the named entry.
// It is a no-op if the entry does not exist.
func (c *Cache) MarkUsed(name string) {
@@ -138,6 +221,9 @@ func (c *Cache) MarkUsed(name string) {
if e, ok := c.entries[name]; ok {
e.LastUsed = time.Now()
c.entries[name] = e
if _, changed := c.dirty[name]; !changed {
c.dirty[name] = usageChange
}
}
}
@@ -172,26 +258,28 @@ func (c *Cache) Search(prefix string) []Entry {
prefix = strings.ToLower(prefix)
var out []Entry
for name, e := range c.entries {
if strings.HasPrefix(strings.ToLower(name), prefix) {
_, hostname, qualified := strings.Cut(strings.ToLower(name), "/")
if strings.HasPrefix(strings.ToLower(name), prefix) || (qualified && !strings.Contains(prefix, "/") && strings.HasPrefix(hostname, prefix)) {
out = append(out, e)
}
}
return out
}
// GetByShortcut scans all entries and returns the first whose normalized name matches
// the normalized shortcut. Returns (entry, found, fresh).
func (c *Cache) GetByShortcut(shortcut string, normalize func(string) string) (entry Entry, found bool, fresh bool) {
// GetByShortcut rejects collisions instead of choosing a random map entry.
func (c *Cache) GetByShortcut(shortcut string, normalize func(string) string) (entry Entry, found bool, fresh bool, err error) {
c.mu.RLock()
defer c.mu.RUnlock()
norm := normalize(shortcut)
for _, e := range c.entries {
if normalize(e.Name) == norm {
isFresh := c.ttl > 0 && time.Since(e.CachedAt) < c.ttl
return e, true, isFresh
if found {
return Entry{}, false, false, fmt.Errorf("ambiguous shortcut %q; use a full hostname", shortcut)
}
entry, found = e, true
}
}
return Entry{}, false, false
return entry, found, found && c.ttl > 0 && time.Since(entry.CachedAt) < c.ttl, nil
}
// Get returns an entry and reports whether it is still within the TTL.
@@ -212,6 +300,8 @@ func (c *Cache) Get(name string) (entry Entry, fresh bool) {
func (c *Cache) Clear() {
c.mu.Lock()
c.entries = make(map[string]Entry)
c.dirty = make(map[string]changeKind)
c.cleared = true
c.mu.Unlock()
}
+17 -5
View File
@@ -314,7 +314,7 @@ func TestGetByShortcut_MatchFresh(t *testing.T) {
return s
}
e, found, fresh := c.GetByShortcut("web01", normalize)
e, found, fresh, _ := c.GetByShortcut("web01", normalize)
if !found {
t.Fatal("expected entry to be found")
}
@@ -340,7 +340,7 @@ func TestGetByShortcut_MatchStale(t *testing.T) {
return s
}
_, found, fresh := c.GetByShortcut("web01", normalize)
_, found, fresh, _ := c.GetByShortcut("web01", normalize)
if !found {
t.Fatal("expected entry to be found even when stale")
}
@@ -353,7 +353,7 @@ func TestGetByShortcut_NotFound(t *testing.T) {
c := New("", 3600)
c.Upsert(Entry{Name: "db01.example.com", IP: "10.0.0.2", Kind: "device"})
_, found, _ := c.GetByShortcut("web01", func(s string) string { return s })
_, found, _, _ := c.GetByShortcut("web01", func(s string) string { return s })
if found {
t.Error("should not find an entry that does not match the shortcut")
}
@@ -361,7 +361,7 @@ func TestGetByShortcut_NotFound(t *testing.T) {
func TestGetByShortcut_EmptyCache(t *testing.T) {
c := New("", 3600)
_, found, _ := c.GetByShortcut("web01", func(s string) string { return s })
_, found, _, _ := c.GetByShortcut("web01", func(s string) string { return s })
if found {
t.Error("empty cache should return found=false")
}
@@ -381,7 +381,7 @@ func TestGetByShortcut_MultiDomain(t *testing.T) {
return s
}
e, found, _ := c.GetByShortcut("web01", normalize)
e, found, _, _ := c.GetByShortcut("web01", normalize)
if !found {
t.Fatal("should match entry with second configured domain")
}
@@ -483,3 +483,15 @@ func TestUpsertPreservesUsageHistory(t *testing.T) {
t.Fatalf("history lost: %+v", after)
}
}
func TestSearchMatchesHostnamesAcrossQualifiedSources(t *testing.T) {
c := New("", 3600)
c.Upsert(Entry{Name: "office/web01", IP: "10.0.0.1"})
c.Upsert(Entry{Name: "lab/web01", IP: "10.0.0.2"})
c.Upsert(Entry{Name: "lab/db01", IP: "10.0.0.3"})
for query, want := range map[string]int{"web": 2, "office/web": 1, "lab/": 2, "WEB": 2} {
if got := len(c.Search(query)); got != want {
t.Errorf("Search(%q)=%d, want %d", query, got, want)
}
}
}
+182
View File
@@ -0,0 +1,182 @@
package cache
import (
"fmt"
"os"
"os/exec"
"path/filepath"
"strings"
"testing"
"time"
)
func TestShortcutRejectsAmbiguousTargets(t *testing.T) {
c := New("", 3600)
c.Upsert(Entry{Name: "web.prod.example", IP: "10.0.0.1"})
c.Upsert(Entry{Name: "web.dev.example", IP: "10.0.0.2"})
normalize := func(s string) string { return strings.SplitN(s, ".", 2)[0] }
for range 100 {
entry, found, fresh, err := c.GetByShortcut("web", normalize)
if err == nil || found || fresh || entry.Name != "" {
t.Fatalf("ambiguous shortcut returned target: %+v, %v, %v, %v", entry, found, fresh, err)
}
}
}
func TestSaveMergesIndependentlyLoadedCaches(t *testing.T) {
path := filepath.Join(t.TempDir(), "hosts.json")
a, b := New(path, 3600), New(path, 3600)
for _, c := range []*Cache{a, b} {
if err := c.Load(); err != nil {
t.Fatal(err)
}
}
a.Upsert(Entry{Name: "a", IP: "10.0.0.1"})
b.Upsert(Entry{Name: "b", IP: "10.0.0.2"})
for _, c := range []*Cache{a, b} {
if err := c.Save(); err != nil {
t.Fatal(err)
}
}
if err := a.Load(); err != nil {
t.Fatal(err)
}
if len(a.All()) != 2 {
t.Fatalf("lost an update: %+v", a.All())
}
// Saving a stale usage update must retain newer IPs and both usage times.
if err := b.Load(); err != nil {
t.Fatal(err)
}
b.MarkUsed("a")
used, _ := b.Get("a")
a.Upsert(Entry{Name: "a", IP: "10.0.0.3"})
if err := a.Save(); err != nil {
t.Fatal(err)
}
if err := b.Save(); err != nil {
t.Fatal(err)
}
got, _ := b.Get("a")
if got.IP != "10.0.0.3" || !got.LastUsed.Equal(used.LastUsed) {
t.Fatalf("lost refreshed IP or usage: %+v", got)
}
b.Delete("a")
if err := b.Save(); err != nil {
t.Fatal(err)
}
if err := a.Load(); err != nil {
t.Fatal(err)
}
if got, _ := a.Get("a"); got.Name != "" {
t.Fatalf("deleted entry survived: %+v", got)
}
a.Clear()
if err := a.Save(); err != nil {
t.Fatal(err)
}
if err := b.Load(); err != nil {
t.Fatal(err)
}
if len(b.All()) != 0 {
t.Fatal("clear merged old entries back in")
}
}
func TestSaveAcrossProcesses(t *testing.T) {
if path := os.Getenv("NETSSH_TEST_CACHE_WRITER_PATH"); path != "" {
c := New(path, 3600)
if err := c.Load(); err != nil {
t.Fatal(err)
}
c.Upsert(Entry{Name: os.Getenv("NETSSH_TEST_CACHE_WRITER_NAME"), IP: "10.0.0.1"})
if err := c.Save(); err != nil {
t.Fatal(err)
}
return
}
path := filepath.Join(t.TempDir(), "hosts.json")
const writers = 8
cmds := make([]*exec.Cmd, writers)
for i := range cmds {
cmd := exec.Command(os.Args[0], "-test.run=^TestSaveAcrossProcesses$")
cmd.Env = append(os.Environ(), "NETSSH_TEST_CACHE_WRITER_PATH="+path, fmt.Sprintf("NETSSH_TEST_CACHE_WRITER_NAME=host-%d", i))
cmd.Stdout, cmd.Stderr = os.Stdout, os.Stderr
if err := cmd.Start(); err != nil {
t.Fatal(err)
}
cmds[i] = cmd
}
for _, cmd := range cmds {
if err := cmd.Wait(); err != nil {
t.Error(err)
}
}
c := New(path, 3600)
if err := c.Load(); err != nil {
t.Fatal(err)
}
if len(c.All()) != writers {
t.Fatalf("lost concurrent updates: got %d, want %d", len(c.All()), writers)
}
}
func TestSavePreservesNewerUsageFromDisk(t *testing.T) {
path := filepath.Join(t.TempDir(), "hosts.json")
a := New(path, 3600)
a.Upsert(Entry{Name: "web", IP: "10.0.0.1", LastUsed: time.Now()})
if err := a.Save(); err != nil {
t.Fatal(err)
}
b := New(path, 3600)
if err := b.Load(); err != nil {
t.Fatal(err)
}
a.MarkUsed("web")
used, _ := a.Get("web")
if err := a.Save(); err != nil {
t.Fatal(err)
}
b.Upsert(Entry{Name: "web", IP: "10.0.0.2"})
if err := b.Save(); err != nil {
t.Fatal(err)
}
got, _ := b.Get("web")
if got.IP != "10.0.0.2" || !got.LastUsed.Equal(used.LastUsed) {
t.Fatalf("lost data: %+v", got)
}
}
func TestUsageSaveDoesNotRestoreRemovedHosts(t *testing.T) {
for _, clear := range []bool{false, true} {
t.Run(fmt.Sprintf("clear=%v", clear), func(t *testing.T) {
path := filepath.Join(t.TempDir(), "hosts.json")
a := New(path, 3600)
a.Upsert(Entry{Name: "web", IP: "10.0.0.1"})
if err := a.Save(); err != nil {
t.Fatal(err)
}
b := New(path, 3600)
if err := b.Load(); err != nil {
t.Fatal(err)
}
b.MarkUsed("web")
if clear {
a.Clear()
} else {
a.Delete("web")
}
if err := a.Save(); err != nil {
t.Fatal(err)
}
if err := b.Save(); err != nil {
t.Fatal(err)
}
if len(b.All()) != 0 {
t.Fatalf("usage update restored removed entry: %+v", b.All())
}
})
}
}
+21
View File
@@ -13,6 +13,7 @@ import (
type Config struct {
Shell ShellConfig `mapstructure:"shell"`
NetBox NetBoxConfig `mapstructure:"netbox"`
NetBoxes []NetBoxConfig `mapstructure:"netboxes"`
Resolver ResolverConfig `mapstructure:"resolver"`
Cache CacheConfig `mapstructure:"cache"`
SSH SSHConfig `mapstructure:"ssh"`
@@ -24,6 +25,7 @@ type ShellConfig struct {
}
type NetBoxConfig struct {
Name string `mapstructure:"name"`
URL string `mapstructure:"url"`
Token string `mapstructure:"token"`
TokenVersion int `mapstructure:"token_version"`
@@ -93,6 +95,11 @@ func Load() (*Config, error) {
if err := v.Unmarshal(&cfg); err != nil {
return nil, fmt.Errorf("parsing config: %w", err)
}
// Legacy environment variables must not invent an additional unnamed source
// when a file explicitly configures named instances (including wizard migration).
if len(cfg.NetBoxes) > 0 && !v.InConfig("netbox.url") {
cfg.NetBox = NetBoxConfig{}
}
if err := ValidateCommandAlias(cfg.Shell.Alias); err != nil {
return nil, err
@@ -106,6 +113,20 @@ func Load() (*Config, error) {
}
}
if err := cfg.ValidateNetBoxes(); err != nil {
return nil, err
}
for i := range cfg.NetBoxes {
source := &cfg.NetBoxes[i]
source.Name = strings.ToLower(source.Name)
if source.TokenVersion == 0 && source.Token != "" {
source.TokenVersion = 1
if strings.HasPrefix(source.Token, "nbt_") {
source.TokenVersion = 2
}
}
}
if cfg.Cache.Path == "" {
cacheDir, err := os.UserCacheDir()
if err != nil {
+56
View File
@@ -0,0 +1,56 @@
package config
import (
"crypto/sha256"
"fmt"
"net/url"
"path/filepath"
"regexp"
"sort"
"strings"
)
var instanceName = regexp.MustCompile(`^[a-zA-Z0-9][a-zA-Z0-9_-]*$`)
// ValidateNetBoxes keeps source names usable as instance/hostname selectors.
func (c *Config) ValidateNetBoxes() error {
if len(c.NetBoxes) > 0 && c.NetBox.URL != "" {
return fmt.Errorf("configure either netbox or netboxes, not both")
}
seen := make(map[string]bool)
for _, source := range c.NetBoxes {
if !instanceName.MatchString(source.Name) {
return fmt.Errorf("netboxes.name %q must contain only letters, digits, underscores, or hyphens", source.Name)
}
name := strings.ToLower(source.Name)
if seen[name] {
return fmt.Errorf("duplicate NetBox instance name %q", source.Name)
}
seen[name] = true
u, err := url.Parse(source.URL)
if err != nil || (u.Scheme != "http" && u.Scheme != "https") || u.Host == "" || u.RawQuery != "" || u.Fragment != "" {
return fmt.Errorf("NetBox %q requires an HTTP(S) URL without query or fragment", source.Name)
}
if source.TokenVersion < 0 || source.TokenVersion > 2 {
return fmt.Errorf("NetBox %q: token_version must be 0, 1, or 2", source.Name)
}
}
return nil
}
func (c *Config) HasNetBox() bool { return c.NetBox.URL != "" || len(c.NetBoxes) > 0 }
// CachePath isolates named sources from legacy caches and from changed endpoints.
// Rotating a token or reordering the sources does not discard usage history.
func (c *Config) CachePath() string {
if len(c.NetBoxes) == 0 {
return c.Cache.Path
}
var identities []string
for _, source := range c.NetBoxes {
identities = append(identities, strings.ToLower(source.Name)+"\x00"+strings.TrimRight(source.URL, "/"))
}
sort.Strings(identities)
sum := sha256.Sum256([]byte(strings.Join(identities, "\x00")))
return filepath.Join(filepath.Dir(c.Cache.Path), fmt.Sprintf("instances-%x", sum[:8]), filepath.Base(c.Cache.Path))
}
+79
View File
@@ -0,0 +1,79 @@
package config
import (
"os"
"path/filepath"
"testing"
)
func TestLoadNamedNetBoxes(t *testing.T) {
dir := t.TempDir()
t.Setenv("XDG_CONFIG_HOME", dir)
t.Setenv("NETSSH_NETBOX_URL", "https://legacy-env.example")
t.Setenv("NETSSH_NETBOX_TOKEN", "legacy-env-token")
data := `netboxes:
- name: Office
url: https://office.example/netbox
token: nbt_office
- name: lab
url: https://lab.example
token: legacy-token
cache:
path: /tmp/netssh-tests/hosts.json
`
if err := os.WriteFile(filepath.Join(dir, "netssh.yaml"), []byte(data), 0o600); err != nil {
t.Fatal(err)
}
cfg, err := Load()
if err != nil {
t.Fatal(err)
}
if !cfg.HasNetBox() || len(cfg.NetBoxes) != 2 || cfg.NetBoxes[0].Name != "office" || cfg.NetBoxes[0].TokenVersion != 2 || cfg.NetBoxes[1].TokenVersion != 1 {
t.Fatalf("bad instances: %+v", cfg.NetBoxes)
}
if cfg.NetBox.URL != "" {
t.Fatal("legacy environment variables added an unnamed instance")
}
first := cfg.CachePath()
if first == cfg.Cache.Path {
t.Fatal("named sources reuse legacy cache")
}
cfg.NetBoxes[0], cfg.NetBoxes[1] = cfg.NetBoxes[1], cfg.NetBoxes[0]
cfg.NetBoxes[0].Token = "rotated"
if cfg.CachePath() != first {
t.Fatal("reordering/rotating credentials discarded cache")
}
cfg.NetBoxes[0].URL = "https://other.example"
if cfg.CachePath() == first {
t.Fatal("changed endpoint reuses old hosts")
}
}
func TestValidateNetBoxes(t *testing.T) {
good := NetBoxConfig{Name: "office", URL: "https://office.example"}
for _, tc := range []struct {
name string
cfg Config
}{
{"duplicate", Config{NetBoxes: []NetBoxConfig{good, {Name: "OFFICE", URL: "https://other.example"}}}},
{"empty name", Config{NetBoxes: []NetBoxConfig{{URL: "https://office.example"}}}},
{"invalid name", Config{NetBoxes: []NetBoxConfig{{Name: "a/b", URL: "https://office.example"}}}},
{"missing URL", Config{NetBoxes: []NetBoxConfig{{Name: "office"}}}},
{"invalid URL", Config{NetBoxes: []NetBoxConfig{{Name: "office", URL: "file:///tmp/netbox"}}}},
{"conflicting config", Config{NetBox: good, NetBoxes: []NetBoxConfig{good}}},
{"invalid token version", Config{NetBoxes: []NetBoxConfig{{Name: "office", URL: good.URL, TokenVersion: 3}}}},
} {
t.Run(tc.name, func(t *testing.T) {
if err := tc.cfg.ValidateNetBoxes(); err == nil {
t.Fatal("invalid configuration accepted")
}
})
}
legacy := Config{NetBox: good, Cache: CacheConfig{Path: "hosts.json"}}
if err := legacy.ValidateNetBoxes(); err != nil {
t.Fatal(err)
}
if !legacy.HasNetBox() || legacy.CachePath() != "hosts.json" {
t.Fatal("legacy behavior changed")
}
}
+15
View File
@@ -227,3 +227,18 @@ func TestCommandAliasGenerationAndCollision(t *testing.T) {
t.Fatal(got)
}
}
func TestAliasesIncludeInstanceName(t *testing.T) {
cfg := config.Config{Shortcuts: config.ShortcutsConfig{Domains: []string{".example.com"}}}
entries := hook.BuildAliasEntries([]cache.Entry{{Name: "office/web01.example.com"}, {Name: "lab/web01.example.com"}}, cfg)
if len(entries) != 2 {
t.Fatalf("missing qualified aliases: %+v", entries)
}
got := map[string]string{}
for _, entry := range entries {
got[entry.Name] = entry.Host
}
if got["office_web01"] != "office/web01.example.com" || got["lab_web01"] != "lab/web01.example.com" {
t.Fatalf("alias lost source: %+v", entries)
}
}
+42 -1
View File
@@ -15,6 +15,7 @@ import (
)
type Client struct {
sources map[string]*Client
baseURL string
token string
tokenVersion int
@@ -38,6 +39,9 @@ func NewClient(baseURL, token string, tokenVersion int) *Client {
// Search queries up to 50 devices and VMs in parallel and merges the results.
// Use SearchOptions to restrict by kind or tag.
func (c *Client) Search(ctx context.Context, query string, opts SearchOptions) ([]HostEntry, error) {
if c.sources != nil {
return c.searchSources(ctx, query, opts, false)
}
if opts.Kind != "" && opts.Kind != "device" && opts.Kind != "vm" {
return nil, fmt.Errorf("invalid host kind %q", opts.Kind)
}
@@ -95,6 +99,9 @@ func (c *Client) Search(ctx context.Context, query string, opts SearchOptions) (
// SearchAll paginates through all matching devices and VMs, fetching every page.
// Intended for cache refresh; use Search for interactive queries.
func (c *Client) SearchAll(ctx context.Context, query string, opts SearchOptions) ([]HostEntry, error) {
if c.sources != nil {
return c.searchSources(ctx, query, opts, true)
}
if opts.Kind != "" && opts.Kind != "device" && opts.Kind != "vm" {
return nil, fmt.Errorf("invalid host kind %q", opts.Kind)
}
@@ -146,6 +153,13 @@ func (c *Client) SearchAll(ctx context.Context, query string, opts SearchOptions
// GetIPs returns all IP addresses assigned to a host, used by resolver strategies
// that need more than just the primary IP.
func (c *Client) GetIPs(ctx context.Context, entry HostEntry) ([]string, error) {
if c.sources != nil {
source, host, err := c.sourceForHost(entry)
if err != nil {
return nil, err
}
return source.GetIPs(ctx, host)
}
var apiURL string
switch entry.Kind {
case "device":
@@ -170,6 +184,9 @@ func (c *Client) GetIPs(ctx context.Context, entry HostEntry) ([]string, error)
// GetIPsWithFilter calls /api/ipam/ip-addresses/ with arbitrary filter query parameters.
func (c *Client) GetIPsWithFilter(ctx context.Context, filterParams string) ([]string, error) {
if c.sources != nil {
return nil, fmt.Errorf("IP filters require a host instance; use GetIPsWithFilterForHost")
}
apiURL := fmt.Sprintf("%s/api/ipam/ip-addresses/?%s&limit=100", c.baseURL, filterParams)
var resp netboxIPListResponse
if err := c.get(ctx, apiURL, &resp); err != nil {
@@ -351,22 +368,32 @@ func stripPrefix(cidr string) string {
return cidr
}
// ErrHostNotFound distinguishes a missing exact match from API failures or ambiguity.
var ErrHostNotFound = errors.New("host not found")
// FindHost refuses ambiguous names so writes cannot target an arbitrary server.
func (c *Client) FindHost(ctx context.Context, name, kind string) (HostEntry, error) {
if kind != "" && kind != "device" && kind != "vm" {
return HostEntry{}, fmt.Errorf("invalid kind %q", kind)
}
entries, err := c.SearchAll(ctx, name, SearchOptions{Kind: kind})
_, hostname := SplitTarget(name)
if err != nil {
return HostEntry{}, err
}
var matches []HostEntry
for _, e := range entries {
if strings.EqualFold(e.Name, name) {
if strings.EqualFold(e.Name, hostname) {
matches = append(matches, e)
}
}
if len(matches) == 0 {
return HostEntry{}, fmt.Errorf("%w: %q", ErrHostNotFound, name)
}
if len(matches) != 1 {
if c.sources != nil {
return HostEntry{}, fmt.Errorf("host %q: found %d exact matches; use instance/hostname and --kind to select a unique host", name, len(matches))
}
return HostEntry{}, fmt.Errorf("host %q: found %d exact matches; use --kind or a unique hostname", name, len(matches))
}
return matches[0], nil
@@ -389,6 +416,13 @@ func (c *Client) hostURL(host HostEntry) (string, error) {
}
func (c *Client) GetComments(ctx context.Context, host HostEntry) (string, string, error) {
if c.sources != nil {
source, host, err := c.sourceForHost(host)
if err != nil {
return "", "", err
}
return source.GetComments(ctx, host)
}
u, err := c.hostURL(host)
if err != nil {
return "", "", err
@@ -401,6 +435,13 @@ func (c *Client) GetComments(ctx context.Context, host HostEntry) (string, strin
}
func (c *Client) SetComments(ctx context.Context, host HostEntry, comments, etag string) error {
if c.sources != nil {
source, host, err := c.sourceForHost(host)
if err != nil {
return err
}
return source.SetComments(ctx, host, comments, etag)
}
u, err := c.hostURL(host)
if err != nil {
return err
+19
View File
@@ -1,5 +1,7 @@
package netbox
import "strings"
// SearchOptions filters a Search or SearchAll query.
// Zero value means no filtering (return all kinds, no tag filter).
type SearchOptions struct {
@@ -9,6 +11,7 @@ type SearchOptions struct {
// HostEntry is a unified model for both devices and virtual machines from NetBox.
type HostEntry struct {
Source string // named NetBox instance; empty for the legacy single-instance config
ID int
Name string
Kind string // "device" | "vm"
@@ -58,3 +61,19 @@ type netboxIPListResponse struct {
} `json:"assigned_object"`
} `json:"results"`
}
// Target returns an unambiguous selector for cache, completion, and SSH.
func (h HostEntry) Target() string {
if h.Source == "" {
return h.Name
}
return h.Source + "/" + h.Name
}
// SplitTarget separates an optional instance prefix from a hostname.
func SplitTarget(target string) (source, name string) {
if source, name, ok := strings.Cut(target, "/"); ok {
return strings.ToLower(source), name
}
return "", target
}
+113
View File
@@ -0,0 +1,113 @@
package netbox
import (
"context"
"errors"
"fmt"
"sort"
"strings"
"sync"
)
// Source binds a name to its own API client and credentials.
type Source struct {
Name string
URL string
Token string
TokenVersion int
}
func NewMultiClient(sources []Source) *Client {
c := &Client{sources: make(map[string]*Client)}
for _, source := range sources {
c.sources[strings.ToLower(source.Name)] = NewClient(source.URL, source.Token, source.TokenVersion)
}
return c
}
func (c *Client) searchSources(ctx context.Context, query string, opts SearchOptions, all bool) ([]HostEntry, error) {
requested, query := SplitTarget(query)
if requested != "" {
if _, ok := c.sources[requested]; !ok {
return nil, fmt.Errorf("unknown NetBox instance %q", requested)
}
}
var mu sync.Mutex
var wg sync.WaitGroup
var entries []HostEntry
var errs []error
started := 0
for name, client := range c.sources {
if requested != "" && name != requested {
continue
}
started++
wg.Add(1)
go func(name string, client *Client) {
defer wg.Done()
var found []HostEntry
var err error
if all {
found, err = client.SearchAll(ctx, query, opts)
} else {
found, err = client.Search(ctx, query, opts)
}
mu.Lock()
defer mu.Unlock()
if err != nil {
errs = append(errs, fmt.Errorf("NetBox %s: %w", name, err))
return
}
for i := range found {
found[i].Source = name
}
entries = append(entries, found...)
}(name, client)
}
wg.Wait()
// Full lookups must see every source to rule out ambiguous hostnames.
if len(errs) > 0 && (all || len(errs) == started) {
return nil, errors.Join(errs...)
}
sort.Slice(entries, func(i, j int) bool { return entries[i].Target() < entries[j].Target() })
return entries, errors.Join(errs...)
}
func (c *Client) sourceForHost(host HostEntry) (*Client, HostEntry, error) {
prefix, name := SplitTarget(host.Name)
if prefix != "" {
if host.Source != "" && !strings.EqualFold(prefix, host.Source) {
return nil, host, fmt.Errorf("conflicting NetBox instance for %q", host.Name)
}
host.Source, host.Name = prefix, name
}
if c.sources == nil {
return c, host, nil
}
source, ok := c.sources[strings.ToLower(host.Source)]
if !ok {
return nil, host, fmt.Errorf("specify a configured NetBox instance as instance/hostname (got %q)", host.Target())
}
host.Source = strings.ToLower(host.Source)
return source, host, nil
}
// HostScope identifies a local note by its original NetBox URL and canonical
// hostname, so renaming an instance does not move or mix its notes.
func (c *Client) HostScope(host HostEntry) (HostEntry, string, error) {
source, host, err := c.sourceForHost(host)
if err != nil {
return host, "", err
}
return host, source.baseURL, nil
}
func (c *Client) GetIPsWithFilterForHost(ctx context.Context, host HostEntry, filters string) ([]string, error) {
source, _, err := c.sourceForHost(host)
if err != nil {
return nil, err
}
return source.GetIPsWithFilter(ctx, filters)
}
func (c *Client) MultipleSources() bool { return c.sources != nil }
+192
View File
@@ -0,0 +1,192 @@
package netbox
import (
"context"
"encoding/json"
"fmt"
"net/http"
"net/http/httptest"
"strings"
"sync"
"testing"
"time"
)
func sourceTestServer(t *testing.T, token, ip, comment string) *httptest.Server {
t.Helper()
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if got := r.Header.Get("Authorization"); got != "Token "+token {
t.Errorf("credentials crossed sources: %q, want %q", got, token)
http.Error(w, "bad token", 401)
return
}
w.Header().Set("Content-Type", "application/json")
switch r.URL.Path {
case "/api/dcim/devices/":
json.NewEncoder(w).Encode(deviceListResponse(netboxDevice{ID: 1, Name: "web", PrimaryIP4: &netboxIP{Address: ip + "/24"}}))
case "/api/virtualization/virtual-machines/":
json.NewEncoder(w).Encode(vmListResponse())
case "/api/ipam/ip-addresses/":
if r.URL.Query().Get("device_id") != "1" {
t.Errorf("wrong host ID: %s", r.URL.RawQuery)
}
json.NewEncoder(w).Encode(ipListResponse(ip + "/24"))
case "/api/dcim/devices/1/":
if r.Method == http.MethodPatch {
var data map[string]string
if err := json.NewDecoder(r.Body).Decode(&data); err != nil {
t.Error(err)
}
if data["comments"] != comment+" updated" {
t.Errorf("comment write crossed sources: %v", data)
}
}
json.NewEncoder(w).Encode(map[string]string{"comments": comment})
default:
http.NotFound(w, r)
}
}))
t.Cleanup(srv.Close)
return srv
}
func TestMultiSourceSearchAndRouting(t *testing.T) {
office := sourceTestServer(t, "office-token", "10.0.0.1", "office note")
lab := sourceTestServer(t, "lab-token", "10.0.0.2", "lab note")
c := NewMultiClient([]Source{{Name: "office", URL: office.URL, Token: "office-token"}, {Name: "lab", URL: lab.URL, Token: "lab-token"}})
ctx := context.Background()
entries, err := c.Search(ctx, "web", SearchOptions{})
if err != nil || len(entries) != 2 {
t.Fatalf("combined search: %+v, %v", entries, err)
}
if entries[0].Target() != "lab/web" || entries[1].Target() != "office/web" {
t.Fatalf("source lost: %+v", entries)
}
if _, err := c.FindHost(ctx, "web", ""); err == nil {
t.Fatal("ambiguous unqualified hostname accepted")
}
for _, tc := range []struct{ name, ip, note string }{{"office", "10.0.0.1", "office note"}, {"lab", "10.0.0.2", "lab note"}} {
t.Run(tc.name, func(t *testing.T) {
host, err := c.FindHost(ctx, tc.name+"/web", "")
if err != nil {
t.Fatal(err)
}
if host.Source != tc.name || host.Name != "web" || host.ID != 1 {
t.Fatalf("wrong host identity: %+v", host)
}
ips, err := c.GetIPs(ctx, host)
if err != nil || len(ips) != 1 || ips[0] != tc.ip {
t.Fatalf("wrong IP source: %v, %v", ips, err)
}
ips, err = c.GetIPsWithFilterForHost(ctx, host, "device_id=1&interface_name=mgmt0")
if err != nil || len(ips) != 1 || ips[0] != tc.ip {
t.Fatalf("wrong interface source: %v, %v", ips, err)
}
text, _, err := c.GetComments(ctx, host)
if err != nil || text != tc.note {
t.Fatalf("wrong comment source: %q, %v", text, err)
}
// TUI cache items carry a qualified name rather than a separate source.
qualified := HostEntry{Name: tc.name + "/web", ID: 1, Kind: "device"}
if err := c.SetComments(ctx, qualified, tc.note+" updated", ""); err != nil {
t.Fatal(err)
}
})
}
if _, err := c.Search(ctx, "missing/web", SearchOptions{}); err == nil {
t.Fatal("unknown source accepted")
}
if _, _, err := c.HostScope(HostEntry{Name: "web", Kind: "device"}); err == nil {
t.Fatal("unqualified note namespace accepted")
}
if _, err := c.GetIPsWithFilter(ctx, "device_id=1"); err == nil {
t.Fatal("IP filter without instance accepted")
}
}
func TestMultiSourceSearchRunsConcurrently(t *testing.T) {
var wg sync.WaitGroup
wg.Add(2)
makeServer := func() *httptest.Server {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
wg.Done()
both := make(chan struct{})
go func() { wg.Wait(); close(both) }()
select {
case <-both:
fmt.Fprint(w, `{"count":0,"results":[]}`)
case <-r.Context().Done():
}
}))
t.Cleanup(srv.Close)
return srv
}
a, b := makeServer(), makeServer()
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()
c := NewMultiClient([]Source{{Name: "a", URL: a.URL}, {Name: "b", URL: b.URL}})
if _, err := c.Search(ctx, "web", SearchOptions{Kind: "device"}); err != nil {
t.Fatalf("sources did not run concurrently: %v", err)
}
}
func TestMultiSourcePartialFailure(t *testing.T) {
good := sourceTestServer(t, "good-token", "10.0.0.1", "note")
failed := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { http.Error(w, "unavailable", 503) }))
defer failed.Close()
c := NewMultiClient([]Source{{Name: "good", URL: good.URL, Token: "good-token"}, {Name: "offline", URL: failed.URL}})
ctx := context.Background()
entries, err := c.Search(ctx, "web", SearchOptions{})
if len(entries) != 1 || err == nil || !strings.Contains(err.Error(), "offline") {
t.Fatalf("partial search lost results or warning: %+v, %v", entries, err)
}
if _, err := c.SearchAll(ctx, "web", SearchOptions{}); err == nil {
t.Fatal("incomplete full search succeeded")
}
if _, err := c.FindHost(ctx, "web", ""); err == nil {
t.Fatal("incomplete search claimed unique host")
}
if host, err := c.FindHost(ctx, "good/web", ""); err != nil || host.Source != "good" {
t.Fatalf("qualified lookup blocked by unrelated outage: %+v, %v", host, err)
}
}
func TestMultiSourceKeepsIndependentDeviceAndVMInventories(t *testing.T) {
office := newTestServer(t, map[string]any{
"/api/dcim/devices/": deviceListResponse(netboxDevice{ID: 1, Name: "office-router", PrimaryIP4: &netboxIP{Address: "10.1.0.1/24"}}),
"/api/virtualization/virtual-machines/": vmListResponse(netboxVM{ID: 2, Name: "office-vm", PrimaryIP4: &netboxIP{Address: "10.1.0.2/24"}}),
})
defer office.Close()
lab := newTestServer(t, map[string]any{
"/api/dcim/devices/": deviceListResponse(netboxDevice{ID: 1, Name: "lab-switch", PrimaryIP4: &netboxIP{Address: "10.2.0.1/24"}}),
"/api/virtualization/virtual-machines/": vmListResponse(netboxVM{ID: 2, Name: "lab-vm", PrimaryIP4: &netboxIP{Address: "10.2.0.2/24"}}),
})
defer lab.Close()
client := NewMultiClient([]Source{{Name: "office", URL: office.URL}, {Name: "lab", URL: lab.URL}})
entries, err := client.SearchAll(context.Background(), "", SearchOptions{})
if err != nil {
t.Fatal(err)
}
want := map[string]string{"office/office-router": "device", "office/office-vm": "vm", "lab/lab-switch": "device", "lab/lab-vm": "vm"}
if len(entries) != len(want) {
t.Fatalf("independent inventories missing: %+v", entries)
}
for _, entry := range entries {
if want[entry.Target()] != entry.Kind {
t.Fatalf("inventory crossed source or kind: %+v", entry)
}
}
vms, err := client.Search(context.Background(), "", SearchOptions{Kind: "vm"})
if err != nil || len(vms) != 2 {
t.Fatalf("VM filter across instances: %+v, %v", vms, err)
}
for _, host := range vms {
if host.Kind != "vm" {
t.Fatalf("device leaked into VM filter: %+v", host)
}
}
host, err := client.FindHost(context.Background(), "lab/lab-vm", "vm")
if err != nil || host.Source != "lab" || host.ID != 2 || host.PrimaryIP4 != "10.2.0.2" {
t.Fatalf("wrong VM selected: %+v, %v", host, err)
}
}
+23 -2
View File
@@ -52,7 +52,11 @@ func (s *Service) Read(ctx context.Context, host netbox.HostEntry, remote bool)
note.Text, note.ETag, err = s.Client.GetComments(ctx, note.Host)
return note, err
}
data, err := os.ReadFile(s.path(host))
path, err := s.localPath(host)
if err != nil {
return note, err
}
data, err := os.ReadFile(path)
if os.IsNotExist(err) {
return note, nil
}
@@ -67,5 +71,22 @@ func (s *Service) Write(ctx context.Context, note Note, remote bool) error {
}
return s.Client.SetComments(ctx, note.Host, note.Text, note.ETag)
}
return storage.WriteFile(s.path(note.Host), []byte(note.Text), 0o600)
path, err := s.localPath(note.Host)
if err != nil {
return err
}
return storage.WriteFile(path, []byte(note.Text), 0o600)
}
func (s *Service) localPath(host netbox.HostEntry) (string, error) {
if s.Client == nil {
return s.path(host), nil
}
host, namespace, err := s.Client.HostScope(host)
if err != nil {
return "", err
}
scoped := *s
scoped.Namespace = namespace
return scoped.path(host), nil
}
+32
View File
@@ -50,3 +50,35 @@ func TestUnreadableNoteIsNotTreatedAsEmpty(t *testing.T) {
t.Fatal("expected read error")
}
}
func TestLocalNotesSeparateInstancesAndSurviveRename(t *testing.T) {
ctx := context.Background()
client := netbox.NewMultiClient([]netbox.Source{{Name: "office", URL: "https://office.example"}, {Name: "lab", URL: "https://lab.example"}})
service := &Service{Dir: t.TempDir(), Client: client}
for _, source := range []string{"office", "lab"} {
note := Note{Host: netbox.HostEntry{Name: source + "/web", Kind: "device"}, Text: source + " private note"}
if err := service.Write(ctx, note, false); err != nil {
t.Fatal(err)
}
}
for _, source := range []string{"office", "lab"} {
note, err := service.Read(ctx, netbox.HostEntry{Name: source + "/web", Kind: "device"}, false)
if err != nil || note.Text != source+" private note" {
t.Fatalf("notes crossed instances: %+v, %v", note, err)
}
}
service.Client = netbox.NewMultiClient([]netbox.Source{{Name: "renamed", URL: "https://office.example"}})
note, err := service.Read(ctx, netbox.HostEntry{Name: "renamed/web", Kind: "device"}, false)
if err != nil || note.Text != "office private note" {
t.Fatalf("renaming source lost note: %+v, %v", note, err)
}
// This is also the namespace used before migrating a legacy single NetBox.
legacy := &Service{Dir: service.Dir, Namespace: "https://office.example"}
note, err = legacy.Read(ctx, netbox.HostEntry{Name: "web", Kind: "device"}, false)
if err != nil || note.Text != "office private note" {
t.Fatalf("legacy note namespace changed: %+v, %v", note, err)
}
if err := service.Write(ctx, Note{Host: netbox.HostEntry{Name: "web", Kind: "device"}}, false); err == nil {
t.Fatal("unqualified notes accepted for multiple sources")
}
}
+43
View File
@@ -0,0 +1,43 @@
package resolver
import (
"context"
"fmt"
"net/http"
"net/http/httptest"
"testing"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
)
func TestVMResolversStayWithinTheirNetBoxInstance(t *testing.T) {
sources := make([]netbox.Source, 0, 2)
for i, name := range []string{"office", "lab"} {
ip := fmt.Sprintf("10.0.0.%d", i+1)
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Query().Get("virtual_machine_id") != "7" {
t.Errorf("wrong VM filter: %s", r.URL.RawQuery)
}
if r.Header.Get("Authorization") != "Token "+name {
t.Error("VM lookup used another instance's credentials")
}
fmt.Fprintf(w, `{"count":1,"results":[{"address":%q}]}`, ip+"/24")
}))
t.Cleanup(srv.Close)
sources = append(sources, netbox.Source{Name: name, URL: srv.URL, Token: name})
}
client := netbox.NewMultiClient(sources)
management, err := NewManagementSubnetStrategy([]string{"10.0.0.0/8"})
if err != nil {
t.Fatal(err)
}
for i, source := range sources {
host := &netbox.HostEntry{Source: source.Name, Name: "vm", Kind: "vm", ID: 7}
for _, strategy := range []Strategy{management, &InterfaceNameStrategy{name: "mgmt0"}} {
ip, err := strategy.Resolve(context.Background(), host, client)
if want := fmt.Sprintf("10.0.0.%d", i+1); err != nil || ip != want {
t.Fatalf("%s VM resolved through wrong instance: %q, %v", strategy.Name(), ip, err)
}
}
}
}
+1 -1
View File
@@ -27,7 +27,7 @@ func (s *InterfaceNameStrategy) Resolve(ctx context.Context, entry *netbox.HostE
return "", fmt.Errorf("unknown kind %q", entry.Kind)
}
ips, err := client.GetIPsWithFilter(ctx, filterParam)
ips, err := client.GetIPsWithFilterForHost(ctx, *entry, filterParam)
if err != nil {
return "", fmt.Errorf("fetching IPs for interface %q: %w", s.name, err)
}
+112
View File
@@ -0,0 +1,112 @@
package setup
import (
"fmt"
"os"
"strings"
"charm.land/huh/v2"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
)
// configureInstances edits a copy; nothing is written until the whole wizard succeeds.
func configureInstances(cfg *config.Config) ([]config.NetBoxConfig, error) {
sources := append([]config.NetBoxConfig(nil), cfg.NetBoxes...)
if len(sources) == 0 && cfg.NetBox.URL != "" {
source := cfg.NetBox
source.Name = "default"
sources = append(sources, source)
}
for {
if len(sources) == 0 {
source, err := editInstance(config.NetBoxConfig{Name: "default"}, sources, "")
if err != nil {
return nil, err
}
sources = append(sources, source)
}
action := "done"
var options []huh.Option[string]
for _, source := range sources {
options = append(options, huh.NewOption("Edit "+source.Name+" ("+source.URL+")", "edit:"+source.Name))
options = append(options, huh.NewOption("Remove "+source.Name, "remove:"+source.Name))
}
options = append(options, huh.NewOption("Add another NetBox", "add"), huh.NewOption("Continue with these instances", "done"))
err := huh.NewForm(huh.NewGroup(huh.NewSelect[string]().Title("NetBox instances").Description("All configured instances are searched together.").Options(options...).Value(&action))).Run()
if err != nil {
return nil, err
}
if action == "done" {
return sources, nil
}
if action == "add" {
source, err := editInstance(config.NetBoxConfig{}, sources, "")
if err != nil {
return nil, err
}
sources = append(sources, source)
continue
}
verb, name, _ := strings.Cut(action, ":")
for i, source := range sources {
if source.Name != name {
continue
}
if verb == "edit" {
edited, err := editInstance(source, sources, name)
if err != nil {
return nil, err
}
sources[i] = edited
} else {
remove := false
if err := huh.NewConfirm().Title("Remove " + name + "?").Value(&remove).Run(); err != nil {
return nil, err
}
if remove {
sources = append(sources[:i], sources[i+1:]...)
}
}
break
}
}
}
func editInstance(source config.NetBoxConfig, sources []config.NetBoxConfig, original string) (config.NetBoxConfig, error) {
err := huh.NewForm(huh.NewGroup(
huh.NewInput().Title("Instance name").Description("Used in selectors such as office/web01.").Value(&source.Name).Validate(func(name string) error {
name = strings.ToLower(strings.TrimSpace(name))
candidate := config.Config{NetBoxes: []config.NetBoxConfig{{Name: name, URL: "https://example.invalid"}}}
if err := candidate.ValidateNetBoxes(); err != nil {
return err
}
for _, existing := range sources {
if strings.EqualFold(existing.Name, name) && !strings.EqualFold(existing.Name, original) {
return fmt.Errorf("instance name %q is already used", name)
}
}
return nil
}),
huh.NewInput().Title("NetBox URL").Placeholder("https://netbox.example.com").Value(&source.URL).Validate(func(value string) error {
return (&config.Config{NetBoxes: []config.NetBoxConfig{{Name: "instance", URL: strings.TrimSpace(value)}}}).ValidateNetBoxes()
}),
huh.NewInput().Title("NetBox API token").EchoMode(huh.EchoModePassword).Value(&source.Token).Validate(func(value string) error {
if strings.TrimSpace(value) == "" {
return fmt.Errorf("required")
}
return nil
}),
).Title("NetBox connection")).Run()
if err != nil {
return source, err
}
source.Name = strings.ToLower(strings.TrimSpace(source.Name))
source.URL = strings.TrimRight(strings.TrimSpace(source.URL), "/")
source.Token = strings.TrimSpace(source.Token)
source.TokenVersion = netbox.TokenVersion(source.Token)
if source.TokenVersion == 1 {
fmt.Fprintf(os.Stderr, "Note: NetBox %s uses a legacy v1 token. A v2 token starts with nbt_.\n", source.Name)
}
return source, nil
}
+24 -44
View File
@@ -8,20 +8,25 @@ import (
"strconv"
"strings"
"github.com/charmbracelet/huh"
"charm.land/huh/v2"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/hook"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/storage"
)
// RunWizard runs the interactive setup form, pre-filled with any existing cfg values.
// It saves the result to the config file on success.
func RunWizard(cfg *config.Config) error {
url := cfg.NetBox.URL
token := cfg.NetBox.Token
sources, err := configureInstances(cfg)
if err != nil {
if errors.Is(err, huh.ErrUserAborted) {
fmt.Fprintln(os.Stderr, "Setup cancelled.")
os.Exit(0)
}
return err
}
defaultUser := cfg.SSH.DefaultUser
defaultPort := ""
if cfg.SSH.DefaultPort > 0 {
@@ -43,30 +48,6 @@ func RunWizard(cfg *config.Config) error {
}
form := huh.NewForm(
huh.NewGroup(
huh.NewInput().
Title("NetBox URL").
Description("e.g. https://netbox.example.com").
Placeholder("https://").
Value(&url).
Validate(func(s string) error {
if strings.TrimSpace(s) == "" {
return errors.New("required")
}
return nil
}),
huh.NewInput().
Title("NetBox API token").
EchoMode(huh.EchoModePassword).
Value(&token).
Validate(func(s string) error {
if strings.TrimSpace(s) == "" {
return errors.New("required")
}
return nil
}),
).Title("NetBox connection"),
huh.NewGroup(
huh.NewInput().
Title("Default SSH user").
@@ -144,11 +125,6 @@ func RunWizard(cfg *config.Config) error {
}
strategies := parseStrategies(strategiesRaw)
tokenVersion := netbox.TokenVersion(token)
if tokenVersion == 1 {
fmt.Fprintln(os.Stderr, "\nNote: You are using a legacy token (v1). Create a v2 token in NetBox (starting with nbt_) for better compatibility.")
fmt.Fprintln(os.Stderr, " NetBox → Admin → API Tokens → Add Token")
}
ttl, _ := strconv.Atoi(cacheTTL)
@@ -175,12 +151,8 @@ func RunWizard(cfg *config.Config) error {
}
out := config.Config{
Shell: config.ShellConfig{Alias: strings.TrimSpace(commandAlias)},
NetBox: config.NetBoxConfig{
URL: strings.TrimRight(strings.TrimSpace(url), "/"),
Token: strings.TrimSpace(token),
TokenVersion: tokenVersion,
},
Shell: config.ShellConfig{Alias: strings.TrimSpace(commandAlias)},
NetBoxes: sources,
SSH: config.SSHConfig{
DefaultUser: strings.TrimSpace(defaultUser),
DefaultPort: port,
@@ -207,7 +179,7 @@ func RunWizard(cfg *config.Config) error {
if err != nil {
return err
}
c := cache.New(loaded.Cache.Path, loaded.Cache.TTL)
c := cache.New(loaded.CachePath(), loaded.Cache.TTL)
if err := c.Load(); err != nil {
return fmt.Errorf("updating aliases: %w", err)
}
@@ -266,16 +238,24 @@ func save(cfg config.Config) error {
if err := config.ValidateCommandAlias(cfg.Shell.Alias); err != nil {
return err
}
if err := cfg.ValidateNetBoxes(); err != nil {
return err
}
path := config.Path()
if err := os.MkdirAll(filepath.Dir(path), 0o700); err != nil {
return fmt.Errorf("creating config dir: %w", err)
}
var b strings.Builder
b.WriteString("netbox:\n")
b.WriteString(fmt.Sprintf(" url: %q\n", cfg.NetBox.URL))
b.WriteString(fmt.Sprintf(" token: %q\n", cfg.NetBox.Token))
fmt.Fprintf(&b, " token_version: %d\n", cfg.NetBox.TokenVersion)
if len(cfg.NetBoxes) > 0 {
b.WriteString("netboxes:\n")
for _, source := range cfg.NetBoxes {
fmt.Fprintf(&b, " - name: %q\n url: %q\n token: %q\n token_version: %d\n", source.Name, source.URL, source.Token, source.TokenVersion)
}
} else {
b.WriteString("netbox:\n")
fmt.Fprintf(&b, " url: %q\n token: %q\n token_version: %d\n", cfg.NetBox.URL, cfg.NetBox.Token, cfg.NetBox.TokenVersion)
}
b.WriteString("\nresolver:\n")
b.WriteString(" strategies:\n")
+34
View File
@@ -386,3 +386,37 @@ func TestSaveCommandAliasRoundtripAndDisable(t *testing.T) {
t.Fatalf("disable: %+v, %v", loaded, err)
}
}
func TestSaveMultipleNetBoxesRoundTrip(t *testing.T) {
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
cfg := config.Config{
NetBoxes: []config.NetBoxConfig{
{Name: "office", URL: "https://office.example/netbox", Token: "nbt_secret: office", TokenVersion: 2},
{Name: "lab", URL: "https://lab.example", Token: "legacy#token", TokenVersion: 1},
},
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
Cache: config.CacheConfig{TTL: 3600},
}
if err := save(cfg); err != nil {
t.Fatal(err)
}
loaded, err := config.Load()
if err != nil {
t.Fatal(err)
}
if len(loaded.NetBoxes) != 2 || loaded.NetBox.URL != "" {
t.Fatalf("instances lost during save: %+v", loaded)
}
for i, want := range cfg.NetBoxes {
if loaded.NetBoxes[i] != want {
t.Fatalf("instance changed: %+v, want %+v", loaded.NetBoxes[i], want)
}
}
info, err := os.Stat(config.Path())
if err != nil {
t.Fatal(err)
}
if info.Mode().Perm() != 0o600 {
t.Fatal("credentials are not private")
}
}
+1 -1
View File
@@ -38,5 +38,5 @@ func MakeNormalizer(cfg config.ShortcutsConfig) func(string) string {
// replaces any remaining dots with underscores so the result is a valid identifier.
func AliasName(name string, cfg config.ShortcutsConfig) string {
s := Normalize(name, cfg)
return strings.ReplaceAll(s, ".", "_")
return strings.NewReplacer(".", "_", "/", "_").Replace(s)
}
+42 -38
View File
@@ -4,7 +4,7 @@ import "strings"
// flagsWithArg lists all SSH flags that consume the following argument.
var flagsWithArg = map[byte]bool{
'b': true, 'c': true, 'D': true, 'E': true, 'e': true,
'B': true, 'P': true, 'b': true, 'c': true, 'D': true, 'E': true, 'e': true,
'F': true, 'I': true, 'i': true, 'J': true, 'L': true,
'l': true, 'm': true, 'o': true, 'O': true, 'p': true,
'Q': true, 'R': true, 'S': true, 'w': true, 'W': true,
@@ -32,18 +32,16 @@ func Parse(args []string) *ParsedArgs {
}
if strings.HasPrefix(arg, "-") && len(arg) > 1 {
flag := arg[1]
if flagsWithArg[flag] {
if len(arg) > 2 {
// argument is attached, e.g. -p2222
i++
} else {
// argument is the next element, e.g. -p 2222
i += 2
// OpenSSH accepts clusters such as -vp 2222 and -vladmin.
for j := 1; j < len(arg); j++ {
if flagsWithArg[arg[j]] {
if j == len(arg)-1 {
i++
}
break
}
} else {
i++
}
i++
continue
}
@@ -86,35 +84,41 @@ func ReplaceHost(args []string, destIdx int, newHost string) []string {
return result
}
// HasPortFlag reports whether a port was specified via -p in args.
func HasPortFlag(args []string) bool {
if parsed := Parse(args); parsed != nil {
args = args[:parsed.DestIdx]
}
for i, a := range args {
if a == "-p" && i+1 < len(args) {
return true
}
if len(a) > 2 && a[0] == '-' && a[1] == 'p' {
return true
}
}
return false
}
// HasPortFlag reports whether a port was explicitly supplied.
func HasPortFlag(args []string) bool { return hasOption(args, 'p', "Port") }
// HasUserFlag reports whether a user was specified via -l in args.
// Used to avoid overriding an explicit -l with the configured default user.
func HasUserFlag(args []string) bool {
if parsed := Parse(args); parsed != nil {
args = args[:parsed.DestIdx]
}
for i, a := range args {
if a == "-l" && i+1 < len(args) {
return true
// HasUserFlag reports whether a login user was explicitly supplied.
func HasUserFlag(args []string) bool { return hasOption(args, 'l', "User") }
func hasOption(args []string, wanted byte, keyword string) bool {
for i := 0; i < len(args); i++ {
arg := args[i]
if arg == "--" || len(arg) < 2 || arg[0] != '-' {
break
}
// handle attached form: -lroot
if len(a) > 2 && a[0] == '-' && a[1] == 'l' {
return true
for j := 1; j < len(arg); j++ {
flag := arg[j]
if !flagsWithArg[flag] {
continue
}
value := arg[j+1:]
if value == "" {
i++
if i >= len(args) {
return false
}
value = args[i]
}
if flag == wanted {
return true
}
if flag == 'o' {
fields := strings.FieldsFunc(value, func(r rune) bool { return r == '=' || r == ' ' || r == '\t' })
if len(fields) >= 2 && strings.EqualFold(fields[0], keyword) {
return true
}
}
break
}
}
return false
+46
View File
@@ -0,0 +1,46 @@
package ssh
import "testing"
func TestParseOptionClusters(t *testing.T) {
for _, args := range [][]string{
{"-vp", "2222", "server"},
{"-vp2222", "server"},
{"-vAl", "admin", "server"},
{"-vladmin", "server"},
{"-B", "eth0", "server"},
{"-P", "production", "server"},
} {
t.Run(args[0], func(t *testing.T) {
assertParsed(t, Parse(args), "server", "", len(args)-1)
})
}
}
func TestExplicitSSHOptions(t *testing.T) {
for _, tc := range []struct {
name string
args []string
user, port bool
}{
{"cluster port separated", []string{"-vp", "2222", "server"}, false, true},
{"cluster user attached", []string{"-vladmin", "server"}, true, false},
{"o separated", []string{"-o", "User=admin", "-o", "Port=2222", "server"}, true, true},
{"o attached and case insensitive", []string{"-ouSeR=admin", "-oport=2222", "server"}, true, true},
{"o whitespace", []string{"-o", " User = admin", "-o", "Port\t2222", "server"}, true, true},
{"cluster o", []string{"-voUser=admin", "server"}, true, false},
{"option value looks like flag", []string{"-i", "-lroot", "-F", "-p2222", "server"}, false, false},
{"remote flags", []string{"server", "-p2222", "-o", "User=admin"}, false, false},
{"after double dash", []string{"--", "-lroot", "-p2222"}, false, false},
{"missing value", []string{"-vp"}, false, false},
} {
t.Run(tc.name, func(t *testing.T) {
if got := HasUserFlag(tc.args); got != tc.user {
t.Errorf("HasUserFlag(%v) = %v, want %v", tc.args, got, tc.user)
}
if got := HasPortFlag(tc.args); got != tc.port {
t.Errorf("HasPortFlag(%v) = %v, want %v", tc.args, got, tc.port)
}
})
}
}
+81
View File
@@ -0,0 +1,81 @@
package tui
import (
"fmt"
"net/http"
"net/http/httptest"
"strings"
"testing"
tea "charm.land/bubbletea/v2"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
)
func tuiSourceServer(t *testing.T, fail bool) *httptest.Server {
t.Helper()
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if fail {
http.Error(w, "offline", 503)
return
}
if r.URL.Path == "/api/dcim/devices/" {
fmt.Fprint(w, `{"count":1,"results":[{"id":1,"name":"web","primary_ip4":{"address":"10.0.0.1/24"}}]}`)
} else {
fmt.Fprint(w, `{"count":0,"results":[]}`)
}
}))
t.Cleanup(srv.Close)
return srv
}
func TestCombinedSearchDoesNotStopAtFirstCachedInstance(t *testing.T) {
office, lab := tuiSourceServer(t, false), tuiSourceServer(t, false)
client := netbox.NewMultiClient([]netbox.Source{{Name: "office", URL: office.URL}, {Name: "lab", URL: lab.URL}})
c := cache.New("", 3600)
c.Upsert(cache.Entry{Name: "office/web", Kind: "device", IP: "10.0.0.9"})
m := New(client, c, "")
msg := m.doSearch("web", 1)().(searchResultMsg)
if msg.err != nil || len(msg.entries) != 2 {
t.Fatalf("cache hid another instance: %+v, %v", msg.entries, msg.err)
}
m.input.SetValue("web")
m.seq = 1
m.Update(msg)
if len(m.list.Items()) != 2 {
t.Fatal("combined results not displayed")
}
for _, item := range m.list.Items() {
if !strings.Contains(item.(hostItem).name, "/") {
t.Fatal("instance not visible in results")
}
}
m.list.Select(0)
m.Update(tea.KeyPressMsg{Code: tea.KeyEnter})
if m.selected == nil || m.selected.Name != "lab/web" {
t.Fatalf("selection lost source: %+v", m.selected)
}
}
func TestPartialOutageKeepsLiveAndCachedResultsVisible(t *testing.T) {
office, lab := tuiSourceServer(t, false), tuiSourceServer(t, true)
client := netbox.NewMultiClient([]netbox.Source{{Name: "office", URL: office.URL}, {Name: "lab", URL: lab.URL}})
c := cache.New("", 3600)
c.Upsert(cache.Entry{Name: "lab/web", Kind: "device", IP: "10.0.0.2"})
m := New(client, c, "")
m.input.SetValue("web")
m.seq = 1
m.Update(tea.WindowSizeMsg{Width: 100, Height: 24})
msg := m.doSearch("web", 1)().(searchResultMsg)
if len(msg.entries) != 2 || msg.err == nil {
t.Fatalf("partial outage lost cache or warning: %+v, %v", msg.entries, msg.err)
}
m.Update(msg)
view := m.View().Content
if !strings.Contains(view, "warning:") || !strings.Contains(view, "lab/web") || !strings.Contains(view, "office/web") {
t.Fatalf("partial results hidden: %s", view)
}
if rows := strings.Count(view, "\n"); rows > 24 {
t.Fatalf("outage warning overflowed view: %d", rows)
}
}
+88 -37
View File
@@ -4,19 +4,20 @@ import (
"context"
"fmt"
"io"
"sort"
"strconv"
"strings"
"time"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/notes"
"github.com/charmbracelet/bubbles/list"
"github.com/charmbracelet/bubbles/textarea"
"github.com/charmbracelet/bubbles/textinput"
tea "github.com/charmbracelet/bubbletea"
"github.com/charmbracelet/lipgloss"
"charm.land/bubbles/v2/list"
"charm.land/bubbles/v2/textarea"
"charm.land/bubbles/v2/textinput"
tea "charm.land/bubbletea/v2"
"charm.land/lipgloss/v2"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/notes"
)
// SelectedHost is returned when the user confirms a host in the TUI.
@@ -78,7 +79,7 @@ func (d compactDelegate) Render(w io.Writer, m list.Model, index int, item list.
if index == m.Index() {
line = lipgloss.NewStyle().Bold(true).Foreground(lipgloss.Color("86")).Render("> " + strings.TrimPrefix(line, " "))
}
fmt.Fprintln(w, line)
fmt.Fprint(w, line)
}
// --- filter ---
@@ -221,6 +222,7 @@ func (m *Model) loadRecent() tea.Cmd {
}
func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
defer m.resizeList()
switch msg := msg.(type) {
case noteResultMsg:
m.noteBusy = false
@@ -240,18 +242,13 @@ func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
case tea.WindowSizeMsg:
m.width = msg.Width
m.height = msg.Height
extraRows := 4
if m.filterOpen {
extraRows++
}
if m.editMode {
extraRows += 2
}
m.list.SetSize(msg.Width, max(1, msg.Height-extraRows))
m.input.SetWidth(max(1, msg.Width-lipgloss.Width(m.input.Prompt)))
m.filterInput.SetWidth(max(1, msg.Width-lipgloss.Width(m.filterInput.Prompt)))
m.editInput.SetWidth(max(1, msg.Width-lipgloss.Width("Connect as: ")))
m.noteInput.SetWidth(max(10, msg.Width-4))
return m, nil
case tea.KeyMsg:
case tea.KeyPressMsg:
if msg.String() == "ctrl+c" {
return m, tea.Quit
}
@@ -416,21 +413,33 @@ func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
return m, nil // discard stale result
}
m.loading = false
if msg.err != nil {
m.err = msg.err
return m, nil
}
m.err = msg.err
m.lastResults = msg.entries
m.updateListItems(msg.entries)
m.err = nil
return m, nil
}
if m.noteMode {
if m.noteBusy {
return m, nil
}
var cmd tea.Cmd
m.noteInput, cmd = m.noteInput.Update(msg)
return m, cmd
}
// Paste and cursor events are separate from key presses in Bubble Tea v2.
// Route them to the focused editor as well.
if m.editMode {
var cmd tea.Cmd
m.editInput, cmd = m.editInput.Update(msg)
return m, cmd
}
if m.filterOpen {
var cmd tea.Cmd
m.filterInput, cmd = m.filterInput.Update(msg)
m.updateListItems(m.lastResults)
return m, cmd
}
// Forward to search input and restart debounce timer.
var cmds []tea.Cmd
var inputCmd tea.Cmd
@@ -449,7 +458,13 @@ func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
return m, tea.Batch(cmds...)
}
func (m *Model) View() string {
func (m *Model) View() tea.View {
view := tea.NewView(m.viewContent())
view.AltScreen = true
return view
}
func (m *Model) viewContent() string {
if m.noteMode {
target := "local"
if m.noteRemote {
@@ -477,9 +492,15 @@ func (m *Model) View() string {
if m.loading {
sb.WriteString(lipgloss.NewStyle().Foreground(lipgloss.Color("240")).Render(" searching…") + "\n")
} else if m.err != nil {
sb.WriteString(lipgloss.NewStyle().Foreground(lipgloss.Color("9")).Render(" error: "+m.err.Error()) + "\n")
} else {
if m.err != nil {
warning := " warning: " + strings.ReplaceAll(m.err.Error(), "\n", "; ")
style := lipgloss.NewStyle().Foreground(lipgloss.Color("9"))
if m.width > 0 {
style = style.MaxWidth(m.width)
}
sb.WriteString(style.Render(warning) + "\n")
}
if m.recentMode && m.input.Value() == "" {
if len(m.list.Items()) > 0 {
sb.WriteString(lipgloss.NewStyle().Foreground(lipgloss.Color("240")).Render(" Recent connections") + "\n")
@@ -516,25 +537,30 @@ func (m *Model) startDebounce() tea.Cmd {
func (m *Model) doSearch(query string, seq int) tea.Cmd {
opts := m.netboxSearchOpts()
return func() tea.Msg {
// Return cache hits immediately without a network round-trip.
var cached []netbox.HostEntry
if m.cache != nil {
if cached := m.cache.Search(query); len(cached) > 0 {
entries := make([]netbox.HostEntry, len(cached))
for i, c := range cached {
entries[i] = netbox.HostEntry{Name: c.Name, PrimaryIP4: c.IP, Kind: c.Kind, Tags: c.Tags}
}
return searchResultMsg{query: query, seq: seq, entries: entries}
for _, entry := range m.cache.Search(query) {
source, name := netbox.SplitTarget(entry.Name)
cached = append(cached, netbox.HostEntry{Source: source, Name: name, PrimaryIP4: entry.IP, Kind: entry.Kind, Tags: entry.Tags})
}
}
if m.client == nil {
return searchResultMsg{query: query, seq: seq, entries: nil}
if m.client == nil || (len(cached) > 0 && !m.client.MultipleSources()) {
return searchResultMsg{query: query, seq: seq, entries: cached}
}
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
entries, err := m.client.Search(ctx, query, opts)
// A cached hit in one instance must not hide live hosts in other instances.
seen := make(map[string]bool)
for _, e := range entries {
seen[e.Target()+"\x00"+e.Kind] = true
}
for _, e := range cached {
if !seen[e.Target()+"\x00"+e.Kind] {
entries = append(entries, e)
}
}
sort.SliceStable(entries, func(i, j int) bool { return entries[i].Target() < entries[j].Target() })
return searchResultMsg{query: query, seq: seq, entries: entries, err: err}
}
}
@@ -559,9 +585,34 @@ func (m *Model) updateListItems(entries []netbox.HostEntry) {
if ip == "" {
ip = e.PrimaryIP6
}
items[i] = hostItem{id: e.ID, name: e.Name, ip: ip, kind: e.Kind, tags: e.Tags}
items[i] = hostItem{id: e.ID, name: e.Target(), ip: ip, kind: e.Kind, tags: e.Tags}
}
m.list.SetItems(items)
m.resizeList()
}
// resizeList keeps the footer visible when the recent heading or editors change.
func (m *Model) resizeList() {
if m.width <= 0 || m.height <= 0 {
return
}
extraRows := 5 // title, blank line, search, footer separator, footer
if m.err != nil {
extraRows++
}
if m.recentMode && m.input.Value() == "" && len(m.list.Items()) > 0 {
extraRows++
}
if m.filterOpen {
extraRows++
}
if m.editMode {
extraRows++
}
height := max(1, m.height-extraRows)
if m.list.Width() != m.width || m.list.Height() != height {
m.list.SetSize(m.width, height)
}
}
// openEdit switches to edit mode for the given list item.
+7 -5
View File
@@ -1,16 +1,18 @@
package tui
import (
"testing"
tea "charm.land/bubbletea/v2"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/notes"
tea "github.com/charmbracelet/bubbletea"
"testing"
)
func TestTypingEDoesNotOpenConnectionEditor(t *testing.T) {
m := New(nil, nil, "")
m.updateListItems([]netbox.HostEntry{{Name: "server"}})
m.Update(tea.KeyMsg{Type: tea.KeyRunes, Runes: []rune{'e'}})
m.Update(tea.KeyPressMsg{Code: 'e', Text: "e"})
if m.editMode || m.input.Value() != "e" {
t.Fatal("e intercepted")
}
@@ -52,7 +54,7 @@ func TestFailedNoteLoadCannotBeSaved(t *testing.T) {
m := New(nil, nil, "")
m.SetNotes(&notes.Service{Dir: t.TempDir()})
m.noteMode = true
_, cmd := m.Update(tea.KeyMsg{Type: tea.KeyCtrlS})
_, cmd := m.Update(tea.KeyPressMsg{Code: 's', Mod: tea.ModCtrl})
if cmd != nil {
t.Fatal("save allowed before successful load")
}
@@ -63,7 +65,7 @@ func TestConnectionEditorKeepsOriginalHost(t *testing.T) {
first := hostItem{name: "first", ip: "10.0.0.1"}
m.openEdit(first)
m.updateListItems([]netbox.HostEntry{{Name: "second", PrimaryIP4: "10.0.0.2"}})
m.Update(tea.KeyMsg{Type: tea.KeyEnter})
m.Update(tea.KeyPressMsg{Code: tea.KeyEnter})
if m.selected == nil || m.selected.Name != "first" {
t.Fatalf("edited host changed: %+v", m.selected)
}
+123
View File
@@ -0,0 +1,123 @@
package tui
import (
"strings"
"testing"
tea "charm.land/bubbletea/v2"
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
)
func TestV2PasteFollowsFocusedEditor(t *testing.T) {
t.Run("search", func(t *testing.T) {
m := New(nil, nil, "")
_, cmd := m.Update(tea.PasteMsg{Content: "web-ä"})
if m.input.Value() != "web-ä" || m.seq != 1 || cmd == nil {
t.Fatalf("paste did not start search: %q, seq %d", m.input.Value(), m.seq)
}
})
t.Run("connection editor", func(t *testing.T) {
m := New(nil, nil, "")
m.openEdit(hostItem{name: "web", ip: "10.0.0.1"})
m.editInput.SetValue("")
m.Update(tea.PasteMsg{Content: "ops@web:2222"})
m.Update(tea.KeyPressMsg{Code: tea.KeyEnter})
if m.selected == nil || m.selected.User != "ops" || m.selected.Port != "2222" {
t.Fatalf("paste lost in editor: %+v", m.selected)
}
if m.input.Value() != "" {
t.Fatal("editor paste changed search")
}
})
t.Run("filter", func(t *testing.T) {
m := New(nil, nil, "")
m.lastResults = []netbox.HostEntry{{Name: "vm", Kind: "vm"}, {Name: "device", Kind: "device"}}
m.updateListItems(m.lastResults)
m.Update(tea.KeyPressMsg{Code: 'f', Mod: tea.ModCtrl})
m.Update(tea.PasteMsg{Content: "kind:vm"})
if m.filterInput.Value() != "kind:vm" || len(m.list.Items()) != 1 {
t.Fatalf("paste did not filter: %q, %d results", m.filterInput.Value(), len(m.list.Items()))
}
if m.input.Value() != "" {
t.Fatal("filter paste changed search")
}
})
t.Run("notes", func(t *testing.T) {
m := New(nil, nil, "")
m.noteMode = true
m.input.Blur()
m.noteInput.Focus()
m.Update(tea.PasteMsg{Content: "First line\nSecond line"})
if m.noteInput.Value() != "First line\nSecond line" {
t.Fatalf("multiline paste lost: %q", m.noteInput.Value())
}
m.noteBusy = true
m.Update(tea.PasteMsg{Content: "must not change busy note"})
if m.noteInput.Value() != "First line\nSecond line" {
t.Fatal("paste edited note while loading/saving")
}
})
}
func TestV2ViewKeepsAlternateScreenInEachMode(t *testing.T) {
for _, mode := range []string{"search", "edit", "notes"} {
t.Run(mode, func(t *testing.T) {
m := New(nil, nil, "")
m.Update(tea.WindowSizeMsg{Width: 80, Height: 24})
if mode == "edit" {
m.openEdit(hostItem{name: "web"})
}
if mode == "notes" {
m.noteMode = true
}
view := m.View()
if !view.AltScreen || strings.TrimSpace(view.Content) == "" {
t.Fatalf("invalid %s view: %+v", mode, view)
}
})
}
}
func TestV2KeyReleaseDoesNotTypeTwice(t *testing.T) {
m := New(nil, nil, "")
m.Update(tea.KeyPressMsg{Code: 'e', Text: "e"})
m.Update(tea.KeyReleaseMsg{Code: 'e', Text: "e"})
if m.input.Value() != "e" {
t.Fatalf("key release changed input: %q", m.input.Value())
}
m.Update(tea.KeyPressMsg{Code: ' ', Text: " "})
if m.input.Value() != "e " {
t.Fatalf("space not inserted: %q", m.input.Value())
}
}
func TestV2ResizeShowsFullSearchPromptAndFooter(t *testing.T) {
m := New(nil, nil, "")
m.Update(tea.WindowSizeMsg{Width: 100, Height: 24})
var entries []netbox.HostEntry
for range 30 {
entries = append(entries, netbox.HostEntry{Name: "web", Kind: "device"})
}
m.updateListItems(entries)
view := m.View()
if m.input.Width() != 98 || m.filterInput.Width() != 92 || m.editInput.Width() != 88 {
t.Fatalf("editors were not sized for terminal: search=%d filter=%d edit=%d", m.input.Width(), m.filterInput.Width(), m.editInput.Width())
}
if !strings.Contains(view.Content, "earch hostname") || !strings.Contains(view.Content, "ctrl+c quit") {
t.Fatalf("search prompt or footer missing: %s", view.Content)
}
assertFits := func() {
t.Helper()
if rows := strings.Count(m.View().Content, "\n"); rows > 24 {
t.Fatalf("view overflows terminal: %d rows", rows)
}
}
assertFits()
m.lastResults = entries
m.Update(tea.KeyPressMsg{Code: 'f', Mod: tea.ModCtrl})
assertFits()
m.Update(tea.KeyPressMsg{Code: 'f', Mod: tea.ModCtrl})
m.Update(tea.KeyPressMsg{Code: 'e', Mod: tea.ModCtrl})
assertFits()
}