Skip to content

Add configPath support to SshParams URL generation and tests #302

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.

Sign up for GitHub

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

Merged
johnstairs merged 1 commit into from
Mar 17, 2026
Merged

Add configPath support to SshParams URL generation and tests #302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions cli/internal/client/sshurl.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,9 @@ func (sp *SshParams) URL() *url.URL {
if sp.CliPath != "" {
q.Set("cliPath", sp.CliPath)
}
if sp.ConfigPath != "" {
q.Set("configPath", sp.ConfigPath)
}
for k, v := range sp.Options {
q.Set(fmt.Sprintf("option[%s]", k), v)
}
Expand Down
20 changes: 9 additions & 11 deletions cli/internal/client/sshurl_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,13 @@ func TestSshParams_URL_WithCliPath(t *testing.T) {
assert.Contains(t, u.RawQuery, "cliPath")
}

func TestSshParams_URL_WithConfigPath(t *testing.T) {
sp := SshParams{Host: "myhost", ConfigPath: "/home/user/.ssh/config"}
u := sp.URL()
assert.Contains(t, u.RawQuery, "configPath")
assert.Equal(t, "/home/user/.ssh/config", u.Query().Get("configPath"))
}

func TestSshParams_URL_WithOptions(t *testing.T) {
sp := SshParams{
Host: "myhost",
Expand All @@ -202,7 +209,7 @@ func TestSshParams_URL_WithOptions(t *testing.T) {
}

func TestSshParams_String_RoundTrip(t *testing.T) {
original := "ssh://alice@myhost:2222/path/to/socket?cliPath=%2Fusr%2Fbin%2Ftyger&option%5BFoo%5D=bar"
original := "ssh://alice@myhost:2222/path/to/socket?cliPath=%2Fusr%2Fbin%2Ftyger&configPath=%2Fhome%2Fuser%2F.ssh%2Fconfig&option%5BFoo%5D=bar"
u, err := url.Parse(original)
require.NoError(t, err)

Expand All @@ -220,6 +227,7 @@ func TestSshParams_String_RoundTrip(t *testing.T) {
assert.Equal(t, u.Path, u2.Path)
assert.Equal(t, u.User.Username(), u2.User.Username())
assert.Equal(t, u.Query().Get("cliPath"), u2.Query().Get("cliPath"))
assert.Equal(t, u.Query().Get("configPath"), u2.Query().Get("configPath"))
assert.Equal(t, u.Query().Get("option[Foo]"), u2.Query().Get("option[Foo]"))
}

Expand Down Expand Up @@ -465,16 +473,6 @@ func TestFormatCmdLine_StructureOrder(t *testing.T) {
assert.Equal(t, "arg2", remoteCmd[3])
}

func TestParseSshUrl_ConfigPathNotInURL(t *testing.T) {
// configPath is consumed during parsing and should not appear in URL output
sp := SshParams{
Host: "myhost",
ConfigPath: "/home/user/.ssh/config",
}
u := sp.URL()
assert.NotContains(t, u.RawQuery, "configPath")
}

func TestSshParams_URL_NoQueryWhenEmpty(t *testing.T) {
sp := SshParams{Host: "myhost", SocketPath: "/path"}
u := sp.URL()
Expand Down
4 changes: 4 additions & 0 deletions cli/internal/tygerproxy/tygerproxy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ func TestUrlsEquivalent(t *testing.T) {
"ssh://user@myhost/opt/tyger/api.sock?option[StrictHostKeyChecking]=no&option[UserKnownHostsFile]=NUL",
"ssh://user@myhost/opt/tyger/api.sock?option%5BStrictHostKeyChecking%5D=no&option%5BUserKnownHostsFile%5D=NUL",
true},
{"order of query parameters doesn't matter",
"ssh://user@myhost/opt/tyger/api.sock?option[StrictHostKeyChecking]=no&option[UserKnownHostsFile]=NUL",
"ssh://user@myhost/opt/tyger/api.sock?option[UserKnownHostsFile]=NUL&option[StrictHostKeyChecking]=no",
true},
{"escaped vs unescaped brackets reversed",
"ssh://user@myhost/opt/tyger/api.sock?option%5BStrictHostKeyChecking%5D=no&option%5BUserKnownHostsFile%5D=NUL",
"ssh://user@myhost/opt/tyger/api.sock?option[StrictHostKeyChecking]=no&option[UserKnownHostsFile]=NUL",
Expand Down
Loading