extern/gatus
1
0
Fork 0
mirror of https://github.com/TwiN/gatus.git synced 2024-11-24 17:04:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

Work on #58: Add default "User-Agent: Gatus/1.0" header

Browse Source
This commit is contained in:
TwinProduction 2020-12-30 19:56:12 -05:00
parent 118b62c979
commit be75ef9c58
2 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
core/service.go
View File

@ -20,6 +20,12 @@ const (
// ContentTypeHeader is the name of the header used to specify the content type // ContentTypeHeader is the name of the header used to specify the content type
ContentTypeHeader = "Content-Type" ContentTypeHeader = "Content-Type"
// UserAgentHeader is the name of the header used to specify the request's user agent
UserAgentHeader = "User-Agent"
// GatusUserAgent is the default user agent that Gatus uses to send requests.
GatusUserAgent = "Gatus/1.0"
) )
var ( var (
@ -90,6 +96,10 @@ func (service *Service) ValidateAndSetDefaults() {
if len(service.Headers) == 0 { if len(service.Headers) == 0 {
service.Headers = make(map[string]string) service.Headers = make(map[string]string)
} }
// Automatically add user agent header if there isn't one specified in the service configuration
if _, userAgentHeaderExists := service.Headers[UserAgentHeader]; !userAgentHeaderExists {
service.Headers[UserAgentHeader] = GatusUserAgent
}
// Automatically add "Content-Type: application/json" header if there's no Content-Type set // Automatically add "Content-Type: application/json" header if there's no Content-Type set
// and service.GraphQL is set to true // and service.GraphQL is set to true
if _, contentTypeHeaderExists := service.Headers[ContentTypeHeader]; !contentTypeHeaderExists && service.GraphQL { if _, contentTypeHeaderExists := service.Headers[ContentTypeHeader]; !contentTypeHeaderExists && service.GraphQL {

26
core/service_test.go
View File

@ -130,6 +130,32 @@ func TestService_buildHTTPRequest(t *testing.T) {
if request.Host != "twinnation.org" { if request.Host != "twinnation.org" {
t.Error("request.Host should've been twinnation.org, but was", request.Host) t.Error("request.Host should've been twinnation.org, but was", request.Host)
} }
if userAgent := request.Header.Get("User-Agent"); userAgent != GatusUserAgent {
t.Errorf("request.Header.Get(User-Agent) should've been %s, but was %s", GatusUserAgent, userAgent)
}
}
func TestService_buildHTTPRequestWithCustomUserAgent(t *testing.T) {
condition := Condition("[STATUS] == 200")
service := Service{
Name: "TwiNNatioN",
URL: "https://twinnation.org/health",
Conditions: []*Condition{&condition},
Headers: map[string]string{
"User-Agent": "Test/2.0",
},
}
service.ValidateAndSetDefaults()
request := service.buildHTTPRequest()
if request.Method != "GET" {
t.Error("request.Method should've been GET, but was", request.Method)
}
if request.Host != "twinnation.org" {
t.Error("request.Host should've been twinnation.org, but was", request.Host)
}
if userAgent := request.Header.Get("User-Agent"); userAgent != "Test/2.0" {
t.Errorf("request.Header.Get(User-Agent) should've been %s, but was %s", "Test/2.0", userAgent)
}
} }
func TestService_buildHTTPRequestWithHostHeader(t *testing.T) { func TestService_buildHTTPRequestWithHostHeader(t *testing.T) {