helpers.go

/* ****************************************************************************
 * Copyright 2022 51 Degrees Mobile Experts Limited (51degrees.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 * ***************************************************************************/
package common

import (
	"compress/gzip"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
	"net/http/httptest"
	"net/url"
	"testing"
	"time"
)

// HTTPTest returns a test response after having processed the handler, method,
// URL, and body provided.
// t testing instance
// method HTTP method
// host
// url HTTP url
// values query values
// body data
// handler HTTP handler being tested
func HTTPTest(
	t *testing.T,
	method string,
	url *url.URL,
	body io.Reader,
	handler func(w http.ResponseWriter, r *http.Request)) *httptest.ResponseRecorder {

	// Get the new request.
	req, err := http.NewRequest(method, url.String(), body)
	if err != nil {
		t.Fatal(err)
	}

	// Call the handler and return the response.
	rr := httptest.NewRecorder()
	http.HandlerFunc(handler).ServeHTTP(rr, req)
	return rr
}

// ResponseAsMapTest decompresses the response and returns the body as a map.
func ResponseAsMapTest(
	t *testing.T,
	rr *httptest.ResponseRecorder) map[string]interface{} {
	var d map[string]interface{}
	err := json.Unmarshal(ResponseAsByteArrayTest(t, rr), &d)
	if err != nil {
		t.Fatal(fmt.Errorf("error unmarshalling: %w", err))
	}
	return d
}

// ResponseAsStringTest decompresses the response and returns the body as a
// string.
func ResponseAsStringTest(
	t *testing.T,
	rr *httptest.ResponseRecorder) string {
	return string(ResponseAsByteArrayTest(t, rr))
}

// ResponseAsByteArrayTest decompresses the response as a byte array.
func ResponseAsByteArrayTest(
	t *testing.T,
	rr *httptest.ResponseRecorder) []byte {
	var br io.Reader
	e := rr.Header().Get("Content-Encoding")
	switch e {
	case "":
		br = rr.Body
	case "gzip":
		var err error
		br, err = gzip.NewReader(rr.Body)
		if err != nil {
			t.Fatal(fmt.Errorf("error gzip decompressing: %w", err))
		}
	default:
		t.Fatal(fmt.Errorf("content type '%s' unsupported", e))
	}
	b, err := io.ReadAll(br)
	if err != nil {
		t.Fatal(err)
	}
	return b
}

func TestCompareDate(t *testing.T, a time.Time, b time.Time) {
	if a.Year() != b.Year() {
		fmt.Printf("Year %d != %d", a.Year(), b.Year())
		t.Fail()
	}
	if a.Month() != b.Month() {
		fmt.Printf("Month %d != %d", a.Month(), b.Month())
		t.Fail()
	}
	if a.Day() != b.Day() {
		fmt.Printf("Day %d != %d", a.Day(), b.Day())
		t.Fail()
	}
}