Tests for HEAD /health

Signed-off-by: eternal-flame-AD <yume@yumechi.jp>

api/health.go

@@ -1,7 +1,10 @@
 package api
 
 import (
+	"net/http"
+
 	"github.com/gin-gonic/gin"
+	"github.com/gin-gonic/gin/render"
 	"github.com/gotify/server/v2/model"
 )
 
@@ -32,15 +35,39 @@ type HealthAPI struct {
 //	    schema:
 //	        $ref: "#/definitions/Health"
 func (a *HealthAPI) Health(ctx *gin.Context) {
+	var response *model.Health
 	if err := a.DB.Ping(); err != nil {
-		ctx.JSON(500, model.Health{
+		response = &model.Health{
 			Health:   model.StatusOrange,
 			Database: model.StatusRed,
-		})
+		}
+	} else {
+		response = &model.Health{
+			Health:   model.StatusGreen,
+			Database: model.StatusGreen,
+		}
+	}
+
+	status := 500
+	if response.Database == model.StatusGreen || response.Health == model.StatusGreen {
+		status = 200
+	}
+
+	renderer := render.JSON{Data: response}
+
+	// in case this is called from a non http request
+	if ctx.Request == nil {
+		ctx.Render(status, renderer)
 		return
 	}
-	ctx.JSON(200, model.Health{
-		Health:   model.StatusGreen,
-		Database: model.StatusGreen,
-	})
+
+	switch ctx.Request.Method {
+	case "HEAD":
+		renderer.WriteContentType(ctx.Writer)
+		ctx.Status(status)
+	case "GET":
+		ctx.Render(status, renderer)
+	default:
+		ctx.AbortWithStatus(http.StatusMethodNotAllowed)
+	}
 }

api/health_test.go

@@ -1,6 +1,7 @@
 package api
 
 import (
+	"net/http"
 	"net/http/httptest"
 	"testing"
 
@@ -9,9 +10,19 @@ import (
 	"github.com/gotify/server/v2/model"
 	"github.com/gotify/server/v2/test"
 	"github.com/gotify/server/v2/test/testdb"
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/suite"
 )
 
+func testConsistentHead(t *testing.T, head http.Header, get http.Header) {
+	// The server SHOULD send the same header fields in response to a HEAD request as it would have sent if the request method had been GET.
+	// However, a server MAY omit header fields for which a value is determined only while generating the content.
+	assert.Empty(t, head.Get("Content-Length"), "Content-Length should be empty")
+	assert.Equal(t, get.Get("Content-Type"), head.Get("Content-Type"), "Content-Type should be the same")
+	assert.Equal(t, get.Get("Transfer-Encoding"), head.Get("Transfer-Encoding"), "Transfer-Encoding should be the same")
+	assert.Equal(t, get.Get("Connection"), head.Get("Connection"), "Connection should be the same")
+}
+
 func TestHealthSuite(t *testing.T) {
 	suite.Run(t, new(HealthSuite))
 }
@@ -38,12 +49,43 @@ func (s *HealthSuite) AfterTest(suiteName, testName string) {
 }
 
 func (s *HealthSuite) TestHealthSuccess() {
+	head, err := http.NewRequest("HEAD", "/health", nil)
+	if err != nil {
+		s.T().Fatal(err)
+	}
+	s.ctx.Request = head
 	s.a.Health(s.ctx)
+	headHeaders := s.recorder.Header().Clone()
+
+	request, err := http.NewRequest("GET", "/health", nil)
+	if err != nil {
+		s.T().Fatal(err)
+	}
+	s.ctx.Request = request
+	s.a.Health(s.ctx)
+
+	testConsistentHead(s.T(), headHeaders, s.recorder.Header())
 	test.BodyEquals(s.T(), model.Health{Health: model.StatusGreen, Database: model.StatusGreen}, s.recorder)
 }
 
 func (s *HealthSuite) TestDatabaseFailure() {
 	s.db.Close()
+
+	head, err := http.NewRequest("HEAD", "/health", nil)
+	if err != nil {
+		s.T().Fatal(err)
+	}
+	s.ctx.Request = head
+	s.a.Health(s.ctx)
+	headHeaders := s.recorder.Header().Clone()
+
+	request, err := http.NewRequest("GET", "/health", nil)
+	if err != nil {
+		s.T().Fatal(err)
+	}
+	s.ctx.Request = request
 	s.a.Health(s.ctx)
+
+	testConsistentHead(s.T(), headHeaders, s.recorder.Header())
 	test.BodyEquals(s.T(), model.Health{Health: model.StatusOrange, Database: model.StatusRed}, s.recorder)
 }