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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
|
package rest
import (
"errors"
"fmt"
"net/http"
"net/http/httptest"
"net/http/httputil"
"strings"
"testing"
"time"
"golang.org/x/net/context"
)
func TestBuildURL(t *testing.T) {
t.Parallel()
host := "http://api.test.com"
queryParams := make(map[string]string)
queryParams["test"] = "1"
queryParams["test2"] = "2"
testURL := AddQueryParameters(host, queryParams)
if testURL != "http://api.test.com?test=1&test2=2" {
t.Error("Bad BuildURL result")
}
}
func TestBuildRequest(t *testing.T) {
t.Parallel()
method := Get
baseURL := "http://api.test.com"
key := "API_KEY"
Headers := make(map[string]string)
Headers["Content-Type"] = "application/json"
Headers["Authorization"] = "Bearer " + key
queryParams := make(map[string]string)
queryParams["test"] = "1"
queryParams["test2"] = "2"
request := Request{
Method: method,
BaseURL: baseURL,
Headers: Headers,
QueryParams: queryParams,
}
req, e := BuildRequestObject(request)
if e != nil {
t.Errorf("Rest failed to BuildRequest. Returned error: %v", e)
}
if req == nil {
t.Errorf("Failed to BuildRequest.")
}
//Start PrintRequest
requestDump, err := httputil.DumpRequest(req, true)
if err != nil {
t.Errorf("Error : %v", err)
}
fmt.Println("Request : ", string(requestDump))
//End Print Request
}
func TestBuildBadRequest(t *testing.T) {
t.Parallel()
request := Request{
Method: Method("@"),
}
req, e := BuildRequestObject(request)
if e == nil {
t.Errorf("Expected an error for a bad HTTP Method")
}
if req != nil {
t.Errorf("If there's an error there shouldn't be a Request.")
}
}
func TestBuildBadAPI(t *testing.T) {
t.Parallel()
request := Request{
Method: Method("@"),
}
res, e := API(request)
if e == nil {
t.Errorf("Expected an error for a bad HTTP Method")
}
if res != nil {
t.Errorf("If there's an error there shouldn't be a Response.")
}
}
func TestBuildResponse(t *testing.T) {
t.Parallel()
fakeServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintln(w, "{\"message\": \"success\"}")
}))
defer fakeServer.Close()
baseURL := fakeServer.URL
method := Get
request := Request{
Method: method,
BaseURL: baseURL,
}
req, e := BuildRequestObject(request)
if e != nil {
t.Error("Failed to BuildRequestObject", e)
}
res, e := MakeRequest(req)
if e != nil {
t.Error("Failed to MakeRequest", e)
}
response, e := BuildResponse(res)
if response.StatusCode != 200 {
t.Error("Invalid status code in BuildResponse")
}
if len(response.Body) == 0 {
t.Error("Invalid response body in BuildResponse")
}
if len(response.Headers) == 0 {
t.Error("Invalid response headers in BuildResponse")
}
if e != nil {
t.Errorf("Rest failed to make a valid API request. Returned error: %v", e)
}
//Start Print Request
requestDump, err := httputil.DumpRequest(req, true)
if err != nil {
t.Errorf("Error : %v", err)
}
fmt.Println("Request :", string(requestDump))
//End Print Request
}
type panicResponse struct{}
func (*panicResponse) Read([]byte) (n int, err error) {
return 0, errors.New("test error")
}
func (*panicResponse) Close() error {
return nil
}
func TestBuildBadResponse(t *testing.T) {
t.Parallel()
res := &http.Response{
Body: new(panicResponse),
}
_, e := BuildResponse(res)
if e == nil {
t.Errorf("This was a bad response and error should be returned")
}
}
func TestRest(t *testing.T) {
t.Parallel()
testingAPI(t, Send)
testingAPI(t, API)
}
func testingAPI(t *testing.T, fn func(request Request) (*Response, error)) {
fakeServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintln(w, "{\"message\": \"success\"}")
}))
defer fakeServer.Close()
host := fakeServer.URL
endpoint := "/test_endpoint"
baseURL := host + endpoint
key := "API_KEY"
Headers := make(map[string]string)
Headers["Content-Type"] = "application/json"
Headers["Authorization"] = "Bearer " + key
method := Get
queryParams := make(map[string]string)
queryParams["test"] = "1"
queryParams["test2"] = "2"
request := Request{
Method: method,
BaseURL: baseURL,
Headers: Headers,
QueryParams: queryParams,
}
//Start Print Request
req, e := BuildRequestObject(request)
if e != nil {
t.Errorf("Error during BuildRequestObject: %v", e)
}
requestDump, err := httputil.DumpRequest(req, true)
if err != nil {
t.Errorf("Error : %v", err)
}
fmt.Println("Request :", string(requestDump))
//End Print Request
response, e := fn(request)
if response.StatusCode != 200 {
t.Error("Invalid status code")
}
if len(response.Body) == 0 {
t.Error("Invalid response body")
}
if len(response.Headers) == 0 {
t.Error("Invalid response headers")
}
if e != nil {
t.Errorf("Rest failed to make a valid API request. Returned error: %v", e)
}
}
func TestDefaultContentTypeWithBody(t *testing.T) {
t.Parallel()
host := "http://localhost"
method := Get
request := Request{
Method: method,
BaseURL: host,
Body: []byte("Hello World"),
}
response, _ := BuildRequestObject(request)
if response.Header.Get("Content-Type") != "application/json" {
t.Error("Content-Type not set to the correct default value when a body is set.")
}
//Start Print Request
fmt.Println("Request Body: ", string(request.Body))
requestDump, err := httputil.DumpRequest(response, true)
if err != nil {
t.Errorf("Error : %v", err)
}
fmt.Println("Request :", string(requestDump))
//End Print Request
}
func TestCustomContentType(t *testing.T) {
t.Parallel()
host := "http://localhost"
Headers := make(map[string]string)
Headers["Content-Type"] = "custom"
method := Get
request := Request{
Method: method,
BaseURL: host,
Headers: Headers,
Body: []byte("Hello World"),
}
response, _ := BuildRequestObject(request)
if response.Header.Get("Content-Type") != "custom" {
t.Error("Content-Type not modified correctly")
}
//Start Print Request
requestDump, err := httputil.DumpRequest(response, true)
if err != nil {
t.Errorf("Error : %v", err)
}
fmt.Println("Request :", string(requestDump))
//End Print Request
}
func TestCustomHTTPClient(t *testing.T) {
t.Parallel()
fakeServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
time.Sleep(time.Millisecond * 20)
fmt.Fprintln(w, "{\"message\": \"success\"}")
}))
defer fakeServer.Close()
host := fakeServer.URL
endpoint := "/test_endpoint"
baseURL := host + endpoint
method := Get
request := Request{
Method: method,
BaseURL: baseURL,
}
customClient := &Client{&http.Client{Timeout: time.Millisecond * 10}}
_, err := customClient.Send(request)
if err == nil {
t.Error("A timeout did not trigger as expected")
}
if !strings.Contains(err.Error(), "Client.Timeout exceeded while awaiting headers") {
t.Error("We did not receive the Timeout error")
}
}
func TestRestError(t *testing.T) {
t.Parallel()
headers := make(map[string][]string)
headers["Content-Type"] = []string{"application/json"}
response := &Response{
StatusCode: 400,
Body: `{"result": "failure"}`,
Headers: headers,
}
var err error = &RestError{Response: response}
if err.Error() != `{"result": "failure"}` {
t.Error("Invalid error message.")
}
}
func TestRepoFiles(t *testing.T) {
//TTT files are not available during tests, so test is deactivated
//TTT files := []string{".env_sample", ".gitignore", ".github/workflows/test.yml", "CHANGELOG.md",
//TTT "CODE_OF_CONDUCT.md", "CONTRIBUTING.md", "ISSUE_TEMPLATE.md",
//TTT "LICENSE", "PULL_REQUEST_TEMPLATE.md", "README.md",
//TTT "TROUBLESHOOTING.md", "USAGE.md"}
//TTT for _, file := range files {
//TTT if _, err := os.Stat(file); os.IsNotExist(err) {
//TTT t.Errorf("Repo file does not exist: %v", file)
//TTT }
//TTT }
}
func TestLicenseYear(t *testing.T) {
//TTT package will be build in older releases, where there was no update of the license
//TTT t.Parallel()
//TTT dat, err := ioutil.ReadFile("LICENSE")
//TTT currentYear := time.Now().Year()
//TTT r := fmt.Sprintf("%d", currentYear)
//TTT match, _ := regexp.MatchString(r, string(dat))
//TTT if err != nil {
//TTT t.Error("License File Not Found")
//TTT }
//TTT if !match {
//TTT t.Error("Incorrect Year in License Copyright")
//TTT }
}
func TestSendWithContext(t *testing.T) {
t.Parallel()
fakeServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
time.Sleep(time.Millisecond * 20)
fmt.Fprintln(w, "{\"message\": \"success\"}")
}))
defer fakeServer.Close()
host := fakeServer.URL
endpoint := "/test_endpoint"
baseURL := host + endpoint
method := Get
request := Request{
Method: method,
BaseURL: baseURL,
}
ctx, _ := context.WithTimeout(context.Background(), time.Millisecond*10)
_, err := SendWithContext(ctx, request)
if err == nil {
t.Error("A timeout did not trigger as expected")
}
if !strings.Contains(err.Error(), "context deadline exceeded") {
t.Error("We did not receive the Timeout error")
}
}
|