Merge pull request #254 from OpenPathfinder/feat/remove-ops

Author: UlisesGascon

__tests__/cli/__snapshots__/workflows.test.js.snap

@@ -7,31 +7,27 @@ exports[`list - Non-Interactive Mode Should provide a list of available workflow
     "isEnabled": true,
     "isRequiredAdditionalData": false,
     "name": "update-github-orgs",
-    "operations": null,
     "workflow": [Function],
   },
   {
     "description": "Check the organizations stored and update/create the information related to the repositories with the GitHub API.",
     "isEnabled": true,
     "isRequiredAdditionalData": false,
     "name": "upsert-github-repositories",
-    "operations": null,
     "workflow": [Function],
   },
   {
     "description": "Run all the compliance checks for the stored data.",
     "isEnabled": true,
     "isRequiredAdditionalData": false,
     "name": "run-all-checks",
-    "operations": null,
     "workflow": [Function],
   },
   {
     "description": "Run a specific compliance check for the stored data.",
     "isEnabled": true,
     "isRequiredAdditionalData": true,
     "name": "run-one-check",
-    "operations": null,
     "schema": {
       "$schema": "http://json-schema.org/draft-07/schema#",
       "additionalProperties": false,
@@ -53,7 +49,6 @@ exports[`list - Non-Interactive Mode Should provide a list of available workflow
     "isEnabled": false,
     "isRequiredAdditionalData": false,
     "name": "upsert-ossf-scorecard",
-    "operations": null,
     "schema": {
       "$schema": "http://json-schema.org/draft-07/schema#",
       "additionalProperties": false,
@@ -75,21 +70,6 @@ exports[`list - Non-Interactive Mode Should provide a list of available workflow
     "isEnabled": true,
     "isRequiredAdditionalData": false,
     "name": "generate-reports",
-    "operations": null,
-    "workflow": [Function],
-  },
-  {
-    "description": "Bulk import data into visionBoard",
-    "isEnabled": false,
-    "isRequiredAdditionalData": true,
-    "name": "bulk-import",
-    "operations": [
-      {
-        "description": "Load manual checks from project policies",
-        "id": "load-manual-checks",
-        "schema": "{"$schema":"http://json-schema.org/draft-07/schema#","title":"Bulk Import","description":"Schema for the bulk import of projects","type":"array","minItems":1,"items":{"type":"object","properties":{"type":{"type":"string","enum":["softwareDesignTraining","owaspTop10Training","defineFunctionalRoles","orgToolingMFA","softwareArchitectureDocs","MFAImpersonationDefense","includeCVEInReleaseNotes","assignCVEForKnownVulns","incidentResponsePlan","regressionTestsForVulns","vulnResponse14Days","useCVDToolForVulns","securityMdMeetsOpenJSCVD","consistentBuildProcessDocs","machineReadableDependencies","identifyModifiedDependencies","ciAndCdPipelineAsCode","npmOrgMFA","npmPublicationMFA","upgradePathDocs","patchNonCriticalVulns90Days","patchCriticalVulns30Days","twoOrMoreOwnersForAccess","injectedSecretsAtRuntime","preventScriptInjection","resolveLinterWarnings","annualDependencyRefresh"],"examples":["softwareDesignTraining"]},"project_id":{"description":"The project id","type":"integer","minimum":1,"examples":[123]},"is_subscribed":{"description":"Flag to indicate if the project is already subscribed to the policy","type":"boolean"},"description":{"description":"Project's description","type":"string","examples":["Course on software design principles done by the team"]},"implementation_status":{"description":"Implementation status of the project","type":"string","enum":["unknown","pending","completed"],"examples":["completed"]},"training_date":{"description":"Date of the training in ISO 8601 format","type":"string","format":"date-time","nullable":true,"examples":["2021-01-01T00:00:00Z"]}},"oneOf":[{"required":["type","project_id","is_subscribed"]},{"required":["type","project_id","description","implementation_status"]}],"additionalProperties":false}}",
-      },
-    ],
     "workflow": [Function],
   },
 ]

src/cli/workflows.js

@@ -3,37 +3,32 @@ const _ = require('lodash')
 const debug = require('debug')('cli:workflows')
 const { updateGithubOrgs, upsertGithubRepositories, runAllTheComplianceChecks, runOneComplianceCheck, upsertOSSFScorecardAnalysis } = require('../workflows')
 const { generateStaticReports } = require('../reports')
-const { bulkImport } = require('../importers')
 const { logger } = require('../utils')
-const { executeOneCheckSchema, executeOptionalProjectSchema, bulkImportSchema } = require('../schemas')
+const { executeOneCheckSchema, executeOptionalProjectSchema } = require('../schemas')
 
 const commandList = [{
   name: 'update-github-orgs',
   isRequiredAdditionalData: false,
   isEnabled: true,
   description: 'Check the organizations stored and update the information with the GitHub API.',
-  operations: null,
   workflow: updateGithubOrgs
 }, {
   name: 'upsert-github-repositories',
   isRequiredAdditionalData: false,
   isEnabled: true,
   description: 'Check the organizations stored and update/create the information related to the repositories with the GitHub API.',
-  operations: null,
   workflow: upsertGithubRepositories
 }, {
   name: 'run-all-checks',
   isRequiredAdditionalData: false,
   isEnabled: true,
   description: 'Run all the compliance checks for the stored data.',
-  operations: null,
   workflow: runAllTheComplianceChecks
 }, {
   name: 'run-one-check',
   isRequiredAdditionalData: true,
   isEnabled: true,
   description: 'Run a specific compliance check for the stored data.',
-  operations: null,
   schema: executeOneCheckSchema,
   workflow: runOneComplianceCheck
 }, {
@@ -42,27 +37,13 @@ const commandList = [{
   schema: executeOptionalProjectSchema,
   isEnabled: false,
   description: 'Upsert the OSSF Scorecard scoring by running and checking every repository in the database.',
-  operations: null,
   workflow: upsertOSSFScorecardAnalysis
 }, {
   name: 'generate-reports',
   isRequiredAdditionalData: false,
   isEnabled: true,
   description: 'Generate the reports for the stored data.',
-  operations: null,
   workflow: generateStaticReports
-}, {
-  // @TODO: Move this workflow to a separate endpoint
-  name: 'bulk-import',
-  isRequiredAdditionalData: true,
-  isEnabled: false,
-  operations: [{
-    id: 'load-manual-checks',
-    description: 'Load manual checks from project policies',
-    schema: JSON.stringify(bulkImportSchema)
-  }],
-  description: 'Bulk import data into visionBoard',
-  workflow: bulkImport
 }]
 
 const validCommandNames = commandList.map(({ name }) => name)
@@ -73,13 +54,12 @@ const getWorkflowsDetails = () => {
 
   commandList.forEach((workflow) => {
     const workflowName = _.kebabCase(workflow.name)
-    workflowsList.push({ id: workflowName, description: workflow.description, isEnabled: workflow.isEnabled, isRequiredAdditionalData: workflow.isRequiredAdditionalData, operations: workflow.operations, schema: JSON.stringify(workflow.schema) })
+    workflowsList.push({ id: workflowName, description: workflow.description, isEnabled: workflow.isEnabled, isRequiredAdditionalData: workflow.isRequiredAdditionalData, schema: JSON.stringify(workflow.schema) })
     workflows[workflowName] = {
       description: workflow.description,
       workflow: workflow.workflow,
       isEnabled: workflow.isEnabled,
       isRequiredAdditionalData: workflow.isRequiredAdditionalData,
-      operations: workflow.operations,
       schema: JSON.stringify(workflow.schema)
     }
   })

src/httpServer/swagger/api-v1.yml

@@ -507,22 +507,6 @@ components:
         schema:
           type: string
           description: JSO Schema for the data required for the workflow
-        operations:
-          type: array
-          nullable: true
-          items:
-            type: object
-            additionalProperties: false
-            properties:
-              id:
-                type: string
-                example: example-operation
-              description:
-                type: string
-                example: This is an example operation
-              schema:
-                type: string
-                description: JSON Schema for the operation
       required:
         - id
         - description