@aikidosec/ci-api-client 1.0.17 → 1.0.18

package/README.md

@@ -49,6 +49,7 @@ Options:
                                     "HIGH", "CRITICAL")
   --poll-interval [interval]        The poll interval when checking for an updated scan result (preset: 10)
   --sla-mode                        Let Aikido only fail only on open issues that have gone out of SLA.
+  --json                            Output the scan result as JSON (gate_passed and issue_breakdown)
   -h, --help                        display help for command
 ```
 
@@ -91,7 +92,7 @@ Options:
 
 The CLI will spawn a cloud-based scan and then report scan progress. It will exit with exitCode `0` if the scan was successfull (`gate_passed: true`). The process will exit with exitCode `10` if the scan was unsuccesfull (`gate_passed: false`). If anything else goes wrong (e.g. API unavailable, scanning unavailable, other unexpected issue) the process will exit with exitCode `1`.
 
-If you want the scan to run quietly (without output), you can add the `--quiet` option to the command.
+If you want the scan to run quietly (without output), you can add the `--quiet` option to the command. If you want machine-readable output instead, add `--json` to `scan-release`. That prints a JSON object with `gate_passed` and `issue_breakdown` and skips spinners and other extra info.
 
 Please note that the repository_id which you need to provide to the CLI is the unique ID of the Git provider you are using, not the ID of the repository in Aikido. You can also find this ID in Aikido, by going to the repository's detail page and clicking on the Git provider's icon in the header. Alternatively, you can pass the repository name as it is defined in Aikido.
 

package/lib/aikidoApi.d.ts

@@ -30,8 +30,24 @@ export type TPollIsScanningResult = {
     secrets_scan_completed: boolean;
     sbom_scan_completed?: boolean;
 };
+export type TIssueSeverityBreakdown = {
+    critical: number;
+    high: number;
+    medium: number;
+    low: number;
+};
+export type TIssueBreakdown = {
+    sast: TIssueSeverityBreakdown;
+    sca: TIssueSeverityBreakdown;
+    iac: TIssueSeverityBreakdown;
+    secrets: TIssueSeverityBreakdown;
+    malware: TIssueSeverityBreakdown;
+    license: TIssueSeverityBreakdown;
+    code_quality: TIssueSeverityBreakdown;
+};
 type TPollScanCompletedOptions = {
     gate_passed: boolean;
+    issue_breakdown?: TIssueBreakdown;
 };
 type TPollScanFeatureBranchCompletedOptions = {
     new_issues_found: number;

package/lib/commands/scan.js

@@ -118,7 +118,7 @@ export const scan = async ({ repoId, baseCommitId, headCommitId, branchName, opt
     pollStatus();
 };
 const parseCliOptions = (userCliOptions) => {
-    const apiOptions = { version: '1.0.16' };
+    const apiOptions = { version: '1.0.18' };
     const cliOptions = { pollInterval: 5 };
     if (userCliOptions.pullRequestTitle) {
         apiOptions.pull_request_metadata = {

package/lib/commands/scanRelease.d.ts

@@ -25,6 +25,7 @@ type TScanUserCliOptions = {
     pollInterval?: number;
     baseBranch?: string;
     slaMode?: boolean;
+    json?: boolean;
 };
 declare function cli(repoId: string, commitId: string, options: TScanUserCliOptions, command: string): Promise<void>;
 export declare const scan: ({ repoId, commitId, options, pollInterval, onStart, onStartComplete, onStartFail, onScanStart, onNextPoll, onScanComplete, onScanFail, }: TScanArguments) => Promise<void>;

package/lib/commands/scanRelease.js

@@ -2,7 +2,7 @@ import chalk from 'chalk';
 import { Argument, InvalidArgumentError, Option } from 'commander';
 import { pollScanStatus, startScan, } from '../aikidoApi.js';
 import { getApiKey } from '../configuration.js';
-import { outputError, outputHttpError, outputLog, startSpinner, } from '../output.js';
+import { outputError, outputHttpError, outputJson, outputLog, startSpinner, } from '../output.js';
 async function cli(repoId, commitId, options, command) {
     const apiKey = getApiKey();
     if (!apiKey) {
@@ -11,6 +11,10 @@ async function cli(repoId, commitId, options, command) {
     const { apiOptions, cliOptions } = parseCliOptions(options);
     let loader;
     let pollCount = 1;
+    const jsonOutput = cliOptions.json;
+    if (jsonOutput) {
+        process.env.QUIET = true;
+    }
     const onStart = () => {
         loader = startSpinner('Starting Aikido Security release scan');
     };
@@ -27,6 +31,16 @@ async function cli(repoId, commitId, options, command) {
         loader = startSpinner('Waiting for scan to complete');
     };
     const onScanComplete = (pollResult) => {
+        if (jsonOutput) {
+            outputJson({
+                gate_passed: pollResult.gate_passed === true,
+                issue_breakdown: pollResult.issue_breakdown,
+            });
+            if (pollResult.gate_passed !== true) {
+                process.exitCode = 10;
+            }
+            return;
+        }
         if (pollResult.gate_passed === true) {
             loader?.succeed('Scan completed, no open issues found');
             if (pollResult.diff_url) {
@@ -123,8 +137,8 @@ export const scan = async ({ repoId, commitId, options, pollInterval = 10, onSta
     pollStatus();
 };
 const parseCliOptions = (userCliOptions) => {
-    const apiOptions = { version: '1.0.16' };
-    const cliOptions = { pollInterval: 10 };
+    const apiOptions = { version: '1.0.18' };
+    const cliOptions = { pollInterval: 10, json: false };
     if (userCliOptions.pullRequestTitle) {
         apiOptions.pull_request_metadata = {
             ...(apiOptions.pull_request_metadata ?? {}),
@@ -168,6 +182,9 @@ const parseCliOptions = (userCliOptions) => {
     else if (userCliOptions.pollInterval) {
         cliOptions.pollInterval = userCliOptions.pollInterval;
     }
+    if (userCliOptions.json) {
+        cliOptions.json = true;
+    }
     return { apiOptions, cliOptions };
 };
 const validateCommitId = (value) => {
@@ -193,6 +210,7 @@ export const cliSetup = (program) => program
     .argParser(parseFloat))
     .addOption(new Option('--base-branch <branchname>', 'Base branch for the release gated scan.'))
     .option('--sla-mode', 'Let Aikido only fail only on open issues that have gone out of SLA.')
+    .option('--json', 'Output the scan result as JSON (gate_passed and issue_breakdown)')
     .description('Run a release scan of an Aikido repo.')
     .action(cli);
 export default { cli, cliSetup, scan };

package/lib/index.js

@@ -11,7 +11,7 @@ export const program = new Command();
 program
     .name('Aikido API Client')
     .description('CLI api client to easily integrate the Aikido public CI API into custom deploy scripts')
-    .version('1.0.16');
+    .version('1.0.18');
 apiKey.cliSetup(program);
 scan.cliSetup(program);
 scanRelease.cliSetup(program);

package/lib/output.d.ts

@@ -1,6 +1,7 @@
 import { Ora } from 'ora';
 import { AxiosError } from 'axios';
 export declare const outputLog: (message: string) => void;
+export declare const outputJson: (data: unknown) => void;
 export declare const outputDebug: (variable: any) => void;
 export declare const outputError: (message: string, exitCode?: number) => void;
 export declare const outputHttpError: (axiosError: AxiosError) => void;

package/lib/output.js

@@ -6,6 +6,9 @@ export const outputLog = (message) => {
         console.log(message);
     }
 };
+export const outputJson = (data) => {
+    console.log(JSON.stringify(data, null, 2));
+};
 export const outputDebug = (variable) => {
     if (process.env.CLI_DEBUG == true || process.env.CLI_DEBUG == 'true') {
         console.log(chalk.blue(typeof variable == 'object' ? JSON.stringify(variable) : variable));

package/npm-shrinkwrap.json

@@ -1,15 +1,15 @@
 {
   "name": "@aikidosec/ci-api-client",
-  "version": "1.0.17",
+  "version": "1.0.18",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@aikidosec/ci-api-client",
-      "version": "1.0.17",
+      "version": "1.0.18",
       "license": "MIT",
       "dependencies": {
-        "axios": "1.16.1",
+        "axios": "1.18.0",
         "chalk": "5.3.0",
         "commander": "11.0.0",
         "configstore": "6.0.0",
@@ -116,8 +116,7 @@
     "node_modules/@types/node": {
       "version": "20.3.3",
       "dev": true,
-      "license": "MIT",
-      "peer": true
+      "license": "MIT"
     },
     "node_modules/abbrev": {
       "version": "1.1.1",
@@ -206,9 +205,9 @@
       "license": "MIT"
     },
     "node_modules/axios": {
-      "version": "1.16.1",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-1.16.1.tgz",
-      "integrity": "sha512-caYkukvroVPO8KrzuJEb50Hm07KwfBZPEC3VeFHTsqWHvKTsy54hjJz9BS/cdaypROE2rH6xvm9mHX4fgWkr3A==",
+      "version": "1.18.0",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-1.18.0.tgz",
+      "integrity": "sha512-E32NzpYKp++W7XRe52rHiXV2ehxmh3wbdgO7MHeFM+vqxLBYHzt0ElkiImtOBxtOmyp0yoC8C6uESVV84Y2/hw==",
       "license": "MIT",
       "dependencies": {
         "follow-redirects": "^1.16.0",
@@ -1271,7 +1270,6 @@
       "version": "5.1.6",
       "dev": true,
       "license": "Apache-2.0",
-      "peer": true,
       "bin": {
         "tsc": "bin/tsc",
         "tsserver": "bin/tsserver"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aikidosec/ci-api-client",
-  "version": "1.0.17",
+  "version": "1.0.18",
   "description": "CLI api client to easily integrate the Aikido public CI API into custom deploy scripts",
   "license": "MIT",
   "author": "Bert Devriese <bert@builtinbruges.com>",
@@ -25,7 +25,7 @@
     }
   },
   "dependencies": {
-    "axios": "1.16.1",
+    "axios": "1.18.0",
     "chalk": "5.3.0",
     "commander": "11.0.0",
     "configstore": "6.0.0",

package/src/aikidoApi.ts

@@ -82,8 +82,26 @@ export type TPollIsScanningResult = {
   sbom_scan_completed?: boolean;
 };
 
+export type TIssueSeverityBreakdown = {
+  critical: number;
+  high: number;
+  medium: number;
+  low: number;
+};
+
+export type TIssueBreakdown = {
+  sast: TIssueSeverityBreakdown;
+  sca: TIssueSeverityBreakdown;
+  iac: TIssueSeverityBreakdown;
+  secrets: TIssueSeverityBreakdown;
+  malware: TIssueSeverityBreakdown;
+  license: TIssueSeverityBreakdown;
+  code_quality: TIssueSeverityBreakdown;
+};
+
 type TPollScanCompletedOptions = {
   gate_passed: boolean;
+  issue_breakdown?: TIssueBreakdown;
 };
 
 type TPollScanFeatureBranchCompletedOptions = {

package/src/commands/scan.ts

@@ -245,7 +245,7 @@ export const scan = async ({
 const parseCliOptions = (userCliOptions: TScanUserCliOptions) => {
   // Version provided to the API corresponds with the version in package.json
   // of the cli client
-  const apiOptions: TScanApiOptions = { version: '1.0.16' };
+  const apiOptions: TScanApiOptions = { version: '1.0.18' };
   const cliOptions: TScanCliOptions = { pollInterval: 5 };
 
   if (userCliOptions.pullRequestTitle) {

package/src/commands/scanRelease.ts

@@ -14,6 +14,7 @@ import { getApiKey } from '../configuration.js';
 import {
   outputError,
   outputHttpError,
+  outputJson,
   outputLog,
   startSpinner,
 } from '../output.js';
@@ -49,6 +50,7 @@ type TScanArguments = {
 
 type TScanCliOptions = {
   pollInterval: number;
+  json: boolean;
 };
 
 type TScanUserCliOptions = {
@@ -63,6 +65,7 @@ type TScanUserCliOptions = {
   pollInterval?: number;
   baseBranch?: string;
   slaMode?: boolean;
+  json?: boolean;
 };
 
 async function cli(
@@ -83,6 +86,13 @@ async function cli(
   let loader: Ora | null;
   let pollCount: number = 1;
 
+  // when the json option is added, only output the json result.
+  // Disabling console output takes care of the spinners and other extra info
+  const jsonOutput = cliOptions.json;
+  if (jsonOutput) {
+    process.env.QUIET = true;
+  }
+
   // Setup different scan() event handlers
   const onStart = () => {
     loader = startSpinner('Starting Aikido Security release scan');
@@ -107,6 +117,20 @@ async function cli(
   };
 
   const onScanComplete = (pollResult: any) => {
+    if (jsonOutput) {
+      outputJson({
+        gate_passed: pollResult.gate_passed === true,
+        issue_breakdown: pollResult.issue_breakdown,
+      });
+
+      if (pollResult.gate_passed !== true) {
+        // Don't process.exit() here: with piped stdout (CI) the JSON write
+        // may still be queued and a forced exit can truncate it.
+        process.exitCode = 10;
+      }
+      return;
+    }
+
     if (pollResult.gate_passed === true) {
       loader?.succeed('Scan completed, no open issues found');
       if (pollResult.diff_url) {
@@ -245,8 +269,8 @@ export const scan = async ({
 const parseCliOptions = (userCliOptions: TScanUserCliOptions) => {
   // Version provided to the API corresponds with the version in package.json
   // of the cli client
-  const apiOptions: TScanApiOptions = { version: '1.0.16' };
-  const cliOptions: TScanCliOptions = { pollInterval: 10 };
+  const apiOptions: TScanApiOptions = { version: '1.0.18' };
+  const cliOptions: TScanCliOptions = { pollInterval: 10, json: false };
 
   if (userCliOptions.pullRequestTitle) {
     apiOptions.pull_request_metadata = {
@@ -292,6 +316,9 @@ const parseCliOptions = (userCliOptions: TScanUserCliOptions) => {
   } else if (userCliOptions.pollInterval) {
     cliOptions.pollInterval = userCliOptions.pollInterval;
   }
+  if (userCliOptions.json) {
+    cliOptions.json = true;
+  }
 
   return { apiOptions, cliOptions };
 };
@@ -363,6 +390,10 @@ export const cliSetup = (program: Command) =>
       '--sla-mode',
       'Let Aikido only fail only on open issues that have gone out of SLA.'
     )
+    .option(
+      '--json',
+      'Output the scan result as JSON (gate_passed and issue_breakdown)'
+    )
     .description('Run a release scan of an Aikido repo.')
     .action(cli);
 

package/src/index.ts

@@ -20,7 +20,7 @@ program
   .description(
     'CLI api client to easily integrate the Aikido public CI API into custom deploy scripts'
   )
-  .version('1.0.16');
+  .version('1.0.18');
 
 // Load in all app commands and set them up in the `program` instance
 apiKey.cliSetup(program);

package/src/output.ts

@@ -10,6 +10,13 @@ export const outputLog = (message: string): void => {
   }
 };
 
+// Output a machine readable result
+// This ignores the global "quiet" option: it is the output that was asked
+// for, not human readable progress information
+export const outputJson = (data: unknown): void => {
+  console.log(JSON.stringify(data, null, 2));
+};
+
 // Output some message, var, .. if --debug was provided
 export const outputDebug = (variable: any): void => {
   if (process.env.CLI_DEBUG == true || process.env.CLI_DEBUG == 'true') {