Simon Law
be16cc0d3d
In PR #19641, we added the `tailscale routecheck` command that supports both `--format=json` and `--format=json-line`. To allow other packages to import and unmarshal that JSON structure, this patch exports that format in a new tsroutecheckjsonv0 package. Updates #17366 Updates tailscale/corp#33033 Signed-off-by: Simon Law <sfllaw@tailscale.com>
123 lines
3.1 KiB
Go
123 lines
3.1 KiB
Go
// Copyright (c) Tailscale Inc & contributors
|
||
// SPDX-License-Identifier: BSD-3-Clause
|
||
|
||
//go:build !ts_omit_routecheck
|
||
|
||
package cli
|
||
|
||
import (
|
||
"cmp"
|
||
"context"
|
||
"flag"
|
||
"fmt"
|
||
"slices"
|
||
"strings"
|
||
"text/tabwriter"
|
||
|
||
jsonv2 "github.com/go-json-experiment/json"
|
||
"github.com/go-json-experiment/json/jsontext"
|
||
"github.com/peterbourgon/ff/v3/ffcli"
|
||
|
||
"tailscale.com/cmd/tailscale/cli/jsonoutput"
|
||
"tailscale.com/cmd/tailscale/tsroutecheckjsonv0"
|
||
"tailscale.com/net/routecheck"
|
||
"tailscale.com/tstime"
|
||
)
|
||
|
||
func init() {
|
||
maybeRoutecheckCmd = routecheckCmd
|
||
}
|
||
|
||
var routecheckCmd = func() *ffcli.Command {
|
||
return &ffcli.Command{
|
||
Name: "routecheck",
|
||
ShortUsage: "tailscale routecheck",
|
||
ShortHelp: "Print a reachability report for routes with multiple paths",
|
||
LongHelp: hidden + `"tailscale routecheck" is an experimental feature; it is not a stable interface`,
|
||
Exec: runRoutecheck,
|
||
FlagSet: routecheckFlagSet,
|
||
}
|
||
}
|
||
|
||
var routecheckFlagSet = func() *flag.FlagSet {
|
||
fs := newFlagSet("routecheck")
|
||
fs.BoolVar(&routecheckArgs.probe, "probe", false, "probe now to generate a new reachability report")
|
||
fs.Var(&routecheckArgs.format, "format", `output format: empty (for human-readable), "json" or "json-line"`)
|
||
fs.Var(routecheckArgs.format.JSONBool(), "json", "output in JSON format")
|
||
return fs
|
||
}()
|
||
|
||
var routecheckArgs struct {
|
||
probe bool
|
||
format jsonoutput.Format
|
||
}
|
||
|
||
func runRoutecheck(ctx context.Context, args []string) error {
|
||
routeCheck := localClient.RouteCheck
|
||
if routecheckArgs.probe {
|
||
routeCheck = localClient.RouteCheckProbe
|
||
}
|
||
rp, err := routeCheck(ctx)
|
||
if err != nil {
|
||
return fmt.Errorf("routecheck: %w", err)
|
||
}
|
||
if err := printRouteCheckReport(rp); err != nil {
|
||
return err
|
||
}
|
||
return nil
|
||
}
|
||
|
||
func printRouteCheckReport(rp *routecheck.Report) error {
|
||
var enc *jsontext.Encoder
|
||
switch routecheckArgs.format.String() {
|
||
case "":
|
||
case "json":
|
||
enc = jsontext.NewEncoder(Stdout, jsontext.WithIndent("\t"))
|
||
case "json-line":
|
||
enc = jsontext.NewEncoder(Stdout, jsontext.Multiline(false))
|
||
default:
|
||
return fmt.Errorf("unknown output format %q", routecheckArgs.format)
|
||
}
|
||
|
||
if rp == nil {
|
||
return fmt.Errorf("routecheck: report unavailable")
|
||
}
|
||
routes := rp.RoutablePrefixes()
|
||
|
||
// Don’t render prefixes that only have one router:
|
||
for pfx, nodes := range routes {
|
||
if len(nodes) <= 1 {
|
||
delete(routes, pfx)
|
||
}
|
||
}
|
||
|
||
if enc != nil {
|
||
out := tsroutecheckjsonv0.ReportResponse{
|
||
Done: rp.Done,
|
||
Routes: routes,
|
||
}
|
||
if err := jsonv2.MarshalEncode(enc, out); err != nil {
|
||
return err
|
||
}
|
||
if _, err := Stdout.Write([]byte("\n")); err != nil {
|
||
return err
|
||
}
|
||
return nil
|
||
}
|
||
|
||
w := tabwriter.NewWriter(Stdout, 10, 5, 5, ' ', 0)
|
||
defer w.Flush()
|
||
fmt.Fprintf(w, "\nReachable routers at %s:\n", rp.Done.Local().Format(tstime.DateSpTimeZ))
|
||
fmt.Fprintf(w, "\n %s\t%s\t%s", "PREFIX", "IP", "HOSTNAME")
|
||
for prefix, nodes := range routes.Sorted() {
|
||
slices.SortFunc(nodes, func(a, b routecheck.Node) int {
|
||
return cmp.Compare(a.Name, b.Name) // order by hostname
|
||
})
|
||
for _, n := range nodes {
|
||
fmt.Fprintf(w, "\n %s\t%s\t%s", prefix, n.Addr, strings.TrimSuffix(n.Name, "."))
|
||
}
|
||
}
|
||
fmt.Fprintln(w)
|
||
return nil
|
||
}
|