feat: add command workflow execute

Author: UlisesGascon

src/__tests__/cli-commands.test.ts

@@ -1,9 +1,9 @@
 /* eslint-env jest */
 
-import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists, printChecks, printWorkflows } from '../cli-commands.js'
+import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists, printChecks, printWorkflows, executeWorkflow } from '../cli-commands.js'
 import { getPackageJson } from '../utils.js'
-import { APIHealthResponse, APIProjectDetails, APIGithubOrgDetails, APIErrorResponse, APIChecklistItem, APICheckItem, APIWorkflowItem } from '../types.js'
-import { mockApiHealthResponse, mockAPIProjectResponse, mockAPIGithubOrgResponse, mockAPIChecklistResponse, mockAPICheckResponse, mockAPIWorkflowResponse } from './fixtures.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 nock from 'nock'
 
 const pkg = getPackageJson()
@@ -504,4 +504,86 @@ describe('CLI Commands', () => {
       expect(result.messages[0]).toBe('No compliance workflows found')
     })
   })
+
+  describe('executeWorkflow', () => {
+    let workflowRunResponse: APIWorkflowRunItem
+
+    beforeEach(() => {
+      nock.cleanAll()
+
+      // Setup mock workflow run response
+      workflowRunResponse = { ...mockAPIWorkflowRunResponse }
+    })
+
+    it('should execute a workflow successfully', async () => {
+      // Mock API call
+      nock('http://localhost:3000')
+        .post('/api/v1/workflow/update-stuff/run', { data: { projectId: 123 } })
+        .reply(202, workflowRunResponse)
+
+      // Execute the function
+      const result = await executeWorkflow('update-stuff', { projectId: 123 })
+
+      // Verify the result
+      expect(result.success).toBe(true)
+      expect(result.messages).toHaveLength(5) // 5 messages with details
+      expect(result.messages[0]).toContain('Workflow executed successfully in 2500 ms')
+      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 execute a workflow that was unsuccessful', async () => {
+      // Mock API call
+      nock('http://localhost:3000')
+        .post('/api/v1/workflow/update-stuff/run', { data: { projectId: 123 } })
+        .reply(202, { ...workflowRunResponse, status: 'failed', result: { message: 'Failed to execute workflow', success: false } })
+
+      // Execute the function
+      const result = await executeWorkflow('update-stuff', { projectId: 123 })
+
+      // Verify the result
+      expect(result.success).toBe(true)
+      expect(result.messages).toHaveLength(5) // 5 messages with details
+      expect(result.messages[0]).toContain('Workflow executed unsuccessfully in 2500 ms')
+      expect(result.messages[1]).toContain('Status: failed')
+      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/workflow/invalid-workflow/run')
+        .reply(404, { errors: [{ message: 'Workflow not found' }] } as APIErrorResponse)
+
+      // Execute the function
+      const result = await executeWorkflow('invalid-workflow', {})
+
+      // Verify the result
+      expect(result.success).toBe(false)
+      expect(result.messages[0]).toContain('❌ Failed to execute the workflow')
+      expect(result.messages).toHaveLength(1)
+    })
+
+    it('should handle network errors gracefully', async () => {
+      // Mock network error
+      nock('http://localhost:3000')
+        .post('/api/v1/workflow/update-stuff/run')
+        .replyWithError('Network error')
+
+      // Execute the function
+      const result = await executeWorkflow('update-stuff', {})
+
+      // Verify the result
+      expect(result.success).toBe(false)
+      expect(result.messages[0]).toContain('❌ Failed to execute the workflow')
+      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 } from './api-client.js'
+import { getAPIDetails, createProject, addGithubOrgToProject, getAllChecklistItems, getAllChecks, getAllWorkflows, runWorkflow } from './api-client.js'
 
 const pkg = getPackageJson()
 
@@ -139,3 +139,28 @@ export const printWorkflows = async (): Promise<CommandResult> => {
     success
   }
 }
+
+export const executeWorkflow = async (workflowId: string, data: any): Promise<CommandResult> => {
+  const messages: string[] = []
+  let success = true
+  try {
+    const results = await runWorkflow(workflowId, data)
+    const startTime = new Date(results.started)
+    const endTime = new Date(results.finished)
+    const duration = endTime.getTime() - startTime.getTime()
+
+    messages.push(`Workflow executed ${results.result.success ? 'successfully' : 'unsuccessfully'} in ${duration} ms`)
+    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 workflow: ${error instanceof Error ? error.message : 'Unknown error'}`)
+    success = false
+  }
+
+  return {
+    messages,
+    success
+  }
+}

src/index.ts

@@ -3,8 +3,10 @@
 import { Command } from 'commander'
 // @ts-ignore
 import { stringToArray } from '@ulisesgascon/string-to-array'
-import { handleCommandResult } from './utils.js'
-import { getVersion, runDoctor, addProjectWithGithubOrgs, printChecklists, printChecks, printWorkflows } from './cli-commands.js'
+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'
 
 const program = new Command()
 
@@ -35,6 +37,50 @@ workflow
     handleCommandResult(result)
   })
 
+workflow
+  .command('execute')
+  .description('Execute a compliance workflow')
+  .requiredOption('-w, --workflow <workflowName>', 'Workflow name')
+  .option('-d, --data <data>', 'Data to pass to the workflow')
+  .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 workflows = await getAllWorkflows()
+    const workflow = workflows.find((workflow) => workflow.id === options.workflow)
+    let data: any | undefined
+    if (!workflow) {
+      throw new Error(`Invalid workflow name (${options.workflow}). Available workflows: ${workflows.map(w => w.id).join(', ')}`)
+    }
+    if (!workflow.isEnabled) {
+      throw new Error('Workflow is not enabled')
+    }
+    // Check if workflow requires additional data and if it is provided or requires collection
+    if (workflow.isRequiredAdditionalData && (!options.data && !options.file)) {
+      throw new Error('Workflow does not require additional data. Please remove -d or -f options')
+    } else if (options.data && options.file) {
+      throw new Error('Please provide either -d or -f, not both')
+    } else if (options.data) {
+      data = options.data
+    } else if (options.file) {
+      data = JSON.parse(fs.readFileSync(options.file, 'utf-8'))
+    }
+
+    // If data is provided, validate against JSON Schema
+    if (data) {
+      const schema = workflow.schema
+      if (!schema) {
+        throw new Error('Workflow does not have a JSON schema')
+      }
+      const result = await validateData(data, schema)
+      if (!result.success) {
+        throw new Error(`Data validation failed: ${result.messages[0]}`)
+      }
+    }
+
+    const result = await executeWorkflow(options.workflow, data)
+    handleCommandResult(result)
+  })
+
 const checklist = program
   .command('compliance-checklist')
   .description('Compliance checklist management')