Skip to content

Commit f14a2d1

Browse files
ritonriton
committed
feat: Add support for specifying URL Query params in HTTP resource
1 parent b563479 commit f14a2d1

File tree

4 files changed

+76
-61
lines changed

4 files changed

+76
-61
lines changed

‎docs/gossfile.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -335,6 +335,8 @@ http:
335335
timeout: 1000
336336
request-headers: # Set request header values
337337
- "Content-Type: text/html"
338+
request-query-params:
339+
foo: 'bar'
338340
headers: [] # Check http response headers for these patterns (e.g. "Content-Type: text/html")
339341
request-body: '{"key": "value"}' # request body
340342
body: [] # Check http response content for these patterns

‎resource/http.go‎

Lines changed: 34 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,27 @@ import (
1010
)
1111

1212
type HTTP struct {
13-
Title string `json:"title,omitempty" yaml:"title,omitempty"`
14-
Meta meta `json:"meta,omitempty" yaml:"meta,omitempty"`
15-
id string `json:"-" yaml:"-"`
16-
URL string `json:"url,omitempty" yaml:"url,omitempty"`
17-
Method string `json:"method,omitempty" yaml:"method,omitempty"`
18-
Status matcher `json:"status" yaml:"status"`
19-
AllowInsecure bool `json:"allow-insecure" yaml:"allow-insecure"`
20-
NoFollowRedirects bool `json:"no-follow-redirects" yaml:"no-follow-redirects"`
21-
Timeout int `json:"timeout,omitempty" yaml:"timeout,omitempty"`
22-
RequestHeader []string `json:"request-headers,omitempty" yaml:"request-headers,omitempty"`
23-
RequestBody string `json:"request-body,omitempty" yaml:"request-body,omitempty"`
24-
Headers matcher `json:"headers,omitempty" yaml:"headers,omitempty"`
25-
Body matcher `json:"body,omitempty" yaml:"body,omitempty"`
26-
Username string `json:"username,omitempty" yaml:"username,omitempty"`
27-
Password string `json:"password,omitempty" yaml:"password,omitempty"`
28-
CAFile string `json:"ca-file,omitempty" yaml:"ca-file,omitempty"`
29-
CertFile string `json:"cert-file,omitempty" yaml:"cert-file,omitempty"`
30-
KeyFile string `json:"key-file,omitempty" yaml:"key-file,omitempty"`
31-
Skip bool `json:"skip,omitempty" yaml:"skip,omitempty"`
32-
Proxy string `json:"proxy,omitempty" yaml:"proxy,omitempty"`
13+
Title string `json:"title,omitempty" yaml:"title,omitempty"`
14+
Meta meta `json:"meta,omitempty" yaml:"meta,omitempty"`
15+
id string `json:"-" yaml:"-"`
16+
URL string `json:"url,omitempty" yaml:"url,omitempty"`
17+
Method string `json:"method,omitempty" yaml:"method,omitempty"`
18+
Status matcher `json:"status" yaml:"status"`
19+
AllowInsecure bool `json:"allow-insecure" yaml:"allow-insecure"`
20+
NoFollowRedirects bool `json:"no-follow-redirects" yaml:"no-follow-redirects"`
21+
Timeout int `json:"timeout,omitempty" yaml:"timeout,omitempty"`
22+
RequestHeader []string `json:"request-headers,omitempty" yaml:"request-headers,omitempty"`
23+
RequestBody string `json:"request-body,omitempty" yaml:"request-body,omitempty"`
24+
RequestQueryParams map[string]string `json:"request-query-params,omitempty" yaml:"request-query-params,omitempty"`
25+
Headers matcher `json:"headers,omitempty" yaml:"headers,omitempty"`
26+
Body matcher `json:"body,omitempty" yaml:"body,omitempty"`
27+
Username string `json:"username,omitempty" yaml:"username,omitempty"`
28+
Password string `json:"password,omitempty" yaml:"password,omitempty"`
29+
CAFile string `json:"ca-file,omitempty" yaml:"ca-file,omitempty"`
30+
CertFile string `json:"cert-file,omitempty" yaml:"cert-file,omitempty"`
31+
KeyFile string `json:"key-file,omitempty" yaml:"key-file,omitempty"`
32+
Skip bool `json:"skip,omitempty" yaml:"skip,omitempty"`
33+
Proxy string `json:"proxy,omitempty" yaml:"proxy,omitempty"`
3334
}
3435

3536
const (
@@ -75,7 +76,7 @@ func (u *HTTP) Validate(sys *system.System) []TestResult {
7576
KeyFile: u.KeyFile,
7677
NoFollowRedirects: u.NoFollowRedirects,
7778
Timeout: time.Duration(u.Timeout) * time.Millisecond, Username: u.Username, Password: u.Password, Proxy: u.Proxy,
78-
RequestHeader: u.RequestHeader, RequestBody: u.RequestBody, Method: u.Method})
79+
RequestHeader: u.RequestHeader, RequestBody: u.RequestBody, RequestQueryParams: u.RequestQueryParams, Method: u.Method})
7980
sysHTTP.SetAllowInsecure(u.AllowInsecure)
8081
sysHTTP.SetNoFollowRedirects(u.NoFollowRedirects)
8182

@@ -98,17 +99,18 @@ func NewHTTP(sysHTTP system.HTTP, config util.Config) (*HTTP, error) {
9899
http := sysHTTP.HTTP()
99100
status, err := sysHTTP.Status()
100101
u := &HTTP{
101-
id: http,
102-
Status: status,
103-
RequestHeader: []string{},
104-
Headers: nil,
105-
Body: []string{},
106-
AllowInsecure: config.AllowInsecure,
107-
NoFollowRedirects: config.NoFollowRedirects,
108-
Timeout: config.TimeOutMilliSeconds(),
109-
Username: config.Username,
110-
Password: config.Password,
111-
Proxy: config.Proxy,
102+
id: http,
103+
Status: status,
104+
RequestHeader: []string{},
105+
RequestQueryParams: nil,
106+
Headers: nil,
107+
Body: []string{},
108+
AllowInsecure: config.AllowInsecure,
109+
NoFollowRedirects: config.NoFollowRedirects,
110+
Timeout: config.TimeOutMilliSeconds(),
111+
Username: config.Username,
112+
Password: config.Password,
113+
Proxy: config.Proxy,
112114
}
113115
return u, err
114116
}

‎system/http.go‎

Lines changed: 39 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,23 @@ type HTTP interface {
3030
}
3131

3232
type DefHTTP struct {
33-
http string
34-
allowInsecure bool
35-
noFollowRedirects bool
36-
resp *http.Response
37-
RequestHeader http.Header
38-
RequestBody string
39-
Timeout int
40-
loaded bool
41-
err error
42-
Username string
43-
Password string
44-
CAFile string
45-
CertFile string
46-
KeyFile string
47-
Method string
48-
Proxy string
33+
http string
34+
allowInsecure bool
35+
noFollowRedirects bool
36+
resp *http.Response
37+
RequestHeader http.Header
38+
RequestBody string
39+
RequestQueryParams map[string]string
40+
Timeout int
41+
loaded bool
42+
err error
43+
Username string
44+
Password string
45+
CAFile string
46+
CertFile string
47+
KeyFile string
48+
Method string
49+
Proxy string
4950
}
5051

5152
func NewDefHTTP(_ context.Context, httpStr string, system *System, config util.Config) HTTP {
@@ -60,19 +61,20 @@ func NewDefHTTP(_ context.Context, httpStr string, system *System, config util.C
6061
headers.Add(str[0], str[1])
6162
}
6263
return &DefHTTP{
63-
http: httpStr,
64-
allowInsecure: config.AllowInsecure,
65-
Method: config.Method,
66-
noFollowRedirects: config.NoFollowRedirects,
67-
RequestHeader: headers,
68-
RequestBody: config.RequestBody,
69-
Timeout: config.TimeOutMilliSeconds(),
70-
Username: config.Username,
71-
Password: config.Password,
72-
CAFile: config.CAFile,
73-
CertFile: config.CertFile,
74-
KeyFile: config.KeyFile,
75-
Proxy: config.Proxy,
64+
http: httpStr,
65+
allowInsecure: config.AllowInsecure,
66+
Method: config.Method,
67+
noFollowRedirects: config.NoFollowRedirects,
68+
RequestHeader: headers,
69+
RequestBody: config.RequestBody,
70+
RequestQueryParams: config.RequestQueryParams,
71+
Timeout: config.TimeOutMilliSeconds(),
72+
Username: config.Username,
73+
Password: config.Password,
74+
CAFile: config.CAFile,
75+
CertFile: config.CertFile,
76+
KeyFile: config.KeyFile,
77+
Proxy: config.Proxy,
7678
}
7779
}
7880

@@ -162,6 +164,14 @@ func (u *DefHTTP) setupReal() error {
162164
req.Host = host
163165
}
164166

167+
if u.RequestQueryParams != nil {
168+
qParams := req.URL.Query()
169+
for k, v := range u.RequestQueryParams {
170+
qParams.Add(k, v)
171+
}
172+
req.URL.RawQuery = qParams.Encode()
173+
}
174+
165175
if u.Username != "" || u.Password != "" {
166176
req.SetBasicAuth(u.Username, u.Password)
167177
}

‎util/config.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ type Config struct {
4242
RequestBody string
4343
Proxy string
4444
RequestHeader []string
45+
RequestQueryParams map[string]string
4546
RetryTimeout time.Duration
4647
RunLevel string
4748
Server string

0 commit comments

Comments
 (0)