Merge pull request #6 from OpenPathfinder/feat/checklist

Author: UlisesGascon

src/__tests__/cli-commands.test.ts

@@ -1,9 +1,9 @@
 /* eslint-env jest */
 
-import { getVersion, runDoctor, addProjectWithGithubOrgs } from '../cli-commands.js'
+import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists } from '../cli-commands.js'
 import { getPackageJson } from '../utils.js'
-import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails, APIErrorResponse } from '../types.js'
-import { mockApiHealthResponse, mockAPIProjectResponse, mockAPIGithubOrgResponse } from './fixtures.js'
+import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails, APIErrorResponse, APIChecklistItem } from '../types.js'
+import { mockApiHealthResponse, mockAPIProjectResponse, mockAPIGithubOrgResponse, mockAPIChecklistResponse } from './fixtures.js'
 import nock from 'nock'
 
 const pkg = getPackageJson()
@@ -175,4 +175,107 @@ describe('CLI Commands', () => {
       expect(result.messages).toHaveLength(1)
     })
   })
+
+  describe('printChecklists', () => {
+    let mockChecklists: APIChecklistItem[]
+
+    beforeEach(() => {
+      nock.cleanAll()
+      mockChecklists = [...mockAPIChecklistResponse]
+    })
+
+    it('should retrieve and format checklist items successfully', async () => {
+      // Mock API call
+      nock('http://localhost:3000')
+        .get('/api/v1/compliance-checklist')
+        .reply(200, mockChecklists)
+
+      // Execute the function
+      const result = await printChecklists()
+
+      // Verify the result
+      expect(result.success).toBe(true)
+      expect(result.messages[0]).toBe('Compliance checklists:')
+      expect(result.messages[1]).toContain(mockChecklists[0].title)
+      expect(result.messages[1]).toContain(mockChecklists[0].code_name)
+      expect(result.messages[1]).toContain(mockChecklists[0].description)
+      expect(result.messages[1]).toContain(mockChecklists[0].url)
+      expect(result.messages).toHaveLength(2) // Header + 1 checklist item
+      expect(nock.isDone()).toBe(true) // Verify all mocked endpoints were called
+    })
+
+    it('should handle multiple checklist items', async () => {
+      // Add a second checklist item
+      const secondChecklist = {
+        ...mockChecklists[0],
+        id: 456,
+        title: 'Second Checklist',
+        code_name: 'second-checklist',
+        description: 'Another checklist description',
+        url: 'https://api.visionboard.example.com/checklist/456'
+      }
+      mockChecklists.push(secondChecklist)
+
+      // Mock API call
+      nock('http://localhost:3000')
+        .get('/api/v1/compliance-checklist')
+        .reply(200, mockChecklists)
+
+      // Execute the function
+      const result = await printChecklists()
+
+      // Verify the result
+      expect(result.success).toBe(true)
+      expect(result.messages[0]).toBe('Compliance checklists:')
+      expect(result.messages[1]).toContain(mockChecklists[0].title)
+      expect(result.messages[2]).toContain(mockChecklists[1].title)
+      expect(result.messages).toHaveLength(3) // Header + 2 checklist items
+    })
+
+    it('should handle API errors gracefully', async () => {
+      // Mock API error
+      nock('http://localhost:3000')
+        .get('/api/v1/compliance-checklist')
+        .reply(500, { errors: [{ message: 'Internal server error' }] } as APIErrorResponse)
+
+      // Execute the function
+      const result = await printChecklists()
+
+      // Verify the result
+      expect(result.success).toBe(false)
+      expect(result.messages[0]).toContain('❌ Failed to retrieve compliance checklist items')
+      expect(result.messages).toHaveLength(1)
+    })
+
+    it('should handle network errors gracefully', async () => {
+      // Mock network error
+      nock('http://localhost:3000')
+        .get('/api/v1/compliance-checklist')
+        .replyWithError('Network error')
+
+      // Execute the function
+      const result = await printChecklists()
+
+      // Verify the result
+      expect(result.success).toBe(false)
+      expect(result.messages[0]).toContain('❌ Failed to retrieve compliance checklist items')
+      expect(result.messages[0]).toContain('Network error')
+      expect(result.messages).toHaveLength(1)
+    })
+
+    it('should handle empty checklist response', async () => {
+      // Mock empty response
+      nock('http://localhost:3000')
+        .get('/api/v1/compliance-checklist')
+        .reply(200, [])
+
+      // Execute the function
+      const result = await printChecklists()
+
+      // Verify the result
+      expect(result.success).toBe(true)
+      expect(result.messages).toHaveLength(1) // Only the header message
+      expect(result.messages[0]).toBe('No compliance checklists found')
+    })
+  })
 })

src/__tests__/fixtures.ts

@@ -1,4 +1,4 @@
-import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails } from '../types.js'
+import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails, APIChecklistItem } from '../types.js'
 
 export const mockApiHealthResponse: APIHealthResponse = {
   status: 'ok',
@@ -93,3 +93,14 @@ export const mockAPIGithubOrgResponse: APIGithubOrgDetails = {
   updated_at: new Date().toISOString(),
   project_id: 123
 }
+
+export const mockAPIChecklistResponse: APIChecklistItem[] = [{
+  id: 123,
+  author: 'Ulises Gascón',
+  title: 'Test Checklist',
+  description: 'Test checklist description',
+  code_name: 'test-checklist',
+  url: 'https://api.visionboard.example.com/checklist/123',
+  created_at: new Date().toISOString(),
+  updated_at: new Date().toISOString()
+}]

src/api-client.ts

@@ -1,6 +1,6 @@
 import { getConfig } from './utils.js'
 import { got } from 'got'
-import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails } from './types.js'
+import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails, APIChecklistItem } from './types.js'
 
 export const apiClient = () => {
   const config = getConfig()
@@ -52,3 +52,12 @@ export const addGithubOrgToProject = async (projectId: number, githubOrgUrl: str
   }
   return response.body as APIGithubOrgDetails
 }
+
+export const getAllChecklistItems = async (): Promise<APIChecklistItem[]> => {
+  const client = apiClient()
+  const response = await client.get('compliance-checklist', { responseType: 'json' })
+  if (response.statusCode !== 200) {
+    throw new Error(`Failed to get the data from the API: ${response.statusCode} ${response.body}`)
+  }
+  return response.body as APIChecklistItem[]
+}

src/cli-commands.ts

@@ -1,6 +1,6 @@
 import { CommandResult } from './types.js'
 import { isApiAvailable, isApiCompatible, getPackageJson } from './utils.js'
-import { getAPIDetails, createProject, addGithubOrgToProject } from './api-client.js'
+import { getAPIDetails, createProject, addGithubOrgToProject, getAllChecklistItems } from './api-client.js'
 
 const pkg = getPackageJson()
 
@@ -42,7 +42,6 @@ export const addProjectWithGithubOrgs = async (name: string, githubOrgUrls: stri
   let success = true
   try {
     const project = await createProject(name)
-    // Add GitHub organizations sequentially to avoid race conditions
     for (const githubOrgUrl of githubOrgUrls) {
       await addGithubOrgToProject(project.id, githubOrgUrl)
     }
@@ -57,3 +56,30 @@ export const addProjectWithGithubOrgs = async (name: string, githubOrgUrls: stri
     success
   }
 }
+
+export const printChecklists = async (): Promise<CommandResult> => {
+  const messages: string[] = []
+  let success = true
+  try {
+    const checklists = await getAllChecklistItems()
+    if (checklists.length === 0) {
+      messages.push('No compliance checklists found')
+      return {
+        messages,
+        success
+      }
+    }
+    messages.push('Compliance checklists:')
+    checklists.forEach((checklist) => {
+      messages.push(`- ${checklist.title} (${checklist.code_name}): ${checklist.description}. Docs: ${checklist.url}`)
+    })
+  } catch (error) {
+    messages.push(`❌ Failed to retrieve compliance checklist items: ${error instanceof Error ? error.message : 'Unknown error'}`)
+    success = false
+  }
+
+  return {
+    messages,
+    success
+  }
+}

src/index.ts

@@ -4,7 +4,7 @@ import { Command } from 'commander'
 // @ts-ignore
 import { stringToArray } from '@ulisesgascon/string-to-array'
 import { handleCommandResult } from './utils.js'
-import { getVersion, runDoctor, addProjectWithGithubOrgs } from './cli-commands.js'
+import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists } from './cli-commands.js'
 
 const program = new Command()
 
@@ -23,6 +23,18 @@ program
     handleCommandResult(result)
   })
 
+const checklist = program
+  .command('compliance-checklist')
+  .description('Compliance checklist management')
+
+checklist
+  .command('list')
+  .description('Print all available compliance checklists')
+  .action(async () => {
+    const result = await printChecklists()
+    handleCommandResult(result)
+  })
+
 const project = program
   .command('project')
   .description('Project management')

src/types.ts

@@ -105,6 +105,20 @@ export interface APIProjectDetails {
   has_annualDependencyRefresh_policy: boolean | null
 }
 
+/**
+ * Checklist schema
+ */
+export interface APIChecklistItem {
+  id: number
+  author: string
+  title: string
+  description: string
+  code_name: string
+  url: string
+  created_at: string
+  updated_at: string
+}
+
 /**
  * Error object as defined in the OpenAPI schema
  */