test: improve testHelpers_test.go ✅

kareemmahlees · Feb 13, 2024 · fa62f03 · fa62f03
1 parent 6a4ab98
commit fa62f03
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 12 deletions.
diff --git a/internal/rest/tableRoutes_test.go b/internal/rest/tableRoutes_test.go
@@ -189,7 +189,7 @@ func (suite *TableRoutesTestSuite) TestHandleAddColumn() {
 		con := suite.getConnection(provider)
 		routes.RegisterTablesRoutes(app, con)
 
-		reqBody := utils.EncodeBody(models.AddModifyColumnPayload{ColName: fmt.Sprintf("test%d", idx), Type: "varchar(255)"})
+		reqBody, _ := utils.EncodeBody(models.AddModifyColumnPayload{ColName: fmt.Sprintf("test%d", idx), Type: "varchar(255)"})
 
 		req := httptest.NewRequest(http.MethodPost, "http://localhost:5522/table/test/column/add", reqBody)
 		req.Header.Set("Content-Type", "application/json")
@@ -231,7 +231,7 @@ func (suite *TableRoutesTestSuite) TestHandleModifyColumn() {
 		con := suite.getConnection(provider)
 		routes.RegisterTablesRoutes(app, con)
 
-		reqBody := utils.EncodeBody(models.AddModifyColumnPayload{ColName: "name", Type: fmt.Sprintf("varchar(5%d)", idx)})
+		reqBody, _ := utils.EncodeBody(models.AddModifyColumnPayload{ColName: "name", Type: fmt.Sprintf("varchar(5%d)", idx)})
 
 		req := httptest.NewRequest(http.MethodPut, "http://localhost:5522/table/test/column/modify", reqBody)
 		req.Header.Set("Content-Type", "application/json")
@@ -257,7 +257,7 @@ func (suite *TableRoutesTestSuite) TestHandleDeleteColumn() {
 		con := suite.getConnection(provider)
 		routes.RegisterTablesRoutes(app, con)
 
-		reqBody := utils.EncodeBody(models.DeleteColumnPayload{ColName: "name"})
+		reqBody, _ := utils.EncodeBody(models.DeleteColumnPayload{ColName: "name"})
 
 		req := httptest.NewRequest(http.MethodDelete, "http://localhost:5522/table/test/column/delete", reqBody)
 		req.Header.Set("Content-Type", "application/json")

diff --git a/utils/testHelpers.go b/utils/testHelpers.go
@@ -5,7 +5,6 @@ import (
 	"context"
 	"encoding/json"
 	"io"
-	"log"
 	"time"
 
 	"github.com/gofiber/fiber/v2"
@@ -82,22 +81,19 @@ func NewTestingFiberApp(provider string) *fiber.App {
 	return app
 }
 
-func EncodeBody[T any](body T) *bytes.Buffer {
+func EncodeBody[T any](body T) (*bytes.Buffer, error) {
 	var buf bytes.Buffer
 	err := json.NewEncoder(&buf).Encode(body)
 	if err != nil {
-		log.Fatal(err)
+		return nil, err
 	}
-	return &buf
+	return &buf, nil
 }
 
 func DecodeBody[K any](body io.ReadCloser) K {
 	var parsedPayload K
 	decoder := json.NewDecoder(body)
-	err := decoder.Decode(&parsedPayload)
-	if err != nil {
-		log.Fatal(err)
-	}
+	_ = decoder.Decode(&parsedPayload)
 	return parsedPayload
 }
 

diff --git a/utils/testHelpers_test.go b/utils/testHelpers_test.go
@@ -2,6 +2,7 @@ package utils
 
 import (
 	"context"
+	"errors"
 	"io"
 	"log"
 	"meta-x/lib"
@@ -80,16 +81,31 @@ func TestNewTestingFiberApp(t *testing.T) {
 
 func TestEncodeBody(t *testing.T) {
 	mockBody := "test"
-	encodedBody := EncodeBody(mockBody)
+	encodedBody, err := EncodeBody(mockBody)
 
 	assert.Equal(t, 7, encodedBody.Len())
+	assert.Nil(t, err)
+
+	_, err = EncodeBody(make(chan any)) // make encoding fail
+	assert.NotNil(t, err)
 }
 
 type mockBody struct {
 	Name string `json:"name"`
 	Age  int    `json:"age"`
 }
 
+// A mocked Reader that implements io.ReadClose which always returns an error
+type errReader int
+
+func (errReader) Read(p []byte) (n int, err error) {
+	return 0, errors.New("test error")
+}
+
+func (errReader) Close() error {
+	return errors.New("test error")
+}
+
 func TestDecodeBody(t *testing.T) {
 	testBody := io.NopCloser(strings.NewReader(`
 	{
@@ -124,6 +140,10 @@ func TestDecodeBody(t *testing.T) {
 
 	age = decodedBody2[1].Age
 	assert.Equal(t, age, 123)
+
+	decodedBody3 := DecodeBody[string](errReader(0))
+
+	assert.Empty(t, decodedBody3)
 }
 
 func TestSliceOfPointersToSliceOfValues(t *testing.T) {