Utils for errors and testing

Author: aditya43

src/api/utils/errors/errors.go

@@ -0,0 +1,63 @@
+package errors
+
+import (
+	"encoding/json"
+	"errors"
+	"net/http"
+)
+
+type ApiError interface {
+	Status() int
+	Message() string
+	Error() string
+}
+
+type apiError struct {
+	AStatus  int    `json:"status"`
+	AMessage string `json:"message"`
+	AnError  string `json:"error,omitempty"`
+}
+
+func (e *apiError) Status() int {
+	return e.AStatus
+}
+
+func (e *apiError) Message() string {
+	return e.AMessage
+}
+
+func (e *apiError) Error() string {
+	return e.AnError
+}
+
+func NewApiError(statusCode int, message string) ApiError {
+	return &apiError{AStatus: statusCode, AMessage: message}
+}
+
+func NewApiErrFromBytes(body []byte) (ApiError, error) {
+	var result apiError
+	if err := json.Unmarshal(body, &result); err != nil {
+		return nil, errors.New("invalid json body")
+	}
+	return &result, nil
+}
+
+func NewInternalServerError(message string) ApiError {
+	return &apiError{
+		AStatus:  http.StatusInternalServerError,
+		AMessage: message,
+	}
+}
+
+func NewNotFoundError(message string) ApiError {
+	return &apiError{
+		AStatus:  http.StatusNotFound,
+		AMessage: message,
+	}
+}
+func NewBadRequestError(message string) ApiError {
+	return &apiError{
+		AStatus:  http.StatusBadRequest,
+		AMessage: message,
+	}
+}

src/api/utils/test_utils/test_utils.go

@@ -0,0 +1,14 @@
+package test_utils
+
+import (
+	"net/http"
+	"net/http/httptest"
+
+	"github.com/gin-gonic/gin"
+)
+
+func GetMockedContext(request *http.Request, response *httptest.ResponseRecorder) *gin.Context {
+	c, _ := gin.CreateTestContext(response)
+	c.Request = request
+	return c
+}

src/api/utils/test_utils/test_utils_test.go

@@ -0,0 +1,25 @@
+package test_utils
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGetMockedContext(t *testing.T) {
+	request, err := http.NewRequest(http.MethodGet, "http://localhost:123/something", nil)
+	assert.Nil(t, err)
+	response := httptest.NewRecorder()
+	request.Header = http.Header{"X-Mock": {"true"}}
+	c := GetMockedContext(request, response)
+
+	assert.EqualValues(t, http.MethodGet, c.Request.Method)
+	assert.EqualValues(t, "123", c.Request.URL.Port())
+	assert.EqualValues(t, "/something", c.Request.URL.Path)
+	assert.EqualValues(t, "http", c.Request.URL.Scheme)
+	assert.EqualValues(t, 1, len(c.Request.Header))
+	assert.EqualValues(t, "true", c.GetHeader("x-mock"))
+	assert.EqualValues(t, "true", c.GetHeader("X-Mock"))
+}