feat: add GET /api/v1/compliance-checklist endpoint

Author: UlisesGascon

__tests__/httpServer/apiV1.test.js

@@ -38,6 +38,7 @@ let addProject
 let getAllGithubOrganizationsByProjectsId
 let getAllChecks
 let getCheckById
+let getAllChecklists
 
 beforeAll(async () => {
   // Initialize server asynchronously
@@ -51,7 +52,8 @@ beforeAll(async () => {
     addProject,
     getAllGithubOrganizationsByProjectsId,
     getAllChecks,
-    getCheckById
+    getCheckById,
+    getAllChecklists
   } = initializeStore(knex))
 })
 
@@ -433,4 +435,17 @@ describe('HTTP Server API V1', () => {
 
     test.todo('should return 500 for internal server error')
   })
+
+  describe('GET /api/v1/compliance-checklist', () => {
+    test('should return 200 and a list of checklists', async () => {
+      const response = await app.get('/api/v1/compliance-checklist')
+      const storedChecklists = await getAllChecklists()
+
+      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(storedChecklists)))
+    })
+
+    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, getAllChecks, getCheckById } = initializeStore(knex)
+  const { addProject, getProjectByName, addGithubOrganization, getProjectById, getAllGithubOrganizationsByProjectsId, getAllChecks, getCheckById, getAllChecklists } = initializeStore(knex)
 
   const router = express.Router()
 
@@ -146,6 +146,16 @@ function createApiRouter (knex, express) {
     }
   })
 
+  router.get('/compliance-checklist', async (req, res) => {
+    try {
+      const checklists = await getAllChecklists()
+      res.json(checklists)
+    } catch (error) {
+      logger.error(error)
+      res.status(500).json({ errors: [{ message: 'Failed to retrieve Compliance Checklists' }] })
+    }
+  })
+
   router.get('/workflow', (req, res) => {
     try {
       const { workflowsList } = getWorkflowsDetails()