allow chi v4. Version the gethealth backend.

Author: gbevan

Gopkg.lock

@@ -24,9 +24,9 @@
 #   go-tests = true
 #   unused-packages = true
 
-[[override]]
-  name = "github.com/go-chi/chi"
-  version = "3.3.2"
+# [[override]]
+#   name = "github.com/go-chi/chi"
+#   version = "3.3.2"
 
 [prune]
   go-tests = true

Gopkg.toml

@@ -46,7 +46,7 @@ type AuthStruct struct {
 // AuthCtxKey context key for authentication state & policy map
 type AuthCtxKey string
 
-// Authenticate caller
+// Authenticate caller's token with vault
 func Authenticate(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		// Allow heath data without authenticating

authenticate/authenticate.go

@@ -50,8 +50,8 @@ func Init(db *mgo.Database) {
 	}
 }
 
-// GetHealth Returns the gostint health status
-func GetHealth() (*map[string]string, error) {
+// GetHealthV1 Returns the gostint health status for api v1
+func GetHealthV1() (*map[string]string, error) {
 	m := make(map[string]string)
 	m["state"] = state.GetState()
 

health/health.go

@@ -111,6 +111,7 @@ func getDbCreds() (string, string, error) {
 // Routes defines RESTful api middleware and routes.
 func Routes() *chi.Mux {
 	router := chi.NewRouter()
+
 	router.Use(
 		metrics.NewMetrics("gostint"),
 		render.SetContentType(render.ContentTypeJSON),
@@ -130,6 +131,7 @@ func Routes() *chi.Mux {
 		r.Mount("/api/metrics", promhttp.Handler())
 	})
 
+	// Allow optional UI user to login
 	router.Get("/login", func(w http.ResponseWriter, r *http.Request) {
 		logmsg.Info("/login URL: %v", r.URL)
 		logmsg.Info("/login RequestURI: %v", r.RequestURI)

main.go

@@ -10,6 +10,7 @@ import (
 	"github.com/prometheus/client_golang/prometheus/promauto"
 )
 
+// Prometheus api metrics collector
 // inspried by https://github.com/766b/chi-prometheus
 
 const (
@@ -35,6 +36,7 @@ func NewMetrics(name string) func(next http.Handler) http.Handler {
 			"path",
 		},
 	)
+
 	return m.handler
 }
 

metrics/metrics.go

@@ -45,6 +45,7 @@ wget -qO- https://dl.google.com/go/go${GOVER}.linux-amd64.tar.gz | \
   tar zx -C /usr/local/
 export PATH=$PATH:/usr/local/go/bin
 echo 'export PATH=$PATH:/usr/local/go/bin:~/go/bin' >> ~vagrant/.bashrc
+echo 'export GOPATH=$HOME/go' >> ~vagrant/.bashrc
 
 export MYPATH=~vagrant/go/src/github.com/gbevan/gostint
 

scripts/init_main.sh

@@ -57,13 +57,11 @@ func Routes(db *mgo.Database) *chi.Mux {
 	return router
 }
 
+// To retrieve this Gostint instance's health
 func getHealth(w http.ResponseWriter, req *http.Request) {
-	// timer := prometheus.NewTimer(healthDuration)
-	// defer timer.ObserveDuration()
-
 	req.ParseForm()
 
-	h, err := health.GetHealth()
+	h, err := health.GetHealthV1()
 	if err != nil {
 		render.Render(w, req, apierrors.ErrInternalError(err))
 		return

v1/health/health.go

@@ -117,6 +117,7 @@ type listResponse struct {
 	Total int           `json:"total"`
 }
 
+// Retrieve a list of jobs
 func listJobs(w http.ResponseWriter, req *http.Request) {
 	// timer := prometheus.NewTimer(jobDuration.WithLabelValues("listJobs"))
 	// defer timer.ObserveDuration()
@@ -177,6 +178,7 @@ func listJobs(w http.ResponseWriter, req *http.Request) {
 	render.JSON(w, req, paginateResp)
 }
 
+// Retrieve a Gostint job by Job ID
 func getJob(w http.ResponseWriter, req *http.Request) {
 	// timer := prometheus.NewTimer(jobDuration.WithLabelValues("getJob"))
 	// defer timer.ObserveDuration()
@@ -222,6 +224,7 @@ type deleteResponse struct {
 	ID string `json:"_id"`
 }
 
+// Delete a Gostint job by Job ID
 func deleteJob(w http.ResponseWriter, req *http.Request) {
 	// timer := prometheus.NewTimer(jobDuration.WithLabelValues("deleteJob"))
 	// defer timer.ObserveDuration()
@@ -337,6 +340,7 @@ type killResponse struct {
 	KillRequested bool   `json:"kill_requested"`
 }
 
+// Kill a Gostint job by Job ID
 func killJob(w http.ResponseWriter, req *http.Request) {
 	// timer := prometheus.NewTimer(jobDuration.WithLabelValues("killJob"))
 	// defer timer.ObserveDuration()

v1/job/job.go

@@ -47,6 +47,7 @@ func Routes() *chi.Mux {
 	return router
 }
 
+// Retrieve Gotstint's Vault info
 func getVault(w http.ResponseWriter, req *http.Request) {
 	m := make(map[string]string)
 	m["vault_addr"] = vaultAddr