feat: add GET /api/v1/check endpoint

Author: UlisesGascon

__tests__/httpServer/apiV1.test.js

@@ -36,6 +36,7 @@ let knex
 let getAllProjects
 let addProject
 let getAllGithubOrganizationsByProjectsId
+let getAllChecks
 
 beforeAll(async () => {
   // Initialize server asynchronously
@@ -47,7 +48,8 @@ beforeAll(async () => {
   ({
     getAllProjects,
     addProject,
-    getAllGithubOrganizationsByProjectsId
+    getAllGithubOrganizationsByProjectsId,
+    getAllChecks
   } = initializeStore(knex))
 })
 
@@ -387,4 +389,17 @@ describe('HTTP Server API V1', () => {
 
     test.todo('should return 500 for internal server error')
   })
+
+  describe('GET /api/v1/check', () => {
+    test('should return 200 and a list of checks', async () => {
+      const response = await app.get('/api/v1/check')
+      const storedChecks = await getAllChecks()
+
+      expect(response.status).toBe(200)
+      // @TODO: find a more elegant way to solve the issue with the date format
+      expect(response.body).toStrictEqual(JSON.parse(JSON.stringify(storedChecks)))
+    })
+
+    test.todo('should return 500 for internal server error')
+  })
 })

src/httpServer/routers/apiV1.js

@@ -27,7 +27,7 @@ const runWorkflow = ({ workflowName, knex, data } = {}) => new Promise((resolve,
 })
 
 function createApiRouter (knex, express) {
-  const { addProject, getProjectByName, addGithubOrganization, getProjectById, getAllGithubOrganizationsByProjectsId } = initializeStore(knex)
+  const { addProject, getProjectByName, addGithubOrganization, getProjectById, getAllGithubOrganizationsByProjectsId, getAllChecks } = initializeStore(knex)
 
   const router = express.Router()
 
@@ -121,6 +121,16 @@ function createApiRouter (knex, express) {
     }
   })
 
+  router.get('/check', async (req, res) => {
+    try {
+      const checks = await getAllChecks()
+      res.json(checks)
+    } catch (error) {
+      logger.error(error)
+      res.status(500).json({ errors: [{ message: 'Failed to retrieve checks' }] })
+    }
+  })
+
   router.get('/workflow', (req, res) => {
     try {
       const { workflowsList } = getWorkflowsDetails()