feat: health check api

Author: hunjixin

api/api_impl/server.go

@@ -9,6 +9,8 @@ import (
 	"net/url"
 	"strings"
 
+	"github.com/hellofresh/health-go/v5"
+
 	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/getkin/kin-openapi/routers/gorillamux"
 
@@ -74,6 +76,11 @@ func SetupAPI(lc fx.Lifecycle, apiConfig *config.APIConfig, secretStore crypt.Se
 
 	api.HandlerFromMuxWithBaseURL(controller, apiRouter, APIV1Prefix)
 	r.Handle("/api/docs/*", http.StripPrefix("/api/docs", swaggerui.Handler(raw)))
+	h, _ := health.New(health.WithComponent(health.Component{
+		Name:    "myservice",
+		Version: "v1.0",
+	}))
+	r.Get("/status", h.HandlerFunc)
 
 	url, err := url.Parse(apiConfig.Listen)
 	if err != nil {

go.mod

@@ -117,7 +117,7 @@ require (
 	github.com/go-logr/logr v1.4.1 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-openapi/jsonpointer v0.19.6 // indirect
-	github.com/go-sql-driver/mysql v1.7.0 // indirect
+	github.com/go-sql-driver/mysql v1.7.1 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
@@ -134,6 +134,7 @@ require (
 	github.com/hashicorp/golang-lru v1.0.2 // indirect
 	github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/hellofresh/health-go/v5 v5.5.2 // indirect
 	github.com/imdario/mergo v0.3.15 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/invopop/yaml v0.2.0 // indirect

go.sum

@@ -241,6 +241,8 @@ github.com/go-openapi/swag v0.22.4 h1:QLMzNJnMGPRNDCbySlcj1x01tzU8/9LTTL9hZZZogB
 github.com/go-openapi/swag v0.22.4/go.mod h1:UzaqsxGiab7freDnrUUra0MwWfN/q7tE4j+VcZ0yl14=
 github.com/go-sql-driver/mysql v1.7.0 h1:ueSltNNllEqE3qcWBTD0iQd3IpL/6U+mJxLkazJ7YPc=
 github.com/go-sql-driver/mysql v1.7.0/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
+github.com/go-sql-driver/mysql v1.7.1 h1:lUIinVbN1DY0xBg0eMOzmmtGoHwWBbvnWubQUrtU8EI=
+github.com/go-sql-driver/mysql v1.7.1/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
 github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 h1:tfuBGBXKqDEevZMzYi5KSi8KkcZtzBcTgAUUtapy0OI=
 github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572/go.mod h1:9Pwr4B2jHnOSGXyyzV8ROjYa2ojvAY6HCGYYfMoC3Ls=
 github.com/go-test/deep v1.0.8/go.mod h1:5C2ZWiW0ErCdrYzpqxLbTX7MG14M9iiw8DgHncVwcsE=
@@ -369,6 +371,8 @@ github.com/hashicorp/golang-lru/v2 v2.0.7 h1:a+bsQ5rvGLjzHuww6tVxozPZFVghXaHOwFs
 github.com/hashicorp/golang-lru/v2 v2.0.7/go.mod h1:QeFd9opnmA6QUJc5vARoKUSoFhyfM2/ZepoAG6RGpeM=
 github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=
 github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
+github.com/hellofresh/health-go/v5 v5.5.2 h1:h17lycd6foR2AUcd2tLYRKyU9YM7oyVtTAqUDqcM5JE=
+github.com/hellofresh/health-go/v5 v5.5.2/go.mod h1:+ENHPehFhTo9xwpJ/vQIe4iP2Uh3a4fUIcA6Rl8DqJ0=
 github.com/hnlq715/golang-lru v0.4.0 h1:gyo/wIvLE6Upf1wucAfwTjpR+BQ5Lli2766H2MnNPv0=
 github.com/hnlq715/golang-lru v0.4.0/go.mod h1:RBkgDAtlu0SgTPvpb4VW2/RQnkCBMRD3Lr6B9RhsAS8=
 github.com/hokaccha/go-prettyjson v0.0.0-20211117102719-0474bc63780f h1:7LYC+Yfkj3CTRcShK0KOL/w6iTiKyqqBA9a41Wnggw8=

integrationtest/root_test.go

@@ -12,6 +12,8 @@ func TestSpec(t *testing.T) {
 	urlStr, cancel := SetupDaemon(t, ctx)
 	defer cancel()
 
+	convey.Convey("status test", t, StatusSpec(ctx, urlStr))
+
 	convey.Convey("user test", t, UserSpec(ctx, urlStr))
 	convey.Convey("repo test", t, RepoSpec(ctx, urlStr))
 	convey.Convey("branch test", t, BranchSpec(ctx, urlStr))

integrationtest/status_test.go

@@ -0,0 +1,20 @@
+package integrationtest
+
+import (
+	"context"
+	"net/http"
+	"net/url"
+
+	"github.com/smartystreets/goconvey/convey"
+)
+
+func StatusSpec(ctx context.Context, urlStr string) func(c convey.C) {
+	return func(c convey.C) {
+		url, err := url.Parse(urlStr)
+		convey.ShouldBeNil(err)
+		url.Path = "/status"
+		resp, err := http.Get(url.String())
+		convey.ShouldBeNil(err)
+		convey.ShouldEqual(resp.StatusCode, http.StatusOK)
+	}
+}