Merge pull request #12 from OpenPathfinder/feat/bulk-import

Author: UlisesGascon

src/__tests__/cli-commands.test.ts

@@ -1,9 +1,9 @@
 /* eslint-env jest */
 
-import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists, printChecks, printWorkflows, executeWorkflow } from '../cli-commands.js'
+import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists, printChecks, printWorkflows, executeWorkflow, printBulkImportOperations } from '../cli-commands.js'
 import { getPackageJson } from '../utils.js'
-import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails, APIErrorResponse, APIChecklistItem, APICheckItem, APIWorkflowItem, APIWorkflowRunItem } from '../types.js'
-import { mockApiHealthResponse, mockAPIProjectResponse, mockAPIGithubOrgResponse, mockAPIChecklistResponse, mockAPICheckResponse, mockAPIWorkflowResponse, mockAPIWorkflowRunResponse } from './fixtures.js'
+import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails, APIErrorResponse, APIChecklistItem, APICheckItem, APIWorkflowItem, APIWorkflowRunItem, APIBulkImportOperationItem } from '../types.js'
+import { mockApiHealthResponse, mockAPIProjectResponse, mockAPIGithubOrgResponse, mockAPIChecklistResponse, mockAPICheckResponse, mockAPIWorkflowResponse, mockAPIWorkflowRunResponse, mockAPIBulkImportOperationResponse } from './fixtures.js'
 import nock from 'nock'
 
 const pkg = getPackageJson()
@@ -586,4 +586,61 @@ describe('CLI Commands', () => {
       expect(result.messages).toHaveLength(1)
     })
   })
+
+  describe('printBulkImportOperations', () => {
+    let mockBulkImportOperations: APIBulkImportOperationItem[]
+
+    beforeEach(() => {
+      nock.cleanAll()
+      mockBulkImportOperations = [...mockAPIBulkImportOperationResponse]
+    })
+
+    it('should retrieve and format bulk import operations successfully', async () => {
+      // Mock API call
+      nock('http://localhost:3000')
+        .get('/api/v1/bulk-import')
+        .reply(200, mockBulkImportOperations)
+
+      // Execute the function
+      const result = await printBulkImportOperations()
+
+      // Verify the result
+      expect(result.success).toBe(true)
+      expect(result.messages[0]).toBe('Bulk import operations available:')
+      expect(result.messages[1]).toContain(mockBulkImportOperations[0].id)
+      expect(result.messages[1]).toContain(mockBulkImportOperations[0].description)
+      expect(result.messages).toHaveLength(2) // Header + 1 bulk import operation
+      expect(nock.isDone()).toBe(true) // Verify all mocked endpoints were called
+    })
+
+    it('should handle empty bulk import operations response', async () => {
+      // Mock empty response
+      nock('http://localhost:3000')
+        .get('/api/v1/bulk-import')
+        .reply(200, [])
+
+      // Execute the function
+      const result = await printBulkImportOperations()
+
+      // Verify the result
+      expect(result.success).toBe(true)
+      expect(result.messages).toHaveLength(1) // Only the header message
+      expect(result.messages[0]).toBe('No bulk import operations found')
+    })
+
+    it('should handle network errors gracefully', async () => {
+      // Mock network error
+      nock('http://localhost:3000')
+        .get('/api/v1/bulk-import')
+        .replyWithError('Network error')
+
+      // Execute the function
+      const result = await printBulkImportOperations()
+
+      // Verify the result
+      expect(result.success).toBe(false)
+      expect(result.messages[0]).toContain('❌ Failed to retrieve bulk import operation items: Network error')
+      expect(result.messages).toHaveLength(1)
+    })
+  })
 })

src/__tests__/fixtures.ts

@@ -1,4 +1,4 @@
-import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails, APIChecklistItem, APICheckItem, APIWorkflowItem, APIWorkflowRunItem } from '../types.js'
+import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails, APIChecklistItem, APICheckItem, APIWorkflowItem, APIWorkflowRunItem, APIBulkImportOperationItem } from '../types.js'
 
 export const mockApiHealthResponse: APIHealthResponse = {
   status: 'ok',
@@ -138,3 +138,9 @@ export const mockAPIWorkflowRunResponse: APIWorkflowRunItem = {
   completed: '2025-06-21T10:05:02.500Z',
   result: { success: true, message: 'Workflow completed successfully' }
 }
+
+export const mockAPIBulkImportOperationResponse: APIBulkImportOperationItem[] = [{
+  id: 'import-data',
+  description: 'Test bulk import operation description',
+  schema: 'test-bulk-import-operation'
+}]

src/api-client.ts

@@ -1,6 +1,6 @@
 import { getConfig } from './utils.js'
 import { got } from 'got'
-import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails, APIChecklistItem, APICheckItem, APIWorkflowItem, APIWorkflowRunItem } from './types.js'
+import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails, APIChecklistItem, APICheckItem, APIWorkflowItem, APIWorkflowRunItem, APIBulkImportOperationItem } from './types.js'
 
 export const apiClient = () => {
   const config = getConfig()
@@ -92,3 +92,12 @@ export const runWorkflow = async (workflowId: string, data: any): Promise<APIWor
   }
   return response.body as APIWorkflowRunItem
 }
+
+export const getAllBulkImportOperations = async (): Promise<APIBulkImportOperationItem[]> => {
+  const client = apiClient()
+  const response = await client.get('bulk-import', { 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 APIBulkImportOperationItem[]
+}

src/cli-commands.ts

@@ -1,6 +1,6 @@
 import { CommandResult } from './types.js'
 import { isApiAvailable, isApiCompatible, getPackageJson } from './utils.js'
-import { getAPIDetails, createProject, addGithubOrgToProject, getAllChecklistItems, getAllChecks, getAllWorkflows, runWorkflow } from './api-client.js'
+import { getAPIDetails, createProject, addGithubOrgToProject, getAllChecklistItems, getAllChecks, getAllWorkflows, getAllBulkImportOperations, runWorkflow } from './api-client.js'
 
 const pkg = getPackageJson()
 
@@ -165,3 +165,30 @@ export const executeWorkflow = async (workflowId: string, data: any): Promise<Co
     success
   }
 }
+
+export const printBulkImportOperations = async (): Promise<CommandResult> => {
+  const messages: string[] = []
+  let success = true
+  try {
+    const operations = await getAllBulkImportOperations()
+    if (operations.length === 0) {
+      messages.push('No bulk import operations found')
+      return {
+        messages,
+        success
+      }
+    }
+    messages.push('Bulk import operations available:')
+    operations.forEach((operation) => {
+      messages.push(`- ${operation.id}: ${operation.description}`)
+    })
+  } catch (error) {
+    messages.push(`❌ Failed to retrieve bulk import operation items: ${error instanceof Error ? error.message : 'Unknown error'}`)
+    success = false
+  }
+
+  return {
+    messages,
+    success
+  }
+}

src/index.ts

@@ -6,7 +6,7 @@ import { stringToArray } from '@ulisesgascon/string-to-array'
 import { handleCommandResult, validateData } from './utils.js'
 import { getAllWorkflows } from './api-client.js'
 import fs from 'fs'
-import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists, printChecks, printWorkflows, executeWorkflow } from './cli-commands.js'
+import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists, printChecks, printWorkflows, executeWorkflow, printBulkImportOperations } from './cli-commands.js'
 
 const program = new Command()
 
@@ -25,6 +25,18 @@ program
     handleCommandResult(result)
   })
 
+const bulkImport = program
+  .command('bulk-import')
+  .description('Bulk import management')
+
+bulkImport
+  .command('list')
+  .description('Print all available bulk import operations')
+  .action(async () => {
+    const result = await printBulkImportOperations()
+    handleCommandResult(result)
+  })
+
 const workflow = program
   .command('workflow')
   .description('Compliance workflow management')

src/types.ts

@@ -141,6 +141,15 @@ export type APICheckItem = {
   updated_at: string;
 };
 
+/**
+ * Bulk Import Operation Schema
+ */
+export interface APIBulkImportOperationItem {
+  id: string;
+  description: string;
+  schema: string;
+}
+
 /**
  * Workflow Operation Schema
  * @TODO: Move or reuse with bulk-import endpoint is created.