Skip to content

UseURL should require host and scheme #758

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
merged 4 commits into from
Jun 5, 2025
Merged

UseURL should require host and scheme #758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f7defde
useURL requires host and scheme
kokes May 26, 2025
5fc27cd
use c.resty.BaseURL
kokes May 26, 2025
f3673d7
redundant field
kokes May 26, 2025
7872c70
Merge branch 'main' into use_url_scheme
jriddle-linode Jun 5, 2025
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 client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,9 @@ func (c *Client) UseURL(apiURL string) (*Client, error) {
if err != nil {
return nil, fmt.Errorf("failed to parse URL: %w", err)
}
if parsedURL.Scheme == "" || parsedURL.Host == "" {
return nil, fmt.Errorf("need both scheme and host in API URL, got %q", apiURL)
}

// Create a new URL excluding the path to use as the base URL
baseURL := &url.URL{
Expand Down
70 changes: 52 additions & 18 deletions client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,30 +116,64 @@ func TestClient_NewFromEnvToken(t *testing.T) {
}

func TestClient_UseURL(t *testing.T) {
client := NewClient(nil)

if _, err := client.UseURL("https://api.test1.linode.com/"); err != nil {
t.Fatal(err)
tests := []struct {
name string
inputURL string
wantBaseURL string
wantErr string
}{
{
name: "Standard v4 URL",
inputURL: "https://api.test1.linode.com/",
wantBaseURL: "https://api.test1.linode.com/v4",
},
{
name: "Beta v4 URL",
inputURL: "https://api.test2.linode.com/v4beta",
wantBaseURL: "https://api.test2.linode.com/v4beta",
},
{
name: "Missing scheme",
inputURL: "api.test3.linode.com/v4",
wantErr: "need both scheme and host in API URL, got \"api.test3.linode.com/v4\"",
},
{
name: "Missing host",
inputURL: "https://",
wantErr: "need both scheme and host in API URL, got \"https://\"",
},
{
name: "Invalid URL",
inputURL: "ht!tp://bad_url",
wantErr: "failed to parse URL: parse \"ht!tp://bad_url\": first path segment in URL cannot contain colon",
},
}

if client.baseURL != "api.test1.linode.com" {
t.Fatalf("mismatched base url: %s", client.baseURL)
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
client := NewClient(nil)

if client.apiVersion != "v4" {
t.Fatalf("mismatched api version: %s", client.apiVersion)
}
_, err := client.UseURL(tt.inputURL)

if _, err := client.UseURL("https://api.test2.linode.com/v4beta"); err != nil {
t.Fatal(err)
}
if tt.wantErr != "" {
if err == nil {
t.Fatalf("expected error containing %q, got nil", tt.wantErr)
}
if !strings.Contains(err.Error(), tt.wantErr) {
t.Fatalf("expected error containing %q, got %q", tt.wantErr, err.Error())
}
// skip further checks if error was expected
return
}

if client.baseURL != "api.test2.linode.com" {
t.Fatalf("mismatched base url: %s", client.baseURL)
}
if err != nil {
t.Fatalf("unexpected error: %v", err)
}

if client.apiVersion != "v4beta" {
t.Fatalf("mismatched api version: %s", client.apiVersion)
if client.resty.BaseURL != tt.wantBaseURL {
t.Fatalf("mismatched base url: got %s, want %s", client.resty.BaseURL, tt.wantBaseURL)
}
})
}
}

Expand Down