mirror of
https://github.com/TwiN/gatus.git
synced 2024-11-21 23:43:27 +01:00
408a46f2af
* feat: enhance HTTP client configuration with proxy support - Add `ProxyURL` field to `Config` struct with YAML tag - Implement proxy URL parsing and setting in `getHTTPClient` method - Add test case for `getHTTPClient` method with custom proxy URL setting - Include `net/url` package in both `config.go` and `config_test.go` files Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * docs: enhance README with Proxy and OAuth2 Docs - Remove empty lines from README.md - Add documentation for proxy configuration in client examples - Include YAML examples for client using a proxy, custom DNS resolver, OAuth2, and identity-aware proxy configurations in README.md Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * docs: add proxy client Signed-off-by: appleboy <appleboy.tw@gmail.com> * Update client/config.go * Update README.md * Update client/config_test.go --------- Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> Signed-off-by: appleboy <appleboy.tw@gmail.com> Co-authored-by: TwiN <twin@linux.com>
109 lines
3.1 KiB
Go
109 lines
3.1 KiB
Go
package client
|
|
|
|
import (
|
|
"net/http"
|
|
"net/url"
|
|
"testing"
|
|
"time"
|
|
)
|
|
|
|
func TestConfig_getHTTPClient(t *testing.T) {
|
|
insecureConfig := &Config{Insecure: true}
|
|
insecureConfig.ValidateAndSetDefaults()
|
|
insecureClient := insecureConfig.getHTTPClient()
|
|
if !(insecureClient.Transport).(*http.Transport).TLSClientConfig.InsecureSkipVerify {
|
|
t.Error("expected Config.Insecure set to true to cause the HTTP client to skip certificate verification")
|
|
}
|
|
if insecureClient.Timeout != defaultTimeout {
|
|
t.Error("expected Config.Timeout to default the HTTP client to a timeout of 10s")
|
|
}
|
|
request, _ := http.NewRequest("GET", "", nil)
|
|
if err := insecureClient.CheckRedirect(request, nil); err != nil {
|
|
t.Error("expected Config.IgnoreRedirect set to false to cause the HTTP client's CheckRedirect to return nil")
|
|
}
|
|
|
|
secureConfig := &Config{IgnoreRedirect: true, Timeout: 5 * time.Second}
|
|
secureConfig.ValidateAndSetDefaults()
|
|
secureClient := secureConfig.getHTTPClient()
|
|
if (secureClient.Transport).(*http.Transport).TLSClientConfig.InsecureSkipVerify {
|
|
t.Error("expected Config.Insecure set to false to cause the HTTP client to not skip certificate verification")
|
|
}
|
|
if secureClient.Timeout != 5*time.Second {
|
|
t.Error("expected Config.Timeout to cause the HTTP client to have a timeout of 5s")
|
|
}
|
|
request, _ = http.NewRequest("GET", "", nil)
|
|
if err := secureClient.CheckRedirect(request, nil); err != http.ErrUseLastResponse {
|
|
t.Error("expected Config.IgnoreRedirect set to true to cause the HTTP client's CheckRedirect to return http.ErrUseLastResponse")
|
|
}
|
|
}
|
|
|
|
func TestConfig_ValidateAndSetDefaults_withCustomDNSResolver(t *testing.T) {
|
|
type args struct {
|
|
dnsResolver string
|
|
}
|
|
tests := []struct {
|
|
name string
|
|
args args
|
|
wantErr bool
|
|
}{
|
|
{
|
|
name: "with-valid-resolver",
|
|
args: args{
|
|
dnsResolver: "tcp://1.1.1.1:53",
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "with-invalid-resolver-port",
|
|
args: args{
|
|
dnsResolver: "tcp://127.0.0.1:99999",
|
|
},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "with-invalid-resolver-format",
|
|
args: args{
|
|
dnsResolver: "foobar",
|
|
},
|
|
wantErr: true,
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
cfg := &Config{
|
|
DNSResolver: tt.args.dnsResolver,
|
|
}
|
|
err := cfg.ValidateAndSetDefaults()
|
|
if (err != nil) != tt.wantErr {
|
|
t.Errorf("ValidateAndSetDefaults() error=%v, wantErr=%v", err, tt.wantErr)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestConfig_getHTTPClient_withCustomProxyURL(t *testing.T) {
|
|
proxyURL := "http://proxy.example.com:8080"
|
|
cfg := &Config{
|
|
ProxyURL: proxyURL,
|
|
}
|
|
cfg.ValidateAndSetDefaults()
|
|
client := cfg.getHTTPClient()
|
|
transport := client.Transport.(*http.Transport)
|
|
if transport.Proxy == nil {
|
|
t.Errorf("expected Config.ProxyURL to set the HTTP client's proxy to %s", proxyURL)
|
|
}
|
|
req := &http.Request{
|
|
URL: &url.URL{
|
|
Scheme: "http",
|
|
Host: "www.example.com",
|
|
},
|
|
}
|
|
expectProxyURL, err := transport.Proxy(req)
|
|
if err != nil {
|
|
t.Errorf("can't proxy the request %s", proxyURL)
|
|
}
|
|
if proxyURL != expectProxyURL.String() {
|
|
t.Errorf("expected Config.ProxyURL to set the HTTP client's proxy to %s", proxyURL)
|
|
}
|
|
}
|