feat: add command bulk-import run

Author: UlisesGascon

src/__tests__/cli-commands.test.ts

@@ -1,9 +1,9 @@
 /* eslint-env jest */
 
-import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists, printChecks, printWorkflows, executeWorkflow, printBulkImportOperations } from '../cli-commands.js'
+import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists, printChecks, printWorkflows, executeWorkflow, printBulkImportOperations, executeBulkImportOperation } from '../cli-commands.js'
 import { getPackageJson } from '../utils.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 { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails, APIErrorResponse, APIChecklistItem, APICheckItem, APIWorkflowItem, APIOperationCompleted, APIBulkImportOperationItem } from '../types.js'
+import { mockApiHealthResponse, mockAPIProjectResponse, mockAPIGithubOrgResponse, mockAPIChecklistResponse, mockAPICheckResponse, mockAPIWorkflowResponse, mockAPIWorkflowRunResponse, mockAPIBulkImportOperationResponse, mockAPIBulkImportOperationRunResponse } from './fixtures.js'
 import nock from 'nock'
 
 const pkg = getPackageJson()
@@ -506,7 +506,7 @@ describe('CLI Commands', () => {
   })
 
   describe('executeWorkflow', () => {
-    let workflowRunResponse: APIWorkflowRunItem
+    let workflowRunResponse: APIOperationCompleted
 
     beforeEach(() => {
       nock.cleanAll()
@@ -643,4 +643,63 @@ describe('CLI Commands', () => {
       expect(result.messages).toHaveLength(1)
     })
   })
+  describe('executeBulkImportOperation', () => {
+    let mockBulkImportOperationResponse: APIOperationCompleted
+
+    beforeEach(() => {
+      nock.cleanAll()
+      mockBulkImportOperationResponse = mockAPIBulkImportOperationRunResponse
+    })
+
+    it('should execute a bulk import operation successfully', async () => {
+      // Mock API call
+      nock('http://localhost:3000')
+        .post('/api/v1/bulk-import')
+        .reply(200, mockBulkImportOperationResponse)
+
+      // Execute the function
+      const result = await executeBulkImportOperation('load-manual-checks', [{ type: 'annualDependencyRefresh', project_id: 1, is_subscribed: true }])
+
+      // Verify the result
+      expect(result.success).toBe(true)
+      expect(result.messages).toHaveLength(5) // 5 messages with details
+      expect(result.messages[0]).toContain('Bulk import operation executed successfully in 2.50 seconds')
+      expect(result.messages[1]).toContain('Status: completed')
+      expect(result.messages[2]).toContain('Started:')
+      expect(result.messages[3]).toContain('Finished:')
+      expect(result.messages[4]).toContain('Result:')
+      expect(nock.isDone()).toBe(true) // Verify all mocked endpoints were called
+    })
+
+    it('should handle API errors gracefully', async () => {
+      // Mock API error
+      nock('http://localhost:3000')
+        .post('/api/v1/bulk-import')
+        .reply(404, { errors: [{ message: 'Bulk import operation not found' }] } as APIErrorResponse)
+
+      // Execute the function
+      const result = await executeBulkImportOperation('load-manual-checks', [{ type: 'annualDependencyRefresh', project_id: 1, is_subscribed: true }])
+
+      // Verify the result
+      expect(result.success).toBe(false)
+      expect(result.messages[0]).toContain('❌ Failed to execute the bulk import operation')
+      expect(result.messages).toHaveLength(1)
+    })
+
+    it('should handle network errors gracefully', async () => {
+      // Mock network error
+      nock('http://localhost:3000')
+        .post('/api/v1/bulk-import')
+        .replyWithError('Network error')
+
+      // Execute the function
+      const result = await executeBulkImportOperation('load-manual-checks', [{ type: 'annualDependencyRefresh', project_id: 1, is_subscribed: true }])
+
+      // Verify the result
+      expect(result.success).toBe(false)
+      expect(result.messages[0]).toContain('❌ Failed to execute the bulk import operation')
+      expect(result.messages[0]).toContain('Network error')
+      expect(result.messages).toHaveLength(1)
+    })
+  })
 })

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, getAllBulkImportOperations, runWorkflow } from './api-client.js'
+import { getAPIDetails, createProject, addGithubOrgToProject, getAllChecklistItems, getAllChecks, getAllWorkflows, getAllBulkImportOperations, runWorkflow, runBulkImportOperation } from './api-client.js'
 
 const pkg = getPackageJson()
 
@@ -192,3 +192,29 @@ export const printBulkImportOperations = async (): Promise<CommandResult> => {
     success
   }
 }
+
+export const executeBulkImportOperation = async (id: string, data: any): Promise<CommandResult> => {
+  const messages: string[] = []
+  let success = true
+  try {
+    const results = await runBulkImportOperation(id, data)
+    const startTime = new Date(results.started)
+    const endTime = new Date(results.finished)
+    const duration = endTime.getTime() - startTime.getTime()
+    const durationStr = duration < 1000 ? `${duration} ms` : `${(duration / 1000).toFixed(2)} seconds`
+
+    messages.push(`Bulk import operation executed ${results.result.success ? 'successfully' : 'unsuccessfully'} in ${durationStr}`)
+    messages.push(`- Status: ${results.status}`)
+    messages.push(`- Started: ${startTime}`)
+    messages.push(`- Finished: ${endTime}`)
+    messages.push(`- Result: ${results.result.message}`)
+  } catch (error) {
+    messages.push(`❌ Failed to execute the bulk import operation: ${error instanceof Error ? error.message : 'Unknown error'}`)
+    success = false
+  }
+
+  return {
+    messages,
+    success
+  }
+}

src/index.ts

@@ -4,9 +4,9 @@ import { Command } from 'commander'
 // @ts-ignore
 import { stringToArray } from '@ulisesgascon/string-to-array'
 import { handleCommandResult, validateData } from './utils.js'
-import { getAllWorkflows } from './api-client.js'
+import { getAllWorkflows, getAllBulkImportOperations } from './api-client.js'
 import fs from 'fs'
-import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists, printChecks, printWorkflows, executeWorkflow, printBulkImportOperations } from './cli-commands.js'
+import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists, printChecks, printWorkflows, executeWorkflow, printBulkImportOperations, executeBulkImportOperation } from './cli-commands.js'
 
 const program = new Command()
 
@@ -37,6 +37,58 @@ bulkImport
     handleCommandResult(result)
   })
 
+bulkImport
+  .command('run')
+  .description('Run a bulk import operation')
+  .requiredOption('-i, --id <id>', 'Bulk import operation ID')
+  .option('-d, --data <data>', 'Data to pass to the bulk import operation')
+  .option('-f, --file <file>', 'File containing the data to be parsed')
+  .action(async (options) => {
+    // @TODO: Move to utils and include tests when the backend has one workflow that requires additional data
+    const operations = await getAllBulkImportOperations()
+    const operation = operations.find((operation) => operation.id === options.id)
+    let data: any | undefined
+    if (!operation) {
+      throw new Error(`Invalid bulk import operation ID (${options.id}). Available operations: ${operations.map(o => o.id).join(', ')}`)
+    }
+
+    // Check if workflow requires additional data and if it is provided or requires collection
+    if (!options.data && !options.file) {
+      throw new Error('Bulk import operation requires additional data. Please provide data using -d or -f option')
+    } else if (options.data && options.file) {
+      throw new Error('Please provide either -d or -f, not both')
+    } else if (options.data) {
+      try {
+        data = JSON.parse(options.data)
+      } catch (error) {
+        throw new Error(`Failed to parse provided JSON data: ${error instanceof Error ? error.message : 'Unknown error'}`)
+      }
+    } else if (options.file) {
+      try {
+        const fileContent = fs.readFileSync(options.file, 'utf-8')
+        data = JSON.parse(fileContent)
+      } catch (error) {
+        throw new Error(`Failed to read or parse file: ${error instanceof Error ? error.message : 'Unknown error'}`)
+      }
+    }
+
+    if (!operation.schema) {
+      throw new Error('Bulk import operation does not have a JSON schema. This is an API error')
+    }
+
+    // If data is provided, validate against JSON Schema
+    if (data && operation.schema) {
+      const schema = JSON.parse(operation.schema)
+      const result = await validateData(data, schema)
+      if (!result.success) {
+        throw new Error(`Data validation failed: ${result.messages[0]}`)
+      }
+    }
+
+    const result = await executeBulkImportOperation(options.id, data)
+    handleCommandResult(result)
+  })
+
 const workflow = program
   .command('workflow')
   .description('Compliance workflow management')