Merge pull request #248 from OpenPathfinder/ulises/v1-cecklist-details

Author: UlisesGascon

__tests__/httpServer/apiV1.test.js

@@ -39,6 +39,7 @@ let getAllGithubOrganizationsByProjectsId
 let getAllChecks
 let getCheckById
 let getAllChecklists
+let getChecklistById
 
 beforeAll(async () => {
   // Initialize server asynchronously
@@ -53,7 +54,8 @@ beforeAll(async () => {
     getAllGithubOrganizationsByProjectsId,
     getAllChecks,
     getCheckById,
-    getAllChecklists
+    getAllChecklists,
+    getChecklistById
   } = initializeStore(knex))
 })
 
@@ -460,4 +462,37 @@ describe('HTTP Server API V1', () => {
 
     test.todo('should return 500 for internal server error')
   })
+
+  describe('GET /api/v1/compliance-checklist/{checklistId}', () => {
+    test('should return 200 and a specific checklist', async () => {
+      const response = await app.get('/api/v1/compliance-checklist/1')
+      const storedChecklist = await getChecklistById(1)
+
+      expect(response.status).toBe(200)
+      const expected = {
+        ...storedChecklist,
+        created_at: storedChecklist.created_at.toISOString(),
+        updated_at: storedChecklist.updated_at.toISOString()
+      }
+      expect(response.body).toStrictEqual(expected)
+    })
+
+    test('should return 400 for invalid checklist ID', async () => {
+      const response = await app.get('/api/v1/compliance-checklist/invalid')
+
+      expect(response.status).toBe(400)
+      expect(response.body).toHaveProperty('errors')
+      expect(response.body.errors[0]).toHaveProperty('message', 'must be integer')
+    })
+
+    test('should return 404 for invalid checklist ID', async () => {
+      const response = await app.get('/api/v1/compliance-checklist/9999999')
+
+      expect(response.status).toBe(404)
+      expect(response.body).toHaveProperty('errors')
+      expect(response.body.errors[0]).toHaveProperty('message', 'Compliance Checklist not found')
+    })
+
+    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, getAllChecklists } = initializeStore(knex)
+  const { addProject, getProjectByName, addGithubOrganization, getProjectById, getAllGithubOrganizationsByProjectsId, getAllChecks, getCheckById, getAllChecklists, getChecklistById } = initializeStore(knex)
 
   const router = express.Router()
 
@@ -146,6 +146,21 @@ function createApiRouter (knex, express) {
     }
   })
 
+  router.get('/compliance-checklist/:checklistId', async (req, res) => {
+    try {
+      // Params validation done in swagger
+      const checklistId = parseInt(req.params.checklistId, 10)
+      const checklist = await getChecklistById(checklistId)
+      if (!checklist) {
+        return res.status(404).json({ errors: [{ message: 'Compliance Checklist not found' }] })
+      }
+      res.json(checklist)
+    } catch (error) {
+      logger.error(error)
+      res.status(500).json({ errors: [{ message: 'Failed to retrieve Compliance Checklist' }] })
+    }
+  })
+
   router.get('/compliance-checklist', async (req, res) => {
     try {
       const checklists = await getAllChecklists()

src/httpServer/swagger/api-v1.yml

@@ -346,7 +346,47 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
-
+  /api/v1/compliance-checklist/{checklistId}:
+    get:
+      summary: Get a compliance checklist by ID
+      description: Returns a compliance checklist by ID
+      operationId: getComplianceChecklistById
+      tags:
+        - Compliance Checklists
+      parameters:
+        - name: checklistId
+          in: path
+          required: true
+          description: The ID of the checklist
+          schema:
+            type: integer
+            minimum: 1
+            example: 1
+      responses:
+        '200':
+          description: A compliance checklist
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ComplianceChecklist'
+        '400':
+          description: Bad request, invalid input data
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Compliance checklist not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
 components:
   schemas:
     ComplianceChecklist:

src/store/index.js

@@ -250,7 +250,8 @@ const initializeStore = (knex) => {
     getProjectById: (id) => getOne('projects', id),
     getProjectByName: getProjectByName(knex),
     getAllChecks: () => getAll('compliance_checks'),
-    getCheckById: (id) => getOne('compliance_checks', id)
+    getCheckById: (id) => getOne('compliance_checks', id),
+    getChecklistById: (id) => getOne('compliance_checklists', id)
   }
 }