Feat: Add endpoint and unit test to ping for the status of Fern Repor…

…ter (#63)

* Feat: Add endpoint and unit test to ping for the status of Fern Reporter

* chore: Updated coverage badge.

---------

Co-authored-by: Kai Lee <[email protected]>
Co-authored-by: GitHub Action <[email protected]>

README.md

@@ -1,5 +1,5 @@
 [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/Guidewire/fern-reporter/badge)](https://securityscorecards.dev/viewer/?uri=github.com/Guidewire/fern-reporter)
-![Coverage](https://img.shields.io/badge/Coverage-73.2%25-brightgreen)
+![Coverage](https://img.shields.io/badge/Coverage-73.9%25-brightgreen)
 
 ![Fern](https://github.com/guidewire/fern-reporter/raw/main/docs/images/logo-no-background.png)
 

pkg/api/handlers/handlers.go

@@ -161,3 +161,9 @@ func (h *Handler) ReportTestRunById(c *gin.Context) {
 		"testRuns": []models.TestRun{testRun},
 	})
 }
+
+func (h *Handler) Ping(c *gin.Context) {
+	c.JSON(200, gin.H{
+		"message": "Fern Reporter is running!",
+	})
+}

pkg/api/handlers/handlers_test.go

@@ -973,6 +973,24 @@ var _ = Describe("Handlers", func() {
 			Expect(w.Code).To((Equal(http.StatusNotFound)))
 
 		})
+	})
+
+	Context("When Ping handler is invoked", func() {
+		It("it should return an HTTP status code of 200, indicating that the 'Fern Reporter' service is operational", func() {
+			gin.SetMode(gin.TestMode)
+
+			w := httptest.NewRecorder()
+			c, r := gin.CreateTestContext(w)
+
+			handler := handlers.NewHandler(gormDb)
+			r.GET("/ping", handler.Ping)
+			c.Request, _ = http.NewRequest(http.MethodGet, "/ping", nil)
+			r.ServeHTTP(w, c.Request)
+
+			Expect(w.Code).To(Equal(http.StatusOK))
+			expectedBody := `{"message":"Fern Reporter is running!"}`
+			Expect(w.Body.String()).To(Equal(expectedBody))
+		})
 
 	})
 

pkg/api/routers/routers.go

@@ -25,4 +25,8 @@ func RegisterRouters(router *gin.Engine) {
 		testRunReport := reports.GET("/", handler.ReportTestRunAll)
 		testRunReport.GET("/:id", handler.ReportTestRunById)
 	}
+	ping := router.Group("/ping")
+	{
+		ping.GET("/", handler.Ping)
+	}
 }