Compare commits
2
Commits
9c6a91e648
..
v1.1.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e5bde9c61f | ||
|
|
8d4915543e |
No files matched your search
@@ -0,0 +1,4 @@
|
|||||||
|
.git
|
||||||
|
testenv/.keys
|
||||||
|
testenv/.state
|
||||||
|
testenv/.artifacts
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
name: Test
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v7
|
||||||
|
|
||||||
|
- uses: actions/setup-go@v7
|
||||||
|
with:
|
||||||
|
go-version-file: go.mod
|
||||||
|
cache: true
|
||||||
|
|
||||||
|
- name: Check formatting
|
||||||
|
run: |
|
||||||
|
unformatted=$(gofmt -l .)
|
||||||
|
if [ -n "$unformatted" ]; then
|
||||||
|
echo "gofmt needed for:"
|
||||||
|
echo "$unformatted"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Vet
|
||||||
|
run: go vet ./...
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: go test -race ./...
|
||||||
@@ -19,3 +19,8 @@ dist/
|
|||||||
# OS
|
# OS
|
||||||
.DS_Store
|
.DS_Store
|
||||||
Thumbs.db
|
Thumbs.db
|
||||||
|
|
||||||
|
# local test environment (testenv/up.sh)
|
||||||
|
testenv/.keys/
|
||||||
|
testenv/.state/
|
||||||
|
testenv/.artifacts/
|
||||||
@@ -1,5 +1,62 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## v1.1.0
|
||||||
|
|
||||||
|
- Add local post-disconnect/post-command scripts, execution timeouts, cancellation, per-command confirmation and host restrictions.
|
||||||
|
- Add configurable recent-host count, persistent favorites/pins, a TUI command menu and cache/live/stale indicators.
|
||||||
|
- Add doctor/explain diagnostics, parallel batch commands with failed-host retry, and optional bounded local action history.
|
||||||
|
- Add configuration export/import that excludes credentials and executable settings while preserving matching local credentials.
|
||||||
|
- Preserve terminal behavior and process exit status during supervised execution; test Bash/Python scripts, process cancellation, concurrency and batch retries.
|
||||||
|
|
||||||
|
## v1.0.0
|
||||||
|
|
||||||
|
- Consolidate the complete project into the initial v1 commit.
|
||||||
|
- Add configurable local host commands and automatically generated aliases, such as `mxg1` for `mtr` on host shortcut `xg1`. Commands resolve the destination at invocation using the configured resolver strategy.
|
||||||
|
- Support executable scripts and interpreter-based scripts, host/address placeholders, extra arguments, dry runs, and configuration through `netssh configure`.
|
||||||
|
- Include all previous SSH, SFTP/SCP, forwarding, multi-session, NetBox instance, shortcut, and security improvements.
|
||||||
|
|
||||||
|
|
||||||
|
## v0.0.29
|
||||||
|
|
||||||
|
- Add `ssh.pre_connect`: a shell command run locally before every connection (ssh, sftp, scp, tunnel), e.g. to check a VPN. A non-zero exit aborts the connection. Layered like `proxy_jump` (global → instance or static host → rules, `none` disables an inherited hook); the host is passed as `NETSSH_HOST`, `NETSSH_TARGET`, `NETSSH_INSTANCE`, `NETSSH_IP`, `NETSSH_KIND`, `NETSSH_TAGS`, `NETSSH_CLIENT`. Editable in `netssh configure`, also `NETSSH_SSH_PRE_CONNECT`. `--dry-run` shows it without running it.
|
||||||
|
- Add `shortcuts.show`: shows each host's shortcut alias (e.g. `fsnbx1` for `fsn1-bx1.hoster.de`) in the TUI and as an `ALIAS` column in `netssh cache list` and `netssh hosts list`, and offers shortcuts in Tab completion even when the full name matches. `--aliases` shows the column for a single call. Editable in `netssh configure`, also `NETSSH_SHORTCUTS_SHOW`.
|
||||||
|
|
||||||
|
## v0.0.25
|
||||||
|
|
||||||
|
- Security: `netssh.yaml` is read from the user config directory only. A file of that name in the working directory (e.g. of a cloned repository) was loaded when no user config existed, and could set ssh options such as `ProxyCommand` or a NetBox URL.
|
||||||
|
- Security: an address from NetBox or the cache that is neither an IP address nor a hostname is refused. A value such as `-oProxyCommand=…` was passed to ssh as an option.
|
||||||
|
- The resolver chain stops at an API failure instead of trying the next strategy. Before, a NetBox error in `management_subnet` or `interface_name` connected to the primary IP and cached it. A strategy that finds no address (including a missing interface) still falls through. Note: a token without permission to read IP addresses now gives an error instead of silently using `primary_ip`.
|
||||||
|
- `netssh --help` and `netssh -h` show netssh's help instead of `unknown option --help` and ssh's usage.
|
||||||
|
- Background cache refreshes are started at most every 5 minutes. While NetBox was unreachable, every command and every new shell started another one.
|
||||||
|
- `netbox.url` is validated like the URLs of named instances (HTTP or HTTPS, no query or fragment).
|
||||||
|
- Hosts with more than 100 IP addresses: all pages are read, so `management_subnet` no longer misses addresses.
|
||||||
|
- CI: tests, `go vet`, and a format check run on pull requests and pushes to `main`.
|
||||||
|
|
||||||
|
## v0.0.24
|
||||||
|
|
||||||
|
- Fix the `interface_name` resolver strategy: it sent filter names that NetBox ignores and therefore returned the host's first IP address instead of the named interface's. It now uses NetBox's `interface` and `vminterface` filters; a missing interface falls through to the next strategy.
|
||||||
|
- Fix `netssh sftp` and `netssh scp` with instance-qualified hosts (`prod/web01:/path`), which were taken for local paths.
|
||||||
|
- Fix shell aliases of instance-qualified hosts ignoring anchored rewrite rules (`fsn_fsn1-pve1` instead of `fsn_fsnpve1`).
|
||||||
|
- Add `netssh multi` to open several hosts side by side in tmux or zellij: host lists, `tag:`, NetBox virtualization clusters (`cluster:`, devices by default, `--kind vm|all`), and groups from the config (`@name`). `--sync` sends typing to all panes; `netssh sync` toggles it later. In the TUI, `Space` marks hosts and `Enter` opens them together. Configurable in `netssh configure` (multiplexer, panes per window, groups).
|
||||||
|
- tmux keys for broadcast in `netssh multi` windows: prefix `S` toggles all panes, prefix `e` excludes the current pane (border `[SOLO]`) or includes it again; also `netssh sync --pane`. Both keys are unbound in a default tmux, are not bound if your tmux.conf uses them, act only in netssh windows, and can be changed or turned off (`multi.sync_key`, `multi.solo_key`).
|
||||||
|
- `netssh multi` widens the status bar of its own tmux session, which tmux otherwise cuts to `[netssh-pv`.
|
||||||
|
- Cache entries remember the NetBox cluster of a host, for `cluster:` completion and offline use.
|
||||||
|
- Add `testenv/`, a local Docker environment with two NetBox instances, SSH targets, a jump host, tmux, zellij, and bash/zsh/fish, and 185 end-to-end checks of all features, including `netssh multi` with real tmux and zellij and screenshot checks of what a real terminal (xterm) renders (`testenv/up.sh`, `testenv/test.sh`). Not part of CI/CD.
|
||||||
|
|
||||||
|
## v0.0.23
|
||||||
|
|
||||||
|
- `netssh configure` now covers every setting: after the instances, a menu opens with SSH defaults, SSH options (jump host, host key checking, connection target, address family, extra arguments, `-o` options), SSH rules (add, edit, remove by tag, instance, kind, name pattern), resolver & cache (including the cache file), shortcuts & command alias, and completion (`max_results`). SSH options can also be set per NetBox instance from the instance list.
|
||||||
|
- Fix `netssh configure` dropping global SSH options, `ssh.rules`, and `completion.max_results` from the config file when saving.
|
||||||
|
- The configurator validates SSH options and rules before writing the config.
|
||||||
|
- Add `shortcuts.rewrites`: regex rules that shorten hostnames, e.g. `^([a-z]+)[0-9]+-` → `$1` turns `fsn1-bx1.hoster.de` into `fsnbx1`. Shortcuts work for connecting, shell aliases, and Tab completion (offered when the full name does not match), and can be edited in `netssh configure`.
|
||||||
|
- Add `netssh alias --test HOSTNAME` to show the shortcut of a name and the cached hosts it matches.
|
||||||
|
- Add `netssh sftp` and `netssh scp`: host lookup, shortcuts, instances, default user and port, SSH options and rules, jump host, `--dry-run`, and completion work as for ssh. IPv6 addresses are bracketed for host:path.
|
||||||
|
- Add named port forwards (`ssh.forwards` globally, per instance, and per rule), `netssh tunnel HOST NAME|SPEC...` (ssh -N with ExitOnForwardFailure), and `netssh --forward NAME`. Forwards are editable in `netssh configure` and completed in the shell.
|
||||||
|
- TUI: `Ctrl+O` opens SFTP, `Ctrl+T` starts a tunnel with configured or ad hoc forwards.
|
||||||
|
- Add the `hostname` resolver strategy: connect by the NetBox name (plus optional `resolver.hostname_domain`) instead of an IP, always or as a fallback after `primary_ip`.
|
||||||
|
- Add static hosts (`hosts:`) for machines that are not in NetBox, with user, port, tags, and SSH options, managed with `netssh hosts list|add|remove` and in `netssh configure`. They are found before NetBox, work offline and without any NetBox, and support shortcuts, rules (`kind: static`), completion, aliases, sftp, scp, tunnels, and the TUI.
|
||||||
|
- Fix options added by netssh landing after `--` (`netssh --no-jump -- host`), where ssh read them as the destination.
|
||||||
|
|
||||||
## v0.0.22
|
## v0.0.22
|
||||||
|
|
||||||
- Fix shell completion with multiple NetBox instances: typing a hostname without an instance prefix (`fsn1-bx1<Tab>`) found nothing in bash and zsh, because only `prod/…` was offered. Hostnames that are unique across all instances are now offered without the prefix; connecting to them still checks every instance for ambiguous names.
|
- Fix shell completion with multiple NetBox instances: typing a hostname without an instance prefix (`fsn1-bx1<Tab>`) found nothing in bash and zsh, because only `prod/…` was offered. Hostnames that are unique across all instances are now offered without the prefix; connecting to them still checks every instance for ambiguous names.
|
||||||
|
|||||||
@@ -0,0 +1,191 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"os/signal"
|
||||||
|
"path/filepath"
|
||||||
|
"sync"
|
||||||
|
"syscall"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/runner"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/storage"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
)
|
||||||
|
|
||||||
|
type batchRetry struct {
|
||||||
|
Command string
|
||||||
|
Hosts []string
|
||||||
|
Extra []string
|
||||||
|
}
|
||||||
|
type batchResult struct {
|
||||||
|
Host string
|
||||||
|
Code int
|
||||||
|
}
|
||||||
|
|
||||||
|
var batchExecutable = os.Executable
|
||||||
|
|
||||||
|
func batchPath() string {
|
||||||
|
return filepath.Join(filepath.Dir(config.Path()), "netssh", "last-failed.json")
|
||||||
|
}
|
||||||
|
func batchCmd() *cobra.Command {
|
||||||
|
var parallel int
|
||||||
|
var retry, yes, dry bool
|
||||||
|
cmd := &cobra.Command{Use: "batch COMMAND HOST... [-- EXTRA_ARGS...]", Short: "Run a configured command on hosts with bounded parallelism", RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
if parallel < 1 || parallel > 64 {
|
||||||
|
return fmt.Errorf("parallel must be between 1 and 64")
|
||||||
|
}
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
work := batchRetry{}
|
||||||
|
if retry {
|
||||||
|
if len(args) > 0 {
|
||||||
|
return fmt.Errorf("--retry-failed takes no positional arguments")
|
||||||
|
}
|
||||||
|
data, err := os.ReadFile(batchPath())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err = json.Unmarshal(data, &work); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
split := cmd.ArgsLenAtDash()
|
||||||
|
if split >= 0 {
|
||||||
|
work.Extra = args[split:]
|
||||||
|
args = args[:split]
|
||||||
|
}
|
||||||
|
if len(args) < 2 {
|
||||||
|
return fmt.Errorf("specify COMMAND and at least one HOST")
|
||||||
|
}
|
||||||
|
work.Command, work.Hosts = args[0], args[1:]
|
||||||
|
}
|
||||||
|
command, ok := cfg.Commands[work.Command]
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("unknown command %q", work.Command)
|
||||||
|
}
|
||||||
|
if len(work.Hosts) == 0 {
|
||||||
|
fmt.Fprintln(cmd.OutOrStdout(), "No failed hosts to retry.")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
// Resolve and validate the entire list before launching any action.
|
||||||
|
var targets []string
|
||||||
|
seen := map[string]bool{}
|
||||||
|
for _, target := range work.Hosts {
|
||||||
|
h, err := resolveTargetE(cfg, target, false)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !command.Allowed(commandHost(h)) {
|
||||||
|
return fmt.Errorf("%s is not allowed on %s", work.Command, h.Name)
|
||||||
|
}
|
||||||
|
if !seen[h.Name] {
|
||||||
|
targets = append(targets, h.Name)
|
||||||
|
seen[h.Name] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if command.Confirm && !dry {
|
||||||
|
if err := confirmAction(fmt.Sprintf("Run %s on %d hosts", work.Command, len(targets)), yes); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
executable, err := batchExecutable()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
// Temporary output files bound memory even for very verbose commands.
|
||||||
|
dir, err := os.MkdirTemp("", "netssh-batch-")
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer os.RemoveAll(dir)
|
||||||
|
ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
|
||||||
|
defer cancel()
|
||||||
|
jobs := make(chan int)
|
||||||
|
results := make(chan batchResult, len(targets))
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
var output sync.Mutex
|
||||||
|
for n := 0; n < parallel; n++ {
|
||||||
|
wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
for i := range jobs {
|
||||||
|
host := targets[i]
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
results <- batchResult{host, 130}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
output.Lock()
|
||||||
|
fmt.Fprintf(cmd.OutOrStdout(), "[%s] starting\n", host)
|
||||||
|
output.Unlock()
|
||||||
|
f, err := os.CreateTemp(dir, "output-")
|
||||||
|
if err != nil {
|
||||||
|
results <- batchResult{host, 1}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
argv := []string{executable, "run", "--yes"}
|
||||||
|
if dry {
|
||||||
|
argv = append(argv, "--dry-run")
|
||||||
|
}
|
||||||
|
argv = append(argv, work.Command, "--", host)
|
||||||
|
argv = append(argv, work.Extra...)
|
||||||
|
r := runner.Run(ctx, argv, runner.Options{Stdout: f, Stderr: f})
|
||||||
|
f.Close()
|
||||||
|
output.Lock()
|
||||||
|
fmt.Fprintf(cmd.OutOrStdout(), "[%s] exit=%d duration=%s\n", host, r.Code, r.Duration.Round(time.Millisecond))
|
||||||
|
read, err := os.Open(f.Name())
|
||||||
|
if err == nil {
|
||||||
|
_, _ = io.Copy(cmd.OutOrStdout(), read)
|
||||||
|
read.Close()
|
||||||
|
}
|
||||||
|
output.Unlock()
|
||||||
|
results <- batchResult{host, r.Code}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
for i := range targets {
|
||||||
|
jobs <- i
|
||||||
|
}
|
||||||
|
close(jobs)
|
||||||
|
wg.Wait()
|
||||||
|
close(results)
|
||||||
|
failed := map[string]bool{}
|
||||||
|
for r := range results {
|
||||||
|
if r.Code != 0 {
|
||||||
|
failed[r.Host] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
work.Hosts = nil
|
||||||
|
for _, host := range targets {
|
||||||
|
if failed[host] {
|
||||||
|
work.Hosts = append(work.Hosts, host)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !dry {
|
||||||
|
data, _ := json.Marshal(work)
|
||||||
|
if err := os.MkdirAll(filepath.Dir(batchPath()), 0700); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := storage.WriteFile(batchPath(), data, 0600); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fmt.Fprintf(cmd.OutOrStdout(), "%d succeeded, %d failed\n", len(targets)-len(failed), len(failed))
|
||||||
|
if len(failed) > 0 {
|
||||||
|
return fmt.Errorf("batch failed; retry with netssh batch --retry-failed")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}}
|
||||||
|
cmd.Flags().IntVar(¶llel, "parallel", 4, "Maximum simultaneous hosts (1-64)")
|
||||||
|
cmd.Flags().BoolVar(&retry, "retry-failed", false, "Repeat failed targets from the last batch")
|
||||||
|
cmd.Flags().BoolVar(&yes, "yes", false, "Confirm the batch action")
|
||||||
|
cmd.Flags().BoolVar(&dry, "dry-run", false, "Resolve and print commands without running")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
@@ -0,0 +1,163 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
"text/tabwriter"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
|
"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/setup"
|
||||||
|
)
|
||||||
|
|
||||||
|
func hostsCmd() *cobra.Command {
|
||||||
|
var showAliases bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "hosts",
|
||||||
|
Short: "Manage static hosts that are not in NetBox",
|
||||||
|
Long: `Static hosts are defined under hosts: in the config. They are found before
|
||||||
|
NetBox, work offline, and support shortcuts, rules (kind: static), aliases,
|
||||||
|
completion, sftp, scp, and tunnels like NetBox hosts.`,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error { return listHosts(showAliases) },
|
||||||
|
}
|
||||||
|
cmd.AddCommand(hostsListCmd(), hostsAddCmd(), hostsRemoveCmd())
|
||||||
|
cmd.Flags().BoolVar(&showAliases, "aliases", false, "Show each host's shortcut alias (always on with shortcuts.show)")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func hostsListCmd() *cobra.Command {
|
||||||
|
var showAliases bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "list",
|
||||||
|
Short: "List static hosts",
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error { return listHosts(showAliases) },
|
||||||
|
}
|
||||||
|
cmd.Flags().BoolVar(&showAliases, "aliases", false, "Show each host's shortcut alias (always on with shortcuts.show)")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func listHosts(showAliases bool) error {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if len(cfg.Hosts) == 0 {
|
||||||
|
fmt.Println("No static hosts. Add one with: netssh hosts add NAME ADDRESS")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
withAliases := showAliases || cfg.Shortcuts.Show
|
||||||
|
var aliases map[string]string
|
||||||
|
if withAliases {
|
||||||
|
// Aliases are unique across all hosts, so compute them with the cache.
|
||||||
|
c := newCache(cfg)
|
||||||
|
_ = c.Load()
|
||||||
|
aliases = shortcutAliases(c.All(), *cfg)
|
||||||
|
}
|
||||||
|
w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
|
||||||
|
if withAliases {
|
||||||
|
fmt.Fprintln(w, "NAME\tALIAS\tADDRESS\tUSER\tPORT\tTAGS")
|
||||||
|
} else {
|
||||||
|
fmt.Fprintln(w, "NAME\tADDRESS\tUSER\tPORT\tTAGS")
|
||||||
|
}
|
||||||
|
for _, host := range cfg.Hosts {
|
||||||
|
port := ""
|
||||||
|
if host.Port > 0 {
|
||||||
|
port = fmt.Sprint(host.Port)
|
||||||
|
}
|
||||||
|
if withAliases {
|
||||||
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\t%s\n", host.Name, orDash(aliases[strings.ToLower(host.Name)]), host.Address, host.User, port, strings.Join(host.Tags, ","))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\n", host.Name, host.Address, host.User, port, strings.Join(host.Tags, ","))
|
||||||
|
}
|
||||||
|
return w.Flush()
|
||||||
|
}
|
||||||
|
|
||||||
|
func hostsAddCmd() *cobra.Command {
|
||||||
|
var host config.StaticHost
|
||||||
|
var replace bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "add NAME ADDRESS",
|
||||||
|
Short: "Add a static host (or replace one with --replace)",
|
||||||
|
Example: ` netssh hosts add router 192.168.1.1 --user admin
|
||||||
|
netssh hosts add backup backup.example.org --port 2222 --tag offsite`,
|
||||||
|
Args: cobra.ExactArgs(2),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
host.Name, host.Address = args[0], args[1]
|
||||||
|
if existing := cfg.StaticHost(host.Name); existing != nil {
|
||||||
|
if !replace {
|
||||||
|
return fmt.Errorf("static host %q already exists; use --replace to overwrite it", existing.Name)
|
||||||
|
}
|
||||||
|
host.SSH = existing.SSH // keep SSH options set in the config or wizard
|
||||||
|
*existing = host
|
||||||
|
} else {
|
||||||
|
cfg.Hosts = append(cfg.Hosts, host)
|
||||||
|
}
|
||||||
|
return saveHosts(cfg)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.Flags().StringVar(&host.User, "user", "", "Login user (default: ssh.default_user)")
|
||||||
|
cmd.Flags().IntVar(&host.Port, "port", 0, "SSH port (default: ssh.default_port or 22)")
|
||||||
|
cmd.Flags().StringSliceVar(&host.Tags, "tag", nil, "Tag for ssh.rules (repeatable)")
|
||||||
|
cmd.Flags().BoolVar(&replace, "replace", false, "Overwrite an existing static host")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func hostsRemoveCmd() *cobra.Command {
|
||||||
|
return &cobra.Command{
|
||||||
|
Use: "remove NAME",
|
||||||
|
Aliases: []string{"rm"},
|
||||||
|
Short: "Remove a static host",
|
||||||
|
Args: cobra.ExactArgs(1),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for i, host := range cfg.Hosts {
|
||||||
|
if strings.EqualFold(host.Name, args[0]) {
|
||||||
|
cfg.Hosts = append(cfg.Hosts[:i], cfg.Hosts[i+1:]...)
|
||||||
|
return saveHosts(cfg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return fmt.Errorf("no static host %q", args[0])
|
||||||
|
},
|
||||||
|
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil || len(args) > 0 {
|
||||||
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
var names []string
|
||||||
|
for _, host := range cfg.Hosts {
|
||||||
|
if strings.HasPrefix(strings.ToLower(host.Name), strings.ToLower(toComplete)) {
|
||||||
|
names = append(names, host.Name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return names, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// saveHosts writes the config and regenerates the shell aliases.
|
||||||
|
func saveHosts(cfg *config.Config) error {
|
||||||
|
if err := setup.Save(*cfg); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
loaded, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
c := newCache(loaded)
|
||||||
|
_ = c.Load()
|
||||||
|
if err := hook.WriteAliasFiles(hook.BuildAliasEntries(c.All(), *loaded)); err != nil {
|
||||||
|
fmt.Fprintf(os.Stderr, "warning: could not write alias files: %v\n", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,130 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
// prepareConfig writes data as the only config, with empty cache and home.
|
||||||
|
func prepareConfig(t *testing.T, data string) string {
|
||||||
|
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", "")
|
||||||
|
path := filepath.Join(dir, "netssh.yaml")
|
||||||
|
if err := os.WriteFile(path, []byte(data), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return path
|
||||||
|
}
|
||||||
|
|
||||||
|
const staticOnlyConfig = `ssh:
|
||||||
|
default_user: ops
|
||||||
|
rules:
|
||||||
|
- match: {kind: static, tag: home}
|
||||||
|
host_key_checking: accept-new
|
||||||
|
shortcuts:
|
||||||
|
domains: [.lan]
|
||||||
|
hosts:
|
||||||
|
- name: router.lan
|
||||||
|
address: 192.168.1.1
|
||||||
|
user: admin
|
||||||
|
port: 2222
|
||||||
|
tags: [home]
|
||||||
|
- name: nas
|
||||||
|
address: nas.example.org
|
||||||
|
ssh:
|
||||||
|
proxy_jump: jh.example.com
|
||||||
|
`
|
||||||
|
|
||||||
|
// Static hosts work without any NetBox and with their own user, port, tags, and options.
|
||||||
|
func TestStaticHostsWithoutNetBox(t *testing.T) {
|
||||||
|
prepareConfig(t, staticOnlyConfig)
|
||||||
|
for _, tc := range []struct {
|
||||||
|
args []string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{[]string{"--dry-run", "router.lan"}, "ssh -p 2222 -l admin -o StrictHostKeyChecking=accept-new 192.168.1.1"},
|
||||||
|
{[]string{"--dry-run", "router"}, "ssh -p 2222 -l admin -o StrictHostKeyChecking=accept-new 192.168.1.1"}, // shortcut
|
||||||
|
{[]string{"--dry-run", "-l", "root", "nas", "uptime"}, "ssh -l root -J jh.example.com nas.example.org uptime"},
|
||||||
|
{[]string{"sftp", "--dry-run", "router:/etc"}, "sftp -P 2222 -o User=admin -o StrictHostKeyChecking=accept-new 192.168.1.1:/etc"},
|
||||||
|
{[]string{"scp", "--dry-run", "a.txt", "nas:/tmp/"}, "scp -o User=ops -J jh.example.com a.txt nas.example.org:/tmp/"},
|
||||||
|
} {
|
||||||
|
out, err := runNetssh(t, tc.args...)
|
||||||
|
if err != nil || out != tc.want {
|
||||||
|
t.Errorf("%v:\n got %s (%v)\n want %s", tc.args, out, err, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if out, err := runNetssh(t, "--dry-run", "unknown"); err == nil || !strings.Contains(out, "no NetBox is configured") {
|
||||||
|
t.Errorf("unknown host: %s (%v)", out, err)
|
||||||
|
}
|
||||||
|
if out, _ := runNetssh(t, "__complete", "rou"); !strings.HasPrefix(out, "router.lan\n") {
|
||||||
|
t.Errorf("completion: %q", out)
|
||||||
|
}
|
||||||
|
if out, _ := runNetssh(t, "alias", "--shell", "bash"); !strings.Contains(out, "alias router='netssh router.lan'") || !strings.Contains(out, "alias nas='netssh nas'") {
|
||||||
|
t.Errorf("aliases: %s", out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHostsCommand(t *testing.T) {
|
||||||
|
path := prepareConfig(t, "hosts:\n - {name: nas, address: nas.example.org, ssh: {proxy_jump: jh}}\n")
|
||||||
|
steps := []struct {
|
||||||
|
args []string
|
||||||
|
wantErr string
|
||||||
|
}{
|
||||||
|
{[]string{"hosts", "add", "router", "192.168.1.1", "--user", "admin", "--port", "2222", "--tag", "home", "--tag", "lab"}, ""},
|
||||||
|
{[]string{"hosts", "add", "router", "10.0.0.1"}, "already exists"},
|
||||||
|
{[]string{"hosts", "add", "nas", "10.0.0.5", "--replace"}, ""},
|
||||||
|
{[]string{"hosts", "add", "bad name", "10.0.0.1"}, "must start with"},
|
||||||
|
{[]string{"hosts", "remove", "missing"}, "no static host"},
|
||||||
|
}
|
||||||
|
for _, step := range steps {
|
||||||
|
out, err := runNetssh(t, step.args...)
|
||||||
|
if step.wantErr == "" && err != nil || step.wantErr != "" && !strings.Contains(out, step.wantErr) {
|
||||||
|
t.Fatalf("%v: %s (%v)", step.args, out, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
router, nas := cfg.StaticHost("router"), cfg.StaticHost("nas")
|
||||||
|
if router == nil || router.User != "admin" || router.Port != 2222 || strings.Join(router.Tags, ",") != "home,lab" {
|
||||||
|
t.Fatalf("router: %+v", router)
|
||||||
|
}
|
||||||
|
if nas == nil || nas.Address != "10.0.0.5" || nas.SSH.ProxyJump != "jh" {
|
||||||
|
t.Fatalf("--replace must keep SSH options: %+v", nas)
|
||||||
|
}
|
||||||
|
out, err := runNetssh(t, "hosts", "list")
|
||||||
|
if err != nil || !strings.Contains(out, "router 192.168.1.1 admin 2222 home,lab") {
|
||||||
|
t.Fatalf("list:\n%s (%v)", out, err)
|
||||||
|
}
|
||||||
|
if out, err := runNetssh(t, "hosts", "rm", "router"); err != nil {
|
||||||
|
t.Fatalf("remove: %s (%v)", out, err)
|
||||||
|
}
|
||||||
|
data, _ := os.ReadFile(path)
|
||||||
|
if strings.Contains(string(data), "router") || strings.Contains(string(data), "netbox:") {
|
||||||
|
t.Fatalf("config after remove:\n%s", data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The hostname strategy passes the NetBox name (plus domain) instead of an IP.
|
||||||
|
func TestHostnameStrategyConnects(t *testing.T) {
|
||||||
|
srv := connectionTestServer(t, []connectionTestHost{{ID: 1, Name: "web01"}, multiHost("db01", "10.0.0.7")}, nil)
|
||||||
|
prepareConfig(t, fmt.Sprintf("netbox:\n url: %q\n token: t\nresolver:\n strategies: [primary_ip, hostname]\n hostname_domain: example.com\n", srv.URL))
|
||||||
|
for host, want := range map[string]string{"web01": "ssh web01.example.com", "db01": "ssh 10.0.0.7"} {
|
||||||
|
if out, err := runNetssh(t, "--dry-run", host); err != nil || out != want {
|
||||||
|
t.Errorf("%s: got %s (%v), want %s", host, out, err, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+100
-6
@@ -6,10 +6,16 @@ import (
|
|||||||
|
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
|
"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/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/netbox"
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/shortcuts"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/shortcuts"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// newCache opens the host cache with the config's static hosts.
|
||||||
|
func newCache(cfg *config.Config) *cache.Cache {
|
||||||
|
return cache.New(cfg.CachePath(), cfg.Cache.TTL).WithStatic(cfg.Hosts)
|
||||||
|
}
|
||||||
|
|
||||||
func newNetBoxClient(cfg *config.Config) *netbox.Client {
|
func newNetBoxClient(cfg *config.Config) *netbox.Client {
|
||||||
if len(cfg.NetBoxes) > 0 {
|
if len(cfg.NetBoxes) > 0 {
|
||||||
sources := make([]netbox.Source, 0, len(cfg.NetBoxes))
|
sources := make([]netbox.Source, 0, len(cfg.NetBoxes))
|
||||||
@@ -24,6 +30,28 @@ func newNetBoxClient(cfg *config.Config) *netbox.Client {
|
|||||||
return netbox.NewClient(cfg.NetBox.URL, cfg.NetBox.Token, cfg.NetBox.TokenVersion)
|
return netbox.NewClient(cfg.NetBox.URL, cfg.NetBox.Token, cfg.NetBox.TokenVersion)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// shortcutAliases maps each target (lowercased) to the shell alias generated for
|
||||||
|
// it, but only where shortcuts actually shorten the displayed name: an alias that
|
||||||
|
// merely replaces dots with underscores ("web01_example_com") adds nothing.
|
||||||
|
// The aliases are the same ones netssh alias and the shell hook define.
|
||||||
|
func shortcutAliases(entries []cache.Entry, cfg config.Config) map[string]string {
|
||||||
|
out := make(map[string]string)
|
||||||
|
if !cfg.Shortcuts.Enabled() {
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
plain := strings.NewReplacer(".", "_", "/", "_")
|
||||||
|
for _, alias := range hook.BuildAliasEntries(append([]cache.Entry(nil), entries...), cfg) {
|
||||||
|
if alias.Host == "" || alias.Command != "" {
|
||||||
|
continue // the command alias for netssh itself
|
||||||
|
}
|
||||||
|
if alias.Name == plain.Replace(strings.ToLower(cfg.HostLabel(alias.Host))) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
out[strings.ToLower(alias.Host)] = alias.Name
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
func normalizeTarget(cfg config.ShortcutsConfig, qualified bool) func(string) string {
|
func normalizeTarget(cfg config.ShortcutsConfig, qualified bool) func(string) string {
|
||||||
return func(target string) string {
|
return func(target string) string {
|
||||||
source, name := netbox.SplitTarget(target)
|
source, name := netbox.SplitTarget(target)
|
||||||
@@ -41,7 +69,12 @@ func normalizeTarget(cfg config.ShortcutsConfig, qualified bool) func(string) st
|
|||||||
// all instances is offered bare ("web01"), so it completes like with a single
|
// all instances is offered bare ("web01"), so it completes like with a single
|
||||||
// NetBox; connecting to it still checks every instance for ambiguity.
|
// NetBox; connecting to it still checks every instance for ambiguity.
|
||||||
// Names present in several instances stay qualified ("prod/web01").
|
// Names present in several instances stay qualified ("prod/web01").
|
||||||
func hostCompletions(entries []cache.Entry, toComplete string) []string {
|
// Hosts whose full name does not match are offered by their configured
|
||||||
|
// shortcut instead ("fsnb" → "fsnbx1" for fsn1-bx1.example.com).
|
||||||
|
//
|
||||||
|
// With shortcuts.show, shortcuts are also offered for hosts whose full name
|
||||||
|
// matches, so "fsn" lists both fsn1-bx1.example.com and fsnbx1.
|
||||||
|
func hostCompletions(entries []cache.Entry, toComplete string, sc config.ShortcutsConfig) []string {
|
||||||
prefix := strings.ToLower(toComplete)
|
prefix := strings.ToLower(toComplete)
|
||||||
qualifiedInput := strings.Contains(prefix, "/")
|
qualifiedInput := strings.Contains(prefix, "/")
|
||||||
instances := make(map[string]int)
|
instances := make(map[string]int)
|
||||||
@@ -49,21 +82,82 @@ func hostCompletions(entries []cache.Entry, toComplete string) []string {
|
|||||||
_, name := netbox.SplitTarget(e.Name)
|
_, name := netbox.SplitTarget(e.Name)
|
||||||
instances[strings.ToLower(name)]++
|
instances[strings.ToLower(name)]++
|
||||||
}
|
}
|
||||||
var out []string
|
var unmatched []cache.Entry
|
||||||
|
var names []string
|
||||||
for _, e := range entries {
|
for _, e := range entries {
|
||||||
source, name := netbox.SplitTarget(e.Name)
|
source, name := netbox.SplitTarget(e.Name)
|
||||||
target := strings.ToLower(e.Name)
|
target := strings.ToLower(e.Name)
|
||||||
switch {
|
switch {
|
||||||
case source != "" && !qualifiedInput && strings.HasPrefix(strings.ToLower(name), prefix):
|
case source != "" && !qualifiedInput && strings.HasPrefix(strings.ToLower(name), prefix):
|
||||||
if instances[strings.ToLower(name)] == 1 {
|
if instances[strings.ToLower(name)] == 1 {
|
||||||
out = append(out, name)
|
names = append(names, name)
|
||||||
} else {
|
} else {
|
||||||
out = append(out, e.Name)
|
names = append(names, e.Name)
|
||||||
}
|
}
|
||||||
case strings.HasPrefix(target, prefix):
|
case strings.HasPrefix(target, prefix):
|
||||||
out = append(out, e.Name)
|
names = append(names, e.Name)
|
||||||
|
default:
|
||||||
|
unmatched = append(unmatched, e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if sc.Enabled() {
|
||||||
|
candidates := unmatched
|
||||||
|
if sc.Show {
|
||||||
|
candidates = entries
|
||||||
|
}
|
||||||
|
offered := make(map[string]bool, len(names))
|
||||||
|
for _, name := range names {
|
||||||
|
offered[strings.ToLower(name)] = true
|
||||||
|
}
|
||||||
|
for _, name := range shortcutCompletions(entries, candidates, prefix, sc) {
|
||||||
|
if !offered[name] {
|
||||||
|
offered[name] = true
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
return names
|
||||||
|
}
|
||||||
|
|
||||||
|
// shortcutCompletions offers the shortcut of each unmatched host when it starts
|
||||||
|
// with prefix and selects exactly one host, qualified by instance if needed.
|
||||||
|
func shortcutCompletions(all, unmatched []cache.Entry, prefix string, sc config.ShortcutsConfig) []string {
|
||||||
|
bare := make(map[string]int)
|
||||||
|
qualified := make(map[string]int)
|
||||||
|
short := func(e cache.Entry) (string, string) {
|
||||||
|
source, name := netbox.SplitTarget(e.Name)
|
||||||
|
s := shortcuts.Normalize(name, sc)
|
||||||
|
if source == "" {
|
||||||
|
return s, s
|
||||||
|
}
|
||||||
|
return s, strings.ToLower(source) + "/" + s
|
||||||
|
}
|
||||||
|
for _, e := range all {
|
||||||
|
b, q := short(e)
|
||||||
|
bare[b]++
|
||||||
|
qualified[q]++
|
||||||
|
}
|
||||||
|
seen := make(map[string]bool)
|
||||||
|
var out []string
|
||||||
|
for _, e := range unmatched {
|
||||||
|
b, q := short(e)
|
||||||
|
candidate := ""
|
||||||
|
switch {
|
||||||
|
case strings.Contains(prefix, "/"):
|
||||||
|
if qualified[q] == 1 && strings.HasPrefix(q, prefix) {
|
||||||
|
candidate = q
|
||||||
|
}
|
||||||
|
case !strings.HasPrefix(b, prefix):
|
||||||
|
case bare[b] == 1:
|
||||||
|
candidate = b
|
||||||
|
case q != b && qualified[q] == 1:
|
||||||
|
candidate = q // like full names: zsh accepts it, bash/fish ignore it
|
||||||
|
}
|
||||||
|
if candidate != "" && !seen[candidate] {
|
||||||
|
seen[candidate] = true
|
||||||
|
out = append(out, candidate)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
sort.Strings(out)
|
|
||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
@@ -228,12 +228,92 @@ func TestHostCompletionsMatchTypedText(t *testing.T) {
|
|||||||
// An instance name typed without the slash completes qualified targets.
|
// An instance name typed without the slash completes qualified targets.
|
||||||
{"st", []string{"stg/fsn1-bx2.example.com", "stg/hel1-tb1.example.com"}},
|
{"st", []string{"stg/fsn1-bx2.example.com", "stg/hel1-tb1.example.com"}},
|
||||||
} {
|
} {
|
||||||
if got := hostCompletions(entries, tc.input); !reflect.DeepEqual(got, tc.want) {
|
if got := hostCompletions(entries, tc.input, config.ShortcutsConfig{}); !reflect.DeepEqual(got, tc.want) {
|
||||||
t.Errorf("%q: got %v, want %v", tc.input, got, tc.want)
|
t.Errorf("%q: got %v, want %v", tc.input, got, tc.want)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// Single-instance caches are unchanged.
|
// Single-instance caches are unchanged.
|
||||||
if got := hostCompletions([]cache.Entry{{Name: "web01"}, {Name: "db01"}}, "w"); !reflect.DeepEqual(got, []string{"web01"}) {
|
if got := hostCompletions([]cache.Entry{{Name: "web01"}, {Name: "db01"}}, "w", config.ShortcutsConfig{}); !reflect.DeepEqual(got, []string{"web01"}) {
|
||||||
t.Errorf("single instance: %v", got)
|
t.Errorf("single instance: %v", got)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var fsnRewrite = config.ShortcutsConfig{
|
||||||
|
Domains: []string{".hoster.de"},
|
||||||
|
Rewrites: []config.ShortcutRewrite{{Pattern: `^([a-z]+)[0-9]+-`, Replace: "$1"}},
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHostCompletionsOfferShortcuts(t *testing.T) {
|
||||||
|
entries := []cache.Entry{
|
||||||
|
{Name: "prod/fsn1-bx1.hoster.de"},
|
||||||
|
{Name: "prod/fsn1-db1.hoster.de"},
|
||||||
|
{Name: "stg/fsn1-db1.hoster.de"},
|
||||||
|
{Name: "prod/web01.hoster.de"},
|
||||||
|
}
|
||||||
|
for _, tc := range []struct {
|
||||||
|
input string
|
||||||
|
want []string
|
||||||
|
}{
|
||||||
|
{"fsnb", []string{"fsnbx1"}},
|
||||||
|
// Shortcut shared by two instances stays qualified.
|
||||||
|
{"fsnd", []string{"prod/fsndb1", "stg/fsndb1"}},
|
||||||
|
{"prod/fsn", []string{"prod/fsn1-bx1.hoster.de", "prod/fsn1-db1.hoster.de"}},
|
||||||
|
{"stg/fsnd", []string{"stg/fsndb1"}},
|
||||||
|
// A matching full name is not repeated as shortcut.
|
||||||
|
{"web", []string{"web01.hoster.de"}},
|
||||||
|
} {
|
||||||
|
if got := hostCompletions(entries, tc.input, fsnRewrite); !reflect.DeepEqual(got, tc.want) {
|
||||||
|
t.Errorf("%q: got %v, want %v", tc.input, got, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Two hosts of the same instance with one shortcut cannot be selected by it.
|
||||||
|
same := []cache.Entry{{Name: "fsn1-bx1.hoster.de"}, {Name: "fsn2-bx1.hoster.de"}}
|
||||||
|
if got := hostCompletions(same, "fsnb", fsnRewrite); len(got) != 0 {
|
||||||
|
t.Errorf("ambiguous shortcut offered: %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestShortcutTestOutput(t *testing.T) {
|
||||||
|
var out bytes.Buffer
|
||||||
|
printShortcutTest(&out, "fsn1-bx1.hoster.de", []cache.Entry{{Name: "fsn1-bx1.hoster.de"}, {Name: "fsn2-bx1.hoster.de"}, {Name: "web01.hoster.de"}}, fsnRewrite)
|
||||||
|
want := "fsn1-bx1.hoster.de → fsnbx1\nambiguous, matches 2 hosts:\n fsn1-bx1.hoster.de\n fsn2-bx1.hoster.de\n"
|
||||||
|
if out.String() != want {
|
||||||
|
t.Fatalf("got:\n%s", out.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Rewrite rules alone must enable the shortcut lookup; NetBox is unreachable,
|
||||||
|
// so only the cached host can answer.
|
||||||
|
func TestWrapperConnectsByRewriteShortcut(t *testing.T) {
|
||||||
|
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 := "netbox:\n url: http://127.0.0.1:1\n token: t\nshortcuts:\n rewrites:\n - pattern: '^([a-z]+)[0-9]+-'\n replace: '$1'\n"
|
||||||
|
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)
|
||||||
|
}
|
||||||
|
c := cache.New(cfg.CachePath(), 3600)
|
||||||
|
c.Upsert(cache.Entry{Name: "fsn1-bx1.hoster.de", IP: "10.0.0.9", Kind: "device"})
|
||||||
|
if err := c.Save(); 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)
|
||||||
|
}
|
||||||
|
cmd := exec.Command(os.Args[0], "-test.run=^TestMultiInstanceWrapperHelper$")
|
||||||
|
cmd.Env = append(os.Environ(), "NETSSH_TEST_MULTI_TARGET=fsnbx1.hoster.de", "PATH="+bin+":"+os.Getenv("PATH"))
|
||||||
|
out, err := cmd.CombinedOutput()
|
||||||
|
if err != nil || !strings.Contains(string(out), "10.0.0.9\n") {
|
||||||
|
t.Fatalf("shortcut not resolved from cache: %s, %v", out, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
+435
-102
@@ -17,6 +17,7 @@ import (
|
|||||||
tea "charm.land/bubbletea/v2"
|
tea "charm.land/bubbletea/v2"
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/activity"
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
|
"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/config"
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/hook"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/hook"
|
||||||
@@ -30,6 +31,7 @@ import (
|
|||||||
|
|
||||||
// managedSubcommands are dispatched to cobra; everything else is treated as SSH wrapper mode.
|
// managedSubcommands are dispatched to cobra; everything else is treated as SSH wrapper mode.
|
||||||
var managedSubcommands = map[string]bool{
|
var managedSubcommands = map[string]bool{
|
||||||
|
"doctor": true, "explain": true, "favorites": true, "history": true, "batch": true, "config": true,
|
||||||
"configure": true,
|
"configure": true,
|
||||||
"notes": true,
|
"notes": true,
|
||||||
"search": true,
|
"search": true,
|
||||||
@@ -42,6 +44,13 @@ var managedSubcommands = map[string]bool{
|
|||||||
"help": true,
|
"help": true,
|
||||||
"version": true,
|
"version": true,
|
||||||
"uninstall": true,
|
"uninstall": true,
|
||||||
|
"sftp": true,
|
||||||
|
"scp": true,
|
||||||
|
"tunnel": true,
|
||||||
|
"hosts": true,
|
||||||
|
"multi": true,
|
||||||
|
"sync": true,
|
||||||
|
"run": true,
|
||||||
}
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
@@ -56,8 +65,22 @@ func main() {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ssh has neither option, so both can only mean netssh's own help.
|
||||||
|
if args[0] == "--help" || args[0] == "-h" {
|
||||||
|
root := rootCmd()
|
||||||
|
root.SetArgs([]string{"help"})
|
||||||
|
if err := root.Execute(); err != nil {
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
if managedSubcommands[args[0]] {
|
if managedSubcommands[args[0]] {
|
||||||
if err := rootCmd().Execute(); err != nil {
|
if err := rootCmd().Execute(); err != nil {
|
||||||
|
var exit *commandExit
|
||||||
|
if errors.As(err, &exit) {
|
||||||
|
os.Exit(exit.code)
|
||||||
|
}
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
return
|
return
|
||||||
@@ -72,7 +95,7 @@ func loadConfigOrSetup() *config.Config {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
fatalf("config: %v", err)
|
fatalf("config: %v", err)
|
||||||
}
|
}
|
||||||
if !cfg.HasNetBox() {
|
if !cfg.HasHosts() {
|
||||||
fmt.Fprintln(os.Stderr, "No configuration found. Starting setup…")
|
fmt.Fprintln(os.Stderr, "No configuration found. Starting setup…")
|
||||||
if err := setup.RunWizard(cfg); err != nil {
|
if err := setup.RunWizard(cfg); err != nil {
|
||||||
fatalf("setup: %v", err)
|
fatalf("setup: %v", err)
|
||||||
@@ -91,60 +114,178 @@ func runSSHWrapper(args []string) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
fatalf("%v", err)
|
fatalf("%v", err)
|
||||||
}
|
}
|
||||||
cfg := loadConfigOrSetup()
|
runClient(internalssh.SSH, flags, args)
|
||||||
|
}
|
||||||
|
|
||||||
parsed := internalssh.Parse(args)
|
// destination is the NetBox host named in the arguments of a client.
|
||||||
|
type destination struct {
|
||||||
|
host string
|
||||||
|
user string
|
||||||
|
dests []int // argument indices naming the host; several only for scp
|
||||||
|
}
|
||||||
|
|
||||||
|
func findDestination(client internalssh.Client, args []string) (*destination, error) {
|
||||||
|
if client.Name == internalssh.SCP.Name {
|
||||||
|
operands, err := client.Operands(args)
|
||||||
|
if err != nil || len(operands) == 0 {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
dest := &destination{host: operands[0].Host}
|
||||||
|
for _, operand := range operands {
|
||||||
|
dest.dests = append(dest.dests, operand.Idx)
|
||||||
|
if operand.User != "" {
|
||||||
|
dest.user = operand.User
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return dest, nil
|
||||||
|
}
|
||||||
|
parsed := client.Parse(args)
|
||||||
if parsed == nil {
|
if parsed == nil {
|
||||||
// No destination found — pass arguments straight through to ssh.
|
return nil, nil
|
||||||
execSSH(internalssh.Result{Args: args}, flags)
|
}
|
||||||
|
return &destination{host: parsed.Host, user: parsed.User, dests: []int{parsed.DestIdx}}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// runClient resolves the NetBox host in args and execs ssh, sftp, or scp.
|
||||||
|
func runClient(client internalssh.Client, flags internalssh.WrapperFlags, args []string) {
|
||||||
|
cfg := loadConfigOrSetup()
|
||||||
|
client = client.WithInstances(instanceNames(cfg))
|
||||||
|
|
||||||
|
dest, err := findDestination(client, args)
|
||||||
|
if err != nil {
|
||||||
|
fatalf("%v", err)
|
||||||
|
}
|
||||||
|
if dest == nil {
|
||||||
|
if len(flags.Forwards) > 0 {
|
||||||
|
fatalf("--forward needs a destination host")
|
||||||
|
}
|
||||||
|
// No destination found — pass arguments straight through.
|
||||||
|
execClient(client, internalssh.Result{Args: args}, flags)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
connect := func(name, kind, ip string, tags []string) {
|
|
||||||
connectHost(cfg, flags, name, kind, ip, tags, parsed.DestIdx, args)
|
host := resolveTarget(cfg, dest.host)
|
||||||
|
user, port := hostDefaults(cfg, host)
|
||||||
|
// Inject the default user if none was given on the command line.
|
||||||
|
if user != "" && dest.user == "" && !client.HasUserFlag(args) {
|
||||||
|
args = prependArgs(client.UserArgs(user), args, dest.dests)
|
||||||
|
}
|
||||||
|
// Inject the default port if none was given on the command line.
|
||||||
|
if port > 0 && !client.HasPortFlag(args) {
|
||||||
|
args = prependArgs(client.PortArgs(strconv.Itoa(port)), args, dest.dests)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Inject the configured default user if none was given on the command line.
|
connectHost(cfg, client, flags, host, dest.dests, args)
|
||||||
if cfg.SSH.DefaultUser != "" && parsed.User == "" && !internalssh.HasUserFlag(args) {
|
|
||||||
args = append([]string{"-l", cfg.SSH.DefaultUser}, args...)
|
|
||||||
parsed.DestIdx += 2
|
|
||||||
}
|
|
||||||
// Inject the configured default port if none was given on the command line.
|
|
||||||
if cfg.SSH.DefaultPort > 0 && !internalssh.HasPortFlag(args) {
|
|
||||||
args = append([]string{"-p", strconv.Itoa(cfg.SSH.DefaultPort)}, args...)
|
|
||||||
parsed.DestIdx += 2
|
|
||||||
}
|
}
|
||||||
|
|
||||||
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
|
// hostDefaults returns the login user and port for host: those of a static
|
||||||
|
// host if set, else ssh.default_user and ssh.default_port.
|
||||||
|
func hostDefaults(cfg *config.Config, host resolvedHost) (string, int) {
|
||||||
|
user, port := cfg.SSH.DefaultUser, cfg.SSH.DefaultPort
|
||||||
|
if host.Kind == config.StaticKind {
|
||||||
|
if static := cfg.StaticHost(host.Name); static != nil {
|
||||||
|
if static.User != "" {
|
||||||
|
user = static.User
|
||||||
|
}
|
||||||
|
if static.Port > 0 {
|
||||||
|
port = static.Port
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return user, port
|
||||||
|
}
|
||||||
|
|
||||||
|
// instanceNames lists the named NetBox instances, which may prefix hostnames.
|
||||||
|
func instanceNames(cfg *config.Config) []string {
|
||||||
|
names := make([]string, 0, len(cfg.NetBoxes))
|
||||||
|
for _, source := range cfg.NetBoxes {
|
||||||
|
names = append(names, source.Name)
|
||||||
|
}
|
||||||
|
return names
|
||||||
|
}
|
||||||
|
|
||||||
|
// prependArgs puts extra before args and shifts the destination indices.
|
||||||
|
func prependArgs(extra, args []string, dests []int) []string {
|
||||||
|
for i := range dests {
|
||||||
|
dests[i] += len(extra)
|
||||||
|
}
|
||||||
|
return append(append([]string(nil), extra...), args...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// resolvedHost is a NetBox host with the address to connect to.
|
||||||
|
type resolvedHost struct {
|
||||||
|
Origin string
|
||||||
|
Resolver string
|
||||||
|
CachedAt time.Time
|
||||||
|
Name string // cache/selector name, may carry an instance prefix
|
||||||
|
Kind string
|
||||||
|
IP string
|
||||||
|
Tags []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// resolveTarget finds host in the cache (also by shortcut) or NetBox and
|
||||||
|
// resolves its address. It exits on failure.
|
||||||
|
func resolveTarget(cfg *config.Config, host string) resolvedHost {
|
||||||
|
result, err := resolveTargetE(cfg, host, true)
|
||||||
|
if err != nil {
|
||||||
|
fatalf("%v", err)
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
func resolveTargetE(cfg *config.Config, host string, record bool) (resolvedHost, error) {
|
||||||
|
c := newCache(cfg)
|
||||||
_ = c.Load()
|
_ = c.Load()
|
||||||
|
if record {
|
||||||
maybeBackgroundRefresh(cfg, c)
|
maybeBackgroundRefresh(cfg, c)
|
||||||
|
}
|
||||||
|
|
||||||
source, _ := netbox.SplitTarget(parsed.Host)
|
source, _ := netbox.SplitTarget(host)
|
||||||
useCache := len(cfg.NetBoxes) == 0 || source != ""
|
useCache := len(cfg.NetBoxes) == 0 || source != ""
|
||||||
|
used := func(entry cache.Entry) resolvedHost {
|
||||||
|
if record {
|
||||||
|
c.MarkUsed(entry.Name)
|
||||||
|
_ = c.Save()
|
||||||
|
}
|
||||||
|
origin := "cache"
|
||||||
|
if entry.Static {
|
||||||
|
origin = "static"
|
||||||
|
}
|
||||||
|
return resolvedHost{Name: entry.Name, Kind: entry.Kind, IP: entry.IP, Tags: entry.Tags, Origin: origin, Resolver: entry.Resolver, CachedAt: entry.CachedAt}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Static hosts from the config win and need no NetBox.
|
||||||
|
if source == "" {
|
||||||
|
var normalize func(string) string
|
||||||
|
if cfg.Shortcuts.Enabled() {
|
||||||
|
normalize = normalizeTarget(cfg.Shortcuts, false)
|
||||||
|
}
|
||||||
|
entry, found, err := c.GetStatic(host, normalize)
|
||||||
|
if err != nil {
|
||||||
|
return resolvedHost{}, err
|
||||||
|
}
|
||||||
|
if found {
|
||||||
|
return used(entry), nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Cache hit with a fresh TTL — connect directly without querying NetBox.
|
// Cache hit with a fresh TTL — connect directly without querying NetBox.
|
||||||
if entry, fresh := c.Get(parsed.Host); fresh && useCache {
|
if entry, fresh := c.Get(host); fresh && useCache {
|
||||||
c.MarkUsed(parsed.Host)
|
return used(entry), nil
|
||||||
_ = c.Save()
|
|
||||||
connect(entry.Name, entry.Kind, entry.IP, entry.Tags)
|
|
||||||
return
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Shortcut cache lookup: scan entries whose normalized name matches the input.
|
// Shortcut cache lookup: scan entries whose normalized name matches the input.
|
||||||
// If a stale match is found, use the canonical name for the NetBox re-fetch below.
|
// If a stale match is found, use the canonical name for the NetBox re-fetch below.
|
||||||
lookupHost := parsed.Host
|
lookupHost := host
|
||||||
shortcutsEnabled := len(cfg.Shortcuts.Domains) > 0 || cfg.Shortcuts.StripHyphens
|
shortcutsEnabled := cfg.Shortcuts.Enabled()
|
||||||
if cached, _ := c.Get(lookupHost); shortcutsEnabled && cached.Name == "" && useCache {
|
if cached, _ := c.Get(lookupHost); shortcutsEnabled && cached.Name == "" && useCache {
|
||||||
normalize := normalizeTarget(cfg.Shortcuts, source != "")
|
normalize := normalizeTarget(cfg.Shortcuts, source != "")
|
||||||
entry, found, fresh, err := c.GetByShortcut(lookupHost, normalize)
|
entry, found, fresh, err := c.GetByShortcut(lookupHost, normalize)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fatalf("%v", err)
|
return resolvedHost{}, err
|
||||||
}
|
}
|
||||||
if found {
|
if found {
|
||||||
if fresh {
|
if fresh {
|
||||||
c.MarkUsed(entry.Name)
|
return used(entry), nil
|
||||||
_ = c.Save()
|
|
||||||
connect(entry.Name, entry.Kind, entry.IP, entry.Tags)
|
|
||||||
return
|
|
||||||
}
|
}
|
||||||
// Stale shortcut match — use canonical name for NetBox re-fetch.
|
// Stale shortcut match — use canonical name for NetBox re-fetch.
|
||||||
lookupHost = entry.Name
|
lookupHost = entry.Name
|
||||||
@@ -152,7 +293,7 @@ func runSSHWrapper(args []string) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if !cfg.HasNetBox() {
|
if !cfg.HasNetBox() {
|
||||||
fatalf("netbox.url is not configured (~/.config/netssh.yaml)")
|
return resolvedHost{}, fmt.Errorf("host %q is not in hosts: and no NetBox is configured (netssh configure)", host)
|
||||||
}
|
}
|
||||||
nbClient := newNetBoxClient(cfg)
|
nbClient := newNetBoxClient(cfg)
|
||||||
|
|
||||||
@@ -161,40 +302,37 @@ func runSSHWrapper(args []string) {
|
|||||||
|
|
||||||
target, err := findSSHHost(ctx, nbClient, lookupHost, cfg.Shortcuts.Domains)
|
target, err := findSSHHost(ctx, nbClient, lookupHost, cfg.Shortcuts.Domains)
|
||||||
if errors.Is(err, netbox.ErrHostNotFound) && !useCache && shortcutsEnabled {
|
if errors.Is(err, netbox.ErrHostNotFound) && !useCache && shortcutsEnabled {
|
||||||
entry, found, _, cacheErr := c.GetByShortcut(parsed.Host, normalizeTarget(cfg.Shortcuts, false))
|
entry, found, _, cacheErr := c.GetByShortcut(host, normalizeTarget(cfg.Shortcuts, false))
|
||||||
if cacheErr != nil {
|
if cacheErr != nil {
|
||||||
fatalf("%v", cacheErr)
|
return resolvedHost{}, cacheErr
|
||||||
}
|
}
|
||||||
if found {
|
if found {
|
||||||
target, err = findSSHHost(ctx, nbClient, entry.Name, cfg.Shortcuts.Domains)
|
target, err = findSSHHost(ctx, nbClient, entry.Name, cfg.Shortcuts.Domains)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fatalf("NetBox: %v", err)
|
return resolvedHost{}, fmt.Errorf("NetBox: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if cached, fresh := c.Get(target.Target()); fresh && cached.Kind == target.Kind {
|
if cached, fresh := c.Get(target.Target()); fresh && cached.Kind == target.Kind {
|
||||||
c.MarkUsed(target.Target())
|
return used(cached), nil
|
||||||
_ = c.Save()
|
|
||||||
connect(cached.Name, cached.Kind, cached.IP, cached.Tags)
|
|
||||||
return
|
|
||||||
}
|
}
|
||||||
|
|
||||||
chain, err := resolver.New(cfg.Resolver)
|
chain, err := resolver.New(cfg.Resolver)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fatalf("resolver: %v", err)
|
return resolvedHost{}, err
|
||||||
}
|
}
|
||||||
|
|
||||||
ip, err := chain.Resolve(ctx, &target, nbClient)
|
ip, strategy, err := chain.ResolveWithStrategy(ctx, &target, nbClient)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fatalf("IP resolution for %q: %v", parsed.Host, err)
|
return resolvedHost{}, fmt.Errorf("IP resolution for %q: %w", host, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
c.Upsert(cache.Entry{Name: target.Target(), IP: ip, Kind: target.Kind, Tags: target.Tags})
|
entry := cache.Entry{Name: target.Target(), IP: ip, Kind: target.Kind, Tags: target.Tags, Cluster: target.Cluster, Resolver: strategy}
|
||||||
c.MarkUsed(target.Target())
|
c.Upsert(entry)
|
||||||
_ = c.Save()
|
result := used(entry)
|
||||||
|
result.Origin = "live"
|
||||||
connect(target.Target(), target.Kind, ip, target.Tags)
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// findSSHHost uses the paginated, ambiguity-checking lookup for connection
|
// findSSHHost uses the paginated, ambiguity-checking lookup for connection
|
||||||
@@ -217,24 +355,66 @@ func findSSHHost(ctx context.Context, client *netbox.Client, name string, domain
|
|||||||
return netbox.HostEntry{}, fmt.Errorf("%w: %q", netbox.ErrHostNotFound, name)
|
return netbox.HostEntry{}, fmt.Errorf("%w: %q", netbox.ErrHostNotFound, name)
|
||||||
}
|
}
|
||||||
|
|
||||||
// connectHost applies the SSH options configured for the host and execs ssh.
|
// connectHost applies the SSH options configured for the host and execs the client.
|
||||||
// target is the cache/selector name, which may carry an instance prefix.
|
func connectHost(cfg *config.Config, client internalssh.Client, flags internalssh.WrapperFlags, host resolvedHost, dests []int, args []string) {
|
||||||
func connectHost(cfg *config.Config, flags internalssh.WrapperFlags, target, kind, ip string, tags []string, destIdx int, args []string) {
|
if !internalssh.ValidAddress(host.IP) {
|
||||||
instance, name := netbox.SplitTarget(target)
|
fatalf("refusing address %q for %s: not an IP address or hostname (check NetBox, or run netssh cache clear)", host.IP, host.Name)
|
||||||
opts := cfg.SSHOptionsFor(config.SSHHost{Instance: instance, Name: name, Kind: kind, Tags: tags})
|
}
|
||||||
execSSH(internalssh.Apply(args, destIdx, internalssh.Host{Name: name, IP: ip}, opts, flags), flags)
|
opts := hostOptions(cfg, host)
|
||||||
|
if len(flags.Forwards) > 0 {
|
||||||
|
forwardArgs, err := internalssh.ForwardArgs(flags.Forwards, opts.Forwards)
|
||||||
|
if err != nil {
|
||||||
|
fatalf("%v", err)
|
||||||
|
}
|
||||||
|
flags.ForwardArgs = forwardArgs
|
||||||
|
}
|
||||||
|
if flags.Tunnel && len(flags.ForwardArgs) == 0 && !client.HasForwardFlag(args) {
|
||||||
|
available := "none configured (ssh.forwards)"
|
||||||
|
if names := forwardNames(opts); len(names) > 0 {
|
||||||
|
available = strings.Join(names, ", ")
|
||||||
|
}
|
||||||
|
fatalf("name a forward or a spec such as 8080:localhost:80; forwards for %s: %s", host.Name, available)
|
||||||
|
}
|
||||||
|
if err := runPreConnect(opts.PreConnectCommand(), host, client.Name, flags.DryRun); err != nil {
|
||||||
|
fatalf("%v", err)
|
||||||
|
}
|
||||||
|
_, name := netbox.SplitTarget(host.Name)
|
||||||
|
result := client.Apply(args, dests, internalssh.Host{Name: name, IP: host.IP}, opts, flags)
|
||||||
|
post := config.HookCommand(opts.PostDisconnect)
|
||||||
|
if flags.DryRun {
|
||||||
|
if post != "" {
|
||||||
|
fmt.Fprintf(os.Stderr, "# post_disconnect (skipped in --dry-run): %s\n", post)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !flags.DryRun && (post != "" || cfg.Activity.Enabled) {
|
||||||
|
if result.Notice != "" {
|
||||||
|
fmt.Fprintln(os.Stderr, result.Notice)
|
||||||
|
}
|
||||||
|
code := supervise(cfg, host, client.Name, append([]string{client.Name}, result.Args...), post, 0, false, os.Stdin, os.Stdout, os.Stderr)
|
||||||
|
if code != 0 {
|
||||||
|
os.Exit(code)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
execClient(client, result, flags)
|
||||||
}
|
}
|
||||||
|
|
||||||
// execSSH replaces the process with ssh, or prints the command for --dry-run.
|
// hostOptions merges the global, instance, and rule SSH options for host.
|
||||||
func execSSH(result internalssh.Result, flags internalssh.WrapperFlags) {
|
func hostOptions(cfg *config.Config, host resolvedHost) config.SSHOptions {
|
||||||
|
instance, name := netbox.SplitTarget(host.Name)
|
||||||
|
return cfg.SSHOptionsFor(config.SSHHost{Instance: instance, Name: name, Kind: host.Kind, Tags: host.Tags})
|
||||||
|
}
|
||||||
|
|
||||||
|
// execClient replaces the process with the client, or prints the command for --dry-run.
|
||||||
|
func execClient(client internalssh.Client, result internalssh.Result, flags internalssh.WrapperFlags) {
|
||||||
if flags.DryRun {
|
if flags.DryRun {
|
||||||
fmt.Println(internalssh.Quote(append([]string{"ssh"}, result.Args...)))
|
fmt.Println(internalssh.Quote(append([]string{client.Name}, result.Args...)))
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if result.Notice != "" {
|
if result.Notice != "" {
|
||||||
fmt.Fprintf(os.Stderr, "netssh: %s\n", result.Notice)
|
fmt.Fprintf(os.Stderr, "netssh: %s\n", result.Notice)
|
||||||
}
|
}
|
||||||
if err := internalssh.Exec(result.Args); err != nil {
|
if err := client.Exec(result.Args); err != nil {
|
||||||
fatalf("%v", err)
|
fatalf("%v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -243,7 +423,7 @@ func execSSH(result internalssh.Result, flags internalssh.WrapperFlags) {
|
|||||||
func runTUI() {
|
func runTUI() {
|
||||||
cfg := loadConfigOrSetup()
|
cfg := loadConfigOrSetup()
|
||||||
|
|
||||||
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
|
c := newCache(cfg)
|
||||||
_ = c.Load()
|
_ = c.Load()
|
||||||
maybeBackgroundRefresh(cfg, c)
|
maybeBackgroundRefresh(cfg, c)
|
||||||
|
|
||||||
@@ -253,7 +433,58 @@ func runTUI() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
m := tui.New(nbClient, c, cfg.SSH.DefaultUser, cfg.SSH.DefaultPort)
|
m := tui.New(nbClient, c, cfg.SSH.DefaultUser, cfg.SSH.DefaultPort)
|
||||||
|
m.SetHostLabel(cfg.HostLabel)
|
||||||
|
m.SetHistoryLimit(cfg.TUI.HistoryLimit)
|
||||||
|
state, stateErr := activity.Read()
|
||||||
|
if stateErr != nil {
|
||||||
|
fmt.Fprintf(os.Stderr, "favorites: %v\n", stateErr)
|
||||||
|
}
|
||||||
|
m.SetPreferences(state.Favorites, state.Pinned, func(favorites, pinned map[string]bool) error {
|
||||||
|
err := activity.Update(func(s *activity.State) {
|
||||||
|
merge := func(dst, previous, next map[string]bool) {
|
||||||
|
for name, value := range next {
|
||||||
|
if previous[name] != value {
|
||||||
|
if value {
|
||||||
|
dst[name] = true
|
||||||
|
} else {
|
||||||
|
delete(dst, name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for name, value := range previous {
|
||||||
|
if value && !next[name] {
|
||||||
|
delete(dst, name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
merge(s.Favorites, state.Favorites, favorites)
|
||||||
|
merge(s.Pinned, state.Pinned, pinned)
|
||||||
|
})
|
||||||
|
if err == nil {
|
||||||
|
state.Favorites = favorites
|
||||||
|
state.Pinned = pinned
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
})
|
||||||
|
m.SetCommands(func(name, kind string, tags []string) []string {
|
||||||
|
var names []string
|
||||||
|
h := commandHost(resolvedHost{Name: name, Kind: kind, Tags: tags})
|
||||||
|
for name, c := range cfg.Commands {
|
||||||
|
if c.Allowed(h) {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
return names
|
||||||
|
})
|
||||||
|
if cfg.Shortcuts.Show {
|
||||||
|
aliases := shortcutAliases(c.All(), *cfg)
|
||||||
|
m.SetAliases(func(target string) string { return aliases[strings.ToLower(target)] })
|
||||||
|
}
|
||||||
m.SetNotes(notes.New(cfg.NetBox.URL, nbClient))
|
m.SetNotes(notes.New(cfg.NetBox.URL, nbClient))
|
||||||
|
m.SetForwards(func(name, kind string, tags []string) []string {
|
||||||
|
return forwardNames(hostOptions(cfg, resolvedHost{Name: name, Kind: kind, Tags: tags}))
|
||||||
|
})
|
||||||
p := tea.NewProgram(m)
|
p := tea.NewProgram(m)
|
||||||
final, err := p.Run()
|
final, err := p.Run()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -268,6 +499,28 @@ func runTUI() {
|
|||||||
if host == nil {
|
if host == nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
if host.Command != "" {
|
||||||
|
args := []string{"run", host.Command, "--", host.Name}
|
||||||
|
if len(host.Targets) > 0 {
|
||||||
|
args = append([]string{"batch", host.Command}, host.Targets...)
|
||||||
|
}
|
||||||
|
root := rootCmd()
|
||||||
|
root.SetArgs(args)
|
||||||
|
if err := root.Execute(); err != nil {
|
||||||
|
var exit *commandExit
|
||||||
|
if errors.As(err, &exit) {
|
||||||
|
os.Exit(exit.code)
|
||||||
|
}
|
||||||
|
fatalf("%v", err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if host.Action == tui.ActionMulti {
|
||||||
|
if err := runMulti(cfg, host.Targets, multiFlags{}); err != nil {
|
||||||
|
fatalf("%v", err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
// Revalidate stale or live TUI results through the configured resolver chain.
|
// Revalidate stale or live TUI results through the configured resolver chain.
|
||||||
var tags []string
|
var tags []string
|
||||||
@@ -288,40 +541,65 @@ func runTUI() {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
fatalf("resolver: %v", err)
|
fatalf("resolver: %v", err)
|
||||||
}
|
}
|
||||||
host.IP, err = chain.Resolve(ctx, &target, nbClient)
|
var strategy string
|
||||||
|
host.IP, strategy, err = chain.ResolveWithStrategy(ctx, &target, nbClient)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fatalf("IP resolution: %v", err)
|
fatalf("IP resolution: %v", err)
|
||||||
}
|
}
|
||||||
c.Upsert(cache.Entry{Name: target.Target(), 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, Cluster: target.Cluster, Resolver: strategy})
|
||||||
tags = target.Tags
|
tags = target.Tags
|
||||||
}
|
}
|
||||||
fmt.Fprintf(os.Stderr, "Connecting to %s (%s)…\n", host.Name, host.IP)
|
fmt.Fprintf(os.Stderr, "Connecting to %s (%s)…\n", host.Name, host.IP)
|
||||||
|
|
||||||
var sshArgs []string
|
|
||||||
|
|
||||||
// User override from TUI edit mode takes priority, then config default.
|
|
||||||
user := host.User
|
|
||||||
if user == "" {
|
|
||||||
user = cfg.SSH.DefaultUser
|
|
||||||
}
|
|
||||||
if user != "" {
|
|
||||||
sshArgs = append(sshArgs, "-l", user)
|
|
||||||
}
|
|
||||||
|
|
||||||
port := host.Port
|
|
||||||
if port == "" && cfg.SSH.DefaultPort > 0 {
|
|
||||||
port = strconv.Itoa(cfg.SSH.DefaultPort)
|
|
||||||
}
|
|
||||||
if port != "" {
|
|
||||||
sshArgs = append(sshArgs, "-p", port)
|
|
||||||
}
|
|
||||||
|
|
||||||
sshArgs = append(sshArgs, host.IP)
|
|
||||||
|
|
||||||
c.MarkUsed(host.Name)
|
c.MarkUsed(host.Name)
|
||||||
_ = c.Save()
|
_ = c.Save()
|
||||||
|
|
||||||
connectHost(cfg, internalssh.WrapperFlags{}, host.Name, host.Kind, host.IP, tags, len(sshArgs)-1, sshArgs)
|
client, flags, args := tuiCommand(cfg, host)
|
||||||
|
connectHost(cfg, client, flags, resolvedHost{Name: host.Name, Kind: host.Kind, IP: host.IP, Tags: tags}, []int{len(args) - 1}, args)
|
||||||
|
}
|
||||||
|
|
||||||
|
// tuiCommand builds the client and arguments for the action chosen in the TUI.
|
||||||
|
func tuiCommand(cfg *config.Config, host *tui.SelectedHost) (internalssh.Client, internalssh.WrapperFlags, []string) {
|
||||||
|
client := internalssh.SSH
|
||||||
|
var flags internalssh.WrapperFlags
|
||||||
|
switch host.Action {
|
||||||
|
case tui.ActionSFTP:
|
||||||
|
client = internalssh.SFTP
|
||||||
|
case tui.ActionTunnel:
|
||||||
|
flags = internalssh.WrapperFlags{Forwards: host.Forwards, Tunnel: true}
|
||||||
|
}
|
||||||
|
|
||||||
|
var args []string
|
||||||
|
// User override from TUI edit mode takes priority, then static host and config defaults.
|
||||||
|
defaultUser, defaultPort := hostDefaults(cfg, resolvedHost{Name: host.Name, Kind: host.Kind})
|
||||||
|
user := host.User
|
||||||
|
if user == "" {
|
||||||
|
user = defaultUser
|
||||||
|
}
|
||||||
|
if user != "" {
|
||||||
|
args = append(args, client.UserArgs(user)...)
|
||||||
|
}
|
||||||
|
port := host.Port
|
||||||
|
if port == "" && defaultPort > 0 {
|
||||||
|
port = strconv.Itoa(defaultPort)
|
||||||
|
}
|
||||||
|
if port != "" {
|
||||||
|
args = append(args, client.PortArgs(port)...)
|
||||||
|
}
|
||||||
|
// Apply replaces the destination; a bare name cannot be mistaken for
|
||||||
|
// host:path by sftp, unlike an IPv6 address.
|
||||||
|
_, name := netbox.SplitTarget(host.Name)
|
||||||
|
return client, flags, append(args, name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// forwardNames lists the forwards configured for a host, sorted.
|
||||||
|
func forwardNames(opts config.SSHOptions) []string {
|
||||||
|
names := make([]string, 0, len(opts.Forwards))
|
||||||
|
for name := range opts.Forwards {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
return names
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- cobra root + subcommands ---
|
// --- cobra root + subcommands ---
|
||||||
@@ -332,17 +610,14 @@ func rootCmd() *cobra.Command {
|
|||||||
Short: "SSH wrapper with NetBox hostname resolution",
|
Short: "SSH wrapper with NetBox hostname resolution",
|
||||||
DisableFlagParsing: true,
|
DisableFlagParsing: true,
|
||||||
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) {
|
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) {
|
||||||
|
if len(args) > 0 && args[len(args)-1] == "--forward" {
|
||||||
cfg, err := config.Load()
|
cfg, err := config.Load()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, cobra.ShellCompDirectiveError
|
return nil, cobra.ShellCompDirectiveError
|
||||||
}
|
}
|
||||||
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
|
return filterPrefix(allForwardNames(cfg), toComplete, nil), cobra.ShellCompDirectiveNoFileComp
|
||||||
_ = c.Load()
|
|
||||||
|
|
||||||
hosts := hostCompletions(c.All(), toComplete)
|
|
||||||
if limit := cfg.Completion.MaxResults; limit > 0 && len(hosts) > limit {
|
|
||||||
hosts = hosts[:limit]
|
|
||||||
}
|
}
|
||||||
|
hosts := completeHosts(toComplete)
|
||||||
completions := make([]cobra.Completion, 0, len(hosts))
|
completions := make([]cobra.Completion, 0, len(hosts))
|
||||||
for _, host := range hosts {
|
for _, host := range hosts {
|
||||||
completions = append(completions, cobra.Completion(host))
|
completions = append(completions, cobra.Completion(host))
|
||||||
@@ -357,7 +632,7 @@ func rootCmd() *cobra.Command {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
root.AddCommand(notesCmd(), configureCmd(), searchCmd(), cacheCmd(), aliasCmd(), hookCmd(), shellInitCmd(), versionCmd(), uninstallCmd())
|
root.AddCommand(doctorCmd(), explainCmd(), favoritesCmd(), historyCmd(), batchCmd(), configCmd(), runCmd(), notesCmd(), configureCmd(), searchCmd(), cacheCmd(), aliasCmd(), hookCmd(), shellInitCmd(), versionCmd(), uninstallCmd(), sftpCmd(), scpCmd(), tunnelCmd(), hostsCmd(), multiCmd(), syncCmd())
|
||||||
|
|
||||||
// cobra builds the "completion" command lazily; force init so we can extend it.
|
// cobra builds the "completion" command lazily; force init so we can extend it.
|
||||||
root.InitDefaultCompletionCmd()
|
root.InitDefaultCompletionCmd()
|
||||||
@@ -479,7 +754,7 @@ func searchCmd() *cobra.Command {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
|
c := newCache(cfg)
|
||||||
if err := c.Load(); err != nil {
|
if err := c.Load(); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -505,7 +780,8 @@ func cacheCmd() *cobra.Command {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func cacheListCmd() *cobra.Command {
|
func cacheListCmd() *cobra.Command {
|
||||||
return &cobra.Command{
|
var showAliases bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
Use: "list",
|
Use: "list",
|
||||||
Short: "Show all cached entries",
|
Short: "Show all cached entries",
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
@@ -513,7 +789,7 @@ func cacheListCmd() *cobra.Command {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
|
c := newCache(cfg)
|
||||||
if err := c.Load(); err != nil {
|
if err := c.Load(); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -521,13 +797,31 @@ func cacheListCmd() *cobra.Command {
|
|||||||
sort.Slice(entries, func(i, j int) bool { return entries[i].Name < entries[j].Name })
|
sort.Slice(entries, func(i, j int) bool { return entries[i].Name < entries[j].Name })
|
||||||
|
|
||||||
w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
|
w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
|
||||||
|
if !showAliases && !cfg.Shortcuts.Show {
|
||||||
fmt.Fprintln(w, "NAME\tIP\tKIND\tCACHED AT")
|
fmt.Fprintln(w, "NAME\tIP\tKIND\tCACHED AT")
|
||||||
for _, e := range entries {
|
for _, e := range entries {
|
||||||
fmt.Fprintf(w, "%s\t%s\t%s\t%s\n", e.Name, e.IP, e.Kind, e.CachedAt.Format(time.RFC3339))
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\n", e.Name, e.IP, e.Kind, e.CachedAt.Format(time.RFC3339))
|
||||||
}
|
}
|
||||||
return w.Flush()
|
return w.Flush()
|
||||||
|
}
|
||||||
|
aliases := shortcutAliases(entries, *cfg)
|
||||||
|
fmt.Fprintln(w, "NAME\tALIAS\tIP\tKIND\tCACHED AT")
|
||||||
|
for _, e := range entries {
|
||||||
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\n", e.Name, orDash(aliases[strings.ToLower(e.Name)]), e.IP, e.Kind, e.CachedAt.Format(time.RFC3339))
|
||||||
|
}
|
||||||
|
return w.Flush()
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
cmd.Flags().BoolVar(&showAliases, "aliases", false, "Show each host's shortcut alias (always on with shortcuts.show)")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// orDash keeps empty table cells visible.
|
||||||
|
func orDash(s string) string {
|
||||||
|
if s == "" {
|
||||||
|
return "-"
|
||||||
|
}
|
||||||
|
return s
|
||||||
}
|
}
|
||||||
|
|
||||||
func cacheClearCmd() *cobra.Command {
|
func cacheClearCmd() *cobra.Command {
|
||||||
@@ -539,7 +833,7 @@ func cacheClearCmd() *cobra.Command {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
|
c := newCache(cfg)
|
||||||
c.Clear()
|
c.Clear()
|
||||||
if err := c.Save(); err != nil {
|
if err := c.Save(); err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -581,7 +875,7 @@ func cacheRefreshCmd() *cobra.Command {
|
|||||||
return fmt.Errorf("NetBox: %w", err)
|
return fmt.Errorf("NetBox: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
|
c := newCache(cfg)
|
||||||
_ = c.Load()
|
_ = c.Load()
|
||||||
|
|
||||||
chain, err := resolver.New(cfg.Resolver)
|
chain, err := resolver.New(cfg.Resolver)
|
||||||
@@ -601,7 +895,7 @@ func cacheRefreshCmd() *cobra.Command {
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
ip, err := chain.Resolve(ctx, e, nbClient)
|
ip, strategy, err := chain.ResolveWithStrategy(ctx, e, nbClient)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// Do not turn a failed configured strategy into a fresh
|
// Do not turn a failed configured strategy into a fresh
|
||||||
// primary-IP cache hit that bypasses the resolver.
|
// primary-IP cache hit that bypasses the resolver.
|
||||||
@@ -612,7 +906,7 @@ func cacheRefreshCmd() *cobra.Command {
|
|||||||
fmt.Fprintf(os.Stderr, "warning: skipping %s: %v\n", e.Name, err)
|
fmt.Fprintf(os.Stderr, "warning: skipping %s: %v\n", e.Name, err)
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
c.Upsert(cache.Entry{Name: e.Target(), IP: ip, Kind: e.Kind, Tags: e.Tags})
|
c.Upsert(cache.Entry{Name: e.Target(), IP: ip, Kind: e.Kind, Tags: e.Tags, Cluster: e.Cluster, Resolver: strategy})
|
||||||
written++
|
written++
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -645,13 +939,15 @@ func buildAliasEntries(c *cache.Cache, cfg config.Config) []hook.AliasEntry {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func aliasCmd() *cobra.Command {
|
func aliasCmd() *cobra.Command {
|
||||||
var shell string
|
var shell, test string
|
||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
Use: "alias",
|
Use: "alias",
|
||||||
Short: "Print shell aliases for all cached hosts",
|
Short: "Print shell aliases for all cached hosts",
|
||||||
Long: `Print shell alias definitions for all cached hosts.
|
Long: `Print shell alias definitions for all cached hosts.
|
||||||
The alias name is the shortened form derived from the configured shortcuts
|
The alias name is the shortened form derived from the configured shortcuts
|
||||||
(domain suffixes stripped, hyphens optionally stripped).
|
(domain suffixes stripped, rewrite rules applied, hyphens optionally stripped).
|
||||||
|
|
||||||
|
Check a rule with: netssh alias --test fsn1-bx1.example.com
|
||||||
|
|
||||||
Source the output in your shell profile:
|
Source the output in your shell profile:
|
||||||
bash/zsh: eval "$(netssh alias)"
|
bash/zsh: eval "$(netssh alias)"
|
||||||
@@ -664,10 +960,14 @@ Or use in a script:
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
|
c := newCache(cfg)
|
||||||
if err := c.Load(); err != nil {
|
if err := c.Load(); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
if test != "" {
|
||||||
|
printShortcutTest(os.Stdout, test, c.All(), cfg.Shortcuts)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
if shell == "" {
|
if shell == "" {
|
||||||
shell = filepath.Base(os.Getenv("SHELL"))
|
shell = filepath.Base(os.Getenv("SHELL"))
|
||||||
}
|
}
|
||||||
@@ -694,9 +994,36 @@ Or use in a script:
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
cmd.Flags().StringVar(&shell, "shell", "", "Output format: bash, zsh, fish (default: $SHELL)")
|
cmd.Flags().StringVar(&shell, "shell", "", "Output format: bash, zsh, fish (default: $SHELL)")
|
||||||
|
cmd.Flags().StringVar(&test, "test", "", "Show the shortcut for a hostname and the cached hosts it matches")
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// printShortcutTest helps writing shortcut rules: it shows what a name is
|
||||||
|
// shortened to and which cached hosts share that shortcut.
|
||||||
|
func printShortcutTest(w io.Writer, name string, entries []cache.Entry, sc config.ShortcutsConfig) {
|
||||||
|
normalize := normalizeTarget(sc, strings.Contains(name, "/"))
|
||||||
|
short := normalize(name)
|
||||||
|
fmt.Fprintf(w, "%s → %s\n", name, short)
|
||||||
|
var matches []string
|
||||||
|
for _, e := range entries {
|
||||||
|
if normalize(e.Name) == short {
|
||||||
|
matches = append(matches, e.Name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Strings(matches)
|
||||||
|
switch len(matches) {
|
||||||
|
case 0:
|
||||||
|
fmt.Fprintln(w, "no cached host has this shortcut")
|
||||||
|
case 1:
|
||||||
|
fmt.Fprintf(w, "matches %s\n", matches[0])
|
||||||
|
default:
|
||||||
|
fmt.Fprintf(w, "ambiguous, matches %d hosts:\n", len(matches))
|
||||||
|
for _, m := range matches {
|
||||||
|
fmt.Fprintf(w, " %s\n", m)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// shellInitCmd is called at shell startup to update alias files and trigger a
|
// shellInitCmd is called at shell startup to update alias files and trigger a
|
||||||
// background cache refresh when stale. Intentionally silent — never disrupts the prompt.
|
// background cache refresh when stale. Intentionally silent — never disrupts the prompt.
|
||||||
func shellInitCmd() *cobra.Command {
|
func shellInitCmd() *cobra.Command {
|
||||||
@@ -709,7 +1036,7 @@ func shellInitCmd() *cobra.Command {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
|
c := newCache(cfg)
|
||||||
_ = c.Load()
|
_ = c.Load()
|
||||||
|
|
||||||
// Regenerate alias files from the current cache every shell start
|
// Regenerate alias files from the current cache every shell start
|
||||||
@@ -768,7 +1095,7 @@ After installation, reload your profile or open a new shell.`,
|
|||||||
// Generate the aliases file immediately so it is ready on the next shell start.
|
// Generate the aliases file immediately so it is ready on the next shell start.
|
||||||
cfg, cfgErr := config.Load()
|
cfg, cfgErr := config.Load()
|
||||||
if cfgErr == nil && cfg.HasNetBox() {
|
if cfgErr == nil && cfg.HasNetBox() {
|
||||||
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
|
c := newCache(cfg)
|
||||||
if _ = c.Load(); true {
|
if _ = c.Load(); true {
|
||||||
if entries := buildAliasEntries(c, *cfg); len(entries) > 0 {
|
if entries := buildAliasEntries(c, *cfg); len(entries) > 0 {
|
||||||
if err := hook.WriteAliasFiles(entries); err != nil {
|
if err := hook.WriteAliasFiles(entries); err != nil {
|
||||||
@@ -817,13 +1144,19 @@ func hookUninstallCmd() *cobra.Command {
|
|||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// refreshRetryInterval is the pause between background refresh attempts.
|
||||||
|
const refreshRetryInterval = 5 * time.Minute
|
||||||
|
|
||||||
// maybeBackgroundRefresh starts a background `netssh cache refresh` if the cache
|
// maybeBackgroundRefresh starts a background `netssh cache refresh` if the cache
|
||||||
// has not been fully refreshed within the last 24 hours.
|
// has not been fully refreshed within the last 24 hours.
|
||||||
func maybeBackgroundRefresh(cfg *config.Config, c *cache.Cache) {
|
func maybeBackgroundRefresh(cfg *config.Config, c *cache.Cache) {
|
||||||
if !cfg.HasNetBox() {
|
// netssh multi checks once and starts its panes with NETSSH_NO_REFRESH.
|
||||||
|
if !cfg.HasNetBox() || os.Getenv("NETSSH_NO_REFRESH") != "" {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if !c.NeedsRefresh(24 * time.Hour) {
|
// While NetBox is unreachable the cache stays stale; without the retry
|
||||||
|
// interval every command and every new shell would start another refresh.
|
||||||
|
if !c.ClaimRefresh(24*time.Hour, refreshRetryInterval) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
self, err := os.Executable()
|
self, err := os.Executable()
|
||||||
|
|||||||
@@ -0,0 +1,414 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"regexp"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
|
"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/multiplex"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
||||||
|
)
|
||||||
|
|
||||||
|
// maxHostsWithoutConfirm guards against opening hundreds of panes by accident.
|
||||||
|
const maxHostsWithoutConfirm = 24
|
||||||
|
|
||||||
|
// multiFlags are the options shared by netssh multi and the TUI.
|
||||||
|
type multiFlags struct {
|
||||||
|
kind, user, jump, multiplexer string
|
||||||
|
noJump, sync, dryRun, yes bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func multiCmd() *cobra.Command {
|
||||||
|
var f multiFlags
|
||||||
|
var useTmux, useZellij bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "multi [flags] HOST|tag:TAG|cluster:NAME|@GROUP...",
|
||||||
|
Short: "Open several hosts side by side in tmux or zellij",
|
||||||
|
Long: `Open one pane per host in a tmux window or zellij tab. Hosts are given as
|
||||||
|
names (shortcuts, instance/host, static hosts) or selectors:
|
||||||
|
|
||||||
|
tag:TAG all hosts with this NetBox tag, and static hosts with this tag
|
||||||
|
cluster:NAME devices of a NetBox virtualization cluster (--kind vm|all for VMs)
|
||||||
|
@GROUP a group from the config (groups:)
|
||||||
|
|
||||||
|
Broadcast typing to all panes of a window with --sync, or toggle it later with
|
||||||
|
netssh sync. Inside tmux or zellij the panes open in the current session.`,
|
||||||
|
Example: ` netssh multi web01 web02 db01
|
||||||
|
netssh multi cluster:pve-fsn1
|
||||||
|
netssh multi --kind vm cluster:pve-fsn1
|
||||||
|
netssh multi --sync tag:k8s-worker
|
||||||
|
netssh multi @k8s`,
|
||||||
|
Args: cobra.MinimumNArgs(1),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
if useTmux && useZellij {
|
||||||
|
return errors.New("--tmux and --zellij are mutually exclusive")
|
||||||
|
}
|
||||||
|
if useTmux {
|
||||||
|
f.multiplexer = multiplex.Tmux
|
||||||
|
} else if useZellij {
|
||||||
|
f.multiplexer = multiplex.Zellij
|
||||||
|
}
|
||||||
|
return runMulti(loadConfigOrSetup(), args, f)
|
||||||
|
},
|
||||||
|
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return nil, cobra.ShellCompDirectiveError
|
||||||
|
}
|
||||||
|
return multiCompletions(cfg, toComplete)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.Flags().StringVar(&f.kind, "kind", "", "Host kind for tag: and cluster: — device, vm, or all (default: all for tags, device for clusters)")
|
||||||
|
cmd.Flags().BoolVar(&f.sync, "sync", false, "Start with typing broadcast to all panes")
|
||||||
|
cmd.Flags().BoolVar(&useTmux, "tmux", false, "Use tmux")
|
||||||
|
cmd.Flags().BoolVar(&useZellij, "zellij", false, "Use zellij")
|
||||||
|
cmd.Flags().StringVarP(&f.user, "user", "l", "", "Login user for every host")
|
||||||
|
cmd.Flags().StringVar(&f.jump, "jump", "", "Jump host for every host")
|
||||||
|
cmd.Flags().BoolVar(&f.noJump, "no-jump", false, "Disable jump hosts")
|
||||||
|
cmd.Flags().BoolVar(&f.dryRun, "dry-run", false, "Print the hosts and multiplexer commands")
|
||||||
|
cmd.Flags().BoolVarP(&f.yes, "yes", "y", false, fmt.Sprintf("Open more than %d hosts without asking", maxHostsWithoutConfirm))
|
||||||
|
_ = cmd.RegisterFlagCompletionFunc("kind", cobra.FixedCompletions([]cobra.Completion{"device", "vm", "all"}, cobra.ShellCompDirectiveNoFileComp))
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func syncCmd() *cobra.Command {
|
||||||
|
var pane bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "sync [--pane]",
|
||||||
|
Short: "Toggle typing into all panes of the current tmux window or zellij tab",
|
||||||
|
Long: `Toggle broadcast in the current tmux window or zellij tab. With --pane,
|
||||||
|
exclude the current tmux pane from broadcast, or include it again.
|
||||||
|
|
||||||
|
In windows opened by netssh multi, tmux also has keys for this:
|
||||||
|
prefix S (all panes) and prefix e (this pane); see multi.sync_key and
|
||||||
|
multi.solo_key. In zellij, use Ctrl+t then s.`,
|
||||||
|
Args: cobra.NoArgs,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
state, err := multiplex.ToggleSync(multiplex.System{}, pane)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
fmt.Fprintln(os.Stderr, "netssh: "+state)
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.Flags().BoolVar(&pane, "pane", false, "Exclude the current tmux pane from broadcast, or include it again")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// runMulti expands selectors and opens one pane per host.
|
||||||
|
func runMulti(cfg *config.Config, selectors []string, f multiFlags) error {
|
||||||
|
if f.jump != "" && f.noJump {
|
||||||
|
return errors.New("--jump and --no-jump are mutually exclusive")
|
||||||
|
}
|
||||||
|
switch f.kind {
|
||||||
|
case "", "device", "vm", "all":
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("--kind must be device, vm, or all")
|
||||||
|
}
|
||||||
|
c := newCache(cfg)
|
||||||
|
_ = c.Load()
|
||||||
|
targets, warnings, err := expandSelectors(cfg, c, selectors, f.kind)
|
||||||
|
for _, warning := range warnings {
|
||||||
|
fmt.Fprintln(os.Stderr, "netssh: warning: "+warning)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if len(targets) > maxHostsWithoutConfirm && !f.yes && !f.dryRun {
|
||||||
|
return fmt.Errorf("%d hosts selected; pass --yes to open them all", len(targets))
|
||||||
|
}
|
||||||
|
|
||||||
|
var runner multiplex.Runner = multiplex.System{}
|
||||||
|
if f.dryRun {
|
||||||
|
fmt.Printf("# %d hosts: %s\n", len(targets), strings.Join(targets, " "))
|
||||||
|
runner = &multiplex.DryRun{W: os.Stdout}
|
||||||
|
}
|
||||||
|
requested := f.multiplexer
|
||||||
|
if requested == "" {
|
||||||
|
requested = cfg.Multi.Multiplexer
|
||||||
|
}
|
||||||
|
kind, err := multiplex.Detect(requested, runner)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !f.dryRun {
|
||||||
|
// Checked once here; the panes skip it (NETSSH_NO_REFRESH).
|
||||||
|
maybeBackgroundRefresh(cfg, c)
|
||||||
|
}
|
||||||
|
|
||||||
|
panes := make([]multiplex.Pane, 0, len(targets))
|
||||||
|
for _, target := range targets {
|
||||||
|
panes = append(panes, multiplex.Pane{Title: target, Argv: paneArgv(target, f)})
|
||||||
|
}
|
||||||
|
layoutDir := filepath.Dir(cfg.Cache.Path)
|
||||||
|
if err := os.MkdirAll(layoutDir, 0o700); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
syncKey, soloKey := cfg.Multi.Keys()
|
||||||
|
return multiplex.Open(kind, panes, multiplex.Options{
|
||||||
|
SyncKey: syncKey,
|
||||||
|
SoloKey: soloKey,
|
||||||
|
Label: multiLabel(selectors),
|
||||||
|
Sync: f.sync,
|
||||||
|
PerWindow: cfg.Multi.PanesPerWindowOrDefault(),
|
||||||
|
LayoutDir: layoutDir,
|
||||||
|
Hint: func(s string) { fmt.Fprintln(os.Stderr, "netssh: "+s) },
|
||||||
|
}, runner)
|
||||||
|
}
|
||||||
|
|
||||||
|
// paneArgv runs netssh for one host. Panes of an existing tmux or zellij
|
||||||
|
// session inherit that server's environment, so the paths that select the
|
||||||
|
// config and cache are passed explicitly; NETSSH_* values are not, because
|
||||||
|
// arguments are visible to other users (tokens).
|
||||||
|
func paneArgv(target string, f multiFlags) []string {
|
||||||
|
self, err := os.Executable()
|
||||||
|
if err != nil {
|
||||||
|
self = "netssh"
|
||||||
|
}
|
||||||
|
env, err := exec.LookPath("env")
|
||||||
|
if err != nil {
|
||||||
|
env = "/usr/bin/env"
|
||||||
|
}
|
||||||
|
argv := []string{env, "NETSSH_NO_REFRESH=1"}
|
||||||
|
for _, key := range []string{"HOME", "XDG_CONFIG_HOME", "XDG_CACHE_HOME"} {
|
||||||
|
if value, ok := os.LookupEnv(key); ok {
|
||||||
|
argv = append(argv, key+"="+value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
argv = append(argv, self)
|
||||||
|
switch {
|
||||||
|
case f.jump != "":
|
||||||
|
argv = append(argv, "--jump", f.jump)
|
||||||
|
case f.noJump:
|
||||||
|
argv = append(argv, "--no-jump")
|
||||||
|
}
|
||||||
|
if f.user != "" {
|
||||||
|
argv = append(argv, "-l", f.user)
|
||||||
|
}
|
||||||
|
return append(argv, target)
|
||||||
|
}
|
||||||
|
|
||||||
|
var unsafeLabel = regexp.MustCompile(`[^A-Za-z0-9_-]+`)
|
||||||
|
|
||||||
|
// multiLabel names the window, session, or tab after a single selector.
|
||||||
|
func multiLabel(selectors []string) string {
|
||||||
|
if len(selectors) != 1 {
|
||||||
|
return "multi"
|
||||||
|
}
|
||||||
|
s := selectors[0]
|
||||||
|
for _, prefix := range []string{"@", "tag:", "cluster:"} {
|
||||||
|
s = strings.TrimPrefix(s, prefix)
|
||||||
|
}
|
||||||
|
if s = strings.Trim(unsafeLabel.ReplaceAllString(s, "-"), "-"); s == "" {
|
||||||
|
return "multi"
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// expander resolves selectors into an ordered list of unique host targets.
|
||||||
|
type expander struct {
|
||||||
|
cfg *config.Config
|
||||||
|
cache *cache.Cache
|
||||||
|
kind string
|
||||||
|
client *netbox.Client
|
||||||
|
seen map[string]bool
|
||||||
|
visiting map[string]bool
|
||||||
|
targets []string
|
||||||
|
warnings []string
|
||||||
|
}
|
||||||
|
|
||||||
|
func expandSelectors(cfg *config.Config, c *cache.Cache, selectors []string, kind string) ([]string, []string, error) {
|
||||||
|
e := &expander{cfg: cfg, cache: c, kind: kind, seen: map[string]bool{}, visiting: map[string]bool{}}
|
||||||
|
for _, selector := range selectors {
|
||||||
|
if err := e.expand(selector); err != nil {
|
||||||
|
return nil, e.warnings, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(e.targets) == 0 {
|
||||||
|
return nil, e.warnings, errors.New("no hosts selected")
|
||||||
|
}
|
||||||
|
return e.targets, e.warnings, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *expander) add(target string) {
|
||||||
|
key := strings.ToLower(target)
|
||||||
|
if !e.seen[key] {
|
||||||
|
e.seen[key] = true
|
||||||
|
e.targets = append(e.targets, target)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *expander) expand(selector string) error {
|
||||||
|
switch {
|
||||||
|
case strings.HasPrefix(selector, "@"):
|
||||||
|
return e.group(strings.ToLower(strings.TrimPrefix(selector, "@")))
|
||||||
|
case strings.HasPrefix(selector, "tag:"):
|
||||||
|
return e.query(selector, netbox.SearchOptions{Tag: strings.TrimPrefix(selector, "tag:")}, "all")
|
||||||
|
case strings.HasPrefix(selector, "cluster:"):
|
||||||
|
return e.query(selector, netbox.SearchOptions{Cluster: strings.TrimPrefix(selector, "cluster:")}, "device")
|
||||||
|
case selector == "":
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
e.add(selector)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *expander) group(name string) error {
|
||||||
|
members, ok := e.cfg.Groups[name]
|
||||||
|
if !ok {
|
||||||
|
names := make([]string, 0, len(e.cfg.Groups))
|
||||||
|
for group := range e.cfg.Groups {
|
||||||
|
names = append(names, "@"+group)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
if len(names) == 0 {
|
||||||
|
return fmt.Errorf("unknown group @%s; no groups are configured (groups:)", name)
|
||||||
|
}
|
||||||
|
return fmt.Errorf("unknown group @%s; available: %s", name, strings.Join(names, ", "))
|
||||||
|
}
|
||||||
|
if e.visiting[name] {
|
||||||
|
return fmt.Errorf("group @%s contains itself", name)
|
||||||
|
}
|
||||||
|
e.visiting[name] = true
|
||||||
|
defer delete(e.visiting, name)
|
||||||
|
for _, member := range members {
|
||||||
|
if err := e.expand(member); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// query expands tag: and cluster: through NetBox, plus static hosts for tags;
|
||||||
|
// if NetBox fails, the cache answers with a warning.
|
||||||
|
func (e *expander) query(selector string, opts netbox.SearchOptions, defaultKind string) error {
|
||||||
|
kind := e.kind
|
||||||
|
if kind == "" {
|
||||||
|
kind = defaultKind
|
||||||
|
}
|
||||||
|
if kind != "all" {
|
||||||
|
opts.Kind = kind
|
||||||
|
}
|
||||||
|
before := len(e.targets)
|
||||||
|
if opts.Tag != "" && (kind == "all" || kind == config.StaticKind) {
|
||||||
|
for _, host := range e.cfg.Hosts {
|
||||||
|
if hasTag(host.Tags, opts.Tag) {
|
||||||
|
e.add(host.Name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if e.cfg.HasNetBox() {
|
||||||
|
if e.client == nil {
|
||||||
|
e.client = newNetBoxClient(e.cfg)
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
||||||
|
entries, err := e.client.SearchAll(ctx, "", opts)
|
||||||
|
cancel()
|
||||||
|
if err != nil {
|
||||||
|
e.warnings = append(e.warnings, fmt.Sprintf("%s: NetBox unavailable, using the cache: %v", selector, err))
|
||||||
|
entries = e.fromCache(opts)
|
||||||
|
} else {
|
||||||
|
sort.Slice(entries, func(i, j int) bool { return entries[i].Target() < entries[j].Target() })
|
||||||
|
}
|
||||||
|
for _, entry := range entries {
|
||||||
|
e.add(entry.Target())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(e.targets) == before {
|
||||||
|
hint := ""
|
||||||
|
if opts.Cluster != "" && e.kind == "" {
|
||||||
|
hint = " (only devices by default; try --kind vm or --kind all)"
|
||||||
|
}
|
||||||
|
return fmt.Errorf("%s matches no hosts%s", selector, hint)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *expander) fromCache(opts netbox.SearchOptions) []netbox.HostEntry {
|
||||||
|
var out []netbox.HostEntry
|
||||||
|
for _, entry := range e.cache.All() {
|
||||||
|
if entry.Static || opts.Kind != "" && entry.Kind != opts.Kind {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if opts.Tag != "" && !hasTag(entry.Tags, opts.Tag) || opts.Cluster != "" && !strings.EqualFold(entry.Cluster, opts.Cluster) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
source, name := netbox.SplitTarget(entry.Name)
|
||||||
|
out = append(out, netbox.HostEntry{Source: source, Name: name, Kind: entry.Kind})
|
||||||
|
}
|
||||||
|
sort.Slice(out, func(i, j int) bool { return out[i].Target() < out[j].Target() })
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// hasTag compares a tag by name or slug, like ssh.rules.
|
||||||
|
func hasTag(tags []string, want string) bool {
|
||||||
|
for _, tag := range tags {
|
||||||
|
if strings.EqualFold(tag, want) || strings.EqualFold(strings.Join(strings.Fields(strings.ToLower(tag)), "-"), want) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// multiCompletions offers hosts, @groups, and tag:/cluster: values from the cache.
|
||||||
|
func multiCompletions(cfg *config.Config, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) {
|
||||||
|
c := newCache(cfg)
|
||||||
|
_ = c.Load()
|
||||||
|
lower := strings.ToLower(toComplete)
|
||||||
|
var out []string
|
||||||
|
switch {
|
||||||
|
case strings.HasPrefix(lower, "tag:"), strings.HasPrefix(lower, "cluster:"):
|
||||||
|
prefix, value, _ := strings.Cut(lower, ":")
|
||||||
|
values := map[string]bool{}
|
||||||
|
for _, entry := range c.All() {
|
||||||
|
if prefix == "tag" {
|
||||||
|
for _, tag := range entry.Tags {
|
||||||
|
values[strings.ToLower(tag)] = true
|
||||||
|
}
|
||||||
|
} else if entry.Cluster != "" {
|
||||||
|
values[entry.Cluster] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for v := range values {
|
||||||
|
if strings.HasPrefix(strings.ToLower(v), value) {
|
||||||
|
out = append(out, prefix+":"+v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case strings.HasPrefix(lower, "@"):
|
||||||
|
for group := range cfg.Groups {
|
||||||
|
if strings.HasPrefix("@"+group, lower) {
|
||||||
|
out = append(out, "@"+group)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
out = completeHosts(toComplete)
|
||||||
|
var prefixes []string
|
||||||
|
for _, p := range []string{"tag:", "cluster:"} {
|
||||||
|
if toComplete != "" && strings.HasPrefix(p, lower) {
|
||||||
|
prefixes = append(prefixes, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(out) == 0 && len(prefixes) > 0 {
|
||||||
|
return prefixes, cobra.ShellCompDirectiveNoSpace | cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
for group := range cfg.Groups {
|
||||||
|
if toComplete == "" {
|
||||||
|
out = append(out, "@"+group)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Strings(out)
|
||||||
|
return out, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestExpandSelectors(t *testing.T) {
|
||||||
|
cfg := &config.Config{
|
||||||
|
Hosts: []config.StaticHost{{Name: "box", Address: "10.0.0.1", Tags: []string{"Web Servers"}}},
|
||||||
|
Groups: map[string][]string{
|
||||||
|
"all": {"@web", "db1", "box"},
|
||||||
|
"web": {"web1", "tag:web-servers", "web1"},
|
||||||
|
"loop": {"@loop"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
c := cache.New(t.TempDir()+"/hosts.json", 60).WithStatic(cfg.Hosts)
|
||||||
|
got, _, err := expandSelectors(cfg, c, []string{"@all", "WEB1"}, "")
|
||||||
|
if err != nil || !reflect.DeepEqual(got, []string{"web1", "box", "db1"}) {
|
||||||
|
t.Fatalf("got %v %v", got, err)
|
||||||
|
}
|
||||||
|
if _, _, err := expandSelectors(cfg, c, []string{"@loop"}, ""); err == nil || !strings.Contains(err.Error(), "contains itself") {
|
||||||
|
t.Fatalf("cycle: %v", err)
|
||||||
|
}
|
||||||
|
if _, _, err := expandSelectors(cfg, c, []string{"@nope"}, ""); err == nil || !strings.Contains(err.Error(), "available: @all, @loop, @web") {
|
||||||
|
t.Fatalf("unknown group: %v", err)
|
||||||
|
}
|
||||||
|
if _, _, err := expandSelectors(cfg, c, []string{"tag:web-servers"}, "device"); err == nil {
|
||||||
|
t.Fatal("--kind device must exclude static hosts")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Without a reachable NetBox, tag: and cluster: fall back to the cache.
|
||||||
|
func TestExpandSelectorsCacheFallback(t *testing.T) {
|
||||||
|
cfg := &config.Config{NetBox: config.NetBoxConfig{URL: "http://127.0.0.1:1", Token: "t", TokenVersion: 1}}
|
||||||
|
c := cache.New(t.TempDir()+"/hosts.json", 60)
|
||||||
|
c.Upsert(cache.Entry{Name: "node2", Kind: "device", Cluster: "pve"})
|
||||||
|
c.Upsert(cache.Entry{Name: "node1", Kind: "device", Cluster: "pve", Tags: []string{"pve"}})
|
||||||
|
c.Upsert(cache.Entry{Name: "vm1", Kind: "vm", Cluster: "pve"})
|
||||||
|
got, warnings, err := expandSelectors(cfg, c, []string{"cluster:PVE"}, "")
|
||||||
|
if err != nil || !reflect.DeepEqual(got, []string{"node1", "node2"}) || len(warnings) != 1 {
|
||||||
|
t.Fatalf("devices: %v %v %v", got, warnings, err)
|
||||||
|
}
|
||||||
|
if got, _, _ := expandSelectors(cfg, c, []string{"cluster:pve"}, "all"); len(got) != 3 {
|
||||||
|
t.Fatalf("all: %v", got)
|
||||||
|
}
|
||||||
|
if _, _, err := expandSelectors(cfg, c, []string{"cluster:other"}, ""); err == nil || !strings.Contains(err.Error(), "--kind vm") {
|
||||||
|
t.Fatalf("empty cluster: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMultiLabelAndPaneArgv(t *testing.T) {
|
||||||
|
for selectors, want := range map[string]string{"@k8s": "k8s", "cluster:pve-fsn1": "pve-fsn1", "tag:a.b": "a-b", "a b": "multi"} {
|
||||||
|
if got := multiLabel(strings.Fields(selectors)); got != want {
|
||||||
|
t.Errorf("%q: got %q", selectors, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", "/cfg")
|
||||||
|
t.Setenv("NETSSH_NETBOX_TOKEN", "secret")
|
||||||
|
argv := strings.Join(paneArgv("prod/web1", multiFlags{user: "ops", jump: "jh"}), " ")
|
||||||
|
for _, want := range []string{"NETSSH_NO_REFRESH=1", "XDG_CONFIG_HOME=/cfg", "--jump jh -l ops prod/web1"} {
|
||||||
|
if !strings.Contains(argv, want) {
|
||||||
|
t.Errorf("argv lacks %q: %s", want, argv)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if strings.Contains(argv, "secret") {
|
||||||
|
t.Fatalf("token leaked into the pane arguments: %s", argv)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMultiDryRun(t *testing.T) {
|
||||||
|
prepareConfig(t, "hosts:\n - {name: a, address: 10.0.0.1, tags: [web]}\n - {name: b, address: 10.0.0.2, tags: [web]}\ngroups:\n web: [\"tag:web\"]\n")
|
||||||
|
out, err := runNetssh(t, "multi", "--dry-run", "--tmux", "--sync", "@web")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("%s %v", out, err)
|
||||||
|
}
|
||||||
|
for _, want := range []string{"# 2 hosts: a b", "tmux new-session -d -x 240 -y 70 -s netssh-web", "synchronize-panes on", "tmux attach-session -t netssh-web"} {
|
||||||
|
if !strings.Contains(out, want) {
|
||||||
|
t.Errorf("missing %q:\n%s", want, out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if out, err := runNetssh(t, "multi", "--dry-run", "--zellij", "a", "b"); err != nil || !strings.Contains(out, `pane name="b"`) {
|
||||||
|
t.Errorf("zellij: %s %v", out, err)
|
||||||
|
}
|
||||||
|
if out, err := runNetssh(t, "sync"); err == nil || !strings.Contains(out, "inside tmux or zellij") {
|
||||||
|
t.Errorf("sync outside: %s %v", out, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
-1
@@ -38,7 +38,7 @@ func notesCmd() *cobra.Command {
|
|||||||
client = newNetBoxClient(cfg)
|
client = newNetBoxClient(cfg)
|
||||||
}
|
}
|
||||||
host := netbox.HostEntry{Name: args[0], Kind: kind}
|
host := netbox.HostEntry{Name: args[0], Kind: kind}
|
||||||
c := cache.New(cfg.CachePath(), cfg.Cache.TTL)
|
c := newCache(cfg)
|
||||||
if err := c.Load(); err != nil {
|
if err := c.Load(); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,193 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/activity"
|
||||||
|
"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/resolver"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
)
|
||||||
|
|
||||||
|
func doctorCmd() *cobra.Command {
|
||||||
|
var online bool
|
||||||
|
cmd := &cobra.Command{Use: "doctor", Short: "Check configuration, programs, cache and optional NetBox connectivity", Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, _ []string) error {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
failed := false
|
||||||
|
report := func(label string, err error) {
|
||||||
|
if err != nil {
|
||||||
|
failed = true
|
||||||
|
fmt.Fprintf(cmd.OutOrStdout(), "FAIL %s: %v\n", label, err)
|
||||||
|
} else {
|
||||||
|
fmt.Fprintf(cmd.OutOrStdout(), "OK %s\n", label)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
report("configuration", nil)
|
||||||
|
_, err = resolver.New(cfg.Resolver)
|
||||||
|
report("resolver", err)
|
||||||
|
programs := map[string]bool{"ssh": true, "sftp": true, "scp": true}
|
||||||
|
for name, c := range cfg.Commands {
|
||||||
|
programs[c.Args[0]] = true
|
||||||
|
if len(c.Args) > 1 && !strings.HasPrefix(c.Args[1], "-") {
|
||||||
|
switch c.Args[0] {
|
||||||
|
case "bash", "sh", "python", "python3":
|
||||||
|
f, err := os.Open(c.Args[1])
|
||||||
|
if err == nil {
|
||||||
|
f.Close()
|
||||||
|
}
|
||||||
|
report("script "+name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var names []string
|
||||||
|
for p := range programs {
|
||||||
|
names = append(names, p)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
for _, p := range names {
|
||||||
|
_, err := exec.LookPath(p)
|
||||||
|
report("program "+p, err)
|
||||||
|
}
|
||||||
|
report("cache", newCache(cfg).Load())
|
||||||
|
if online {
|
||||||
|
sources := cfg.NetBoxes
|
||||||
|
if len(sources) == 0 && cfg.NetBox.URL != "" {
|
||||||
|
sources = []config.NetBoxConfig{cfg.NetBox}
|
||||||
|
}
|
||||||
|
for _, s := range sources {
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
_, err := netbox.NewClient(s.URL, s.Token, s.TokenVersion).Search(ctx, "", netbox.SearchOptions{})
|
||||||
|
cancel()
|
||||||
|
report("NetBox "+s.Name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if failed {
|
||||||
|
return fmt.Errorf("doctor found problems")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}}
|
||||||
|
cmd.Flags().BoolVar(&online, "online", false, "Also query every NetBox instance")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
func explainCmd() *cobra.Command {
|
||||||
|
return &cobra.Command{Use: "explain HOST", Short: "Explain actual host resolution and effective SSH settings without connecting", Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
h, err := resolveTargetE(cfg, args[0], false)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
selectors := commandHost(h)
|
||||||
|
user, port := hostDefaults(cfg, h)
|
||||||
|
opts := hostOptions(cfg, h)
|
||||||
|
var rules []int
|
||||||
|
for i, r := range cfg.SSH.Rules {
|
||||||
|
if r.Match.Matches(selectors) {
|
||||||
|
rules = append(rules, i+1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
strategy := h.Resolver
|
||||||
|
if strategy == "" {
|
||||||
|
if h.Origin == "static" {
|
||||||
|
strategy = "static address"
|
||||||
|
} else {
|
||||||
|
strategy = "not recorded in this cache entry"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return json.NewEncoder(cmd.OutOrStdout()).Encode(map[string]any{
|
||||||
|
"target": h.Name, "instance": selectors.Instance, "address": h.IP, "source": h.Origin, "cached_at": h.CachedAt,
|
||||||
|
"resolver_order": cfg.Resolver.Strategies, "resolver_used": strategy, "matching_rules": rules, "user": user, "port": port, "ssh": opts,
|
||||||
|
})
|
||||||
|
}}
|
||||||
|
}
|
||||||
|
func favoritesCmd() *cobra.Command {
|
||||||
|
cmd := &cobra.Command{Use: "favorites", Short: "List or change favorite and pinned hosts", RunE: func(cmd *cobra.Command, _ []string) error {
|
||||||
|
s, err := activity.Read()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var names []string
|
||||||
|
for n := range s.Favorites {
|
||||||
|
if s.Favorites[n] {
|
||||||
|
names = append(names, n)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
for _, n := range names {
|
||||||
|
marker := "favorite"
|
||||||
|
if s.Pinned[n] {
|
||||||
|
marker = "pinned"
|
||||||
|
}
|
||||||
|
fmt.Fprintf(cmd.OutOrStdout(), "%s\t%s\n", n, marker)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}}
|
||||||
|
for _, action := range []string{"add", "remove", "pin", "unpin"} {
|
||||||
|
cmd.AddCommand(&cobra.Command{Use: action + " HOST", Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
target := args[0]
|
||||||
|
if action == "add" || action == "pin" {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
h, err := resolveTargetE(cfg, target, false)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
target = h.Name
|
||||||
|
}
|
||||||
|
return activity.Update(func(s *activity.State) {
|
||||||
|
switch action {
|
||||||
|
case "add":
|
||||||
|
s.Favorites[target] = true
|
||||||
|
case "pin":
|
||||||
|
s.Favorites[target] = true
|
||||||
|
s.Pinned[target] = true
|
||||||
|
case "unpin":
|
||||||
|
delete(s.Pinned, target)
|
||||||
|
case "remove":
|
||||||
|
delete(s.Favorites, target)
|
||||||
|
delete(s.Pinned, target)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}})
|
||||||
|
}
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
func historyCmd() *cobra.Command {
|
||||||
|
cmd := &cobra.Command{Use: "history", Short: "Show optional local action history", RunE: func(cmd *cobra.Command, _ []string) error {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := activity.Update(func(s *activity.State) { activity.Prune(s, cfg.Activity) }); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
s, err := activity.Read()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for i := len(s.Records) - 1; i >= 0; i-- {
|
||||||
|
r := s.Records[i]
|
||||||
|
fmt.Fprintf(cmd.OutOrStdout(), "%s\t%s\t%s\texit=%d\t%s\n", r.Time.Format(time.RFC3339), r.Host, r.Command, r.Code, r.Duration.Round(time.Millisecond))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}}
|
||||||
|
cmd.AddCommand(&cobra.Command{Use: "clear", Short: "Delete recorded actions, preserving favorites", Args: cobra.NoArgs, RunE: func(_ *cobra.Command, _ []string) error {
|
||||||
|
return activity.Update(func(s *activity.State) { s.Records = nil })
|
||||||
|
}})
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
@@ -0,0 +1,258 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/activity"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func writeOperationsConfig(t *testing.T, extra string) {
|
||||||
|
t.Helper()
|
||||||
|
prepareTransferTest(t)
|
||||||
|
data := `hosts:
|
||||||
|
- name: router
|
||||||
|
address: 192.0.2.1
|
||||||
|
tags: [router]
|
||||||
|
- name: fail
|
||||||
|
address: 192.0.2.2
|
||||||
|
- name: okay
|
||||||
|
address: 192.0.2.3
|
||||||
|
resolver:
|
||||||
|
strategies: [primary_ip]
|
||||||
|
` + extra
|
||||||
|
if err := os.WriteFile(config.Path(), []byte(data), 0600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func TestPostHooksFiltersAndConfirmation(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
marker := filepath.Join(dir, "post")
|
||||||
|
writeOperationsConfig(t, fmt.Sprintf(`
|
||||||
|
commands:
|
||||||
|
success:
|
||||||
|
args: [sh, -c, "exit 0", "{host}"]
|
||||||
|
post_run: 'printf "%%s:%%s" "$NETSSH_HOST" "$NETSSH_EXIT_CODE" > %s'
|
||||||
|
failure:
|
||||||
|
args: [sh, -c, "exit 7", "{host}"]
|
||||||
|
post_run: 'printf "%%s" "$NETSSH_EXIT_CODE" > %s; exit 9'
|
||||||
|
postfail:
|
||||||
|
args: [sh, -c, "exit 0", "{host}"]
|
||||||
|
post_run: exit 9
|
||||||
|
protected:
|
||||||
|
args: [sh, -c, "exit 0", "{host}"]
|
||||||
|
confirm: true
|
||||||
|
match: {tag: router, kind: static, name: "rou*"}
|
||||||
|
timeout:
|
||||||
|
args: [sh, -c, "sleep 20", "{host}"]
|
||||||
|
timeout: 50ms
|
||||||
|
activity:
|
||||||
|
enabled: true
|
||||||
|
retention_days: 30
|
||||||
|
max_entries: 50
|
||||||
|
`, marker, marker))
|
||||||
|
if out, err := runNetssh(t, "run", "--dry-run", "success", "router"); err != nil {
|
||||||
|
t.Fatalf("%s %v", out, err)
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(marker); !os.IsNotExist(err) {
|
||||||
|
t.Fatal("dry-run executed post hook")
|
||||||
|
}
|
||||||
|
if out, err := runNetssh(t, "run", "success", "router"); err != nil {
|
||||||
|
t.Fatalf("%s %v", out, err)
|
||||||
|
}
|
||||||
|
data, _ := os.ReadFile(marker)
|
||||||
|
if string(data) != "router:0" {
|
||||||
|
t.Fatal(string(data))
|
||||||
|
}
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
code int
|
||||||
|
}{{"failure", 7}, {"postfail", 9}, {"timeout", 124}} {
|
||||||
|
_, err := runNetssh(t, "run", tc.name, "router")
|
||||||
|
exit, ok := err.(*exec.ExitError)
|
||||||
|
if !ok || exit.ExitCode() != tc.code {
|
||||||
|
t.Fatalf("%s: %v", tc.name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
data, _ = os.ReadFile(marker)
|
||||||
|
if string(data) != "7" {
|
||||||
|
t.Fatal(string(data))
|
||||||
|
}
|
||||||
|
if out, err := runNetssh(t, "run", "protected", "router"); err == nil || !strings.Contains(out, "--yes") {
|
||||||
|
t.Fatalf("%q %v", out, err)
|
||||||
|
}
|
||||||
|
if out, err := runNetssh(t, "run", "--yes", "protected", "router"); err != nil {
|
||||||
|
t.Fatalf("%q %v", out, err)
|
||||||
|
}
|
||||||
|
if out, err := runNetssh(t, "run", "--yes", "protected", "okay"); err == nil || !strings.Contains(out, "not allowed") {
|
||||||
|
t.Fatalf("%q %v", out, err)
|
||||||
|
}
|
||||||
|
state, err := activity.Read()
|
||||||
|
if err != nil || len(state.Records) != 5 {
|
||||||
|
t.Fatalf("%+v %v", state, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func TestSSHPostDisconnect(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
marker := filepath.Join(dir, "after")
|
||||||
|
writeOperationsConfig(t, fmt.Sprintf("ssh:\n post_disconnect: 'printf \"%%s\" \"$NETSSH_EXIT_CODE\" > %s'\n", marker))
|
||||||
|
if err := os.WriteFile(filepath.Join(dir, "ssh"), []byte("#!/bin/sh\nexit 6\n"), 0700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Setenv("PATH", dir+string(os.PathListSeparator)+os.Getenv("PATH"))
|
||||||
|
_, err := runNetssh(t, "router")
|
||||||
|
exit, ok := err.(*exec.ExitError)
|
||||||
|
if !ok || exit.ExitCode() != 6 {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
data, _ := os.ReadFile(marker)
|
||||||
|
if string(data) != "6" {
|
||||||
|
t.Fatalf("post: %s", data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func TestExplainAndFavorites(t *testing.T) {
|
||||||
|
writeOperationsConfig(t, "tui:\n history_limit: 25\nssh:\n rules:\n - match: {tag: router}\n post_disconnect: echo done\n")
|
||||||
|
out, err := runNetssh(t, "explain", "router")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("%s %v", out, err)
|
||||||
|
}
|
||||||
|
var result map[string]any
|
||||||
|
if err := json.Unmarshal([]byte(out), &result); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if result["source"] != "static" || result["address"] != "192.0.2.1" {
|
||||||
|
t.Fatal(result)
|
||||||
|
}
|
||||||
|
for _, args := range [][]string{{"favorites", "pin", "router"}, {"favorites", "add", "okay"}} {
|
||||||
|
if out, err := runNetssh(t, args...); err != nil {
|
||||||
|
t.Fatalf("%s %v", out, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
state, err := activity.Read()
|
||||||
|
if err != nil || !state.Pinned["router"] || !state.Favorites["okay"] {
|
||||||
|
t.Fatalf("%+v %v", state, err)
|
||||||
|
}
|
||||||
|
if out, err := runNetssh(t, "favorites", "remove", "router"); err != nil {
|
||||||
|
t.Fatalf("%s %v", out, err)
|
||||||
|
}
|
||||||
|
state, _ = activity.Read()
|
||||||
|
if state.Pinned["router"] || state.Favorites["router"] {
|
||||||
|
t.Fatal(state)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func TestPortableConfigOmitsAllExecutableSecrets(t *testing.T) {
|
||||||
|
c := config.Config{
|
||||||
|
NetBoxes: []config.NetBoxConfig{{Name: "prod", URL: "https://user:URLSECRET@netbox.example", Token: "TOKEN", SSH: config.SSHOptions{PreConnect: "HOOKSECRET"}}},
|
||||||
|
SSH: config.SSHConfig{SSHOptions: config.SSHOptions{Options: map[string]string{"ProxyCommand": "OPTIONSECRET"}, PostDisconnect: "POSTSECRET"}},
|
||||||
|
Commands: map[string]config.HostCommand{"check": {Args: []string{"echo", "COMMANDSECRET", "{host}"}}},
|
||||||
|
Hosts: []config.StaticHost{{Name: "router", Address: "192.0.2.1", SSH: config.SSHOptions{PreConnect: "STATICSECRET"}}},
|
||||||
|
TUI: config.TUIConfig{HistoryLimit: 25},
|
||||||
|
}
|
||||||
|
data, err := json.Marshal(portableConfig(c))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, secret := range []string{"URLSECRET", "TOKEN", "HOOKSECRET", "OPTIONSECRET", "POSTSECRET", "COMMANDSECRET", "STATICSECRET"} {
|
||||||
|
if bytes.Contains(data, []byte(secret)) {
|
||||||
|
t.Fatalf("export leaked %s", secret)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
parsed, err := decodePortable(data)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if parsed.TUI.HistoryLimit != 25 || len(parsed.NetBoxes) != 1 || parsed.NetBoxes[0].URL != "https://netbox.example" {
|
||||||
|
t.Fatalf("%+v", parsed)
|
||||||
|
}
|
||||||
|
hostile := []byte("netbox:\n url: https://netbox.example\n token: bad\nssh:\n pre_connect: touch /tmp/never\ncommands:\n check:\n args: [sh, -c, evil]\n")
|
||||||
|
parsed, err = decodePortable(hostile)
|
||||||
|
if err != nil || parsed.NetBox.Token != "" || parsed.SSH.PreConnect != "" || len(parsed.Commands) != 0 {
|
||||||
|
t.Fatalf("%+v %v", parsed, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func TestBatchRetryFailedOnly(t *testing.T) {
|
||||||
|
bin := filepath.Join(t.TempDir(), "netssh")
|
||||||
|
build := exec.Command("go", "build", "-o", bin, ".")
|
||||||
|
if out, err := build.CombinedOutput(); err != nil {
|
||||||
|
t.Fatalf("build: %s %v", out, err)
|
||||||
|
}
|
||||||
|
old := batchExecutable
|
||||||
|
batchExecutable = func() (string, error) { return bin, nil }
|
||||||
|
t.Cleanup(func() { batchExecutable = old })
|
||||||
|
dir := t.TempDir()
|
||||||
|
script := filepath.Join(dir, "check.sh")
|
||||||
|
ready := filepath.Join(dir, "ready")
|
||||||
|
if err := os.WriteFile(script, []byte(fmt.Sprintf("#!/bin/sh\nif [ \"$1\" = fail ] && [ ! -f %q ]; then exit 3; fi\nprintf 'ran %%s\\n' \"$1\"\n", ready)), 0700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
writeOperationsConfig(t, fmt.Sprintf("commands:\n check:\n args: [%q, \"{host}\"]\n", script))
|
||||||
|
run := func(args ...string) (string, error) {
|
||||||
|
cmd := batchCmd()
|
||||||
|
cmd.SetArgs(args)
|
||||||
|
var out bytes.Buffer
|
||||||
|
cmd.SetOut(&out)
|
||||||
|
cmd.SetErr(&out)
|
||||||
|
err := cmd.Execute()
|
||||||
|
return out.String(), err
|
||||||
|
}
|
||||||
|
out, err := run("--parallel", "2", "check", "router", "fail", "okay")
|
||||||
|
if err == nil || !strings.Contains(out, "2 succeeded, 1 failed") {
|
||||||
|
t.Fatalf("%s %v", out, err)
|
||||||
|
}
|
||||||
|
data, _ := os.ReadFile(batchPath())
|
||||||
|
var retry batchRetry
|
||||||
|
if err := json.Unmarshal(data, &retry); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(retry.Hosts, []string{"fail"}) {
|
||||||
|
t.Fatalf("%+v", retry)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(ready, nil, 0600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
out, err = run("--retry-failed")
|
||||||
|
if err != nil || !strings.Contains(out, "1 succeeded, 0 failed") || strings.Contains(out, "ran router") {
|
||||||
|
t.Fatalf("%s %v", out, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestImportPreservesOnlyMatchingCredentials(t *testing.T) {
|
||||||
|
writeOperationsConfig(t, "")
|
||||||
|
original := []byte("netboxes:\n - name: prod\n url: https://prod.example\n token: LOCALPROD\n - name: lab\n url: https://lab.example\n token: LOCALLAB\ncommands:\n local:\n args: [echo, \"{host}\"]\n")
|
||||||
|
if err := os.WriteFile(config.Path(), original, 0600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
shared := filepath.Join(t.TempDir(), "shared.yaml")
|
||||||
|
if err := os.WriteFile(shared, []byte("netboxes:\n - name: prod\n url: https://prod.example\n token: UNTRUSTED\n - name: lab\n url: https://other.example\ntui:\n history_limit: 25\nssh:\n pre_connect: evil\n"), 0600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if out, err := runNetssh(t, "config", "import", shared, "--dry-run"); err != nil {
|
||||||
|
t.Fatalf("%s %v", out, err)
|
||||||
|
}
|
||||||
|
after, _ := os.ReadFile(config.Path())
|
||||||
|
if !bytes.Equal(original, after) {
|
||||||
|
t.Fatal("preview changed config")
|
||||||
|
}
|
||||||
|
if out, err := runNetssh(t, "config", "import", shared, "--yes"); err != nil {
|
||||||
|
t.Fatalf("%s %v", out, err)
|
||||||
|
}
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if cfg.NetBoxes[0].Token != "LOCALPROD" || cfg.NetBoxes[1].Token != "" || cfg.SSH.PreConnect != "" || len(cfg.Commands) != 1 || cfg.TUI.HistoryLimit != 25 {
|
||||||
|
t.Fatalf("incorrect imported settings: names=%d tui=%d", len(cfg.NetBoxes), cfg.TUI.HistoryLimit)
|
||||||
|
}
|
||||||
|
backup, _ := os.ReadFile(config.Path() + ".before-import")
|
||||||
|
if !bytes.Equal(backup, original) {
|
||||||
|
t.Fatal("backup differs")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,164 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"net/url"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/setup"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/storage"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
"github.com/spf13/viper"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Portable config deliberately omits arbitrary command/hook/SSH option strings:
|
||||||
|
// secrets may be embedded there, and cannot reliably be detected by key name.
|
||||||
|
func portableConfig(c config.Config) map[string]any {
|
||||||
|
cleanURL := func(raw string) string {
|
||||||
|
u, err := url.Parse(raw)
|
||||||
|
if err != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
u.User = nil
|
||||||
|
u.RawQuery = ""
|
||||||
|
u.Fragment = ""
|
||||||
|
return u.String()
|
||||||
|
}
|
||||||
|
sources := []map[string]any{}
|
||||||
|
for _, s := range c.NetBoxes {
|
||||||
|
sources = append(sources, map[string]any{"name": s.Name, "url": cleanURL(s.URL), "disable_prefix": s.DisablePrefix})
|
||||||
|
}
|
||||||
|
hosts := []map[string]any{}
|
||||||
|
for _, h := range c.Hosts {
|
||||||
|
hosts = append(hosts, map[string]any{"name": h.Name, "address": h.Address, "user": h.User, "port": h.Port, "tags": h.Tags})
|
||||||
|
}
|
||||||
|
rewrites := []map[string]string{}
|
||||||
|
for _, r := range c.Shortcuts.Rewrites {
|
||||||
|
rewrites = append(rewrites, map[string]string{"pattern": r.Pattern, "replace": r.Replace})
|
||||||
|
}
|
||||||
|
out := map[string]any{
|
||||||
|
"hosts": hosts, "groups": c.Groups,
|
||||||
|
"ssh": map[string]any{"default_user": c.SSH.DefaultUser, "default_port": c.SSH.DefaultPort},
|
||||||
|
"resolver": map[string]any{"strategies": c.Resolver.Strategies, "management_subnets": c.Resolver.ManagementSubnets, "interface_name": c.Resolver.InterfaceName, "hostname_domain": c.Resolver.HostnameDomain},
|
||||||
|
"shortcuts": map[string]any{"domains": c.Shortcuts.Domains, "rewrites": rewrites, "strip_hyphens": c.Shortcuts.StripHyphens, "show": c.Shortcuts.Show},
|
||||||
|
"completion": map[string]any{"max_results": c.Completion.MaxResults},
|
||||||
|
"tui": map[string]any{"history_limit": c.TUI.HistoryLimit},
|
||||||
|
}
|
||||||
|
if len(sources) > 0 {
|
||||||
|
out["netboxes"] = sources
|
||||||
|
} else if c.NetBox.URL != "" {
|
||||||
|
out["netbox"] = map[string]string{"url": cleanURL(c.NetBox.URL)}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
func decodePortable(data []byte) (config.Config, error) {
|
||||||
|
v := viper.New()
|
||||||
|
v.SetConfigType("yaml")
|
||||||
|
v.SetDefault("tui.history_limit", 10)
|
||||||
|
var c config.Config
|
||||||
|
if err := v.ReadConfig(bytes.NewReader(data)); err != nil {
|
||||||
|
return c, err
|
||||||
|
}
|
||||||
|
if err := v.Unmarshal(&c); err != nil {
|
||||||
|
return c, err
|
||||||
|
}
|
||||||
|
// Strip executable settings and credentials even from externally edited files.
|
||||||
|
safe, _ := json.Marshal(portableConfig(c))
|
||||||
|
v = viper.New()
|
||||||
|
v.SetConfigType("json")
|
||||||
|
if err := v.ReadConfig(bytes.NewReader(safe)); err != nil {
|
||||||
|
return c, err
|
||||||
|
}
|
||||||
|
c = config.Config{}
|
||||||
|
err := v.Unmarshal(&c)
|
||||||
|
return c, err
|
||||||
|
}
|
||||||
|
func configCmd() *cobra.Command {
|
||||||
|
cmd := &cobra.Command{Use: "config", Short: "Share configuration without credentials or executable settings"}
|
||||||
|
export := &cobra.Command{Use: "export [FILE]", Short: "Export a secret-free JSON configuration (also valid YAML)", Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
data, err := json.MarshalIndent(portableConfig(*cfg), "", " ")
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if len(args) == 0 {
|
||||||
|
fmt.Fprintln(cmd.OutOrStdout(), string(data))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return storage.WriteFile(args[0], append(data, '\n'), 0600)
|
||||||
|
}}
|
||||||
|
var yes, dry bool
|
||||||
|
imp := &cobra.Command{Use: "import FILE", Short: "Import shared host settings; preserve matching local credentials and commands", Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
data, err := os.ReadFile(args[0])
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
incoming, err := decodePortable(data)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
current, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
same := func(a, b string) bool { return strings.TrimRight(a, "/") == strings.TrimRight(b, "/") }
|
||||||
|
for i := range incoming.NetBoxes {
|
||||||
|
for _, old := range current.NetBoxes {
|
||||||
|
s := &incoming.NetBoxes[i]
|
||||||
|
if strings.EqualFold(s.Name, old.Name) && same(s.URL, old.URL) {
|
||||||
|
s.Token = old.Token
|
||||||
|
s.TokenVersion = old.TokenVersion
|
||||||
|
s.SSH = old.SSH
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if incoming.NetBox.URL != "" && same(incoming.NetBox.URL, current.NetBox.URL) {
|
||||||
|
incoming.NetBox.Token = current.NetBox.Token
|
||||||
|
incoming.NetBox.TokenVersion = current.NetBox.TokenVersion
|
||||||
|
incoming.NetBox.SSH = current.NetBox.SSH
|
||||||
|
}
|
||||||
|
incoming.Commands = current.Commands
|
||||||
|
incoming.Activity = current.Activity
|
||||||
|
incoming.Cache = current.Cache
|
||||||
|
incoming.Multi = current.Multi
|
||||||
|
incoming.Shell = current.Shell
|
||||||
|
incoming.SSH.SSHOptions = current.SSH.SSHOptions
|
||||||
|
incoming.SSH.Rules = current.SSH.Rules
|
||||||
|
for i := range incoming.Hosts {
|
||||||
|
for _, old := range current.Hosts {
|
||||||
|
if incoming.Hosts[i].Name == old.Name && incoming.Hosts[i].Address == old.Address {
|
||||||
|
incoming.Hosts[i].SSH = old.SSH
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, validate := range []func() error{incoming.ValidateNetBoxes, incoming.ValidateHosts, incoming.ValidateSSH, incoming.ValidateCommands, incoming.ValidateOperations, incoming.Shortcuts.Validate, incoming.ValidateMulti} {
|
||||||
|
if err := validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fmt.Fprintf(cmd.OutOrStdout(), "Import: %d named instances, %d static hosts. Local commands and matching credentials are retained.\n", len(incoming.NetBoxes), len(incoming.Hosts))
|
||||||
|
if dry {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := confirmAction("Replace shared configuration settings", yes); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if existing, err := os.ReadFile(config.Path()); err == nil {
|
||||||
|
if err := storage.WriteFile(config.Path()+".before-import", existing, 0600); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return setup.Save(incoming)
|
||||||
|
}}
|
||||||
|
imp.Flags().BoolVar(&yes, "yes", false, "Approve replacing shared configuration settings")
|
||||||
|
imp.Flags().BoolVar(&dry, "dry-run", false, "Validate and preview without writing")
|
||||||
|
cmd.AddCommand(export, imp)
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
||||||
|
)
|
||||||
|
|
||||||
|
// preConnectRunner runs the hook; tests replace it to avoid spawning a shell.
|
||||||
|
var preConnectRunner = runPreConnectCommand
|
||||||
|
|
||||||
|
// preConnectEnv describes the host to the hook through environment variables.
|
||||||
|
func preConnectEnv(host resolvedHost, clientName string) []string {
|
||||||
|
instance, name := netbox.SplitTarget(host.Name)
|
||||||
|
return []string{
|
||||||
|
"NETSSH_HOST=" + name,
|
||||||
|
"NETSSH_TARGET=" + host.Name,
|
||||||
|
"NETSSH_INSTANCE=" + instance,
|
||||||
|
"NETSSH_IP=" + host.IP,
|
||||||
|
"NETSSH_KIND=" + host.Kind,
|
||||||
|
"NETSSH_TAGS=" + strings.Join(host.Tags, ","),
|
||||||
|
"NETSSH_CLIENT=" + clientName,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// runPreConnect runs the configured pre_connect hook for host. Its output goes
|
||||||
|
// to stderr so it never mixes with the output of a remote command or scp.
|
||||||
|
// A failing hook returns an error and the connection must not be opened.
|
||||||
|
func runPreConnect(command string, host resolvedHost, clientName string, dryRun bool) error {
|
||||||
|
if command == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if dryRun {
|
||||||
|
fmt.Fprintf(os.Stderr, "# pre_connect (skipped in --dry-run): %s\n", command)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := preConnectRunner(command, preConnectEnv(host, clientName), os.Stdin, os.Stderr); err != nil {
|
||||||
|
return fmt.Errorf("pre_connect hook for %s failed: %w", host.Name, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func runPreConnectCommand(command string, env []string, stdin io.Reader, out io.Writer) error {
|
||||||
|
cmd := exec.Command("sh", "-c", command)
|
||||||
|
cmd.Env = append(os.Environ(), env...)
|
||||||
|
cmd.Stdin = stdin
|
||||||
|
cmd.Stdout = out
|
||||||
|
cmd.Stderr = out
|
||||||
|
return cmd.Run()
|
||||||
|
}
|
||||||
@@ -0,0 +1,112 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
internalssh "git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/ssh"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRunPreConnectPassesHostAndStopsOnFailure(t *testing.T) {
|
||||||
|
host := resolvedHost{Name: "prod/web01", Kind: "vm", IP: "10.0.0.5", Tags: []string{"dmz", "web"}}
|
||||||
|
var gotCommand string
|
||||||
|
var gotEnv []string
|
||||||
|
fail := false
|
||||||
|
preConnectRunner = func(command string, env []string, _ io.Reader, _ io.Writer) error {
|
||||||
|
gotCommand, gotEnv = command, env
|
||||||
|
if fail {
|
||||||
|
return errors.New("exit status 1")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { preConnectRunner = runPreConnectCommand })
|
||||||
|
|
||||||
|
if err := runPreConnect("vpn-check", host, "sftp", false); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := []string{"NETSSH_HOST=web01", "NETSSH_TARGET=prod/web01", "NETSSH_INSTANCE=prod", "NETSSH_IP=10.0.0.5", "NETSSH_KIND=vm", "NETSSH_TAGS=dmz,web", "NETSSH_CLIENT=sftp"}
|
||||||
|
if gotCommand != "vpn-check" || !reflect.DeepEqual(gotEnv, want) {
|
||||||
|
t.Fatalf("got %q %v", gotCommand, gotEnv)
|
||||||
|
}
|
||||||
|
|
||||||
|
fail = true
|
||||||
|
if err := runPreConnect("vpn-check", host, "ssh", false); err == nil || !strings.Contains(err.Error(), "prod/web01") {
|
||||||
|
t.Fatalf("failure not reported: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
gotCommand = ""
|
||||||
|
if err := runPreConnect("vpn-check", host, "ssh", true); err != nil || gotCommand != "" {
|
||||||
|
t.Fatalf("dry-run ran the hook: %v %q", err, gotCommand)
|
||||||
|
}
|
||||||
|
if err := runPreConnect("", host, "ssh", false); err != nil || gotCommand != "" {
|
||||||
|
t.Fatalf("empty hook ran: %v %q", err, gotCommand)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunPreConnectCommandUsesShell(t *testing.T) {
|
||||||
|
var out bytes.Buffer
|
||||||
|
err := runPreConnectCommand(`echo "$NETSSH_HOST via $NETSSH_CLIENT"`, []string{"NETSSH_HOST=web01", "NETSSH_CLIENT=ssh"}, strings.NewReader(""), &out)
|
||||||
|
if err != nil || out.String() != "web01 via ssh\n" {
|
||||||
|
t.Fatalf("got %q, %v", out.String(), err)
|
||||||
|
}
|
||||||
|
if err := runPreConnectCommand("exit 3", nil, strings.NewReader(""), io.Discard); err == nil {
|
||||||
|
t.Fatal("non-zero exit not reported")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --dry-run only prints the ssh command: it must not run the hook, which may
|
||||||
|
// have side effects (bringing up a VPN, logging).
|
||||||
|
func TestConnectHostDryRunSkipsPreConnect(t *testing.T) {
|
||||||
|
ran := 0
|
||||||
|
preConnectRunner = func(string, []string, io.Reader, io.Writer) error { ran++; return nil }
|
||||||
|
t.Cleanup(func() { preConnectRunner = runPreConnectCommand })
|
||||||
|
cfg := &config.Config{SSH: config.SSHConfig{SSHOptions: config.SSHOptions{PreConnect: "hook"}}}
|
||||||
|
stdout := os.Stdout
|
||||||
|
r, w, _ := os.Pipe()
|
||||||
|
os.Stdout = w
|
||||||
|
connectHost(cfg, internalssh.SSH, internalssh.WrapperFlags{DryRun: true}, resolvedHost{Name: "web01", IP: "10.0.0.1"}, []int{0}, []string{"web01"})
|
||||||
|
w.Close()
|
||||||
|
os.Stdout = stdout
|
||||||
|
printed, _ := io.ReadAll(r)
|
||||||
|
if ran != 0 || !strings.Contains(string(printed), "10.0.0.1") {
|
||||||
|
t.Fatalf("dry-run: ran=%d printed=%q", ran, printed)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestShortcutAliasesOnlyWhenShortened(t *testing.T) {
|
||||||
|
cfg := config.Config{Shell: config.ShellConfig{Alias: "j"}, Shortcuts: fsnRewrite}
|
||||||
|
entries := []cache.Entry{{Name: "fsn1-bx1.hoster.de"}, {Name: "web01.other.de"}, {Name: "db01.hoster.de"}}
|
||||||
|
got := shortcutAliases(entries, cfg)
|
||||||
|
want := map[string]string{"fsn1-bx1.hoster.de": "fsnbx1", "db01.hoster.de": "db01"}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("got %v, want %v", got, want)
|
||||||
|
}
|
||||||
|
if got := shortcutAliases(entries, config.Config{}); len(got) != 0 {
|
||||||
|
t.Fatalf("aliases without shortcuts: %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHostCompletionsShowShortcutsForMatchingNames(t *testing.T) {
|
||||||
|
entries := []cache.Entry{{Name: "fsn1-bx1.hoster.de"}, {Name: "fsn1-db1.hoster.de"}}
|
||||||
|
if got := hostCompletions(entries, "fsn", fsnRewrite); !reflect.DeepEqual(got, []string{"fsn1-bx1.hoster.de", "fsn1-db1.hoster.de"}) {
|
||||||
|
t.Fatalf("without show: %v", got)
|
||||||
|
}
|
||||||
|
show := fsnRewrite
|
||||||
|
show.Show = true
|
||||||
|
want := []string{"fsn1-bx1.hoster.de", "fsn1-db1.hoster.de", "fsnbx1", "fsndb1"}
|
||||||
|
if got := hostCompletions(entries, "fsn", show); !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("with show: got %v, want %v", got, want)
|
||||||
|
}
|
||||||
|
// A shortcut equal to an offered name is not repeated.
|
||||||
|
plain := []cache.Entry{{Name: "web01"}}
|
||||||
|
if got := hostCompletions(plain, "web", show); !reflect.DeepEqual(got, []string{"web01"}) {
|
||||||
|
t.Fatalf("duplicate: %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,106 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
||||||
|
"github.com/charmbracelet/x/term"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
)
|
||||||
|
|
||||||
|
// expandHostCommand substitutes each argument once, without shell evaluation.
|
||||||
|
func expandHostCommand(command config.HostCommand, host resolvedHost, extra []string) []string {
|
||||||
|
_, name := netbox.SplitTarget(host.Name)
|
||||||
|
replace := strings.NewReplacer("{host}", name, "{address}", host.IP, "{target}", host.Name)
|
||||||
|
argv := make([]string, 0, len(command.Args)+len(extra))
|
||||||
|
for _, arg := range command.Args {
|
||||||
|
argv = append(argv, replace.Replace(arg))
|
||||||
|
}
|
||||||
|
return append(argv, extra...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func runCmd() *cobra.Command {
|
||||||
|
var dryRun, yes, status bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "run [--dry-run] COMMAND HOST [-- EXTRA_ARGS...]",
|
||||||
|
Short: "Run a configured local command for a NetBox or static host",
|
||||||
|
Args: cobra.MinimumNArgs(2),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
command, ok := cfg.Commands[args[0]]
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("unknown configured command %q", args[0])
|
||||||
|
}
|
||||||
|
host, err := resolveTargetE(cfg, args[1], !dryRun)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !command.Allowed(commandHost(host)) {
|
||||||
|
return fmt.Errorf("command %q is not allowed for %s", args[0], host.Name)
|
||||||
|
}
|
||||||
|
argv := expandHostCommand(command, host, args[2:])
|
||||||
|
if dryRun {
|
||||||
|
if post := config.HookCommand(command.PostRun); post != "" {
|
||||||
|
fmt.Fprintf(cmd.ErrOrStderr(), "# post_run (skipped in --dry-run): %s\n", post)
|
||||||
|
}
|
||||||
|
for i, arg := range argv {
|
||||||
|
if i > 0 {
|
||||||
|
fmt.Fprint(cmd.OutOrStdout(), " ")
|
||||||
|
}
|
||||||
|
fmt.Fprintf(cmd.OutOrStdout(), "%q", arg)
|
||||||
|
}
|
||||||
|
fmt.Fprintln(cmd.OutOrStdout())
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if command.Confirm {
|
||||||
|
if err := confirmAction("Run "+args[0]+" on "+host.Name, yes); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
timeout, _ := time.ParseDuration(command.Timeout)
|
||||||
|
code := supervise(cfg, host, args[0], argv, command.PostRun, timeout, status || term.IsTerminal(os.Stderr.Fd()), os.Stdin, cmd.OutOrStdout(), cmd.ErrOrStderr())
|
||||||
|
if code != 0 {
|
||||||
|
cmd.SilenceErrors = true
|
||||||
|
cmd.SilenceUsage = true
|
||||||
|
return &commandExit{code}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
ValidArgsFunction: func(cmd *cobra.Command, args []string, prefix string) ([]string, cobra.ShellCompDirective) {
|
||||||
|
if len(args) == 0 {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return nil, cobra.ShellCompDirectiveError
|
||||||
|
}
|
||||||
|
var names []string
|
||||||
|
for name := range cfg.Commands {
|
||||||
|
if strings.HasPrefix(name, prefix) {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
return names, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
if len(args) == 1 {
|
||||||
|
return completeHosts(prefix), cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.Flags().BoolVar(&yes, "yes", false, "Approve an action requiring confirmation")
|
||||||
|
cmd.Flags().BoolVar(&status, "status", false, "Show elapsed runtime")
|
||||||
|
cmd.Flags().BoolVar(&dryRun, "dry-run", false, "Print the command without running it")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
type commandExit struct{ code int }
|
||||||
|
|
||||||
|
func (e *commandExit) Error() string { return fmt.Sprintf("command exited with status %d", e.code) }
|
||||||
@@ -0,0 +1,130 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestExpandHostCommand(t *testing.T) {
|
||||||
|
command := config.HostCommand{Args: []string{"mtr", "--target={address}", "{host}", "{target}", "$(literal)"}}
|
||||||
|
host := resolvedHost{Name: "office/xzi-groß1", IP: "2001:db8::1"}
|
||||||
|
got := expandHostCommand(command, host, []string{"--report", "two words"})
|
||||||
|
want := []string{"mtr", "--target=2001:db8::1", "xzi-groß1", "office/xzi-groß1", "$(literal)", "--report", "two words"}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("%q, want %q", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunConfiguredHostCommand(t *testing.T) {
|
||||||
|
prepareTransferTest(t)
|
||||||
|
f, err := os.OpenFile(config.Path(), os.O_APPEND|os.O_WRONLY, 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_, err = f.WriteString(`
|
||||||
|
commands:
|
||||||
|
trace:
|
||||||
|
alias_prefix: m
|
||||||
|
args: [mtr, "{address}", "{host}", "{target}"]
|
||||||
|
literal:
|
||||||
|
args: [printf, "%s|%s|%s", "{address}", "{host}", "$(touch should-not-exist)"]
|
||||||
|
`)
|
||||||
|
if closeErr := f.Close(); err != nil || closeErr != nil {
|
||||||
|
t.Fatalf("write config: %v %v", err, closeErr)
|
||||||
|
}
|
||||||
|
for _, tc := range []struct {
|
||||||
|
args []string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{[]string{"run", "--dry-run", "trace", "fsnbx1", "--", "--report"}, `"mtr" "10.0.0.9" "fsn1-bx1.hoster.de" "fsn1-bx1.hoster.de" "--report"`},
|
||||||
|
{[]string{"run", "--dry-run", "trace", "--", "fsnbx1", "--help"}, `"mtr" "10.0.0.9" "fsn1-bx1.hoster.de" "fsn1-bx1.hoster.de" "--help"`},
|
||||||
|
{[]string{"run", "literal", "fsnbx1"}, "10.0.0.9|fsn1-bx1.hoster.de|$(touch should-not-exist)"},
|
||||||
|
} {
|
||||||
|
out, err := runNetssh(t, tc.args...)
|
||||||
|
if err != nil || out != tc.want {
|
||||||
|
t.Fatalf("%v: %q (%v), want %q", tc.args, out, err, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out, err := runNetssh(t, "run", "missing", "fsnbx1")
|
||||||
|
if err == nil || !strings.Contains(out, "unknown configured command") {
|
||||||
|
t.Fatalf("%q %v", out, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunCommandAcceptsResolvedHostname(t *testing.T) {
|
||||||
|
prepareTransferTest(t)
|
||||||
|
data := `netbox:
|
||||||
|
url: http://127.0.0.1:1
|
||||||
|
token: t
|
||||||
|
hosts:
|
||||||
|
- name: router
|
||||||
|
address: router.example.com
|
||||||
|
commands:
|
||||||
|
trace:
|
||||||
|
args: [mtr, "{address}"]
|
||||||
|
`
|
||||||
|
if err := os.WriteFile(filepath.Join(os.Getenv("XDG_CONFIG_HOME"), "netssh.yaml"), []byte(data), 0600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
out, err := runNetssh(t, "run", "--dry-run", "trace", "router")
|
||||||
|
if err != nil || out != `"mtr" "router.example.com"` {
|
||||||
|
t.Fatalf("%q %v", out, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunOwnScripts(t *testing.T) {
|
||||||
|
for _, mode := range []string{"executable", "bash", "python3"} {
|
||||||
|
t.Run(mode, func(t *testing.T) {
|
||||||
|
if mode != "executable" {
|
||||||
|
if _, err := exec.LookPath(mode); err != nil {
|
||||||
|
t.Skip("interpreter not installed")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
prepareTransferTest(t)
|
||||||
|
script := filepath.Join(t.TempDir(), "my host check")
|
||||||
|
body := "#!/bin/sh\nprintf '<%s>\\n' \"$@\"\nexit 7\n"
|
||||||
|
permissions := os.FileMode(0700)
|
||||||
|
argv := []string{script}
|
||||||
|
if mode != "executable" {
|
||||||
|
permissions = 0600
|
||||||
|
argv = []string{mode, script}
|
||||||
|
}
|
||||||
|
if mode == "python3" {
|
||||||
|
body = "import sys\nfor arg in sys.argv[1:]:\n print('<' + arg + '>')\nsys.exit(7)\n"
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(script, []byte(body), permissions); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
argv = append(argv, "{address}", "{host}", "{target}")
|
||||||
|
var yaml strings.Builder
|
||||||
|
yaml.WriteString("\ncommands:\n check:\n alias_prefix: c\n args:\n")
|
||||||
|
for _, arg := range argv {
|
||||||
|
fmt.Fprintf(&yaml, " - %q\n", arg)
|
||||||
|
}
|
||||||
|
f, err := os.OpenFile(config.Path(), os.O_APPEND|os.O_WRONLY, 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_, err = f.WriteString(yaml.String())
|
||||||
|
if closeErr := f.Close(); err != nil || closeErr != nil {
|
||||||
|
t.Fatalf("config write: %v %v", err, closeErr)
|
||||||
|
}
|
||||||
|
out, err := runNetssh(t, "run", "check", "fsnbx1", "--", "--report", "two words", "$(literal)")
|
||||||
|
want := "<10.0.0.9>\n<fsn1-bx1.hoster.de>\n<fsn1-bx1.hoster.de>\n<--report>\n<two words>\n<$(literal)>"
|
||||||
|
if out != want {
|
||||||
|
t.Fatalf("script args: %q, want %q", out, want)
|
||||||
|
}
|
||||||
|
exit, ok := err.(*exec.ExitError)
|
||||||
|
if !ok || exit.ExitCode() != 7 {
|
||||||
|
t.Fatalf("script exit status lost: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/activity"
|
||||||
|
"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/runner"
|
||||||
|
"github.com/charmbracelet/x/term"
|
||||||
|
)
|
||||||
|
|
||||||
|
func commandHost(h resolvedHost) config.SSHHost {
|
||||||
|
instance, name := netbox.SplitTarget(h.Name)
|
||||||
|
return config.SSHHost{Instance: instance, Name: name, Kind: h.Kind, Tags: h.Tags}
|
||||||
|
}
|
||||||
|
func confirmAction(message string, yes bool) error {
|
||||||
|
if yes {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if !term.IsTerminal(os.Stdin.Fd()) {
|
||||||
|
return fmt.Errorf("%s requires confirmation; use --yes for unattended execution", message)
|
||||||
|
}
|
||||||
|
fmt.Fprintf(os.Stderr, "%s? [y/N] ", message)
|
||||||
|
answer, err := bufio.NewReader(os.Stdin).ReadString('\n')
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if strings.EqualFold(strings.TrimSpace(answer), "y") || strings.EqualFold(strings.TrimSpace(answer), "yes") {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return fmt.Errorf("cancelled")
|
||||||
|
}
|
||||||
|
func supervise(cfg *config.Config, h resolvedHost, name string, argv []string, post string, timeout time.Duration, status bool, stdin io.Reader, stdout, stderr io.Writer) int {
|
||||||
|
start := time.Now()
|
||||||
|
env := append(preConnectEnv(h, name), "NETSSH_COMMAND="+name)
|
||||||
|
result := runner.Run(context.Background(), argv, runner.Options{Stdin: stdin, Stdout: stdout, Stderr: stderr, Env: env, Timeout: timeout, Status: status, Label: name + " " + h.Name})
|
||||||
|
code := result.Code
|
||||||
|
if result.Started && config.HookCommand(post) != "" {
|
||||||
|
hook := runner.Run(context.Background(), []string{"sh", "-c", post}, runner.Options{Stdin: nil, Stdout: stderr, Stderr: stderr, Env: append(env, "NETSSH_EXIT_CODE="+strconv.Itoa(code)), Timeout: 30 * time.Second})
|
||||||
|
if hook.Code != 0 {
|
||||||
|
fmt.Fprintf(stderr, "post hook failed (exit %d)\n", hook.Code)
|
||||||
|
if code == 0 {
|
||||||
|
code = hook.Code
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := activity.Append(cfg.Activity, activity.Record{Time: start, Host: h.Name, Command: name, Code: code, Duration: time.Since(start)}); err != nil {
|
||||||
|
fmt.Fprintf(stderr, "activity: %v\n", err)
|
||||||
|
}
|
||||||
|
return code
|
||||||
|
}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Integration helpers run this test binary as netssh. An automatic refresh
|
||||||
|
// would otherwise launch the test binary again with "cache refresh", rerunning
|
||||||
|
// the entire suite. Explicit cache-refresh tests still exercise the real command.
|
||||||
|
func TestMain(m *testing.M) {
|
||||||
|
_ = os.Setenv("NETSSH_NO_REFRESH", "1")
|
||||||
|
os.Exit(m.Run())
|
||||||
|
}
|
||||||
@@ -0,0 +1,198 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
internalssh "git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/ssh"
|
||||||
|
)
|
||||||
|
|
||||||
|
func sftpCmd() *cobra.Command {
|
||||||
|
return transferCmd(internalssh.SFTP, "sftp [--dry-run] [--jump HOST|--no-jump] [sftp options] HOST[:PATH]",
|
||||||
|
"Open an SFTP session to a NetBox host",
|
||||||
|
`Resolve HOST like netssh does for ssh (cache, shortcuts, instance/host,
|
||||||
|
SSH options and rules, jump host) and run sftp. sftp options are passed
|
||||||
|
through; note that sftp uses -P for the port.
|
||||||
|
|
||||||
|
netssh sftp fsnbx1
|
||||||
|
netssh sftp -P 2222 prod/web01:/var/log`)
|
||||||
|
}
|
||||||
|
|
||||||
|
func scpCmd() *cobra.Command {
|
||||||
|
return transferCmd(internalssh.SCP, "scp [--dry-run] [--jump HOST|--no-jump] [scp options] SOURCE... TARGET",
|
||||||
|
"Copy files to or from a NetBox host",
|
||||||
|
`Resolve the host in HOST:PATH operands like netssh does for ssh and run scp.
|
||||||
|
All remote operands must name the same host.
|
||||||
|
|
||||||
|
netssh scp ./app.tar fsnbx1:/tmp/
|
||||||
|
netssh scp -r prod/web01:/etc/nginx ./nginx`)
|
||||||
|
}
|
||||||
|
|
||||||
|
func transferCmd(client internalssh.Client, use, short, long string) *cobra.Command {
|
||||||
|
return &cobra.Command{
|
||||||
|
Use: use,
|
||||||
|
Short: short,
|
||||||
|
Long: long,
|
||||||
|
DisableFlagParsing: true,
|
||||||
|
Run: func(cmd *cobra.Command, args []string) {
|
||||||
|
if len(args) == 0 || args[0] == "--help" || args[0] == "-h" {
|
||||||
|
_ = cmd.Help()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
flags, args, err := client.ExtractWrapperFlags(args)
|
||||||
|
if err != nil {
|
||||||
|
fatalf("%v", err)
|
||||||
|
}
|
||||||
|
if len(flags.Forwards) > 0 {
|
||||||
|
fatalf("--forward is only available for ssh and netssh tunnel")
|
||||||
|
}
|
||||||
|
runClient(client, flags, args)
|
||||||
|
},
|
||||||
|
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) {
|
||||||
|
if client.Name == internalssh.SFTP.Name && client.Parse(args) != nil {
|
||||||
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
if strings.HasPrefix(toComplete, "-") {
|
||||||
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
if client.Name == internalssh.SCP.Name {
|
||||||
|
if strings.Contains(toComplete, ":") {
|
||||||
|
return nil, cobra.ShellCompDirectiveNoFileComp // remote paths are not completed
|
||||||
|
}
|
||||||
|
// HOST: for remote operands; without a matching host, local files.
|
||||||
|
hosts := completeHosts(toComplete)
|
||||||
|
if len(hosts) == 0 {
|
||||||
|
return nil, cobra.ShellCompDirectiveDefault
|
||||||
|
}
|
||||||
|
for i := range hosts {
|
||||||
|
hosts[i] += ":"
|
||||||
|
}
|
||||||
|
return hosts, cobra.ShellCompDirectiveNoSpace | cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
return completeHosts(toComplete), cobra.ShellCompDirectiveNoFileComp
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func tunnelCmd() *cobra.Command {
|
||||||
|
return &cobra.Command{
|
||||||
|
Use: "tunnel [--dry-run] [--jump HOST|--no-jump] [ssh options] HOST FORWARD...",
|
||||||
|
Short: "Open port forwards to a NetBox host without a shell",
|
||||||
|
Long: `Run ssh -N with the named forwards configured under ssh.forwards (globally,
|
||||||
|
per NetBox instance, or per rule). A FORWARD that is no configured name but a
|
||||||
|
port spec such as 8080:localhost:80 is used as a local forward (-L).
|
||||||
|
|
||||||
|
netssh tunnel fsnbx1 web socks
|
||||||
|
netssh tunnel prod/db01 5432:localhost:5432`,
|
||||||
|
DisableFlagParsing: true,
|
||||||
|
Run: func(cmd *cobra.Command, args []string) {
|
||||||
|
if len(args) == 0 || args[0] == "--help" || args[0] == "-h" {
|
||||||
|
_ = cmd.Help()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
flags, args, err := internalssh.SSH.ExtractWrapperFlags(args)
|
||||||
|
if err != nil {
|
||||||
|
fatalf("%v", err)
|
||||||
|
}
|
||||||
|
parsed := internalssh.SSH.Parse(args)
|
||||||
|
if parsed == nil {
|
||||||
|
fatalf("usage: netssh tunnel HOST FORWARD...")
|
||||||
|
}
|
||||||
|
// Everything after the host names forwards instead of a remote command.
|
||||||
|
flags.Forwards = append(flags.Forwards, args[parsed.DestIdx+1:]...)
|
||||||
|
flags.Tunnel = true
|
||||||
|
runClient(internalssh.SSH, flags, args[:parsed.DestIdx+1])
|
||||||
|
},
|
||||||
|
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) {
|
||||||
|
parsed := internalssh.SSH.Parse(args)
|
||||||
|
if parsed == nil {
|
||||||
|
return completeHosts(toComplete), cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return nil, cobra.ShellCompDirectiveError
|
||||||
|
}
|
||||||
|
var names []string
|
||||||
|
if entry, ok := cachedHost(cfg, parsed.Host); ok {
|
||||||
|
names = forwardNames(hostOptions(cfg, resolvedHost{Name: entry.Name, Kind: entry.Kind, Tags: entry.Tags}))
|
||||||
|
} else {
|
||||||
|
names = allForwardNames(cfg)
|
||||||
|
}
|
||||||
|
return filterPrefix(names, toComplete, args[parsed.DestIdx+1:]), cobra.ShellCompDirectiveNoFileComp
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// completeHosts returns the cached hosts for a completion request.
|
||||||
|
func completeHosts(toComplete string) []string {
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
c := newCache(cfg)
|
||||||
|
_ = c.Load()
|
||||||
|
hosts := hostCompletions(c.All(), toComplete, cfg.Shortcuts)
|
||||||
|
if limit := cfg.Completion.MaxResults; limit > 0 && len(hosts) > limit {
|
||||||
|
hosts = hosts[:limit]
|
||||||
|
}
|
||||||
|
return hosts
|
||||||
|
}
|
||||||
|
|
||||||
|
// cachedHost finds a host for completion by name or shortcut, without NetBox.
|
||||||
|
func cachedHost(cfg *config.Config, host string) (cache.Entry, bool) {
|
||||||
|
c := newCache(cfg)
|
||||||
|
if err := c.Load(); err != nil {
|
||||||
|
return cache.Entry{}, false
|
||||||
|
}
|
||||||
|
if entry, _ := c.Get(host); entry.Name != "" {
|
||||||
|
return entry, true
|
||||||
|
}
|
||||||
|
if !cfg.Shortcuts.Enabled() {
|
||||||
|
return cache.Entry{}, false
|
||||||
|
}
|
||||||
|
entry, found, _, err := c.GetByShortcut(host, normalizeTarget(cfg.Shortcuts, strings.Contains(host, "/")))
|
||||||
|
return entry, found && err == nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// allForwardNames lists every configured forward name, for when the host is unknown.
|
||||||
|
func allForwardNames(cfg *config.Config) []string {
|
||||||
|
seen := map[string]bool{}
|
||||||
|
add := func(o config.SSHOptions) {
|
||||||
|
for name := range o.Forwards {
|
||||||
|
seen[strings.ToLower(name)] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
add(cfg.SSH.SSHOptions)
|
||||||
|
add(cfg.NetBox.SSH)
|
||||||
|
for _, source := range cfg.NetBoxes {
|
||||||
|
add(source.SSH)
|
||||||
|
}
|
||||||
|
for _, rule := range cfg.SSH.Rules {
|
||||||
|
add(rule.SSHOptions)
|
||||||
|
}
|
||||||
|
names := make([]string, 0, len(seen))
|
||||||
|
for name := range seen {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
return names
|
||||||
|
}
|
||||||
|
|
||||||
|
// filterPrefix keeps the names starting with prefix that were not given yet.
|
||||||
|
func filterPrefix(names []string, prefix string, given []string) []string {
|
||||||
|
used := map[string]bool{}
|
||||||
|
for _, name := range given {
|
||||||
|
used[strings.ToLower(name)] = true
|
||||||
|
}
|
||||||
|
var out []string
|
||||||
|
for _, name := range names {
|
||||||
|
if strings.HasPrefix(name, strings.ToLower(prefix)) && !used[name] {
|
||||||
|
out = append(out, name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
@@ -0,0 +1,130 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestNetsshHelper runs main() with the arguments in NETSSH_TEST_ARGS.
|
||||||
|
func TestNetsshHelper(t *testing.T) {
|
||||||
|
if args := os.Getenv("NETSSH_TEST_ARGS"); args != "" {
|
||||||
|
os.Args = append([]string{"netssh"}, strings.Split(args, "\x1f")...)
|
||||||
|
main()
|
||||||
|
os.Exit(0)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// prepareTransferTest writes a config whose only host is cached; NetBox is
|
||||||
|
// unreachable, so every result must come from cache, shortcuts, and options.
|
||||||
|
func prepareTransferTest(t *testing.T) {
|
||||||
|
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 := `netbox:
|
||||||
|
url: http://127.0.0.1:1
|
||||||
|
token: t
|
||||||
|
ssh:
|
||||||
|
default_user: ops
|
||||||
|
default_port: 2222
|
||||||
|
extra_args: ["-A"]
|
||||||
|
forwards:
|
||||||
|
web: {local: "8080:localhost:80"}
|
||||||
|
rules:
|
||||||
|
- match: {tag: dmz}
|
||||||
|
proxy_jump: jh.example.com
|
||||||
|
forwards:
|
||||||
|
socks: {dynamic: "1080"}
|
||||||
|
shortcuts:
|
||||||
|
domains: [.hoster.de]
|
||||||
|
rewrites:
|
||||||
|
- pattern: '^([a-z]+)[0-9]+-'
|
||||||
|
replace: '$1'
|
||||||
|
`
|
||||||
|
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)
|
||||||
|
}
|
||||||
|
c := cache.New(cfg.CachePath(), 3600)
|
||||||
|
c.Upsert(cache.Entry{Name: "fsn1-bx1.hoster.de", IP: "10.0.0.9", Kind: "device", Tags: []string{"dmz"}})
|
||||||
|
if err := c.Save(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func runNetssh(t *testing.T, args ...string) (string, error) {
|
||||||
|
t.Helper()
|
||||||
|
cmd := exec.Command(os.Args[0], "-test.run=^TestNetsshHelper$")
|
||||||
|
cmd.Env = append(os.Environ(), "NETSSH_TEST_ARGS="+strings.Join(args, "\x1f"))
|
||||||
|
out, err := cmd.CombinedOutput()
|
||||||
|
return strings.TrimSpace(string(out)), err
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTransferAndTunnelCommands(t *testing.T) {
|
||||||
|
prepareTransferTest(t)
|
||||||
|
for _, tc := range []struct {
|
||||||
|
args []string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
// sftp: -P and -o User, rule jump host, path kept, no ssh-only extra_args.
|
||||||
|
{[]string{"sftp", "--dry-run", "fsnbx1:/var/log"}, "sftp -P 2222 -o User=ops -J jh.example.com 10.0.0.9:/var/log"},
|
||||||
|
{[]string{"sftp", "--dry-run", "-P", "22", "root@fsnbx1"}, "sftp -P 22 -J jh.example.com root@10.0.0.9"},
|
||||||
|
{[]string{"scp", "--dry-run", "-r", "a.txt", "fsn1-bx1.hoster.de:/tmp/"}, "scp -P 2222 -o User=ops -r -J jh.example.com a.txt 10.0.0.9:/tmp/"},
|
||||||
|
{[]string{"scp", "--dry-run", "--no-jump", "fsnbx1:/etc/hosts", "."}, "scp -P 2222 -o User=ops -o ProxyJump=none 10.0.0.9:/etc/hosts ."},
|
||||||
|
// Forwards come from the global options and the matching rule.
|
||||||
|
{[]string{"tunnel", "--dry-run", "fsnbx1", "web", "socks", "5432:db:5432"}, "ssh -A -p 2222 -l ops -J jh.example.com -L 8080:localhost:80 -D 1080 -L 5432:db:5432 -o ExitOnForwardFailure=yes -N 10.0.0.9"},
|
||||||
|
{[]string{"--dry-run", "--forward", "web", "fsnbx1"}, "ssh -A -p 2222 -l ops -J jh.example.com -L 8080:localhost:80 10.0.0.9"},
|
||||||
|
} {
|
||||||
|
out, err := runNetssh(t, tc.args...)
|
||||||
|
if err != nil || out != tc.want {
|
||||||
|
t.Errorf("%v:\n got %s (%v)\n want %s", tc.args, out, err, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, tc := range []struct {
|
||||||
|
args []string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{[]string{"tunnel", "--dry-run", "fsnbx1"}, "forwards for fsn1-bx1.hoster.de: socks, web"},
|
||||||
|
{[]string{"tunnel", "--dry-run", "fsnbx1", "db"}, `unknown forward "db"; available: socks, web`},
|
||||||
|
{[]string{"sftp", "--forward", "web", "fsnbx1"}, "only available for ssh"},
|
||||||
|
{[]string{"scp", "fsnbx1:a", "other:b"}, "not supported"},
|
||||||
|
} {
|
||||||
|
out, err := runNetssh(t, tc.args...)
|
||||||
|
if err == nil || !strings.Contains(out, tc.want) {
|
||||||
|
t.Errorf("%v: got %s (%v), want error containing %q", tc.args, out, err, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTransferCompletion(t *testing.T) {
|
||||||
|
prepareTransferTest(t)
|
||||||
|
for _, tc := range []struct {
|
||||||
|
args []string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{[]string{"__complete", "sftp", "fsnb"}, "fsnbx1\n"},
|
||||||
|
{[]string{"__complete", "scp", "a.txt", "fsnb"}, "fsnbx1:\n"},
|
||||||
|
{[]string{"__complete", "tunnel", "fsnbx1", ""}, "socks\nweb\n"},
|
||||||
|
{[]string{"__complete", "tunnel", "fsnbx1", "web", ""}, "socks\n"},
|
||||||
|
{[]string{"__complete", "--forward", ""}, "socks\nweb\n"},
|
||||||
|
} {
|
||||||
|
out, err := runNetssh(t, tc.args...)
|
||||||
|
if err != nil || !strings.HasPrefix(out+"\n", tc.want) {
|
||||||
|
t.Errorf("%v: got %q (%v), want prefix %q", tc.args, out, err, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -71,6 +71,7 @@ func buildUninstallPlan(cfg *config.Config, keepConfig bool) uninstallPlan {
|
|||||||
addPath(path)
|
addPath(path)
|
||||||
addPath(path + ".lock")
|
addPath(path + ".lock")
|
||||||
addPath(filepath.Join(filepath.Dir(path), "last_refresh"))
|
addPath(filepath.Join(filepath.Dir(path), "last_refresh"))
|
||||||
|
addPath(filepath.Join(filepath.Dir(path), "refresh_attempt"))
|
||||||
if strings.HasPrefix(filepath.Base(filepath.Dir(path)), "instances-") {
|
if strings.HasPrefix(filepath.Base(filepath.Dir(path)), "instances-") {
|
||||||
addPath(filepath.Dir(path))
|
addPath(filepath.Dir(path))
|
||||||
}
|
}
|
||||||
@@ -203,10 +204,10 @@ func uninstallCmd() *cobra.Command {
|
|||||||
- netssh blocks and unmarked entries of older versions in bash, zsh, and fish profiles
|
- netssh blocks and unmarked entries of older versions in bash, zsh, and fish profiles
|
||||||
- shell completion files (bash, zsh, fish, oh-my-zsh cache, command alias)
|
- shell completion files (bash, zsh, fish, oh-my-zsh cache, command alias)
|
||||||
- the cache directory with hosts, aliases, and per-instance caches
|
- the cache directory with hosts, aliases, and per-instance caches
|
||||||
- the config file (a private backup is kept) and local server notes
|
- the config file (a private backup is kept) and local notes, favorites, action history and batch retry state
|
||||||
- the netssh binary
|
- the netssh binary
|
||||||
|
|
||||||
Use --keep-config to keep the config file and notes for a reinstall.`,
|
Use --keep-config to keep the config file and local state for a reinstall.`,
|
||||||
Args: cobra.NoArgs,
|
Args: cobra.NoArgs,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
cfg, err := config.Load()
|
cfg, err := config.Load()
|
||||||
@@ -243,7 +244,7 @@ Use --keep-config to keep the config file and notes for a reinstall.`,
|
|||||||
return err
|
return err
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
cmd.Flags().BoolVar(&keepConfig, "keep-config", false, "Keep the config file and local notes")
|
cmd.Flags().BoolVar(&keepConfig, "keep-config", false, "Keep the config file and local state")
|
||||||
cmd.Flags().BoolVarP(&yes, "yes", "y", false, "Do not ask for confirmation")
|
cmd.Flags().BoolVarP(&yes, "yes", "y", false, "Do not ask for confirmation")
|
||||||
cmd.Flags().BoolVar(&dryRun, "dry-run", false, "Only show what would be removed")
|
cmd.Flags().BoolVar(&dryRun, "dry-run", false, "Only show what would be removed")
|
||||||
return cmd
|
return cmd
|
||||||
|
|||||||
@@ -1,15 +1,15 @@
|
|||||||
module git.zb-server.de/Sebi/ssh-netbox-wrapper
|
module git.zb-server.de/Sebi/ssh-netbox-wrapper
|
||||||
|
|
||||||
go 1.27.3
|
go 1.27.4
|
||||||
|
|
||||||
require (
|
require (
|
||||||
charm.land/bubbles/v2 v2.2.1
|
charm.land/bubbles/v2 v2.2.1
|
||||||
charm.land/bubbletea/v2 v2.1.0
|
charm.land/bubbletea/v2 v2.1.1
|
||||||
charm.land/huh/v2 v2.0.3
|
charm.land/huh/v2 v2.0.3
|
||||||
charm.land/lipgloss/v2 v2.0.6
|
charm.land/lipgloss/v2 v2.1.1
|
||||||
github.com/spf13/cobra v1.10.2
|
github.com/spf13/cobra v1.10.2
|
||||||
github.com/spf13/viper v1.21.0
|
github.com/spf13/viper v1.21.0
|
||||||
golang.org/x/sys v0.49.0
|
golang.org/x/sys v0.50.0
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
@@ -43,11 +43,11 @@ require (
|
|||||||
github.com/sahilm/fuzzy v0.1.3 // indirect
|
github.com/sahilm/fuzzy v0.1.3 // indirect
|
||||||
github.com/spf13/afero v1.15.0 // indirect
|
github.com/spf13/afero v1.15.0 // indirect
|
||||||
github.com/spf13/cast v1.10.0 // indirect
|
github.com/spf13/cast v1.10.0 // indirect
|
||||||
github.com/spf13/pflag v1.0.10 // indirect
|
github.com/spf13/pflag v1.1.0 // indirect
|
||||||
github.com/stretchr/testify v1.12.1 // indirect
|
github.com/stretchr/testify v1.12.1 // indirect
|
||||||
github.com/subosito/gotenv v1.6.0 // indirect
|
github.com/subosito/gotenv v1.6.0 // indirect
|
||||||
github.com/xo/terminfo v1.2.1 // indirect
|
github.com/xo/terminfo v1.3.1 // indirect
|
||||||
go.yaml.in/yaml/v3 v3.0.5 // indirect
|
go.yaml.in/yaml/v3 v3.0.6 // indirect
|
||||||
golang.org/x/sync v0.24.0 // indirect
|
golang.org/x/sync v0.25.0 // indirect
|
||||||
golang.org/x/text v0.43.0 // indirect
|
golang.org/x/text v0.44.0 // indirect
|
||||||
)
|
)
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
charm.land/bubbles/v2 v2.2.1 h1:Fq1+qm5hV6GkvzLQDhCBpXXE5tLgvh1PRriCLwSvIQU=
|
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/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.1 h1:S1S9l37pCZGrj1JexBcr9x4Nr3MVeM42InqCYM/tDpU=
|
||||||
charm.land/bubbletea/v2 v2.1.0/go.mod h1:xWHeyxIX9/wiFU2kgPW04ojOZyTzrWf+8lGjUCaftiU=
|
charm.land/bubbletea/v2 v2.1.1/go.mod h1:xWHeyxIX9/wiFU2kgPW04ojOZyTzrWf+8lGjUCaftiU=
|
||||||
charm.land/huh/v2 v2.0.3 h1:2cJsMqEPwSywGHvdlKsJyQKPtSJLVnFKyFbsYZTlLkU=
|
charm.land/huh/v2 v2.0.3 h1:2cJsMqEPwSywGHvdlKsJyQKPtSJLVnFKyFbsYZTlLkU=
|
||||||
charm.land/huh/v2 v2.0.3/go.mod h1:93eEveeeqn47MwiC3tf+2atZ2l7Is88rAtmZNZ8x9Wc=
|
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.1.1 h1:F+vKWis9Kz3MFRsbICSDFtT1ZwVL+8f+36Dtg+OpKwc=
|
||||||
charm.land/lipgloss/v2 v2.0.6/go.mod h1:ipDDJNSGa1hlwDtSfW1s2/xR8Vdhbut4PXh2zEKZd0Q=
|
charm.land/lipgloss/v2 v2.1.1/go.mod h1:k79y/56yThpkJvbwyrcHr8MyZF42e84Q5fW9Ibu6LFc=
|
||||||
github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ=
|
github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ=
|
||||||
github.com/MakeNowJust/heredoc v1.0.0/go.mod h1:mG5amYoWBHf8vpLOuehzbGGw0EHxpZZ6lCpQ4fNJ8LE=
|
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 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4=
|
||||||
@@ -87,23 +87,23 @@ github.com/spf13/cast v1.10.0/go.mod h1:jNfB8QC9IA6ZuY2ZjDp0KtFO2LZZlg4S/7bzP6qq
|
|||||||
github.com/spf13/cobra v1.10.2 h1:DMTTonx5m65Ic0GOoRY2c16WCbHxOOw6xxezuLaBpcU=
|
github.com/spf13/cobra v1.10.2 h1:DMTTonx5m65Ic0GOoRY2c16WCbHxOOw6xxezuLaBpcU=
|
||||||
github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4=
|
github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4=
|
||||||
github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||||
github.com/spf13/pflag v1.0.10 h1:4EBh2KAYBwaONj6b2Ye1GiHfwjqyROoF4RwYO+vPwFk=
|
github.com/spf13/pflag v1.1.0 h1:6W6MbVUrnMb8PEhjkqwsVLY7ryuzRfFHF4mQd7L94ag=
|
||||||
github.com/spf13/pflag v1.0.10/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
github.com/spf13/pflag v1.1.0/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||||
github.com/spf13/viper v1.21.0 h1:x5S+0EU27Lbphp4UKm1C+1oQO+rKx36vfCoaVebLFSU=
|
github.com/spf13/viper v1.21.0 h1:x5S+0EU27Lbphp4UKm1C+1oQO+rKx36vfCoaVebLFSU=
|
||||||
github.com/spf13/viper v1.21.0/go.mod h1:P0lhsswPGWD/1lZJ9ny3fYnVqxiegrlNrEmgLjbTCAY=
|
github.com/spf13/viper v1.21.0/go.mod h1:P0lhsswPGWD/1lZJ9ny3fYnVqxiegrlNrEmgLjbTCAY=
|
||||||
github.com/stretchr/testify v1.12.1 h1:EuwCh5fleGS7H32xRwO3wRGT7DxrDhLAT6FF8MpWDWE=
|
github.com/stretchr/testify v1.12.1 h1:EuwCh5fleGS7H32xRwO3wRGT7DxrDhLAT6FF8MpWDWE=
|
||||||
github.com/stretchr/testify v1.12.1/go.mod h1:MDEgiDPPsNp5cuIrHPPCyornHKgEVbtFUmoNlxoYthg=
|
github.com/stretchr/testify v1.12.1/go.mod h1:MDEgiDPPsNp5cuIrHPPCyornHKgEVbtFUmoNlxoYthg=
|
||||||
github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
|
github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
|
||||||
github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
|
github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
|
||||||
github.com/xo/terminfo v1.2.1 h1:e5fQoon4xY/NK3LJzcF8me+JaknbLD8zjtRWm0uvxtw=
|
github.com/xo/terminfo v1.3.1 h1:4ZwPCuu4PEFw0PkNp3Hv/x3gqvgLCzYhurszsj101cM=
|
||||||
github.com/xo/terminfo v1.2.1/go.mod h1:lGzkSo8Fe7IRh/w+Gqz7n5mDog4FVXCj3gy/DYTBqio=
|
github.com/xo/terminfo v1.3.1/go.mod h1:lGzkSo8Fe7IRh/w+Gqz7n5mDog4FVXCj3gy/DYTBqio=
|
||||||
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
|
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.6 h1:zcDfvjXEqTQmpjniUBLc91xYJMB2c4QOFxEF/LCEckM=
|
||||||
go.yaml.in/yaml/v3 v3.0.5/go.mod h1:HVTZu1O7/Vkt2N+BFy8Zza+lnLsABggaTM2ZpNIGuKg=
|
go.yaml.in/yaml/v3 v3.0.6/go.mod h1:HVTZu1O7/Vkt2N+BFy8Zza+lnLsABggaTM2ZpNIGuKg=
|
||||||
golang.org/x/sync v0.24.0 h1:iqiDrGoDgyuvAKrhLQthUEzU/R378N78gXbBjxed7oA=
|
golang.org/x/sync v0.25.0 h1:dJnifr0nMV8/SBnBvdo4eSGGnrc3O4FFx6IqvtLcmRs=
|
||||||
golang.org/x/sync v0.24.0/go.mod h1:sUUOizhqBxiL6pEWpqNLUiaJn1ShEbZ6BBqskPbjZm0=
|
golang.org/x/sync v0.25.0/go.mod h1:sUUOizhqBxiL6pEWpqNLUiaJn1ShEbZ6BBqskPbjZm0=
|
||||||
golang.org/x/sys v0.49.0 h1:XbzkgYJHdqh/8m2Uu0W/dQv8nktxx4BFHp1M0gROTXA=
|
golang.org/x/sys v0.50.0 h1:dkKZEFTEKaLr1sjhs0WiKqoi8Jj5nHbS3Njmx1UoMJs=
|
||||||
golang.org/x/sys v0.49.0/go.mod h1:hNLxWAXmnKAxqDtdwIYC4bM9oQPEecfsnNMuSxOs3og=
|
golang.org/x/sys v0.50.0/go.mod h1:hNLxWAXmnKAxqDtdwIYC4bM9oQPEecfsnNMuSxOs3og=
|
||||||
golang.org/x/text v0.43.0 h1:1QivrlhwAsnMOcqgOdl9my7s9OyZl8O5/UGUTJVXoWc=
|
golang.org/x/text v0.44.0 h1:YItdp/mQNGnsmrgpcdA5yQ3bnRxCfo/Tj/iByGW9GGo=
|
||||||
golang.org/x/text v0.43.0/go.mod h1:hbSIYA/amXcRXTFSZqh8tWHEoqRvvbKPJ2uz/KU+a+s=
|
golang.org/x/text v0.44.0/go.mod h1:S4FR1waQ9LbjQTls97SyRjDaUUVkaM+cXwwuG/G+MwY=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
@@ -0,0 +1,94 @@
|
|||||||
|
// Package activity stores local preferences and optional execution metadata.
|
||||||
|
// No command arguments, environment variables, tokens or command output are logged.
|
||||||
|
package activity
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/storage"
|
||||||
|
"golang.org/x/sys/unix"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Record struct {
|
||||||
|
Time time.Time `json:"time"`
|
||||||
|
Host string `json:"host"`
|
||||||
|
Command string `json:"command"`
|
||||||
|
Code int `json:"exit_code"`
|
||||||
|
Duration time.Duration `json:"duration_ns"`
|
||||||
|
}
|
||||||
|
type State struct {
|
||||||
|
Favorites map[string]bool `json:"favorites,omitempty"`
|
||||||
|
Pinned map[string]bool `json:"pinned,omitempty"`
|
||||||
|
Records []Record `json:"records,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func Path() string { return filepath.Join(filepath.Dir(config.Path()), "netssh", "activity.json") }
|
||||||
|
func Read() (State, error) {
|
||||||
|
var s State
|
||||||
|
data, err := os.ReadFile(Path())
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
err = nil
|
||||||
|
} else if err == nil {
|
||||||
|
err = json.Unmarshal(data, &s)
|
||||||
|
}
|
||||||
|
if s.Favorites == nil {
|
||||||
|
s.Favorites = map[string]bool{}
|
||||||
|
}
|
||||||
|
if s.Pinned == nil {
|
||||||
|
s.Pinned = map[string]bool{}
|
||||||
|
}
|
||||||
|
return s, err
|
||||||
|
}
|
||||||
|
func Update(change func(*State)) error {
|
||||||
|
p := Path()
|
||||||
|
if err := os.MkdirAll(filepath.Dir(p), 0700); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
f, err := os.OpenFile(p+".lock", os.O_CREATE|os.O_RDWR, 0600)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer f.Close()
|
||||||
|
if err = unix.Flock(int(f.Fd()), unix.LOCK_EX); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer unix.Flock(int(f.Fd()), unix.LOCK_UN)
|
||||||
|
s, err := Read()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("local state: %w", err)
|
||||||
|
}
|
||||||
|
change(&s)
|
||||||
|
data, err := json.MarshalIndent(s, "", " ")
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return storage.WriteFile(p, data, 0600)
|
||||||
|
}
|
||||||
|
func Prune(s *State, c config.ActivityConfig) {
|
||||||
|
if c.RetentionDays > 0 {
|
||||||
|
cutoff := time.Now().Add(-time.Duration(c.RetentionDays) * 24 * time.Hour)
|
||||||
|
keep := s.Records[:0]
|
||||||
|
for _, r := range s.Records {
|
||||||
|
if !r.Time.Before(cutoff) {
|
||||||
|
keep = append(keep, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
s.Records = keep
|
||||||
|
}
|
||||||
|
sort.SliceStable(s.Records, func(i, j int) bool { return s.Records[i].Time.Before(s.Records[j].Time) })
|
||||||
|
if c.MaxEntries > 0 && len(s.Records) > c.MaxEntries {
|
||||||
|
s.Records = s.Records[len(s.Records)-c.MaxEntries:]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func Append(c config.ActivityConfig, r Record) error {
|
||||||
|
if !c.Enabled {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return Update(func(s *State) { s.Records = append(s.Records, r); Prune(s, c) })
|
||||||
|
}
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
package activity
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestConcurrentActivityAndRetention(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
cfg := config.ActivityConfig{Enabled: true, RetentionDays: 1, MaxEntries: 10}
|
||||||
|
if err := Update(func(s *State) {
|
||||||
|
s.Favorites["prod/web"] = true
|
||||||
|
s.Pinned["prod/web"] = true
|
||||||
|
s.Records = []Record{{Time: time.Now().Add(-48 * time.Hour), Host: "old"}}
|
||||||
|
}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
for i := 0; i < 20; i++ {
|
||||||
|
wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
if err := Append(cfg, Record{Time: time.Now(), Host: fmt.Sprint(i), Command: "test"}); err != nil {
|
||||||
|
t.Error(err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
wg.Wait()
|
||||||
|
s, err := Read()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if len(s.Records) != 10 || !s.Favorites["prod/web"] || !s.Pinned["prod/web"] {
|
||||||
|
t.Fatalf("%+v", s)
|
||||||
|
}
|
||||||
|
for _, r := range s.Records {
|
||||||
|
if r.Host == "old" {
|
||||||
|
t.Fatal("expired record retained")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
info, _ := os.Stat(Path())
|
||||||
|
if info.Mode().Perm() != 0600 {
|
||||||
|
t.Fatal(info.Mode())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func TestDisabledHistoryDoesNotWrite(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
if err := Append(config.ActivityConfig{}, Record{}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(Path()); !os.IsNotExist(err) {
|
||||||
|
t.Fatal("disabled history wrote data")
|
||||||
|
}
|
||||||
|
}
|
||||||
Vendored
+116
-3
@@ -12,16 +12,22 @@ import (
|
|||||||
|
|
||||||
"golang.org/x/sys/unix"
|
"golang.org/x/sys/unix"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/storage"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/storage"
|
||||||
)
|
)
|
||||||
|
|
||||||
type Entry struct {
|
type Entry struct {
|
||||||
|
Resolver string `json:"resolver,omitempty"`
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
IP string `json:"ip"`
|
IP string `json:"ip"`
|
||||||
Kind string `json:"kind"`
|
Kind string `json:"kind"`
|
||||||
Tags []string `json:"tags,omitempty"`
|
Tags []string `json:"tags,omitempty"`
|
||||||
|
Cluster string `json:"cluster,omitempty"`
|
||||||
CachedAt time.Time `json:"cached_at"`
|
CachedAt time.Time `json:"cached_at"`
|
||||||
LastUsed time.Time `json:"last_used,omitempty"`
|
LastUsed time.Time `json:"last_used,omitempty"`
|
||||||
|
// Static marks a host from the config's hosts: list. It never expires;
|
||||||
|
// it is stored only to remember LastUsed for the recently-used list.
|
||||||
|
Static bool `json:"static,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type changeKind uint8
|
type changeKind uint8
|
||||||
@@ -40,6 +46,7 @@ type Cache struct {
|
|||||||
path string
|
path string
|
||||||
ttl time.Duration
|
ttl time.Duration
|
||||||
refreshStamp string // path to last_refresh timestamp file
|
refreshStamp string // path to last_refresh timestamp file
|
||||||
|
static []config.StaticHost
|
||||||
}
|
}
|
||||||
|
|
||||||
type diskFormat struct {
|
type diskFormat struct {
|
||||||
@@ -77,6 +84,26 @@ func (c *Cache) NeedsRefresh(d time.Duration) bool {
|
|||||||
return time.Since(t) >= d
|
return time.Since(t) >= d
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ClaimRefresh reports whether a background refresh should start now: the last
|
||||||
|
// full refresh is older than d and no attempt was claimed within retry. It
|
||||||
|
// records the attempt, so parallel shells and repeated commands start one
|
||||||
|
// refresh per retry interval instead of one each.
|
||||||
|
func (c *Cache) ClaimRefresh(d, retry time.Duration) bool {
|
||||||
|
if !c.NeedsRefresh(d) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
attempt := filepath.Join(filepath.Dir(c.refreshStamp), "refresh_attempt")
|
||||||
|
if info, err := os.Stat(attempt); err == nil && time.Since(info.ModTime()) < retry {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if err := os.MkdirAll(filepath.Dir(attempt), 0o755); err != nil {
|
||||||
|
return true // cannot record the attempt; refreshing is still right
|
||||||
|
}
|
||||||
|
// Best effort: two processes racing here may both refresh once.
|
||||||
|
_ = os.WriteFile(attempt, nil, 0o600)
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
// SetRefreshed records the current time as the last successful full refresh.
|
// SetRefreshed records the current time as the last successful full refresh.
|
||||||
func (c *Cache) SetRefreshed() error {
|
func (c *Cache) SetRefreshed() error {
|
||||||
if c.refreshStamp == "" {
|
if c.refreshStamp == "" {
|
||||||
@@ -98,6 +125,7 @@ func (c *Cache) Load() error {
|
|||||||
|
|
||||||
data, err := os.ReadFile(c.path)
|
data, err := os.ReadFile(c.path)
|
||||||
if os.IsNotExist(err) {
|
if os.IsNotExist(err) {
|
||||||
|
c.applyStatic()
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -115,6 +143,7 @@ func (c *Cache) Load() error {
|
|||||||
for _, e := range df.Entries {
|
for _, e := range df.Entries {
|
||||||
c.entries[e.Name] = e
|
c.entries[e.Name] = e
|
||||||
}
|
}
|
||||||
|
c.applyStatic()
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -188,6 +217,15 @@ func (c *Cache) Save() error {
|
|||||||
if err := storage.WriteFile(c.path, data, 0o600); err != nil {
|
if err := storage.WriteFile(c.path, data, 0o600); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
// Static hosts come from the config, not the file: keep them in memory.
|
||||||
|
for name, e := range c.entries {
|
||||||
|
if e.Static {
|
||||||
|
if old, ok := merged[name]; ok && old.LastUsed.After(e.LastUsed) {
|
||||||
|
e.LastUsed = old.LastUsed
|
||||||
|
}
|
||||||
|
merged[name] = e
|
||||||
|
}
|
||||||
|
}
|
||||||
c.entries = merged
|
c.entries = merged
|
||||||
c.dirty = make(map[string]changeKind)
|
c.dirty = make(map[string]changeKind)
|
||||||
c.cleared = false
|
c.cleared = false
|
||||||
@@ -221,7 +259,10 @@ func (c *Cache) MarkUsed(name string) {
|
|||||||
if e, ok := c.entries[name]; ok {
|
if e, ok := c.entries[name]; ok {
|
||||||
e.LastUsed = time.Now()
|
e.LastUsed = time.Now()
|
||||||
c.entries[name] = e
|
c.entries[name] = e
|
||||||
if _, changed := c.dirty[name]; !changed {
|
if e.Static {
|
||||||
|
// A static host may not be on disk yet; usage alone would not add it.
|
||||||
|
c.dirty[name] = upsertChange
|
||||||
|
} else if _, changed := c.dirty[name]; !changed {
|
||||||
c.dirty[name] = usageChange
|
c.dirty[name] = usageChange
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -279,7 +320,7 @@ func (c *Cache) GetByShortcut(shortcut string, normalize func(string) string) (e
|
|||||||
entry, found = e, true
|
entry, found = e, true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return entry, found, found && c.ttl > 0 && time.Since(entry.CachedAt) < c.ttl, nil
|
return entry, found, found && (entry.Static || c.ttl > 0 && time.Since(entry.CachedAt) < c.ttl), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get returns an entry and reports whether it is still within the TTL.
|
// Get returns an entry and reports whether it is still within the TTL.
|
||||||
@@ -291,20 +332,92 @@ func (c *Cache) Get(name string) (entry Entry, fresh bool) {
|
|||||||
if !ok {
|
if !ok {
|
||||||
return Entry{}, false
|
return Entry{}, false
|
||||||
}
|
}
|
||||||
|
if e.Static {
|
||||||
|
return e, true
|
||||||
|
}
|
||||||
if c.ttl == 0 {
|
if c.ttl == 0 {
|
||||||
return e, false
|
return e, false
|
||||||
}
|
}
|
||||||
return e, time.Since(e.CachedAt) < c.ttl
|
return e, time.Since(e.CachedAt) < c.ttl
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Clear removes all NetBox entries; static hosts come from the config and stay.
|
||||||
func (c *Cache) Clear() {
|
func (c *Cache) Clear() {
|
||||||
c.mu.Lock()
|
c.mu.Lock()
|
||||||
c.entries = make(map[string]Entry)
|
static := make(map[string]Entry)
|
||||||
|
for name, e := range c.entries {
|
||||||
|
if e.Static {
|
||||||
|
static[name] = e
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c.entries = static
|
||||||
c.dirty = make(map[string]changeKind)
|
c.dirty = make(map[string]changeKind)
|
||||||
c.cleared = true
|
c.cleared = true
|
||||||
c.mu.Unlock()
|
c.mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetStatic adds the config's static hosts. They replace cached entries of the
|
||||||
|
// same name, keep their recorded LastUsed, and static entries that are no
|
||||||
|
// longer configured are removed on the next Save.
|
||||||
|
func (c *Cache) SetStatic(hosts []config.StaticHost) {
|
||||||
|
c.mu.Lock()
|
||||||
|
defer c.mu.Unlock()
|
||||||
|
c.static = hosts
|
||||||
|
c.applyStatic()
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithStatic sets the static hosts now and after every Load.
|
||||||
|
func (c *Cache) WithStatic(hosts []config.StaticHost) *Cache {
|
||||||
|
c.SetStatic(hosts)
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Cache) applyStatic() {
|
||||||
|
hosts := c.static
|
||||||
|
configured := make(map[string]bool, len(hosts))
|
||||||
|
for _, host := range hosts {
|
||||||
|
e := Entry{Name: host.Name, IP: host.Address, Kind: config.StaticKind, Tags: host.Tags, CachedAt: time.Now(), Static: true}
|
||||||
|
if old, ok := c.entries[host.Name]; ok && old.Static {
|
||||||
|
e.LastUsed = old.LastUsed
|
||||||
|
}
|
||||||
|
c.entries[host.Name] = e
|
||||||
|
configured[host.Name] = true
|
||||||
|
}
|
||||||
|
for name, e := range c.entries {
|
||||||
|
if e.Static && !configured[name] {
|
||||||
|
delete(c.entries, name)
|
||||||
|
c.dirty[name] = deleteChange
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetStatic finds a static host by name or by shortcut. Static hosts are
|
||||||
|
// checked before NetBox, so they also work when NetBox is unreachable.
|
||||||
|
func (c *Cache) GetStatic(name string, normalize func(string) string) (Entry, bool, error) {
|
||||||
|
c.mu.RLock()
|
||||||
|
defer c.mu.RUnlock()
|
||||||
|
var match Entry
|
||||||
|
found := false
|
||||||
|
for key, e := range c.entries {
|
||||||
|
if e.Static && strings.EqualFold(key, name) {
|
||||||
|
return e, true, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if normalize == nil {
|
||||||
|
return Entry{}, false, nil
|
||||||
|
}
|
||||||
|
short := normalize(name)
|
||||||
|
for _, e := range c.entries {
|
||||||
|
if e.Static && normalize(e.Name) == short {
|
||||||
|
if found {
|
||||||
|
return Entry{}, false, fmt.Errorf("ambiguous shortcut %q; use a full hostname", name)
|
||||||
|
}
|
||||||
|
match, found = e, true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return match, found, nil
|
||||||
|
}
|
||||||
|
|
||||||
func (c *Cache) All() []Entry {
|
func (c *Cache) All() []Entry {
|
||||||
c.mu.RLock()
|
c.mu.RLock()
|
||||||
defer c.mu.RUnlock()
|
defer c.mu.RUnlock()
|
||||||
|
|||||||
Vendored
+82
@@ -4,8 +4,11 @@ import (
|
|||||||
"encoding/json"
|
"encoding/json"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestNew(t *testing.T) {
|
func TestNew(t *testing.T) {
|
||||||
@@ -495,3 +498,82 @@ func TestSearchMatchesHostnamesAcrossQualifiedSources(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestStaticHosts(t *testing.T) {
|
||||||
|
path := filepath.Join(t.TempDir(), "hosts.json")
|
||||||
|
hosts := []config.StaticHost{{Name: "router", Address: "192.168.1.1", Tags: []string{"home"}}, {Name: "nas", Address: "nas.lan"}}
|
||||||
|
c := New(path, 1).WithStatic(hosts)
|
||||||
|
c.Upsert(Entry{Name: "web01", IP: "10.0.0.1", Kind: "device"})
|
||||||
|
if err := c.Load(); err != nil { // no file yet; static hosts stay
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if e, fresh := c.Get("router"); !fresh || e.IP != "192.168.1.1" || e.Kind != config.StaticKind || !e.Static {
|
||||||
|
t.Fatalf("static get: %+v %v", e, fresh)
|
||||||
|
}
|
||||||
|
if e, found, err := c.GetStatic("ROUTER", nil); !found || err != nil || e.Name != "router" {
|
||||||
|
t.Fatalf("by name: %+v %v %v", e, found, err)
|
||||||
|
}
|
||||||
|
normalize := func(s string) string { return strings.TrimSuffix(strings.ToLower(s), ".lan") }
|
||||||
|
if e, found, _ := c.GetStatic("nas.lan", normalize); !found || e.Name != "nas" {
|
||||||
|
t.Fatalf("by shortcut: %+v", e)
|
||||||
|
}
|
||||||
|
if _, found, _ := c.GetStatic("web01", normalize); found {
|
||||||
|
t.Fatal("NetBox entry returned as static")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Usage of a static host persists; the host itself stays after Save and Clear.
|
||||||
|
c.MarkUsed("router")
|
||||||
|
if err := c.Save(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, fresh := c.Get("nas"); !fresh {
|
||||||
|
t.Fatal("static host lost after Save")
|
||||||
|
}
|
||||||
|
reloaded := New(path, 1).WithStatic(hosts)
|
||||||
|
if err := reloaded.Load(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if recent := reloaded.RecentlyUsed(5); len(recent) != 1 || recent[0].Name != "router" {
|
||||||
|
t.Fatalf("recent: %+v", recent)
|
||||||
|
}
|
||||||
|
reloaded.Clear()
|
||||||
|
if _, fresh := reloaded.Get("router"); !fresh {
|
||||||
|
t.Fatal("Clear removed a static host")
|
||||||
|
}
|
||||||
|
|
||||||
|
// A host removed from the config disappears, also from the file.
|
||||||
|
removed := New(path, 1).WithStatic(hosts[1:])
|
||||||
|
if err := removed.Load(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if e, _ := removed.Get("router"); e.Name != "" {
|
||||||
|
t.Fatalf("removed static host still present: %+v", e)
|
||||||
|
}
|
||||||
|
if err := removed.Save(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
data, _ := os.ReadFile(path)
|
||||||
|
if strings.Contains(string(data), "192.168.1.1") {
|
||||||
|
t.Fatalf("removed static host still on disk:\n%s", data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestClaimRefreshThrottlesAttempts(t *testing.T) {
|
||||||
|
c := New(filepath.Join(t.TempDir(), "netssh", "hosts.json"), 60)
|
||||||
|
if !c.ClaimRefresh(24*time.Hour, time.Minute) {
|
||||||
|
t.Fatal("a never refreshed cache must claim a refresh")
|
||||||
|
}
|
||||||
|
// NetBox is down: the stamp stays stale, but the attempt is remembered.
|
||||||
|
if c.ClaimRefresh(24*time.Hour, time.Minute) {
|
||||||
|
t.Error("a second refresh within the retry interval must not start")
|
||||||
|
}
|
||||||
|
if !c.ClaimRefresh(24*time.Hour, 0) {
|
||||||
|
t.Error("after the retry interval a refresh must start again")
|
||||||
|
}
|
||||||
|
if err := c.SetRefreshed(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if c.ClaimRefresh(24*time.Hour, 0) {
|
||||||
|
t.Error("a freshly refreshed cache must not claim a refresh")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// HostCommand defines a local command and the prefix of its generated host aliases.
|
||||||
|
type HostCommand struct {
|
||||||
|
PostRun string `mapstructure:"post_run"`
|
||||||
|
Match SSHMatch `mapstructure:"match"`
|
||||||
|
Confirm bool `mapstructure:"confirm"`
|
||||||
|
Timeout string `mapstructure:"timeout"`
|
||||||
|
AliasPrefix string `mapstructure:"alias_prefix" yaml:"alias_prefix"`
|
||||||
|
Args []string `mapstructure:"args" yaml:"args"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Config) ValidateCommands() error {
|
||||||
|
prefixes := make(map[string]bool)
|
||||||
|
for name, command := range c.Commands {
|
||||||
|
if strings.ContainsRune(command.PostRun, 0) {
|
||||||
|
return fmt.Errorf("commands.%s.post_run contains NUL", name)
|
||||||
|
}
|
||||||
|
if command.Match != (SSHMatch{}) {
|
||||||
|
if err := command.Match.Validate("commands." + name); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if command.Timeout != "" {
|
||||||
|
d, err := time.ParseDuration(command.Timeout)
|
||||||
|
if err != nil || d <= 0 {
|
||||||
|
return fmt.Errorf("commands.%s.timeout requires a positive duration", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if name == "" || ValidateCommandAlias(name) != nil {
|
||||||
|
return fmt.Errorf("commands.%s: name must be a non-reserved shell identifier", name)
|
||||||
|
}
|
||||||
|
if command.AliasPrefix != "" {
|
||||||
|
if !regexp.MustCompile(`^[a-zA-Z_][a-zA-Z0-9_]*$`).MatchString(command.AliasPrefix) {
|
||||||
|
return fmt.Errorf("commands.%s.alias_prefix must be a shell identifier", name)
|
||||||
|
}
|
||||||
|
if prefixes[command.AliasPrefix] {
|
||||||
|
return fmt.Errorf("commands.%s: duplicate alias_prefix %q", name, command.AliasPrefix)
|
||||||
|
}
|
||||||
|
prefixes[command.AliasPrefix] = true
|
||||||
|
}
|
||||||
|
if len(command.Args) == 0 || strings.TrimSpace(command.Args[0]) == "" {
|
||||||
|
return fmt.Errorf("commands.%s.args requires an executable", name)
|
||||||
|
}
|
||||||
|
target := false
|
||||||
|
for i, arg := range command.Args {
|
||||||
|
if strings.ContainsRune(arg, 0) {
|
||||||
|
return fmt.Errorf("commands.%s.args cannot contain NUL", name)
|
||||||
|
}
|
||||||
|
if i == 0 && strings.ContainsAny(arg, "{}") {
|
||||||
|
return fmt.Errorf("commands.%s: executable cannot contain placeholders", name)
|
||||||
|
}
|
||||||
|
if strings.Contains(arg, "{host}") || strings.Contains(arg, "{address}") || strings.Contains(arg, "{target}") {
|
||||||
|
target = true
|
||||||
|
}
|
||||||
|
rest := strings.NewReplacer("{host}", "", "{address}", "", "{target}", "").Replace(arg)
|
||||||
|
if strings.ContainsAny(rest, "{}") {
|
||||||
|
return fmt.Errorf("commands.%s: supported placeholders are {host}, {address}, {target}", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !target {
|
||||||
|
return fmt.Errorf("commands.%s.args requires {host}, {address}, or {target}", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
func TestValidateCommands(t *testing.T) {
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
command HostCommand
|
||||||
|
valid bool
|
||||||
|
}{
|
||||||
|
{"mtr", HostCommand{AliasPrefix: "m", Args: []string{"mtr", "{address}"}}, true},
|
||||||
|
{"ping", HostCommand{Args: []string{"ping", "-c", "3", "{host}"}}, true},
|
||||||
|
{"inspect", HostCommand{Args: []string{"echo", "{target}"}}, true},
|
||||||
|
{"", HostCommand{Args: []string{"echo", "{host}"}}, false},
|
||||||
|
{"bad name", HostCommand{Args: []string{"echo", "{host}"}}, false},
|
||||||
|
{"netssh", HostCommand{Args: []string{"echo", "{host}"}}, false},
|
||||||
|
{"bad", HostCommand{AliasPrefix: "m;", Args: []string{"mtr", "{address}"}}, false},
|
||||||
|
{"bad", HostCommand{}, false},
|
||||||
|
{"bad", HostCommand{Args: []string{"", "{host}"}}, false},
|
||||||
|
{"bad", HostCommand{Args: []string{"{host}", "{address}"}}, false},
|
||||||
|
{"bad", HostCommand{Args: []string{"mtr", "{adress}"}}, false},
|
||||||
|
{"bad", HostCommand{Args: []string{"mtr"}}, false},
|
||||||
|
{"bad", HostCommand{Args: []string{"mtr", "{host}\x00"}}, false},
|
||||||
|
} {
|
||||||
|
cfg := Config{Commands: map[string]HostCommand{tc.name: tc.command}}
|
||||||
|
if err := cfg.ValidateCommands(); (err == nil) != tc.valid {
|
||||||
|
t.Errorf("%+v: %v", tc, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
cfg := Config{Commands: map[string]HostCommand{
|
||||||
|
"mtr": {AliasPrefix: "m", Args: []string{"mtr", "{address}"}},
|
||||||
|
"ping": {AliasPrefix: "m", Args: []string{"ping", "{address}"}},
|
||||||
|
}}
|
||||||
|
if cfg.ValidateCommands() == nil {
|
||||||
|
t.Fatal("duplicate prefixes accepted")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -11,6 +11,9 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
type Config struct {
|
type Config struct {
|
||||||
|
TUI TUIConfig `mapstructure:"tui"`
|
||||||
|
Activity ActivityConfig `mapstructure:"activity"`
|
||||||
|
Commands map[string]HostCommand `mapstructure:"commands"`
|
||||||
Shell ShellConfig `mapstructure:"shell"`
|
Shell ShellConfig `mapstructure:"shell"`
|
||||||
NetBox NetBoxConfig `mapstructure:"netbox"`
|
NetBox NetBoxConfig `mapstructure:"netbox"`
|
||||||
NetBoxes []NetBoxConfig `mapstructure:"netboxes"`
|
NetBoxes []NetBoxConfig `mapstructure:"netboxes"`
|
||||||
@@ -19,6 +22,10 @@ type Config struct {
|
|||||||
SSH SSHConfig `mapstructure:"ssh"`
|
SSH SSHConfig `mapstructure:"ssh"`
|
||||||
Shortcuts ShortcutsConfig `mapstructure:"shortcuts"`
|
Shortcuts ShortcutsConfig `mapstructure:"shortcuts"`
|
||||||
Completion CompletionConfig `mapstructure:"completion"`
|
Completion CompletionConfig `mapstructure:"completion"`
|
||||||
|
Hosts []StaticHost `mapstructure:"hosts"`
|
||||||
|
// Groups name lists of hosts and selectors for netssh multi (@name).
|
||||||
|
Groups map[string][]string `mapstructure:"groups"`
|
||||||
|
Multi MultiConfig `mapstructure:"multi"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type ShellConfig struct {
|
type ShellConfig struct {
|
||||||
@@ -26,6 +33,7 @@ type ShellConfig struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type NetBoxConfig struct {
|
type NetBoxConfig struct {
|
||||||
|
DisablePrefix bool `mapstructure:"disable_prefix"`
|
||||||
Name string `mapstructure:"name"`
|
Name string `mapstructure:"name"`
|
||||||
URL string `mapstructure:"url"`
|
URL string `mapstructure:"url"`
|
||||||
Token string `mapstructure:"token"`
|
Token string `mapstructure:"token"`
|
||||||
@@ -37,6 +45,8 @@ type ResolverConfig struct {
|
|||||||
Strategies []string `mapstructure:"strategies"`
|
Strategies []string `mapstructure:"strategies"`
|
||||||
ManagementSubnets []string `mapstructure:"management_subnets"`
|
ManagementSubnets []string `mapstructure:"management_subnets"`
|
||||||
InterfaceName string `mapstructure:"interface_name"`
|
InterfaceName string `mapstructure:"interface_name"`
|
||||||
|
// HostnameDomain is appended by the hostname strategy to names without a dot.
|
||||||
|
HostnameDomain string `mapstructure:"hostname_domain"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type CacheConfig struct {
|
type CacheConfig struct {
|
||||||
@@ -59,6 +69,35 @@ type CompletionConfig struct {
|
|||||||
type ShortcutsConfig struct {
|
type ShortcutsConfig struct {
|
||||||
Domains []string `mapstructure:"domains"`
|
Domains []string `mapstructure:"domains"`
|
||||||
StripHyphens bool `mapstructure:"strip_hyphens"`
|
StripHyphens bool `mapstructure:"strip_hyphens"`
|
||||||
|
Rewrites []ShortcutRewrite `mapstructure:"rewrites"`
|
||||||
|
// Show displays each host's shortcut alias in the TUI and in host lists, and
|
||||||
|
// offers shortcuts in Tab completion even when the full name matches.
|
||||||
|
Show bool `mapstructure:"show"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ShortcutRewrite replaces every match of Pattern (Go regexp syntax) with
|
||||||
|
// Replace, which may reference groups as $1. Applied after domain stripping.
|
||||||
|
type ShortcutRewrite struct {
|
||||||
|
Pattern string `mapstructure:"pattern"`
|
||||||
|
Replace string `mapstructure:"replace"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enabled reports whether any shortcut normalization is configured.
|
||||||
|
func (s ShortcutsConfig) Enabled() bool {
|
||||||
|
return len(s.Domains) > 0 || s.StripHyphens || len(s.Rewrites) > 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate rejects rewrite rules that cannot be compiled.
|
||||||
|
func (s ShortcutsConfig) Validate() error {
|
||||||
|
for i, rewrite := range s.Rewrites {
|
||||||
|
if rewrite.Pattern == "" {
|
||||||
|
return fmt.Errorf("shortcuts.rewrites[%d]: pattern is required", i)
|
||||||
|
}
|
||||||
|
if _, err := regexp.Compile(rewrite.Pattern); err != nil {
|
||||||
|
return fmt.Errorf("shortcuts.rewrites[%d]: invalid pattern %q: %v", i, rewrite.Pattern, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Path returns the canonical config file path.
|
// Path returns the canonical config file path.
|
||||||
@@ -76,19 +115,23 @@ func Load() (*Config, error) {
|
|||||||
v.SetDefault("resolver.strategies", []string{"management_subnet", "primary_ip"})
|
v.SetDefault("resolver.strategies", []string{"management_subnet", "primary_ip"})
|
||||||
v.SetDefault("resolver.management_subnets", []string{})
|
v.SetDefault("resolver.management_subnets", []string{})
|
||||||
v.SetDefault("cache.ttl", 3600)
|
v.SetDefault("cache.ttl", 3600)
|
||||||
|
v.SetDefault("tui.history_limit", 10)
|
||||||
|
v.SetDefault("activity.retention_days", 30)
|
||||||
|
v.SetDefault("activity.max_entries", 1000)
|
||||||
|
|
||||||
configDir, err := os.UserConfigDir()
|
configDir, err := os.UserConfigDir()
|
||||||
if err == nil {
|
if err == nil {
|
||||||
v.SetConfigName("netssh")
|
v.SetConfigName("netssh")
|
||||||
v.SetConfigType("yaml")
|
v.SetConfigType("yaml")
|
||||||
v.AddConfigPath(filepath.Join(configDir))
|
// Only the user's own directory: a netssh.yaml in the working directory
|
||||||
v.AddConfigPath(".")
|
// (e.g. of a cloned repository) could inject ssh options and a NetBox URL.
|
||||||
|
v.AddConfigPath(configDir)
|
||||||
}
|
}
|
||||||
|
|
||||||
v.SetEnvPrefix("NETSSH")
|
v.SetEnvPrefix("NETSSH")
|
||||||
v.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
|
v.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
|
||||||
v.AutomaticEnv()
|
v.AutomaticEnv()
|
||||||
for _, key := range []string{"netbox.url", "netbox.token", "netbox.token_version", "resolver.strategies", "resolver.management_subnets", "resolver.interface_name", "cache.ttl", "cache.path", "ssh.default_user", "ssh.default_port", "shortcuts.domains", "shortcuts.strip_hyphens", "shell.alias", "ssh.proxy_jump", "ssh.host_key_checking", "ssh.target", "ssh.address_family", "completion.max_results"} {
|
for _, key := range []string{"netbox.url", "netbox.token", "netbox.token_version", "resolver.strategies", "resolver.management_subnets", "resolver.interface_name", "resolver.hostname_domain", "cache.ttl", "cache.path", "ssh.default_user", "ssh.default_port", "shortcuts.domains", "shortcuts.strip_hyphens", "shortcuts.show", "shell.alias", "ssh.proxy_jump", "ssh.pre_connect", "ssh.post_disconnect", "tui.history_limit", "activity.enabled", "activity.retention_days", "activity.max_entries", "ssh.host_key_checking", "ssh.target", "ssh.address_family", "completion.max_results", "multi.multiplexer", "multi.panes_per_window"} {
|
||||||
if err := v.BindEnv(key); err != nil {
|
if err := v.BindEnv(key); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -128,6 +171,21 @@ func Load() (*Config, error) {
|
|||||||
if err := cfg.ValidateSSH(); err != nil {
|
if err := cfg.ValidateSSH(); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
if err := cfg.Shortcuts.Validate(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := cfg.ValidateHosts(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := cfg.ValidateOperations(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := cfg.ValidateCommands(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := cfg.ValidateMulti(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
for i := range cfg.NetBoxes {
|
for i := range cfg.NetBoxes {
|
||||||
source := &cfg.NetBoxes[i]
|
source := &cfg.NetBoxes[i]
|
||||||
source.Name = strings.ToLower(source.Name)
|
source.Name = strings.ToLower(source.Name)
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ package config
|
|||||||
import (
|
import (
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -177,3 +178,45 @@ func TestCommandAliasEnvironmentAndValidation(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestLoad_ShortcutRewrites(t *testing.T) {
|
||||||
|
dir := writeConfig(t, "shortcuts:\n rewrites:\n - pattern: '^([a-z]+)[0-9]+-'\n replace: '$1'\n")
|
||||||
|
cfg := loadFromDir(t, dir)
|
||||||
|
want := []ShortcutRewrite{{Pattern: `^([a-z]+)[0-9]+-`, Replace: "$1"}}
|
||||||
|
if len(cfg.Shortcuts.Rewrites) != 1 || cfg.Shortcuts.Rewrites[0] != want[0] || !cfg.Shortcuts.Enabled() {
|
||||||
|
t.Fatalf("rewrites: %+v", cfg.Shortcuts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoad_InvalidShortcutRewrite(t *testing.T) {
|
||||||
|
for _, rule := range []string{"pattern: '[a-'", "replace: x"} {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", writeConfig(t, "shortcuts:\n rewrites:\n - "+rule+"\n"))
|
||||||
|
if _, err := Load(); err == nil || !strings.Contains(err.Error(), "shortcuts.rewrites[0]") {
|
||||||
|
t.Errorf("%s: got %v", rule, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A netssh.yaml in the working directory (e.g. of a cloned repository) must
|
||||||
|
// not be loaded: it could inject ssh options such as ProxyCommand.
|
||||||
|
func TestLoad_IgnoresConfigInWorkingDirectory(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
t.Setenv("NETSSH_NETBOX_URL", "")
|
||||||
|
t.Chdir(writeConfig(t, "hosts:\n - name: evil\n address: 10.0.0.1\nssh:\n options:\n ProxyCommand: touch /tmp/pwned\n"))
|
||||||
|
cfg, err := Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Load: %v", err)
|
||||||
|
}
|
||||||
|
if len(cfg.Hosts) != 0 || len(cfg.SSH.Options) != 0 {
|
||||||
|
t.Errorf("config from the working directory was loaded: %+v", cfg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoad_RejectsInvalidLegacyNetBoxURL(t *testing.T) {
|
||||||
|
for _, bad := range []string{"netbox.example.com", "ftp://netbox.example.com", "https://netbox.example.com/?x=1"} {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", writeConfig(t, "netbox:\n url: \""+bad+"\"\n token: t\n"))
|
||||||
|
if _, err := Load(); err == nil || !strings.Contains(err.Error(), "netbox.url") {
|
||||||
|
t.Errorf("%s: got %v, want a netbox.url error", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// StaticKind is the kind of hosts defined under hosts: instead of NetBox.
|
||||||
|
const StaticKind = "static"
|
||||||
|
|
||||||
|
// StaticHost is a host that is not in NetBox, defined in the config.
|
||||||
|
type StaticHost struct {
|
||||||
|
Name string `mapstructure:"name"`
|
||||||
|
Address string `mapstructure:"address"` // IP address or DNS name
|
||||||
|
User string `mapstructure:"user"`
|
||||||
|
Port int `mapstructure:"port"`
|
||||||
|
Tags []string `mapstructure:"tags"`
|
||||||
|
SSH SSHOptions `mapstructure:"ssh"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var staticHostName = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9._-]*$`)
|
||||||
|
|
||||||
|
// ValidateHosts keeps static host names usable as selectors and addresses
|
||||||
|
// safe to pass to ssh.
|
||||||
|
func (c *Config) ValidateHosts() error {
|
||||||
|
seen := make(map[string]bool)
|
||||||
|
for i, host := range c.Hosts {
|
||||||
|
scope := fmt.Sprintf("hosts[%d]", i)
|
||||||
|
if !staticHostName.MatchString(host.Name) {
|
||||||
|
return fmt.Errorf("%s: name %q must start with a letter or digit and contain only letters, digits, dots, underscores, or hyphens", scope, host.Name)
|
||||||
|
}
|
||||||
|
name := strings.ToLower(host.Name)
|
||||||
|
if seen[name] {
|
||||||
|
return fmt.Errorf("%s: duplicate host name %q", scope, host.Name)
|
||||||
|
}
|
||||||
|
seen[name] = true
|
||||||
|
if host.Address == "" || strings.HasPrefix(host.Address, "-") || strings.ContainsAny(host.Address, " \t\n\r/@") {
|
||||||
|
return fmt.Errorf("%s: address %q must be an IP address or hostname", scope, host.Address)
|
||||||
|
}
|
||||||
|
if host.Port < 0 || host.Port > 65535 {
|
||||||
|
return fmt.Errorf("%s: port must be between 1 and 65535", scope)
|
||||||
|
}
|
||||||
|
if strings.HasPrefix(host.User, "-") || strings.ContainsAny(host.User, " \t\n\r@") {
|
||||||
|
return fmt.Errorf("%s: invalid user %q", scope, host.User)
|
||||||
|
}
|
||||||
|
if err := host.SSH.Validate(scope + ".ssh"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// StaticHost returns the static host with the given name, or nil.
|
||||||
|
func (c *Config) StaticHost(name string) *StaticHost {
|
||||||
|
for i := range c.Hosts {
|
||||||
|
if strings.EqualFold(c.Hosts[i].Name, name) {
|
||||||
|
return &c.Hosts[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -17,6 +17,9 @@ func (c *Config) ValidateNetBoxes() error {
|
|||||||
if len(c.NetBoxes) > 0 && c.NetBox.URL != "" {
|
if len(c.NetBoxes) > 0 && c.NetBox.URL != "" {
|
||||||
return fmt.Errorf("configure either netbox or netboxes, not both")
|
return fmt.Errorf("configure either netbox or netboxes, not both")
|
||||||
}
|
}
|
||||||
|
if c.NetBox.URL != "" && !validNetBoxURL(c.NetBox.URL) {
|
||||||
|
return fmt.Errorf("netbox.url %q must be an HTTP(S) URL without query or fragment", c.NetBox.URL)
|
||||||
|
}
|
||||||
seen := make(map[string]bool)
|
seen := make(map[string]bool)
|
||||||
for _, source := range c.NetBoxes {
|
for _, source := range c.NetBoxes {
|
||||||
if !instanceName.MatchString(source.Name) {
|
if !instanceName.MatchString(source.Name) {
|
||||||
@@ -27,8 +30,7 @@ func (c *Config) ValidateNetBoxes() error {
|
|||||||
return fmt.Errorf("duplicate NetBox instance name %q", source.Name)
|
return fmt.Errorf("duplicate NetBox instance name %q", source.Name)
|
||||||
}
|
}
|
||||||
seen[name] = true
|
seen[name] = true
|
||||||
u, err := url.Parse(source.URL)
|
if !validNetBoxURL(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)
|
return fmt.Errorf("NetBox %q requires an HTTP(S) URL without query or fragment", source.Name)
|
||||||
}
|
}
|
||||||
if source.TokenVersion < 0 || source.TokenVersion > 2 {
|
if source.TokenVersion < 0 || source.TokenVersion > 2 {
|
||||||
@@ -38,8 +40,17 @@ func (c *Config) ValidateNetBoxes() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// validNetBoxURL accepts base URLs that API paths can be appended to.
|
||||||
|
func validNetBoxURL(raw string) bool {
|
||||||
|
u, err := url.Parse(raw)
|
||||||
|
return err == nil && (u.Scheme == "http" || u.Scheme == "https") && u.Host != "" && u.RawQuery == "" && u.Fragment == ""
|
||||||
|
}
|
||||||
|
|
||||||
func (c *Config) HasNetBox() bool { return c.NetBox.URL != "" || len(c.NetBoxes) > 0 }
|
func (c *Config) HasNetBox() bool { return c.NetBox.URL != "" || len(c.NetBoxes) > 0 }
|
||||||
|
|
||||||
|
// HasHosts reports whether netssh has anything to connect to: NetBox or static hosts.
|
||||||
|
func (c *Config) HasHosts() bool { return c.HasNetBox() || len(c.Hosts) > 0 }
|
||||||
|
|
||||||
// CachePath isolates named sources from legacy caches and from changed endpoints.
|
// CachePath isolates named sources from legacy caches and from changed endpoints.
|
||||||
// Rotating a token or reordering the sources does not discard usage history.
|
// Rotating a token or reordering the sources does not discard usage history.
|
||||||
func (c *Config) CachePath() string {
|
func (c *Config) CachePath() string {
|
||||||
@@ -54,3 +65,17 @@ func (c *Config) CachePath() string {
|
|||||||
sum := sha256.Sum256([]byte(strings.Join(identities, "\x00")))
|
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))
|
return filepath.Join(filepath.Dir(c.Cache.Path), fmt.Sprintf("instances-%x", sum[:8]), filepath.Base(c.Cache.Path))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// HostLabel omits the configured instance prefix for display only. Callers
|
||||||
|
// must retain the canonical target for connections and handle label collisions.
|
||||||
|
func (c *Config) HostLabel(target string) string {
|
||||||
|
source, host, qualified := strings.Cut(target, "/")
|
||||||
|
if qualified {
|
||||||
|
for _, instance := range c.NetBoxes {
|
||||||
|
if instance.DisablePrefix && strings.EqualFold(instance.Name, source) {
|
||||||
|
return host
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return target
|
||||||
|
}
|
||||||
@@ -15,6 +15,7 @@ func TestLoadNamedNetBoxes(t *testing.T) {
|
|||||||
- name: Office
|
- name: Office
|
||||||
url: https://office.example/netbox
|
url: https://office.example/netbox
|
||||||
token: nbt_office
|
token: nbt_office
|
||||||
|
disable_prefix: true
|
||||||
- name: lab
|
- name: lab
|
||||||
url: https://lab.example
|
url: https://lab.example
|
||||||
token: legacy-token
|
token: legacy-token
|
||||||
@@ -34,7 +35,14 @@ cache:
|
|||||||
if cfg.NetBox.URL != "" {
|
if cfg.NetBox.URL != "" {
|
||||||
t.Fatal("legacy environment variables added an unnamed instance")
|
t.Fatal("legacy environment variables added an unnamed instance")
|
||||||
}
|
}
|
||||||
|
if !cfg.NetBoxes[0].DisablePrefix || cfg.NetBoxes[1].DisablePrefix {
|
||||||
|
t.Fatal("per-instance alias prefix setting was not loaded")
|
||||||
|
}
|
||||||
first := cfg.CachePath()
|
first := cfg.CachePath()
|
||||||
|
cfg.NetBoxes[0].DisablePrefix = false
|
||||||
|
if cfg.CachePath() != first {
|
||||||
|
t.Fatal("alias prefix setting discarded cache")
|
||||||
|
}
|
||||||
if first == cfg.Cache.Path {
|
if first == cfg.Cache.Path {
|
||||||
t.Fatal("named sources reuse legacy cache")
|
t.Fatal("named sources reuse legacy cache")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,92 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"regexp"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MultiConfig controls netssh multi.
|
||||||
|
type MultiConfig struct {
|
||||||
|
// Multiplexer is auto, tmux, or zellij; empty means auto.
|
||||||
|
Multiplexer string `mapstructure:"multiplexer"`
|
||||||
|
// PanesPerWindow splits larger host lists into more windows or tabs; 0 = 9.
|
||||||
|
PanesPerWindow int `mapstructure:"panes_per_window"`
|
||||||
|
// SyncKey and SoloKey are tmux prefix keys for broadcast to all panes and
|
||||||
|
// for excluding the current pane; empty = default (S, e), "none" = off.
|
||||||
|
SyncKey string `mapstructure:"sync_key"`
|
||||||
|
SoloKey string `mapstructure:"solo_key"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Default tmux keys: unbound in a stock tmux (E would be "spread evenly").
|
||||||
|
const (
|
||||||
|
DefaultSyncKey = "S"
|
||||||
|
DefaultSoloKey = "e"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Keys returns the tmux keys to bind; "" for a disabled one.
|
||||||
|
func (m MultiConfig) Keys() (sync, solo string) {
|
||||||
|
pick := func(key, fallback string) string {
|
||||||
|
switch key {
|
||||||
|
case "":
|
||||||
|
return fallback
|
||||||
|
case "none":
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return key
|
||||||
|
}
|
||||||
|
return pick(m.SyncKey, DefaultSyncKey), pick(m.SoloKey, DefaultSoloKey)
|
||||||
|
}
|
||||||
|
|
||||||
|
var tmuxKey = regexp.MustCompile(`^([CMS]-)*([A-Za-z0-9]|F[0-9]{1,2}|[-_=+!@#$%^&*,./?<>\[\]]|Tab|Space|Enter|BSpace|Up|Down|Left|Right|Home|End|PPage|NPage)$`)
|
||||||
|
|
||||||
|
// DefaultPanesPerWindow keeps panes readable on a normal screen (3×3).
|
||||||
|
const DefaultPanesPerWindow = 9
|
||||||
|
|
||||||
|
// ValidateMulti checks groups and the multi settings.
|
||||||
|
func (c *Config) ValidateMulti() error {
|
||||||
|
switch c.Multi.Multiplexer {
|
||||||
|
case "", "auto", "tmux", "zellij":
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("multi.multiplexer must be auto, tmux, or zellij")
|
||||||
|
}
|
||||||
|
if c.Multi.PanesPerWindow < 0 || c.Multi.PanesPerWindow > 64 {
|
||||||
|
return fmt.Errorf("multi.panes_per_window must be between 1 and 64")
|
||||||
|
}
|
||||||
|
for name, key := range map[string]string{"sync_key": c.Multi.SyncKey, "solo_key": c.Multi.SoloKey} {
|
||||||
|
if key != "" && key != "none" && !tmuxKey.MatchString(key) {
|
||||||
|
return fmt.Errorf("multi.%s %q is not a tmux key (e.g. S, e, C-s, F5) or none", name, key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if sync, solo := c.Multi.Keys(); sync != "" && sync == solo {
|
||||||
|
return fmt.Errorf("multi.sync_key and multi.solo_key must differ")
|
||||||
|
}
|
||||||
|
names := make([]string, 0, len(c.Groups))
|
||||||
|
for name := range c.Groups {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
for _, name := range names {
|
||||||
|
if !instanceName.MatchString(name) {
|
||||||
|
return fmt.Errorf("groups: name %q must contain only letters, digits, underscores, or hyphens", name)
|
||||||
|
}
|
||||||
|
if len(c.Groups[name]) == 0 {
|
||||||
|
return fmt.Errorf("groups.%s: needs at least one host or selector", name)
|
||||||
|
}
|
||||||
|
for _, selector := range c.Groups[name] {
|
||||||
|
if strings.TrimSpace(selector) == "" || strings.ContainsAny(selector, " \t\n") || strings.HasPrefix(selector, "-") {
|
||||||
|
return fmt.Errorf("groups.%s: invalid entry %q", name, selector)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// PanesPerWindowOrDefault returns the configured value or the default.
|
||||||
|
func (m MultiConfig) PanesPerWindowOrDefault() int {
|
||||||
|
if m.PanesPerWindow > 0 {
|
||||||
|
return m.PanesPerWindow
|
||||||
|
}
|
||||||
|
return DefaultPanesPerWindow
|
||||||
|
}
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
type TUIConfig struct {
|
||||||
|
HistoryLimit int `mapstructure:"history_limit"`
|
||||||
|
}
|
||||||
|
type ActivityConfig struct {
|
||||||
|
Enabled bool `mapstructure:"enabled"`
|
||||||
|
RetentionDays int `mapstructure:"retention_days"`
|
||||||
|
MaxEntries int `mapstructure:"max_entries"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Config) ValidateOperations() error {
|
||||||
|
if c.TUI.HistoryLimit < 0 {
|
||||||
|
return fmt.Errorf("tui.history_limit must be >= 0 (0 = all)")
|
||||||
|
}
|
||||||
|
if c.Activity.RetentionDays < 0 || c.Activity.MaxEntries < 0 {
|
||||||
|
return fmt.Errorf("activity retention_days and max_entries must be >= 0")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (m SSHMatch) Matches(host SSHHost) bool { return m == (SSHMatch{}) || m.matches(host) }
|
||||||
|
func (c HostCommand) Allowed(host SSHHost) bool { return c.Match.Matches(host) }
|
||||||
|
func HookCommand(s string) string {
|
||||||
|
s = strings.TrimSpace(s)
|
||||||
|
if strings.EqualFold(s, "none") {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestOperationsDefaultsEnvironmentAndValidation(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
if err := os.WriteFile(filepath.Join(os.Getenv("XDG_CONFIG_HOME"), "netssh.yaml"), []byte("hosts:\n - name: router\n address: 192.0.2.1\n"), 0600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
cfg, err := Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if cfg.TUI.HistoryLimit != 10 || cfg.Activity.Enabled || cfg.Activity.RetentionDays != 30 || cfg.Activity.MaxEntries != 1000 {
|
||||||
|
t.Fatalf("%+v %+v", cfg.TUI, cfg.Activity)
|
||||||
|
}
|
||||||
|
t.Setenv("NETSSH_TUI_HISTORY_LIMIT", "25")
|
||||||
|
t.Setenv("NETSSH_SSH_POST_DISCONNECT", "echo done")
|
||||||
|
cfg, err = Load()
|
||||||
|
if err != nil || cfg.TUI.HistoryLimit != 25 || cfg.SSH.PostDisconnect != "echo done" {
|
||||||
|
t.Fatalf("%+v %v", cfg, err)
|
||||||
|
}
|
||||||
|
cfg.TUI.HistoryLimit = -1
|
||||||
|
if cfg.ValidateOperations() == nil {
|
||||||
|
t.Fatal("negative history accepted")
|
||||||
|
}
|
||||||
|
for _, timeout := range []string{"-1s", "0s", "invalid"} {
|
||||||
|
cfg.Commands = map[string]HostCommand{"check": {Args: []string{"echo", "{host}"}, Timeout: timeout}}
|
||||||
|
if cfg.ValidateCommands() == nil {
|
||||||
|
t.Fatalf("accepted %q", timeout)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func TestPostDisconnectLayering(t *testing.T) {
|
||||||
|
cfg := Config{
|
||||||
|
SSH: SSHConfig{SSHOptions: SSHOptions{PostDisconnect: "global"}, Rules: []SSHRule{{Match: SSHMatch{Tag: "lab"}, SSHOptions: SSHOptions{PostDisconnect: "none"}}}},
|
||||||
|
NetBoxes: []NetBoxConfig{{Name: "prod", SSH: SSHOptions{PostDisconnect: "instance"}}},
|
||||||
|
}
|
||||||
|
for _, tc := range []struct {
|
||||||
|
host SSHHost
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{SSHHost{Name: "web"}, "global"},
|
||||||
|
{SSHHost{Name: "web", Instance: "prod"}, "instance"},
|
||||||
|
{SSHHost{Name: "web", Instance: "prod", Tags: []string{"lab"}}, ""},
|
||||||
|
} {
|
||||||
|
if got := HookCommand(cfg.SSHOptionsFor(tc.host).PostDisconnect); got != tc.want {
|
||||||
|
t.Fatalf("%q want %q", got, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+116
-12
@@ -22,6 +22,64 @@ type SSHOptions struct {
|
|||||||
ExtraArgs []string `mapstructure:"extra_args"`
|
ExtraArgs []string `mapstructure:"extra_args"`
|
||||||
// Options are passed as -o Key=Value.
|
// Options are passed as -o Key=Value.
|
||||||
Options map[string]string `mapstructure:"options"`
|
Options map[string]string `mapstructure:"options"`
|
||||||
|
// Forwards are named port forwards, selected with --forward or netssh tunnel.
|
||||||
|
Forwards map[string]Forward `mapstructure:"forwards"`
|
||||||
|
// PreConnect is a shell command run locally before connecting; a non-zero
|
||||||
|
// exit aborts the connection. "none" disables a hook set by a broader layer.
|
||||||
|
PreConnect string `mapstructure:"pre_connect"`
|
||||||
|
PostDisconnect string `mapstructure:"post_disconnect"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PreConnectNone disables an inherited pre_connect hook.
|
||||||
|
const PreConnectNone = "none"
|
||||||
|
|
||||||
|
// PreConnectCommand returns the hook to run, or "" when none is configured.
|
||||||
|
func (o SSHOptions) PreConnectCommand() string {
|
||||||
|
command := strings.TrimSpace(o.PreConnect)
|
||||||
|
if strings.EqualFold(command, PreConnectNone) {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return command
|
||||||
|
}
|
||||||
|
|
||||||
|
// Forward is one port forward; exactly one of the fields is set.
|
||||||
|
type Forward struct {
|
||||||
|
Local string `mapstructure:"local"` // -L [bind:]port:host:hostport
|
||||||
|
Remote string `mapstructure:"remote"` // -R [bind:]port:host:hostport
|
||||||
|
Dynamic string `mapstructure:"dynamic"` // -D [bind:]port (SOCKS proxy)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Flag returns the ssh arguments for the forward, e.g. -L 8080:localhost:80.
|
||||||
|
func (f Forward) Flag() []string {
|
||||||
|
switch {
|
||||||
|
case f.Local != "":
|
||||||
|
return []string{"-L", f.Local}
|
||||||
|
case f.Remote != "":
|
||||||
|
return []string{"-R", f.Remote}
|
||||||
|
case f.Dynamic != "":
|
||||||
|
return []string{"-D", f.Dynamic}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// String renders the forward as its ssh flag, e.g. "-L 8080:localhost:80".
|
||||||
|
func (f Forward) String() string { return strings.Join(f.Flag(), " ") }
|
||||||
|
|
||||||
|
func (f Forward) validate() error {
|
||||||
|
set := 0
|
||||||
|
for _, spec := range []string{f.Local, f.Remote, f.Dynamic} {
|
||||||
|
if spec == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
set++
|
||||||
|
if strings.HasPrefix(spec, "-") || strings.ContainsAny(spec, " \t\n\r") {
|
||||||
|
return fmt.Errorf("invalid forward %q", spec)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if set != 1 {
|
||||||
|
return fmt.Errorf("set exactly one of local, remote, dynamic")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// SSHRule applies SSH options to hosts that match every non-empty field.
|
// SSHRule applies SSH options to hosts that match every non-empty field.
|
||||||
@@ -50,32 +108,46 @@ var sshOptionKey = regexp.MustCompile(`^[A-Za-z][A-Za-z0-9]*$`)
|
|||||||
|
|
||||||
// ValidateSSH rejects values that would be passed to ssh in an unexpected form.
|
// ValidateSSH rejects values that would be passed to ssh in an unexpected form.
|
||||||
func (c *Config) ValidateSSH() error {
|
func (c *Config) ValidateSSH() error {
|
||||||
if err := c.SSH.SSHOptions.validate("ssh"); err != nil {
|
if err := c.SSH.SSHOptions.Validate("ssh"); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
for i, rule := range c.SSH.Rules {
|
for i, rule := range c.SSH.Rules {
|
||||||
if err := rule.SSHOptions.validate(fmt.Sprintf("ssh.rules[%d]", i)); err != nil {
|
if err := rule.Validate(fmt.Sprintf("ssh.rules[%d]", i)); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if rule.Match == (SSHMatch{}) {
|
|
||||||
return fmt.Errorf("ssh.rules[%d]: match must set at least one of tag, instance, kind, name", i)
|
|
||||||
}
|
}
|
||||||
if _, err := path.Match(rule.Match.Name, ""); err != nil {
|
if err := c.NetBox.SSH.Validate("netbox.ssh"); err != nil {
|
||||||
return fmt.Errorf("ssh.rules[%d]: invalid name pattern %q", i, rule.Match.Name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if err := c.NetBox.SSH.validate("netbox.ssh"); err != nil {
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
for _, source := range c.NetBoxes {
|
for _, source := range c.NetBoxes {
|
||||||
if err := source.SSH.validate("netboxes." + source.Name + ".ssh"); err != nil {
|
if err := source.SSH.Validate("netboxes." + source.Name + ".ssh"); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o SSHOptions) validate(scope string) error {
|
// Validate checks the match and options of a single rule.
|
||||||
|
func (r SSHRule) Validate(scope string) error {
|
||||||
|
if err := r.SSHOptions.Validate(scope); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return r.Match.Validate(scope)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate requires at least one selector and a well-formed name pattern.
|
||||||
|
func (m SSHMatch) Validate(scope string) error {
|
||||||
|
if m == (SSHMatch{}) {
|
||||||
|
return fmt.Errorf("%s: match must set at least one of tag, instance, kind, name", scope)
|
||||||
|
}
|
||||||
|
if _, err := path.Match(m.Name, ""); err != nil {
|
||||||
|
return fmt.Errorf("%s: invalid name pattern %q", scope, m.Name)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate rejects values that ssh would not accept or would misinterpret.
|
||||||
|
func (o SSHOptions) Validate(scope string) error {
|
||||||
switch o.HostKeyChecking {
|
switch o.HostKeyChecking {
|
||||||
case "", "strict", "accept-new", "off":
|
case "", "strict", "accept-new", "off":
|
||||||
default:
|
default:
|
||||||
@@ -99,13 +171,31 @@ func (o SSHOptions) validate(scope string) error {
|
|||||||
return fmt.Errorf("%s.options: invalid option %q", scope, key)
|
return fmt.Errorf("%s.options: invalid option %q", scope, key)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if strings.ContainsRune(o.PostDisconnect, 0) {
|
||||||
|
return fmt.Errorf("%s.post_disconnect must not contain NUL bytes", scope)
|
||||||
|
}
|
||||||
|
if strings.ContainsRune(o.PreConnect, 0) {
|
||||||
|
return fmt.Errorf("%s.pre_connect must not contain NUL bytes", scope)
|
||||||
|
}
|
||||||
|
for name, forward := range o.Forwards {
|
||||||
|
if !instanceName.MatchString(name) {
|
||||||
|
return fmt.Errorf("%s.forwards: name %q must contain only letters, digits, underscores, or hyphens", scope, name)
|
||||||
|
}
|
||||||
|
if err := forward.validate(); err != nil {
|
||||||
|
return fmt.Errorf("%s.forwards.%s: %v", scope, name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// SSHOptionsFor merges global, instance, and matching rule options for host.
|
// SSHOptionsFor merges global, instance, and matching rule options for host.
|
||||||
func (c *Config) SSHOptionsFor(host SSHHost) SSHOptions {
|
func (c *Config) SSHOptionsFor(host SSHHost) SSHOptions {
|
||||||
merged := c.SSH.SSHOptions.merge(SSHOptions{})
|
merged := c.SSH.SSHOptions.merge(SSHOptions{})
|
||||||
if host.Instance == "" {
|
if host.Kind == StaticKind {
|
||||||
|
if static := c.StaticHost(host.Name); static != nil {
|
||||||
|
merged = merged.merge(static.SSH)
|
||||||
|
}
|
||||||
|
} else if host.Instance == "" {
|
||||||
merged = merged.merge(c.NetBox.SSH)
|
merged = merged.merge(c.NetBox.SSH)
|
||||||
}
|
}
|
||||||
for _, source := range c.NetBoxes {
|
for _, source := range c.NetBoxes {
|
||||||
@@ -133,6 +223,14 @@ func (o SSHOptions) merge(override SSHOptions) SSHOptions {
|
|||||||
for key, value := range override.Options {
|
for key, value := range override.Options {
|
||||||
out.Options[strings.ToLower(key)] = value
|
out.Options[strings.ToLower(key)] = value
|
||||||
}
|
}
|
||||||
|
// Forwards override per name, so a rule can redefine a global "web" forward.
|
||||||
|
out.Forwards = make(map[string]Forward, len(o.Forwards)+len(override.Forwards))
|
||||||
|
for name, forward := range o.Forwards {
|
||||||
|
out.Forwards[strings.ToLower(name)] = forward
|
||||||
|
}
|
||||||
|
for name, forward := range override.Forwards {
|
||||||
|
out.Forwards[strings.ToLower(name)] = forward
|
||||||
|
}
|
||||||
if override.ProxyJump != "" {
|
if override.ProxyJump != "" {
|
||||||
out.ProxyJump = override.ProxyJump
|
out.ProxyJump = override.ProxyJump
|
||||||
}
|
}
|
||||||
@@ -145,6 +243,12 @@ func (o SSHOptions) merge(override SSHOptions) SSHOptions {
|
|||||||
if override.AddressFamily != "" {
|
if override.AddressFamily != "" {
|
||||||
out.AddressFamily = override.AddressFamily
|
out.AddressFamily = override.AddressFamily
|
||||||
}
|
}
|
||||||
|
if strings.TrimSpace(override.PostDisconnect) != "" {
|
||||||
|
out.PostDisconnect = override.PostDisconnect
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(override.PreConnect) != "" {
|
||||||
|
out.PreConnect = override.PreConnect
|
||||||
|
}
|
||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -88,3 +88,172 @@ func TestSSHOptionsValidation(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestForwardsLayering(t *testing.T) {
|
||||||
|
cfg, err := loadYAML(t, `
|
||||||
|
netboxes:
|
||||||
|
- name: prod
|
||||||
|
url: https://prod.example
|
||||||
|
token: t
|
||||||
|
ssh:
|
||||||
|
forwards:
|
||||||
|
db: {local: "5432:localhost:5432"}
|
||||||
|
ssh:
|
||||||
|
forwards:
|
||||||
|
web: {local: "8080:localhost:80"}
|
||||||
|
socks: {dynamic: "1080"}
|
||||||
|
rules:
|
||||||
|
- match: {tag: dmz}
|
||||||
|
forwards:
|
||||||
|
web: {local: "8443:localhost:443"}
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got := cfg.SSHOptionsFor(SSHHost{Instance: "prod", Name: "web01", Tags: []string{"dmz"}}).Forwards
|
||||||
|
want := map[string]Forward{"web": {Local: "8443:localhost:443"}, "socks": {Dynamic: "1080"}, "db": {Local: "5432:localhost:5432"}}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("got %+v", got)
|
||||||
|
}
|
||||||
|
if got := cfg.SSHOptionsFor(SSHHost{Instance: "other", Name: "web01"}).Forwards; len(got) != 2 || got["web"].Local != "8080:localhost:80" {
|
||||||
|
t.Fatalf("other instance: %+v", got)
|
||||||
|
}
|
||||||
|
if f := (Forward{Remote: "9000:localhost:9000"}); f.String() != "-R 9000:localhost:9000" {
|
||||||
|
t.Fatal(f.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForwardsValidation(t *testing.T) {
|
||||||
|
for _, forwards := range []string{
|
||||||
|
`web: {local: "8080:a:80", dynamic: "1080"}`,
|
||||||
|
`web: {local: "-oProxyCommand=x"}`,
|
||||||
|
`web: {local: "8080 a:80"}`,
|
||||||
|
`"bad name": {local: "8080:a:80"}`,
|
||||||
|
} {
|
||||||
|
if _, err := loadYAML(t, "ssh:\n forwards:\n "+forwards+"\n"); err == nil || !strings.Contains(err.Error(), "forwards") {
|
||||||
|
t.Errorf("%s: got %v", forwards, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStaticHosts(t *testing.T) {
|
||||||
|
cfg, err := loadYAML(t, `
|
||||||
|
resolver:
|
||||||
|
hostname_domain: example.com
|
||||||
|
ssh:
|
||||||
|
proxy_jump: jh
|
||||||
|
rules:
|
||||||
|
- match: {kind: static, tag: home}
|
||||||
|
host_key_checking: off
|
||||||
|
hosts:
|
||||||
|
- name: Router
|
||||||
|
address: 192.168.1.1
|
||||||
|
user: admin
|
||||||
|
port: 2222
|
||||||
|
tags: [home]
|
||||||
|
ssh:
|
||||||
|
proxy_jump: none
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !cfg.HasHosts() || cfg.HasNetBox() || cfg.Resolver.HostnameDomain != "example.com" {
|
||||||
|
t.Fatalf("got %+v", cfg)
|
||||||
|
}
|
||||||
|
host := cfg.StaticHost("router")
|
||||||
|
if host == nil || host.Address != "192.168.1.1" || host.User != "admin" || host.Port != 2222 {
|
||||||
|
t.Fatalf("host: %+v", host)
|
||||||
|
}
|
||||||
|
opts := cfg.SSHOptionsFor(SSHHost{Name: "Router", Kind: StaticKind, Tags: []string{"home"}})
|
||||||
|
if opts.ProxyJump != "none" || opts.HostKeyChecking != "off" {
|
||||||
|
t.Fatalf("static host options: %+v", opts)
|
||||||
|
}
|
||||||
|
// A NetBox host of the same name does not get the static host's options.
|
||||||
|
if got := cfg.SSHOptionsFor(SSHHost{Name: "Router", Kind: "device"}); got.ProxyJump != "jh" {
|
||||||
|
t.Fatalf("netbox host: %+v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStaticHostsValidation(t *testing.T) {
|
||||||
|
for _, hosts := range []string{
|
||||||
|
"- {name: a, address: 10.0.0.1}\n - {name: A, address: 10.0.0.2}",
|
||||||
|
"- {name: 'bad name', address: 10.0.0.1}",
|
||||||
|
"- {name: prod/a, address: 10.0.0.1}",
|
||||||
|
"- {name: a}",
|
||||||
|
"- {name: a, address: '-oProxyCommand=x'}",
|
||||||
|
"- {name: a, address: 10.0.0.1, port: 70000}",
|
||||||
|
"- {name: a, address: 10.0.0.1, user: 'a b'}",
|
||||||
|
"- {name: a, address: 10.0.0.1, ssh: {target: nope}}",
|
||||||
|
} {
|
||||||
|
if _, err := loadYAML(t, "hosts:\n "+hosts+"\n"); err == nil || !strings.Contains(err.Error(), "hosts[") {
|
||||||
|
t.Errorf("%s: got %v", hosts, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMultiConfig(t *testing.T) {
|
||||||
|
cfg, err := loadYAML(t, "groups:\n K8s: [master1, \"tag:worker\"]\nmulti:\n multiplexer: zellij\n")
|
||||||
|
if err != nil || len(cfg.Groups["k8s"]) != 2 || cfg.Multi.Multiplexer != "zellij" || cfg.Multi.PanesPerWindowOrDefault() != 9 {
|
||||||
|
t.Fatalf("%+v %v", cfg, err)
|
||||||
|
}
|
||||||
|
if sync, solo := cfg.Multi.Keys(); sync != "S" || solo != "e" {
|
||||||
|
t.Fatalf("default keys %q %q", sync, solo)
|
||||||
|
}
|
||||||
|
custom, err := loadYAML(t, "multi: {sync_key: C-s, solo_key: none}\n")
|
||||||
|
if sync, solo := custom.Multi.Keys(); err != nil || sync != "C-s" || solo != "" {
|
||||||
|
t.Fatalf("custom keys %q %q %v", sync, solo, err)
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"multi: {multiplexer: screen}", "multi: {panes_per_window: 100}", "groups: {web: []}", "groups: {web: [\"a b\"]}",
|
||||||
|
"multi: {sync_key: \"x y\"}", "multi: {sync_key: \"{\"}", "multi: {sync_key: e}"} {
|
||||||
|
if _, err := loadYAML(t, bad+"\n"); err == nil {
|
||||||
|
t.Errorf("%s accepted", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPreConnectLayeringAndNone(t *testing.T) {
|
||||||
|
cfg, err := loadYAML(t, `
|
||||||
|
netboxes:
|
||||||
|
- name: prod
|
||||||
|
url: https://prod.example.com
|
||||||
|
ssh:
|
||||||
|
pre_connect: vpn-up prod
|
||||||
|
- name: lab
|
||||||
|
url: https://lab.example.com
|
||||||
|
ssh:
|
||||||
|
pre_connect: check-vpn
|
||||||
|
rules:
|
||||||
|
- match: {tag: dmz}
|
||||||
|
pre_connect: none
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, tc := range []struct {
|
||||||
|
host SSHHost
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{SSHHost{Instance: "lab", Name: "web01"}, "check-vpn"},
|
||||||
|
{SSHHost{Instance: "prod", Name: "web01"}, "vpn-up prod"},
|
||||||
|
{SSHHost{Instance: "prod", Name: "gw", Tags: []string{"dmz"}}, ""},
|
||||||
|
} {
|
||||||
|
if got := cfg.SSHOptionsFor(tc.host).PreConnectCommand(); got != tc.want {
|
||||||
|
t.Errorf("%+v: got %q, want %q", tc.host, got, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := (SSHOptions{PreConnect: "a\x00b"}).Validate("ssh"); err == nil {
|
||||||
|
t.Error("NUL byte in pre_connect accepted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPreConnectFromEnvironment(t *testing.T) {
|
||||||
|
t.Setenv("NETSSH_SSH_PRE_CONNECT", "true")
|
||||||
|
t.Setenv("NETSSH_SHORTCUTS_SHOW", "true")
|
||||||
|
cfg, err := loadYAML(t, "")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if cfg.SSH.PreConnect != "true" || !cfg.Shortcuts.Show {
|
||||||
|
t.Fatalf("env not applied: pre_connect=%q show=%v", cfg.SSH.PreConnect, cfg.Shortcuts.Show)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -16,6 +16,7 @@ import (
|
|||||||
|
|
||||||
// AliasEntry holds a single shell alias mapping.
|
// AliasEntry holds a single shell alias mapping.
|
||||||
type AliasEntry struct {
|
type AliasEntry struct {
|
||||||
|
Command string // configured host command; empty means the default SSH alias
|
||||||
Name string // short alias name (e.g. "web01")
|
Name string // short alias name (e.g. "web01")
|
||||||
Host string // canonical NetBox hostname (e.g. "web01.example.com")
|
Host string // canonical NetBox hostname (e.g. "web01.example.com")
|
||||||
}
|
}
|
||||||
@@ -51,7 +52,7 @@ func WriteAliasFiles(entries []AliasEntry) error {
|
|||||||
writeFishAliasFile(entries) // best-effort — never blocks the caller on failure
|
writeFishAliasFile(entries) // best-effort — never blocks the caller on failure
|
||||||
alias := ""
|
alias := ""
|
||||||
for _, entry := range entries {
|
for _, entry := range entries {
|
||||||
if entry.Host == "" {
|
if entry.Host == "" && entry.Command == "" {
|
||||||
alias = entry.Name
|
alias = entry.Name
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
@@ -94,6 +95,9 @@ func writeFishAliasFile(entries []AliasEntry) {
|
|||||||
// Empty Host represents an alias for the netssh command itself.
|
// Empty Host represents an alias for the netssh command itself.
|
||||||
func (e AliasEntry) Definition(shell string) string {
|
func (e AliasEntry) Definition(shell string) string {
|
||||||
command := "netssh"
|
command := "netssh"
|
||||||
|
if e.Command != "" {
|
||||||
|
command += " run " + shellQuote(e.Command, shell) + " --"
|
||||||
|
}
|
||||||
if e.Host != "" {
|
if e.Host != "" {
|
||||||
host := e.Host
|
host := e.Host
|
||||||
if !regexp.MustCompile(`^[a-zA-Z0-9_.:-]+$`).MatchString(host) {
|
if !regexp.MustCompile(`^[a-zA-Z0-9_.:-]+$`).MatchString(host) {
|
||||||
@@ -124,14 +128,83 @@ func BuildAliasEntries(entries []cache.Entry, cfg config.Config) []AliasEntry {
|
|||||||
seen[cfg.Shell.Alias] = true
|
seen[cfg.Shell.Alias] = true
|
||||||
out = append(out, AliasEntry{Name: cfg.Shell.Alias})
|
out = append(out, AliasEntry{Name: cfg.Shell.Alias})
|
||||||
}
|
}
|
||||||
for _, e := range entries {
|
|
||||||
|
withoutPrefix := make(map[string]bool, len(cfg.NetBoxes))
|
||||||
|
for _, source := range cfg.NetBoxes {
|
||||||
|
withoutPrefix[strings.ToLower(source.Name)] = source.DisablePrefix
|
||||||
|
}
|
||||||
|
// Reserve canonical aliases as well as requested bare aliases before
|
||||||
|
// generating any output, so cache ordering cannot redirect a collision.
|
||||||
|
canonical := make(map[string]bool, len(entries))
|
||||||
|
counts := make(map[string]int, len(entries))
|
||||||
|
candidates := make([]string, len(entries))
|
||||||
|
for i, e := range entries {
|
||||||
name := shortcuts.AliasName(e.Name, cfg.Shortcuts)
|
name := shortcuts.AliasName(e.Name, cfg.Shortcuts)
|
||||||
if seen[name] || name == "" || !regexp.MustCompile(`^[a-zA-Z_][a-zA-Z0-9_-]*$`).MatchString(name) {
|
canonical[name] = true
|
||||||
|
source, host, qualified := strings.Cut(e.Name, "/")
|
||||||
|
if qualified && withoutPrefix[strings.ToLower(source)] {
|
||||||
|
name = shortcuts.AliasName(host, cfg.Shortcuts)
|
||||||
|
}
|
||||||
|
candidates[i] = name
|
||||||
|
counts[name]++
|
||||||
|
}
|
||||||
|
validAlias := regexp.MustCompile(`^[a-zA-Z_][a-zA-Z0-9_-]*$`)
|
||||||
|
for i, e := range entries {
|
||||||
|
name := candidates[i]
|
||||||
|
full := shortcuts.AliasName(e.Name, cfg.Shortcuts)
|
||||||
|
if name != full && (counts[name] > 1 || canonical[name] || seen[name] || !validAlias.MatchString(name)) {
|
||||||
|
name = full
|
||||||
|
}
|
||||||
|
if seen[name] || name == "" || !validAlias.MatchString(name) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
seen[name] = true
|
seen[name] = true
|
||||||
out = append(out, AliasEntry{Name: name, Host: e.Name})
|
out = append(out, AliasEntry{Name: name, Host: e.Name})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Build from the final SSH aliases, preserving per-instance prefix and
|
||||||
|
// collision handling. Never replace an existing SSH or command alias.
|
||||||
|
hostAliases := append([]AliasEntry(nil), out...)
|
||||||
|
hostMetadata := map[string]config.SSHHost{}
|
||||||
|
for _, e := range entries {
|
||||||
|
instance, hostname, ok := strings.Cut(e.Name, "/")
|
||||||
|
if !ok {
|
||||||
|
hostname = instance
|
||||||
|
instance = ""
|
||||||
|
}
|
||||||
|
hostMetadata[e.Name] = config.SSHHost{Instance: instance, Name: hostname, Kind: e.Kind, Tags: e.Tags}
|
||||||
|
}
|
||||||
|
var commands []string
|
||||||
|
for name := range cfg.Commands {
|
||||||
|
commands = append(commands, name)
|
||||||
|
}
|
||||||
|
sort.Strings(commands)
|
||||||
|
var candidatesForCommands []AliasEntry
|
||||||
|
commandCounts := make(map[string]int)
|
||||||
|
for _, name := range commands {
|
||||||
|
prefix := cfg.Commands[name].AliasPrefix
|
||||||
|
if prefix == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, host := range hostAliases {
|
||||||
|
if host.Host == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !cfg.Commands[name].Allowed(hostMetadata[host.Host]) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
alias := prefix + host.Name
|
||||||
|
commandCounts[alias]++
|
||||||
|
candidatesForCommands = append(candidatesForCommands, AliasEntry{Name: alias, Host: host.Host, Command: name})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, c := range candidatesForCommands {
|
||||||
|
if seen[c.Name] || commandCounts[c.Name] != 1 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
seen[c.Name] = true
|
||||||
|
out = append(out, c)
|
||||||
|
}
|
||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ package hook_test
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"os"
|
"os"
|
||||||
|
"os/exec"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
@@ -242,3 +243,176 @@ func TestAliasesIncludeInstanceName(t *testing.T) {
|
|||||||
t.Fatalf("alias lost source: %+v", entries)
|
t.Fatalf("alias lost source: %+v", entries)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestAliasesUseRewriteRules(t *testing.T) {
|
||||||
|
cfg := config.Config{Shortcuts: config.ShortcutsConfig{
|
||||||
|
Domains: []string{".hoster.de"},
|
||||||
|
Rewrites: []config.ShortcutRewrite{{Pattern: `^([a-z]+)[0-9]+-`, Replace: "$1"}},
|
||||||
|
}}
|
||||||
|
entries := hook.BuildAliasEntries([]cache.Entry{{Name: "fsn1-bx1.hoster.de"}}, cfg)
|
||||||
|
if len(entries) != 1 || entries[0].Definition("bash") != "alias fsnbx1='netssh fsn1-bx1.hoster.de'" {
|
||||||
|
t.Fatalf("entries: %+v", entries)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAliasesOptionalInstancePrefix(t *testing.T) {
|
||||||
|
cfg := config.Config{
|
||||||
|
NetBoxes: []config.NetBoxConfig{
|
||||||
|
{Name: "OFFICE", DisablePrefix: true},
|
||||||
|
{Name: "lab"},
|
||||||
|
},
|
||||||
|
Shortcuts: config.ShortcutsConfig{
|
||||||
|
Domains: []string{".example.com"},
|
||||||
|
Rewrites: []config.ShortcutRewrite{{Pattern: "^web-", Replace: "app"}},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
entries := hook.BuildAliasEntries([]cache.Entry{
|
||||||
|
{Name: "office/web-01.example.com"},
|
||||||
|
{Name: "lab/web-01.example.com"},
|
||||||
|
}, cfg)
|
||||||
|
got := map[string]string{}
|
||||||
|
for _, e := range entries {
|
||||||
|
got[e.Name] = e.Host
|
||||||
|
// Both output formats must keep the fully qualified destination.
|
||||||
|
for _, shell := range []string{"bash", "zsh", "fish"} {
|
||||||
|
if !strings.Contains(e.Definition(shell), e.Host) {
|
||||||
|
t.Fatalf("%s alias lost its target: %s", shell, e.Definition(shell))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(got) != 2 || got["app01"] != "office/web-01.example.com" || got["lab_app01"] != "lab/web-01.example.com" {
|
||||||
|
t.Fatalf("unexpected aliases: %+v", entries)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAliasesWithoutPrefixCollisions(t *testing.T) {
|
||||||
|
cfg := config.Config{
|
||||||
|
NetBoxes: []config.NetBoxConfig{
|
||||||
|
{Name: "office", DisablePrefix: true},
|
||||||
|
{Name: "lab", DisablePrefix: true},
|
||||||
|
},
|
||||||
|
Shell: config.ShellConfig{Alias: "j"},
|
||||||
|
Shortcuts: config.ShortcutsConfig{Domains: []string{".example.com"}},
|
||||||
|
}
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
hosts []string
|
||||||
|
want map[string]string
|
||||||
|
}{
|
||||||
|
{"two instances", []string{"office/web.example.com", "lab/web.example.com"},
|
||||||
|
map[string]string{"j": "", "office_web": "office/web.example.com", "lab_web": "lab/web.example.com"}},
|
||||||
|
{"static host", []string{"office/web.example.com", "web"},
|
||||||
|
map[string]string{"j": "", "office_web": "office/web.example.com", "web": "web"}},
|
||||||
|
{"command aliases", []string{"office/j", "office/netssh"},
|
||||||
|
map[string]string{"j": "", "office_j": "office/j", "office_netssh": "office/netssh"}},
|
||||||
|
{"reserved qualified alias", []string{"office/lab_web", "lab/web"},
|
||||||
|
map[string]string{"j": "", "office_lab_web": "office/lab_web", "web": "lab/web"}},
|
||||||
|
{"invalid bare alias", []string{"office/123.example.com"},
|
||||||
|
map[string]string{"j": "", "office_123": "office/123.example.com"}},
|
||||||
|
{"normalized names", []string{"office/web.example.com", "office/web"},
|
||||||
|
map[string]string{"j": "", "office_web": "office/web"}},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
var input []cache.Entry
|
||||||
|
for _, host := range tc.hosts {
|
||||||
|
input = append(input, cache.Entry{Name: host})
|
||||||
|
}
|
||||||
|
entries := hook.BuildAliasEntries(input, cfg)
|
||||||
|
if len(entries) != len(tc.want) {
|
||||||
|
t.Fatalf("aliases: %+v, want %+v", entries, tc.want)
|
||||||
|
}
|
||||||
|
for _, e := range entries {
|
||||||
|
if host, ok := tc.want[e.Name]; !ok || host != e.Host {
|
||||||
|
t.Fatalf("unexpected alias: %+v", e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCustomCommandAliases(t *testing.T) {
|
||||||
|
cfg := config.Config{
|
||||||
|
NetBoxes: []config.NetBoxConfig{{Name: "office", DisablePrefix: true}},
|
||||||
|
Shortcuts: config.ShortcutsConfig{Rewrites: []config.ShortcutRewrite{{Pattern: "^xzi-groß", Replace: "xg"}}},
|
||||||
|
Commands: map[string]config.HostCommand{
|
||||||
|
"mtr": {AliasPrefix: "m", Args: []string{"mtr", "{address}"}},
|
||||||
|
"ping": {AliasPrefix: "p", Args: []string{"ping", "{address}"}},
|
||||||
|
"manual": {Args: []string{"echo", "{host}"}},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
entries := hook.BuildAliasEntries([]cache.Entry{{Name: "office/xzi-groß1", IP: "10.0.0.1"}}, cfg)
|
||||||
|
got := map[string]hook.AliasEntry{}
|
||||||
|
for _, e := range entries {
|
||||||
|
got[e.Name] = e
|
||||||
|
}
|
||||||
|
if len(entries) != 3 || got["mxg1"].Command != "mtr" || got["pxg1"].Command != "ping" {
|
||||||
|
t.Fatalf("unexpected aliases: %+v", entries)
|
||||||
|
}
|
||||||
|
if got["mxg1"].Host != "office/xzi-groß1" {
|
||||||
|
t.Fatal("instance lost")
|
||||||
|
}
|
||||||
|
for _, shell := range []string{"bash", "zsh", "fish"} {
|
||||||
|
def := got["mxg1"].Definition(shell)
|
||||||
|
if !strings.Contains(def, "netssh run") || !strings.Contains(def, "office/xzi-groß1") || strings.Contains(def, "10.0.0.1") {
|
||||||
|
t.Fatalf("%s alias must resolve at invocation: %s", shell, def)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCustomCommandAliasesPreserveExistingNames(t *testing.T) {
|
||||||
|
cfg := config.Config{
|
||||||
|
Shell: config.ShellConfig{Alias: "mfoo"},
|
||||||
|
Commands: map[string]config.HostCommand{
|
||||||
|
"mtr": {AliasPrefix: "m", Args: []string{"mtr", "{address}"}},
|
||||||
|
"ping": {AliasPrefix: "mp", Args: []string{"ping", "{address}"}},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
entries := hook.BuildAliasEntries([]cache.Entry{
|
||||||
|
{Name: "foo"}, {Name: "web"}, {Name: "mweb"}, {Name: "x"}, {Name: "px"},
|
||||||
|
}, cfg)
|
||||||
|
for _, e := range entries {
|
||||||
|
if e.Name == "mfoo" && (e.Host != "" || e.Command != "") {
|
||||||
|
t.Fatal("command alias overwritten")
|
||||||
|
}
|
||||||
|
if e.Name == "mweb" && (e.Host != "mweb" || e.Command != "") {
|
||||||
|
t.Fatal("SSH alias overwritten")
|
||||||
|
}
|
||||||
|
if e.Name == "mpx" {
|
||||||
|
t.Fatal("ambiguous custom alias generated")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCustomAliasShellArgumentQuoting(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
if err := os.WriteFile(filepath.Join(dir, "netssh"), []byte("#!/bin/sh\nprintf '%s\\n' \"$@\"\n"), 0700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Setenv("PATH", dir+string(os.PathListSeparator)+os.Getenv("PATH"))
|
||||||
|
entry := hook.AliasEntry{Name: "mxg1", Host: "office/xzi-groß1'$(oops)", Command: "mtr"}
|
||||||
|
for _, shell := range []string{"bash", "zsh", "fish"} {
|
||||||
|
t.Run(shell, func(t *testing.T) {
|
||||||
|
path, err := exec.LookPath(shell)
|
||||||
|
if err != nil {
|
||||||
|
t.Skip("shell not installed")
|
||||||
|
}
|
||||||
|
// A separate parse models invoking an alias after sourcing the file.
|
||||||
|
script := entry.Definition(shell) + "\neval 'mxg1 --report'\n"
|
||||||
|
args := []string{"-c", script}
|
||||||
|
if shell == "bash" {
|
||||||
|
args = []string{"--noprofile", "--norc", "-O", "expand_aliases", "-c", script}
|
||||||
|
}
|
||||||
|
if shell == "zsh" {
|
||||||
|
args = []string{"-f", "-c", script}
|
||||||
|
}
|
||||||
|
if shell == "fish" {
|
||||||
|
args = []string{"--no-config", "-c", script}
|
||||||
|
}
|
||||||
|
out, err := exec.Command(path, args...).CombinedOutput()
|
||||||
|
want := "run\nmtr\n--\n" + entry.Host + "\n--report\n"
|
||||||
|
if err != nil || string(out) != want {
|
||||||
|
t.Fatalf("%q (%v), want %q", out, err, want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,251 @@
|
|||||||
|
// Package multiplex opens several commands side by side in tmux or zellij.
|
||||||
|
package multiplex
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"strings"
|
||||||
|
"syscall"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Pane is one command shown in its own pane.
|
||||||
|
type Pane struct {
|
||||||
|
Title string
|
||||||
|
Argv []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Options control how panes are laid out.
|
||||||
|
type Options struct {
|
||||||
|
Label string // window, session, and tab name
|
||||||
|
Sync bool // type into all panes of a window at once
|
||||||
|
PerWindow int // panes per tmux window or zellij tab
|
||||||
|
LayoutDir string // where zellij layout files and tmux key bindings are written
|
||||||
|
// SyncKey and SoloKey are tmux prefix keys that toggle broadcast for the
|
||||||
|
// window and exclude the current pane from it; empty means no binding.
|
||||||
|
SyncKey, SoloKey string
|
||||||
|
// Hint receives notes for the user before the process is replaced.
|
||||||
|
Hint func(string)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Runner executes multiplexer commands; tests and --dry-run replace it.
|
||||||
|
type Runner interface {
|
||||||
|
// Output runs argv and returns its trimmed standard output.
|
||||||
|
Output(argv ...string) (string, error)
|
||||||
|
// Exec replaces the current process with argv.
|
||||||
|
Exec(argv ...string) error
|
||||||
|
LookPath(name string) (string, error)
|
||||||
|
Getenv(key string) string
|
||||||
|
WriteFile(path string, data []byte) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// Supported multiplexers.
|
||||||
|
const (
|
||||||
|
Tmux = "tmux"
|
||||||
|
Zellij = "zellij"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrNone means neither tmux nor zellij is available.
|
||||||
|
var ErrNone = errors.New("netssh multi needs tmux or zellij; install one of them (e.g. apt install tmux)")
|
||||||
|
|
||||||
|
// Detect picks the multiplexer: the requested one, else the one netssh runs
|
||||||
|
// in, else tmux, else zellij.
|
||||||
|
func Detect(requested string, r Runner) (string, error) {
|
||||||
|
switch requested {
|
||||||
|
case Tmux, Zellij:
|
||||||
|
if _, err := r.LookPath(requested); err != nil {
|
||||||
|
return "", fmt.Errorf("%s is not installed", requested)
|
||||||
|
}
|
||||||
|
return requested, nil
|
||||||
|
case "", "auto":
|
||||||
|
default:
|
||||||
|
return "", fmt.Errorf("unknown multiplexer %q", requested)
|
||||||
|
}
|
||||||
|
if r.Getenv("TMUX") != "" {
|
||||||
|
return Tmux, nil
|
||||||
|
}
|
||||||
|
if r.Getenv("ZELLIJ") != "" {
|
||||||
|
return Zellij, nil
|
||||||
|
}
|
||||||
|
for _, name := range []string{Tmux, Zellij} {
|
||||||
|
if _, err := r.LookPath(name); err == nil {
|
||||||
|
return name, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "", ErrNone
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open shows panes in the multiplexer. Outside of it, Open replaces the
|
||||||
|
// process with the multiplexer client and only returns on error.
|
||||||
|
func Open(kind string, panes []Pane, opts Options, r Runner) error {
|
||||||
|
if len(panes) == 0 {
|
||||||
|
return errors.New("no hosts to open")
|
||||||
|
}
|
||||||
|
if opts.Hint == nil {
|
||||||
|
opts.Hint = func(string) {}
|
||||||
|
}
|
||||||
|
if opts.PerWindow <= 0 {
|
||||||
|
opts.PerWindow = 9
|
||||||
|
}
|
||||||
|
if opts.Label == "" {
|
||||||
|
opts.Label = "netssh"
|
||||||
|
}
|
||||||
|
switch kind {
|
||||||
|
case Tmux:
|
||||||
|
return openTmux(panes, opts, r)
|
||||||
|
case Zellij:
|
||||||
|
return openZellij(panes, opts, r)
|
||||||
|
}
|
||||||
|
return fmt.Errorf("unknown multiplexer %q", kind)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ToggleSync switches broadcast input in the current tmux window or zellij
|
||||||
|
// tab; with pane it excludes the current tmux pane from it or includes it again.
|
||||||
|
func ToggleSync(r Runner, pane bool) (string, error) {
|
||||||
|
if pane {
|
||||||
|
if r.Getenv("TMUX") == "" {
|
||||||
|
if r.Getenv("ZELLIJ") != "" {
|
||||||
|
return "", errors.New("zellij broadcasts to a whole tab; single panes cannot be excluded")
|
||||||
|
}
|
||||||
|
return "", errors.New("netssh sync --pane works inside tmux")
|
||||||
|
}
|
||||||
|
solo, err := r.Output("tmux", "display-message", "-p", "#{@netssh_solo}")
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
for _, argv := range soloToggle(solo == "1") {
|
||||||
|
if _, err := r.Output(argv...); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if solo == "1" {
|
||||||
|
return "pane included in broadcast", nil
|
||||||
|
}
|
||||||
|
return "pane excluded from broadcast", nil
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case r.Getenv("TMUX") != "":
|
||||||
|
current, err := r.Output("tmux", "show-window-options", "-v", "synchronize-panes")
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
next := "on"
|
||||||
|
if current == "on" {
|
||||||
|
next = "off"
|
||||||
|
}
|
||||||
|
if _, err := r.Output("tmux", "set-window-option", "synchronize-panes", next); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return "broadcast " + next, nil
|
||||||
|
case r.Getenv("ZELLIJ") != "":
|
||||||
|
if _, err := r.Output("zellij", "action", "toggle-active-sync-tab"); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return "broadcast toggled", nil
|
||||||
|
}
|
||||||
|
return "", errors.New("netssh sync works inside tmux or zellij")
|
||||||
|
}
|
||||||
|
|
||||||
|
// chunks splits panes into groups of at most n.
|
||||||
|
func chunks(panes []Pane, n int) [][]Pane {
|
||||||
|
var out [][]Pane
|
||||||
|
for len(panes) > n {
|
||||||
|
out = append(out, panes[:n])
|
||||||
|
panes = panes[n:]
|
||||||
|
}
|
||||||
|
return append(out, panes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// windowLabel numbers windows when the panes need more than one.
|
||||||
|
func windowLabel(label string, i, total int) string {
|
||||||
|
if total == 1 {
|
||||||
|
return label
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("%s-%d", label, i+1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// System runs real commands.
|
||||||
|
type System struct{}
|
||||||
|
|
||||||
|
func (System) Output(argv ...string) (string, error) {
|
||||||
|
cmd := exec.Command(argv[0], argv[1:]...)
|
||||||
|
var stderr strings.Builder
|
||||||
|
cmd.Stderr = &stderr
|
||||||
|
out, err := cmd.Output()
|
||||||
|
if err != nil {
|
||||||
|
if msg := strings.TrimSpace(stderr.String()); msg != "" {
|
||||||
|
return "", fmt.Errorf("%s: %s", argv[0], msg)
|
||||||
|
}
|
||||||
|
return "", fmt.Errorf("%s: %w", argv[0], err)
|
||||||
|
}
|
||||||
|
return strings.TrimSpace(string(out)), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (System) Exec(argv ...string) error {
|
||||||
|
path, err := exec.LookPath(argv[0])
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return syscall.Exec(path, argv, os.Environ())
|
||||||
|
}
|
||||||
|
|
||||||
|
func (System) LookPath(name string) (string, error) { return exec.LookPath(name) }
|
||||||
|
func (System) Getenv(key string) string { return os.Getenv(key) }
|
||||||
|
func (System) WriteFile(path string, data []byte) error {
|
||||||
|
return os.WriteFile(path, data, 0o600)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DryRun prints commands instead of running them; Output returns fake IDs.
|
||||||
|
type DryRun struct {
|
||||||
|
W io.Writer
|
||||||
|
Env map[string]string // values for Getenv, e.g. TMUX
|
||||||
|
n int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *DryRun) Output(argv ...string) (string, error) {
|
||||||
|
fmt.Fprintln(d.W, shellJoin(argv))
|
||||||
|
d.n++
|
||||||
|
switch {
|
||||||
|
case len(argv) > 1 && (argv[1] == "new-window" || argv[1] == "new-session"):
|
||||||
|
return fmt.Sprintf("@%d %%%d", d.n, d.n), nil
|
||||||
|
case len(argv) > 1 && argv[1] == "split-window":
|
||||||
|
return fmt.Sprintf("%%%d", d.n), nil
|
||||||
|
case len(argv) > 1 && argv[1] == "has-session":
|
||||||
|
return "", errors.New("no session")
|
||||||
|
}
|
||||||
|
return "", nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *DryRun) Exec(argv ...string) error {
|
||||||
|
fmt.Fprintln(d.W, shellJoin(argv))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// LookPath pretends every multiplexer is installed, so --dry-run shows the
|
||||||
|
// commands on machines without tmux or zellij.
|
||||||
|
func (d *DryRun) LookPath(name string) (string, error) { return name, nil }
|
||||||
|
func (d *DryRun) Getenv(key string) string {
|
||||||
|
if v, ok := d.Env[key]; ok {
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
return os.Getenv(key)
|
||||||
|
}
|
||||||
|
func (d *DryRun) WriteFile(path string, data []byte) error {
|
||||||
|
fmt.Fprintf(d.W, "# %s\n%s", path, data)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// shellJoin quotes argv for display.
|
||||||
|
func shellJoin(argv []string) string {
|
||||||
|
quoted := make([]string, len(argv))
|
||||||
|
for i, arg := range argv {
|
||||||
|
if arg != "" && strings.Trim(arg, "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789@%+=:,./_-") == "" {
|
||||||
|
quoted[i] = arg
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
quoted[i] = "'" + strings.ReplaceAll(arg, "'", `'\''`) + "'"
|
||||||
|
}
|
||||||
|
return strings.Join(quoted, " ")
|
||||||
|
}
|
||||||
@@ -0,0 +1,317 @@
|
|||||||
|
package multiplex
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fake records commands and answers like tmux and zellij would.
|
||||||
|
type fake struct {
|
||||||
|
env map[string]string
|
||||||
|
installed map[string]bool
|
||||||
|
sessions map[string]bool
|
||||||
|
calls []string
|
||||||
|
exec []string
|
||||||
|
files map[string]string
|
||||||
|
syncState string
|
||||||
|
keys map[string]string // existing prefix bindings by key
|
||||||
|
solo string
|
||||||
|
prefix string
|
||||||
|
n int
|
||||||
|
}
|
||||||
|
|
||||||
|
func newFake(env map[string]string, installed ...string) *fake {
|
||||||
|
f := &fake{env: env, installed: map[string]bool{}, sessions: map[string]bool{}, files: map[string]string{}, syncState: "off"}
|
||||||
|
for _, name := range installed {
|
||||||
|
f.installed[name] = true
|
||||||
|
}
|
||||||
|
return f
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fake) Output(argv ...string) (string, error) {
|
||||||
|
f.calls = append(f.calls, strings.Join(argv, " "))
|
||||||
|
f.n++
|
||||||
|
switch argv[1] {
|
||||||
|
case "show-options":
|
||||||
|
return f.prefix, nil
|
||||||
|
case "new-window", "new-session":
|
||||||
|
return fmt.Sprintf("@%d %%%d", f.n, f.n), nil
|
||||||
|
case "split-window":
|
||||||
|
return fmt.Sprintf("%%%d", f.n), nil
|
||||||
|
case "has-session":
|
||||||
|
if f.sessions[strings.TrimPrefix(argv[3], "=")] {
|
||||||
|
return "", nil
|
||||||
|
}
|
||||||
|
return "", errors.New("can't find session")
|
||||||
|
case "show-window-options":
|
||||||
|
return f.syncState, nil
|
||||||
|
case "list-keys":
|
||||||
|
return f.keys[argv[4]], nil
|
||||||
|
case "display-message":
|
||||||
|
return f.solo, nil
|
||||||
|
}
|
||||||
|
return "", nil
|
||||||
|
}
|
||||||
|
func (f *fake) Exec(argv ...string) error { f.exec = argv; return nil }
|
||||||
|
func (f *fake) LookPath(name string) (string, error) {
|
||||||
|
if f.installed[name] {
|
||||||
|
return "/usr/bin/" + name, nil
|
||||||
|
}
|
||||||
|
return "", errors.New("not found")
|
||||||
|
}
|
||||||
|
func (f *fake) Getenv(key string) string { return f.env[key] }
|
||||||
|
func (f *fake) WriteFile(path string, data []byte) error {
|
||||||
|
f.files[path] = string(data)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func panes(names ...string) []Pane {
|
||||||
|
out := make([]Pane, 0, len(names))
|
||||||
|
for _, name := range names {
|
||||||
|
out = append(out, Pane{Title: name, Argv: []string{"/usr/bin/netssh", name}})
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDetect(t *testing.T) {
|
||||||
|
for _, tc := range []struct {
|
||||||
|
requested string
|
||||||
|
env map[string]string
|
||||||
|
installed []string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{"", map[string]string{"TMUX": "/tmp/tmux"}, []string{"tmux", "zellij"}, Tmux},
|
||||||
|
{"auto", map[string]string{"ZELLIJ": "0"}, []string{"tmux", "zellij"}, Zellij},
|
||||||
|
{"", nil, []string{"tmux", "zellij"}, Tmux},
|
||||||
|
{"", nil, []string{"zellij"}, Zellij},
|
||||||
|
{"zellij", map[string]string{"TMUX": "x"}, []string{"tmux", "zellij"}, Zellij},
|
||||||
|
} {
|
||||||
|
got, err := Detect(tc.requested, newFake(tc.env, tc.installed...))
|
||||||
|
if err != nil || got != tc.want {
|
||||||
|
t.Errorf("%+v: got %q %v", tc, got, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := Detect("", newFake(nil)); !errors.Is(err, ErrNone) {
|
||||||
|
t.Errorf("nothing installed: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := Detect("tmux", newFake(nil, "zellij")); err == nil {
|
||||||
|
t.Error("missing requested multiplexer accepted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTmuxInside(t *testing.T) {
|
||||||
|
f := newFake(map[string]string{"TMUX": "/tmp/tmux-1/default"}, "tmux")
|
||||||
|
if err := Open(Tmux, panes("a", "b", "c"), Options{Label: "pve", Sync: true, SyncKey: "S", SoloKey: "e", LayoutDir: "/tmp/l"}, f); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
script := "sh -c " + paneScript + " netssh-pane /usr/bin/netssh "
|
||||||
|
want := []string{
|
||||||
|
"tmux new-window -P -F #{window_id} #{pane_id} -n pve " + script + "a",
|
||||||
|
"tmux split-window -t @1 -P -F #{pane_id} " + script + "b",
|
||||||
|
"tmux select-layout -t @1 tiled",
|
||||||
|
"tmux split-window -t @1 -P -F #{pane_id} " + script + "c",
|
||||||
|
"tmux select-layout -t @1 tiled",
|
||||||
|
"tmux set-option -p -t %1 @netssh_host a",
|
||||||
|
"tmux set-option -p -t %2 @netssh_host b",
|
||||||
|
"tmux set-option -p -t %4 @netssh_host c",
|
||||||
|
"tmux set-window-option -t @1 @netssh 1",
|
||||||
|
"tmux set-window-option -t @1 pane-border-status top",
|
||||||
|
"tmux set-window-option -t @1 pane-border-format #{@netssh_host}#{?pane_synchronized, [SYNC],#{?@netssh_solo, [SOLO],}} ",
|
||||||
|
"tmux set-window-option -t @1 synchronize-panes on",
|
||||||
|
"tmux show-options -gv prefix",
|
||||||
|
"tmux list-keys -T prefix S",
|
||||||
|
"tmux list-keys -T prefix e",
|
||||||
|
"tmux source-file /tmp/l/netssh-multi.tmux.conf",
|
||||||
|
"tmux set-window-option -t @1 @netssh_keys keys: Ctrl+b then S: sync on/off | Ctrl+b then e: solo on/off",
|
||||||
|
"tmux set-window-option -t @1 pane-border-format #{@netssh_host}#{?pane_synchronized, [SYNC],#{?@netssh_solo, [SOLO],}} #{?pane_active, | #{@netssh_keys},} ",
|
||||||
|
"tmux select-window -t @1",
|
||||||
|
}
|
||||||
|
if strings.Join(f.calls, "\n") != strings.Join(want, "\n") {
|
||||||
|
t.Fatalf("calls:\n%s\nwant:\n%s", strings.Join(f.calls, "\n"), strings.Join(want, "\n"))
|
||||||
|
}
|
||||||
|
if f.exec != nil {
|
||||||
|
t.Fatal("inside tmux must not attach")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTmuxOutsideSplitsWindowsAndAvoidsSessionNames(t *testing.T) {
|
||||||
|
f := newFake(nil, "tmux")
|
||||||
|
f.sessions["netssh-pve"] = true
|
||||||
|
var hints []string
|
||||||
|
err := Open(Tmux, panes("a", "b", "c"), Options{Label: "pve", PerWindow: 2, Hint: func(s string) { hints = append(hints, s) }}, f)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
joined := strings.Join(f.calls, "\n")
|
||||||
|
for _, want := range []string{
|
||||||
|
"tmux has-session -t =netssh-pve-2",
|
||||||
|
"tmux new-session -d -x 240 -y 70 -s netssh-pve-2 -P -F #{window_id} #{pane_id} -n pve-1 ",
|
||||||
|
"tmux new-window -t netssh-pve-2: -P -F #{window_id} #{pane_id} -n pve-2 ",
|
||||||
|
"tmux set-option -t netssh-pve-2 status-left-length 40",
|
||||||
|
} {
|
||||||
|
if !strings.Contains(joined, want) {
|
||||||
|
t.Errorf("missing %q in\n%s", want, joined)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if strings.Contains(joined, "synchronize-panes") {
|
||||||
|
t.Error("sync set without --sync")
|
||||||
|
}
|
||||||
|
if strings.Join(f.exec, " ") != "tmux attach-session -t netssh-pve-2" || len(hints) != 1 {
|
||||||
|
t.Fatalf("exec %v hints %v", f.exec, hints)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestZellijOutsideWritesGridLayout(t *testing.T) {
|
||||||
|
f := newFake(nil, "zellij")
|
||||||
|
if err := Open(Zellij, panes("a", "b", "c", `q"x`), Options{Label: "pve", LayoutDir: "/tmp/l"}, f); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
layout := f.files["/tmp/l/netssh-multi.kdl"]
|
||||||
|
for _, want := range []string{
|
||||||
|
`plugin location="zellij:tab-bar"`,
|
||||||
|
`tab name="pve" focus=true {`,
|
||||||
|
`pane split_direction="vertical" {`,
|
||||||
|
`pane name="a" command="/usr/bin/netssh" {`,
|
||||||
|
`args "a"`,
|
||||||
|
`pane name="q\"x" command="/usr/bin/netssh" {`,
|
||||||
|
} {
|
||||||
|
if !strings.Contains(layout, want) {
|
||||||
|
t.Errorf("layout lacks %q:\n%s", want, layout)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// 4 panes → 2 columns × 2 rows.
|
||||||
|
if n := strings.Count(layout, `split_direction="vertical"`); n != 2 {
|
||||||
|
t.Errorf("%d rows, want 2:\n%s", n, layout)
|
||||||
|
}
|
||||||
|
if strings.Join(f.exec, " ") != "zellij --layout /tmp/l/netssh-multi.kdl" {
|
||||||
|
t.Fatalf("exec %v", f.exec)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestZellijInsideAddsTabs(t *testing.T) {
|
||||||
|
f := newFake(map[string]string{"ZELLIJ": "0"}, "zellij")
|
||||||
|
if err := Open(Zellij, panes("a", "b", "c"), Options{Label: "pve", PerWindow: 2, Sync: true, LayoutDir: "/tmp/l"}, f); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := []string{
|
||||||
|
"zellij action new-tab --layout /tmp/l/netssh-multi-1.kdl",
|
||||||
|
"zellij action toggle-active-sync-tab",
|
||||||
|
"zellij action new-tab --layout /tmp/l/netssh-multi-2.kdl",
|
||||||
|
"zellij action toggle-active-sync-tab",
|
||||||
|
}
|
||||||
|
if strings.Join(f.calls, "\n") != strings.Join(want, "\n") {
|
||||||
|
t.Fatalf("calls:\n%s", strings.Join(f.calls, "\n"))
|
||||||
|
}
|
||||||
|
if !strings.Contains(f.files["/tmp/l/netssh-multi-2.kdl"], `tab name="pve-2"`) {
|
||||||
|
t.Fatalf("second tab: %s", f.files["/tmp/l/netssh-multi-2.kdl"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestToggleSync(t *testing.T) {
|
||||||
|
f := newFake(map[string]string{"TMUX": "x"})
|
||||||
|
if state, err := ToggleSync(f, false); err != nil || state != "broadcast on" || f.calls[1] != "tmux set-window-option synchronize-panes on" {
|
||||||
|
t.Fatalf("%q %v %v", state, err, f.calls)
|
||||||
|
}
|
||||||
|
f.syncState = "on"
|
||||||
|
if state, _ := ToggleSync(f, false); state != "broadcast off" {
|
||||||
|
t.Fatalf("%q", state)
|
||||||
|
}
|
||||||
|
z := newFake(map[string]string{"ZELLIJ": "0"})
|
||||||
|
if _, err := ToggleSync(z, false); err != nil || z.calls[0] != "zellij action toggle-active-sync-tab" {
|
||||||
|
t.Fatalf("%v %v", err, z.calls)
|
||||||
|
}
|
||||||
|
if _, err := ToggleSync(newFake(nil), false); err == nil {
|
||||||
|
t.Fatal("outside a multiplexer accepted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTmuxKeyBindings(t *testing.T) {
|
||||||
|
f := newFake(map[string]string{"TMUX": "x"}, "tmux")
|
||||||
|
var hint string
|
||||||
|
if err := Open(Tmux, panes("a"), Options{SyncKey: "S", SoloKey: "e", LayoutDir: "/tmp/l", Hint: func(s string) { hint = s }}, f); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
conf := f.files["/tmp/l/netssh-multi.tmux.conf"]
|
||||||
|
for _, want := range []string{"bind-key -T prefix S if-shell -F '#{@netssh}'", "bind-key -T prefix e if-shell", "set-option -p synchronize-panes off"} {
|
||||||
|
if !strings.Contains(conf, want) {
|
||||||
|
t.Errorf("conf lacks %q:\n%s", want, conf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if hint != "keys: Ctrl+b then S: sync on/off | Ctrl+b then e: solo on/off" {
|
||||||
|
t.Errorf("hint %q", hint)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A key bound in the user's tmux.conf is left alone; netssh's own is replaced.
|
||||||
|
f = newFake(map[string]string{"TMUX": "x"}, "tmux")
|
||||||
|
f.keys = map[string]string{"S": "bind-key -T prefix S kill-server", "e": "bind-key -T prefix e if-shell -F #{@netssh} …"}
|
||||||
|
if err := Open(Tmux, panes("a"), Options{SyncKey: "S", SoloKey: "e", LayoutDir: "/tmp/l", Hint: func(s string) { hint = s }}, f); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
conf = f.files["/tmp/l/netssh-multi.tmux.conf"]
|
||||||
|
if strings.Contains(conf, "prefix S ") || !strings.Contains(conf, "prefix e ") {
|
||||||
|
t.Errorf("user binding overwritten or own binding not refreshed:\n%s", conf)
|
||||||
|
}
|
||||||
|
if !strings.Contains(hint, "C-b S kept your own binding") {
|
||||||
|
t.Errorf("hint %q", hint)
|
||||||
|
}
|
||||||
|
|
||||||
|
// No keys configured: nothing is bound.
|
||||||
|
f = newFake(map[string]string{"TMUX": "x"}, "tmux")
|
||||||
|
if err := Open(Tmux, panes("a"), Options{LayoutDir: "/tmp/l"}, f); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if len(f.files) != 0 || strings.Contains(strings.Join(f.calls, "\n"), "source-file") {
|
||||||
|
t.Errorf("bound keys although disabled: %v", f.calls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestToggleSyncPane(t *testing.T) {
|
||||||
|
f := newFake(map[string]string{"TMUX": "x"})
|
||||||
|
if state, err := ToggleSync(f, true); err != nil || state != "pane excluded from broadcast" {
|
||||||
|
t.Fatalf("%q %v", state, err)
|
||||||
|
}
|
||||||
|
if got := strings.Join(f.calls[1:], "; "); got != "tmux set-option -p synchronize-panes off; tmux set-option -p @netssh_solo 1" {
|
||||||
|
t.Fatalf("exclude: %s", got)
|
||||||
|
}
|
||||||
|
f = newFake(map[string]string{"TMUX": "x"})
|
||||||
|
f.solo = "1"
|
||||||
|
if state, _ := ToggleSync(f, true); state != "pane included in broadcast" || f.calls[1] != "tmux set-option -pu synchronize-panes" {
|
||||||
|
t.Fatalf("include: %q %v", state, f.calls)
|
||||||
|
}
|
||||||
|
if _, err := ToggleSync(newFake(map[string]string{"ZELLIJ": "0"}), true); err == nil || !strings.Contains(err.Error(), "whole tab") {
|
||||||
|
t.Fatalf("zellij: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTmuxPersistentHints(t *testing.T) {
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
keys map[string]string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{"custom prefix", nil, "keys: Ctrl+a then Ctrl+s: sync on/off | Ctrl+a then e: solo on/off"},
|
||||||
|
{"occupied key", map[string]string{"C-s": "bind-key -T prefix C-s display-time"}, "keys: Ctrl+a then e: solo on/off; C-a C-s kept your own binding (use netssh sync)"},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
f := newFake(nil, "tmux")
|
||||||
|
f.prefix, f.keys = "C-a", tc.keys
|
||||||
|
if err := Open(Tmux, panes("a", "b"), Options{PerWindow: 1, SyncKey: "C-s", SoloKey: "e"}, f); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
n := 0
|
||||||
|
for _, call := range f.calls {
|
||||||
|
if strings.Contains(call, " @netssh_keys ") {
|
||||||
|
n++
|
||||||
|
if !strings.HasSuffix(call, " @netssh_keys "+tc.want) {
|
||||||
|
t.Fatalf("wrong persistent hint: %s", call)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if n != 2 {
|
||||||
|
t.Fatalf("hints installed in %d windows, want 2", n)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,213 @@
|
|||||||
|
package multiplex
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"path/filepath"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// paneScript runs the pane's command and keeps a failed one on screen, so an
|
||||||
|
// unreachable host shows its error instead of the pane vanishing.
|
||||||
|
const paneScript = `"$@"; status=$?; if [ "$status" -ne 0 ]; then echo; echo "netssh exited with status $status, press Enter to close"; read -r _; fi`
|
||||||
|
|
||||||
|
// tmuxArgv runs the pane through sh with argv as arguments: no quoting, and
|
||||||
|
// independent of the user's default-shell (which may be fish).
|
||||||
|
func tmuxArgv(p Pane) []string {
|
||||||
|
return append([]string{"sh", "-c", paneScript, "netssh-pane"}, p.Argv...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// openTmux adds a window per chunk of panes: to the current session inside
|
||||||
|
// tmux, else to a new detached session that is attached at the end.
|
||||||
|
func openTmux(panes []Pane, opts Options, r Runner) error {
|
||||||
|
inside := r.Getenv("TMUX") != ""
|
||||||
|
session := ""
|
||||||
|
if !inside {
|
||||||
|
session = freeSession(r, "netssh-"+opts.Label)
|
||||||
|
}
|
||||||
|
groups := chunks(panes, opts.PerWindow)
|
||||||
|
first := ""
|
||||||
|
var windows []string
|
||||||
|
for i, group := range groups {
|
||||||
|
name := windowLabel(opts.Label, i, len(groups))
|
||||||
|
format := []string{"-P", "-F", "#{window_id} #{pane_id}", "-n", name}
|
||||||
|
var create []string
|
||||||
|
switch {
|
||||||
|
case inside:
|
||||||
|
create = append([]string{"tmux", "new-window"}, format...)
|
||||||
|
case i == 0:
|
||||||
|
// A large virtual size leaves room for the splits; attaching resizes it.
|
||||||
|
create = append([]string{"tmux", "new-session", "-d", "-x", "240", "-y", "70", "-s", session}, format...)
|
||||||
|
default:
|
||||||
|
create = append([]string{"tmux", "new-window", "-t", session + ":"}, format...)
|
||||||
|
}
|
||||||
|
out, err := r.Output(append(create, tmuxArgv(group[0])...)...)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !inside && i == 0 {
|
||||||
|
// tmux cuts the status bar's session name at 10 characters
|
||||||
|
// ("[netssh-pv"); widen it for this session only.
|
||||||
|
if _, err := r.Output("tmux", "set-option", "-t", session, "status-left-length", "40"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
window, pane, _ := strings.Cut(out, " ")
|
||||||
|
windows = append(windows, window)
|
||||||
|
if first == "" {
|
||||||
|
first = window
|
||||||
|
}
|
||||||
|
paneIDs := []string{pane}
|
||||||
|
for _, p := range group[1:] {
|
||||||
|
id, err := r.Output(append([]string{"tmux", "split-window", "-t", window, "-P", "-F", "#{pane_id}"}, tmuxArgv(p)...)...)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
paneIDs = append(paneIDs, id)
|
||||||
|
// Re-tile after every split so the next one still has room.
|
||||||
|
if _, err := r.Output("tmux", "select-layout", "-t", window, "tiled"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for j, id := range paneIDs {
|
||||||
|
// A pane may already be gone (host unreachable and closed); not fatal.
|
||||||
|
_, _ = r.Output("tmux", "set-option", "-p", "-t", id, "@netssh_host", group[j].Title)
|
||||||
|
}
|
||||||
|
windowOptions := [][]string{
|
||||||
|
{"@netssh", "1"}, // the key bindings act only in these windows
|
||||||
|
{"pane-border-status", "top"},
|
||||||
|
{"pane-border-format", " #{@netssh_host}#{?pane_synchronized, [SYNC],#{?@netssh_solo, [SOLO],}} "},
|
||||||
|
}
|
||||||
|
if opts.Sync {
|
||||||
|
windowOptions = append(windowOptions, []string{"synchronize-panes", "on"})
|
||||||
|
}
|
||||||
|
for _, option := range windowOptions {
|
||||||
|
if _, err := r.Output("tmux", "set-window-option", "-t", window, option[0], option[1]); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
keys, err := bindKeys(r, opts)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if keys != "" {
|
||||||
|
opts.Hint(keys)
|
||||||
|
// Window-local hints remain visible after attaching, including in an
|
||||||
|
// existing session. Keep other windows and the user's status bar intact.
|
||||||
|
for _, window := range windows {
|
||||||
|
if _, err := r.Output("tmux", "set-window-option", "-t", window, "@netssh_keys", keys); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if _, err := r.Output("tmux", "set-window-option", "-t", window, "pane-border-format",
|
||||||
|
" #{@netssh_host}#{?pane_synchronized, [SYNC],#{?@netssh_solo, [SOLO],}} #{?pane_active, | #{@netssh_keys},} "); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if inside {
|
||||||
|
_, err := r.Output("tmux", "select-window", "-t", first)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return r.Exec("tmux", "attach-session", "-t", session)
|
||||||
|
}
|
||||||
|
|
||||||
|
// soloToggle excludes the current pane from broadcast (a pane-level
|
||||||
|
// synchronize-panes off) or includes it again by removing that override.
|
||||||
|
func soloToggle(solo bool) [][]string {
|
||||||
|
if solo {
|
||||||
|
return [][]string{
|
||||||
|
{"tmux", "set-option", "-pu", "synchronize-panes"},
|
||||||
|
{"tmux", "set-option", "-pu", "@netssh_solo"},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return [][]string{
|
||||||
|
{"tmux", "set-option", "-p", "synchronize-panes", "off"},
|
||||||
|
{"tmux", "set-option", "-p", "@netssh_solo", "1"},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// keyBindings toggle broadcast in netssh multi windows; elsewhere they only
|
||||||
|
// show a message, so they do not change what the keys mean to other windows.
|
||||||
|
const syncBinding = `bind-key -T prefix %s if-shell -F '#{@netssh}' {
|
||||||
|
set-window-option synchronize-panes
|
||||||
|
display-message 'netssh: broadcast #{?synchronize-panes,on,off}'
|
||||||
|
} {
|
||||||
|
display-message 'netssh: not a netssh multi window'
|
||||||
|
}
|
||||||
|
`
|
||||||
|
|
||||||
|
const soloBinding = `bind-key -T prefix %s if-shell -F '#{@netssh}' {
|
||||||
|
if-shell -F '#{@netssh_solo}' {
|
||||||
|
set-option -pu synchronize-panes
|
||||||
|
set-option -pu @netssh_solo
|
||||||
|
display-message 'netssh: pane included in broadcast'
|
||||||
|
} {
|
||||||
|
set-option -p synchronize-panes off
|
||||||
|
set-option -p @netssh_solo 1
|
||||||
|
display-message 'netssh: pane excluded from broadcast'
|
||||||
|
}
|
||||||
|
} {
|
||||||
|
display-message 'netssh: not a netssh multi window'
|
||||||
|
}
|
||||||
|
`
|
||||||
|
|
||||||
|
// bindKeys installs the broadcast keys in the tmux server unless the user's
|
||||||
|
// own configuration already uses them, and returns a hint naming the keys.
|
||||||
|
func bindKeys(r Runner, opts Options) (string, error) {
|
||||||
|
prefix, err := r.Output("tmux", "show-options", "-gv", "prefix")
|
||||||
|
if err != nil || prefix == "" {
|
||||||
|
prefix = "C-b"
|
||||||
|
}
|
||||||
|
var conf strings.Builder
|
||||||
|
var hints, taken []string
|
||||||
|
for _, key := range []struct{ key, binding, what string }{
|
||||||
|
{opts.SyncKey, syncBinding, "sync on/off"},
|
||||||
|
{opts.SoloKey, soloBinding, "solo on/off"},
|
||||||
|
} {
|
||||||
|
if key.key == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// An existing binding is replaced only if netssh made it.
|
||||||
|
if existing, _ := r.Output("tmux", "list-keys", "-T", "prefix", key.key); existing != "" && !strings.Contains(existing, "@netssh") {
|
||||||
|
taken = append(taken, prefix+" "+key.key)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
fmt.Fprintf(&conf, key.binding, key.key)
|
||||||
|
hints = append(hints, displayKey(prefix)+" then "+displayKey(key.key)+": "+key.what)
|
||||||
|
}
|
||||||
|
if conf.Len() > 0 {
|
||||||
|
path := filepath.Join(opts.LayoutDir, "netssh-multi.tmux.conf")
|
||||||
|
if err := r.WriteFile(path, []byte(conf.String())); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if _, err := r.Output("tmux", "source-file", path); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
hint := "keys: " + strings.Join(hints, " | ")
|
||||||
|
if len(hints) == 0 {
|
||||||
|
hint = "toggle broadcast with: netssh sync, netssh sync --pane"
|
||||||
|
}
|
||||||
|
if len(taken) > 0 {
|
||||||
|
hint += "; " + strings.Join(taken, " and ") + " kept your own binding (use netssh sync)"
|
||||||
|
}
|
||||||
|
return hint, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// freeSession returns name, or name-2, name-3, … if a session already uses it.
|
||||||
|
func freeSession(r Runner, name string) string {
|
||||||
|
candidate := name
|
||||||
|
for n := 2; ; n++ {
|
||||||
|
if _, err := r.Output("tmux", "has-session", "-t", "="+candidate); err != nil {
|
||||||
|
return candidate
|
||||||
|
}
|
||||||
|
candidate = name + "-" + strconv.Itoa(n)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// displayKey expands tmux's modifier notation for the on-screen legend.
|
||||||
|
func displayKey(key string) string {
|
||||||
|
key = strings.ReplaceAll(key, "C-", "Ctrl+")
|
||||||
|
return strings.ReplaceAll(key, "M-", "Alt+")
|
||||||
|
}
|
||||||
@@ -0,0 +1,101 @@
|
|||||||
|
package multiplex
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"math"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// openZellij writes a layout with one tab per chunk of panes. Inside zellij
|
||||||
|
// each tab is added to the current session; outside, a new session starts.
|
||||||
|
func openZellij(panes []Pane, opts Options, r Runner) error {
|
||||||
|
groups := chunks(panes, opts.PerWindow)
|
||||||
|
if r.Getenv("ZELLIJ") != "" {
|
||||||
|
for i, group := range groups {
|
||||||
|
path := filepath.Join(opts.LayoutDir, fmt.Sprintf("netssh-multi-%d.kdl", i+1))
|
||||||
|
tab := zellijTab(windowLabel(opts.Label, i, len(groups)), group, true)
|
||||||
|
if err := r.WriteFile(path, []byte(zellijLayout(tab))); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if _, err := r.Output("zellij", "action", "new-tab", "--layout", path); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if opts.Sync {
|
||||||
|
if _, err := r.Output("zellij", "action", "toggle-active-sync-tab"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
var tabs strings.Builder
|
||||||
|
for i, group := range groups {
|
||||||
|
tabs.WriteString(zellijTab(windowLabel(opts.Label, i, len(groups)), group, i == 0))
|
||||||
|
}
|
||||||
|
path := filepath.Join(opts.LayoutDir, "netssh-multi.kdl")
|
||||||
|
if err := r.WriteFile(path, []byte(zellijLayout(tabs.String()))); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if opts.Sync {
|
||||||
|
opts.Hint("zellij starts without broadcast: press Ctrl+t, then s, to type into all panes")
|
||||||
|
} else {
|
||||||
|
opts.Hint("toggle broadcast with Ctrl+t, then s (or netssh sync)")
|
||||||
|
}
|
||||||
|
return r.Exec("zellij", "--layout", path)
|
||||||
|
}
|
||||||
|
|
||||||
|
// zellijLayout wraps tabs with zellij's tab and status bars.
|
||||||
|
func zellijLayout(tabs string) string {
|
||||||
|
return `layout {
|
||||||
|
default_tab_template {
|
||||||
|
pane size=1 borderless=true {
|
||||||
|
plugin location="zellij:tab-bar"
|
||||||
|
}
|
||||||
|
children
|
||||||
|
pane size=2 borderless=true {
|
||||||
|
plugin location="zellij:status-bar"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
` + tabs + "}\n"
|
||||||
|
}
|
||||||
|
|
||||||
|
// zellijTab arranges panes in a grid: rows of ceil(sqrt(n)) columns.
|
||||||
|
func zellijTab(name string, panes []Pane, focus bool) string {
|
||||||
|
cols := int(math.Ceil(math.Sqrt(float64(len(panes)))))
|
||||||
|
var b strings.Builder
|
||||||
|
fmt.Fprintf(&b, " tab name=%s", kdlString(name))
|
||||||
|
if focus {
|
||||||
|
b.WriteString(" focus=true")
|
||||||
|
}
|
||||||
|
b.WriteString(" {\n")
|
||||||
|
for start := 0; start < len(panes); start += cols {
|
||||||
|
row := panes[start:min(start+cols, len(panes))]
|
||||||
|
indent := " "
|
||||||
|
if len(row) > 1 {
|
||||||
|
b.WriteString(indent + "pane split_direction=\"vertical\" {\n")
|
||||||
|
indent += " "
|
||||||
|
}
|
||||||
|
for _, p := range row {
|
||||||
|
fmt.Fprintf(&b, "%spane name=%s command=%s {\n", indent, kdlString(p.Title), kdlString(p.Argv[0]))
|
||||||
|
if len(p.Argv) > 1 {
|
||||||
|
args := make([]string, 0, len(p.Argv)-1)
|
||||||
|
for _, arg := range p.Argv[1:] {
|
||||||
|
args = append(args, kdlString(arg))
|
||||||
|
}
|
||||||
|
fmt.Fprintf(&b, "%s args %s\n", indent, strings.Join(args, " "))
|
||||||
|
}
|
||||||
|
b.WriteString(indent + "}\n")
|
||||||
|
}
|
||||||
|
if len(row) > 1 {
|
||||||
|
b.WriteString(" }\n")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
b.WriteString(" }\n")
|
||||||
|
return b.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// kdlString quotes s as a KDL string.
|
||||||
|
func kdlString(s string) string {
|
||||||
|
return `"` + strings.NewReplacer(`\`, `\\`, `"`, `\"`, "\n", `\n`).Replace(s) + `"`
|
||||||
|
}
|
||||||
+69
-29
@@ -105,6 +105,22 @@ func (c *Client) SearchAll(ctx context.Context, query string, opts SearchOptions
|
|||||||
if opts.Kind != "" && opts.Kind != "device" && opts.Kind != "vm" {
|
if opts.Kind != "" && opts.Kind != "device" && opts.Kind != "vm" {
|
||||||
return nil, fmt.Errorf("invalid host kind %q", opts.Kind)
|
return nil, fmt.Errorf("invalid host kind %q", opts.Kind)
|
||||||
}
|
}
|
||||||
|
filters := ""
|
||||||
|
if opts.Tag != "" {
|
||||||
|
filters += "&tag=" + url.QueryEscape(opts.Tag)
|
||||||
|
}
|
||||||
|
if opts.Cluster != "" {
|
||||||
|
ids, err := c.clusterIDs(ctx, opts.Cluster)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("clusters: %w", err)
|
||||||
|
}
|
||||||
|
if len(ids) == 0 {
|
||||||
|
return nil, nil // no such cluster in this NetBox
|
||||||
|
}
|
||||||
|
for _, id := range ids {
|
||||||
|
filters += fmt.Sprintf("&cluster_id=%d", id)
|
||||||
|
}
|
||||||
|
}
|
||||||
var (
|
var (
|
||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
results []HostEntry
|
results []HostEntry
|
||||||
@@ -116,7 +132,7 @@ func (c *Client) SearchAll(ctx context.Context, query string, opts SearchOptions
|
|||||||
wg.Add(1)
|
wg.Add(1)
|
||||||
go func() {
|
go func() {
|
||||||
defer wg.Done()
|
defer wg.Done()
|
||||||
devices, err := c.fetchAllDevices(ctx, query, opts.Tag)
|
devices, err := c.fetchAllDevices(ctx, query, filters)
|
||||||
mu.Lock()
|
mu.Lock()
|
||||||
defer mu.Unlock()
|
defer mu.Unlock()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -131,7 +147,7 @@ func (c *Client) SearchAll(ctx context.Context, query string, opts SearchOptions
|
|||||||
wg.Add(1)
|
wg.Add(1)
|
||||||
go func() {
|
go func() {
|
||||||
defer wg.Done()
|
defer wg.Done()
|
||||||
vms, err := c.fetchAllVMs(ctx, query, opts.Tag)
|
vms, err := c.fetchAllVMs(ctx, query, filters)
|
||||||
mu.Lock()
|
mu.Lock()
|
||||||
defer mu.Unlock()
|
defer mu.Unlock()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -160,25 +176,33 @@ func (c *Client) GetIPs(ctx context.Context, entry HostEntry) ([]string, error)
|
|||||||
}
|
}
|
||||||
return source.GetIPs(ctx, host)
|
return source.GetIPs(ctx, host)
|
||||||
}
|
}
|
||||||
var apiURL string
|
|
||||||
switch entry.Kind {
|
switch entry.Kind {
|
||||||
case "device":
|
case "device":
|
||||||
apiURL = fmt.Sprintf("%s/api/ipam/ip-addresses/?device_id=%d&limit=100", c.baseURL, entry.ID)
|
return c.fetchAllIPs(ctx, fmt.Sprintf("device_id=%d", entry.ID))
|
||||||
case "vm":
|
case "vm":
|
||||||
apiURL = fmt.Sprintf("%s/api/ipam/ip-addresses/?virtual_machine_id=%d&limit=100", c.baseURL, entry.ID)
|
return c.fetchAllIPs(ctx, fmt.Sprintf("virtual_machine_id=%d", entry.ID))
|
||||||
default:
|
}
|
||||||
return nil, fmt.Errorf("unknown host kind: %q", entry.Kind)
|
return nil, fmt.Errorf("unknown host kind: %q", entry.Kind)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// fetchAllIPs pages through the IP addresses matching filterParams, so hosts
|
||||||
|
// with more addresses than one page do not lose their management address.
|
||||||
|
func (c *Client) fetchAllIPs(ctx context.Context, filterParams string) ([]string, error) {
|
||||||
|
const pageSize = 100
|
||||||
|
var ips []string
|
||||||
|
for offset := 0; ; offset += pageSize {
|
||||||
|
apiURL := fmt.Sprintf("%s/api/ipam/ip-addresses/?%s&limit=%d&offset=%d", c.baseURL, filterParams, pageSize, offset)
|
||||||
var resp netboxIPListResponse
|
var resp netboxIPListResponse
|
||||||
if err := c.get(ctx, apiURL, &resp); err != nil {
|
if err := c.get(ctx, apiURL, &resp); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
ips := make([]string, 0, len(resp.Results))
|
|
||||||
for _, r := range resp.Results {
|
for _, r := range resp.Results {
|
||||||
ips = append(ips, stripPrefix(r.Address))
|
ips = append(ips, stripPrefix(r.Address))
|
||||||
}
|
}
|
||||||
|
if len(resp.Results) < pageSize || len(ips) >= resp.Count {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
return ips, nil
|
return ips, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -187,16 +211,7 @@ func (c *Client) GetIPsWithFilter(ctx context.Context, filterParams string) ([]s
|
|||||||
if c.sources != nil {
|
if c.sources != nil {
|
||||||
return nil, fmt.Errorf("IP filters require a host instance; use GetIPsWithFilterForHost")
|
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)
|
return c.fetchAllIPs(ctx, filterParams)
|
||||||
var resp netboxIPListResponse
|
|
||||||
if err := c.get(ctx, apiURL, &resp); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
ips := make([]string, 0, len(resp.Results))
|
|
||||||
for _, r := range resp.Results {
|
|
||||||
ips = append(ips, stripPrefix(r.Address))
|
|
||||||
}
|
|
||||||
return ips, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Client) searchDevices(ctx context.Context, query, tag string) ([]HostEntry, error) {
|
func (c *Client) searchDevices(ctx context.Context, query, tag string) ([]HostEntry, error) {
|
||||||
@@ -231,15 +246,27 @@ func (c *Client) searchVMs(ctx context.Context, query, tag string) ([]HostEntry,
|
|||||||
return entries, nil
|
return entries, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Client) fetchAllDevices(ctx context.Context, query, tag string) ([]HostEntry, error) {
|
// clusterIDs returns the IDs of the clusters named name (case-insensitive).
|
||||||
|
func (c *Client) clusterIDs(ctx context.Context, name string) ([]int, error) {
|
||||||
|
var resp netboxListResponse[netboxCluster]
|
||||||
|
apiURL := fmt.Sprintf("%s/api/virtualization/clusters/?name__ie=%s&limit=50", c.baseURL, url.QueryEscape(name))
|
||||||
|
if err := c.get(ctx, apiURL, &resp); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
ids := make([]int, 0, len(resp.Results))
|
||||||
|
for _, cluster := range resp.Results {
|
||||||
|
ids = append(ids, cluster.ID)
|
||||||
|
}
|
||||||
|
return ids, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// fetchAllDevices pages through devices; filters are extra "&key=value" parameters.
|
||||||
|
func (c *Client) fetchAllDevices(ctx context.Context, query, filters string) ([]HostEntry, error) {
|
||||||
const pageSize = 50
|
const pageSize = 50
|
||||||
var all []HostEntry
|
var all []HostEntry
|
||||||
for offset := 0; ; offset += pageSize {
|
for offset := 0; ; offset += pageSize {
|
||||||
apiURL := fmt.Sprintf("%s/api/dcim/devices/?name__ic=%s&limit=%d&offset=%d",
|
apiURL := fmt.Sprintf("%s/api/dcim/devices/?name__ic=%s&limit=%d&offset=%d",
|
||||||
c.baseURL, url.QueryEscape(query), pageSize, offset)
|
c.baseURL, url.QueryEscape(query), pageSize, offset) + filters
|
||||||
if tag != "" {
|
|
||||||
apiURL += "&tag=" + url.QueryEscape(tag)
|
|
||||||
}
|
|
||||||
var resp netboxListResponse[netboxDevice]
|
var resp netboxListResponse[netboxDevice]
|
||||||
if err := c.get(ctx, apiURL, &resp); err != nil {
|
if err := c.get(ctx, apiURL, &resp); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -254,15 +281,12 @@ func (c *Client) fetchAllDevices(ctx context.Context, query, tag string) ([]Host
|
|||||||
return all, nil
|
return all, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Client) fetchAllVMs(ctx context.Context, query, tag string) ([]HostEntry, error) {
|
func (c *Client) fetchAllVMs(ctx context.Context, query, filters string) ([]HostEntry, error) {
|
||||||
const pageSize = 50
|
const pageSize = 50
|
||||||
var all []HostEntry
|
var all []HostEntry
|
||||||
for offset := 0; ; offset += pageSize {
|
for offset := 0; ; offset += pageSize {
|
||||||
apiURL := fmt.Sprintf("%s/api/virtualization/virtual-machines/?name__ic=%s&limit=%d&offset=%d",
|
apiURL := fmt.Sprintf("%s/api/virtualization/virtual-machines/?name__ic=%s&limit=%d&offset=%d",
|
||||||
c.baseURL, url.QueryEscape(query), pageSize, offset)
|
c.baseURL, url.QueryEscape(query), pageSize, offset) + filters
|
||||||
if tag != "" {
|
|
||||||
apiURL += "&tag=" + url.QueryEscape(tag)
|
|
||||||
}
|
|
||||||
var resp netboxListResponse[netboxVM]
|
var resp netboxListResponse[netboxVM]
|
||||||
if err := c.get(ctx, apiURL, &resp); err != nil {
|
if err := c.get(ctx, apiURL, &resp); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -323,7 +347,7 @@ func (c *Client) request(ctx context.Context, method, apiURL string, body io.Rea
|
|||||||
}
|
}
|
||||||
|
|
||||||
if resp.StatusCode != http.StatusOK {
|
if resp.StatusCode != http.StatusOK {
|
||||||
return "", fmt.Errorf("netbox returned %d for %s", resp.StatusCode, apiURL)
|
return "", &StatusError{Code: resp.StatusCode, URL: apiURL}
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := json.NewDecoder(resp.Body).Decode(out); err != nil {
|
if err := json.NewDecoder(resp.Body).Decode(out); err != nil {
|
||||||
@@ -343,6 +367,9 @@ func deviceToEntry(d netboxDevice) HostEntry {
|
|||||||
for _, t := range d.Tags {
|
for _, t := range d.Tags {
|
||||||
e.Tags = append(e.Tags, t.Name)
|
e.Tags = append(e.Tags, t.Name)
|
||||||
}
|
}
|
||||||
|
if d.Cluster != nil {
|
||||||
|
e.Cluster = d.Cluster.Name
|
||||||
|
}
|
||||||
return e
|
return e
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -357,6 +384,9 @@ func vmToEntry(v netboxVM) HostEntry {
|
|||||||
for _, t := range v.Tags {
|
for _, t := range v.Tags {
|
||||||
e.Tags = append(e.Tags, t.Name)
|
e.Tags = append(e.Tags, t.Name)
|
||||||
}
|
}
|
||||||
|
if v.Cluster != nil {
|
||||||
|
e.Cluster = v.Cluster.Name
|
||||||
|
}
|
||||||
return e
|
return e
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -368,6 +398,16 @@ func stripPrefix(cidr string) string {
|
|||||||
return cidr
|
return cidr
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// StatusError is an unexpected HTTP status from NetBox.
|
||||||
|
type StatusError struct {
|
||||||
|
Code int
|
||||||
|
URL string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *StatusError) Error() string {
|
||||||
|
return fmt.Sprintf("netbox returned %d for %s", e.Code, e.URL)
|
||||||
|
}
|
||||||
|
|
||||||
// ErrHostNotFound distinguishes a missing exact match from API failures or ambiguity.
|
// ErrHostNotFound distinguishes a missing exact match from API failures or ambiguity.
|
||||||
var ErrHostNotFound = errors.New("host not found")
|
var ErrHostNotFound = errors.New("host not found")
|
||||||
|
|
||||||
|
|||||||
@@ -3,8 +3,11 @@ package netbox
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
@@ -235,7 +238,7 @@ func TestGetIPsWithFilter(t *testing.T) {
|
|||||||
defer srv.Close()
|
defer srv.Close()
|
||||||
|
|
||||||
c := NewClient(srv.URL, "token", 0)
|
c := NewClient(srv.URL, "token", 0)
|
||||||
ips, err := c.GetIPsWithFilter(context.Background(), "device_id=1&interface_name=mgmt0")
|
ips, err := c.GetIPsWithFilter(context.Background(), "device_id=1&interface=mgmt0")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("GetIPsWithFilter: %v", err)
|
t.Fatalf("GetIPsWithFilter: %v", err)
|
||||||
}
|
}
|
||||||
@@ -499,3 +502,45 @@ func TestCommentConflictIsReported(t *testing.T) {
|
|||||||
t.Fatal("conflict ignored")
|
t.Fatal("conflict ignored")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Hosts with more addresses than one page must not lose the later ones.
|
||||||
|
func TestGetIPs_Paginates(t *testing.T) {
|
||||||
|
const total = 230
|
||||||
|
var offsets []string
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
offsets = append(offsets, r.URL.Query().Get("offset"))
|
||||||
|
offset, _ := strconv.Atoi(r.URL.Query().Get("offset"))
|
||||||
|
limit, _ := strconv.Atoi(r.URL.Query().Get("limit"))
|
||||||
|
var addrs []string
|
||||||
|
for i := offset; i < offset+limit && i < total; i++ {
|
||||||
|
addrs = append(addrs, fmt.Sprintf("10.0.%d.%d/24", i/250, i%250+1))
|
||||||
|
}
|
||||||
|
resp := ipListResponse(addrs...)
|
||||||
|
resp.Count = total
|
||||||
|
json.NewEncoder(w).Encode(resp)
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
ips, err := NewClient(srv.URL, "token", 0).GetIPs(context.Background(), HostEntry{ID: 1, Kind: "device"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GetIPs: %v", err)
|
||||||
|
}
|
||||||
|
if len(ips) != total || ips[total-1] != "10.0.0.230" {
|
||||||
|
t.Errorf("got %d IPs (last %q), want %d", len(ips), ips[len(ips)-1], total)
|
||||||
|
}
|
||||||
|
if strings.Join(offsets, ",") != "0,100,200" {
|
||||||
|
t.Errorf("offsets %v, want 0,100,200", offsets)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequest_StatusErrorCarriesCode(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
_, err := NewClient(srv.URL, "token", 0).GetIPsWithFilter(context.Background(), "device_id=1&interface=nope")
|
||||||
|
var status *StatusError
|
||||||
|
if !errors.As(err, &status) || status.Code != http.StatusBadRequest {
|
||||||
|
t.Fatalf("got %v, want a StatusError with code 400", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
package netbox
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestSearchAllByCluster(t *testing.T) {
|
||||||
|
var deviceQuery, vmQuery string
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
switch r.URL.Path {
|
||||||
|
case "/api/virtualization/clusters/":
|
||||||
|
if r.URL.Query().Get("name__ie") == "PVE" {
|
||||||
|
fmt.Fprint(w, `{"count":2,"results":[{"id":3,"name":"pve"},{"id":4,"name":"pve"}]}`)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
fmt.Fprint(w, `{"count":0,"results":[]}`)
|
||||||
|
case "/api/dcim/devices/":
|
||||||
|
deviceQuery = r.URL.RawQuery
|
||||||
|
fmt.Fprint(w, `{"count":1,"results":[{"id":1,"name":"node1","cluster":{"id":3,"name":"pve"}}]}`)
|
||||||
|
case "/api/virtualization/virtual-machines/":
|
||||||
|
vmQuery = r.URL.RawQuery
|
||||||
|
fmt.Fprint(w, `{"count":1,"results":[{"id":2,"name":"vm1","cluster":{"id":4,"name":"pve"}}]}`)
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
c := NewClient(srv.URL, "t", 1)
|
||||||
|
|
||||||
|
hosts, err := c.SearchAll(context.Background(), "", SearchOptions{Cluster: "PVE", Kind: "device"})
|
||||||
|
if err != nil || len(hosts) != 1 || hosts[0].Name != "node1" || hosts[0].Cluster != "pve" {
|
||||||
|
t.Fatalf("got %+v %v", hosts, err)
|
||||||
|
}
|
||||||
|
if want := "name__ic=&limit=50&offset=0&cluster_id=3&cluster_id=4"; deviceQuery != want {
|
||||||
|
t.Errorf("device query %q, want %q", deviceQuery, want)
|
||||||
|
}
|
||||||
|
if vmQuery != "" {
|
||||||
|
t.Error("VMs queried for kind device")
|
||||||
|
}
|
||||||
|
all, err := c.SearchAll(context.Background(), "", SearchOptions{Cluster: "PVE"})
|
||||||
|
if err != nil || len(all) != 2 {
|
||||||
|
t.Fatalf("all kinds: %+v %v", all, err)
|
||||||
|
}
|
||||||
|
none, err := c.SearchAll(context.Background(), "", SearchOptions{Cluster: "missing"})
|
||||||
|
if err != nil || len(none) != 0 {
|
||||||
|
t.Fatalf("unknown cluster: %+v %v", none, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,16 +1,24 @@
|
|||||||
package netbox
|
package netbox
|
||||||
|
|
||||||
import "strings"
|
import (
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
// SearchOptions filters a Search or SearchAll query.
|
// SearchOptions filters a Search or SearchAll query.
|
||||||
// Zero value means no filtering (return all kinds, no tag filter).
|
// Zero value means no filtering (return all kinds, no tag filter).
|
||||||
type SearchOptions struct {
|
type SearchOptions struct {
|
||||||
Tag string // filter by tag slug; empty = no filter
|
Tag string // filter by tag slug; empty = no filter
|
||||||
Kind string // "device" | "vm" | "" (both)
|
Kind string // "device" | "vm" | "" (both)
|
||||||
|
// Cluster filters SearchAll by virtualization cluster name (case-insensitive).
|
||||||
|
Cluster string
|
||||||
}
|
}
|
||||||
|
|
||||||
// HostEntry is a unified model for both devices and virtual machines from NetBox.
|
// HostEntry is a unified model for both devices and virtual machines from NetBox.
|
||||||
type HostEntry struct {
|
type HostEntry struct {
|
||||||
|
Cached bool
|
||||||
|
CachedAt time.Time
|
||||||
|
Static bool
|
||||||
Source string // named NetBox instance; empty for the legacy single-instance config
|
Source string // named NetBox instance; empty for the legacy single-instance config
|
||||||
ID int
|
ID int
|
||||||
Name string
|
Name string
|
||||||
@@ -18,6 +26,13 @@ type HostEntry struct {
|
|||||||
PrimaryIP4 string // e.g. "10.0.1.5" (prefix length stripped)
|
PrimaryIP4 string // e.g. "10.0.1.5" (prefix length stripped)
|
||||||
PrimaryIP6 string
|
PrimaryIP6 string
|
||||||
Tags []string
|
Tags []string
|
||||||
|
Cluster string // virtualization cluster name, if assigned
|
||||||
|
}
|
||||||
|
|
||||||
|
// netboxCluster is the nested cluster of a device or virtual machine.
|
||||||
|
type netboxCluster struct {
|
||||||
|
ID int `json:"id"`
|
||||||
|
Name string `json:"name"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// netboxIP represents an IP address as returned by the NetBox API.
|
// netboxIP represents an IP address as returned by the NetBox API.
|
||||||
@@ -34,6 +49,7 @@ type netboxDevice struct {
|
|||||||
} `json:"tags"`
|
} `json:"tags"`
|
||||||
PrimaryIP4 *netboxIP `json:"primary_ip4"`
|
PrimaryIP4 *netboxIP `json:"primary_ip4"`
|
||||||
PrimaryIP6 *netboxIP `json:"primary_ip6"`
|
PrimaryIP6 *netboxIP `json:"primary_ip6"`
|
||||||
|
Cluster *netboxCluster `json:"cluster"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// netboxVM matches the relevant fields of the NetBox /virtualization/virtual-machines/ response.
|
// netboxVM matches the relevant fields of the NetBox /virtualization/virtual-machines/ response.
|
||||||
@@ -45,6 +61,7 @@ type netboxVM struct {
|
|||||||
} `json:"tags"`
|
} `json:"tags"`
|
||||||
PrimaryIP4 *netboxIP `json:"primary_ip4"`
|
PrimaryIP4 *netboxIP `json:"primary_ip4"`
|
||||||
PrimaryIP6 *netboxIP `json:"primary_ip6"`
|
PrimaryIP6 *netboxIP `json:"primary_ip6"`
|
||||||
|
Cluster *netboxCluster `json:"cluster"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type netboxListResponse[T any] struct {
|
type netboxListResponse[T any] struct {
|
||||||
|
|||||||
@@ -78,7 +78,7 @@ func TestMultiSourceSearchAndRouting(t *testing.T) {
|
|||||||
if err != nil || len(ips) != 1 || ips[0] != tc.ip {
|
if err != nil || len(ips) != 1 || ips[0] != tc.ip {
|
||||||
t.Fatalf("wrong IP source: %v, %v", ips, err)
|
t.Fatalf("wrong IP source: %v, %v", ips, err)
|
||||||
}
|
}
|
||||||
ips, err = c.GetIPsWithFilterForHost(ctx, host, "device_id=1&interface_name=mgmt0")
|
ips, err = c.GetIPsWithFilterForHost(ctx, host, "device_id=1&interface=mgmt0")
|
||||||
if err != nil || len(ips) != 1 || ips[0] != tc.ip {
|
if err != nil || len(ips) != 1 || ips[0] != tc.ip {
|
||||||
t.Fatalf("wrong interface source: %v, %v", ips, err)
|
t.Fatalf("wrong interface source: %v, %v", ips, err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ package resolver
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
@@ -27,13 +28,24 @@ func New(cfg config.ResolverConfig) (*Chain, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (c *Chain) Resolve(ctx context.Context, entry *netbox.HostEntry, client *netbox.Client) (string, error) {
|
func (c *Chain) Resolve(ctx context.Context, entry *netbox.HostEntry, client *netbox.Client) (string, error) {
|
||||||
|
address, _, err := c.ResolveWithStrategy(ctx, entry, client)
|
||||||
|
return address, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Chain) ResolveWithStrategy(ctx context.Context, entry *netbox.HostEntry, client *netbox.Client) (string, string, error) {
|
||||||
for _, s := range c.strategies {
|
for _, s := range c.strategies {
|
||||||
ip, err := s.Resolve(ctx, entry, client)
|
ip, err := s.Resolve(ctx, entry, client)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
return ip, nil
|
return ip, s.Name(), nil
|
||||||
|
}
|
||||||
|
// Only "this strategy has no address" moves on. After an API failure
|
||||||
|
// the next strategy would connect to (and cache) a different address
|
||||||
|
// than the configured order asks for.
|
||||||
|
if !errors.Is(err, ErrNoIP) {
|
||||||
|
return "", "", fmt.Errorf("resolver strategy %q for %q: %w", s.Name(), entry.Name, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return "", fmt.Errorf("no strategy resolved an IP for %q", entry.Name)
|
return "", "", fmt.Errorf("no strategy resolved an IP for %q", entry.Name)
|
||||||
}
|
}
|
||||||
|
|
||||||
func newStrategy(name string, cfg config.ResolverConfig) (Strategy, error) {
|
func newStrategy(name string, cfg config.ResolverConfig) (Strategy, error) {
|
||||||
@@ -46,6 +58,8 @@ func newStrategy(name string, cfg config.ResolverConfig) (Strategy, error) {
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
return s, nil
|
return s, nil
|
||||||
|
case "hostname":
|
||||||
|
return &HostnameStrategy{domain: cfg.HostnameDomain}, nil
|
||||||
case "interface_name":
|
case "interface_name":
|
||||||
if cfg.InterfaceName == "" {
|
if cfg.InterfaceName == "" {
|
||||||
return nil, fmt.Errorf("interface_name strategy requires resolver.interface_name to be set")
|
return nil, fmt.Errorf("interface_name strategy requires resolver.interface_name to be set")
|
||||||
|
|||||||
@@ -153,3 +153,17 @@ func TestNew_MultipleStrategies(t *testing.T) {
|
|||||||
t.Errorf("got %d strategies, want 2", len(c.strategies))
|
t.Errorf("got %d strategies, want 2", len(c.strategies))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// An API failure must not fall through: the next strategy would connect to
|
||||||
|
// and cache a different address than the configured order asks for.
|
||||||
|
func TestChain_APIErrorStopsTheChain(t *testing.T) {
|
||||||
|
apiErr := errors.New("connection refused")
|
||||||
|
c := &Chain{strategies: []Strategy{
|
||||||
|
&stubStrategy{name: "management_subnet", err: apiErr},
|
||||||
|
&stubStrategy{name: "primary_ip", ip: "10.0.0.2"},
|
||||||
|
}}
|
||||||
|
ip, err := c.Resolve(context.Background(), &netbox.HostEntry{Name: "host"}, nil)
|
||||||
|
if !errors.Is(err, apiErr) || ip != "" {
|
||||||
|
t.Fatalf("got %q, %v; want the API error and no address", ip, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
package resolver
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
||||||
|
)
|
||||||
|
|
||||||
|
var validHostname = regexp.MustCompile(`^[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?(\.[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?)*$`)
|
||||||
|
|
||||||
|
// HostnameStrategy connects by the NetBox name instead of an IP, so DNS or
|
||||||
|
// ~/.ssh/config resolves it. Names without a dot get the optional domain.
|
||||||
|
// Names that are no valid hostname fall through to the next strategy.
|
||||||
|
type HostnameStrategy struct {
|
||||||
|
domain string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *HostnameStrategy) Name() string { return "hostname" }
|
||||||
|
|
||||||
|
func (s *HostnameStrategy) Resolve(_ context.Context, entry *netbox.HostEntry, _ *netbox.Client) (string, error) {
|
||||||
|
name := strings.ToLower(entry.Name)
|
||||||
|
if domain := strings.Trim(s.domain, "."); domain != "" && !strings.Contains(name, ".") {
|
||||||
|
name += "." + strings.ToLower(domain)
|
||||||
|
}
|
||||||
|
if !validHostname.MatchString(name) {
|
||||||
|
return "", ErrNoIP
|
||||||
|
}
|
||||||
|
return name, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
package resolver
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestHostnameStrategy(t *testing.T) {
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name, domain, want string
|
||||||
|
}{
|
||||||
|
{"Web01.Example.com", "", "web01.example.com"},
|
||||||
|
{"web01", "example.com", "web01.example.com"},
|
||||||
|
{"web01", ".example.com.", "web01.example.com"},
|
||||||
|
{"web01.lab", "example.com", "web01.lab"}, // already qualified
|
||||||
|
} {
|
||||||
|
got, err := (&HostnameStrategy{domain: tc.domain}).Resolve(context.Background(), &netbox.HostEntry{Name: tc.name}, nil)
|
||||||
|
if err != nil || got != tc.want {
|
||||||
|
t.Errorf("%q + %q: got %q, %v; want %q", tc.name, tc.domain, got, err, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, name := range []string{"Core Switch 1", "-x", "a..b", "web_01"} {
|
||||||
|
if _, err := (&HostnameStrategy{}).Resolve(context.Background(), &netbox.HostEntry{Name: name}, nil); err != ErrNoIP {
|
||||||
|
t.Errorf("%q: got %v, want ErrNoIP", name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHostnameAsFallback(t *testing.T) {
|
||||||
|
chain, err := New(config.ResolverConfig{Strategies: []string{"primary_ip", "hostname"}, HostnameDomain: "example.com"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if ip, _ := chain.Resolve(context.Background(), &netbox.HostEntry{Name: "web01", PrimaryIP4: "192.0.2.1"}, nil); ip != "192.0.2.1" {
|
||||||
|
t.Fatalf("primary IP first: %q", ip)
|
||||||
|
}
|
||||||
|
if ip, _ := chain.Resolve(context.Background(), &netbox.HostEntry{Name: "web02"}, nil); ip != "web02.example.com" {
|
||||||
|
t.Fatalf("hostname fallback: %q", ip)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,7 +2,9 @@ package resolver
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
|
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
||||||
@@ -16,18 +18,25 @@ type InterfaceNameStrategy struct {
|
|||||||
func (s *InterfaceNameStrategy) Name() string { return "interface_name" }
|
func (s *InterfaceNameStrategy) Name() string { return "interface_name" }
|
||||||
|
|
||||||
func (s *InterfaceNameStrategy) Resolve(ctx context.Context, entry *netbox.HostEntry, client *netbox.Client) (string, error) {
|
func (s *InterfaceNameStrategy) Resolve(ctx context.Context, entry *netbox.HostEntry, client *netbox.Client) (string, error) {
|
||||||
// Build filter parameters for IP addresses attached to the named interface.
|
// NetBox filters IP addresses by interface name with interface= (devices)
|
||||||
|
// and vminterface= (VMs); unknown parameters would be ignored silently and
|
||||||
|
// return every address of the host. A missing interface is an HTTP 400,
|
||||||
|
// which lets the chain try the next strategy.
|
||||||
var filterParam string
|
var filterParam string
|
||||||
switch entry.Kind {
|
switch entry.Kind {
|
||||||
case "device":
|
case "device":
|
||||||
filterParam = fmt.Sprintf("device_id=%d&interface_name=%s", entry.ID, url.QueryEscape(s.name))
|
filterParam = fmt.Sprintf("device_id=%d&interface=%s", entry.ID, url.QueryEscape(s.name))
|
||||||
case "vm":
|
case "vm":
|
||||||
filterParam = fmt.Sprintf("virtual_machine_id=%d&vminterface_name=%s", entry.ID, url.QueryEscape(s.name))
|
filterParam = fmt.Sprintf("virtual_machine_id=%d&vminterface=%s", entry.ID, url.QueryEscape(s.name))
|
||||||
default:
|
default:
|
||||||
return "", fmt.Errorf("unknown kind %q", entry.Kind)
|
return "", fmt.Errorf("unknown kind %q", entry.Kind)
|
||||||
}
|
}
|
||||||
|
|
||||||
ips, err := client.GetIPsWithFilterForHost(ctx, *entry, filterParam)
|
ips, err := client.GetIPsWithFilterForHost(ctx, *entry, filterParam)
|
||||||
|
var status *netbox.StatusError
|
||||||
|
if errors.As(err, &status) && status.Code == http.StatusBadRequest {
|
||||||
|
return "", ErrNoIP // the host has no interface of this name
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("fetching IPs for interface %q: %w", s.name, err)
|
return "", fmt.Errorf("fetching IPs for interface %q: %w", s.name, err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,70 @@
|
|||||||
|
package resolver
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"net/url"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
||||||
|
)
|
||||||
|
|
||||||
|
// NetBox ignores unknown filters, so the strategy must use the real filter
|
||||||
|
// names; otherwise it silently returns the host's first address.
|
||||||
|
func TestInterfaceNameStrategyFilters(t *testing.T) {
|
||||||
|
for kind, want := range map[string]string{
|
||||||
|
"device": "device_id=7&interface=mgmt0",
|
||||||
|
"vm": "virtual_machine_id=7&vminterface=mgmt0",
|
||||||
|
} {
|
||||||
|
var got string
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
q := r.URL.Query()
|
||||||
|
q.Del("limit")
|
||||||
|
q.Del("offset")
|
||||||
|
got = q.Encode()
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
w.Write([]byte(`{"count":1,"results":[{"address":"10.0.0.7/24"}]}`))
|
||||||
|
}))
|
||||||
|
ip, err := (&InterfaceNameStrategy{name: "mgmt0"}).Resolve(context.Background(), &netbox.HostEntry{ID: 7, Kind: kind}, netbox.NewClient(srv.URL, "t", 1))
|
||||||
|
srv.Close()
|
||||||
|
if err != nil || ip != "10.0.0.7" {
|
||||||
|
t.Fatalf("%s: %q %v", kind, ip, err)
|
||||||
|
}
|
||||||
|
if parsed, _ := urlQuery(want); got != parsed {
|
||||||
|
t.Errorf("%s: query %q, want %q", kind, got, parsed)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInterfaceNameStrategyMissingInterfaceFallsThrough(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
http.Error(w, `{"vminterface":["Select a valid choice."]}`, http.StatusBadRequest)
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
client := netbox.NewClient(srv.URL, "t", 1)
|
||||||
|
chain := &Chain{strategies: []Strategy{&InterfaceNameStrategy{name: "mgmt0"}, &PrimaryIPStrategy{}}}
|
||||||
|
ip, err := chain.Resolve(context.Background(), &netbox.HostEntry{ID: 7, Kind: "vm", PrimaryIP4: "10.0.0.9"}, client)
|
||||||
|
if err != nil || ip != "10.0.0.9" {
|
||||||
|
t.Fatalf("got %q %v", ip, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func urlQuery(s string) (string, error) {
|
||||||
|
q, err := url.ParseQuery(s)
|
||||||
|
return q.Encode(), err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Only the HTTP 400 of a missing interface means "no address here"; a server
|
||||||
|
// error must stop the chain instead of silently using the next strategy.
|
||||||
|
func TestInterfaceNameStrategyServerErrorIsNotNoIP(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusBadGateway)
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
_, err := (&InterfaceNameStrategy{name: "mgmt0"}).Resolve(context.Background(), &netbox.HostEntry{ID: 7, Kind: "device"}, netbox.NewClient(srv.URL, "t", 1))
|
||||||
|
if err == nil || errors.Is(err, ErrNoIP) {
|
||||||
|
t.Fatalf("got %v, want an API error", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,146 @@
|
|||||||
|
// Package runner supervises local commands while retaining terminal I/O.
|
||||||
|
package runner
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"os/signal"
|
||||||
|
"syscall"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/charmbracelet/x/term"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Options struct {
|
||||||
|
Stdin io.Reader
|
||||||
|
Stdout, Stderr io.Writer
|
||||||
|
Env []string
|
||||||
|
Timeout time.Duration
|
||||||
|
Status bool
|
||||||
|
Label string
|
||||||
|
}
|
||||||
|
type Result struct {
|
||||||
|
Code int
|
||||||
|
Started bool
|
||||||
|
Duration time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
func Run(ctx context.Context, argv []string, o Options) Result {
|
||||||
|
if o.Stderr == nil {
|
||||||
|
o.Stderr = io.Discard
|
||||||
|
}
|
||||||
|
if o.Stdout == nil {
|
||||||
|
o.Stdout = io.Discard
|
||||||
|
}
|
||||||
|
start := time.Now()
|
||||||
|
result := Result{Code: 1}
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
result.Code = 130
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
if len(argv) == 0 {
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
cmd := exec.Command(argv[0], argv[1:]...)
|
||||||
|
cmd.Stdin, cmd.Stdout, cmd.Stderr = o.Stdin, o.Stdout, o.Stderr
|
||||||
|
cmd.Env = append(os.Environ(), o.Env...)
|
||||||
|
interactive := false
|
||||||
|
if f, ok := o.Stdin.(*os.File); ok {
|
||||||
|
interactive = term.IsTerminal(f.Fd())
|
||||||
|
}
|
||||||
|
// Interactive SSH must share the foreground terminal process group.
|
||||||
|
// Background jobs get an isolated group so cancellation reaches descendants.
|
||||||
|
cmd.SysProcAttr = &syscall.SysProcAttr{Setpgid: !interactive}
|
||||||
|
if err := cmd.Start(); err != nil {
|
||||||
|
fmt.Fprintf(o.Stderr, "%s: %v\n", argv[0], err)
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
result.Started = true
|
||||||
|
done := make(chan error, 1)
|
||||||
|
go func() { done <- cmd.Wait() }()
|
||||||
|
sigs := make(chan os.Signal, 4)
|
||||||
|
signal.Notify(sigs, os.Interrupt, syscall.SIGTERM, syscall.SIGHUP, syscall.SIGQUIT)
|
||||||
|
defer signal.Stop(sigs)
|
||||||
|
var timeout <-chan time.Time
|
||||||
|
if o.Timeout > 0 {
|
||||||
|
timer := time.NewTimer(o.Timeout)
|
||||||
|
defer timer.Stop()
|
||||||
|
timeout = timer.C
|
||||||
|
}
|
||||||
|
ticker := time.NewTicker(time.Second)
|
||||||
|
defer ticker.Stop()
|
||||||
|
var killTimer *time.Timer
|
||||||
|
var kill <-chan time.Time
|
||||||
|
defer func() {
|
||||||
|
if killTimer != nil {
|
||||||
|
killTimer.Stop()
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
send := func(sig syscall.Signal) {
|
||||||
|
if interactive {
|
||||||
|
_ = cmd.Process.Signal(sig)
|
||||||
|
} else {
|
||||||
|
_ = syscall.Kill(-cmd.Process.Pid, sig)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
forced := 0
|
||||||
|
cancelCh := ctx.Done()
|
||||||
|
stop := func(code int, sig syscall.Signal) {
|
||||||
|
if forced != 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
forced = code
|
||||||
|
send(sig)
|
||||||
|
killTimer = time.NewTimer(2 * time.Second)
|
||||||
|
kill = killTimer.C
|
||||||
|
}
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case err := <-done:
|
||||||
|
result.Duration = time.Since(start)
|
||||||
|
result.Code = 0
|
||||||
|
if err != nil {
|
||||||
|
result.Code = 1
|
||||||
|
if e, ok := err.(*exec.ExitError); ok {
|
||||||
|
result.Code = e.ExitCode()
|
||||||
|
if s, ok := e.Sys().(syscall.WaitStatus); ok && s.Signaled() {
|
||||||
|
result.Code = 128 + int(s.Signal())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if forced != 0 {
|
||||||
|
result.Code = forced
|
||||||
|
}
|
||||||
|
// Kill descendants left behind after cancellation even if the parent exited.
|
||||||
|
if forced != 0 && !interactive {
|
||||||
|
send(syscall.SIGKILL)
|
||||||
|
}
|
||||||
|
if o.Status {
|
||||||
|
fmt.Fprintf(o.Stderr, "[%s] finished in %s (exit %d)\n", o.Label, result.Duration.Round(time.Millisecond), result.Code)
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
case sig := <-sigs:
|
||||||
|
s := sig.(syscall.Signal)
|
||||||
|
if interactive && (s == syscall.SIGINT || s == syscall.SIGQUIT) {
|
||||||
|
continue
|
||||||
|
} // terminal delivered it to child too
|
||||||
|
stop(128+int(s), s)
|
||||||
|
case <-cancelCh:
|
||||||
|
cancelCh = nil
|
||||||
|
stop(130, syscall.SIGTERM)
|
||||||
|
case <-timeout:
|
||||||
|
timeout = nil
|
||||||
|
stop(124, syscall.SIGTERM)
|
||||||
|
case <-kill:
|
||||||
|
kill = nil
|
||||||
|
send(syscall.SIGKILL)
|
||||||
|
case <-ticker.C:
|
||||||
|
if o.Status {
|
||||||
|
fmt.Fprintf(o.Stderr, "[%s] running %s (Ctrl+C cancels)\n", o.Label, time.Since(start).Round(time.Second))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
package runner
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"io"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestExitAndTimeout(t *testing.T) {
|
||||||
|
var out bytes.Buffer
|
||||||
|
r := Run(context.Background(), []string{"sh", "-c", "printf result; exit 7"}, Options{Stdout: &out, Stderr: io.Discard})
|
||||||
|
if !r.Started || r.Code != 7 || out.String() != "result" {
|
||||||
|
t.Fatalf("%+v %q", r, out.String())
|
||||||
|
}
|
||||||
|
start := time.Now()
|
||||||
|
r = Run(context.Background(), []string{"sh", "-c", "trap '' TERM; sleep 30 & wait"}, Options{Stdout: io.Discard, Stderr: io.Discard, Timeout: 50 * time.Millisecond})
|
||||||
|
if r.Code != 124 || time.Since(start) > 4*time.Second {
|
||||||
|
t.Fatalf("timeout: %+v", r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func TestCancellationAndNoStart(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
r := Run(ctx, []string{"sh", "-c", "exit 0"}, Options{Stderr: io.Discard})
|
||||||
|
if r.Started || r.Code != 130 {
|
||||||
|
t.Fatalf("%+v", r)
|
||||||
|
}
|
||||||
|
var errOut bytes.Buffer
|
||||||
|
r = Run(context.Background(), []string{"/no/such/netssh-test-executable"}, Options{Stderr: &errOut})
|
||||||
|
if r.Started || r.Code == 0 || !strings.Contains(errOut.String(), "no such") {
|
||||||
|
t.Fatalf("%+v %s", r, errOut.String())
|
||||||
|
}
|
||||||
|
ctx, cancel = context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
time.AfterFunc(50*time.Millisecond, cancel)
|
||||||
|
r = Run(ctx, []string{"sh", "-c", "sleep 30"}, Options{Stdout: io.Discard, Stderr: io.Discard})
|
||||||
|
if r.Code != 130 {
|
||||||
|
t.Fatalf("%+v", r)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,94 @@
|
|||||||
|
package setup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"charm.land/huh/v2"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func editCommands(cfg *config.Config) error {
|
||||||
|
for {
|
||||||
|
var names []string
|
||||||
|
for name := range cfg.Commands {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
var options []huh.Option[string]
|
||||||
|
for _, name := range names {
|
||||||
|
options = append(options, huh.NewOption("Edit "+name, "edit:"+name), huh.NewOption("Remove "+name, "remove:"+name))
|
||||||
|
}
|
||||||
|
options = append(options, huh.NewOption("Add command", "add"), huh.NewOption("Done", "done"))
|
||||||
|
action := "done"
|
||||||
|
if err := huh.NewSelect[string]().Title("Custom host commands").Options(options...).Value(&action).Run(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if action == "done" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if name, ok := strings.CutPrefix(action, "remove:"); ok {
|
||||||
|
remove := false
|
||||||
|
if err := huh.NewConfirm().Title("Remove " + name + "?").Value(&remove).Run(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if remove {
|
||||||
|
delete(cfg.Commands, name)
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
original, _ := strings.CutPrefix(action, "edit:")
|
||||||
|
if action == "add" {
|
||||||
|
original = ""
|
||||||
|
}
|
||||||
|
name := original
|
||||||
|
command := cfg.Commands[original]
|
||||||
|
binary, arguments := "", ""
|
||||||
|
if len(command.Args) > 0 {
|
||||||
|
binary = command.Args[0]
|
||||||
|
arguments = strings.Join(command.Args[1:], "\n")
|
||||||
|
}
|
||||||
|
err := huh.NewForm(huh.NewGroup(
|
||||||
|
huh.NewInput().Title("Command name").Placeholder("mtr").Value(&name).Validate(func(s string) error {
|
||||||
|
if s == "" {
|
||||||
|
return fmt.Errorf("required")
|
||||||
|
}
|
||||||
|
if s != original {
|
||||||
|
if _, exists := cfg.Commands[s]; exists {
|
||||||
|
return fmt.Errorf("name already exists")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return config.ValidateCommandAlias(s)
|
||||||
|
}),
|
||||||
|
huh.NewInput().Title("Alias prefix").Description("m + host shortcut xg1 = mxg1. Empty disables automatic aliases.").Value(&command.AliasPrefix),
|
||||||
|
huh.NewInput().Title("Program or executable script").Description("Use an absolute script path, or bash/python3 with the script path as the first argument.").Placeholder("mtr or /home/user/bin/check-host").Value(&binary),
|
||||||
|
huh.NewText().Title("Arguments, one per line").Description("Use {address} for the resolved address, {host} for the hostname, {target} for instance/hostname. No shell quoting needed.").Lines(5).Value(&arguments),
|
||||||
|
huh.NewConfirm().Title("Confirm before running?").Value(&command.Confirm),
|
||||||
|
huh.NewInput().Title("Timeout").Description("Optional positive duration, e.g. 30s or 5m.").Value(&command.Timeout),
|
||||||
|
huh.NewInput().Title("Post-run script").Description("Local command after completion; receives NETSSH_EXIT_CODE.").Value(&command.PostRun),
|
||||||
|
huh.NewInput().Title("Only for tag").Value(&command.Match.Tag),
|
||||||
|
huh.NewInput().Title("Only for instance").Value(&command.Match.Instance),
|
||||||
|
huh.NewInput().Title("Only for kind").Description("device, vm or static; empty means all.").Value(&command.Match.Kind),
|
||||||
|
huh.NewInput().Title("Only for hostname pattern").Description("For example router*; all specified filters must match.").Value(&command.Match.Name),
|
||||||
|
).Title("Local command")).Run()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
command.Args = []string{binary}
|
||||||
|
if arguments != "" {
|
||||||
|
command.Args = append(command.Args, strings.Split(arguments, "\n")...)
|
||||||
|
}
|
||||||
|
candidate := config.Config{Commands: make(map[string]config.HostCommand)}
|
||||||
|
for k, v := range cfg.Commands {
|
||||||
|
if k != original {
|
||||||
|
candidate.Commands[k] = v
|
||||||
|
}
|
||||||
|
}
|
||||||
|
candidate.Commands[name] = command
|
||||||
|
if err := candidate.ValidateCommands(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cfg.Commands = candidate.Commands
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,140 @@
|
|||||||
|
package setup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"charm.land/huh/v2"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
// configureHosts edits a copy of the static hosts; the caller decides whether to keep it.
|
||||||
|
func configureHosts(hosts []config.StaticHost) ([]config.StaticHost, error) {
|
||||||
|
hosts = append([]config.StaticHost(nil), hosts...)
|
||||||
|
for {
|
||||||
|
action := "done"
|
||||||
|
var options []huh.Option[string]
|
||||||
|
for i, host := range hosts {
|
||||||
|
index := strconv.Itoa(i)
|
||||||
|
options = append(options,
|
||||||
|
huh.NewOption("Edit "+host.Name+" ("+host.Address+")", "edit:"+index),
|
||||||
|
huh.NewOption("SSH options for "+host.Name, "ssh:"+index),
|
||||||
|
huh.NewOption("Remove "+host.Name, "remove:"+index))
|
||||||
|
}
|
||||||
|
options = append(options, huh.NewOption("Add host", "add"), huh.NewOption("Back", "done"))
|
||||||
|
err := huh.NewForm(huh.NewGroup(huh.NewSelect[string]().
|
||||||
|
Title("Static hosts").
|
||||||
|
Description("Hosts that are not in NetBox. They are found before NetBox and work offline.").
|
||||||
|
Options(options...).
|
||||||
|
Value(&action))).Run()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if action == "done" {
|
||||||
|
return hosts, nil
|
||||||
|
}
|
||||||
|
if action == "add" {
|
||||||
|
host, err := editHost(config.StaticHost{}, hosts, -1)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
hosts = append(hosts, host)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
verb, index, _ := strings.Cut(action, ":")
|
||||||
|
i, _ := strconv.Atoi(index)
|
||||||
|
switch verb {
|
||||||
|
case "edit":
|
||||||
|
host, err := editHost(hosts[i], hosts, i)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
hosts[i] = host
|
||||||
|
case "ssh":
|
||||||
|
options, err := editSSHOptions("SSH options for "+hosts[i].Name, hosts[i].SSH)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
hosts[i].SSH = options
|
||||||
|
case "remove":
|
||||||
|
remove := false
|
||||||
|
if err := huh.NewConfirm().Title("Remove " + hosts[i].Name + "?").Value(&remove).Run(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if remove {
|
||||||
|
hosts = append(hosts[:i], hosts[i+1:]...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func editHost(host config.StaticHost, hosts []config.StaticHost, index int) (config.StaticHost, error) {
|
||||||
|
name, address, user := host.Name, host.Address, host.User
|
||||||
|
port := ""
|
||||||
|
if host.Port > 0 {
|
||||||
|
port = strconv.Itoa(host.Port)
|
||||||
|
}
|
||||||
|
tags := strings.Join(host.Tags, ", ")
|
||||||
|
candidate := func() config.StaticHost {
|
||||||
|
out := host
|
||||||
|
out.Name = strings.TrimSpace(name)
|
||||||
|
out.Address = strings.TrimSpace(address)
|
||||||
|
out.User = strings.TrimSpace(user)
|
||||||
|
out.Port, _ = strconv.Atoi(strings.TrimSpace(port))
|
||||||
|
out.Tags = splitList(tags)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
// huh validates the typed value before storing it, so each validator
|
||||||
|
// checks the host with its own field taken from the argument.
|
||||||
|
validate := func(set func(*config.StaticHost, string)) func(string) error {
|
||||||
|
return func(value string) error {
|
||||||
|
h := candidate()
|
||||||
|
set(&h, strings.TrimSpace(value))
|
||||||
|
return validateHostIn(h, hosts, index)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
err := huh.NewForm(huh.NewGroup(
|
||||||
|
huh.NewInput().Title("Name").Description("What you type: netssh NAME. Letters, digits, dots, hyphens.").Value(&name).
|
||||||
|
Validate(validate(func(h *config.StaticHost, v string) { h.Name = v })),
|
||||||
|
huh.NewInput().Title("Address").Description("IP address or DNS name to connect to.").Value(&address).
|
||||||
|
Validate(validate(func(h *config.StaticHost, v string) {
|
||||||
|
h.Address = v
|
||||||
|
if v == "" {
|
||||||
|
h.Address = "-" // required: reported as invalid address
|
||||||
|
}
|
||||||
|
})),
|
||||||
|
huh.NewInput().Title("User").Description("Leave empty for ssh.default_user.").Value(&user).
|
||||||
|
Validate(validate(func(h *config.StaticHost, v string) { h.User = v })),
|
||||||
|
huh.NewInput().Title("Port").Description("Leave empty for ssh.default_port or 22.").Value(&port).Validate(func(s string) error {
|
||||||
|
if s = strings.TrimSpace(s); s == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if n, err := strconv.Atoi(s); err != nil || n < 1 || n > 65535 {
|
||||||
|
return fmt.Errorf("must be a port number between 1 and 65535")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}),
|
||||||
|
huh.NewInput().Title("Tags").Description("Comma-separated, for ssh.rules match: {tag: …}.").Value(&tags),
|
||||||
|
).Title("Static host")).Run()
|
||||||
|
if err != nil {
|
||||||
|
return host, err
|
||||||
|
}
|
||||||
|
return candidate(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// validateHostIn checks host as entry index of hosts (-1 for a new host).
|
||||||
|
func validateHostIn(host config.StaticHost, hosts []config.StaticHost, index int) error {
|
||||||
|
others := make([]config.StaticHost, 0, len(hosts)+1)
|
||||||
|
for i, other := range hosts {
|
||||||
|
if i != index {
|
||||||
|
others = append(others, other)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if host.Address == "" {
|
||||||
|
host.Address = "placeholder" // reported once the address field is filled
|
||||||
|
}
|
||||||
|
return (&config.Config{Hosts: append(others, host)}).ValidateHosts()
|
||||||
|
}
|
||||||
@@ -20,6 +20,18 @@ func configureInstances(cfg *config.Config) ([]config.NetBoxConfig, error) {
|
|||||||
}
|
}
|
||||||
for {
|
for {
|
||||||
if len(sources) == 0 {
|
if len(sources) == 0 {
|
||||||
|
choice := "add"
|
||||||
|
err := huh.NewForm(huh.NewGroup(huh.NewSelect[string]().
|
||||||
|
Title("NetBox").
|
||||||
|
Description("netssh looks up hosts in NetBox. Without NetBox, only static hosts (configured next) are available.").
|
||||||
|
Options(huh.NewOption("Add a NetBox instance", "add"), huh.NewOption("Continue without NetBox (static hosts only)", "none")).
|
||||||
|
Value(&choice))).Run()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if choice == "none" {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
source, err := editInstance(config.NetBoxConfig{Name: "default"}, sources, "")
|
source, err := editInstance(config.NetBoxConfig{Name: "default"}, sources, "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -30,6 +42,7 @@ func configureInstances(cfg *config.Config) ([]config.NetBoxConfig, error) {
|
|||||||
var options []huh.Option[string]
|
var options []huh.Option[string]
|
||||||
for _, source := range sources {
|
for _, source := range sources {
|
||||||
options = append(options, huh.NewOption("Edit "+source.Name+" ("+source.URL+")", "edit:"+source.Name))
|
options = append(options, huh.NewOption("Edit "+source.Name+" ("+source.URL+")", "edit:"+source.Name))
|
||||||
|
options = append(options, huh.NewOption("SSH options for "+source.Name, "ssh:"+source.Name))
|
||||||
options = append(options, huh.NewOption("Remove "+source.Name, "remove:"+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"))
|
options = append(options, huh.NewOption("Add another NetBox", "add"), huh.NewOption("Continue with these instances", "done"))
|
||||||
@@ -53,13 +66,20 @@ func configureInstances(cfg *config.Config) ([]config.NetBoxConfig, error) {
|
|||||||
if source.Name != name {
|
if source.Name != name {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
if verb == "edit" {
|
switch verb {
|
||||||
|
case "edit":
|
||||||
edited, err := editInstance(source, sources, name)
|
edited, err := editInstance(source, sources, name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
sources[i] = edited
|
sources[i] = edited
|
||||||
} else {
|
case "ssh":
|
||||||
|
options, err := editSSHOptions("SSH options for "+name, source.SSH)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
sources[i].SSH = options
|
||||||
|
default:
|
||||||
remove := false
|
remove := false
|
||||||
if err := huh.NewConfirm().Title("Remove " + name + "?").Value(&remove).Run(); err != nil {
|
if err := huh.NewConfirm().Title("Remove " + name + "?").Value(&remove).Run(); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -88,6 +108,9 @@ func editInstance(source config.NetBoxConfig, sources []config.NetBoxConfig, ori
|
|||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}),
|
}),
|
||||||
|
huh.NewConfirm().Title("Hide instance prefix in aliases and TUI?").
|
||||||
|
Description("Shorter shell aliases and TUI host names. Conflicting names keep their prefix.").
|
||||||
|
Value(&source.DisablePrefix),
|
||||||
huh.NewInput().Title("NetBox URL").Placeholder("https://netbox.example.com").Value(&source.URL).Validate(func(value string) error {
|
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()
|
return (&config.Config{NetBoxes: []config.NetBoxConfig{{Name: "instance", URL: strings.TrimSpace(value)}}}).ValidateNetBoxes()
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -0,0 +1,128 @@
|
|||||||
|
package setup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"charm.land/huh/v2"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func editMulti(cfg *config.Config) error {
|
||||||
|
multiplexer := cfg.Multi.Multiplexer
|
||||||
|
if multiplexer == "" {
|
||||||
|
multiplexer = "auto"
|
||||||
|
}
|
||||||
|
perWindow := ""
|
||||||
|
if cfg.Multi.PanesPerWindow > 0 {
|
||||||
|
perWindow = strconv.Itoa(cfg.Multi.PanesPerWindow)
|
||||||
|
}
|
||||||
|
groups := formatGroups(cfg.Groups)
|
||||||
|
syncKey, soloKey := cfg.Multi.SyncKey, cfg.Multi.SoloKey
|
||||||
|
validKey := func(field string) func(string) error {
|
||||||
|
return func(s string) error {
|
||||||
|
candidate := config.Config{Multi: cfg.Multi}
|
||||||
|
if field == "sync" {
|
||||||
|
candidate.Multi.SyncKey = strings.TrimSpace(s)
|
||||||
|
} else {
|
||||||
|
candidate.Multi.SoloKey = strings.TrimSpace(s)
|
||||||
|
}
|
||||||
|
return candidate.ValidateMulti()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
err := huh.NewForm(huh.NewGroup(
|
||||||
|
huh.NewSelect[string]().
|
||||||
|
Title("Multiplexer").
|
||||||
|
Description("netssh multi opens hosts side by side. auto uses the one you are in, else tmux, else zellij.").
|
||||||
|
Options(huh.NewOption("auto", "auto"), huh.NewOption("tmux", "tmux"), huh.NewOption("zellij", "zellij")).
|
||||||
|
Value(&multiplexer),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Panes per window").
|
||||||
|
Description(fmt.Sprintf("More hosts open in further windows or tabs. Leave empty for %d.", config.DefaultPanesPerWindow)).
|
||||||
|
Value(&perWindow).
|
||||||
|
Validate(func(s string) error {
|
||||||
|
if s = strings.TrimSpace(s); s == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if n, err := strconv.Atoi(s); err != nil || n < 1 || n > 64 {
|
||||||
|
return errors.New("must be a number between 1 and 64")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("tmux key: broadcast to all panes").
|
||||||
|
Description(fmt.Sprintf("Pressed after the tmux prefix. Empty = %s, none = no key.", config.DefaultSyncKey)).
|
||||||
|
Placeholder(config.DefaultSyncKey).
|
||||||
|
Value(&syncKey).
|
||||||
|
Validate(validKey("sync")),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("tmux key: exclude/include this pane").
|
||||||
|
Description(fmt.Sprintf("Pressed after the tmux prefix. Empty = %s, none = no key.", config.DefaultSoloKey)).
|
||||||
|
Placeholder(config.DefaultSoloKey).
|
||||||
|
Value(&soloKey).
|
||||||
|
Validate(validKey("solo")),
|
||||||
|
huh.NewText().
|
||||||
|
Title("Groups").
|
||||||
|
Description("One per line: NAME: host, tag:TAG, cluster:NAME, @other — open with netssh multi @NAME.").
|
||||||
|
Lines(4).
|
||||||
|
Value(&groups).
|
||||||
|
Validate(func(s string) error {
|
||||||
|
_, err := parseGroups(s)
|
||||||
|
return err
|
||||||
|
}),
|
||||||
|
).Title("Multi-session")).Run()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cfg.Multi.Multiplexer = multiplexer
|
||||||
|
if multiplexer == "auto" {
|
||||||
|
cfg.Multi.Multiplexer = ""
|
||||||
|
}
|
||||||
|
cfg.Multi.PanesPerWindow, _ = strconv.Atoi(strings.TrimSpace(perWindow))
|
||||||
|
cfg.Multi.SyncKey = strings.TrimSpace(syncKey)
|
||||||
|
cfg.Multi.SoloKey = strings.TrimSpace(soloKey)
|
||||||
|
cfg.Groups, _ = parseGroups(groups)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseGroups reads "NAME: sel1, sel2" lines into groups:.
|
||||||
|
func parseGroups(s string) (map[string][]string, error) {
|
||||||
|
var out map[string][]string
|
||||||
|
for _, line := range parseLines(s) {
|
||||||
|
name, members, ok := strings.Cut(line, ":")
|
||||||
|
name = strings.ToLower(strings.TrimSpace(name))
|
||||||
|
// "tag:x" alone has no group name before the first colon worth keeping.
|
||||||
|
if !ok || name == "" || name == "tag" || name == "cluster" {
|
||||||
|
return nil, fmt.Errorf("%q: expected NAME: host, tag:TAG, …", line)
|
||||||
|
}
|
||||||
|
var selectors []string
|
||||||
|
for _, field := range strings.FieldsFunc(members, func(r rune) bool { return r == ',' || r == ' ' || r == '\t' }) {
|
||||||
|
selectors = append(selectors, field)
|
||||||
|
}
|
||||||
|
if out == nil {
|
||||||
|
out = make(map[string][]string)
|
||||||
|
}
|
||||||
|
out[name] = append(out[name], selectors...)
|
||||||
|
}
|
||||||
|
if err := (&config.Config{Groups: out}).ValidateMulti(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func formatGroups(groups map[string][]string) string {
|
||||||
|
names := make([]string, 0, len(groups))
|
||||||
|
for name := range groups {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
lines := make([]string, 0, len(names))
|
||||||
|
for _, name := range names {
|
||||||
|
lines = append(lines, name+": "+strings.Join(groups[name], ", "))
|
||||||
|
}
|
||||||
|
return strings.Join(lines, "\n")
|
||||||
|
}
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
package setup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
|
||||||
|
"charm.land/huh/v2"
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func editOperations(cfg *config.Config) error {
|
||||||
|
history, days, entries := strconv.Itoa(cfg.TUI.HistoryLimit), strconv.Itoa(cfg.Activity.RetentionDays), strconv.Itoa(cfg.Activity.MaxEntries)
|
||||||
|
enabled := cfg.Activity.Enabled
|
||||||
|
valid := func(s string) error {
|
||||||
|
n, err := strconv.Atoi(s)
|
||||||
|
if err != nil || n < 0 {
|
||||||
|
return fmt.Errorf("enter a non-negative number")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
err := huh.NewForm(huh.NewGroup(
|
||||||
|
huh.NewInput().Title("Recent hosts shown").Description("10 by default; 0 shows all. Favorites are additional.").Value(&history).Validate(valid),
|
||||||
|
huh.NewConfirm().Title("Record local action history?").Description("Stores host, command name, duration and exit code; no arguments or output.").Value(&enabled),
|
||||||
|
huh.NewInput().Title("Retention in days").Description("0 = no age limit").Value(&days).Validate(valid),
|
||||||
|
huh.NewInput().Title("Maximum recorded actions").Description("0 = no count limit").Value(&entries).Validate(valid),
|
||||||
|
).Title("History & activity")).Run()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cfg.TUI.HistoryLimit, _ = strconv.Atoi(history)
|
||||||
|
cfg.Activity.RetentionDays, _ = strconv.Atoi(days)
|
||||||
|
cfg.Activity.MaxEntries, _ = strconv.Atoi(entries)
|
||||||
|
cfg.Activity.Enabled = enabled
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,297 @@
|
|||||||
|
package setup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"charm.land/huh/v2"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
// inheritOption leaves a setting empty so a broader layer (or ssh itself) decides.
|
||||||
|
func inheritOption() huh.Option[string] { return huh.NewOption("(inherit)", "") }
|
||||||
|
|
||||||
|
// editSSHOptions edits one SSH option layer: global, per instance, or per rule.
|
||||||
|
func editSSHOptions(title string, o config.SSHOptions) (config.SSHOptions, error) {
|
||||||
|
proxyJump := o.ProxyJump
|
||||||
|
hostKeyChecking := o.HostKeyChecking
|
||||||
|
target := o.Target
|
||||||
|
addressFamily := o.AddressFamily
|
||||||
|
extraArgs := strings.Join(o.ExtraArgs, "\n")
|
||||||
|
options := formatOptions(o.Options)
|
||||||
|
forwards := formatForwards(o.Forwards)
|
||||||
|
preConnect := o.PreConnect
|
||||||
|
postDisconnect := o.PostDisconnect
|
||||||
|
|
||||||
|
err := huh.NewForm(huh.NewGroup(
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Jump host").
|
||||||
|
Description("Passed as -J, e.g. admin@bastion.example.com.\nLeave empty to inherit; 'none' disables a jump host set elsewhere.").
|
||||||
|
Value(&proxyJump).
|
||||||
|
Validate(func(s string) error {
|
||||||
|
return config.SSHOptions{ProxyJump: strings.TrimSpace(s)}.Validate("ssh")
|
||||||
|
}),
|
||||||
|
huh.NewSelect[string]().
|
||||||
|
Title("Host key checking").
|
||||||
|
Options(inheritOption(), huh.NewOption("strict", "strict"), huh.NewOption("accept-new", "accept-new"), huh.NewOption("off", "off")).
|
||||||
|
Value(&hostKeyChecking),
|
||||||
|
huh.NewSelect[string]().
|
||||||
|
Title("Connection target").
|
||||||
|
Description("What is passed to ssh as destination.").
|
||||||
|
Options(inheritOption(), huh.NewOption("ip — resolved address", "ip"), huh.NewOption("name — NetBox name", "name"), huh.NewOption("hostname — name as typed", "hostname")).
|
||||||
|
Value(&target),
|
||||||
|
huh.NewSelect[string]().
|
||||||
|
Title("Address family").
|
||||||
|
Options(inheritOption(), huh.NewOption("any", "any"), huh.NewOption("inet (IPv4)", "inet"), huh.NewOption("inet6 (IPv6)", "inet6")).
|
||||||
|
Value(&addressFamily),
|
||||||
|
huh.NewText().
|
||||||
|
Title("Extra arguments").
|
||||||
|
Description("One argument per line, inserted before the destination, e.g. -A").
|
||||||
|
Lines(3).
|
||||||
|
Value(&extraArgs),
|
||||||
|
huh.NewText().
|
||||||
|
Title("SSH options").
|
||||||
|
Description("One Key=Value per line, passed as -o, e.g. ServerAliveInterval=60").
|
||||||
|
Lines(4).
|
||||||
|
Value(&options).
|
||||||
|
Validate(func(s string) error {
|
||||||
|
_, err := parseOptions(s)
|
||||||
|
return err
|
||||||
|
}),
|
||||||
|
huh.NewText().
|
||||||
|
Title("Port forwards").
|
||||||
|
Description("One per line: NAME L|R|D SPEC, e.g. web L 8080:localhost:80 or socks D 1080.\n"+
|
||||||
|
"Use with netssh tunnel HOST NAME or netssh --forward NAME HOST.").
|
||||||
|
Lines(3).
|
||||||
|
Value(&forwards).
|
||||||
|
Validate(func(s string) error {
|
||||||
|
_, err := parseForwards(s)
|
||||||
|
return err
|
||||||
|
}),
|
||||||
|
huh.NewInput().Title("Post-disconnect script").Description("Local command after the client exits; none disables inheritance.").Value(&postDisconnect),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Pre-connect hook").
|
||||||
|
Description("Shell command run locally before connecting, e.g. vpn-check.sh \"$NETSSH_HOST\".\n"+
|
||||||
|
"A non-zero exit aborts. Leave empty to inherit; 'none' disables a hook set elsewhere.").
|
||||||
|
Value(&preConnect).
|
||||||
|
Validate(func(s string) error {
|
||||||
|
return config.SSHOptions{PreConnect: s}.Validate("ssh")
|
||||||
|
}),
|
||||||
|
).Title(title)).Run()
|
||||||
|
if err != nil {
|
||||||
|
return o, err
|
||||||
|
}
|
||||||
|
|
||||||
|
parsed, _ := parseOptions(options)
|
||||||
|
parsedForwards, _ := parseForwards(forwards)
|
||||||
|
return config.SSHOptions{
|
||||||
|
Forwards: parsedForwards,
|
||||||
|
ProxyJump: strings.TrimSpace(proxyJump),
|
||||||
|
HostKeyChecking: hostKeyChecking,
|
||||||
|
Target: target,
|
||||||
|
AddressFamily: addressFamily,
|
||||||
|
ExtraArgs: parseLines(extraArgs),
|
||||||
|
Options: parsed,
|
||||||
|
PreConnect: strings.TrimSpace(preConnect),
|
||||||
|
PostDisconnect: strings.TrimSpace(postDisconnect),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseLines returns the non-empty, trimmed lines of s.
|
||||||
|
func parseLines(s string) []string {
|
||||||
|
var out []string
|
||||||
|
for _, line := range strings.Split(s, "\n") {
|
||||||
|
if line = strings.TrimSpace(line); line != "" {
|
||||||
|
out = append(out, line)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseOptions reads Key=Value lines into the map stored under ssh.options.
|
||||||
|
func parseOptions(s string) (map[string]string, error) {
|
||||||
|
var out map[string]string
|
||||||
|
for _, line := range parseLines(s) {
|
||||||
|
key, value, ok := strings.Cut(line, "=")
|
||||||
|
key = strings.TrimSpace(key)
|
||||||
|
if !ok || key == "" {
|
||||||
|
return nil, fmt.Errorf("%q: expected Key=Value", line)
|
||||||
|
}
|
||||||
|
if out == nil {
|
||||||
|
out = make(map[string]string)
|
||||||
|
}
|
||||||
|
out[key] = strings.TrimSpace(value)
|
||||||
|
}
|
||||||
|
if err := (config.SSHOptions{Options: out}).Validate("ssh"); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// forwardKinds maps the letters used in the form to the ssh flags.
|
||||||
|
var forwardKinds = map[string]func(spec string) config.Forward{
|
||||||
|
"L": func(spec string) config.Forward { return config.Forward{Local: spec} },
|
||||||
|
"R": func(spec string) config.Forward { return config.Forward{Remote: spec} },
|
||||||
|
"D": func(spec string) config.Forward { return config.Forward{Dynamic: spec} },
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseForwards reads "NAME L|R|D SPEC" lines into ssh.forwards.
|
||||||
|
func parseForwards(s string) (map[string]config.Forward, error) {
|
||||||
|
var out map[string]config.Forward
|
||||||
|
for _, line := range parseLines(s) {
|
||||||
|
fields := strings.Fields(line)
|
||||||
|
if len(fields) != 3 || forwardKinds[strings.ToUpper(fields[1])] == nil {
|
||||||
|
return nil, fmt.Errorf("%q: expected NAME L|R|D SPEC", line)
|
||||||
|
}
|
||||||
|
if out == nil {
|
||||||
|
out = make(map[string]config.Forward)
|
||||||
|
}
|
||||||
|
out[strings.ToLower(fields[0])] = forwardKinds[strings.ToUpper(fields[1])](fields[2])
|
||||||
|
}
|
||||||
|
if err := (config.SSHOptions{Forwards: out}).Validate("ssh"); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func formatForwards(forwards map[string]config.Forward) string {
|
||||||
|
names := make([]string, 0, len(forwards))
|
||||||
|
for name := range forwards {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
lines := make([]string, 0, len(names))
|
||||||
|
for _, name := range names {
|
||||||
|
flag := forwards[name].Flag()
|
||||||
|
if len(flag) == 2 {
|
||||||
|
lines = append(lines, name+" "+strings.TrimPrefix(flag[0], "-")+" "+flag[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return strings.Join(lines, "\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
func formatOptions(options map[string]string) string {
|
||||||
|
keys := make([]string, 0, len(options))
|
||||||
|
for key := range options {
|
||||||
|
keys = append(keys, key)
|
||||||
|
}
|
||||||
|
sort.Strings(keys)
|
||||||
|
lines := make([]string, 0, len(keys))
|
||||||
|
for _, key := range keys {
|
||||||
|
lines = append(lines, key+"="+options[key])
|
||||||
|
}
|
||||||
|
return strings.Join(lines, "\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
// configureRules edits a copy of the rules; the caller decides whether to keep it.
|
||||||
|
func configureRules(rules []config.SSHRule, sources []config.NetBoxConfig) ([]config.SSHRule, error) {
|
||||||
|
rules = append([]config.SSHRule(nil), rules...)
|
||||||
|
for {
|
||||||
|
action := "done"
|
||||||
|
var options []huh.Option[string]
|
||||||
|
for i, rule := range rules {
|
||||||
|
index := strconv.Itoa(i)
|
||||||
|
options = append(options, huh.NewOption("Edit rule "+describeMatch(rule.Match), "edit:"+index))
|
||||||
|
options = append(options, huh.NewOption("Remove rule "+describeMatch(rule.Match), "remove:"+index))
|
||||||
|
}
|
||||||
|
options = append(options, huh.NewOption("Add rule", "add"), huh.NewOption("Back", "done"))
|
||||||
|
err := huh.NewForm(huh.NewGroup(huh.NewSelect[string]().
|
||||||
|
Title("SSH rules").
|
||||||
|
Description("Rules apply SSH options to hosts matching every set field. Later rules win.").
|
||||||
|
Options(options...).
|
||||||
|
Value(&action))).Run()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if action == "done" {
|
||||||
|
return rules, nil
|
||||||
|
}
|
||||||
|
if action == "add" {
|
||||||
|
rule, err := editRule(config.SSHRule{}, sources)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
rules = append(rules, rule)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
verb, index, _ := strings.Cut(action, ":")
|
||||||
|
i, _ := strconv.Atoi(index)
|
||||||
|
if verb == "edit" {
|
||||||
|
rule, err := editRule(rules[i], sources)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
rules[i] = rule
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
remove := false
|
||||||
|
if err := huh.NewConfirm().Title("Remove rule " + describeMatch(rules[i].Match) + "?").Value(&remove).Run(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if remove {
|
||||||
|
rules = append(rules[:i], rules[i+1:]...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func editRule(rule config.SSHRule, sources []config.NetBoxConfig) (config.SSHRule, error) {
|
||||||
|
match := rule.Match
|
||||||
|
instances := []huh.Option[string]{huh.NewOption("(any)", "")}
|
||||||
|
known := false
|
||||||
|
for _, source := range sources {
|
||||||
|
instances = append(instances, huh.NewOption(source.Name, source.Name))
|
||||||
|
known = known || strings.EqualFold(source.Name, match.Instance)
|
||||||
|
}
|
||||||
|
if match.Instance != "" && !known {
|
||||||
|
instances = append(instances, huh.NewOption(match.Instance+" (not configured)", match.Instance))
|
||||||
|
}
|
||||||
|
|
||||||
|
err := huh.NewForm(huh.NewGroup(
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Tag").
|
||||||
|
Description("NetBox tag name or slug, e.g. dmz").
|
||||||
|
Value(&match.Tag),
|
||||||
|
huh.NewSelect[string]().
|
||||||
|
Title("Instance").
|
||||||
|
Options(instances...).
|
||||||
|
Value(&match.Instance),
|
||||||
|
huh.NewSelect[string]().
|
||||||
|
Title("Kind").
|
||||||
|
Options(huh.NewOption("(any)", ""), huh.NewOption("device", "device"), huh.NewOption("vm", "vm")).
|
||||||
|
Value(&match.Kind),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Name pattern").
|
||||||
|
Description("Shell-style glob without instance prefix, e.g. *.dmz.example.com").
|
||||||
|
Value(&match.Name).
|
||||||
|
Validate(func(s string) error {
|
||||||
|
candidate := match
|
||||||
|
candidate.Tag = strings.TrimSpace(candidate.Tag)
|
||||||
|
candidate.Name = strings.TrimSpace(s)
|
||||||
|
return candidate.Validate("rule")
|
||||||
|
}),
|
||||||
|
).Title("Rule match")).Run()
|
||||||
|
if err != nil {
|
||||||
|
return rule, err
|
||||||
|
}
|
||||||
|
match.Tag = strings.TrimSpace(match.Tag)
|
||||||
|
match.Name = strings.TrimSpace(match.Name)
|
||||||
|
|
||||||
|
options, err := editSSHOptions("SSH options for rule "+describeMatch(match), rule.SSHOptions)
|
||||||
|
if err != nil {
|
||||||
|
return rule, err
|
||||||
|
}
|
||||||
|
return config.SSHRule{Match: match, SSHOptions: options}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func describeMatch(m config.SSHMatch) string {
|
||||||
|
var parts []string
|
||||||
|
for _, field := range [][2]string{{"tag", m.Tag}, {"instance", m.Instance}, {"kind", m.Kind}, {"name", m.Name}} {
|
||||||
|
if field[1] != "" {
|
||||||
|
parts = append(parts, field[0]+"="+field[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "[" + strings.Join(parts, " ") + "]"
|
||||||
|
}
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
package setup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestParseLines(t *testing.T) {
|
||||||
|
got := parseLines(" -A \n\n\t-C\n \n")
|
||||||
|
if want := []string{"-A", "-C"}; !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("got %q, want %q", got, want)
|
||||||
|
}
|
||||||
|
if got := parseLines(" \n "); got != nil {
|
||||||
|
t.Fatalf("blank input: got %q, want nil", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseOptionsRoundtrip(t *testing.T) {
|
||||||
|
text := "ServerAliveInterval = 60\n\nForwardAgent=yes\nLocalCommand=echo a=b\n"
|
||||||
|
got, err := parseOptions(text)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := map[string]string{"ServerAliveInterval": "60", "ForwardAgent": "yes", "LocalCommand": "echo a=b"}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("got %v, want %v", got, want)
|
||||||
|
}
|
||||||
|
again, err := parseOptions(formatOptions(got))
|
||||||
|
if err != nil || !reflect.DeepEqual(again, want) {
|
||||||
|
t.Fatalf("roundtrip: got %v (%v)", again, err)
|
||||||
|
}
|
||||||
|
if formatOptions(got) != "ForwardAgent=yes\nLocalCommand=echo a=b\nServerAliveInterval=60" {
|
||||||
|
t.Fatalf("formatOptions not sorted: %q", formatOptions(got))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseOptionsEmpty(t *testing.T) {
|
||||||
|
got, err := parseOptions("\n \n")
|
||||||
|
if err != nil || got != nil {
|
||||||
|
t.Fatalf("got %v, %v; want nil, nil", got, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseOptionsInvalid(t *testing.T) {
|
||||||
|
for _, text := range []string{"ServerAliveInterval", "=60", "Bad-Key=1", "1Key=1"} {
|
||||||
|
if _, err := parseOptions(text); err == nil {
|
||||||
|
t.Errorf("%q: expected error", text)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDescribeMatch(t *testing.T) {
|
||||||
|
got := describeMatch(config.SSHMatch{Tag: "dmz", Name: "*.dmz"})
|
||||||
|
if got != "[tag=dmz name=*.dmz]" {
|
||||||
|
t.Fatalf("got %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRuleValidation(t *testing.T) {
|
||||||
|
if err := (config.SSHMatch{}).Validate("rule"); err == nil || !strings.Contains(err.Error(), "at least one") {
|
||||||
|
t.Fatalf("empty match: got %v", err)
|
||||||
|
}
|
||||||
|
if err := (config.SSHMatch{Name: "[web"}).Validate("rule"); err == nil {
|
||||||
|
t.Fatal("invalid glob accepted")
|
||||||
|
}
|
||||||
|
if err := (config.SSHMatch{Kind: "vm"}).Validate("rule"); err != nil {
|
||||||
|
t.Fatalf("valid match rejected: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseForwardsRoundtrip(t *testing.T) {
|
||||||
|
text := "Web L 8080:localhost:80\n\nsocks d 1080\nback R 9000:localhost:9000\n"
|
||||||
|
got, err := parseForwards(text)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := map[string]config.Forward{"web": {Local: "8080:localhost:80"}, "socks": {Dynamic: "1080"}, "back": {Remote: "9000:localhost:9000"}}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("got %+v", got)
|
||||||
|
}
|
||||||
|
if formatForwards(got) != "back R 9000:localhost:9000\nsocks D 1080\nweb L 8080:localhost:80" {
|
||||||
|
t.Fatalf("format: %q", formatForwards(got))
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"web 8080:localhost:80", "web X 8080", "web L -oFoo", "bad/name L 1:a:2"} {
|
||||||
|
if _, err := parseForwards(bad); err == nil {
|
||||||
|
t.Errorf("%q accepted", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+433
-166
@@ -17,170 +17,26 @@ import (
|
|||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/storage"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/storage"
|
||||||
)
|
)
|
||||||
|
|
||||||
// RunWizard runs the interactive setup form, pre-filled with any existing cfg values.
|
// RunWizard runs the interactive configurator, pre-filled with any existing cfg values.
|
||||||
// It saves the result to the config file on success.
|
// It saves the result to the config file on success.
|
||||||
func RunWizard(cfg *config.Config) error {
|
func RunWizard(cfg *config.Config) error {
|
||||||
sources, err := configureInstances(cfg)
|
sources, err := configureInstances(cfg)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if errors.Is(err, huh.ErrUserAborted) {
|
return cancelled(err)
|
||||||
fmt.Fprintln(os.Stderr, "Setup cancelled.")
|
|
||||||
os.Exit(0)
|
|
||||||
}
|
}
|
||||||
return err
|
work := prepare(*cfg, sources)
|
||||||
}
|
if err := runMenu(&work); err != nil {
|
||||||
defaultUser := cfg.SSH.DefaultUser
|
return cancelled(err)
|
||||||
defaultPort := ""
|
|
||||||
if cfg.SSH.DefaultPort > 0 {
|
|
||||||
defaultPort = strconv.Itoa(cfg.SSH.DefaultPort)
|
|
||||||
}
|
|
||||||
strategiesRaw := strings.Join(cfg.Resolver.Strategies, ", ")
|
|
||||||
subnets := strings.Join(cfg.Resolver.ManagementSubnets, ", ")
|
|
||||||
interfaceName := cfg.Resolver.InterfaceName
|
|
||||||
cacheTTL := strconv.Itoa(cfg.Cache.TTL)
|
|
||||||
shortcutDomains := strings.Join(cfg.Shortcuts.Domains, ", ")
|
|
||||||
stripHyphens := cfg.Shortcuts.StripHyphens
|
|
||||||
commandAlias := cfg.Shell.Alias
|
|
||||||
|
|
||||||
if strategiesRaw == "" {
|
|
||||||
strategiesRaw = "primary_ip"
|
|
||||||
}
|
|
||||||
if cacheTTL == "0" {
|
|
||||||
cacheTTL = "3600"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
form := huh.NewForm(
|
if err := save(work); err != nil {
|
||||||
huh.NewGroup(
|
|
||||||
huh.NewInput().
|
|
||||||
Title("Default SSH user").
|
|
||||||
Description("Leave empty to use your system user ($USER).").
|
|
||||||
Value(&defaultUser),
|
|
||||||
huh.NewInput().
|
|
||||||
Title("Default SSH port").
|
|
||||||
Description("Leave empty to use the standard port (22).").
|
|
||||||
Placeholder("22").
|
|
||||||
Value(&defaultPort).
|
|
||||||
Validate(func(s string) error {
|
|
||||||
if strings.TrimSpace(s) == "" {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
n, err := strconv.Atoi(strings.TrimSpace(s))
|
|
||||||
if err != nil || n < 1 || n > 65535 {
|
|
||||||
return errors.New("must be a port number between 1 and 65535")
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}),
|
|
||||||
).Title("SSH defaults"),
|
|
||||||
|
|
||||||
huh.NewGroup(
|
|
||||||
huh.NewInput().
|
|
||||||
Title("Resolver strategies").
|
|
||||||
Description("Comma-separated, in priority order. First match wins.\nAvailable: primary_ip, management_subnet, interface_name").
|
|
||||||
Placeholder("primary_ip, management_subnet").
|
|
||||||
Value(&strategiesRaw).
|
|
||||||
Validate(validateStrategies),
|
|
||||||
huh.NewInput().
|
|
||||||
Title("Management subnets").
|
|
||||||
Description("Comma-separated CIDRs, e.g. 10.0.0.0/8, 192.168.0.0/16\nOnly used when management_subnet strategy is active.").
|
|
||||||
Value(&subnets),
|
|
||||||
huh.NewInput().
|
|
||||||
Title("Interface name").
|
|
||||||
Description("Only used when interface_name strategy is active.").
|
|
||||||
Placeholder("eth0").
|
|
||||||
Value(&interfaceName),
|
|
||||||
huh.NewInput().
|
|
||||||
Title("Cache TTL (seconds)").
|
|
||||||
Value(&cacheTTL).
|
|
||||||
Validate(func(s string) error {
|
|
||||||
if _, err := strconv.Atoi(s); err != nil {
|
|
||||||
return errors.New("must be a number")
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}),
|
|
||||||
).Title("Resolver & cache"),
|
|
||||||
|
|
||||||
huh.NewGroup(
|
|
||||||
huh.NewInput().
|
|
||||||
Title("Domain suffixes").
|
|
||||||
Description("Comma-separated suffixes stripped for shortcuts, e.g. .example.com, .example.de\nAllows typing 'web01' instead of 'web01.example.com'.").
|
|
||||||
Placeholder(".example.com").
|
|
||||||
Value(&shortcutDomains),
|
|
||||||
huh.NewConfirm().
|
|
||||||
Title("Strip hyphens").
|
|
||||||
Description("When enabled, fsn1-web01.example.com can be accessed as fsn1web01.\nOnly works for hosts already in the cache.").
|
|
||||||
Value(&stripHyphens),
|
|
||||||
huh.NewInput().
|
|
||||||
Title("Command alias").
|
|
||||||
Description("Optional alias for netssh itself, e.g. j. Leave empty to disable.").
|
|
||||||
Placeholder("j").
|
|
||||||
Value(&commandAlias).
|
|
||||||
Validate(func(s string) error { return config.ValidateCommandAlias(strings.TrimSpace(s)) }),
|
|
||||||
).Title("Shortcuts"),
|
|
||||||
)
|
|
||||||
|
|
||||||
if err := form.Run(); err != nil {
|
|
||||||
if errors.Is(err, huh.ErrUserAborted) {
|
|
||||||
fmt.Fprintln(os.Stderr, "Setup cancelled.")
|
|
||||||
os.Exit(0)
|
|
||||||
}
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
strategies := parseStrategies(strategiesRaw)
|
|
||||||
|
|
||||||
ttl, _ := strconv.Atoi(cacheTTL)
|
|
||||||
|
|
||||||
port := 0
|
|
||||||
if p, err := strconv.Atoi(strings.TrimSpace(defaultPort)); err == nil {
|
|
||||||
port = p
|
|
||||||
}
|
|
||||||
|
|
||||||
var subnetList []string
|
|
||||||
for _, s := range strings.Split(subnets, ",") {
|
|
||||||
if s = strings.TrimSpace(s); s != "" {
|
|
||||||
subnetList = append(subnetList, s)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var domainList []string
|
|
||||||
for _, s := range strings.Split(shortcutDomains, ",") {
|
|
||||||
if s = strings.TrimSpace(s); s != "" {
|
|
||||||
if !strings.HasPrefix(s, ".") {
|
|
||||||
s = "." + s
|
|
||||||
}
|
|
||||||
domainList = append(domainList, s)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
out := config.Config{
|
|
||||||
Shell: config.ShellConfig{Alias: strings.TrimSpace(commandAlias)},
|
|
||||||
NetBoxes: sources,
|
|
||||||
SSH: config.SSHConfig{
|
|
||||||
DefaultUser: strings.TrimSpace(defaultUser),
|
|
||||||
DefaultPort: port,
|
|
||||||
},
|
|
||||||
Resolver: config.ResolverConfig{
|
|
||||||
Strategies: strategies,
|
|
||||||
ManagementSubnets: subnetList,
|
|
||||||
InterfaceName: strings.TrimSpace(interfaceName),
|
|
||||||
},
|
|
||||||
Cache: config.CacheConfig{
|
|
||||||
TTL: ttl,
|
|
||||||
Path: cfg.Cache.Path,
|
|
||||||
},
|
|
||||||
Shortcuts: config.ShortcutsConfig{
|
|
||||||
Domains: domainList,
|
|
||||||
StripHyphens: stripHyphens,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := save(out); err != nil {
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
loaded, err := config.Load()
|
loaded, err := config.Load()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
c := cache.New(loaded.CachePath(), loaded.Cache.TTL)
|
c := cache.New(loaded.CachePath(), loaded.Cache.TTL).WithStatic(loaded.Hosts)
|
||||||
if err := c.Load(); err != nil {
|
if err := c.Load(); err != nil {
|
||||||
return fmt.Errorf("updating aliases: %w", err)
|
return fmt.Errorf("updating aliases: %w", err)
|
||||||
}
|
}
|
||||||
@@ -202,10 +58,298 @@ func RunWizard(cfg *config.Config) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func cancelled(err error) error {
|
||||||
|
if errors.Is(err, huh.ErrUserAborted) {
|
||||||
|
fmt.Fprintln(os.Stderr, "Setup cancelled.")
|
||||||
|
os.Exit(0)
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// prepare starts from the loaded config so settings without a menu entry survive
|
||||||
|
// a rewrite, migrates a legacy single instance, and fills in usable defaults.
|
||||||
|
func prepare(cfg config.Config, sources []config.NetBoxConfig) config.Config {
|
||||||
|
cfg.NetBox = config.NetBoxConfig{}
|
||||||
|
cfg.NetBoxes = sources
|
||||||
|
if len(cfg.Resolver.Strategies) == 0 {
|
||||||
|
cfg.Resolver.Strategies = []string{"primary_ip"}
|
||||||
|
}
|
||||||
|
if cfg.Cache.TTL == 0 {
|
||||||
|
cfg.Cache.TTL = 3600
|
||||||
|
}
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
func runMenu(cfg *config.Config) error {
|
||||||
|
for {
|
||||||
|
action := "save"
|
||||||
|
err := huh.NewForm(huh.NewGroup(huh.NewSelect[string]().
|
||||||
|
Title("netssh configuration").
|
||||||
|
Description("Choose a section to edit, then save.").
|
||||||
|
Options(
|
||||||
|
huh.NewOption("SSH defaults — user, port", "defaults"),
|
||||||
|
huh.NewOption("SSH options — jump host, host keys, target, -o, forwards", "ssh"),
|
||||||
|
huh.NewOption(fmt.Sprintf("SSH rules — per tag, instance, kind, name (%d)", len(cfg.SSH.Rules)), "rules"),
|
||||||
|
huh.NewOption(fmt.Sprintf("Static hosts — hosts not in NetBox (%d)", len(cfg.Hosts)), "hosts"),
|
||||||
|
huh.NewOption(fmt.Sprintf("Multi-session — groups, tmux/zellij (%d groups)", len(cfg.Groups)), "multi"),
|
||||||
|
huh.NewOption("Resolver & cache", "resolver"),
|
||||||
|
huh.NewOption("Shortcuts & command alias", "shortcuts"),
|
||||||
|
huh.NewOption("Custom commands — mtr, ping, scripts", "commands"),
|
||||||
|
huh.NewOption("History & activity logging", "operations"),
|
||||||
|
huh.NewOption("Completion", "completion"),
|
||||||
|
huh.NewOption("Save and exit", "save"),
|
||||||
|
).
|
||||||
|
Value(&action))).Run()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
switch action {
|
||||||
|
case "defaults":
|
||||||
|
err = editSSHDefaults(cfg)
|
||||||
|
case "ssh":
|
||||||
|
cfg.SSH.SSHOptions, err = editSSHOptions("SSH options (all hosts)", cfg.SSH.SSHOptions)
|
||||||
|
case "rules":
|
||||||
|
var rules []config.SSHRule
|
||||||
|
if rules, err = configureRules(cfg.SSH.Rules, cfg.NetBoxes); err == nil {
|
||||||
|
cfg.SSH.Rules = rules
|
||||||
|
}
|
||||||
|
case "hosts":
|
||||||
|
var hosts []config.StaticHost
|
||||||
|
if hosts, err = configureHosts(cfg.Hosts); err == nil {
|
||||||
|
cfg.Hosts = hosts
|
||||||
|
}
|
||||||
|
case "multi":
|
||||||
|
err = editMulti(cfg)
|
||||||
|
case "resolver":
|
||||||
|
err = editResolverCache(cfg)
|
||||||
|
case "shortcuts":
|
||||||
|
err = editShortcuts(cfg)
|
||||||
|
case "commands":
|
||||||
|
err = editCommands(cfg)
|
||||||
|
case "operations":
|
||||||
|
err = editOperations(cfg)
|
||||||
|
case "completion":
|
||||||
|
err = editCompletion(cfg)
|
||||||
|
case "save":
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func editSSHDefaults(cfg *config.Config) error {
|
||||||
|
defaultUser := cfg.SSH.DefaultUser
|
||||||
|
defaultPort := ""
|
||||||
|
if cfg.SSH.DefaultPort > 0 {
|
||||||
|
defaultPort = strconv.Itoa(cfg.SSH.DefaultPort)
|
||||||
|
}
|
||||||
|
err := huh.NewForm(huh.NewGroup(
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Default SSH user").
|
||||||
|
Description("Leave empty to use your system user ($USER).").
|
||||||
|
Value(&defaultUser),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Default SSH port").
|
||||||
|
Description("Leave empty to use the standard port (22).").
|
||||||
|
Placeholder("22").
|
||||||
|
Value(&defaultPort).
|
||||||
|
Validate(func(s string) error {
|
||||||
|
if strings.TrimSpace(s) == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
n, err := strconv.Atoi(strings.TrimSpace(s))
|
||||||
|
if err != nil || n < 1 || n > 65535 {
|
||||||
|
return errors.New("must be a port number between 1 and 65535")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}),
|
||||||
|
).Title("SSH defaults")).Run()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cfg.SSH.DefaultUser = strings.TrimSpace(defaultUser)
|
||||||
|
cfg.SSH.DefaultPort, _ = strconv.Atoi(strings.TrimSpace(defaultPort))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func editResolverCache(cfg *config.Config) error {
|
||||||
|
strategiesRaw := strings.Join(cfg.Resolver.Strategies, ", ")
|
||||||
|
subnets := strings.Join(cfg.Resolver.ManagementSubnets, ", ")
|
||||||
|
interfaceName := cfg.Resolver.InterfaceName
|
||||||
|
hostnameDomain := cfg.Resolver.HostnameDomain
|
||||||
|
cacheTTL := strconv.Itoa(cfg.Cache.TTL)
|
||||||
|
cachePath := cfg.Cache.Path
|
||||||
|
err := huh.NewForm(huh.NewGroup(
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Resolver strategies").
|
||||||
|
Description("Comma-separated, in priority order. First match wins.\nAvailable: primary_ip, management_subnet, interface_name, hostname").
|
||||||
|
Placeholder("primary_ip, management_subnet").
|
||||||
|
Value(&strategiesRaw).
|
||||||
|
Validate(validateStrategies),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Management subnets").
|
||||||
|
Description("Comma-separated CIDRs, e.g. 10.0.0.0/8, 192.168.0.0/16\nOnly used when management_subnet strategy is active.").
|
||||||
|
Value(&subnets),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Interface name").
|
||||||
|
Description("Only used when interface_name strategy is active.").
|
||||||
|
Placeholder("eth0").
|
||||||
|
Value(&interfaceName),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Hostname domain").
|
||||||
|
Description("Only used by the hostname strategy: appended to NetBox names without a dot,\ne.g. example.com turns web01 into web01.example.com.").
|
||||||
|
Value(&hostnameDomain),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Cache TTL (seconds)").
|
||||||
|
Value(&cacheTTL).
|
||||||
|
Validate(func(s string) error {
|
||||||
|
if _, err := strconv.Atoi(s); err != nil {
|
||||||
|
return errors.New("must be a number")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Cache file").
|
||||||
|
Description("Where resolved hosts are stored. Leave empty for the default location.").
|
||||||
|
Value(&cachePath),
|
||||||
|
).Title("Resolver & cache")).Run()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cfg.Resolver.Strategies = parseStrategies(strategiesRaw)
|
||||||
|
cfg.Resolver.ManagementSubnets = splitList(subnets)
|
||||||
|
cfg.Resolver.InterfaceName = strings.TrimSpace(interfaceName)
|
||||||
|
cfg.Resolver.HostnameDomain = strings.Trim(strings.TrimSpace(hostnameDomain), ".")
|
||||||
|
cfg.Cache.TTL, _ = strconv.Atoi(cacheTTL)
|
||||||
|
cfg.Cache.Path = strings.TrimSpace(cachePath)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func editShortcuts(cfg *config.Config) error {
|
||||||
|
shortcutDomains := strings.Join(cfg.Shortcuts.Domains, ", ")
|
||||||
|
stripHyphens := cfg.Shortcuts.StripHyphens
|
||||||
|
rewrites := formatRewrites(cfg.Shortcuts.Rewrites)
|
||||||
|
commandAlias := cfg.Shell.Alias
|
||||||
|
showShortcuts := cfg.Shortcuts.Show
|
||||||
|
err := huh.NewForm(huh.NewGroup(
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Domain suffixes").
|
||||||
|
Description("Comma-separated suffixes stripped for shortcuts, e.g. .example.com, .example.de\nAllows typing 'web01' instead of 'web01.example.com'.").
|
||||||
|
Placeholder(".example.com").
|
||||||
|
Value(&shortcutDomains),
|
||||||
|
huh.NewConfirm().
|
||||||
|
Title("Strip hyphens").
|
||||||
|
Description("When enabled, fsn1-web01.example.com can be accessed as fsn1web01.\nOnly works for hosts already in the cache.").
|
||||||
|
Value(&stripHyphens),
|
||||||
|
huh.NewText().
|
||||||
|
Title("Rewrite rules").
|
||||||
|
Description("One rule per line: REGEX => REPLACEMENT, applied after the domain suffix is removed.\n"+
|
||||||
|
"Example: ^([a-z]+)[0-9]+- => $1 turns fsn1-bx1.example.com into fsnbx1.\n"+
|
||||||
|
"Check rules with: netssh alias --test HOSTNAME").
|
||||||
|
Lines(3).
|
||||||
|
Value(&rewrites).
|
||||||
|
Validate(func(s string) error {
|
||||||
|
_, err := parseRewrites(s)
|
||||||
|
return err
|
||||||
|
}),
|
||||||
|
huh.NewConfirm().
|
||||||
|
Title("Show shortcuts").
|
||||||
|
Description("Show each host's shortcut alias in the TUI, netssh cache list and netssh hosts list,\n"+
|
||||||
|
"and offer shortcuts in Tab completion even when the full name matches.").
|
||||||
|
Value(&showShortcuts),
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Command alias").
|
||||||
|
Description("Optional alias for netssh itself, e.g. j. Leave empty to disable.").
|
||||||
|
Placeholder("j").
|
||||||
|
Value(&commandAlias).
|
||||||
|
Validate(func(s string) error { return config.ValidateCommandAlias(strings.TrimSpace(s)) }),
|
||||||
|
).Title("Shortcuts")).Run()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cfg.Shortcuts.Domains = nil
|
||||||
|
for _, s := range splitList(shortcutDomains) {
|
||||||
|
if !strings.HasPrefix(s, ".") {
|
||||||
|
s = "." + s
|
||||||
|
}
|
||||||
|
cfg.Shortcuts.Domains = append(cfg.Shortcuts.Domains, s)
|
||||||
|
}
|
||||||
|
cfg.Shortcuts.StripHyphens = stripHyphens
|
||||||
|
cfg.Shortcuts.Rewrites, _ = parseRewrites(rewrites)
|
||||||
|
cfg.Shortcuts.Show = showShortcuts
|
||||||
|
cfg.Shell.Alias = strings.TrimSpace(commandAlias)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func editCompletion(cfg *config.Config) error {
|
||||||
|
maxResults := ""
|
||||||
|
if cfg.Completion.MaxResults > 0 {
|
||||||
|
maxResults = strconv.Itoa(cfg.Completion.MaxResults)
|
||||||
|
}
|
||||||
|
err := huh.NewForm(huh.NewGroup(
|
||||||
|
huh.NewInput().
|
||||||
|
Title("Maximum completion results").
|
||||||
|
Description("Limits the hostnames offered per Tab completion. Leave empty for unlimited.").
|
||||||
|
Value(&maxResults).
|
||||||
|
Validate(func(s string) error {
|
||||||
|
if strings.TrimSpace(s) == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if n, err := strconv.Atoi(strings.TrimSpace(s)); err != nil || n < 0 {
|
||||||
|
return errors.New("must be a non-negative number")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}),
|
||||||
|
).Title("Completion")).Run()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cfg.Completion.MaxResults, _ = strconv.Atoi(strings.TrimSpace(maxResults))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseRewrites reads "REGEX => REPLACEMENT" lines; the replacement may be empty.
|
||||||
|
func parseRewrites(s string) ([]config.ShortcutRewrite, error) {
|
||||||
|
var out []config.ShortcutRewrite
|
||||||
|
for _, line := range parseLines(s) {
|
||||||
|
pattern, replace, ok := strings.Cut(line, "=>")
|
||||||
|
if !ok {
|
||||||
|
return nil, fmt.Errorf("%q: expected REGEX => REPLACEMENT", line)
|
||||||
|
}
|
||||||
|
out = append(out, config.ShortcutRewrite{Pattern: strings.TrimSpace(pattern), Replace: strings.TrimSpace(replace)})
|
||||||
|
}
|
||||||
|
if err := (config.ShortcutsConfig{Rewrites: out}).Validate(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func formatRewrites(rewrites []config.ShortcutRewrite) string {
|
||||||
|
lines := make([]string, 0, len(rewrites))
|
||||||
|
for _, r := range rewrites {
|
||||||
|
lines = append(lines, r.Pattern+" => "+r.Replace)
|
||||||
|
}
|
||||||
|
return strings.Join(lines, "\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
// splitList returns the non-empty, trimmed entries of a comma-separated list.
|
||||||
|
func splitList(s string) []string {
|
||||||
|
var out []string
|
||||||
|
for _, part := range strings.Split(s, ",") {
|
||||||
|
if part = strings.TrimSpace(part); part != "" {
|
||||||
|
out = append(out, part)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
var knownStrategies = map[string]bool{
|
var knownStrategies = map[string]bool{
|
||||||
"primary_ip": true,
|
"primary_ip": true,
|
||||||
"management_subnet": true,
|
"management_subnet": true,
|
||||||
"interface_name": true,
|
"interface_name": true,
|
||||||
|
"hostname": true,
|
||||||
}
|
}
|
||||||
|
|
||||||
func validateStrategies(s string) error {
|
func validateStrategies(s string) error {
|
||||||
@@ -214,21 +358,16 @@ func validateStrategies(s string) error {
|
|||||||
}
|
}
|
||||||
for _, name := range parseStrategies(s) {
|
for _, name := range parseStrategies(s) {
|
||||||
if !knownStrategies[name] {
|
if !knownStrategies[name] {
|
||||||
return fmt.Errorf("unknown strategy %q — available: primary_ip, management_subnet, interface_name", name)
|
return fmt.Errorf("unknown strategy %q — available: primary_ip, management_subnet, interface_name, hostname", name)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func parseStrategies(s string) []string {
|
func parseStrategies(s string) []string { return splitList(s) }
|
||||||
var out []string
|
|
||||||
for _, part := range strings.Split(s, ",") {
|
// Save validates cfg and writes it to the config file, replacing the old file.
|
||||||
if name := strings.TrimSpace(part); name != "" {
|
func Save(cfg config.Config) error { return save(cfg) }
|
||||||
out = append(out, name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func save(cfg config.Config) error {
|
func save(cfg config.Config) error {
|
||||||
if err := config.ValidateCommandAlias(cfg.Shell.Alias); err != nil {
|
if err := config.ValidateCommandAlias(cfg.Shell.Alias); err != nil {
|
||||||
@@ -237,6 +376,24 @@ func save(cfg config.Config) error {
|
|||||||
if err := cfg.ValidateNetBoxes(); err != nil {
|
if err := cfg.ValidateNetBoxes(); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
if err := cfg.ValidateSSH(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := cfg.Shortcuts.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := cfg.ValidateHosts(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := cfg.ValidateOperations(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := cfg.ValidateCommands(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := cfg.ValidateMulti(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
path := config.Path()
|
path := config.Path()
|
||||||
if err := os.MkdirAll(filepath.Dir(path), 0o700); err != nil {
|
if err := os.MkdirAll(filepath.Dir(path), 0o700); err != nil {
|
||||||
return fmt.Errorf("creating config dir: %w", err)
|
return fmt.Errorf("creating config dir: %w", err)
|
||||||
@@ -247,12 +404,15 @@ func save(cfg config.Config) error {
|
|||||||
b.WriteString("netboxes:\n")
|
b.WriteString("netboxes:\n")
|
||||||
for _, source := range cfg.NetBoxes {
|
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)
|
fmt.Fprintf(&b, " - name: %q\n url: %q\n token: %q\n token_version: %d\n", source.Name, source.URL, source.Token, source.TokenVersion)
|
||||||
|
if source.DisablePrefix {
|
||||||
|
b.WriteString(" disable_prefix: true\n")
|
||||||
|
}
|
||||||
if !sshOptionsEmpty(source.SSH) {
|
if !sshOptionsEmpty(source.SSH) {
|
||||||
b.WriteString(" ssh:\n")
|
b.WriteString(" ssh:\n")
|
||||||
writeSSHOptions(&b, " ", source.SSH)
|
writeSSHOptions(&b, " ", source.SSH)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else {
|
} else if cfg.NetBox.URL != "" || len(cfg.Hosts) == 0 {
|
||||||
b.WriteString("netbox:\n")
|
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)
|
fmt.Fprintf(&b, " url: %q\n token: %q\n token_version: %d\n", cfg.NetBox.URL, cfg.NetBox.Token, cfg.NetBox.TokenVersion)
|
||||||
if !sshOptionsEmpty(cfg.NetBox.SSH) {
|
if !sshOptionsEmpty(cfg.NetBox.SSH) {
|
||||||
@@ -275,6 +435,9 @@ func save(cfg config.Config) error {
|
|||||||
if cfg.Resolver.InterfaceName != "" {
|
if cfg.Resolver.InterfaceName != "" {
|
||||||
fmt.Fprintf(&b, " interface_name: %q\n", cfg.Resolver.InterfaceName)
|
fmt.Fprintf(&b, " interface_name: %q\n", cfg.Resolver.InterfaceName)
|
||||||
}
|
}
|
||||||
|
if cfg.Resolver.HostnameDomain != "" {
|
||||||
|
fmt.Fprintf(&b, " hostname_domain: %q\n", cfg.Resolver.HostnameDomain)
|
||||||
|
}
|
||||||
|
|
||||||
b.WriteString("\ncache:\n")
|
b.WriteString("\ncache:\n")
|
||||||
fmt.Fprintf(&b, " ttl: %d\n", cfg.Cache.TTL)
|
fmt.Fprintf(&b, " ttl: %d\n", cfg.Cache.TTL)
|
||||||
@@ -303,11 +466,64 @@ func save(cfg config.Config) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if len(cfg.Hosts) > 0 {
|
||||||
|
b.WriteString("\nhosts:\n")
|
||||||
|
for _, host := range cfg.Hosts {
|
||||||
|
fmt.Fprintf(&b, " - name: %q\n address: %q\n", host.Name, host.Address)
|
||||||
|
if host.User != "" {
|
||||||
|
fmt.Fprintf(&b, " user: %q\n", host.User)
|
||||||
|
}
|
||||||
|
if host.Port > 0 {
|
||||||
|
fmt.Fprintf(&b, " port: %d\n", host.Port)
|
||||||
|
}
|
||||||
|
if len(host.Tags) > 0 {
|
||||||
|
b.WriteString(" tags:\n")
|
||||||
|
for _, tag := range host.Tags {
|
||||||
|
fmt.Fprintf(&b, " - %q\n", tag)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !sshOptionsEmpty(host.SSH) {
|
||||||
|
b.WriteString(" ssh:\n")
|
||||||
|
writeSSHOptions(&b, " ", host.SSH)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(cfg.Groups) > 0 {
|
||||||
|
b.WriteString("\ngroups:\n")
|
||||||
|
names := make([]string, 0, len(cfg.Groups))
|
||||||
|
for name := range cfg.Groups {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
for _, name := range names {
|
||||||
|
quoted := make([]string, 0, len(cfg.Groups[name]))
|
||||||
|
for _, selector := range cfg.Groups[name] {
|
||||||
|
quoted = append(quoted, strconv.Quote(selector))
|
||||||
|
}
|
||||||
|
fmt.Fprintf(&b, " %s: [%s]\n", name, strings.Join(quoted, ", "))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if cfg.Multi != (config.MultiConfig{}) {
|
||||||
|
b.WriteString("\nmulti:\n")
|
||||||
|
if cfg.Multi.Multiplexer != "" {
|
||||||
|
fmt.Fprintf(&b, " multiplexer: %s\n", cfg.Multi.Multiplexer)
|
||||||
|
}
|
||||||
|
if cfg.Multi.PanesPerWindow > 0 {
|
||||||
|
fmt.Fprintf(&b, " panes_per_window: %d\n", cfg.Multi.PanesPerWindow)
|
||||||
|
}
|
||||||
|
for _, key := range [][2]string{{"sync_key", cfg.Multi.SyncKey}, {"solo_key", cfg.Multi.SoloKey}} {
|
||||||
|
if key[1] != "" {
|
||||||
|
fmt.Fprintf(&b, " %s: %q\n", key[0], key[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if cfg.Completion.MaxResults > 0 {
|
if cfg.Completion.MaxResults > 0 {
|
||||||
fmt.Fprintf(&b, "\ncompletion:\n max_results: %d\n", cfg.Completion.MaxResults)
|
fmt.Fprintf(&b, "\ncompletion:\n max_results: %d\n", cfg.Completion.MaxResults)
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(cfg.Shortcuts.Domains) > 0 || cfg.Shortcuts.StripHyphens {
|
if cfg.Shortcuts.Enabled() || cfg.Shortcuts.Show {
|
||||||
b.WriteString("\nshortcuts:\n")
|
b.WriteString("\nshortcuts:\n")
|
||||||
if len(cfg.Shortcuts.Domains) > 0 {
|
if len(cfg.Shortcuts.Domains) > 0 {
|
||||||
b.WriteString(" domains:\n")
|
b.WriteString(" domains:\n")
|
||||||
@@ -318,13 +534,48 @@ func save(cfg config.Config) error {
|
|||||||
if cfg.Shortcuts.StripHyphens {
|
if cfg.Shortcuts.StripHyphens {
|
||||||
b.WriteString(" strip_hyphens: true\n")
|
b.WriteString(" strip_hyphens: true\n")
|
||||||
}
|
}
|
||||||
|
if len(cfg.Shortcuts.Rewrites) > 0 {
|
||||||
|
b.WriteString(" rewrites:\n")
|
||||||
|
for _, r := range cfg.Shortcuts.Rewrites {
|
||||||
|
fmt.Fprintf(&b, " - pattern: %q\n replace: %q\n", r.Pattern, r.Replace)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if cfg.Shortcuts.Show {
|
||||||
|
b.WriteString(" show: true\n")
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if len(cfg.Commands) > 0 {
|
||||||
|
b.WriteString("\ncommands:\n")
|
||||||
|
var names []string
|
||||||
|
for name := range cfg.Commands {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
for _, name := range names {
|
||||||
|
command := cfg.Commands[name]
|
||||||
|
fmt.Fprintf(&b, " %s:\n alias_prefix: %q\n args:\n", name, command.AliasPrefix)
|
||||||
|
for _, arg := range command.Args {
|
||||||
|
fmt.Fprintf(&b, " - %q\n", arg)
|
||||||
|
}
|
||||||
|
fmt.Fprintf(&b, " confirm: %t\n timeout: %q\n post_run: %q\n", command.Confirm, command.Timeout, command.PostRun)
|
||||||
|
if command.Match != (config.SSHMatch{}) {
|
||||||
|
b.WriteString(" match:\n")
|
||||||
|
for _, pair := range [][2]string{{"tag", command.Match.Tag}, {"instance", command.Match.Instance}, {"kind", command.Match.Kind}, {"name", command.Match.Name}} {
|
||||||
|
if pair[1] != "" {
|
||||||
|
fmt.Fprintf(&b, " %s: %q\n", pair[0], pair[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Fprintf(&b, "\ntui:\n history_limit: %d\nactivity:\n enabled: %t\n retention_days: %d\n max_entries: %d\n", cfg.TUI.HistoryLimit, cfg.Activity.Enabled, cfg.Activity.RetentionDays, cfg.Activity.MaxEntries)
|
||||||
if cfg.Shell.Alias != "" {
|
if cfg.Shell.Alias != "" {
|
||||||
fmt.Fprintf(&b, "\nshell:\n alias: %q\n", cfg.Shell.Alias)
|
fmt.Fprintf(&b, "\nshell:\n alias: %q\n", cfg.Shell.Alias)
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := storage.WriteFile(path, []byte(b.String()), 0o600); err != nil {
|
if err := storage.WriteFile(path, []byte(strings.TrimLeft(b.String(), "\n")), 0o600); err != nil {
|
||||||
return fmt.Errorf("writing config: %w", err)
|
return fmt.Errorf("writing config: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -333,12 +584,12 @@ func save(cfg config.Config) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func sshOptionsEmpty(o config.SSHOptions) bool {
|
func sshOptionsEmpty(o config.SSHOptions) bool {
|
||||||
return o.ProxyJump == "" && o.HostKeyChecking == "" && o.Target == "" && o.AddressFamily == "" && len(o.ExtraArgs) == 0 && len(o.Options) == 0
|
return o.ProxyJump == "" && o.HostKeyChecking == "" && o.Target == "" && o.AddressFamily == "" && len(o.ExtraArgs) == 0 && len(o.Options) == 0 && len(o.Forwards) == 0 && o.PreConnect == "" && o.PostDisconnect == ""
|
||||||
}
|
}
|
||||||
|
|
||||||
// writeSSHOptions keeps settings the wizard does not ask for when it rewrites the config.
|
// writeSSHOptions keeps settings the wizard does not ask for when it rewrites the config.
|
||||||
func writeSSHOptions(b *strings.Builder, indent string, o config.SSHOptions) {
|
func writeSSHOptions(b *strings.Builder, indent string, o config.SSHOptions) {
|
||||||
for _, field := range [][2]string{{"proxy_jump", o.ProxyJump}, {"host_key_checking", o.HostKeyChecking}, {"target", o.Target}, {"address_family", o.AddressFamily}} {
|
for _, field := range [][2]string{{"proxy_jump", o.ProxyJump}, {"host_key_checking", o.HostKeyChecking}, {"target", o.Target}, {"address_family", o.AddressFamily}, {"pre_connect", o.PreConnect}, {"post_disconnect", o.PostDisconnect}} {
|
||||||
if field[1] != "" {
|
if field[1] != "" {
|
||||||
fmt.Fprintf(b, "%s%s: %q\n", indent, field[0], field[1])
|
fmt.Fprintf(b, "%s%s: %q\n", indent, field[0], field[1])
|
||||||
}
|
}
|
||||||
@@ -360,4 +611,20 @@ func writeSSHOptions(b *strings.Builder, indent string, o config.SSHOptions) {
|
|||||||
fmt.Fprintf(b, "%s %s: %q\n", indent, key, o.Options[key])
|
fmt.Fprintf(b, "%s %s: %q\n", indent, key, o.Options[key])
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if len(o.Forwards) > 0 {
|
||||||
|
names := make([]string, 0, len(o.Forwards))
|
||||||
|
for name := range o.Forwards {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
fmt.Fprintf(b, "%sforwards:\n", indent)
|
||||||
|
for _, name := range names {
|
||||||
|
f := o.Forwards[name]
|
||||||
|
for _, field := range [][2]string{{"local", f.Local}, {"remote", f.Remote}, {"dynamic", f.Dynamic}} {
|
||||||
|
if field[1] != "" {
|
||||||
|
fmt.Fprintf(b, "%s %s:\n%s %s: %q\n", indent, name, indent, field[0], field[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -295,6 +295,12 @@ func TestParseStrategies_PreservesOrder(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestValidateStrategiesHostname(t *testing.T) {
|
||||||
|
if err := validateStrategies("primary_ip, hostname"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestValidateStrategies_Valid(t *testing.T) {
|
func TestValidateStrategies_Valid(t *testing.T) {
|
||||||
cases := []string{
|
cases := []string{
|
||||||
"primary_ip",
|
"primary_ip",
|
||||||
@@ -392,7 +398,7 @@ func TestSaveMultipleNetBoxesRoundTrip(t *testing.T) {
|
|||||||
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
cfg := config.Config{
|
cfg := config.Config{
|
||||||
NetBoxes: []config.NetBoxConfig{
|
NetBoxes: []config.NetBoxConfig{
|
||||||
{Name: "office", URL: "https://office.example/netbox", Token: "nbt_secret: office", TokenVersion: 2},
|
{Name: "office", URL: "https://office.example/netbox", Token: "nbt_secret: office", TokenVersion: 2, DisablePrefix: true},
|
||||||
{Name: "lab", URL: "https://lab.example", Token: "legacy#token", TokenVersion: 1},
|
{Name: "lab", URL: "https://lab.example", Token: "legacy#token", TokenVersion: 1},
|
||||||
},
|
},
|
||||||
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
||||||
@@ -432,9 +438,10 @@ func TestSaveKeepsSSHOptions(t *testing.T) {
|
|||||||
AddressFamily: "inet",
|
AddressFamily: "inet",
|
||||||
ExtraArgs: []string{"-A"},
|
ExtraArgs: []string{"-A"},
|
||||||
Options: map[string]string{"serveraliveinterval": "60"},
|
Options: map[string]string{"serveraliveinterval": "60"},
|
||||||
|
PreConnect: `vpn-check "$NETSSH_HOST" && echo 'ok'`,
|
||||||
}
|
}
|
||||||
cfg := config.Config{
|
cfg := config.Config{
|
||||||
NetBoxes: []config.NetBoxConfig{{Name: "prod", URL: "https://prod.example", Token: "t", TokenVersion: 1, SSH: config.SSHOptions{HostKeyChecking: "off"}}},
|
NetBoxes: []config.NetBoxConfig{{Name: "prod", URL: "https://prod.example", Token: "t", TokenVersion: 1, SSH: config.SSHOptions{HostKeyChecking: "off", PreConnect: "none"}}},
|
||||||
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
||||||
Cache: config.CacheConfig{TTL: 3600},
|
Cache: config.CacheConfig{TTL: 3600},
|
||||||
SSH: config.SSHConfig{
|
SSH: config.SSHConfig{
|
||||||
@@ -455,3 +462,260 @@ func TestSaveKeepsSSHOptions(t *testing.T) {
|
|||||||
t.Fatalf("ssh settings lost:\n%+v\n%+v", loaded.SSH, loaded.NetBoxes[0].SSH)
|
t.Fatalf("ssh settings lost:\n%+v\n%+v", loaded.SSH, loaded.NetBoxes[0].SSH)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Re-running the configurator must keep settings that have no form field of
|
||||||
|
// their own or were not touched in the menu.
|
||||||
|
func TestPrepareKeepsUnmanagedSettings(t *testing.T) {
|
||||||
|
cfg := config.Config{
|
||||||
|
NetBox: config.NetBoxConfig{URL: "https://legacy.example", Token: "t"},
|
||||||
|
SSH: config.SSHConfig{
|
||||||
|
DefaultUser: "root",
|
||||||
|
SSHOptions: config.SSHOptions{ProxyJump: "jh.example.com", Options: map[string]string{"forwardagent": "yes"}},
|
||||||
|
Rules: []config.SSHRule{{Match: config.SSHMatch{Tag: "dmz"}, SSHOptions: config.SSHOptions{ProxyJump: "none"}}},
|
||||||
|
},
|
||||||
|
Completion: config.CompletionConfig{MaxResults: 50},
|
||||||
|
Cache: config.CacheConfig{Path: "/var/cache/netssh/hosts.json"},
|
||||||
|
}
|
||||||
|
sources := []config.NetBoxConfig{{Name: "default", URL: "https://legacy.example", Token: "t"}}
|
||||||
|
got := prepare(cfg, sources)
|
||||||
|
|
||||||
|
if !reflect.DeepEqual(got.SSH, cfg.SSH) || got.Completion != cfg.Completion || got.Cache.Path != cfg.Cache.Path {
|
||||||
|
t.Fatalf("settings lost: %+v", got)
|
||||||
|
}
|
||||||
|
if got.NetBox.URL != "" || !reflect.DeepEqual(got.NetBoxes, sources) {
|
||||||
|
t.Fatalf("legacy instance not migrated: %+v / %+v", got.NetBox, got.NetBoxes)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(got.Resolver.Strategies, []string{"primary_ip"}) || got.Cache.TTL != 3600 {
|
||||||
|
t.Fatalf("defaults missing: %+v %+v", got.Resolver, got.Cache)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSaveRejectsInvalidSSHOptions(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
t.Setenv("HOME", t.TempDir())
|
||||||
|
cfg := config.Config{
|
||||||
|
NetBoxes: []config.NetBoxConfig{{Name: "prod", URL: "https://prod.example", Token: "t"}},
|
||||||
|
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
||||||
|
SSH: config.SSHConfig{Rules: []config.SSHRule{{SSHOptions: config.SSHOptions{ProxyJump: "none"}}}},
|
||||||
|
}
|
||||||
|
if err := save(cfg); err == nil {
|
||||||
|
t.Fatal("rule without match was saved")
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(config.Path()); !os.IsNotExist(err) {
|
||||||
|
t.Fatalf("config file written despite error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseRewrites(t *testing.T) {
|
||||||
|
text := `^([a-z]+)[0-9]+- => $1
|
||||||
|
|
||||||
|
\.lab$ =>
|
||||||
|
`
|
||||||
|
got, err := parseRewrites(text)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := []config.ShortcutRewrite{{Pattern: `^([a-z]+)[0-9]+-`, Replace: "$1"}, {Pattern: `\.lab$`, Replace: ""}}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("got %+v", got)
|
||||||
|
}
|
||||||
|
if again, _ := parseRewrites(formatRewrites(got)); !reflect.DeepEqual(again, want) {
|
||||||
|
t.Fatalf("roundtrip: %+v", again)
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"no arrow", "[a- => x", " => x"} {
|
||||||
|
if _, err := parseRewrites(bad); err == nil {
|
||||||
|
t.Errorf("%q accepted", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSaveShortcutRewritesRoundtrip(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
t.Setenv("HOME", t.TempDir())
|
||||||
|
rewrites := []config.ShortcutRewrite{{Pattern: `^([a-z]+)[0-9]+-`, Replace: "$1"}, {Pattern: `\.lab\.example\.com$`, Replace: `"q"`}}
|
||||||
|
cfg := config.Config{
|
||||||
|
NetBoxes: []config.NetBoxConfig{{Name: "prod", URL: "https://prod.example", Token: "t"}},
|
||||||
|
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
||||||
|
Shortcuts: config.ShortcutsConfig{Rewrites: rewrites},
|
||||||
|
}
|
||||||
|
if err := save(cfg); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
loaded, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(loaded.Shortcuts.Rewrites, rewrites) {
|
||||||
|
t.Fatalf("got %+v", loaded.Shortcuts.Rewrites)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSaveForwardsRoundtrip(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
t.Setenv("HOME", t.TempDir())
|
||||||
|
global := map[string]config.Forward{"web": {Local: "8080:localhost:80"}, "socks": {Dynamic: "1080"}}
|
||||||
|
cfg := config.Config{
|
||||||
|
NetBoxes: []config.NetBoxConfig{{Name: "prod", URL: "https://prod.example", Token: "t", SSH: config.SSHOptions{Forwards: map[string]config.Forward{"db": {Local: "5432:localhost:5432"}}}}},
|
||||||
|
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
||||||
|
SSH: config.SSHConfig{
|
||||||
|
SSHOptions: config.SSHOptions{Forwards: global},
|
||||||
|
Rules: []config.SSHRule{{Match: config.SSHMatch{Tag: "dmz"}, SSHOptions: config.SSHOptions{Forwards: map[string]config.Forward{"back": {Remote: "9000:localhost:9000"}}}}},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
if err := save(cfg); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
loaded, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(loaded.SSH.Forwards, global) ||
|
||||||
|
!reflect.DeepEqual(loaded.NetBoxes[0].SSH.Forwards, cfg.NetBoxes[0].SSH.Forwards) ||
|
||||||
|
!reflect.DeepEqual(loaded.SSH.Rules[0].Forwards, cfg.SSH.Rules[0].Forwards) {
|
||||||
|
t.Fatalf("forwards lost: %+v / %+v / %+v", loaded.SSH.Forwards, loaded.NetBoxes[0].SSH.Forwards, loaded.SSH.Rules)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSaveStaticHostsRoundtrip(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
t.Setenv("HOME", t.TempDir())
|
||||||
|
hosts := []config.StaticHost{
|
||||||
|
{Name: "router", Address: "192.168.1.1", User: "admin", Port: 2222, Tags: []string{"home"}, SSH: config.SSHOptions{ProxyJump: "none"}},
|
||||||
|
{Name: "nas", Address: "nas.example.org"},
|
||||||
|
}
|
||||||
|
cfg := config.Config{
|
||||||
|
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip", "hostname"}, HostnameDomain: "example.com"},
|
||||||
|
Hosts: hosts,
|
||||||
|
}
|
||||||
|
if err := save(cfg); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
data, _ := os.ReadFile(config.Path())
|
||||||
|
if strings.Contains(string(data), "netbox:") {
|
||||||
|
t.Fatalf("static-only config got an empty netbox section:\n%s", data)
|
||||||
|
}
|
||||||
|
loaded, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(loaded.Hosts, hosts) || loaded.Resolver.HostnameDomain != "example.com" || loaded.HasNetBox() {
|
||||||
|
t.Fatalf("got %+v / %+v", loaded.Hosts, loaded.Resolver)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestValidateHostIn(t *testing.T) {
|
||||||
|
hosts := []config.StaticHost{{Name: "router", Address: "10.0.0.1"}, {Name: "nas", Address: "10.0.0.2"}}
|
||||||
|
if err := validateHostIn(config.StaticHost{Name: "Router", Address: "10.0.0.9"}, hosts, -1); err == nil {
|
||||||
|
t.Fatal("duplicate name accepted")
|
||||||
|
}
|
||||||
|
if err := validateHostIn(config.StaticHost{Name: "router", Address: "10.0.0.9"}, hosts, 0); err != nil {
|
||||||
|
t.Fatalf("editing a host in place rejected: %v", err)
|
||||||
|
}
|
||||||
|
if err := validateHostIn(config.StaticHost{Name: "new"}, hosts, -1); err != nil {
|
||||||
|
t.Fatalf("empty address while typing rejected: %v", err)
|
||||||
|
}
|
||||||
|
if err := validateHostIn(config.StaticHost{Name: "new", Address: "a b"}, hosts, -1); err == nil {
|
||||||
|
t.Fatal("invalid address accepted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseGroupsAndSaveMulti(t *testing.T) {
|
||||||
|
groups, err := parseGroups("K8s: master1, tag:k8s-worker\npve: cluster:pve-fsn1 @k8s\n")
|
||||||
|
want := map[string][]string{"k8s": {"master1", "tag:k8s-worker"}, "pve": {"cluster:pve-fsn1", "@k8s"}}
|
||||||
|
if err != nil || !reflect.DeepEqual(groups, want) {
|
||||||
|
t.Fatalf("got %v %v", groups, err)
|
||||||
|
}
|
||||||
|
if again, _ := parseGroups(formatGroups(groups)); !reflect.DeepEqual(again, want) {
|
||||||
|
t.Fatalf("roundtrip: %v", again)
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"no colon", "tag:x", "bad name: a", "empty:"} {
|
||||||
|
if _, err := parseGroups(bad); err == nil {
|
||||||
|
t.Errorf("%q accepted", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
t.Setenv("HOME", t.TempDir())
|
||||||
|
cfg := config.Config{
|
||||||
|
Hosts: []config.StaticHost{{Name: "a", Address: "10.0.0.1"}},
|
||||||
|
Groups: groups,
|
||||||
|
Multi: config.MultiConfig{Multiplexer: "zellij", PanesPerWindow: 4},
|
||||||
|
}
|
||||||
|
if err := save(cfg); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
loaded, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(loaded.Groups, want) || loaded.Multi != cfg.Multi {
|
||||||
|
t.Fatalf("got %v %+v", loaded.Groups, loaded.Multi)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSaveKeepsShortcutsShow(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
t.Setenv("HOME", t.TempDir())
|
||||||
|
for _, sc := range []config.ShortcutsConfig{
|
||||||
|
{Domains: []string{".example.com"}, Show: true},
|
||||||
|
{Show: true}, // no shortcut rules yet: the switch alone must survive
|
||||||
|
} {
|
||||||
|
cfg := config.Config{
|
||||||
|
Resolver: config.ResolverConfig{Strategies: []string{"primary_ip"}},
|
||||||
|
Cache: config.CacheConfig{TTL: 3600},
|
||||||
|
Shortcuts: sc,
|
||||||
|
}
|
||||||
|
if err := save(cfg); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
loaded, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !loaded.Shortcuts.Show || !reflect.DeepEqual(loaded.Shortcuts.Domains, sc.Domains) {
|
||||||
|
t.Fatalf("shortcuts lost: %+v", loaded.Shortcuts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSaveCommandsRoundTrip(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
cfg := config.Config{
|
||||||
|
NetBox: config.NetBoxConfig{URL: "https://netbox.example", Token: "test"},
|
||||||
|
Commands: map[string]config.HostCommand{
|
||||||
|
"mtr": {AliasPrefix: "m", Args: []string{"mtr", "--report", "{address}"}},
|
||||||
|
"ping": {AliasPrefix: "p", Args: []string{"ping", "-c", "3", "{address}"}},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
if err := save(cfg); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(got.Commands, cfg.Commands) {
|
||||||
|
t.Fatalf("commands lost: %+v", got.Commands)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOperationsRoundTrip(t *testing.T) {
|
||||||
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
||||||
|
cfg := config.Config{
|
||||||
|
NetBox: config.NetBoxConfig{URL: "https://netbox.example", Token: "token"},
|
||||||
|
TUI: config.TUIConfig{HistoryLimit: 25},
|
||||||
|
Activity: config.ActivityConfig{Enabled: true, RetentionDays: 7, MaxEntries: 50},
|
||||||
|
SSH: config.SSHConfig{SSHOptions: config.SSHOptions{PostDisconnect: "echo done"}, Rules: []config.SSHRule{{Match: config.SSHMatch{Tag: "lab"}, SSHOptions: config.SSHOptions{PostDisconnect: "none"}}}},
|
||||||
|
Commands: map[string]config.HostCommand{"mtr": {Args: []string{"mtr", "{address}"}, AliasPrefix: "m", Timeout: "10s", Confirm: true, PostRun: "echo done", Match: config.SSHMatch{Tag: "router", Instance: "prod"}}},
|
||||||
|
}
|
||||||
|
if err := save(cfg); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got.TUI != cfg.TUI || got.Activity != cfg.Activity || !reflect.DeepEqual(got.Commands, cfg.Commands) || !reflect.DeepEqual(got.SSH, cfg.SSH) {
|
||||||
|
t.Fatalf("round trip lost operations: %+v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,13 +1,30 @@
|
|||||||
package shortcuts
|
package shortcuts
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"regexp"
|
||||||
"strings"
|
"strings"
|
||||||
|
"sync"
|
||||||
|
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Normalize strips configured domain suffixes and optionally hyphens from a hostname.
|
// compiled caches rewrite patterns: Normalize runs for every cache entry on each lookup.
|
||||||
// The result is lowercased for case-insensitive comparison.
|
var compiled sync.Map // pattern → *regexp.Regexp
|
||||||
|
|
||||||
|
func rewritePattern(pattern string) *regexp.Regexp {
|
||||||
|
if re, ok := compiled.Load(pattern); ok {
|
||||||
|
return re.(*regexp.Regexp)
|
||||||
|
}
|
||||||
|
re, err := regexp.Compile(pattern)
|
||||||
|
if err != nil {
|
||||||
|
return nil // rejected by config.Load already
|
||||||
|
}
|
||||||
|
compiled.Store(pattern, re)
|
||||||
|
return re
|
||||||
|
}
|
||||||
|
|
||||||
|
// Normalize strips configured domain suffixes, applies rewrite rules in order, and
|
||||||
|
// optionally strips hyphens. The result is lowercased for case-insensitive comparison.
|
||||||
func Normalize(name string, cfg config.ShortcutsConfig) string {
|
func Normalize(name string, cfg config.ShortcutsConfig) string {
|
||||||
s := strings.ToLower(name)
|
s := strings.ToLower(name)
|
||||||
for _, domain := range cfg.Domains {
|
for _, domain := range cfg.Domains {
|
||||||
@@ -20,6 +37,11 @@ func Normalize(name string, cfg config.ShortcutsConfig) string {
|
|||||||
break
|
break
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
for _, rewrite := range cfg.Rewrites {
|
||||||
|
if re := rewritePattern(rewrite.Pattern); re != nil {
|
||||||
|
s = re.ReplaceAllString(s, rewrite.Replace)
|
||||||
|
}
|
||||||
|
}
|
||||||
if cfg.StripHyphens {
|
if cfg.StripHyphens {
|
||||||
s = strings.ReplaceAll(s, "-", "")
|
s = strings.ReplaceAll(s, "-", "")
|
||||||
}
|
}
|
||||||
@@ -34,9 +56,14 @@ func MakeNormalizer(cfg config.ShortcutsConfig) func(string) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// AliasName returns a shell-safe alias name for the given host.
|
// AliasName returns a shell-safe alias name for the given host.
|
||||||
// It normalizes the name (strips configured domains and optionally hyphens) then
|
// It normalizes the name (strips configured domains, applies rewrites, optionally strips hyphens) then
|
||||||
// replaces any remaining dots with underscores so the result is a valid identifier.
|
// replaces any remaining dots with underscores so the result is a valid identifier.
|
||||||
func AliasName(name string, cfg config.ShortcutsConfig) string {
|
func AliasName(name string, cfg config.ShortcutsConfig) string {
|
||||||
s := Normalize(name, cfg)
|
// Shorten only the hostname: anchored rewrite rules must not see "instance/".
|
||||||
|
prefix := ""
|
||||||
|
if source, host, ok := strings.Cut(name, "/"); ok {
|
||||||
|
prefix, name = strings.ToLower(source)+"_", host
|
||||||
|
}
|
||||||
|
s := prefix + Normalize(name, cfg)
|
||||||
return strings.NewReplacer(".", "_", "/", "_").Replace(s)
|
return strings.NewReplacer(".", "_", "/", "_").Replace(s)
|
||||||
}
|
}
|
||||||
@@ -78,3 +78,50 @@ func TestAliasName_NoConfig(t *testing.T) {
|
|||||||
t.Errorf("AliasName = %q, want %q", got, want)
|
t.Errorf("AliasName = %q, want %q", got, want)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestNormalizeRewrites(t *testing.T) {
|
||||||
|
cfg := config.ShortcutsConfig{
|
||||||
|
Domains: []string{".hoster.de"},
|
||||||
|
Rewrites: []config.ShortcutRewrite{{Pattern: `^([a-z]+)[0-9]+-`, Replace: "$1"}},
|
||||||
|
}
|
||||||
|
for input, want := range map[string]string{
|
||||||
|
"fsn1-bx1.hoster.de": "fsnbx1",
|
||||||
|
"FSN1-BX1.hoster.de": "fsnbx1",
|
||||||
|
"fsn1-bx1": "fsnbx1",
|
||||||
|
"fsnbx1": "fsnbx1", // the shortcut itself is left alone
|
||||||
|
"web01.hoster.de": "web01",
|
||||||
|
} {
|
||||||
|
if got := shortcuts.Normalize(input, cfg); got != want {
|
||||||
|
t.Errorf("Normalize(%q) = %q, want %q", input, got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if got := shortcuts.AliasName("fsn1-bx1.hoster.de", cfg); got != "fsnbx1" {
|
||||||
|
t.Errorf("AliasName = %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNormalizeRewritesOrder(t *testing.T) {
|
||||||
|
// Rules run in order after domain stripping, before hyphen stripping.
|
||||||
|
cfg := config.ShortcutsConfig{
|
||||||
|
Domains: []string{".hoster.de"},
|
||||||
|
StripHyphens: true,
|
||||||
|
Rewrites: []config.ShortcutRewrite{
|
||||||
|
{Pattern: `\.hoster\.de$`, Replace: "-never"},
|
||||||
|
{Pattern: `^fsn`, Replace: "f"},
|
||||||
|
{Pattern: `^f1`, Replace: "falkenstein"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
if got := shortcuts.Normalize("fsn1-bx-1.hoster.de", cfg); got != "falkensteinbx1" {
|
||||||
|
t.Fatalf("got %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAliasNameRewritesInstanceQualifiedHosts(t *testing.T) {
|
||||||
|
cfg := config.ShortcutsConfig{
|
||||||
|
Domains: []string{".hoster.test"},
|
||||||
|
Rewrites: []config.ShortcutRewrite{{Pattern: `^([a-z]+)[0-9]+-`, Replace: "$1"}},
|
||||||
|
}
|
||||||
|
if got := shortcuts.AliasName("fsn/fsn1-pve1.hoster.test", cfg); got != "fsn_fsnpve1" {
|
||||||
|
t.Fatalf("got %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
+53
-30
@@ -12,15 +12,19 @@ var flagsWithArg = map[byte]bool{
|
|||||||
|
|
||||||
// ParsedArgs holds the result of parsing SSH arguments.
|
// ParsedArgs holds the result of parsing SSH arguments.
|
||||||
type ParsedArgs struct {
|
type ParsedArgs struct {
|
||||||
Host string // hostname without the user@ prefix
|
Host string // hostname without the user@ prefix or :path
|
||||||
User string // empty if not specified
|
User string // empty if not specified
|
||||||
|
Path string // sftp only: the remote path after host:
|
||||||
DestIdx int // index in Args where [user@]host sits
|
DestIdx int // index in Args where [user@]host sits
|
||||||
Args []string
|
Args []string
|
||||||
}
|
}
|
||||||
|
|
||||||
// Parse scans SSH arguments and extracts the destination ([user@]host).
|
// Parse scans SSH arguments and extracts the destination ([user@]host).
|
||||||
// Returns nil if no destination is found.
|
// Returns nil if no destination is found.
|
||||||
func Parse(args []string) *ParsedArgs {
|
func Parse(args []string) *ParsedArgs { return SSH.Parse(args) }
|
||||||
|
|
||||||
|
// Parse extracts the destination: [user@]host, or [user@]host[:path] for sftp.
|
||||||
|
func (c Client) Parse(args []string) *ParsedArgs {
|
||||||
i := 0
|
i := 0
|
||||||
for i < len(args) {
|
for i < len(args) {
|
||||||
arg := args[i]
|
arg := args[i]
|
||||||
@@ -33,64 +37,83 @@ func Parse(args []string) *ParsedArgs {
|
|||||||
|
|
||||||
if strings.HasPrefix(arg, "-") && len(arg) > 1 {
|
if strings.HasPrefix(arg, "-") && len(arg) > 1 {
|
||||||
// OpenSSH accepts clusters such as -vp 2222 and -vladmin.
|
// OpenSSH accepts clusters such as -vp 2222 and -vladmin.
|
||||||
for j := 1; j < len(arg); j++ {
|
if c.takesSeparateValue(arg) {
|
||||||
if flagsWithArg[arg[j]] {
|
|
||||||
if j == len(arg)-1 {
|
|
||||||
i++
|
i++
|
||||||
}
|
}
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
i++
|
i++
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
// first non-flag argument is the destination
|
// first non-flag argument is the destination
|
||||||
host, user := splitUserHost(arg)
|
return c.parsed(args, i)
|
||||||
return &ParsedArgs{
|
|
||||||
Host: host,
|
|
||||||
User: user,
|
|
||||||
DestIdx: i,
|
|
||||||
Args: args,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// handle arguments after "--"
|
// handle arguments after "--"
|
||||||
if i < len(args) {
|
if i < len(args) {
|
||||||
host, user := splitUserHost(args[i])
|
return c.parsed(args, i)
|
||||||
return &ParsedArgs{
|
|
||||||
Host: host,
|
|
||||||
User: user,
|
|
||||||
DestIdx: i,
|
|
||||||
Args: args,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (c Client) parsed(args []string, i int) *ParsedArgs {
|
||||||
|
dest, path := args[i], ""
|
||||||
|
if c.paths {
|
||||||
|
if d, p, remote := c.splitRemote(dest); remote {
|
||||||
|
dest, path = d, p
|
||||||
|
}
|
||||||
|
}
|
||||||
|
host, user := splitUserHost(dest)
|
||||||
|
return &ParsedArgs{Host: host, User: user, Path: path, DestIdx: i, Args: args}
|
||||||
|
}
|
||||||
|
|
||||||
// ReplaceHost returns a copy of args with the destination replaced by newHost,
|
// ReplaceHost returns a copy of args with the destination replaced by newHost,
|
||||||
// preserving any user@ prefix.
|
// preserving any user@ prefix.
|
||||||
func ReplaceHost(args []string, destIdx int, newHost string) []string {
|
func ReplaceHost(args []string, destIdx int, newHost string) []string {
|
||||||
|
return SSH.replaceHost(args, []int{destIdx}, newHost)
|
||||||
|
}
|
||||||
|
|
||||||
|
// replaceHost keeps user@ and, for sftp and scp, :path. Those clients read
|
||||||
|
// host:path, so an IPv6 address must be bracketed.
|
||||||
|
func (c Client) replaceHost(args []string, dests []int, newHost string) []string {
|
||||||
result := make([]string, len(args))
|
result := make([]string, len(args))
|
||||||
copy(result, args)
|
copy(result, args)
|
||||||
|
if c.paths && strings.Contains(newHost, ":") {
|
||||||
|
newHost = "[" + newHost + "]"
|
||||||
|
}
|
||||||
|
for _, destIdx := range dests {
|
||||||
original := args[destIdx]
|
original := args[destIdx]
|
||||||
|
prefix, suffix := "", ""
|
||||||
if at := strings.Index(original, "@"); at != -1 {
|
if at := strings.Index(original, "@"); at != -1 {
|
||||||
result[destIdx] = original[:at+1] + newHost
|
prefix, original = original[:at+1], original[at+1:]
|
||||||
} else {
|
}
|
||||||
result[destIdx] = newHost
|
if c.paths {
|
||||||
|
if _, path, remote := c.splitRemote(original); remote {
|
||||||
|
suffix = ":" + path
|
||||||
|
}
|
||||||
|
}
|
||||||
|
result[destIdx] = prefix + newHost + suffix
|
||||||
}
|
}
|
||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
// HasPortFlag reports whether a port was explicitly supplied.
|
// HasPortFlag reports whether a port was explicitly supplied.
|
||||||
func HasPortFlag(args []string) bool { return hasOption(args, 'p', "Port") }
|
func HasPortFlag(args []string) bool { return SSH.HasPortFlag(args) }
|
||||||
|
|
||||||
// HasUserFlag reports whether a login user was explicitly supplied.
|
// HasUserFlag reports whether a login user was explicitly supplied.
|
||||||
func HasUserFlag(args []string) bool { return hasOption(args, 'l', "User") }
|
func HasUserFlag(args []string) bool { return SSH.HasUserFlag(args) }
|
||||||
|
|
||||||
|
// HasPortFlag reports whether a port was explicitly supplied.
|
||||||
|
func (c Client) HasPortFlag(args []string) bool { return c.hasOption(args, c.port, "Port") }
|
||||||
|
|
||||||
|
// HasUserFlag reports whether a login user was explicitly supplied.
|
||||||
|
func (c Client) HasUserFlag(args []string) bool { return c.hasOption(args, c.user, "User") }
|
||||||
|
|
||||||
func hasOption(args []string, wanted byte, keyword string) bool {
|
func hasOption(args []string, wanted byte, keyword string) bool {
|
||||||
|
return SSH.hasOption(args, wanted, keyword)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c Client) hasOption(args []string, wanted byte, keyword string) bool {
|
||||||
for i := 0; i < len(args); i++ {
|
for i := 0; i < len(args); i++ {
|
||||||
arg := args[i]
|
arg := args[i]
|
||||||
if arg == "--" || len(arg) < 2 || arg[0] != '-' {
|
if arg == "--" || len(arg) < 2 || arg[0] != '-' {
|
||||||
@@ -98,7 +121,7 @@ func hasOption(args []string, wanted byte, keyword string) bool {
|
|||||||
}
|
}
|
||||||
for j := 1; j < len(arg); j++ {
|
for j := 1; j < len(arg); j++ {
|
||||||
flag := arg[j]
|
flag := arg[j]
|
||||||
if !flagsWithArg[flag] {
|
if !c.withArg[flag] {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
value := arg[j+1:]
|
value := arg[j+1:]
|
||||||
@@ -109,7 +132,7 @@ func hasOption(args []string, wanted byte, keyword string) bool {
|
|||||||
}
|
}
|
||||||
value = args[i]
|
value = args[i]
|
||||||
}
|
}
|
||||||
if flag == wanted {
|
if wanted != 0 && flag == wanted {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
if flag == 'o' {
|
if flag == 'o' {
|
||||||
|
|||||||
@@ -0,0 +1,162 @@
|
|||||||
|
package ssh
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Client describes one OpenSSH program netssh can run. The programs share
|
||||||
|
// ssh's connection options but differ in flags and destination syntax.
|
||||||
|
type Client struct {
|
||||||
|
Name string // binary name: ssh, sftp, or scp
|
||||||
|
withArg map[byte]bool // short flags that consume a value
|
||||||
|
port byte // flag for the port: -p (ssh) or -P (sftp, scp)
|
||||||
|
user byte // flag for the login user; 0 when only user@ or -o User work
|
||||||
|
paths bool // destinations are host[:path]
|
||||||
|
// instances are the configured NetBox instance names; "inst/host:path"
|
||||||
|
// is remote only for these, so local paths like "dir/file:x" stay local.
|
||||||
|
instances map[string]bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithInstances returns c aware of the NetBox instance prefixes in host:path.
|
||||||
|
func (c Client) WithInstances(names []string) Client {
|
||||||
|
c.instances = make(map[string]bool, len(names))
|
||||||
|
for _, name := range names {
|
||||||
|
c.instances[strings.ToLower(name)] = true
|
||||||
|
}
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
// SSH is the default client; its flag table is flagsWithArg.
|
||||||
|
SSH = Client{Name: "ssh", withArg: flagsWithArg, port: 'p', user: 'l'}
|
||||||
|
// SFTP follows sftp(1): -l is a bandwidth limit, -P the port.
|
||||||
|
SFTP = Client{Name: "sftp", withArg: flagSet("BbcDFiJloPRSsX"), port: 'P', paths: true}
|
||||||
|
// SCP follows scp(1); unlike sftp, -B and -R take no value.
|
||||||
|
SCP = Client{Name: "scp", withArg: flagSet("cDFiJloPSX"), port: 'P', paths: true}
|
||||||
|
)
|
||||||
|
|
||||||
|
func flagSet(flags string) map[byte]bool {
|
||||||
|
set := make(map[byte]bool, len(flags))
|
||||||
|
for i := 0; i < len(flags); i++ {
|
||||||
|
set[flags[i]] = true
|
||||||
|
}
|
||||||
|
return set
|
||||||
|
}
|
||||||
|
|
||||||
|
// PortArgs returns the arguments that set port for this client.
|
||||||
|
func (c Client) PortArgs(port string) []string { return []string{"-" + string(c.port), port} }
|
||||||
|
|
||||||
|
// UserArgs returns the arguments that set the login user for this client.
|
||||||
|
func (c Client) UserArgs(user string) []string {
|
||||||
|
if c.user == 0 {
|
||||||
|
return []string{"-o", "User=" + user}
|
||||||
|
}
|
||||||
|
return []string{"-" + string(c.user), user}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Operand is a remote scp argument such as user@host:/path.
|
||||||
|
type Operand struct {
|
||||||
|
Idx int
|
||||||
|
User string
|
||||||
|
Host string
|
||||||
|
Path string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Operands returns the remote operands of scp arguments. All remote operands
|
||||||
|
// must name the same host, because one set of options applies per call.
|
||||||
|
func (c Client) Operands(args []string) ([]Operand, error) {
|
||||||
|
start := c.optionsEnd(args)
|
||||||
|
var out []Operand
|
||||||
|
for i := start; i < len(args); i++ {
|
||||||
|
arg := args[i]
|
||||||
|
if strings.HasPrefix(arg, "scp://") || strings.HasPrefix(arg, "sftp://") {
|
||||||
|
return nil, fmt.Errorf("%q: use host:path instead of a URI", arg)
|
||||||
|
}
|
||||||
|
dest, path, remote := c.splitRemote(arg)
|
||||||
|
if !remote {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
host, user := splitUserHost(dest)
|
||||||
|
if host == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if len(out) > 0 && !strings.EqualFold(out[0].Host, host) {
|
||||||
|
return nil, fmt.Errorf("scp between two remote hosts (%s, %s) is not supported; copy in two steps", out[0].Host, host)
|
||||||
|
}
|
||||||
|
out = append(out, Operand{Idx: i, User: user, Host: host, Path: path})
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// optionsEnd returns the index of the first operand; scp, like ssh, stops
|
||||||
|
// option parsing at the first non-option or after "--".
|
||||||
|
func (c Client) optionsEnd(args []string) int {
|
||||||
|
end := c.insertionPoint(args)
|
||||||
|
if end < len(args) && args[end] == "--" {
|
||||||
|
end++
|
||||||
|
}
|
||||||
|
return end
|
||||||
|
}
|
||||||
|
|
||||||
|
// insertionPoint is where added options still count as options: before the
|
||||||
|
// first operand or before "--".
|
||||||
|
func (c Client) insertionPoint(args []string) int {
|
||||||
|
for i := 0; i < len(args); i++ {
|
||||||
|
arg := args[i]
|
||||||
|
if arg == "--" {
|
||||||
|
return i
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(arg, "-") || len(arg) < 2 {
|
||||||
|
return i
|
||||||
|
}
|
||||||
|
if c.takesSeparateValue(arg) {
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return len(args)
|
||||||
|
}
|
||||||
|
|
||||||
|
// splitRemote is splitHostPath with netssh's [user@]instance/host:path form.
|
||||||
|
func (c Client) splitRemote(arg string) (dest, path string, remote bool) {
|
||||||
|
if head, rest, ok := strings.Cut(arg, "/"); ok {
|
||||||
|
instance := head[strings.LastIndex(head, "@")+1:]
|
||||||
|
if c.instances[strings.ToLower(instance)] {
|
||||||
|
if d, p, r := splitHostPath(rest); r {
|
||||||
|
return head + "/" + d, p, true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return splitHostPath(arg)
|
||||||
|
}
|
||||||
|
|
||||||
|
// splitHostPath mirrors scp's colon(): an argument is remote when a ':' comes
|
||||||
|
// before any '/'. A leading "[" starts a bracketed IPv6 address.
|
||||||
|
func splitHostPath(arg string) (dest, path string, remote bool) {
|
||||||
|
if strings.HasPrefix(arg, "/") || strings.HasPrefix(arg, ".") {
|
||||||
|
return "", "", false
|
||||||
|
}
|
||||||
|
inBracket := false
|
||||||
|
for i := 0; i < len(arg); i++ {
|
||||||
|
switch arg[i] {
|
||||||
|
case '[':
|
||||||
|
inBracket = true
|
||||||
|
case ']':
|
||||||
|
inBracket = false
|
||||||
|
case '/':
|
||||||
|
if !inBracket {
|
||||||
|
return "", "", false
|
||||||
|
}
|
||||||
|
case ':':
|
||||||
|
if !inBracket {
|
||||||
|
return arg[:i], arg[i+1:], true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "", "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasForwardFlag reports whether -L, -R, or -D (or the -o equivalents) was given.
|
||||||
|
func (c Client) HasForwardFlag(args []string) bool {
|
||||||
|
return c.hasOption(args, 'L', "LocalForward") || c.hasOption(args, 'R', "RemoteForward") || c.hasOption(args, 'D', "DynamicForward")
|
||||||
|
}
|
||||||
@@ -0,0 +1,180 @@
|
|||||||
|
package ssh
|
||||||
|
|
||||||
|
import (
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestSFTPParse(t *testing.T) {
|
||||||
|
// -l is a bandwidth limit and -s takes a value for sftp, unlike ssh.
|
||||||
|
parsed := SFTP.Parse([]string{"-l", "100", "-s", "sub", "-P", "2222", "ops@web01:/var/log"})
|
||||||
|
if parsed == nil || parsed.Host != "web01" || parsed.User != "ops" || parsed.Path != "/var/log" || parsed.DestIdx != 6 {
|
||||||
|
t.Fatalf("got %+v", parsed)
|
||||||
|
}
|
||||||
|
if p := SFTP.Parse([]string{"prod/web01"}); p == nil || p.Host != "prod/web01" || p.Path != "" {
|
||||||
|
t.Fatalf("instance-qualified host: %+v", p)
|
||||||
|
}
|
||||||
|
if !SFTP.HasPortFlag([]string{"-P", "2222", "web"}) || SFTP.HasPortFlag([]string{"-p", "web"}) {
|
||||||
|
t.Fatal("sftp port flag is -P")
|
||||||
|
}
|
||||||
|
if SFTP.HasUserFlag([]string{"-l", "100", "web"}) || !SFTP.HasUserFlag([]string{"-o", "User=ops", "web"}) {
|
||||||
|
t.Fatal("sftp has no -l user flag")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSCPOperands(t *testing.T) {
|
||||||
|
ops, err := SCP.Operands([]string{"-X", "nrequests=8", "-r", "./local:dir", "/abs/file", "ops@web01:/tmp/", "web01:b"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := []Operand{{Idx: 5, User: "ops", Host: "web01", Path: "/tmp/"}, {Idx: 6, Host: "web01", Path: "b"}}
|
||||||
|
if !reflect.DeepEqual(ops, want) {
|
||||||
|
t.Fatalf("got %+v", ops)
|
||||||
|
}
|
||||||
|
if ops, _ := SCP.Operands([]string{"a.txt", "b.txt"}); len(ops) != 0 {
|
||||||
|
t.Fatalf("local copy has remote operands: %+v", ops)
|
||||||
|
}
|
||||||
|
if _, err := SCP.Operands([]string{"web01:a", "db01:b"}); err == nil {
|
||||||
|
t.Fatal("two remote hosts accepted")
|
||||||
|
}
|
||||||
|
if _, err := SCP.Operands([]string{"scp://web01/a", "."}); err == nil {
|
||||||
|
t.Fatal("URI accepted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSFTPApply(t *testing.T) {
|
||||||
|
args := []string{"-P", "2222", "ops@web01:/var/log"}
|
||||||
|
opts := config.SSHOptions{ProxyJump: "jh", ExtraArgs: []string{"-A"}, Forwards: map[string]config.Forward{"web": {Local: "1:a:2"}}}
|
||||||
|
got := SFTP.Apply(args, []int{2}, Host{Name: "web01", IP: "192.0.2.10"}, opts, WrapperFlags{ForwardArgs: []string{"-L", "1:a:2"}}).Args
|
||||||
|
want := []string{"-P", "2222", "-J", "jh", "ops@192.0.2.10:/var/log"}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("got %v, want %v (extra_args and forwards are ssh only)", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSCPApplyReplacesEveryOperandAndBracketsIPv6(t *testing.T) {
|
||||||
|
args := []string{"a.txt", "web01:/tmp/", "ops@web01:b"}
|
||||||
|
got := SCP.Apply(args, []int{1, 2}, Host{Name: "web01", IP: "2001:db8::1"}, config.SSHOptions{HostKeyChecking: "accept-new"}, WrapperFlags{}).Args
|
||||||
|
want := []string{"-o", "StrictHostKeyChecking=accept-new", "a.txt", "[2001:db8::1]:/tmp/", "ops@[2001:db8::1]:b"}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("got %v", got)
|
||||||
|
}
|
||||||
|
// sftp needs brackets even without a path; ssh never does.
|
||||||
|
if got := SFTP.Apply([]string{"web01"}, []int{0}, Host{Name: "web01", IP: "2001:db8::1"}, config.SSHOptions{}, WrapperFlags{}).Args; got[0] != "[2001:db8::1]" {
|
||||||
|
t.Fatalf("sftp: %v", got)
|
||||||
|
}
|
||||||
|
if got := apply([]string{"web01"}, config.SSHOptions{}, WrapperFlags{}); got.Args[0] != "192.0.2.10" {
|
||||||
|
t.Fatalf("ssh: %v", got.Args)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSFTPTargetName(t *testing.T) {
|
||||||
|
got := SFTP.Apply([]string{"web01:/srv"}, []int{0}, Host{Name: "web01.example.com", IP: "192.0.2.10"}, config.SSHOptions{Target: "name"}, WrapperFlags{}).Args
|
||||||
|
want := []string{"-o", "HostName=192.0.2.10", "-o", "HostKeyAlias=web01.example.com", "web01.example.com:/srv"}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("got %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestClientUserAndPortArgs(t *testing.T) {
|
||||||
|
if got := SSH.UserArgs("ops"); !reflect.DeepEqual(got, []string{"-l", "ops"}) {
|
||||||
|
t.Fatal(got)
|
||||||
|
}
|
||||||
|
if got := SCP.UserArgs("ops"); !reflect.DeepEqual(got, []string{"-o", "User=ops"}) {
|
||||||
|
t.Fatal(got)
|
||||||
|
}
|
||||||
|
if got := SFTP.PortArgs("2222"); !reflect.DeepEqual(got, []string{"-P", "2222"}) {
|
||||||
|
t.Fatal(got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestClientExtractWrapperFlags(t *testing.T) {
|
||||||
|
// For scp, -X takes a value; for ssh it does not.
|
||||||
|
flags, rest, err := SCP.ExtractWrapperFlags([]string{"-X", "--dry-run", "--dry-run", "a", "web:b"})
|
||||||
|
if err != nil || !flags.DryRun || !reflect.DeepEqual(rest, []string{"-X", "--dry-run", "a", "web:b"}) {
|
||||||
|
t.Fatalf("got %+v %v %v", flags, rest, err)
|
||||||
|
}
|
||||||
|
flags, rest, err = ExtractWrapperFlags([]string{"--forward", "web", "--forward=8080:localhost:80", "-v", "web01"})
|
||||||
|
if err != nil || !reflect.DeepEqual(flags.Forwards, []string{"web", "8080:localhost:80"}) || !reflect.DeepEqual(rest, []string{"-v", "web01"}) {
|
||||||
|
t.Fatalf("got %+v %v %v", flags, rest, err)
|
||||||
|
}
|
||||||
|
for _, args := range [][]string{{"--forward"}, {"--forward", "-L", "web"}} {
|
||||||
|
if _, _, err := ExtractWrapperFlags(args); err == nil {
|
||||||
|
t.Errorf("%v accepted", args)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForwardArgs(t *testing.T) {
|
||||||
|
available := map[string]config.Forward{"web": {Local: "8080:localhost:80"}, "socks": {Dynamic: "1080"}, "back": {Remote: "9000:localhost:9000"}}
|
||||||
|
got, err := ForwardArgs([]string{"WEB", "socks", "back", "5432:db:5432", "127.0.0.1:3000:localhost:3000"}, available)
|
||||||
|
want := []string{"-L", "8080:localhost:80", "-D", "1080", "-R", "9000:localhost:9000", "-L", "5432:db:5432", "-L", "127.0.0.1:3000:localhost:3000"}
|
||||||
|
if err != nil || !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("got %v %v", got, err)
|
||||||
|
}
|
||||||
|
if _, err := ForwardArgs([]string{"db"}, available); err == nil || !strings.Contains(err.Error(), "back, socks, web") {
|
||||||
|
t.Fatalf("unknown name: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := ForwardArgs([]string{"db"}, nil); err == nil || !strings.Contains(err.Error(), "no forwards are configured") {
|
||||||
|
t.Fatalf("no forwards: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplyForwardsAndTunnel(t *testing.T) {
|
||||||
|
flags := WrapperFlags{ForwardArgs: []string{"-L", "8080:localhost:80"}}
|
||||||
|
if got := apply([]string{"web"}, config.SSHOptions{}, flags).Args; !reflect.DeepEqual(got, []string{"-L", "8080:localhost:80", "192.0.2.10"}) {
|
||||||
|
t.Fatalf("forward: %v", got)
|
||||||
|
}
|
||||||
|
flags.Tunnel = true
|
||||||
|
result := apply([]string{"web"}, config.SSHOptions{}, flags)
|
||||||
|
want := []string{"-L", "8080:localhost:80", "-o", "ExitOnForwardFailure=yes", "-N", "192.0.2.10"}
|
||||||
|
if !reflect.DeepEqual(result.Args, want) || !strings.Contains(result.Notice, "forwarding -L 8080:localhost:80 via web.example.com") {
|
||||||
|
t.Fatalf("tunnel: %v %q", result.Args, result.Notice)
|
||||||
|
}
|
||||||
|
// The user's own ExitOnForwardFailure wins.
|
||||||
|
if got := apply([]string{"-o", "ExitOnForwardFailure=no", "web"}, config.SSHOptions{}, flags).Args; strings.Contains(strings.Join(got, " "), "=yes") {
|
||||||
|
t.Fatalf("overrode user option: %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHasForwardFlag(t *testing.T) {
|
||||||
|
for args, want := range map[string]bool{"-L 1:a:2 web": true, "-vD1080 web": true, "-o RemoteForward=1_a_2 web": true, "-l ops web": false, "web -L 1:a:2": false} {
|
||||||
|
if got := SSH.HasForwardFlag(strings.Fields(args)); got != want {
|
||||||
|
t.Errorf("%q: got %v", args, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplyInsertsOptionsBeforeDoubleDash(t *testing.T) {
|
||||||
|
got := Apply([]string{"-v", "--", "web"}, 2, Host{Name: "web", IP: "192.0.2.10"}, config.SSHOptions{ProxyJump: "jh"}, WrapperFlags{}).Args
|
||||||
|
if want := []string{"-v", "-J", "jh", "--", "192.0.2.10"}; !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("got %v, want %v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Instance-qualified hosts contain "/" before the ":" of host:path; only
|
||||||
|
// configured instances make such an argument remote.
|
||||||
|
func TestInstanceQualifiedHostPath(t *testing.T) {
|
||||||
|
scp := SCP.WithInstances([]string{"prod"})
|
||||||
|
ops, err := scp.Operands([]string{"a.txt", "ops@prod/web01:/tmp/", "dir/file:x"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if want := []Operand{{Idx: 1, User: "ops", Host: "prod/web01", Path: "/tmp/"}}; !reflect.DeepEqual(ops, want) {
|
||||||
|
t.Fatalf("got %+v", ops)
|
||||||
|
}
|
||||||
|
got := scp.Apply([]string{"a.txt", "ops@prod/web01:/tmp/"}, []int{1}, Host{Name: "web01", IP: "192.0.2.1"}, config.SSHOptions{}, WrapperFlags{}).Args
|
||||||
|
if want := []string{"a.txt", "ops@192.0.2.1:/tmp/"}; !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("apply: %v", got)
|
||||||
|
}
|
||||||
|
sftp := SFTP.WithInstances([]string{"prod"})
|
||||||
|
if p := sftp.Parse([]string{"prod/web01:/var/log"}); p == nil || p.Host != "prod/web01" || p.Path != "/var/log" {
|
||||||
|
t.Fatalf("sftp: %+v", p)
|
||||||
|
}
|
||||||
|
if ops, _ := SCP.Operands([]string{"prod/web01:/tmp/", "."}); len(ops) != 0 {
|
||||||
|
t.Fatalf("unknown instance must stay local: %+v", ops)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -9,11 +9,14 @@ import (
|
|||||||
|
|
||||||
// Exec replaces the current process with the native ssh client via syscall.Exec.
|
// Exec replaces the current process with the native ssh client via syscall.Exec.
|
||||||
// All existing SSH configs, keys, and agent forwarding remain intact.
|
// All existing SSH configs, keys, and agent forwarding remain intact.
|
||||||
func Exec(args []string) error {
|
func Exec(args []string) error { return SSH.Exec(args) }
|
||||||
sshPath, err := exec.LookPath("ssh")
|
|
||||||
|
// Exec replaces the current process with the client's binary.
|
||||||
|
func (c Client) Exec(args []string) error {
|
||||||
|
path, err := exec.LookPath(c.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("ssh not found in PATH: %w", err)
|
return fmt.Errorf("%s not found in PATH: %w", c.Name, err)
|
||||||
}
|
}
|
||||||
argv := append([]string{"ssh"}, args...)
|
argv := append([]string{c.Name}, args...)
|
||||||
return syscall.Exec(sshPath, argv, os.Environ())
|
return syscall.Exec(path, argv, os.Environ())
|
||||||
}
|
}
|
||||||
+109
-13
@@ -2,6 +2,7 @@ package ssh
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"net/netip"
|
||||||
"regexp"
|
"regexp"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -15,11 +16,21 @@ type WrapperFlags struct {
|
|||||||
DryRun bool
|
DryRun bool
|
||||||
Jump string // --jump HOST overrides the configured jump host
|
Jump string // --jump HOST overrides the configured jump host
|
||||||
NoJump bool // --no-jump disables any jump host, including ~/.ssh/config
|
NoJump bool // --no-jump disables any jump host, including ~/.ssh/config
|
||||||
|
Forwards []string // --forward NAME|SPEC, repeatable (ssh only)
|
||||||
|
// ForwardArgs are Forwards resolved by ForwardArgs; Apply inserts them.
|
||||||
|
ForwardArgs []string
|
||||||
|
// Tunnel runs ssh without a remote command (-N), for netssh tunnel.
|
||||||
|
Tunnel bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExtractWrapperFlags removes netssh's long options that appear before the
|
// ExtractWrapperFlags removes netssh's long options that appear before the
|
||||||
// destination. Anything after the destination belongs to the remote command.
|
// destination. Anything after the destination belongs to the remote command.
|
||||||
func ExtractWrapperFlags(args []string) (WrapperFlags, []string, error) {
|
func ExtractWrapperFlags(args []string) (WrapperFlags, []string, error) {
|
||||||
|
return SSH.ExtractWrapperFlags(args)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExtractWrapperFlags removes netssh's long options before the destination.
|
||||||
|
func (c Client) ExtractWrapperFlags(args []string) (WrapperFlags, []string, error) {
|
||||||
var flags WrapperFlags
|
var flags WrapperFlags
|
||||||
out := make([]string, 0, len(args))
|
out := make([]string, 0, len(args))
|
||||||
for i := 0; i < len(args); i++ {
|
for i := 0; i < len(args); i++ {
|
||||||
@@ -37,6 +48,14 @@ func ExtractWrapperFlags(args []string) (WrapperFlags, []string, error) {
|
|||||||
flags.Jump = args[i]
|
flags.Jump = args[i]
|
||||||
case strings.HasPrefix(arg, "--jump="):
|
case strings.HasPrefix(arg, "--jump="):
|
||||||
flags.Jump = strings.TrimPrefix(arg, "--jump=")
|
flags.Jump = strings.TrimPrefix(arg, "--jump=")
|
||||||
|
case arg == "--forward":
|
||||||
|
if i+1 >= len(args) {
|
||||||
|
return flags, nil, fmt.Errorf("--forward requires a name or spec")
|
||||||
|
}
|
||||||
|
i++
|
||||||
|
flags.Forwards = append(flags.Forwards, args[i])
|
||||||
|
case strings.HasPrefix(arg, "--forward="):
|
||||||
|
flags.Forwards = append(flags.Forwards, strings.TrimPrefix(arg, "--forward="))
|
||||||
case arg == "--" || !strings.HasPrefix(arg, "-") || len(arg) < 2:
|
case arg == "--" || !strings.HasPrefix(arg, "-") || len(arg) < 2:
|
||||||
// Destination or end of options: keep the rest unchanged.
|
// Destination or end of options: keep the rest unchanged.
|
||||||
return flags, append(out, args[i:]...), validateJump(flags)
|
return flags, append(out, args[i:]...), validateJump(flags)
|
||||||
@@ -45,7 +64,7 @@ func ExtractWrapperFlags(args []string) (WrapperFlags, []string, error) {
|
|||||||
default:
|
default:
|
||||||
out = append(out, arg)
|
out = append(out, arg)
|
||||||
// Keep the value of an ssh option such as -l USER together with it.
|
// Keep the value of an ssh option such as -l USER together with it.
|
||||||
if takesSeparateValue(arg) && i+1 < len(args) {
|
if c.takesSeparateValue(arg) && i+1 < len(args) {
|
||||||
i++
|
i++
|
||||||
out = append(out, args[i])
|
out = append(out, args[i])
|
||||||
}
|
}
|
||||||
@@ -64,14 +83,48 @@ func validateJump(flags WrapperFlags) error {
|
|||||||
if strings.HasPrefix(flags.Jump, "-") {
|
if strings.HasPrefix(flags.Jump, "-") {
|
||||||
return fmt.Errorf("--jump: invalid host %q", flags.Jump)
|
return fmt.Errorf("--jump: invalid host %q", flags.Jump)
|
||||||
}
|
}
|
||||||
|
for _, forward := range flags.Forwards {
|
||||||
|
if forward == "" || strings.HasPrefix(forward, "-") || strings.ContainsAny(forward, " \t\n") {
|
||||||
|
return fmt.Errorf("--forward: invalid value %q", forward)
|
||||||
|
}
|
||||||
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var adHocForward = regexp.MustCompile(`^([^\s:]+:)?[0-9]+(:[^\s]+:[0-9]+)?$`)
|
||||||
|
|
||||||
|
// ForwardArgs resolves forward names against the configured forwards. A value
|
||||||
|
// that is no configured name but looks like a port or [bind:]port:host:port
|
||||||
|
// is used as a local forward (-L).
|
||||||
|
func ForwardArgs(names []string, available map[string]config.Forward) ([]string, error) {
|
||||||
|
var out []string
|
||||||
|
for _, name := range names {
|
||||||
|
if forward, ok := available[strings.ToLower(name)]; ok {
|
||||||
|
out = append(out, forward.Flag()...)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if strings.Contains(name, ":") && adHocForward.MatchString(name) {
|
||||||
|
out = append(out, "-L", name)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
known := make([]string, 0, len(available))
|
||||||
|
for key := range available {
|
||||||
|
known = append(known, key)
|
||||||
|
}
|
||||||
|
sort.Strings(known)
|
||||||
|
if len(known) == 0 {
|
||||||
|
return nil, fmt.Errorf("unknown forward %q; no forwards are configured for this host (ssh.forwards), or pass a spec such as 8080:localhost:80", name)
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("unknown forward %q; available: %s", name, strings.Join(known, ", "))
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
// takesSeparateValue reports whether a short option cluster ends with a flag
|
// takesSeparateValue reports whether a short option cluster ends with a flag
|
||||||
// whose value is the next argument (e.g. "-l" or "-vp").
|
// whose value is the next argument (e.g. "-l" or "-vp").
|
||||||
func takesSeparateValue(arg string) bool {
|
func (c Client) takesSeparateValue(arg string) bool {
|
||||||
for j := 1; j < len(arg); j++ {
|
for j := 1; j < len(arg); j++ {
|
||||||
if flagsWithArg[arg[j]] {
|
if c.withArg[arg[j]] {
|
||||||
return j == len(arg)-1
|
return j == len(arg)-1
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -90,15 +143,35 @@ type Result struct {
|
|||||||
Notice string
|
Notice string
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var destinationName = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9._-]*$`)
|
||||||
|
|
||||||
|
// ValidAddress reports whether addr is an IP address or a hostname. Addresses
|
||||||
|
// come from NetBox and the cache file; one such as "-oProxyCommand=…" would be
|
||||||
|
// read by ssh as an option and run a command.
|
||||||
|
func ValidAddress(addr string) bool {
|
||||||
|
if _, err := netip.ParseAddr(addr); err == nil {
|
||||||
|
return !strings.ContainsAny(addr, " \t\r\n")
|
||||||
|
}
|
||||||
|
return destinationName.MatchString(addr)
|
||||||
|
}
|
||||||
|
|
||||||
var plainHostname = regexp.MustCompile(`^[A-Za-z0-9]([A-Za-z0-9._-]*[A-Za-z0-9])?$`)
|
var plainHostname = regexp.MustCompile(`^[A-Za-z0-9]([A-Za-z0-9._-]*[A-Za-z0-9])?$`)
|
||||||
|
|
||||||
// Apply replaces the destination at destIdx and inserts the configured -o
|
// Apply replaces the destination at destIdx and inserts the configured -o
|
||||||
// options directly before it. Explicit options given by the user come first,
|
// options directly before it. Explicit options given by the user come first,
|
||||||
// and ssh uses the first -o value it obtains, so the user's choice wins.
|
// and ssh uses the first -o value it obtains, so the user's choice wins.
|
||||||
func Apply(args []string, destIdx int, host Host, opts config.SSHOptions, flags WrapperFlags) Result {
|
func Apply(args []string, destIdx int, host Host, opts config.SSHOptions, flags WrapperFlags) Result {
|
||||||
|
return SSH.Apply(args, []int{destIdx}, host, opts, flags)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Apply replaces the host in every destination (several only for scp) and
|
||||||
|
// inserts the configured options before the first one. extra_args and
|
||||||
|
// forwards are ssh flags and apply to ssh only.
|
||||||
|
func (c Client) Apply(args []string, dests []int, host Host, opts config.SSHOptions, flags WrapperFlags) Result {
|
||||||
|
destIdx := dests[0]
|
||||||
var inserted []string
|
var inserted []string
|
||||||
add := func(keyword, value string) {
|
add := func(keyword, value string) {
|
||||||
if !hasOption(args[:destIdx], 0, keyword) {
|
if !c.hasOption(args[:destIdx], 0, keyword) {
|
||||||
inserted = append(inserted, "-o", keyword+"="+value)
|
inserted = append(inserted, "-o", keyword+"="+value)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -114,7 +187,7 @@ func Apply(args []string, destIdx int, host Host, opts config.SSHOptions, flags
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
userJump := hasOption(args[:destIdx], 'J', "ProxyJump") || hasOption(args[:destIdx], 0, "ProxyCommand")
|
userJump := c.hasOption(args[:destIdx], 'J', "ProxyJump") || c.hasOption(args[:destIdx], 0, "ProxyCommand")
|
||||||
switch {
|
switch {
|
||||||
case userJump:
|
case userJump:
|
||||||
case flags.NoJump:
|
case flags.NoJump:
|
||||||
@@ -140,7 +213,7 @@ func Apply(args []string, destIdx int, host Host, opts config.SSHOptions, flags
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if opts.AddressFamily != "" && !hasBoolFlag(args[:destIdx], '4') && !hasBoolFlag(args[:destIdx], '6') {
|
if opts.AddressFamily != "" && !c.hasBoolFlag(args[:destIdx], '4') && !c.hasBoolFlag(args[:destIdx], '6') {
|
||||||
add("AddressFamily", opts.AddressFamily)
|
add("AddressFamily", opts.AddressFamily)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -153,19 +226,42 @@ func Apply(args []string, destIdx int, host Host, opts config.SSHOptions, flags
|
|||||||
add(key, opts.Options[key])
|
add(key, opts.Options[key])
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var extra []string
|
||||||
|
if c.Name == SSH.Name {
|
||||||
|
extra = opts.ExtraArgs
|
||||||
|
inserted = append(inserted, flags.ForwardArgs...)
|
||||||
|
if flags.Tunnel {
|
||||||
|
add("ExitOnForwardFailure", "yes")
|
||||||
|
inserted = append(inserted, "-N")
|
||||||
|
forwards := strings.Join(flags.ForwardArgs, " ")
|
||||||
|
if forwards == "" {
|
||||||
|
forwards = "the given ports"
|
||||||
|
}
|
||||||
|
tunnel := fmt.Sprintf("forwarding %s via %s, press Ctrl+C to stop", forwards, host.Name)
|
||||||
|
if notice == "" {
|
||||||
|
notice = tunnel
|
||||||
|
} else {
|
||||||
|
notice += "\nnetssh: " + tunnel
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Extra arguments go first: short flags such as -4 or -A take the last
|
// Extra arguments go first: short flags such as -4 or -A take the last
|
||||||
// value given, so the user's own flags later on the line still win.
|
// value given, so the user's own flags later on the line still win.
|
||||||
replaced := ReplaceHost(args, destIdx, dest)
|
// Options go before the first operand: scp stops reading options there,
|
||||||
out := make([]string, 0, len(opts.ExtraArgs)+len(replaced)+len(inserted))
|
// and after "--" they would be taken as the destination.
|
||||||
out = append(out, opts.ExtraArgs...)
|
at := c.insertionPoint(args)
|
||||||
out = append(out, replaced[:destIdx]...)
|
replaced := c.replaceHost(args, dests, dest)
|
||||||
|
out := make([]string, 0, len(extra)+len(replaced)+len(inserted))
|
||||||
|
out = append(out, extra...)
|
||||||
|
out = append(out, replaced[:at]...)
|
||||||
out = append(out, inserted...)
|
out = append(out, inserted...)
|
||||||
out = append(out, replaced[destIdx:]...)
|
out = append(out, replaced[at:]...)
|
||||||
return Result{Args: out, Notice: notice}
|
return Result{Args: out, Notice: notice}
|
||||||
}
|
}
|
||||||
|
|
||||||
// hasBoolFlag reports whether a flag without a value, such as -4, was given.
|
// hasBoolFlag reports whether a flag without a value, such as -4, was given.
|
||||||
func hasBoolFlag(args []string, wanted byte) bool {
|
func (c Client) hasBoolFlag(args []string, wanted byte) bool {
|
||||||
for i := 0; i < len(args); i++ {
|
for i := 0; i < len(args); i++ {
|
||||||
arg := args[i]
|
arg := args[i]
|
||||||
if arg == "--" || len(arg) < 2 || arg[0] != '-' {
|
if arg == "--" || len(arg) < 2 || arg[0] != '-' {
|
||||||
@@ -175,7 +271,7 @@ func hasBoolFlag(args []string, wanted byte) bool {
|
|||||||
if arg[j] == wanted {
|
if arg[j] == wanted {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
if flagsWithArg[arg[j]] {
|
if c.withArg[arg[j]] {
|
||||||
if j == len(arg)-1 {
|
if j == len(arg)-1 {
|
||||||
i++
|
i++
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ func TestExtractWrapperFlags(t *testing.T) {
|
|||||||
{[]string{"--no-jump", "--", "web"}, WrapperFlags{NoJump: true}, []string{"--", "web"}},
|
{[]string{"--no-jump", "--", "web"}, WrapperFlags{NoJump: true}, []string{"--", "web"}},
|
||||||
} {
|
} {
|
||||||
flags, rest, err := ExtractWrapperFlags(tc.args)
|
flags, rest, err := ExtractWrapperFlags(tc.args)
|
||||||
if err != nil || flags != tc.flags || !reflect.DeepEqual(rest, tc.rest) {
|
if err != nil || !reflect.DeepEqual(flags, tc.flags) || !reflect.DeepEqual(rest, tc.rest) {
|
||||||
t.Errorf("%v: got %+v %v %v", tc.args, flags, rest, err)
|
t.Errorf("%v: got %+v %v %v", tc.args, flags, rest, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -128,3 +128,17 @@ func TestQuote(t *testing.T) {
|
|||||||
t.Fatalf("got %s", got)
|
t.Fatalf("got %s", got)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestValidAddress(t *testing.T) {
|
||||||
|
for _, addr := range []string{"10.0.0.1", "fd00:30::60", "fe80::1%eth0", "web01", "web01.example.com", "db_1.lan"} {
|
||||||
|
if !ValidAddress(addr) {
|
||||||
|
t.Errorf("ValidAddress(%q) = false, want true", addr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// ssh would read the first as an option and run the command.
|
||||||
|
for _, addr := range []string{"-oProxyCommand=touch /tmp/pwned", "-J", "", "a b", "host;id", "user@host", "host/path", "fe80::1%eth0 x", "$(id)"} {
|
||||||
|
if ValidAddress(addr) {
|
||||||
|
t.Errorf("ValidAddress(%q) = true, want false", addr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
package storage
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestWriteFileReplacesAtomically(t *testing.T) {
|
||||||
|
dir := filepath.Join(t.TempDir(), "new", "dir")
|
||||||
|
path := filepath.Join(dir, "file")
|
||||||
|
for _, content := range []string{"first", "second"} {
|
||||||
|
if err := WriteFile(path, []byte(content), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got, err := os.ReadFile(path)
|
||||||
|
if err != nil || string(got) != content {
|
||||||
|
t.Fatalf("got %q, %v; want %q", got, err, content)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
info, err := os.Stat(path)
|
||||||
|
if err != nil || info.Mode().Perm() != 0o600 {
|
||||||
|
t.Errorf("mode %v, %v; want 0600", info.Mode().Perm(), err)
|
||||||
|
}
|
||||||
|
entries, _ := os.ReadDir(dir)
|
||||||
|
if len(entries) != 1 {
|
||||||
|
t.Errorf("temporary files left behind: %v", entries)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -9,6 +9,7 @@ import (
|
|||||||
|
|
||||||
tea "charm.land/bubbletea/v2"
|
tea "charm.land/bubbletea/v2"
|
||||||
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/cache"
|
"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/netbox"
|
"git.zb-server.de/Sebi/ssh-netbox-wrapper/internal/netbox"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -79,3 +80,116 @@ func TestPartialOutageKeepsLiveAndCachedResultsVisible(t *testing.T) {
|
|||||||
t.Fatalf("outage warning overflowed view: %d", rows)
|
t.Fatalf("outage warning overflowed view: %d", rows)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestHiddenPrefixKeepsCanonicalTargets(t *testing.T) {
|
||||||
|
cfg := config.Config{NetBoxes: []config.NetBoxConfig{
|
||||||
|
{Name: "OFFICE", DisablePrefix: true}, {Name: "lab"},
|
||||||
|
}}
|
||||||
|
for _, cached := range []bool{false, true} {
|
||||||
|
for _, action := range []string{"ssh", "sftp", "multi", "autocomplete", "edit", "tunnel"} {
|
||||||
|
t.Run(fmt.Sprintf("cached=%v/%s", cached, action), func(t *testing.T) {
|
||||||
|
m := New(nil, nil, "")
|
||||||
|
m.SetHostLabel(cfg.HostLabel)
|
||||||
|
m.Update(tea.WindowSizeMsg{Width: 100, Height: 24})
|
||||||
|
entries := []netbox.HostEntry{
|
||||||
|
{Source: "office", Name: "web01", PrimaryIP4: "10.0.0.1"},
|
||||||
|
{Source: "lab", Name: "web01", PrimaryIP4: "10.0.0.2"},
|
||||||
|
}
|
||||||
|
if cached {
|
||||||
|
for i := range entries {
|
||||||
|
entries[i].Name = entries[i].Target()
|
||||||
|
entries[i].Source = ""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
m.updateListItems(entries)
|
||||||
|
item := m.list.Items()[0].(hostItem)
|
||||||
|
if item.Title() != "web01" || item.name != "office/web01" {
|
||||||
|
t.Fatalf("display changed identity: %+v", item)
|
||||||
|
}
|
||||||
|
view := m.View().Content
|
||||||
|
if strings.Contains(view, "office/web01") || !strings.Contains(view, "lab/web01") {
|
||||||
|
t.Fatalf("wrong rendered prefixes: %s", view)
|
||||||
|
}
|
||||||
|
switch action {
|
||||||
|
case "ssh", "sftp":
|
||||||
|
key := tea.KeyPressMsg{Code: tea.KeyEnter}
|
||||||
|
if action == "sftp" {
|
||||||
|
key = tea.KeyPressMsg{Code: 'o', Mod: tea.ModCtrl}
|
||||||
|
}
|
||||||
|
m.Update(key)
|
||||||
|
if m.selected == nil || m.selected.Name != "office/web01" {
|
||||||
|
t.Fatalf("lost instance: %+v", m.selected)
|
||||||
|
}
|
||||||
|
case "multi":
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeySpace, Text: " "})
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeyEnter})
|
||||||
|
if m.selected == nil || len(m.selected.Targets) != 1 || m.selected.Targets[0] != "office/web01" {
|
||||||
|
t.Fatalf("multi lost instance: %+v", m.selected)
|
||||||
|
}
|
||||||
|
case "autocomplete":
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeyTab})
|
||||||
|
if m.input.Value() != "office/web01" {
|
||||||
|
t.Fatal("autocomplete lost instance")
|
||||||
|
}
|
||||||
|
case "edit":
|
||||||
|
m.Update(tea.KeyPressMsg{Code: 'e', Mod: tea.ModCtrl})
|
||||||
|
if m.editHost == nil || m.editHost.name != "office/web01" {
|
||||||
|
t.Fatal("editor lost instance")
|
||||||
|
}
|
||||||
|
case "tunnel":
|
||||||
|
m.Update(tea.KeyPressMsg{Code: 't', Mod: tea.ModCtrl})
|
||||||
|
if m.forwardHost == nil || m.forwardHost.name != "office/web01" {
|
||||||
|
t.Fatal("tunnel lost instance")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHiddenPrefixDuplicateLabels(t *testing.T) {
|
||||||
|
cfg := config.Config{NetBoxes: []config.NetBoxConfig{
|
||||||
|
{Name: "office", DisablePrefix: true}, {Name: "lab", DisablePrefix: true},
|
||||||
|
}}
|
||||||
|
for _, other := range []netbox.HostEntry{
|
||||||
|
{Source: "lab", Name: "WEB"},
|
||||||
|
{Name: "web", Kind: "static"},
|
||||||
|
} {
|
||||||
|
m := New(nil, nil, "")
|
||||||
|
m.SetHostLabel(cfg.HostLabel)
|
||||||
|
m.updateListItems([]netbox.HostEntry{{Source: "office", Name: "web"}, other})
|
||||||
|
for _, entry := range m.list.Items() {
|
||||||
|
item := entry.(hostItem)
|
||||||
|
if item.Title() != item.name {
|
||||||
|
t.Fatalf("ambiguous label: %+v", item)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAliasesShownNextToHostName(t *testing.T) {
|
||||||
|
m := New(nil, cache.New("", 3600), "")
|
||||||
|
m.SetAliases(func(target string) string {
|
||||||
|
return map[string]string{"fsn1-bx1.hoster.de": "fsnbx1", "web01": "web01"}[target]
|
||||||
|
})
|
||||||
|
m.updateListItems([]netbox.HostEntry{{Name: "fsn1-bx1.hoster.de", PrimaryIP4: "10.0.0.1"}, {Name: "web01", PrimaryIP4: "10.0.0.2"}})
|
||||||
|
items := m.list.Items()
|
||||||
|
if got := items[0].(hostItem).alias; got != "fsnbx1" {
|
||||||
|
t.Fatalf("alias = %q", got)
|
||||||
|
}
|
||||||
|
// An alias equal to the shown name is not repeated.
|
||||||
|
if got := items[1].(hostItem).alias; got != "" {
|
||||||
|
t.Fatalf("redundant alias %q", got)
|
||||||
|
}
|
||||||
|
var b strings.Builder
|
||||||
|
compactDelegate{marked: map[string]bool{}}.Render(&b, m.list, 1, items[0])
|
||||||
|
if !strings.Contains(b.String(), "fsn1-bx1.hoster.de") || !strings.Contains(b.String(), "→ fsnbx1") {
|
||||||
|
t.Fatalf("row %q", b.String())
|
||||||
|
}
|
||||||
|
// Without SetAliases nothing changes.
|
||||||
|
plain := New(nil, cache.New("", 3600), "")
|
||||||
|
plain.updateListItems([]netbox.HostEntry{{Name: "fsn1-bx1.hoster.de"}})
|
||||||
|
if got := plain.list.Items()[0].(hostItem).alias; got != "" {
|
||||||
|
t.Fatalf("alias without SetAliases: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
+397
-11
@@ -22,13 +22,25 @@ import (
|
|||||||
|
|
||||||
// SelectedHost is returned when the user confirms a host in the TUI.
|
// SelectedHost is returned when the user confirms a host in the TUI.
|
||||||
type SelectedHost struct {
|
type SelectedHost struct {
|
||||||
|
Command string
|
||||||
Kind string
|
Kind string
|
||||||
Name string
|
Name string
|
||||||
IP string
|
IP string
|
||||||
User string // empty = use config default
|
User string // empty = use config default
|
||||||
Port string // empty = use default port
|
Port string // empty = use default port
|
||||||
|
Action string // ActionSSH, ActionSFTP, ActionTunnel, or ActionMulti
|
||||||
|
Forwards []string // forward names or specs for ActionTunnel
|
||||||
|
Targets []string // marked hosts for ActionMulti
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Actions the user can start on a host.
|
||||||
|
const (
|
||||||
|
ActionSSH = ""
|
||||||
|
ActionSFTP = "sftp"
|
||||||
|
ActionTunnel = "tunnel"
|
||||||
|
ActionMulti = "multi"
|
||||||
|
)
|
||||||
|
|
||||||
// --- bubbletea messages ---
|
// --- bubbletea messages ---
|
||||||
|
|
||||||
type debounceMsg struct {
|
type debounceMsg struct {
|
||||||
@@ -52,6 +64,10 @@ type searchResultMsg struct {
|
|||||||
// --- list item ---
|
// --- list item ---
|
||||||
|
|
||||||
type hostItem struct {
|
type hostItem struct {
|
||||||
|
provenance string
|
||||||
|
favorite, pinned bool
|
||||||
|
label string // display only; name remains the canonical target
|
||||||
|
alias string // shortcut alias shown next to the name (shortcuts.show)
|
||||||
name string
|
name string
|
||||||
id int
|
id int
|
||||||
ip string
|
ip string
|
||||||
@@ -59,13 +75,19 @@ type hostItem struct {
|
|||||||
tags []string
|
tags []string
|
||||||
}
|
}
|
||||||
|
|
||||||
func (h hostItem) Title() string { return h.name }
|
func (h hostItem) Title() string {
|
||||||
|
if h.label != "" {
|
||||||
|
return h.label
|
||||||
|
}
|
||||||
|
return h.name
|
||||||
|
}
|
||||||
func (h hostItem) Description() string { return fmt.Sprintf("%s [%s]", h.ip, h.kind) }
|
func (h hostItem) Description() string { return fmt.Sprintf("%s [%s]", h.ip, h.kind) }
|
||||||
func (h hostItem) FilterValue() string { return h.name }
|
func (h hostItem) FilterValue() string { return h.name }
|
||||||
|
|
||||||
// --- compact list delegate ---
|
// --- compact list delegate ---
|
||||||
|
|
||||||
type compactDelegate struct{}
|
// compactDelegate shares the model's marks so marked hosts show a dot.
|
||||||
|
type compactDelegate struct{ marked map[string]bool }
|
||||||
|
|
||||||
func (d compactDelegate) Height() int { return 1 }
|
func (d compactDelegate) Height() int { return 1 }
|
||||||
func (d compactDelegate) Spacing() int { return 0 }
|
func (d compactDelegate) Spacing() int { return 0 }
|
||||||
@@ -75,7 +97,24 @@ func (d compactDelegate) Render(w io.Writer, m list.Model, index int, item list.
|
|||||||
if !ok {
|
if !ok {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
line := fmt.Sprintf(" %s %s", h.name, lipgloss.NewStyle().Foreground(lipgloss.Color("240")).Render(h.ip))
|
mark := " "
|
||||||
|
if d.marked[h.key()] {
|
||||||
|
mark = "● "
|
||||||
|
}
|
||||||
|
title := h.Title()
|
||||||
|
if h.alias != "" {
|
||||||
|
title += " " + lipgloss.NewStyle().Foreground(lipgloss.Color("109")).Render("→ "+h.alias)
|
||||||
|
}
|
||||||
|
badge := ""
|
||||||
|
if h.pinned {
|
||||||
|
badge = "◆ "
|
||||||
|
} else if h.favorite {
|
||||||
|
badge = "★ "
|
||||||
|
}
|
||||||
|
line := fmt.Sprintf(" %s%s %s", mark+badge, title, lipgloss.NewStyle().Foreground(lipgloss.Color("240")).Render(h.ip))
|
||||||
|
if h.provenance != "" {
|
||||||
|
line += " [" + h.provenance + "]"
|
||||||
|
}
|
||||||
if index == m.Index() {
|
if index == m.Index() {
|
||||||
line = lipgloss.NewStyle().Bold(true).Foreground(lipgloss.Color("86")).Render("> " + strings.TrimPrefix(line, " "))
|
line = lipgloss.NewStyle().Bold(true).Foreground(lipgloss.Color("86")).Render("> " + strings.TrimPrefix(line, " "))
|
||||||
}
|
}
|
||||||
@@ -134,6 +173,14 @@ func applyFilter(entries []netbox.HostEntry, f filterOpts) []netbox.HostEntry {
|
|||||||
// --- Model ---
|
// --- Model ---
|
||||||
|
|
||||||
type Model struct {
|
type Model struct {
|
||||||
|
historyLimit int
|
||||||
|
favorites, pinned map[string]bool
|
||||||
|
savePreferences func(map[string]bool, map[string]bool) error
|
||||||
|
commandsFor func(string, string, []string) []string
|
||||||
|
actionHost *hostItem
|
||||||
|
actionNames []string
|
||||||
|
actionIndex int
|
||||||
|
|
||||||
noteErr error
|
noteErr error
|
||||||
editHost *hostItem
|
editHost *hostItem
|
||||||
noteInput textarea.Model
|
noteInput textarea.Model
|
||||||
@@ -145,6 +192,9 @@ type Model struct {
|
|||||||
input textinput.Model
|
input textinput.Model
|
||||||
filterInput textinput.Model // tag:X kind:Y filter, toggled with ctrl+f
|
filterInput textinput.Model // tag:X kind:Y filter, toggled with ctrl+f
|
||||||
editInput textinput.Model // user@host:port inline editor
|
editInput textinput.Model // user@host:port inline editor
|
||||||
|
forwardInput textinput.Model // forward names/specs, ctrl+t
|
||||||
|
forwardHost *hostItem
|
||||||
|
forwardsFor func(name, kind string, tags []string) []string
|
||||||
list list.Model
|
list list.Model
|
||||||
client *netbox.Client
|
client *netbox.Client
|
||||||
cache *cache.Cache
|
cache *cache.Cache
|
||||||
@@ -160,6 +210,11 @@ type Model struct {
|
|||||||
recentMode bool // true when showing recent hosts (empty search, initial state)
|
recentMode bool // true when showing recent hosts (empty search, initial state)
|
||||||
filterOpen bool // Ctrl+F toggles
|
filterOpen bool // Ctrl+F toggles
|
||||||
editMode bool // Ctrl+E on the selected item
|
editMode bool // Ctrl+E on the selected item
|
||||||
|
forwardMode bool // Ctrl+T on the selected item
|
||||||
|
marked map[string]bool // hostItem.key() of hosts marked with space
|
||||||
|
hostLabel func(string) string
|
||||||
|
aliasFor func(string) string // shortcut alias per target, "" for none
|
||||||
|
markOrder []string // targets in the order they were marked
|
||||||
}
|
}
|
||||||
|
|
||||||
func New(client *netbox.Client, c *cache.Cache, defaultUser string, defaultPorts ...int) *Model {
|
func New(client *netbox.Client, c *cache.Cache, defaultUser string, defaultPorts ...int) *Model {
|
||||||
@@ -174,7 +229,12 @@ func New(client *netbox.Client, c *cache.Cache, defaultUser string, defaultPorts
|
|||||||
ei := textinput.New()
|
ei := textinput.New()
|
||||||
ei.Prompt = ""
|
ei.Prompt = ""
|
||||||
|
|
||||||
l := list.New(nil, compactDelegate{}, 0, 0)
|
fwd := textinput.New()
|
||||||
|
fwd.Prompt = ""
|
||||||
|
fwd.Placeholder = "web, 8080:localhost:80"
|
||||||
|
|
||||||
|
marked := make(map[string]bool)
|
||||||
|
l := list.New(nil, compactDelegate{marked: marked}, 0, 0)
|
||||||
l.SetShowHelp(false)
|
l.SetShowHelp(false)
|
||||||
l.SetShowTitle(false)
|
l.SetShowTitle(false)
|
||||||
l.SetShowStatusBar(false)
|
l.SetShowStatusBar(false)
|
||||||
@@ -189,11 +249,14 @@ func New(client *netbox.Client, c *cache.Cache, defaultUser string, defaultPorts
|
|||||||
ni.CharLimit = 0
|
ni.CharLimit = 0
|
||||||
ni.SetHeight(10)
|
ni.SetHeight(10)
|
||||||
return &Model{
|
return &Model{
|
||||||
|
historyLimit: 10, favorites: map[string]bool{}, pinned: map[string]bool{},
|
||||||
noteInput: ni,
|
noteInput: ni,
|
||||||
defaultPort: port,
|
defaultPort: port,
|
||||||
input: ti,
|
input: ti,
|
||||||
filterInput: fi,
|
filterInput: fi,
|
||||||
editInput: ei,
|
editInput: ei,
|
||||||
|
forwardInput: fwd,
|
||||||
|
marked: marked,
|
||||||
list: l,
|
list: l,
|
||||||
client: client,
|
client: client,
|
||||||
cache: c,
|
cache: c,
|
||||||
@@ -208,14 +271,40 @@ func (m *Model) Init() tea.Cmd {
|
|||||||
|
|
||||||
// loadRecent returns a Cmd that immediately resolves to the recently-used host list.
|
// loadRecent returns a Cmd that immediately resolves to the recently-used host list.
|
||||||
func (m *Model) loadRecent() tea.Cmd {
|
func (m *Model) loadRecent() tea.Cmd {
|
||||||
|
favoriteNames, pinned, limit := copyBools(m.favorites), copyBools(m.pinned), m.historyLimit
|
||||||
return func() tea.Msg {
|
return func() tea.Msg {
|
||||||
if m.cache == nil {
|
if m.cache == nil {
|
||||||
return searchResultMsg{query: "", entries: nil, recent: true}
|
return searchResultMsg{query: "", entries: nil, recent: true}
|
||||||
}
|
}
|
||||||
recent := m.cache.RecentlyUsed(10)
|
recent := m.cache.RecentlyUsed(limit)
|
||||||
|
seen := map[string]bool{}
|
||||||
|
var favorites []cache.Entry
|
||||||
|
for name, enabled := range favoriteNames {
|
||||||
|
if !enabled {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
e, _ := m.cache.Get(name)
|
||||||
|
if e.Name == "" {
|
||||||
|
e.Name = name
|
||||||
|
}
|
||||||
|
favorites = append(favorites, e)
|
||||||
|
seen[name] = true
|
||||||
|
}
|
||||||
|
sort.Slice(favorites, func(i, j int) bool {
|
||||||
|
if pinned[favorites[i].Name] != pinned[favorites[j].Name] {
|
||||||
|
return pinned[favorites[i].Name]
|
||||||
|
}
|
||||||
|
return favorites[i].Name < favorites[j].Name
|
||||||
|
})
|
||||||
|
for _, e := range recent {
|
||||||
|
if !seen[e.Name] {
|
||||||
|
favorites = append(favorites, e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
recent = favorites
|
||||||
entries := make([]netbox.HostEntry, len(recent))
|
entries := make([]netbox.HostEntry, len(recent))
|
||||||
for i, e := range recent {
|
for i, e := range recent {
|
||||||
entries[i] = netbox.HostEntry{Name: e.Name, PrimaryIP4: e.IP, Kind: e.Kind, Tags: e.Tags}
|
entries[i] = netbox.HostEntry{Name: e.Name, PrimaryIP4: e.IP, Kind: e.Kind, Tags: e.Tags, Cached: true, CachedAt: e.CachedAt, Static: e.Static}
|
||||||
}
|
}
|
||||||
return searchResultMsg{query: "", entries: entries, recent: true}
|
return searchResultMsg{query: "", entries: entries, recent: true}
|
||||||
}
|
}
|
||||||
@@ -252,6 +341,34 @@ func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
|
|||||||
if msg.String() == "ctrl+c" {
|
if msg.String() == "ctrl+c" {
|
||||||
return m, tea.Quit
|
return m, tea.Quit
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if m.actionHost != nil {
|
||||||
|
switch msg.String() {
|
||||||
|
case "esc":
|
||||||
|
m.actionHost = nil
|
||||||
|
case "up":
|
||||||
|
if m.actionIndex > 0 {
|
||||||
|
m.actionIndex--
|
||||||
|
}
|
||||||
|
case "down":
|
||||||
|
if m.actionIndex+1 < len(m.actionNames) {
|
||||||
|
m.actionIndex++
|
||||||
|
}
|
||||||
|
case "enter":
|
||||||
|
h := m.actionHost
|
||||||
|
if m.actionIndex == 0 {
|
||||||
|
if len(m.markOrder) > 0 {
|
||||||
|
m.selected = &SelectedHost{Action: ActionMulti, Targets: append([]string(nil), m.markOrder...)}
|
||||||
|
} else {
|
||||||
|
m.selected = &SelectedHost{Name: h.name, Kind: h.kind, IP: h.ip}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
m.selected = &SelectedHost{Name: h.name, Kind: h.kind, IP: h.ip, Command: m.actionNames[m.actionIndex], Targets: append([]string(nil), m.markOrder...)}
|
||||||
|
}
|
||||||
|
return m, tea.Quit
|
||||||
|
}
|
||||||
|
return m, nil
|
||||||
|
}
|
||||||
if m.noteMode {
|
if m.noteMode {
|
||||||
if m.noteBusy {
|
if m.noteBusy {
|
||||||
return m, nil
|
return m, nil
|
||||||
@@ -281,6 +398,30 @@ func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
|
|||||||
m.noteInput, cmd = m.noteInput.Update(msg)
|
m.noteInput, cmd = m.noteInput.Update(msg)
|
||||||
return m, cmd
|
return m, cmd
|
||||||
}
|
}
|
||||||
|
// --- Forward mode ---
|
||||||
|
if m.forwardMode {
|
||||||
|
switch msg.String() {
|
||||||
|
case "esc":
|
||||||
|
m.forwardMode = false
|
||||||
|
m.forwardInput.Blur()
|
||||||
|
m.input.Focus()
|
||||||
|
m.err = nil
|
||||||
|
return m, nil
|
||||||
|
case "enter":
|
||||||
|
item := *m.forwardHost
|
||||||
|
forwards, err := parseForwards(m.forwardInput.Value(), m.availableForwards(item))
|
||||||
|
if err != nil {
|
||||||
|
m.err = err
|
||||||
|
return m, nil
|
||||||
|
}
|
||||||
|
m.selected = &SelectedHost{Name: item.name, IP: item.ip, Kind: item.kind, Action: ActionTunnel, Forwards: forwards}
|
||||||
|
return m, tea.Quit
|
||||||
|
}
|
||||||
|
var cmd tea.Cmd
|
||||||
|
m.forwardInput, cmd = m.forwardInput.Update(msg)
|
||||||
|
return m, cmd
|
||||||
|
}
|
||||||
|
|
||||||
// --- Edit mode ---
|
// --- Edit mode ---
|
||||||
if m.editMode {
|
if m.editMode {
|
||||||
switch msg.String() {
|
switch msg.String() {
|
||||||
@@ -337,6 +478,43 @@ func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
|
|||||||
case "ctrl+c", "esc":
|
case "ctrl+c", "esc":
|
||||||
return m, tea.Quit
|
return m, tea.Quit
|
||||||
|
|
||||||
|
case "ctrl+r":
|
||||||
|
if h, ok := m.list.SelectedItem().(hostItem); ok {
|
||||||
|
m.actionHost = &h
|
||||||
|
m.actionIndex = 0
|
||||||
|
m.actionNames = []string{"SSH"}
|
||||||
|
if m.commandsFor != nil {
|
||||||
|
m.actionNames = append(m.actionNames, m.commandsFor(h.name, h.kind, h.tags)...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return m, nil
|
||||||
|
case "ctrl+d", "ctrl+p":
|
||||||
|
if h, ok := m.list.SelectedItem().(hostItem); ok {
|
||||||
|
favorites, pinned := copyBools(m.favorites), copyBools(m.pinned)
|
||||||
|
if msg.String() == "ctrl+p" {
|
||||||
|
pinned[h.name] = !pinned[h.name]
|
||||||
|
if pinned[h.name] {
|
||||||
|
favorites[h.name] = true
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
favorites[h.name] = !favorites[h.name]
|
||||||
|
if !favorites[h.name] {
|
||||||
|
delete(pinned, h.name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if m.savePreferences != nil {
|
||||||
|
if err := m.savePreferences(favorites, pinned); err != nil {
|
||||||
|
m.err = err
|
||||||
|
return m, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
m.favorites, m.pinned = favorites, pinned
|
||||||
|
m.updateListItems(m.lastResults)
|
||||||
|
if m.recentMode && m.input.Value() == "" {
|
||||||
|
return m, m.loadRecent()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return m, nil
|
||||||
case "ctrl+f":
|
case "ctrl+f":
|
||||||
m.filterOpen = true
|
m.filterOpen = true
|
||||||
m.input.Blur()
|
m.input.Blur()
|
||||||
@@ -344,17 +522,49 @@ func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
|
|||||||
return m, nil
|
return m, nil
|
||||||
|
|
||||||
case "enter":
|
case "enter":
|
||||||
|
if len(m.markOrder) > 0 {
|
||||||
|
m.selected = &SelectedHost{Action: ActionMulti, Targets: append([]string(nil), m.markOrder...)}
|
||||||
|
return m, tea.Quit
|
||||||
|
}
|
||||||
if item, ok := m.list.SelectedItem().(hostItem); ok {
|
if item, ok := m.list.SelectedItem().(hostItem); ok {
|
||||||
m.selected = &SelectedHost{Name: item.name, IP: item.ip, Kind: item.kind}
|
m.selected = &SelectedHost{Name: item.name, IP: item.ip, Kind: item.kind}
|
||||||
return m, tea.Quit
|
return m, tea.Quit
|
||||||
}
|
}
|
||||||
|
|
||||||
|
case "space":
|
||||||
|
if item, ok := m.list.SelectedItem().(hostItem); ok {
|
||||||
|
m.toggleMark(item)
|
||||||
|
m.list.CursorDown()
|
||||||
|
return m, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
case "ctrl+a":
|
||||||
|
m.toggleAllVisible()
|
||||||
|
return m, nil
|
||||||
|
|
||||||
case "ctrl+e":
|
case "ctrl+e":
|
||||||
if item, ok := m.list.SelectedItem().(hostItem); ok {
|
if item, ok := m.list.SelectedItem().(hostItem); ok {
|
||||||
m.openEdit(item)
|
m.openEdit(item)
|
||||||
return m, nil
|
return m, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
case "ctrl+o":
|
||||||
|
if item, ok := m.list.SelectedItem().(hostItem); ok {
|
||||||
|
m.selected = &SelectedHost{Name: item.name, IP: item.ip, Kind: item.kind, Action: ActionSFTP}
|
||||||
|
return m, tea.Quit
|
||||||
|
}
|
||||||
|
|
||||||
|
case "ctrl+t":
|
||||||
|
if item, ok := m.list.SelectedItem().(hostItem); ok {
|
||||||
|
m.forwardMode = true
|
||||||
|
m.forwardHost = &item
|
||||||
|
m.err = nil
|
||||||
|
m.input.Blur()
|
||||||
|
m.forwardInput.SetValue("")
|
||||||
|
m.forwardInput.Focus()
|
||||||
|
return m, nil
|
||||||
|
}
|
||||||
|
|
||||||
case "ctrl+n", "ctrl+b":
|
case "ctrl+n", "ctrl+b":
|
||||||
if item, ok := m.list.SelectedItem().(hostItem); ok && m.noteService != nil {
|
if item, ok := m.list.SelectedItem().(hostItem); ok && m.noteService != nil {
|
||||||
m.noteMode = true
|
m.noteMode = true
|
||||||
@@ -465,6 +675,24 @@ func (m *Model) View() tea.View {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (m *Model) viewContent() string {
|
func (m *Model) viewContent() string {
|
||||||
|
if m.actionHost != nil {
|
||||||
|
var out strings.Builder
|
||||||
|
fmt.Fprintf(&out, "Action for %s", m.actionHost.Title())
|
||||||
|
if len(m.markOrder) > 0 {
|
||||||
|
fmt.Fprintf(&out, " (%d marked hosts)", len(m.markOrder))
|
||||||
|
}
|
||||||
|
out.WriteString("\n\n")
|
||||||
|
for i, n := range m.actionNames {
|
||||||
|
marker := " "
|
||||||
|
if i == m.actionIndex {
|
||||||
|
marker = "> "
|
||||||
|
}
|
||||||
|
fmt.Fprintf(&out, "%s%s\n", marker, n)
|
||||||
|
}
|
||||||
|
out.WriteString("\n↑/↓ select enter run esc cancel\n")
|
||||||
|
return out.String()
|
||||||
|
}
|
||||||
|
|
||||||
if m.noteMode {
|
if m.noteMode {
|
||||||
target := "local"
|
target := "local"
|
||||||
if m.noteRemote {
|
if m.noteRemote {
|
||||||
@@ -509,13 +737,26 @@ func (m *Model) viewContent() string {
|
|||||||
sb.WriteString(m.list.View())
|
sb.WriteString(m.list.View())
|
||||||
}
|
}
|
||||||
|
|
||||||
if m.editMode {
|
if m.forwardMode {
|
||||||
|
dim := lipgloss.NewStyle().Foreground(lipgloss.Color("240"))
|
||||||
|
sb.WriteString("\n" + dim.Render("Forward via "+m.forwardHost.name+": "))
|
||||||
|
sb.WriteString(m.forwardInput.View() + "\n")
|
||||||
|
available := "none configured — enter specs such as 8080:localhost:80"
|
||||||
|
if names := m.availableForwards(*m.forwardHost); len(names) > 0 {
|
||||||
|
available = strings.Join(names, ", ")
|
||||||
|
}
|
||||||
|
sb.WriteString(dim.Render(" forwards: "+available) + "\n")
|
||||||
|
sb.WriteString(dim.Render(" enter start tunnel esc cancel") + "\n")
|
||||||
|
} else if m.editMode {
|
||||||
sb.WriteString("\n")
|
sb.WriteString("\n")
|
||||||
sb.WriteString(lipgloss.NewStyle().Foreground(lipgloss.Color("240")).Render("Connect as: "))
|
sb.WriteString(lipgloss.NewStyle().Foreground(lipgloss.Color("240")).Render("Connect as: "))
|
||||||
sb.WriteString(m.editInput.View() + "\n")
|
sb.WriteString(m.editInput.View() + "\n")
|
||||||
sb.WriteString(lipgloss.NewStyle().Foreground(lipgloss.Color("240")).Render(" enter connect esc cancel") + "\n")
|
sb.WriteString(lipgloss.NewStyle().Foreground(lipgloss.Color("240")).Render(" enter connect esc cancel") + "\n")
|
||||||
} else {
|
} else {
|
||||||
hint := "ctrl+c quit enter connect ctrl+e edit ctrl+f filter ctrl+n notes ctrl+b NetBox"
|
hint := "ctrl+r actions ctrl+d favorite ctrl+p pin ctrl+c quit enter connect space mark ctrl+o sftp ctrl+t forward ctrl+e edit ctrl+f filter ctrl+n notes ctrl+b NetBox"
|
||||||
|
if n := len(m.markOrder); n > 0 {
|
||||||
|
hint = fmt.Sprintf("%d marked — enter open side by side space unmark ctrl+a all esc quit", n)
|
||||||
|
}
|
||||||
sb.WriteString("\n" + lipgloss.NewStyle().Foreground(lipgloss.Color("240")).Render(hint) + "\n")
|
sb.WriteString("\n" + lipgloss.NewStyle().Foreground(lipgloss.Color("240")).Render(hint) + "\n")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -541,7 +782,7 @@ func (m *Model) doSearch(query string, seq int) tea.Cmd {
|
|||||||
if m.cache != nil {
|
if m.cache != nil {
|
||||||
for _, entry := range m.cache.Search(query) {
|
for _, entry := range m.cache.Search(query) {
|
||||||
source, name := netbox.SplitTarget(entry.Name)
|
source, name := netbox.SplitTarget(entry.Name)
|
||||||
cached = append(cached, netbox.HostEntry{Source: source, Name: name, PrimaryIP4: entry.IP, Kind: entry.Kind, Tags: entry.Tags})
|
cached = append(cached, netbox.HostEntry{Source: source, Name: name, PrimaryIP4: entry.IP, Kind: entry.Kind, Tags: entry.Tags, Cached: true, CachedAt: entry.CachedAt, Static: entry.Static})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if m.client == nil || (len(cached) > 0 && !m.client.MultipleSources()) {
|
if m.client == nil || (len(cached) > 0 && !m.client.MultipleSources()) {
|
||||||
@@ -578,14 +819,64 @@ func (m *Model) netboxSearchOpts() netbox.SearchOptions {
|
|||||||
// updateListItems applies the active filter and sets the list items.
|
// updateListItems applies the active filter and sets the list items.
|
||||||
func (m *Model) updateListItems(entries []netbox.HostEntry) {
|
func (m *Model) updateListItems(entries []netbox.HostEntry) {
|
||||||
f := parseFilter(m.filterInput.Value())
|
f := parseFilter(m.filterInput.Value())
|
||||||
filtered := applyFilter(entries, f)
|
filtered := append([]netbox.HostEntry(nil), applyFilter(entries, f)...)
|
||||||
|
sort.SliceStable(filtered, func(i, j int) bool {
|
||||||
|
rank := func(e netbox.HostEntry) int {
|
||||||
|
if m.pinned[e.Target()] {
|
||||||
|
return 2
|
||||||
|
}
|
||||||
|
if m.favorites[e.Target()] {
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
return rank(filtered[i]) > rank(filtered[j])
|
||||||
|
})
|
||||||
items := make([]list.Item, len(filtered))
|
items := make([]list.Item, len(filtered))
|
||||||
|
labels := make([]string, len(filtered))
|
||||||
|
counts := make(map[string]int, len(filtered))
|
||||||
|
canonical := make(map[string]bool, len(filtered))
|
||||||
|
for i, e := range filtered {
|
||||||
|
labels[i] = e.Target()
|
||||||
|
canonical[strings.ToLower(e.Target())] = true
|
||||||
|
if m.hostLabel != nil {
|
||||||
|
labels[i] = m.hostLabel(e.Target())
|
||||||
|
}
|
||||||
|
counts[strings.ToLower(labels[i])]++
|
||||||
|
}
|
||||||
for i, e := range filtered {
|
for i, e := range filtered {
|
||||||
ip := e.PrimaryIP4
|
ip := e.PrimaryIP4
|
||||||
if ip == "" {
|
if ip == "" {
|
||||||
ip = e.PrimaryIP6
|
ip = e.PrimaryIP6
|
||||||
}
|
}
|
||||||
items[i] = hostItem{id: e.ID, name: e.Target(), ip: ip, kind: e.Kind, tags: e.Tags}
|
label := labels[i]
|
||||||
|
if label != e.Target() && (counts[strings.ToLower(label)] > 1 || canonical[strings.ToLower(label)]) {
|
||||||
|
label = e.Target()
|
||||||
|
}
|
||||||
|
alias := ""
|
||||||
|
if m.aliasFor != nil {
|
||||||
|
alias = m.aliasFor(e.Target())
|
||||||
|
if strings.EqualFold(alias, label) {
|
||||||
|
alias = ""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
provenance := "live"
|
||||||
|
if e.Static {
|
||||||
|
provenance = "static"
|
||||||
|
} else if e.Cached {
|
||||||
|
if e.CachedAt.IsZero() {
|
||||||
|
provenance = "saved host; resolve on connect"
|
||||||
|
} else {
|
||||||
|
age := max(time.Duration(0), time.Since(e.CachedAt)).Round(time.Second)
|
||||||
|
provenance = "cache " + age.String()
|
||||||
|
if m.cache != nil {
|
||||||
|
if _, fresh := m.cache.Get(e.Target()); !fresh {
|
||||||
|
provenance += ", stale"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
items[i] = hostItem{provenance: provenance, favorite: m.favorites[e.Target()], pinned: m.pinned[e.Target()], label: label, alias: alias, id: e.ID, name: e.Target(), ip: ip, kind: e.Kind, tags: e.Tags}
|
||||||
}
|
}
|
||||||
m.list.SetItems(items)
|
m.list.SetItems(items)
|
||||||
m.resizeList()
|
m.resizeList()
|
||||||
@@ -654,3 +945,98 @@ func (m *Model) buildSelected(item hostItem) *SelectedHost {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (m *Model) SetNotes(service *notes.Service) { m.noteService = service }
|
func (m *Model) SetNotes(service *notes.Service) { m.noteService = service }
|
||||||
|
|
||||||
|
func (h hostItem) key() string { return h.name + "\x00" + h.kind }
|
||||||
|
|
||||||
|
// toggleMark marks or unmarks a host for opening several side by side.
|
||||||
|
func (m *Model) toggleMark(item hostItem) {
|
||||||
|
key := item.key()
|
||||||
|
if m.marked[key] {
|
||||||
|
delete(m.marked, key)
|
||||||
|
for i, target := range m.markOrder {
|
||||||
|
if target == item.name {
|
||||||
|
m.markOrder = append(m.markOrder[:i], m.markOrder[i+1:]...)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
m.marked[key] = true
|
||||||
|
m.markOrder = append(m.markOrder, item.name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// toggleAllVisible marks every listed host, or unmarks them if all are marked.
|
||||||
|
func (m *Model) toggleAllVisible() {
|
||||||
|
var items []hostItem
|
||||||
|
allMarked := true
|
||||||
|
for _, it := range m.list.Items() {
|
||||||
|
if item, ok := it.(hostItem); ok {
|
||||||
|
items = append(items, item)
|
||||||
|
allMarked = allMarked && m.marked[item.key()]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, item := range items {
|
||||||
|
if m.marked[item.key()] == allMarked {
|
||||||
|
m.toggleMark(item)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetForwards provides the forward names configured for a host (ctrl+t).
|
||||||
|
func (m *Model) SetForwards(forwardsFor func(name, kind string, tags []string) []string) {
|
||||||
|
m.forwardsFor = forwardsFor
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *Model) availableForwards(item hostItem) []string {
|
||||||
|
if m.forwardsFor == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return m.forwardsFor(item.name, item.kind, item.tags)
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseForwards accepts configured names and specs containing a colon,
|
||||||
|
// separated by commas or spaces.
|
||||||
|
func parseForwards(input string, available []string) ([]string, error) {
|
||||||
|
known := make(map[string]bool, len(available))
|
||||||
|
for _, name := range available {
|
||||||
|
known[strings.ToLower(name)] = true
|
||||||
|
}
|
||||||
|
fields := strings.FieldsFunc(input, func(r rune) bool { return r == ',' || r == ' ' || r == '\t' })
|
||||||
|
if len(fields) == 0 {
|
||||||
|
return nil, fmt.Errorf("enter a forward name or a spec such as 8080:localhost:80")
|
||||||
|
}
|
||||||
|
for _, field := range fields {
|
||||||
|
if !known[strings.ToLower(field)] && !strings.Contains(field, ":") {
|
||||||
|
return nil, fmt.Errorf("unknown forward %q", field)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return fields, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetHostLabel sets the display name formatter without changing host identity.
|
||||||
|
// Configure it before the program starts, just like SetNotes and SetForwards.
|
||||||
|
func (m *Model) SetHostLabel(format func(string) string) {
|
||||||
|
m.hostLabel = format
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetAliases shows the shortcut alias returned for each target next to its
|
||||||
|
// name; return "" for hosts without one. Configure it before the program starts.
|
||||||
|
func (m *Model) SetAliases(aliasFor func(target string) string) {
|
||||||
|
m.aliasFor = aliasFor
|
||||||
|
}
|
||||||
|
|
||||||
|
func copyBools(in map[string]bool) map[string]bool {
|
||||||
|
out := map[string]bool{}
|
||||||
|
for k, v := range in {
|
||||||
|
out[k] = v
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
func (m *Model) SetHistoryLimit(limit int) { m.historyLimit = limit }
|
||||||
|
func (m *Model) SetPreferences(favorites, pinned map[string]bool, save func(map[string]bool, map[string]bool) error) {
|
||||||
|
m.favorites, m.pinned = copyBools(favorites), copyBools(pinned)
|
||||||
|
m.savePreferences = save
|
||||||
|
}
|
||||||
|
func (m *Model) SetCommands(commands func(string, string, []string) []string) {
|
||||||
|
m.commandsFor = commands
|
||||||
|
}
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
package tui
|
package tui
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
tea "charm.land/bubbletea/v2"
|
tea "charm.land/bubbletea/v2"
|
||||||
@@ -70,3 +72,88 @@ func TestConnectionEditorKeepsOriginalHost(t *testing.T) {
|
|||||||
t.Fatalf("edited host changed: %+v", m.selected)
|
t.Fatalf("edited host changed: %+v", m.selected)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestCtrlOSelectsSFTP(t *testing.T) {
|
||||||
|
m := New(nil, nil, "")
|
||||||
|
m.updateListItems([]netbox.HostEntry{{Name: "web01", PrimaryIP4: "10.0.0.1"}})
|
||||||
|
m.Update(tea.KeyPressMsg{Code: 'o', Mod: tea.ModCtrl})
|
||||||
|
if m.selected == nil || m.selected.Action != ActionSFTP || m.selected.Name != "web01" {
|
||||||
|
t.Fatalf("got %+v", m.selected)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCtrlTStartsTunnelWithForwards(t *testing.T) {
|
||||||
|
m := New(nil, nil, "")
|
||||||
|
m.SetForwards(func(name, kind string, tags []string) []string {
|
||||||
|
if name != "web01" || len(tags) != 1 {
|
||||||
|
t.Errorf("forwards asked for %s %v", name, tags)
|
||||||
|
}
|
||||||
|
return []string{"web"}
|
||||||
|
})
|
||||||
|
m.updateListItems([]netbox.HostEntry{{Name: "web01", PrimaryIP4: "10.0.0.1", Tags: []string{"dmz"}}})
|
||||||
|
m.Update(tea.KeyPressMsg{Code: 't', Mod: tea.ModCtrl})
|
||||||
|
if !m.forwardMode || m.selected != nil {
|
||||||
|
t.Fatal("forward input not opened")
|
||||||
|
}
|
||||||
|
if !strings.Contains(m.viewContent(), "forwards: web") {
|
||||||
|
t.Fatalf("configured forwards not shown:\n%s", m.viewContent())
|
||||||
|
}
|
||||||
|
|
||||||
|
m.forwardInput.SetValue("nope")
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeyEnter})
|
||||||
|
if m.selected != nil || m.err == nil {
|
||||||
|
t.Fatal("unknown forward accepted")
|
||||||
|
}
|
||||||
|
|
||||||
|
m.forwardInput.SetValue("WEB, 9000:localhost:9000")
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeyEnter})
|
||||||
|
want := []string{"WEB", "9000:localhost:9000"}
|
||||||
|
if m.selected == nil || m.selected.Action != ActionTunnel || !reflect.DeepEqual(m.selected.Forwards, want) {
|
||||||
|
t.Fatalf("got %+v", m.selected)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForwardInputEscCancels(t *testing.T) {
|
||||||
|
m := New(nil, nil, "")
|
||||||
|
m.updateListItems([]netbox.HostEntry{{Name: "web01"}})
|
||||||
|
m.Update(tea.KeyPressMsg{Code: 't', Mod: tea.ModCtrl})
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeyEscape})
|
||||||
|
if m.forwardMode || m.selected != nil {
|
||||||
|
t.Fatal("esc did not cancel")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSpaceMarksHostsAndEnterOpensThem(t *testing.T) {
|
||||||
|
m := New(nil, nil, "")
|
||||||
|
m.updateListItems([]netbox.HostEntry{{Name: "a", Kind: "device"}, {Name: "b", Kind: "device"}, {Name: "c", Kind: "vm"}})
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeySpace, Text: " "})
|
||||||
|
if len(m.markOrder) != 1 || m.markOrder[0] != "a" || m.list.Index() != 1 {
|
||||||
|
t.Fatalf("space: marks %v, cursor %d", m.markOrder, m.list.Index())
|
||||||
|
}
|
||||||
|
if m.input.Value() != "" {
|
||||||
|
t.Fatal("space went into the search field")
|
||||||
|
}
|
||||||
|
m.list.Select(2)
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeySpace, Text: " "})
|
||||||
|
if !strings.Contains(m.viewContent(), "2 marked") {
|
||||||
|
t.Fatalf("no marked count:\n%s", m.viewContent())
|
||||||
|
}
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeyEnter})
|
||||||
|
if m.selected == nil || m.selected.Action != ActionMulti || !reflect.DeepEqual(m.selected.Targets, []string{"a", "c"}) {
|
||||||
|
t.Fatalf("got %+v", m.selected)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCtrlATogglesAllVisible(t *testing.T) {
|
||||||
|
m := New(nil, nil, "")
|
||||||
|
m.updateListItems([]netbox.HostEntry{{Name: "a"}, {Name: "b"}})
|
||||||
|
m.toggleMark(hostItem{name: "a"})
|
||||||
|
m.Update(tea.KeyPressMsg{Code: 'a', Mod: tea.ModCtrl})
|
||||||
|
if !reflect.DeepEqual(m.markOrder, []string{"a", "b"}) {
|
||||||
|
t.Fatalf("mark all: %v", m.markOrder)
|
||||||
|
}
|
||||||
|
m.Update(tea.KeyPressMsg{Code: 'a', Mod: tea.ModCtrl})
|
||||||
|
if len(m.markOrder) != 0 {
|
||||||
|
t.Fatalf("unmark all: %v", m.markOrder)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
package tui
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
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 TestFavoritesHistoryAndActions(t *testing.T) {
|
||||||
|
c := cache.New("", 3600)
|
||||||
|
for _, name := range []string{"a", "b", "pinned"} {
|
||||||
|
c.Upsert(cache.Entry{Name: name, IP: "10.0.0.1", Kind: "device"})
|
||||||
|
c.MarkUsed(name)
|
||||||
|
}
|
||||||
|
m := New(nil, c, "")
|
||||||
|
m.SetHistoryLimit(1)
|
||||||
|
m.SetPreferences(map[string]bool{"pinned": true, "offline/missing": true}, map[string]bool{"pinned": true}, nil)
|
||||||
|
msg := m.loadRecent()().(searchResultMsg)
|
||||||
|
if len(msg.entries) < 2 || msg.entries[0].Target() != "pinned" {
|
||||||
|
t.Fatalf("%+v", msg.entries)
|
||||||
|
}
|
||||||
|
m.Update(msg)
|
||||||
|
m.Update(tea.WindowSizeMsg{Width: 160, Height: 30})
|
||||||
|
if !strings.Contains(m.View().Content, "◆") || !strings.Contains(m.View().Content, "cache") {
|
||||||
|
t.Fatal(m.View().Content)
|
||||||
|
}
|
||||||
|
m.SetCommands(func(name, kind string, tags []string) []string { return []string{"mtr"} })
|
||||||
|
m.Update(tea.KeyPressMsg{Code: 'r', Mod: tea.ModCtrl})
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeyDown})
|
||||||
|
m.Update(tea.KeyPressMsg{Code: tea.KeyEnter})
|
||||||
|
if m.Selected() == nil || m.Selected().Command != "mtr" || m.Selected().Name != "pinned" {
|
||||||
|
t.Fatalf("%+v", m.Selected())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func TestHistoryLimitAndPreferencePersistence(t *testing.T) {
|
||||||
|
c := cache.New("", 3600)
|
||||||
|
for _, n := range []string{"a", "b", "c"} {
|
||||||
|
c.Upsert(cache.Entry{Name: n})
|
||||||
|
c.MarkUsed(n)
|
||||||
|
}
|
||||||
|
m := New(nil, c, "")
|
||||||
|
m.SetHistoryLimit(2)
|
||||||
|
if got := len(m.loadRecent()().(searchResultMsg).entries); got != 2 {
|
||||||
|
t.Fatal(got)
|
||||||
|
}
|
||||||
|
m.SetHistoryLimit(0)
|
||||||
|
if got := len(m.loadRecent()().(searchResultMsg).entries); got != 3 {
|
||||||
|
t.Fatal(got)
|
||||||
|
}
|
||||||
|
saved := false
|
||||||
|
m.SetPreferences(nil, nil, func(f, p map[string]bool) error { saved = f["prod/web"] && p["prod/web"]; return nil })
|
||||||
|
entries := []netbox.HostEntry{{Name: "web", Source: "prod", Cached: true, CachedAt: time.Now().Add(-2 * time.Hour)}}
|
||||||
|
m.lastResults = entries
|
||||||
|
m.updateListItems(entries)
|
||||||
|
m.Update(tea.KeyPressMsg{Code: 'p', Mod: tea.ModCtrl})
|
||||||
|
if !saved {
|
||||||
|
t.Fatal("pin not persisted")
|
||||||
|
}
|
||||||
|
item := m.list.Items()[0].(hostItem)
|
||||||
|
if !strings.Contains(item.provenance, "stale") {
|
||||||
|
t.Fatal(item.provenance)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -25,6 +25,19 @@
|
|||||||
],
|
],
|
||||||
"enabled": true
|
"enabled": true
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"description": "Skip major updates of indirect Go modules: a new major version is a separate module path that no dependency imports, so the update only adds an unused requirement",
|
||||||
|
"matchManagers": [
|
||||||
|
"gomod"
|
||||||
|
],
|
||||||
|
"matchDepTypes": [
|
||||||
|
"indirect"
|
||||||
|
],
|
||||||
|
"matchUpdateTypes": [
|
||||||
|
"major"
|
||||||
|
],
|
||||||
|
"enabled": false
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"description": "Update the Go version declared in go.mod",
|
"description": "Update the Go version declared in go.mod",
|
||||||
"matchManagers": [
|
"matchManagers": [
|
||||||
|
|||||||
@@ -0,0 +1,116 @@
|
|||||||
|
# netssh test environment
|
||||||
|
|
||||||
|
A local Docker environment for testing every netssh feature against real
|
||||||
|
services: two NetBox instances, SSH targets on three networks, a jump host,
|
||||||
|
and a client with ssh, sftp, scp, tmux, zellij, bash, zsh, and fish. It is for
|
||||||
|
local use only and is not part of CI/CD.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
testenv/up.sh # build, start, seed NetBox (first start ~6 min, then ~1 min)
|
||||||
|
testenv/test.sh # run all tests; testenv/test.sh tunnel runs only matching files
|
||||||
|
testenv/shell.sh # interactive shell in the client, netssh configured
|
||||||
|
testenv/down.sh # stop and delete everything (volumes, generated state)
|
||||||
|
```
|
||||||
|
|
||||||
|
`test.sh` rebuilds the client image first, so the tests always run the current
|
||||||
|
source. `NO_BUILD=1 testenv/test.sh` skips that. Exit code 1 if any check fails.
|
||||||
|
|
||||||
|
Requirements: Docker with Compose v2, about 3 GB RAM, ports 18000/18001 on
|
||||||
|
127.0.0.1 free.
|
||||||
|
|
||||||
|
## Topology
|
||||||
|
|
||||||
|
```
|
||||||
|
public 10.231.0.0/24 + fd00:30::/64 mgmt 10.231.1.0/24 prod 10.231.2.0/24
|
||||||
|
client .10 ────────────┬─ bastion .30 ───────────────────────────────┬─ (only via bastion)
|
||||||
|
netbox-fsn .20 │ fsn1-pve1..3 .11-.13 (mgmt0) │ fsn1-pve1..3 .11-.13 (eth0)
|
||||||
|
netbox-lab .21 │ lab-db1 .41, lab-web1 .42 │ web1 .21, web2 .22
|
||||||
|
legacy-box .50 client .10 ───────┘
|
||||||
|
v6-host fd00:30::60
|
||||||
|
```
|
||||||
|
|
||||||
|
| NetBox | Host | Kind | Primary IP | Other | Tags |
|
||||||
|
|---|---|---|---|---|---|
|
||||||
|
| fsn | `fsn1-pve1..3.hoster.test` | device, cluster `pve-fsn1` | eth0 = prod (needs bastion) | mgmt0 = mgmt (direct) | `pve` |
|
||||||
|
| fsn | `bastion.hoster.test` | device | 10.231.0.30 | | `bastion` |
|
||||||
|
| fsn | `v6-host` | device | fd00:30::60 (IPv6 only) | | `ipv6` |
|
||||||
|
| fsn | `web1`, `web2` | VM, cluster `pve-fsn1` | prod (needs bastion) | | `web` |
|
||||||
|
| lab | `lab-db1` | device | 10.231.1.41 | | `db` |
|
||||||
|
| lab | `web1` | VM, cluster `lab-k8s` | 10.231.1.42 | | `web` |
|
||||||
|
| — | `legacy-box` (10.231.0.50) | static host | | | |
|
||||||
|
|
||||||
|
- **fsn** uses a v2 token (`nbt_…`), **lab** a legacy v1 token; both come from `.state/env`.
|
||||||
|
- `web1` exists in both instances (ambiguity, `instance/host`).
|
||||||
|
- Docker DNS resolves the `*.hoster.test` names on the mgmt network (`hostname` strategy).
|
||||||
|
- Every target runs sshd on ports 22 and 2222 with users `ops` and `admin`, and an HTTP server on its own 127.0.0.1:8081 for tunnel tests ("hello from HOST").
|
||||||
|
- NetBox UI: http://127.0.0.1:18000 (fsn), http://127.0.0.1:18001 (lab), login `admin` / `admin`.
|
||||||
|
|
||||||
|
## Files
|
||||||
|
|
||||||
|
| Path | Purpose |
|
||||||
|
|---|---|
|
||||||
|
| `compose.yaml` | All services and networks. |
|
||||||
|
| `client.Dockerfile`, `client-entrypoint.sh` | Client image; builds netssh from the repository. |
|
||||||
|
| `targets/` | SSH target image (sshd config, entrypoint). |
|
||||||
|
| `seed/seed.py` | Fills both NetBox instances via the REST API (idempotent), writes `.state/`. |
|
||||||
|
| `tests/run.sh`, `tests/lib.sh` | Test runner and helpers (`check`, `expect_out`, `expect_eq`, `expect_fail`, `wait_for`). |
|
||||||
|
| `tests/NN-*.sh` | Test files; each runs in a fresh `HOME`. |
|
||||||
|
| `tests/drive.py` | Drives `netssh configure` in huh's accessible mode. |
|
||||||
|
| `.keys/`, `.state/` | Generated test key and seed output (git-ignored). |
|
||||||
|
| `.artifacts/` | Screenshots from `tests/16-render.sh` (git-ignored). |
|
||||||
|
|
||||||
|
## Writing tests
|
||||||
|
|
||||||
|
Each `tests/NN-name.sh` is sourced by `run.sh` in a subshell with a new
|
||||||
|
`HOME`, `XDG_CONFIG_HOME`, and `XDG_CACHE_HOME`. Write the netssh config with
|
||||||
|
`config <<'EOF' … EOF` (both NetBox instances plus your YAML) or `config_only`
|
||||||
|
(no NetBox), then use the helpers:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
config <<'EOF'
|
||||||
|
ssh: {default_user: ops}
|
||||||
|
EOF
|
||||||
|
expect_eq "connect" "fsn1-pve1" netssh fsn/fsn1-pve1.hoster.test hostname
|
||||||
|
expect_out "dry run" "-J ops@10.231.0.30" netssh --dry-run fsn/web1
|
||||||
|
expect_fail "ambiguous" "found 2 exact matches" netssh web1
|
||||||
|
```
|
||||||
|
|
||||||
|
ssh always reads `/home/tester/.ssh/config` (OpenSSH ignores `$HOME`): it uses
|
||||||
|
the test key, `BatchMode`, `StrictHostKeyChecking accept-new`, and
|
||||||
|
`LogLevel ERROR`. Tests that need their own known_hosts set
|
||||||
|
`ssh.options.UserKnownHostsFile`. The TUI test runs netssh inside tmux and
|
||||||
|
reads the screen with `tmux capture-pane`. The multi test (`15-multi.sh`)
|
||||||
|
opens panes in real tmux and zellij sessions and checks that broadcast typing
|
||||||
|
reaches every node.
|
||||||
|
|
||||||
|
## What a user sees: `16-render.sh`
|
||||||
|
|
||||||
|
The render test runs tmux, zellij, and the TUI in a real terminal emulator —
|
||||||
|
xterm on a virtual X server (Xvfb) — takes screenshots, and reads them back
|
||||||
|
with OCR (tesseract). It checks what is actually drawn: remote prompts in all
|
||||||
|
panes, borders and titles with the host names, `[SYNC]` appearing and
|
||||||
|
disappearing, panes side by side, broadcast output in every pane, input in one
|
||||||
|
pane only without broadcast, the status bar, and the TUI marks. The broadcast
|
||||||
|
keys are pressed as a user would: `tmux send-keys -K` delivers them to the
|
||||||
|
xterm client, so they pass through the prefix and key tables (`prefix e` →
|
||||||
|
`[SOLO]` and the pane drops out of the broadcast; `prefix S` toggles all panes;
|
||||||
|
other windows stay unaffected).
|
||||||
|
|
||||||
|
```sh
|
||||||
|
testenv/test.sh render # then look at the screenshots:
|
||||||
|
ls testenv/.artifacts/ # tmux-1.png, zellij-2.png, tui-3.png, …
|
||||||
|
```
|
||||||
|
|
||||||
|
Helpers in `lib.sh`: `start_screen`/`stop_screen`, `term CMD…` (full-screen
|
||||||
|
xterm), `shot NAME`, `screen_shows NAME TEXT…`, `screen_count NAME TEXT`.
|
||||||
|
OCR reads each screenshot in three preprocessing variants (plain, stretched for
|
||||||
|
dim gray, brightest channel for colored text) and normalizes characters it
|
||||||
|
confuses in DejaVu Sans Mono (`1`/`l`, `C`/`(`), so checks stay robust without
|
||||||
|
becoming vague.
|
||||||
|
|
||||||
|
## Not covered
|
||||||
|
|
||||||
|
- The installer (`install.sh`) downloads release assets from Gitea; it is tested by the Go tests with local fixtures.
|
||||||
|
- macOS paths and behaviour.
|
||||||
|
- `netssh uninstall` runs only with `--dry-run`, so the client keeps its binary.
|
||||||
|
- Rendering is checked in xterm with DejaVu Sans Mono. Other terminals and fonts may differ, e.g. zellij's Powerline arrows need a Nerd Font.
|
||||||
Executable
+20
@@ -0,0 +1,20 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# ssh reads ~/.ssh from the passwd entry, not $HOME, so the key and ssh config
|
||||||
|
# live in /home/tester for every test; tests isolate netssh via HOME/XDG_*.
|
||||||
|
set -eu
|
||||||
|
mkdir -p /home/tester/.ssh
|
||||||
|
if [ -f /keys/id_ed25519 ]; then
|
||||||
|
install -m 600 /keys/id_ed25519 /home/tester/.ssh/id_ed25519
|
||||||
|
fi
|
||||||
|
cat >/home/tester/.ssh/config <<'EOF'
|
||||||
|
Host *
|
||||||
|
IdentityFile ~/.ssh/id_ed25519
|
||||||
|
IdentitiesOnly yes
|
||||||
|
BatchMode yes
|
||||||
|
ConnectTimeout 5
|
||||||
|
StrictHostKeyChecking accept-new
|
||||||
|
LogLevel ERROR
|
||||||
|
EOF
|
||||||
|
chmod 700 /home/tester/.ssh
|
||||||
|
chmod 600 /home/tester/.ssh/config
|
||||||
|
exec "$@"
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
# Client for the netssh test environment: netssh built from this repository
|
||||||
|
# plus everything it drives or integrates with (ssh, sftp, scp, tmux, zellij,
|
||||||
|
# bash, zsh, fish). Rebuild after code changes: testenv/up.sh or
|
||||||
|
# docker compose -f testenv/compose.yaml build client
|
||||||
|
FROM golang:1.27.4-alpine3.23 AS build
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
COPY cmd ./cmd
|
||||||
|
COPY internal ./internal
|
||||||
|
RUN CGO_ENABLED=0 go build -o /out/netssh ./cmd/netssh
|
||||||
|
|
||||||
|
FROM alpine:3.24
|
||||||
|
# xvfb/xterm/imagemagick/tesseract: render panes in a real terminal emulator,
|
||||||
|
# take screenshots, and read them back with OCR (tests/16-render.sh).
|
||||||
|
RUN apk add --no-cache openssh-client-default tmux zellij bash zsh fish bash-completion \
|
||||||
|
curl python3 jq ncurses coreutils grep \
|
||||||
|
xvfb xterm imagemagick tesseract-ocr tesseract-ocr-data-eng font-dejavu \
|
||||||
|
&& adduser -D -s /bin/bash tester
|
||||||
|
COPY --from=build /out/netssh /usr/local/bin/netssh
|
||||||
|
COPY testenv/client-entrypoint.sh /entrypoint.sh
|
||||||
|
USER tester
|
||||||
|
WORKDIR /home/tester
|
||||||
|
ENV TERM=xterm-256color LANG=C.UTF-8
|
||||||
|
ENTRYPOINT ["/entrypoint.sh"]
|
||||||
|
CMD ["sleep", "infinity"]
|
||||||
@@ -0,0 +1,211 @@
|
|||||||
|
# netssh test environment — local only, not used by CI/CD. See testenv/README.md.
|
||||||
|
#
|
||||||
|
# public 10.231.0.0/24 + fd00:30::/64 client, NetBox x2, bastion, static host, IPv6 host
|
||||||
|
# mgmt 10.231.1.0/24 client, Proxmox nodes (mgmt0), lab hosts
|
||||||
|
# prod 10.231.2.0/24 bastion, Proxmox nodes (eth0), VMs — not reachable from the client
|
||||||
|
name: netssh-test
|
||||||
|
|
||||||
|
x-netbox: &netbox
|
||||||
|
image: netboxcommunity/netbox:v4.7.5-5.1.1
|
||||||
|
depends_on:
|
||||||
|
postgres: {condition: service_healthy}
|
||||||
|
redis: {condition: service_healthy}
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD-SHELL", "curl -sf http://localhost:8080/login/ >/dev/null"]
|
||||||
|
interval: 10s
|
||||||
|
timeout: 5s
|
||||||
|
retries: 60
|
||||||
|
start_period: 60s
|
||||||
|
|
||||||
|
x-netbox-env: &netbox-env
|
||||||
|
DB_HOST: postgres
|
||||||
|
DB_USER: netbox
|
||||||
|
DB_PASSWORD: netbox
|
||||||
|
REDIS_HOST: redis
|
||||||
|
SECRET_KEY: netssh-test-environment-secret-key-0123456789-abcdefghijklmnopqrstuvwxyz
|
||||||
|
API_TOKEN_PEPPER_1: netssh-test-environment-pepper-0123456789-abcdefghijklmnop
|
||||||
|
SUPERUSER_NAME: admin
|
||||||
|
SUPERUSER_EMAIL: admin@example.com
|
||||||
|
SUPERUSER_PASSWORD: admin
|
||||||
|
SUPERUSER_API_KEY: netsshtest01
|
||||||
|
SUPERUSER_API_TOKEN: 0123456789abcdef0123456789abcdef01234567
|
||||||
|
SKIP_SUPERUSER: "false"
|
||||||
|
|
||||||
|
x-target: &target
|
||||||
|
build:
|
||||||
|
context: ..
|
||||||
|
dockerfile: testenv/targets/target.Dockerfile
|
||||||
|
image: netssh-test-target
|
||||||
|
volumes:
|
||||||
|
- ./.keys/authorized_keys:/keys/authorized_keys:ro
|
||||||
|
|
||||||
|
services:
|
||||||
|
postgres:
|
||||||
|
image: postgres:18-alpine
|
||||||
|
environment:
|
||||||
|
POSTGRES_USER: netbox
|
||||||
|
POSTGRES_PASSWORD: netbox
|
||||||
|
POSTGRES_DB: netbox
|
||||||
|
volumes:
|
||||||
|
- ./postgres-init.sql:/docker-entrypoint-initdb.d/init.sql:ro
|
||||||
|
- postgres:/var/lib/postgresql
|
||||||
|
networks: [backend]
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD-SHELL", "pg_isready -U netbox"]
|
||||||
|
interval: 5s
|
||||||
|
retries: 30
|
||||||
|
|
||||||
|
redis:
|
||||||
|
image: redis:8-alpine
|
||||||
|
networks: [backend]
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD", "redis-cli", "ping"]
|
||||||
|
interval: 5s
|
||||||
|
retries: 30
|
||||||
|
|
||||||
|
netbox-fsn:
|
||||||
|
<<: *netbox
|
||||||
|
hostname: netbox-fsn
|
||||||
|
environment:
|
||||||
|
<<: *netbox-env
|
||||||
|
DB_NAME: netbox_fsn
|
||||||
|
REDIS_DATABASE: "0"
|
||||||
|
REDIS_CACHE_DATABASE: "1"
|
||||||
|
ports: ["127.0.0.1:18000:8080"]
|
||||||
|
networks:
|
||||||
|
backend: {}
|
||||||
|
public: {ipv4_address: 10.231.0.20}
|
||||||
|
|
||||||
|
netbox-lab:
|
||||||
|
<<: *netbox
|
||||||
|
hostname: netbox-lab
|
||||||
|
environment:
|
||||||
|
<<: *netbox-env
|
||||||
|
DB_NAME: netbox_lab
|
||||||
|
REDIS_DATABASE: "2"
|
||||||
|
REDIS_CACHE_DATABASE: "3"
|
||||||
|
ports: ["127.0.0.1:18001:8080"]
|
||||||
|
networks:
|
||||||
|
backend: {}
|
||||||
|
public: {ipv4_address: 10.231.0.21}
|
||||||
|
|
||||||
|
# Jump host: the only way from the client into the prod network.
|
||||||
|
bastion:
|
||||||
|
<<: *target
|
||||||
|
hostname: bastion
|
||||||
|
networks:
|
||||||
|
public: {ipv4_address: 10.231.0.30, aliases: [bastion.hoster.test]}
|
||||||
|
prod: {ipv4_address: 10.231.2.30}
|
||||||
|
|
||||||
|
fsn1-pve1:
|
||||||
|
<<: *target
|
||||||
|
hostname: fsn1-pve1
|
||||||
|
networks:
|
||||||
|
mgmt: {ipv4_address: 10.231.1.11, aliases: [fsn1-pve1.hoster.test]}
|
||||||
|
prod: {ipv4_address: 10.231.2.11}
|
||||||
|
fsn1-pve2:
|
||||||
|
<<: *target
|
||||||
|
hostname: fsn1-pve2
|
||||||
|
networks:
|
||||||
|
mgmt: {ipv4_address: 10.231.1.12, aliases: [fsn1-pve2.hoster.test]}
|
||||||
|
prod: {ipv4_address: 10.231.2.12}
|
||||||
|
fsn1-pve3:
|
||||||
|
<<: *target
|
||||||
|
hostname: fsn1-pve3
|
||||||
|
networks:
|
||||||
|
mgmt: {ipv4_address: 10.231.1.13, aliases: [fsn1-pve3.hoster.test]}
|
||||||
|
prod: {ipv4_address: 10.231.2.13}
|
||||||
|
|
||||||
|
# VMs of cluster pve-fsn1: only in prod, so they need the bastion.
|
||||||
|
web1:
|
||||||
|
<<: *target
|
||||||
|
hostname: web1
|
||||||
|
networks:
|
||||||
|
prod: {ipv4_address: 10.231.2.21}
|
||||||
|
web2:
|
||||||
|
<<: *target
|
||||||
|
hostname: web2
|
||||||
|
networks:
|
||||||
|
prod: {ipv4_address: 10.231.2.22}
|
||||||
|
|
||||||
|
# NetBox instance "lab": a device and a VM named web1 like the fsn VM.
|
||||||
|
lab-db1:
|
||||||
|
<<: *target
|
||||||
|
hostname: lab-db1
|
||||||
|
networks:
|
||||||
|
mgmt: {ipv4_address: 10.231.1.41}
|
||||||
|
lab-web1:
|
||||||
|
<<: *target
|
||||||
|
hostname: lab-web1
|
||||||
|
networks:
|
||||||
|
mgmt: {ipv4_address: 10.231.1.42}
|
||||||
|
|
||||||
|
# Not in NetBox: tested as a static host.
|
||||||
|
legacy-box:
|
||||||
|
<<: *target
|
||||||
|
hostname: legacy-box
|
||||||
|
networks:
|
||||||
|
public: {ipv4_address: 10.231.0.50}
|
||||||
|
|
||||||
|
# In NetBox with an IPv6 primary address only.
|
||||||
|
v6-host:
|
||||||
|
<<: *target
|
||||||
|
hostname: v6-host
|
||||||
|
networks:
|
||||||
|
public: {ipv4_address: 10.231.0.60, ipv6_address: "fd00:30::60"}
|
||||||
|
|
||||||
|
client:
|
||||||
|
build:
|
||||||
|
context: ..
|
||||||
|
dockerfile: testenv/client.Dockerfile
|
||||||
|
image: netssh-test-client
|
||||||
|
hostname: client
|
||||||
|
init: true
|
||||||
|
volumes:
|
||||||
|
- ./.keys:/keys:ro
|
||||||
|
- ./.state:/state
|
||||||
|
- ./tests:/tests:ro
|
||||||
|
- ./.artifacts:/artifacts
|
||||||
|
networks:
|
||||||
|
public: {ipv4_address: 10.231.0.10, ipv6_address: "fd00:30::10"}
|
||||||
|
mgmt: {ipv4_address: 10.231.1.10}
|
||||||
|
|
||||||
|
# Fills both NetBox instances and writes /state/netssh.yaml, then exits.
|
||||||
|
seed:
|
||||||
|
image: netssh-test-client
|
||||||
|
depends_on:
|
||||||
|
client: {condition: service_started}
|
||||||
|
netbox-fsn: {condition: service_healthy}
|
||||||
|
netbox-lab: {condition: service_healthy}
|
||||||
|
volumes:
|
||||||
|
- ./.state:/state
|
||||||
|
- ./seed:/seed:ro
|
||||||
|
networks:
|
||||||
|
public: {}
|
||||||
|
command: ["python3", "/seed/seed.py"]
|
||||||
|
restart: "no"
|
||||||
|
|
||||||
|
# Fixed subnets outside Docker's default address pools (172.17-31.x, 192.168.x),
|
||||||
|
# so automatically numbered networks of other projects cannot collide.
|
||||||
|
networks:
|
||||||
|
backend:
|
||||||
|
ipam:
|
||||||
|
config:
|
||||||
|
- subnet: 10.231.3.0/24
|
||||||
|
public:
|
||||||
|
enable_ipv6: true
|
||||||
|
ipam:
|
||||||
|
config:
|
||||||
|
- subnet: 10.231.0.0/24
|
||||||
|
- subnet: fd00:30::/64
|
||||||
|
mgmt:
|
||||||
|
ipam:
|
||||||
|
config:
|
||||||
|
- subnet: 10.231.1.0/24
|
||||||
|
prod:
|
||||||
|
ipam:
|
||||||
|
config:
|
||||||
|
- subnet: 10.231.2.0/24
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
postgres: {}
|
||||||
Executable
+6
@@ -0,0 +1,6 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Stop the netssh test environment and remove its volumes and state.
|
||||||
|
set -euo pipefail
|
||||||
|
cd "$(dirname "$0")"
|
||||||
|
docker compose -f compose.yaml down -v --remove-orphans
|
||||||
|
rm -rf .state
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
-- One Postgres serves both NetBox instances of the test environment.
|
||||||
|
CREATE DATABASE netbox_fsn OWNER netbox;
|
||||||
|
CREATE DATABASE netbox_lab OWNER netbox;
|
||||||
@@ -0,0 +1,171 @@
|
|||||||
|
"""Fill both NetBox instances of the netssh test environment.
|
||||||
|
|
||||||
|
Idempotent: objects are looked up before they are created, so running the
|
||||||
|
seed again leaves NetBox unchanged. Writes /state/env (tokens) and
|
||||||
|
/state/netssh.yaml (base config for the tests).
|
||||||
|
"""
|
||||||
|
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
import time
|
||||||
|
import urllib.error
|
||||||
|
import urllib.request
|
||||||
|
|
||||||
|
FSN = "http://10.231.0.20:8080"
|
||||||
|
LAB = "http://10.231.0.21:8080"
|
||||||
|
# Superuser v2 token from compose.yaml (SUPERUSER_API_KEY / SUPERUSER_API_TOKEN).
|
||||||
|
V2_TOKEN = "nbt_netsshtest01.0123456789abcdef0123456789abcdef01234567"
|
||||||
|
STATE = "/state"
|
||||||
|
|
||||||
|
|
||||||
|
class NetBox:
|
||||||
|
def __init__(self, url):
|
||||||
|
self.url = url
|
||||||
|
|
||||||
|
def call(self, method, path, body=None):
|
||||||
|
data = json.dumps(body).encode() if body is not None else None
|
||||||
|
req = urllib.request.Request(self.url + "/api/" + path, data=data, method=method)
|
||||||
|
req.add_header("Authorization", "Bearer " + V2_TOKEN)
|
||||||
|
req.add_header("Content-Type", "application/json")
|
||||||
|
req.add_header("Accept", "application/json")
|
||||||
|
try:
|
||||||
|
with urllib.request.urlopen(req, timeout=30) as resp:
|
||||||
|
raw = resp.read()
|
||||||
|
return json.loads(raw) if raw else None
|
||||||
|
except urllib.error.HTTPError as err:
|
||||||
|
sys.exit(f"{method} {path}: HTTP {err.code}: {err.read().decode(errors='replace')}")
|
||||||
|
|
||||||
|
def find(self, path, **filters):
|
||||||
|
query = "&".join(f"{k}={urllib.request.quote(str(v))}" for k, v in filters.items())
|
||||||
|
results = self.call("GET", f"{path}?{query}&limit=2")["results"]
|
||||||
|
return results[0] if results else None
|
||||||
|
|
||||||
|
def ensure(self, path, lookup, body):
|
||||||
|
"""Return the object matching lookup, creating it from body if missing."""
|
||||||
|
found = self.find(path, **lookup)
|
||||||
|
if found:
|
||||||
|
return found
|
||||||
|
return self.call("POST", path, body)
|
||||||
|
|
||||||
|
def wait(self):
|
||||||
|
for _ in range(120):
|
||||||
|
try:
|
||||||
|
self.call("GET", "status/")
|
||||||
|
return
|
||||||
|
except SystemExit:
|
||||||
|
pass
|
||||||
|
except (urllib.error.URLError, ConnectionError, TimeoutError):
|
||||||
|
pass
|
||||||
|
time.sleep(5)
|
||||||
|
sys.exit(f"NetBox {self.url} did not become ready")
|
||||||
|
|
||||||
|
|
||||||
|
def base(nb, site, cluster_type, cluster):
|
||||||
|
for tag in ("pve", "web", "bastion", "db", "ipv6"):
|
||||||
|
nb.ensure("extras/tags/", {"slug": tag}, {"name": tag, "slug": tag})
|
||||||
|
site = nb.ensure("dcim/sites/", {"slug": site}, {"name": site, "slug": site, "status": "active"})
|
||||||
|
mfr = nb.ensure("dcim/manufacturers/", {"slug": "generic"}, {"name": "Generic", "slug": "generic"})
|
||||||
|
role = nb.ensure("dcim/device-roles/", {"slug": "server"}, {"name": "Server", "slug": "server", "color": "2196f3"})
|
||||||
|
dtype = nb.ensure("dcim/device-types/", {"slug": "generic-server"},
|
||||||
|
{"manufacturer": mfr["id"], "model": "Generic Server", "slug": "generic-server"})
|
||||||
|
ctype = nb.ensure("virtualization/cluster-types/", {"slug": cluster_type},
|
||||||
|
{"name": cluster_type, "slug": cluster_type})
|
||||||
|
cluster = nb.ensure("virtualization/clusters/", {"name": cluster},
|
||||||
|
{"name": cluster, "type": ctype["id"], "status": "active"})
|
||||||
|
return {"site": site["id"], "role": role["id"], "type": dtype["id"], "cluster": cluster["id"]}
|
||||||
|
|
||||||
|
|
||||||
|
def device(nb, ids, name, ips, tags=(), cluster=False, comments=""):
|
||||||
|
"""ips: list of (interface, address, primary) with primary in (None, 4, 6)."""
|
||||||
|
body = {"name": name, "role": ids["role"], "device_type": ids["type"], "site": ids["site"],
|
||||||
|
"status": "active", "tags": [{"slug": t} for t in tags], "comments": comments}
|
||||||
|
if cluster:
|
||||||
|
body["cluster"] = ids["cluster"]
|
||||||
|
dev = nb.ensure("dcim/devices/", {"name": name}, body)
|
||||||
|
primary = {}
|
||||||
|
for ifname, address, family in ips:
|
||||||
|
iface = nb.ensure("dcim/interfaces/", {"device_id": dev["id"], "name": ifname},
|
||||||
|
{"device": dev["id"], "name": ifname, "type": "1000base-t"})
|
||||||
|
ip = nb.ensure("ipam/ip-addresses/", {"address": address},
|
||||||
|
{"address": address, "assigned_object_type": "dcim.interface", "assigned_object_id": iface["id"]})
|
||||||
|
if family:
|
||||||
|
primary[f"primary_ip{family}"] = ip["id"]
|
||||||
|
if primary:
|
||||||
|
nb.call("PATCH", f"dcim/devices/{dev['id']}/", primary)
|
||||||
|
|
||||||
|
|
||||||
|
def vm(nb, ids, name, address, tags=()):
|
||||||
|
machine = nb.ensure("virtualization/virtual-machines/", {"name": name},
|
||||||
|
{"name": name, "cluster": ids["cluster"], "status": "active",
|
||||||
|
"tags": [{"slug": t} for t in tags]})
|
||||||
|
iface = nb.ensure("virtualization/interfaces/", {"virtual_machine_id": machine["id"], "name": "eth0"},
|
||||||
|
{"virtual_machine": machine["id"], "name": "eth0"})
|
||||||
|
ip = nb.ensure("ipam/ip-addresses/", {"address": address},
|
||||||
|
{"address": address, "assigned_object_type": "virtualization.vminterface",
|
||||||
|
"assigned_object_id": iface["id"]})
|
||||||
|
nb.call("PATCH", f"virtualization/virtual-machines/{machine['id']}/", {"primary_ip4": ip["id"]})
|
||||||
|
|
||||||
|
|
||||||
|
def v1_token(nb):
|
||||||
|
"""A legacy v1 token for the lab instance, reused from /state/env if present."""
|
||||||
|
env = read_env()
|
||||||
|
if env.get("LAB_TOKEN"):
|
||||||
|
return env["LAB_TOKEN"]
|
||||||
|
user = nb.find("users/users/", username="admin")
|
||||||
|
token = nb.call("POST", "users/tokens/", {"user": user["id"], "version": 1, "description": "netssh v1 test"})
|
||||||
|
plaintext = token.get("token") or token.get("plaintext")
|
||||||
|
if not plaintext:
|
||||||
|
sys.exit(f"v1 token response without plaintext: {token}")
|
||||||
|
return plaintext
|
||||||
|
|
||||||
|
|
||||||
|
def read_env():
|
||||||
|
env = {}
|
||||||
|
try:
|
||||||
|
with open(os.path.join(STATE, "env")) as f:
|
||||||
|
for line in f:
|
||||||
|
key, _, value = line.strip().partition("=")
|
||||||
|
env[key] = value
|
||||||
|
except FileNotFoundError:
|
||||||
|
pass
|
||||||
|
return env
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
fsn, lab = NetBox(FSN), NetBox(LAB)
|
||||||
|
fsn.wait()
|
||||||
|
lab.wait()
|
||||||
|
|
||||||
|
ids = base(fsn, "fsn1", "proxmox", "pve-fsn1")
|
||||||
|
for n in (1, 2, 3):
|
||||||
|
device(fsn, ids, f"fsn1-pve{n}.hoster.test",
|
||||||
|
[("eth0", f"10.231.2.1{n}/24", 4), ("mgmt0", f"10.231.1.1{n}/24", None)],
|
||||||
|
tags=("pve",), cluster=True, comments=f"Proxmox node {n}")
|
||||||
|
device(fsn, ids, "bastion.hoster.test", [("eth0", "10.231.0.30/24", 4)], tags=("bastion",))
|
||||||
|
device(fsn, ids, "v6-host", [("eth0", "fd00:30::60/64", 6)], tags=("ipv6",))
|
||||||
|
vm(fsn, ids, "web1", "10.231.2.21/24", tags=("web",))
|
||||||
|
vm(fsn, ids, "web2", "10.231.2.22/24", tags=("web",))
|
||||||
|
|
||||||
|
ids = base(lab, "lab", "kubernetes", "lab-k8s")
|
||||||
|
device(lab, ids, "lab-db1", [("eth0", "10.231.1.41/24", 4)], tags=("db",))
|
||||||
|
vm(lab, ids, "web1", "10.231.1.42/24", tags=("web",))
|
||||||
|
|
||||||
|
lab_token = v1_token(lab)
|
||||||
|
os.makedirs(STATE, exist_ok=True)
|
||||||
|
with open(os.path.join(STATE, "env"), "w") as f:
|
||||||
|
f.write(f"FSN_URL={FSN}\nLAB_URL={LAB}\nFSN_TOKEN={V2_TOKEN}\nLAB_TOKEN={lab_token}\n")
|
||||||
|
with open(os.path.join(STATE, "netssh.yaml"), "w") as f:
|
||||||
|
f.write(f"""netboxes:
|
||||||
|
- name: fsn
|
||||||
|
url: "{FSN}"
|
||||||
|
token: "{V2_TOKEN}"
|
||||||
|
- name: lab
|
||||||
|
url: "{LAB}"
|
||||||
|
token: "{lab_token}"
|
||||||
|
""")
|
||||||
|
print("seed: done (fsn: 3 nodes, bastion, v6-host, 2 VMs; lab: lab-db1, web1)")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
Executable
+20
@@ -0,0 +1,20 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Interactive shell in the client with a ready netssh config (fresh home).
|
||||||
|
set -euo pipefail
|
||||||
|
cd "$(dirname "$0")"
|
||||||
|
exec docker compose -f compose.yaml exec -it client bash -c '
|
||||||
|
. /tests/lib.sh
|
||||||
|
new_home
|
||||||
|
base_config >"$XDG_CONFIG_HOME/netssh.yaml" <<EOF
|
||||||
|
resolver:
|
||||||
|
strategies: [management_subnet, primary_ip]
|
||||||
|
management_subnets: [10.231.1.0/24]
|
||||||
|
ssh:
|
||||||
|
default_user: ops
|
||||||
|
host_key_checking: accept-new
|
||||||
|
rules:
|
||||||
|
- match: {kind: vm, instance: fsn}
|
||||||
|
proxy_jump: ops@10.231.0.30
|
||||||
|
EOF
|
||||||
|
echo "netssh is configured (HOME=$HOME). Try: netssh cache refresh && netssh"
|
||||||
|
exec bash -i'
|
||||||
Executable
+21
@@ -0,0 +1,21 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# Prepares host keys and the test users, starts a small HTTP server for the
|
||||||
|
# tunnel tests (reachable only on the target itself), then runs sshd.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
[ -f /etc/ssh/ssh_host_ed25519_key ] || ssh-keygen -q -t ed25519 -N '' -f /etc/ssh/ssh_host_ed25519_key
|
||||||
|
|
||||||
|
for user in ops admin; do
|
||||||
|
home="/home/$user"
|
||||||
|
mkdir -p "$home/.ssh"
|
||||||
|
cp /keys/authorized_keys "$home/.ssh/authorized_keys"
|
||||||
|
chown -R "$user:$user" "$home/.ssh"
|
||||||
|
chmod 700 "$home/.ssh"
|
||||||
|
chmod 600 "$home/.ssh/authorized_keys"
|
||||||
|
done
|
||||||
|
|
||||||
|
mkdir -p /srv/www
|
||||||
|
echo "hello from $(hostname)" > /srv/www/index.html
|
||||||
|
python3 -m http.server 8081 --bind 127.0.0.1 --directory /srv/www >/dev/null 2>&1 &
|
||||||
|
|
||||||
|
exec /usr/sbin/sshd -D -e
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# Test targets accept the generated test key only. Port 2222 tests ssh.default_port.
|
||||||
|
Port 22
|
||||||
|
Port 2222
|
||||||
|
ListenAddress 0.0.0.0
|
||||||
|
ListenAddress ::
|
||||||
|
HostKey /etc/ssh/ssh_host_ed25519_key
|
||||||
|
PermitRootLogin no
|
||||||
|
PasswordAuthentication no
|
||||||
|
KbdInteractiveAuthentication no
|
||||||
|
PubkeyAuthentication yes
|
||||||
|
AuthorizedKeysFile .ssh/authorized_keys
|
||||||
|
AllowTcpForwarding yes
|
||||||
|
AllowAgentForwarding yes
|
||||||
|
GatewayPorts no
|
||||||
|
PermitTunnel no
|
||||||
|
X11Forwarding no
|
||||||
|
PrintMotd no
|
||||||
|
Subsystem sftp /usr/lib/ssh/sftp-server
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
# SSH target for the netssh test environment: every NetBox host, the bastion,
|
||||||
|
# and the static host run this image with a different hostname.
|
||||||
|
FROM alpine:3.24
|
||||||
|
|
||||||
|
# Alpine locks new accounts with "!"; sshd refuses key logins for locked
|
||||||
|
# accounts, so the password field is set to "*" (no password, not locked).
|
||||||
|
RUN apk add --no-cache openssh-server openssh-sftp-server python3 \
|
||||||
|
&& for user in ops admin; do \
|
||||||
|
adduser -D -s /bin/sh "$user" && sed -i "s/^$user:!/$user:*/" /etc/shadow; \
|
||||||
|
done
|
||||||
|
|
||||||
|
COPY testenv/targets/sshd_config /etc/ssh/sshd_config
|
||||||
|
COPY testenv/targets/entrypoint.sh /entrypoint.sh
|
||||||
|
|
||||||
|
EXPOSE 22 2222
|
||||||
|
ENTRYPOINT ["/entrypoint.sh"]
|
||||||
Executable
+12
@@ -0,0 +1,12 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Run the test scripts in the client container. Optional FILTER selects files
|
||||||
|
# by substring, e.g. testenv/test.sh tunnel. The client is rebuilt first so the
|
||||||
|
# tests always run the current source.
|
||||||
|
set -euo pipefail
|
||||||
|
cd "$(dirname "$0")"
|
||||||
|
compose=(docker compose -f compose.yaml)
|
||||||
|
if [ "${NO_BUILD:-}" != 1 ]; then
|
||||||
|
"${compose[@]}" build -q client
|
||||||
|
"${compose[@]}" up -d --wait client
|
||||||
|
fi
|
||||||
|
exec "${compose[@]}" exec -T client bash /tests/run.sh "${1:-}"
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# Cache refresh across both NetBox instances, filters, list, search, clear.
|
||||||
|
config <<'EOF'
|
||||||
|
resolver:
|
||||||
|
strategies: [management_subnet, primary_ip]
|
||||||
|
management_subnets: [10.231.1.0/24]
|
||||||
|
EOF
|
||||||
|
|
||||||
|
expect_out "refresh both instances" "9 entries written" netssh cache refresh
|
||||||
|
expect_out "list shows mgmt address" "fsn/fsn1-pve1.hoster.test 10.231.1.11" netssh cache list
|
||||||
|
expect_out "list shows lab VM" "lab/web1 10.231.1.42 vm" netssh cache list
|
||||||
|
expect_out "IPv6-only host" "fsn/v6-host fd00:30::60" netssh cache list
|
||||||
|
expect_out "refresh one instance" "2 entries written" netssh cache refresh --instance lab
|
||||||
|
expect_out "refresh by tag" "3 entries written" netssh cache refresh --tag pve
|
||||||
|
expect_out "refresh by kind" "3 entries written" netssh cache refresh --kind vm
|
||||||
|
expect_eq "search" "fsn/fsn1-pve1.hoster.test
|
||||||
|
fsn/fsn1-pve2.hoster.test
|
||||||
|
fsn/fsn1-pve3.hoster.test" bash -c 'netssh search fsn1 | sort'
|
||||||
|
check "clear" netssh cache clear
|
||||||
|
expect_eq "empty after clear" "" bash -c 'netssh search fsn'
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
# Connecting with the resolved address, default user and port, overrides.
|
||||||
|
config <<'EOF'
|
||||||
|
resolver:
|
||||||
|
strategies: [management_subnet, primary_ip]
|
||||||
|
management_subnets: [10.231.1.0/24]
|
||||||
|
ssh:
|
||||||
|
default_user: ops
|
||||||
|
EOF
|
||||||
|
|
||||||
|
expect_eq "connect via NetBox" "fsn1-pve1" netssh fsn/fsn1-pve1.hoster.test hostname
|
||||||
|
expect_eq "unique name without instance" "fsn1-pve2" netssh fsn1-pve2.hoster.test hostname
|
||||||
|
expect_eq "default user" "ops" netssh fsn/fsn1-pve1.hoster.test whoami
|
||||||
|
expect_eq "user@ wins" "admin" netssh admin@fsn/fsn1-pve1.hoster.test whoami
|
||||||
|
expect_eq "-l wins" "admin" netssh -l admin fsn/fsn1-pve1.hoster.test whoami
|
||||||
|
expect_eq "remote command with arguments" "a b" netssh fsn/fsn1-pve1.hoster.test echo a b
|
||||||
|
expect_eq "dry run" "ssh -l ops 10.231.1.11" netssh --dry-run fsn/fsn1-pve1.hoster.test
|
||||||
|
|
||||||
|
config <<'EOF'
|
||||||
|
resolver:
|
||||||
|
strategies: [management_subnet, primary_ip]
|
||||||
|
management_subnets: [10.231.1.0/24]
|
||||||
|
ssh:
|
||||||
|
default_user: ops
|
||||||
|
default_port: 2222
|
||||||
|
EOF
|
||||||
|
expect_out "default port" " 2222" netssh fsn/fsn1-pve1.hoster.test 'echo $SSH_CONNECTION'
|
||||||
|
expect_out "-p wins over default port" " 22" netssh -p 22 fsn/fsn1-pve1.hoster.test 'echo $SSH_CONNECTION'
|
||||||
|
expect_eq "dry run with port" "ssh -p 2222 -l ops 10.231.1.11" netssh --dry-run fsn/fsn1-pve1.hoster.test
|
||||||
|
expect_eq "version" "netssh" bash -c 'netssh --version | cut -d" " -f1'
|
||||||
Loaded 100 of 118 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user