-
Notifications
You must be signed in to change notification settings - Fork 5
/
httptest.go
146 lines (131 loc) · 4.72 KB
/
httptest.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
// The MIT License (MIT)
//
// Copyright (c) 2016 GeekyPanda
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
package httptest
import (
"github.com/gavv/httpexpect"
"github.com/valyala/fasthttp"
"net/http"
"testing"
)
type (
// OptionSetter sets a configuration field to the configuration
OptionSetter interface {
// Set receives a pointer to the Configuration type and does the job of filling it
Set(c *Configuration)
}
// OptionSet implements the OptionSetter
OptionSet func(c *Configuration)
)
// Set is the func which makes the OptionSet an OptionSetter, this is used mostly
func (o OptionSet) Set(c *Configuration) {
o(c)
}
// Configuration is the httptest main configuration
type Configuration struct {
// Handler is the net/http handler, if != nil then httptest is testing via net/http's options
Handler http.Handler
// RequestHandler is the valyala/fasthttp.RequestHandler, if != nil then httptest is testing via valyala/fasthttp's options
RequestHandler fasthttp.RequestHandler
// ExplicitURL If true then the url (should) be prepended manually, useful when want to test subdomains
// Default is false
ExplicitURL bool
// Debug if true then debug messages from the httpexpect will be shown when a test runs
// Default is false
Debug bool
}
// Set implements the OptionSetter for the Configuration itself
func (c Configuration) Set(main *Configuration) {
main.ExplicitURL = c.ExplicitURL
main.Debug = c.Debug
if c.Handler != nil {
main.Handler = c.Handler
} else if c.RequestHandler != nil {
main.RequestHandler = c.RequestHandler
}
}
var (
// ExplicitURL If true then the url (should) be prepended manually, useful when want to test subdomains
// Default is false
ExplicitURL = func(val bool) OptionSet {
return func(c *Configuration) {
c.ExplicitURL = val
}
}
// Debug if true then debug messages from the httpexpect will be shown when a test runs
// Default is false
Debug = func(val bool) OptionSet {
return func(c *Configuration) {
c.Debug = val
}
}
// Handler sets the http handler to the httptest , use this function if you test your net/http api
Handler = func(val http.Handler) OptionSet {
return func(c *Configuration) {
c.Handler = val
}
}
// RequestHandler sets the fasthttp handler to the httptest , use this function if you test your valyala/fasthttp api
RequestHandler = func(val fasthttp.RequestHandler) OptionSet {
return func(c *Configuration) {
c.RequestHandler = val
}
}
)
// DefaultConfiguration returns the default configuration for the httptest
// all values are defaulted to false for clarity
func DefaultConfiguration() *Configuration {
return &Configuration{ExplicitURL: false, Debug: false}
}
// New Prepares and returns a new test framework based on a handler
// mux := http.NewServeMux()
// mux.Handle("/",http.HandlerFunc(...))
// ...
// e := httptest.New(t, httptest.Handler(mux))
// e.GET("/mypath").Expect().Status(http.StatusOK).Body().Equal("my body")
func New(t *testing.T, setters ...OptionSetter) *httpexpect.Expect {
conf := DefaultConfiguration()
for _, setter := range setters {
setter.Set(conf)
}
baseURL := ""
if !conf.ExplicitURL {
baseURL = "http://localhost:9999"
}
client := &http.Client{Jar: httpexpect.NewJar()}
// check if net/http or valyala/fasthttp
if conf.Handler != nil {
client.Transport = httpexpect.NewBinder(conf.Handler)
} else if conf.RequestHandler != nil {
client.Transport = httpexpect.NewFastBinder(conf.RequestHandler)
}
testConfiguration := httpexpect.Config{
BaseURL: baseURL,
Client: client,
Reporter: httpexpect.NewAssertReporter(t),
}
if conf.Debug {
testConfiguration.Printers = []httpexpect.Printer{
httpexpect.NewDebugPrinter(t, true),
}
}
return httpexpect.WithConfig(testConfiguration)
}