mirrors
/
tailscale
mirror of https://github.com/tailscale/tailscale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cmd/tailscale/cli: updates help and background messaging (#9929) 

* Fixes issue with template string not being provided in help text
* Updates background information to provide full URL, including path, to make it clear the source and destination
* Restores some tests
* Removes AllowFunnel in ServeConfig if no proxy exists for that port.

updates #8489

Signed-off-by: Tyler Smalley <tyler@tailscale.com>
This commit is contained in:
Tyler Smalley 2023-10-23 13:24:21 -07:00 committed by GitHub
parent c53ee37912
commit 35d7b3aa27
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 81 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
cmd/tailscale/cli/serve_v2.go
View File

@ -46,16 +46,13 @@ a partial URL (e.g., localhost:3000), or a full URL including a path (e.g., http
EXAMPLES EXAMPLES
- Expose an HTTP server running at 127.0.0.1:3000 in the foreground: - Expose an HTTP server running at 127.0.0.1:3000 in the foreground:
$ tailscale %s 3000 $ tailscale %[1]s 3000
- Expose an HTTP server running at 127.0.0.1:3000 in the background: - Expose an HTTP server running at 127.0.0.1:3000 in the background:
$ tailscale %s --bg 3000 $ tailscale %[1]s --bg 3000
- Expose an HTTPS server with a valid certificate at https://localhost:8443
$ tailscale %s https://localhost:8443
- Expose an HTTPS server with invalid or self-signed certificates at https://localhost:8443 - Expose an HTTPS server with invalid or self-signed certificates at https://localhost:8443
$ tailscale %s https+insecure://localhost:8443 $ tailscale %[1]s https+insecure://localhost:8443
For more examples and use cases visit our docs site https://tailscale.com/kb/1247/funnel-serve-use-cases For more examples and use cases visit our docs site https://tailscale.com/kb/1247/funnel-serve-use-cases
`) `)
@ -119,7 +116,7 @@ func newServeV2Command(e *serveEnv, subcmd serveMode) *ffcli.Command {
fmt.Sprintf("%s status [--json]", info.Name), fmt.Sprintf("%s status [--json]", info.Name),
fmt.Sprintf("%s reset", info.Name), fmt.Sprintf("%s reset", info.Name),
}, "\n "), }, "\n "),
LongHelp: info.LongHelp + fmt.Sprintf(strings.TrimSpace(serveHelpCommon), info.Name, info.Name), LongHelp: info.LongHelp + fmt.Sprintf(strings.TrimSpace(serveHelpCommon), info.Name),
Exec: e.runServeCombined(subcmd), Exec: e.runServeCombined(subcmd),
FlagSet: e.newFlags("serve-set", func(fs *flag.FlagSet) { FlagSet: e.newFlags("serve-set", func(fs *flag.FlagSet) {
@ -397,6 +394,10 @@ func (e *serveEnv) setServe(sc *ipn.ServeConfig, st *ipnstate.Status, dnsName st
return fmt.Errorf("failed apply web serve: %w", err) return fmt.Errorf("failed apply web serve: %w", err)
} }
case serveTypeTCP, serveTypeTLSTerminatedTCP: case serveTypeTCP, serveTypeTLSTerminatedTCP:
if e.setPath != "" {
return fmt.Errorf("cannot mount a path for TCP serve")
}
err := e.applyTCPServe(sc, dnsName, srvType, srvPort, target) err := e.applyTCPServe(sc, dnsName, srvType, srvPort, target)
if err != nil { if err != nil {
return fmt.Errorf("failed to apply TCP serve: %w", err) return fmt.Errorf("failed to apply TCP serve: %w", err)
@ -431,7 +432,7 @@ func (e *serveEnv) messageForPort(sc *ipn.ServeConfig, st *ipnstate.Status, dnsN
} else { } else {
output.WriteString(msgServeAvailable) output.WriteString(msgServeAvailable)
} }
output.WriteString("\n") output.WriteString("\n\n")
scheme := "https" scheme := "https"
if sc.IsServingHTTP(srvPort) { if sc.IsServingHTTP(srvPort) {
@ -444,13 +445,6 @@ func (e *serveEnv) messageForPort(sc *ipn.ServeConfig, st *ipnstate.Status, dnsN
portPart = "" portPart = ""
} }
output.WriteString(fmt.Sprintf("%s://%s%s\n\n", scheme, dnsName, portPart))
if !e.bg {
output.WriteString(msgToExit)
return output.String()
}
srvTypeAndDesc := func(h *ipn.HTTPHandler) (string, string) { srvTypeAndDesc := func(h *ipn.HTTPHandler) (string, string) {
switch { switch {
case h.Path != "": case h.Path != "":
@ -472,12 +466,12 @@ func (e *serveEnv) messageForPort(sc *ipn.ServeConfig, st *ipnstate.Status, dnsN
sort.Slice(mounts, func(i, j int) bool { sort.Slice(mounts, func(i, j int) bool {
return len(mounts[i]) < len(mounts[j]) return len(mounts[i]) < len(mounts[j])
}) })
maxLen := len(mounts[len(mounts)-1])
for _, m := range mounts { for _, m := range mounts {
h := sc.Web[hp].Handlers[m] h := sc.Web[hp].Handlers[m]
t, d := srvTypeAndDesc(h) t, d := srvTypeAndDesc(h)
output.WriteString(fmt.Sprintf("%s %s%s %-5s %s\n", "|--", m, strings.Repeat(" ", maxLen-len(m)), t, d)) output.WriteString(fmt.Sprintf("%s://%s%s%s\n", scheme, dnsName, portPart, m))
output.WriteString(fmt.Sprintf("%s %-5s %s\n\n", "|--", t, d))
} }
} else if sc.TCP[srvPort] != nil { } else if sc.TCP[srvPort] != nil {
h := sc.TCP[srvPort] h := sc.TCP[srvPort]
@ -487,6 +481,7 @@ func (e *serveEnv) messageForPort(sc *ipn.ServeConfig, st *ipnstate.Status, dnsN
tlsStatus = "TLS terminated" tlsStatus = "TLS terminated"
} }
output.WriteString(fmt.Sprintf("%s://%s%s\n", scheme, dnsName, portPart))
output.WriteString(fmt.Sprintf("|-- tcp://%s (%s)\n", hp, tlsStatus)) output.WriteString(fmt.Sprintf("|-- tcp://%s (%s)\n", hp, tlsStatus))
for _, a := range st.TailscaleIPs { for _, a := range st.TailscaleIPs {
ipp := net.JoinHostPort(a.String(), strconv.Itoa(int(srvPort))) ipp := net.JoinHostPort(a.String(), strconv.Itoa(int(srvPort)))
@ -495,11 +490,15 @@ func (e *serveEnv) messageForPort(sc *ipn.ServeConfig, st *ipnstate.Status, dnsN
output.WriteString(fmt.Sprintf("|--> tcp://%s\n", h.TCPForward)) output.WriteString(fmt.Sprintf("|--> tcp://%s\n", h.TCPForward))
} }
subCmd := infoMap[e.subcmd].Name if !e.bg {
subCmdSentance := strings.ToUpper(string(subCmd[0])) + subCmd[1:] output.WriteString(msgToExit)
return output.String()
}
output.WriteString("\n") subCmd := infoMap[e.subcmd].Name
output.WriteString(fmt.Sprintf(msgRunningInBackground, subCmdSentance)) subCmdUpper := strings.ToUpper(string(subCmd[0])) + subCmd[1:]
output.WriteString(fmt.Sprintf(msgRunningInBackground, subCmdUpper))
output.WriteString("\n") output.WriteString("\n")
output.WriteString(fmt.Sprintf(msgDisableProxy, subCmd, srvType.String(), srvPort)) output.WriteString(fmt.Sprintf(msgDisableProxy, subCmd, srvType.String(), srvPort))
@ -623,6 +622,9 @@ func (e *serveEnv) applyFunnel(sc *ipn.ServeConfig, dnsName string, srvPort uint
// TODO: add error handling for if toggling for existing sc // TODO: add error handling for if toggling for existing sc
if allowFunnel { if allowFunnel {
mak.Set(&sc.AllowFunnel, hp, true) mak.Set(&sc.AllowFunnel, hp, true)
} else if _, exists := sc.AllowFunnel[hp]; exists {
fmt.Printf("Removing Funnel for %s\n", hp)
delete(sc.AllowFunnel, hp)
} }
} }
@ -821,6 +823,7 @@ func (e *serveEnv) removeWebServe(sc *ipn.ServeConfig, dnsName string, srvPort u
} }
if len(sc.Web[hp].Handlers) == 0 { if len(sc.Web[hp].Handlers) == 0 {
delete(sc.Web, hp) delete(sc.Web, hp)
delete(sc.AllowFunnel, hp)
delete(sc.TCP, srvPort) delete(sc.TCP, srvPort)
} }
@ -838,6 +841,10 @@ func (e *serveEnv) removeWebServe(sc *ipn.ServeConfig, dnsName string, srvPort u
delete(sc.AllowFunnel, hp) delete(sc.AllowFunnel, hp)
} }
if len(sc.AllowFunnel) == 0 {
sc.AllowFunnel = nil
}
return nil return nil
} }

116
cmd/tailscale/cli/serve_v2_test.go
View File

@ -586,65 +586,55 @@ func TestServeDevConfigMutations(t *testing.T) {
}, },
}, },
}) })
// TODO(tylersmalley) resolve these failures add(step{ // turn funnel off for primary port 443
// add(step{ // turn funnel off for primary port 443 command: cmd("serve --bg localhost:3000"),
// command: cmd("serve --https=443 --set-path=/bar localhost:3001"), want: &ipn.ServeConfig{
// want: &ipn.ServeConfig{ AllowFunnel: map[ipn.HostPort]bool{"foo.test.ts.net:8443": true},
// AllowFunnel: map[ipn.HostPort]bool{"foo.test.ts.net:8443": true}, TCP: map[uint16]*ipn.TCPPortHandler{443: {HTTPS: true}, 8443: {HTTPS: true}},
// TCP: map[uint16]*ipn.TCPPortHandler{443: {HTTPS: true}, 8443: {HTTPS: true}}, Web: map[ipn.HostPort]*ipn.WebServerConfig{
// Web: map[ipn.HostPort]*ipn.WebServerConfig{ "foo.test.ts.net:443": {Handlers: map[string]*ipn.HTTPHandler{
// "foo.test.ts.net:443": {Handlers: map[string]*ipn.HTTPHandler{ "/": {Proxy: "http://127.0.0.1:3000"},
// "/": {Proxy: "http://127.0.0.1:3000"}, }},
// }}, "foo.test.ts.net:8443": {Handlers: map[string]*ipn.HTTPHandler{
// "foo.test.ts.net:8443": {Handlers: map[string]*ipn.HTTPHandler{ "/bar": {Proxy: "http://127.0.0.1:3001"},
// "/bar": {Proxy: "http://127.0.0.1:3001"}, }},
// }}, },
// }, },
// }, })
// }) add(step{ // remove secondary port
// add(step{ // remove secondary port command: cmd("serve --https=8443 --set-path=/bar off"),
// command: cmd("https:8443 /bar off"), want: &ipn.ServeConfig{
// want: &ipn.ServeConfig{ TCP: map[uint16]*ipn.TCPPortHandler{443: {HTTPS: true}},
// AllowFunnel: map[ipn.HostPort]bool{"foo.test.ts.net:8443": true}, Web: map[ipn.HostPort]*ipn.WebServerConfig{
// TCP: map[uint16]*ipn.TCPPortHandler{443: {HTTPS: true}}, "foo.test.ts.net:443": {Handlers: map[string]*ipn.HTTPHandler{
// Web: map[ipn.HostPort]*ipn.WebServerConfig{ "/": {Proxy: "http://127.0.0.1:3000"},
// "foo.test.ts.net:443": {Handlers: map[string]*ipn.HTTPHandler{ }},
// "/": {Proxy: "http://127.0.0.1:3000"}, },
// }}, },
// }, })
// }, add(step{ // start a tcp forwarder on 8443
// }) command: cmd("serve --bg --tcp=8443 tcp://localhost:5432"),
// add(step{ // start a tcp forwarder on 8443 want: &ipn.ServeConfig{
// command: cmd("tcp:8443 tcp://localhost:5432"), TCP: map[uint16]*ipn.TCPPortHandler{443: {HTTPS: true}, 8443: {TCPForward: "127.0.0.1:5432"}},
// want: &ipn.ServeConfig{ Web: map[ipn.HostPort]*ipn.WebServerConfig{
// AllowFunnel: map[ipn.HostPort]bool{"foo.test.ts.net:8443": true}, "foo.test.ts.net:443": {Handlers: map[string]*ipn.HTTPHandler{
// TCP: map[uint16]*ipn.TCPPortHandler{443: {HTTPS: true}, 8443: {TCPForward: "127.0.0.1:5432"}}, "/": {Proxy: "http://127.0.0.1:3000"},
// Web: map[ipn.HostPort]*ipn.WebServerConfig{ }},
// "foo.test.ts.net:443": {Handlers: map[string]*ipn.HTTPHandler{ },
// "/": {Proxy: "http://127.0.0.1:3000"}, },
// }}, })
// }, add(step{ // remove primary port http handler
// }, command: cmd("serve off"),
// }) want: &ipn.ServeConfig{
// add(step{ // remove primary port http handler TCP: map[uint16]*ipn.TCPPortHandler{8443: {TCPForward: "127.0.0.1:5432"}},
// command: cmd("https:443 / off"), },
// want: &ipn.ServeConfig{ })
// AllowFunnel: map[ipn.HostPort]bool{"foo.test.ts.net:8443": true}, add(step{ // remove tcp forwarder
// TCP: map[uint16]*ipn.TCPPortHandler{8443: {TCPForward: "127.0.0.1:5432"}}, command: cmd("serve --tls-terminated-tcp=8443 off"),
// }, want: &ipn.ServeConfig{},
// }) })
// add(step{ // remove tcp forwarder
// command: cmd("tls-terminated-tcp:8443 off"),
// want: &ipn.ServeConfig{
// AllowFunnel: map[ipn.HostPort]bool{"foo.test.ts.net:8443": true},
// },
// })
// add(step{ // turn off funnel
// command: cmd("funnel 8443 off"),
// want: &ipn.ServeConfig{},
// })
// // tricky steps // tricky steps
add(step{reset: true}) add(step{reset: true})
add(step{ // a directory with a trailing slash mount point add(step{ // a directory with a trailing slash mount point
command: cmd("serve --https=443 --set-path=/dir " + filepath.Join(td, "subdir")), command: cmd("serve --https=443 --set-path=/dir " + filepath.Join(td, "subdir")),
@ -1123,9 +1113,9 @@ func TestMessageForPort(t *testing.T) {
srvPort: 443, srvPort: 443,
expected: strings.Join([]string{ expected: strings.Join([]string{
msgFunnelAvailable, msgFunnelAvailable,
"https://foo.test.ts.net",
"", "",
"|-- / proxy http://127.0.0.1:3000", "https://foo.test.ts.net/",
"|-- proxy http://127.0.0.1:3000",
"", "",
fmt.Sprintf(msgRunningInBackground, "Funnel"), fmt.Sprintf(msgRunningInBackground, "Funnel"),
fmt.Sprintf(msgDisableProxy, "funnel", "https", 443), fmt.Sprintf(msgDisableProxy, "funnel", "https", 443),
@ -1152,9 +1142,9 @@ func TestMessageForPort(t *testing.T) {
srvPort: 80, srvPort: 80,
expected: strings.Join([]string{ expected: strings.Join([]string{
msgServeAvailable, msgServeAvailable,
"https://foo.test.ts.net:80",
"", "",
"|-- / proxy http://127.0.0.1:3000", "https://foo.test.ts.net:80/",
"|-- proxy http://127.0.0.1:3000",
"", "",
fmt.Sprintf(msgRunningInBackground, "Serve"), fmt.Sprintf(msgRunningInBackground, "Serve"),
fmt.Sprintf(msgDisableProxy, "serve", "http", 80), fmt.Sprintf(msgDisableProxy, "serve", "http", 80),
@ -1173,7 +1163,7 @@ func TestMessageForPort(t *testing.T) {
} }
if actual != tt.expected { if actual != tt.expected {
t.Errorf("Got: %q; expected: %q", actual, tt.expected) t.Errorf("\nGot: %q\nExpected: %q", actual, tt.expected)
} }
}) })
} }