-
Notifications
You must be signed in to change notification settings - Fork 874
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix: Can't use Unix Sockets in Quick Tunnel mode #1367
base: master
Are you sure you want to change the base?
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -215,6 +215,7 @@ var ( | |
"overwrite-dns", | ||
"help", | ||
} | ||
runQuickTunnel = RunQuickTunnel | ||
) | ||
|
||
func Flags() []cli.Flag { | ||
|
@@ -313,9 +314,9 @@ func TunnelCommand(c *cli.Context) error { | |
// Run a quick tunnel | ||
// A unauthenticated named tunnel hosted on <random>.<quick-tunnels-service>.com | ||
// We don't support running proxy-dns and a quick tunnel at the same time as the same process | ||
shouldRunQuickTunnel := c.IsSet("url") || c.IsSet(ingress.HelloWorldFlag) | ||
shouldRunQuickTunnel := c.IsSet("url") || c.IsSet("unix-socket") || c.IsSet(ingress.HelloWorldFlag) | ||
if !c.IsSet("proxy-dns") && c.String("quick-service") != "" && shouldRunQuickTunnel { | ||
return RunQuickTunnel(sc) | ||
return runQuickTunnel(sc) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was hoping to avoid changes here as far as possible, but I'm happy to refactor this into a separate function if this is too hacky. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @rhyswilliamsza There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hi @lazysegtree ! Thanks for taking a look. I've unfortunately had to do this to allow injection of mock There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @rhyswilliamsza Got it. The test cases still seems pretty hacky (assigning A way that is not hacky, but neither does it introduces too many changes in source. Still yours might be the only way that introduces minimum changes in the source. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yip, I agree but unfortunately couldn't find a better way to mock out using the existing testing framework... I'll take another look after work today. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @rhyswilliamsza We could make Thats a bit more intrusive on the source code, but less hacky. Tell me what you think about this. Testcase run and diff
diff ➜ ~/Workspace/Other_proj/rhyswilliamsza/cloudflared/cmd/cloudflared/tunnel git:(fix/unix-socket-quick-tunnel) ✗ [9:16:05] git --no-pager diff
diff --git a/cmd/cloudflared/tunnel/cmd.go b/cmd/cloudflared/tunnel/cmd.go
index 24ec3817..21aff7b0 100644
--- a/cmd/cloudflared/tunnel/cmd.go
+++ b/cmd/cloudflared/tunnel/cmd.go
@@ -215,7 +215,6 @@ var (
"overwrite-dns",
"help",
}
- runQuickTunnel = RunQuickTunnel
)
func Flags() []cli.Flag {
@@ -287,7 +286,14 @@ See https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/in
}
}
+// This is so that we can mock QuickTunnelRunner for TunnelCommand test cases
+type QuickTunnelRunner func(*subcommandContext) error
+
func TunnelCommand(c *cli.Context) error {
+ return TunnelCommandImpl(c, RunQuickTunnel)
+}
+
+func TunnelCommandImpl(c *cli.Context, quickTunnelRunner QuickTunnelRunner) error {
sc, err := newSubcommandContext(c)
if err != nil {
return err
@@ -316,7 +322,7 @@ func TunnelCommand(c *cli.Context) error {
// We don't support running proxy-dns and a quick tunnel at the same time as the same process
shouldRunQuickTunnel := c.IsSet("url") || c.IsSet("unix-socket") || c.IsSet(ingress.HelloWorldFlag)
if !c.IsSet("proxy-dns") && c.String("quick-service") != "" && shouldRunQuickTunnel {
- return runQuickTunnel(sc)
+ return quickTunnelRunner(sc)
}
// If user provides a config, check to see if they meant to use `tunnel run` instead
diff --git a/cmd/cloudflared/tunnel/cmd_test.go b/cmd/cloudflared/tunnel/cmd_test.go
index faf1de00..0ac039a0 100644
--- a/cmd/cloudflared/tunnel/cmd_test.go
+++ b/cmd/cloudflared/tunnel/cmd_test.go
@@ -55,10 +55,8 @@ func TestShouldRunQuickTunnel(t *testing.T) {
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Mock RunQuickTunnel Function
- originalRunQuickTunnel := runQuickTunnel
- defer func() { runQuickTunnel = originalRunQuickTunnel }()
mockCalled := false
- runQuickTunnel = func(sc *subcommandContext) error {
+ runQuickTunnel := func(sc *subcommandContext) error {
mockCalled = true
return nil
}
@@ -69,7 +67,7 @@ func TestShouldRunQuickTunnel(t *testing.T) {
context := cli.NewContext(app, set, nil)
// Call TunnelCommand
- err := TunnelCommand(context)
+ err := TunnelCommandImpl(context, runQuickTunnel)
// Validate
if tt.expectError {
➜ ~/Workspace/Other_proj/rhyswilliamsza/cloudflared/cmd/cloudflared/tunnel git:(fix/unix-socket-quick-tunnel) ✗ [9:17:36] (Maybe we can rename There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks, @lazysegtree! Sorry for the delay, has been a busy week. I was hoping to change the source as little as possible, however I agree that it's better to do this in a more structured fashion. I like your approach better than the silly 'swapping in a function' method, even if it does require additional changes. I have added you as a collaborator to the forked repo. Please feel free to stage the change directly to the rhyswilliamsza:fix/unix-socket-quick-tunnel branch, or let me know if you'd prefer I do so :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Cool. I have committed the changes. @rhyswilliamsza |
||
} | ||
|
||
// If user provides a config, check to see if they meant to use `tunnel run` instead | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,12 @@ | ||
package tunnel | ||
|
||
import ( | ||
"flag" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
"github.com/stretchr/testify/require" | ||
"github.com/urfave/cli/v2" | ||
) | ||
|
||
func TestHostnameFromURI(t *testing.T) { | ||
|
@@ -15,3 +18,76 @@ func TestHostnameFromURI(t *testing.T) { | |
assert.Equal(t, "", hostnameFromURI("trash")) | ||
assert.Equal(t, "", hostnameFromURI("https://awesomesauce.com")) | ||
} | ||
|
||
func TestShouldRunQuickTunnel(t *testing.T) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've scoped this specifically to quick tunnels, so it won't test falling through to other tunnel types. |
||
tests := []struct { | ||
name string | ||
flags map[string]string | ||
expectError bool | ||
}{ | ||
{ | ||
name: "Quick tunnel with URL set", | ||
flags: map[string]string{"url": "http://127.0.0.1:8080", "quick-service": "https://fakeapi.trycloudflare.com"}, | ||
expectError: false, | ||
}, | ||
{ | ||
name: "Quick tunnel with unix-socket set", | ||
flags: map[string]string{"unix-socket": "/tmp/socket", "quick-service": "https://fakeapi.trycloudflare.com"}, | ||
expectError: false, | ||
}, | ||
{ | ||
name: "Quick tunnel with hello-world flag", | ||
flags: map[string]string{"hello-world": "true", "quick-service": "https://fakeapi.trycloudflare.com"}, | ||
expectError: false, | ||
}, | ||
{ | ||
name: "Quick tunnel with proxy-dns (invalid combo)", | ||
flags: map[string]string{"url": "http://127.0.0.1:9090", "proxy-dns": "true", "quick-service": "https://fakeapi.trycloudflare.com"}, | ||
expectError: true, | ||
}, | ||
{ | ||
name: "No quick-service set", | ||
flags: map[string]string{"url": "http://127.0.0.1:9090"}, | ||
expectError: true, | ||
}, | ||
} | ||
|
||
for _, tt := range tests { | ||
t.Run(tt.name, func(t *testing.T) { | ||
// Mock RunQuickTunnel Function | ||
originalRunQuickTunnel := runQuickTunnel | ||
defer func() { runQuickTunnel = originalRunQuickTunnel }() | ||
mockCalled := false | ||
runQuickTunnel = func(sc *subcommandContext) error { | ||
mockCalled = true | ||
return nil | ||
} | ||
|
||
// Mock App Context | ||
app := &cli.App{} | ||
set := flagSetFromMap(tt.flags) | ||
context := cli.NewContext(app, set, nil) | ||
|
||
// Call TunnelCommand | ||
err := TunnelCommand(context) | ||
|
||
// Validate | ||
if tt.expectError { | ||
assert.False(t, mockCalled) | ||
require.Error(t, err) | ||
} else { | ||
assert.True(t, mockCalled) | ||
require.NoError(t, err) | ||
} | ||
}) | ||
} | ||
} | ||
|
||
func flagSetFromMap(flags map[string]string) *flag.FlagSet { | ||
set := flag.NewFlagSet("test", 0) | ||
for key, value := range flags { | ||
set.String(key, "", "") | ||
set.Set(key, value) | ||
} | ||
return set | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't done any side-effect analysis to check whether anyone could be relying on
--unix-socket
forcing a trapdoor toproxy-dns
, but that seems unlikely so it should be okay.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried going through the code.
In
TunnelCommand
function in cmd.go, if--name
is not specified, only two non failure scenarios exists - quick tunnel or proxy dns.And in case of proxy-dns, I did not found a possible use of
--unix-socket
anywhere, as much I could understand the code flow.So, looks good.