Skip to content

Commit 27d1c5a

Browse files
pymqpymq
committed
cli: rework me status and gateway status output
me status: merge each service's status and address into one row (VPN, DNS, SOCKS5), collapse exit-peer details into a single "<ip>, ping <N>ms, direct/via relay" line, regroup rows, reformat uptime ("1d 21h 13m"), and disable table wrapping. gateway status: humanize booleans (enabled/disabled, [connected], direct/via relay), show the full peer id, fall back to id when the name is unknown, server before client, aligned as plain key: value lines.
1 parent 3c0bf20 commit 27d1c5a

4 files changed

Lines changed: 226 additions & 38 deletions

File tree

‎cli/gateway.go‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,26 @@ func gatewayStatus(api *apiclient.Client, w io.Writer) error {
1515
}
1616
gw := info.VPNGateway
1717

18-
fmt.Fprintf(w, "VPN gateway client enabled: %v\n", gw.ClientEnabled)
19-
fmt.Fprintf(w, "VPN gateway server enabled: %v\n", gw.ServerEnabled)
18+
line := func(label, value string) {
19+
fmt.Fprintf(w, "%-14s %s\n", label+":", value)
20+
}
21+
22+
line("Server", formatEnabled(gw.ServerEnabled))
23+
line("Client", formatEnabled(gw.ClientEnabled))
2024
if gw.ClientEnabled {
21-
fmt.Fprintf(w, "Gateway peer: %s (%s)\n", gw.GatewayPeerName, gw.GatewayPeerID)
22-
fmt.Fprintf(w, "Gateway peer connected: %v\n", gw.Connected)
25+
name := gw.GatewayPeerName
26+
if name == "" {
27+
name = gw.GatewayPeerID
28+
}
29+
line("Gateway peer", fmt.Sprintf("%s [%s]", name, formatConnected(gw.Connected)))
30+
line("Peer ID", gw.GatewayPeerID)
2331
if gw.GatewayPublicIP != "" {
24-
fmt.Fprintf(w, "Gateway public IP: %s\n", gw.GatewayPublicIP)
32+
line("Public IP", gw.GatewayPublicIP)
2533
}
2634
if gw.GatewayPing > 0 {
27-
fmt.Fprintf(w, "Gateway ping: %s\n", gw.GatewayPing.Round(time.Millisecond))
35+
line("Ping", gw.GatewayPing.Round(time.Millisecond).String())
2836
}
29-
fmt.Fprintf(w, "Gateway via relay: %v\n", gw.GatewayThroughRelay)
37+
line("Connection", formatRelay(gw.GatewayThroughRelay))
3038
}
3139

3240
return nil

‎cli/me.go‎

Lines changed: 130 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,33 +20,37 @@ func printStatus(api *apiclient.Client, w io.Writer) error {
2020
}
2121

2222
rows := [][]string{
23+
{"Name", stats.Name},
2324
{"Download rate", fmt.Sprintf("%s (%s)", stats.NetworkStatsInIECUnits.RateIn, stats.NetworkStatsInIECUnits.TotalIn)},
2425
{"Upload rate", fmt.Sprintf("%s (%s)", stats.NetworkStatsInIECUnits.RateOut, stats.NetworkStatsInIECUnits.TotalOut)},
2526
{"Bootstrap peers", fmt.Sprintf("%d/%d", stats.ConnectedBootstrapPeers, stats.TotalBootstrapPeers)},
26-
{"DNS", formatWorkingStatus(stats.IsAwlDNSSetAsSystem)},
27-
{"SOCKS5 Proxy", formatWorkingStatus(stats.SOCKS5.ListenerEnabled)},
28-
{"SOCKS5 Proxy address", stats.SOCKS5.ListenAddress},
29-
{"SOCKS5 Proxy exit node", stats.SOCKS5.UsingPeerName},
27+
{"VPN", formatVPNStatus(stats.VPN)},
3028
{"VPN gateway client", formatVPNGatewayClient(stats.VPNGateway)},
3129
}
3230
gw := stats.VPNGateway
3331
if gw.ClientEnabled {
34-
if gw.GatewayPublicIP != "" {
35-
rows = append(rows, []string{"VPN gateway public IP", gw.GatewayPublicIP})
32+
if detail := formatExitDetail(gw.GatewayPublicIP, gw.GatewayPing, gw.Connected, gw.GatewayThroughRelay); detail != "" {
33+
rows = append(rows, []string{"VPN gateway exit", detail})
3634
}
37-
if gw.GatewayPing > 0 {
38-
rows = append(rows, []string{"VPN gateway ping", gw.GatewayPing.Round(time.Millisecond).String()})
35+
}
36+
rows = append(rows, []string{"VPN gateway server", formatWorkingStatus(stats.VPNGateway.ServerEnabled)})
37+
rows = append(rows, []string{"SOCKS5 Proxy", formatServiceStatus(stats.SOCKS5.ListenerEnabled, stats.SOCKS5.ListenAddress)})
38+
s5 := stats.SOCKS5
39+
if exit := formatSOCKS5ExitNode(s5); exit != "off" {
40+
rows = append(rows, []string{"SOCKS5 exit node", exit})
41+
if detail := formatExitDetail(s5.UsingPeerPublicIP, s5.UsingPeerPing, s5.Connected, s5.UsingPeerThroughRelay); detail != "" {
42+
rows = append(rows, []string{"SOCKS5 exit", detail})
3943
}
40-
rows = append(rows, []string{"VPN gateway via relay", fmt.Sprintf("%v", gw.GatewayThroughRelay)})
4144
}
4245
rows = append(rows,
43-
[]string{"VPN gateway server", formatWorkingStatus(stats.VPNGateway.ServerEnabled)},
46+
[]string{"DNS", formatServiceStatus(stats.IsAwlDNSSetAsSystem, stats.AwlDNSAddress)},
4447
[]string{"Reachability", strings.ToLower(stats.Reachability)},
45-
[]string{"Uptime", stats.Uptime.Round(time.Second).String()},
48+
[]string{"Uptime", formatUptime(stats.Uptime)},
4649
[]string{"Server version", stats.ServerVersion},
4750
)
4851

4952
table := tablewriter.NewWriter(w)
53+
table.SetAutoWrapText(false)
5054
table.AppendBulk(rows)
5155

5256
table.Render()
@@ -61,23 +65,126 @@ func formatWorkingStatus(working bool) string {
6165
return "not working"
6266
}
6367

64-
// formatVPNGatewayClient renders the client-side VPN gateway state in a
65-
// single line: either "off", or the gateway peer's name + connectivity.
66-
// Mirrors how SOCKS5 status splits across two rows but compresses to one
67-
// since VPN gateway has fewer knobs to surface.
68+
// formatEnabled renders an on/off feature toggle.
69+
func formatEnabled(enabled bool) string {
70+
if enabled {
71+
return "enabled"
72+
}
73+
return "disabled"
74+
}
75+
76+
// formatConnected renders libp2p connectivity to a peer.
77+
func formatConnected(connected bool) string {
78+
if connected {
79+
return "connected"
80+
}
81+
return "disconnected"
82+
}
83+
84+
// formatServiceStatus renders an enabled/disabled service and, when enabled,
85+
// appends its listen address in parentheses, e.g. "working (127.0.0.66:53)".
86+
// The address is omitted while the service is off.
87+
func formatServiceStatus(enabled bool, addr string) string {
88+
if !enabled {
89+
return "not working"
90+
}
91+
if addr != "" {
92+
return fmt.Sprintf("working (%s)", addr)
93+
}
94+
return "working"
95+
}
96+
97+
// formatVPNStatus renders the local VPN interface state, including the
98+
// interface name and assigned address when it is up, e.g.
99+
// "working (awl0, 10.66.0.1/24)".
100+
func formatVPNStatus(vpn entity.VPNInfo) string {
101+
if !vpn.VPNInterfaceEnabled {
102+
return "not working"
103+
}
104+
var parts []string
105+
if vpn.InterfaceName != "" {
106+
parts = append(parts, vpn.InterfaceName)
107+
}
108+
if vpn.IPNet != "" {
109+
parts = append(parts, vpn.IPNet)
110+
}
111+
if len(parts) == 0 {
112+
return "working"
113+
}
114+
return fmt.Sprintf("working (%s)", strings.Join(parts, ", "))
115+
}
116+
117+
// formatExitDetail renders a compact one-line summary of a selected exit peer
118+
// (SOCKS5 or VPN gateway): "<public IP>, ping <N>ms, direct/via relay". Each
119+
// part is included only when meaningful; the relay part appears only while
120+
// connected. Returns "" when nothing is known.
121+
func formatExitDetail(publicIP string, ping time.Duration, connected, throughRelay bool) string {
122+
var parts []string
123+
if publicIP != "" {
124+
parts = append(parts, publicIP)
125+
}
126+
if ping > 0 {
127+
parts = append(parts, "ping "+ping.Round(time.Millisecond).String())
128+
}
129+
if connected {
130+
parts = append(parts, formatRelay(throughRelay))
131+
}
132+
return strings.Join(parts, ", ")
133+
}
134+
135+
// formatRelay renders the connection path of an exit peer in human terms.
136+
func formatRelay(throughRelay bool) string {
137+
if throughRelay {
138+
return "via relay"
139+
}
140+
return "direct"
141+
}
142+
143+
// formatUptime renders uptime with spaces between units. For 24h or more it
144+
// switches to day granularity and drops seconds (e.g. "1d 21h 13m"); below 24h
145+
// it keeps seconds and omits leading zero units (e.g. "1h 25m 5s", "5s").
146+
func formatUptime(d time.Duration) string {
147+
d = d.Round(time.Second)
148+
days := d / (24 * time.Hour)
149+
d -= days * 24 * time.Hour
150+
hours := d / time.Hour
151+
d -= hours * time.Hour
152+
mins := d / time.Minute
153+
d -= mins * time.Minute
154+
secs := d / time.Second
155+
156+
if days > 0 {
157+
return fmt.Sprintf("%dd %dh %dm", int64(days), int64(hours), int64(mins))
158+
}
159+
160+
var parts []string
161+
if hours > 0 {
162+
parts = append(parts, fmt.Sprintf("%dh", int64(hours)))
163+
}
164+
if mins > 0 || hours > 0 {
165+
parts = append(parts, fmt.Sprintf("%dm", int64(mins)))
166+
}
167+
parts = append(parts, fmt.Sprintf("%ds", int64(secs)))
168+
return strings.Join(parts, " ")
169+
}
170+
171+
func formatSOCKS5ExitNode(s5 entity.SOCKS5Info) string {
172+
return formatExitClient(s5.UsingPeerID != "", s5.Connected, s5.UsingPeerName, s5.UsingPeerID)
173+
}
174+
68175
func formatVPNGatewayClient(gw entity.VPNGatewayInfo) string {
69-
if !gw.ClientEnabled {
176+
return formatExitClient(gw.ClientEnabled, gw.Connected, gw.GatewayPeerName, gw.GatewayPeerID)
177+
}
178+
179+
func formatExitClient(enabled, connected bool, peerName, peerID string) string {
180+
if !enabled {
70181
return "off"
71182
}
72-
name := gw.GatewayPeerName
183+
name := peerName
73184
if name == "" {
74-
name = gw.GatewayPeerID
75-
}
76-
conn := "disconnected"
77-
if gw.Connected {
78-
conn = "connected"
185+
name = peerID
79186
}
80-
return fmt.Sprintf("via %s [%s]", name, conn)
187+
return fmt.Sprintf("%s [%s]", name, formatConnected(connected))
81188
}
82189

83190
func printPeerId(api *apiclient.Client, w io.Writer) error {

‎cli/me_test.go‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
package cli
2+
3+
import (
4+
"testing"
5+
"time"
6+
7+
"github.com/stretchr/testify/require"
8+
9+
"github.com/anywherelan/awl/entity"
10+
)
11+
12+
func TestFormatUptime(t *testing.T) {
13+
cases := []struct {
14+
name string
15+
d time.Duration
16+
want string
17+
}{
18+
{"seconds only", 5 * time.Second, "5s"},
19+
{"minutes and seconds", 25*time.Minute + 5*time.Second, "25m 5s"},
20+
{"hours minutes seconds", time.Hour + 25*time.Minute + 5*time.Second, "1h 25m 5s"},
21+
{"zero minutes kept under a day", time.Hour + 5*time.Second, "1h 0m 5s"},
22+
{"just under a day keeps seconds", 23*time.Hour + 59*time.Minute + 59*time.Second, "23h 59m 59s"},
23+
{"exactly a day drops seconds", 24 * time.Hour, "1d 0h 0m"},
24+
{"over a day drops seconds", 45*time.Hour + 13*time.Minute + 31*time.Second, "1d 21h 13m"},
25+
{"sub-second rounds down", 900 * time.Millisecond, "1s"},
26+
}
27+
for _, tc := range cases {
28+
t.Run(tc.name, func(t *testing.T) {
29+
require.Equal(t, tc.want, formatUptime(tc.d))
30+
})
31+
}
32+
}
33+
34+
func TestFormatExitDetail(t *testing.T) {
35+
cases := []struct {
36+
name string
37+
publicIP string
38+
ping time.Duration
39+
connected bool
40+
throughRelay bool
41+
want string
42+
}{
43+
{"full direct", "1.2.3.4", 674 * time.Millisecond, true, false, "1.2.3.4, ping 674ms, direct"},
44+
{"full via relay", "1.2.3.4", 405 * time.Millisecond, true, true, "1.2.3.4, ping 405ms, via relay"},
45+
{"no public ip", "", 100 * time.Millisecond, true, false, "ping 100ms, direct"},
46+
{"zero ping dropped", "1.2.3.4", 0, true, false, "1.2.3.4, direct"},
47+
{"disconnected drops relay", "1.2.3.4", 100 * time.Millisecond, false, false, "1.2.3.4, ping 100ms"},
48+
{"nothing known", "", 0, false, false, ""},
49+
}
50+
for _, tc := range cases {
51+
t.Run(tc.name, func(t *testing.T) {
52+
require.Equal(t, tc.want, formatExitDetail(tc.publicIP, tc.ping, tc.connected, tc.throughRelay))
53+
})
54+
}
55+
}
56+
57+
func TestFormatVPNStatus(t *testing.T) {
58+
require.Equal(t, "not working", formatVPNStatus(entity.VPNInfo{}))
59+
require.Equal(t, "working (awl0, 10.66.0.1/24)", formatVPNStatus(entity.VPNInfo{
60+
VPNInterfaceEnabled: true, InterfaceName: "awl0", IPNet: "10.66.0.1/24",
61+
}))
62+
require.Equal(t, "working (awl0)", formatVPNStatus(entity.VPNInfo{
63+
VPNInterfaceEnabled: true, InterfaceName: "awl0",
64+
}))
65+
require.Equal(t, "working", formatVPNStatus(entity.VPNInfo{VPNInterfaceEnabled: true}))
66+
}
67+
68+
func TestFormatServiceStatus(t *testing.T) {
69+
require.Equal(t, "not working", formatServiceStatus(false, "127.0.0.66:53"))
70+
require.Equal(t, "working (127.0.0.66:53)", formatServiceStatus(true, "127.0.0.66:53"))
71+
require.Equal(t, "working", formatServiceStatus(true, ""))
72+
}

‎cli_test.go‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,8 @@ func TestCLI_Me(t *testing.T) {
4040
require.NoError(t, err)
4141
// Row labels are static; values are dynamic (uptime, bootstrap peers, reachability)
4242
for _, label := range []string{
43-
"Download rate", "Upload rate", "Bootstrap peers",
44-
"DNS", "SOCKS5 Proxy", "SOCKS5 Proxy address",
45-
"SOCKS5 Proxy exit node",
43+
"Name", "Download rate", "Upload rate", "Bootstrap peers",
44+
"VPN", "DNS", "SOCKS5 Proxy",
4645
"VPN gateway client", "VPN gateway server",
4746
"Reachability", "Uptime", "Server version",
4847
} {
@@ -388,11 +387,11 @@ func TestCLI_Gateway(t *testing.T) {
388387
t.Run("StatusEnabled", func(t *testing.T) {
389388
out, err := runCLI(ts, client, "gateway", "status")
390389
require.NoError(t, err)
391-
require.Contains(t, out, "VPN gateway client enabled: true")
390+
require.Regexp(t, `Client:\s+enabled`, out)
391+
require.Regexp(t, `Server:\s+disabled`, out)
392392
require.Contains(t, out, "Gateway peer:")
393393
require.Contains(t, out, exitNode.PeerID())
394-
require.Contains(t, out, "Gateway via relay:")
395-
require.Contains(t, out, "VPN gateway server enabled: false")
394+
require.Regexp(t, `Connection:\s+(direct|via relay)`, out)
396395
})
397396

398397
t.Run("List", func(t *testing.T) {
@@ -428,9 +427,11 @@ func TestCLI_Gateway(t *testing.T) {
428427
statusOut, err := runCLI(ts, client, "me", "status")
429428
require.NoError(t, err)
430429
require.Contains(t, statusOut, "VPN gateway client")
431-
require.Contains(t, statusOut, "via ")
430+
require.Contains(t, statusOut, "peer_2")
432431
require.Contains(t, statusOut, "[connected]")
433-
require.Contains(t, statusOut, "VPN gateway via relay")
432+
// The gateway detail row shows the connection path once connected.
433+
require.True(t, strings.Contains(statusOut, "direct") || strings.Contains(statusOut, "via relay"),
434+
"gateway detail row should show connection path")
434435
})
435436

436437
t.Run("ServerDisable", func(t *testing.T) {

0 commit comments

Comments
 (0)