chore: Add test for health handler (#7)

Author: thomaspoignant

api/server.go

@@ -36,7 +36,7 @@ func (s *Server) Start() {
 	s.apiEcho.Use(middleware.CORSWithConfig(middleware.DefaultCORSConfig))
 
 	// init health routes
-	s.apiEcho.POST("/health", s.healthHandlers.Health)
+	s.apiEcho.GET("/health", s.healthHandlers.Health)
 
 	// init API routes
 	groupV1 := s.apiEcho.Group("/v1")

dao/inmemory_mock_impl.go

@@ -0,0 +1,84 @@
+package dao
+
+import (
+	"context"
+	"fmt"
+	daoErr "github.com/go-feature-flag/app-api/dao/err"
+	"github.com/go-feature-flag/app-api/model"
+	_ "github.com/lib/pq" // we import the driver used by sqlx
+)
+
+func NewInMemoryMockDao() (*InMemoryMockDao, error) {
+	return &InMemoryMockDao{
+		flags: []model.FeatureFlag{},
+	}, nil
+}
+
+type InMemoryMockDao struct {
+	flags []model.FeatureFlag
+
+	errorOnPing bool
+}
+
+// GetFlags return all the flags
+func (m *InMemoryMockDao) GetFlags(ctx context.Context) ([]model.FeatureFlag, daoErr.DaoError) {
+	return m.flags, nil
+}
+
+// GetFlagByID return a flag by its ID
+func (m *InMemoryMockDao) GetFlagByID(ctx context.Context, id string) (model.FeatureFlag, daoErr.DaoError) {
+	for _, flag := range m.flags {
+		if flag.ID == id {
+			return flag, nil
+		}
+	}
+	return model.FeatureFlag{}, daoErr.NewDaoError(daoErr.NotFound, fmt.Errorf("flag with id %s not found", id))
+}
+
+// GetFlagByName return a flag by its name
+func (m *InMemoryMockDao) GetFlagByName(ctx context.Context, name string) (model.FeatureFlag, daoErr.DaoError) {
+	for _, flag := range m.flags {
+		if flag.Name == name {
+			return flag, nil
+		}
+	}
+	return model.FeatureFlag{}, daoErr.NewDaoError(daoErr.NotFound, fmt.Errorf("flag with name %s not found", name))
+}
+
+// CreateFlag create a new flag, return the id of the flag
+func (m *InMemoryMockDao) CreateFlag(ctx context.Context, flag model.FeatureFlag) (string, daoErr.DaoError) {
+	m.flags = append(m.flags, flag)
+	return flag.ID, nil
+}
+
+func (m *InMemoryMockDao) UpdateFlag(ctx context.Context, flag model.FeatureFlag) daoErr.DaoError {
+	for index, f := range m.flags {
+		if f.ID == flag.ID {
+			m.flags[index] = flag
+			return nil
+		}
+	}
+	return daoErr.NewDaoError(daoErr.NotFound, fmt.Errorf("flag with id %s not found", flag.ID))
+}
+
+func (m *InMemoryMockDao) DeleteFlagByID(ctx context.Context, id string) daoErr.DaoError {
+	newInmemoryFlagList := []model.FeatureFlag{}
+	for _, f := range m.flags {
+		if f.ID != id {
+			newInmemoryFlagList = append(newInmemoryFlagList, f)
+		}
+	}
+	m.flags = newInmemoryFlagList
+	return nil
+}
+
+func (m *InMemoryMockDao) Ping() daoErr.DaoError {
+	if m.errorOnPing {
+		return daoErr.NewDaoError(daoErr.DatabaseNotInitialized, fmt.Errorf("error on ping"))
+	}
+	return nil
+}
+
+func (m *InMemoryMockDao) OnPingReturnError(v bool) {
+	m.errorOnPing = v
+}

docs/docs.go

@@ -27,7 +27,7 @@ const docTemplate = `{
     "basePath": "{{.BasePath}}",
     "paths": {
         "/health": {
-            "post": {
+            "get": {
                 "description": "Check if the API is up and running and that the database is available.",
                 "tags": [
                     "Feature Monitoring"

docs/swagger.json

@@ -19,7 +19,7 @@
     "basePath": "/",
     "paths": {
         "/health": {
-            "post": {
+            "get": {
                 "description": "Check if the API is up and running and that the database is available.",
                 "tags": [
                     "Feature Monitoring"

docs/swagger.yaml

@@ -173,7 +173,7 @@ info:
     url: https://raw.githubusercontent.com/thomaspoignant/go-feature-flag/main/logo_128.png
 paths:
   /health:
-    post:
+    get:
       description: Check if the API is up and running and that the database is available.
       responses:
         "200":

go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/jmoiron/sqlx v1.4.0
 	github.com/labstack/echo/v4 v4.12.0
 	github.com/lib/pq v1.10.9
+	github.com/stretchr/testify v1.9.0
 	github.com/swaggo/echo-swagger v1.4.1
 	github.com/swaggo/swag v1.16.3
 )
@@ -32,7 +33,6 @@ require (
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/rogpeppe/go-internal v1.13.1 // indirect
-	github.com/stretchr/testify v1.9.0 // indirect
 	github.com/swaggo/files/v2 v2.0.0 // indirect
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
 	github.com/valyala/fasttemplate v1.2.2 // indirect
@@ -43,4 +43,5 @@ require (
 	golang.org/x/time v0.5.0 // indirect
 	golang.org/x/tools v0.22.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

handler/health.go

@@ -28,7 +28,7 @@ type successResponse struct {
 // @Description  Check if the API is up and running and that the database is available.
 // @Success      200  {object} successResponse "Created"
 // @Failure      500 {object} model.HTTPError "Internal server error"
-// @Router       /health [post]
+// @Router       /health [get]
 func (f Health) Health(c echo.Context) error {
 	err := f.dao.Ping()
 	if err != nil {

handler/health_test.go

@@ -0,0 +1,45 @@
+package handler
+
+import (
+	"github.com/go-feature-flag/app-api/dao"
+	"github.com/labstack/echo/v4"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+)
+
+func TestHealthHandler_Health(t *testing.T) {
+	e := echo.New()
+
+	t.Run("API is up and running", func(t *testing.T) {
+		mockDao, err := dao.NewInMemoryMockDao()
+		require.NoError(t, err)
+		mockDao.OnPingReturnError(false)
+
+		h := NewHealth(mockDao)
+		req := httptest.NewRequest(http.MethodGet, "/health", nil)
+		rec := httptest.NewRecorder()
+		c := e.NewContext(req, rec)
+
+		require.NoError(t, h.Health(c))
+		assert.Equal(t, http.StatusOK, rec.Code)
+		assert.JSONEq(t, `{"message":"API is up and running","code":200}`, rec.Body.String())
+	})
+
+	t.Run("Database not available", func(t *testing.T) {
+		mockDao, err := dao.NewInMemoryMockDao()
+		require.NoError(t, err)
+		mockDao.OnPingReturnError(true)
+
+		h := NewHealth(mockDao)
+		req := httptest.NewRequest(http.MethodGet, "/health", nil)
+		rec := httptest.NewRecorder()
+		c := e.NewContext(req, rec)
+
+		require.NoError(t, h.Health(c))
+		assert.Equal(t, http.StatusInternalServerError, rec.Code)
+		assert.JSONEq(t, `{"errorDetails":"error on ping","code":500}`, rec.Body.String())
+	})
+}