@aikidosec/ci-api-client 1.0.0 → 1.0.2

package/src/commands/upload.ts

@@ -1,184 +1,184 @@
-import { Argument, Command, InvalidArgumentError, Option } from 'commander';
-import {
-  TScanApiOptions,
-  TUploadApiOptions,
-  TUploadPayloadType,
-  TUploadResult,
-  pollScanStatus,
-  startScan,
-  uploadCustomScanResult,
-} from '../aikidoApi.js';
-import { getApiKey } from '../configuration.js';
-import {
-  outputError,
-  outputHttpError,
-  outputLog,
-  startSpinner,
-} from '../output.js';
-import chalk from 'chalk';
-import { Ora } from 'ora';
-import { readFile } from 'fs';
-import { promisify } from 'util';
-
-type TUploadArguments = {
-  data: TUploadApiOptions;
-  onUploadComplete?: (startResult: TUploadResult) => void | null;
-  onUploadFail?: (error: any) => void | null;
-};
-
-type TUploadCliOptions = {
-  payloadFile?: string;
-  payload?: string;
-};
-
-type TUploadUserCliOptions = {
-  scanId?: string | number;
-  repositoryId: string | number;
-  containerImage?: string;
-  type: TUploadPayloadType;
-  file?: string;
-  payload?: string;
-};
-
-async function cli(options: TUploadUserCliOptions, command: string) {
-  const apiKey = getApiKey();
-
-  if (!apiKey) {
-    outputError('Please set an api key using: aikido-cli apikey <key>');
-  }
-
-  // Process command options and group them into apiOptions hash
-  const { apiOptions, cliOptions } = await parseCliOptions(options);
-
-  let loader: Ora | null = startSpinner('Uploading custom scan');
-
-  const onUploadComplete = (result: TUploadResult) => {
-    if (result.success === 1) {
-      loader?.succeed('Upload completed');
-    } else {
-      loader?.fail(
-        'Upload failed, please verify your payload data and try again'
-      );
-      process.exit(10);
-    }
-  };
-
-  const onUploadFail = (error: any) => {
-    loader?.fail();
-    outputHttpError(error);
-
-    process.exit(1);
-  };
-
-  await upload({
-    data: apiOptions,
-    onUploadComplete,
-    onUploadFail,
-  });
-}
-
-export const upload = async ({
-  data,
-  onUploadComplete,
-  onUploadFail,
-}: TUploadArguments): Promise<void> => {
-  try {
-    const result = await uploadCustomScanResult(data);
-    onUploadComplete?.(result);
-  } catch (error) {
-    onUploadFail?.(error);
-    return;
-  }
-};
-
-type TParseCliResult = {
-  apiOptions: TUploadApiOptions;
-  cliOptions: TUploadCliOptions;
-};
-
-const parseCliOptions = async (
-  userCliOptions: TUploadUserCliOptions
-): Promise<TParseCliResult> => {
-  const apiOptions: TUploadApiOptions = {
-    repository_id: userCliOptions.repositoryId,
-    container_image_name: userCliOptions.containerImage ?? undefined,
-    payload_type: userCliOptions.type,
-    payload: '',
-  };
-
-  const cliOptions: TUploadCliOptions = {
-    payloadFile: userCliOptions.file,
-    payload: userCliOptions.payload,
-  };
-
-  // Additional validation
-  if (userCliOptions.type == TUploadPayloadType.JsonSbom) {
-    if (
-      userCliOptions.containerImage === undefined ||
-      userCliOptions.containerImage.trim() === ''
-    ) {
-      outputError(
-        'Please provide a valid container image name with --container-image'
-      );
-    }
-  }
-
-  if (userCliOptions.file) {
-    // Read '--payloadFile' if available...
-    try {
-      const data: string = await promisify(readFile)(
-        userCliOptions.file,
-        'utf8'
-      );
-      apiOptions.payload = data;
-    } catch (error) {
-      outputError('Cannot read file provided with --payloadFile, aborting');
-      process.exit(1);
-    }
-  } else if (cliOptions.payload?.trim() != '') {
-    // ... no payloadFile provided, use the --payload information
-    apiOptions.payload = cliOptions.payload!;
-  } else {
-    // No payload available? Abort
-    outputError('No payload provided, aborting');
-    process.exit(1);
-  }
-
-  return { apiOptions, cliOptions };
-};
-
-// Make an option required
-const requiredOption = (option: Option): Option => {
-  option.required = true;
-  return option;
-};
-
-export const cliSetup = (program: Command) =>
-  program
-    .command('upload')
-    .option('-s, --scan-id <scanid>', 'Set the scan id')
-    .requiredOption(
-      '-r, --repository-id <repositoryid>',
-      'Set the repository id'
-    )
-    .option(
-      '-i, --container-image <container-image-name>',
-      'Set the container image name. '
-    )
-    .addOption(
-      requiredOption(
-        new Option(
-          '-t, --type <type>',
-          'Set the provided payload type. Available options are: checkov, json-sbom'
-        ).choices(['checkov', 'json-sbom'])
-      )
-    )
-    .option(
-      '-f, --file <payloadFile>',
-      'Specify the payload file. The cli command wil read the file and use the contents as payload data.'
-    )
-    .option('-p, --payload <payload>', 'Set the payload')
-    .description('Upload a custom scan result.')
-    .action(cli);
-
-export default { cli, cliSetup };
+import { Argument, Command, InvalidArgumentError, Option } from 'commander';
+import {
+  TScanApiOptions,
+  TUploadApiOptions,
+  TUploadPayloadType,
+  TUploadResult,
+  pollScanStatus,
+  startScan,
+  uploadCustomScanResult,
+} from '../aikidoApi.js';
+import { getApiKey } from '../configuration.js';
+import {
+  outputError,
+  outputHttpError,
+  outputLog,
+  startSpinner,
+} from '../output.js';
+import chalk from 'chalk';
+import { Ora } from 'ora';
+import { readFile } from 'fs';
+import { promisify } from 'util';
+
+type TUploadArguments = {
+  data: TUploadApiOptions;
+  onUploadComplete?: (startResult: TUploadResult) => void | null;
+  onUploadFail?: (error: any) => void | null;
+};
+
+type TUploadCliOptions = {
+  payloadFile?: string;
+  payload?: string;
+};
+
+type TUploadUserCliOptions = {
+  scanId?: string | number;
+  repositoryId: string | number;
+  containerImage?: string;
+  type: TUploadPayloadType;
+  file?: string;
+  payload?: string;
+};
+
+async function cli(options: TUploadUserCliOptions, command: string) {
+  const apiKey = getApiKey();
+
+  if (!apiKey) {
+    outputError('Please set an api key using: aikido-cli apikey <key>');
+  }
+
+  // Process command options and group them into apiOptions hash
+  const { apiOptions, cliOptions } = await parseCliOptions(options);
+
+  let loader: Ora | null = startSpinner('Uploading custom scan');
+
+  const onUploadComplete = (result: TUploadResult) => {
+    if (result.success === 1) {
+      loader?.succeed('Upload completed');
+    } else {
+      loader?.fail(
+        'Upload failed, please verify your payload data and try again'
+      );
+      process.exit(10);
+    }
+  };
+
+  const onUploadFail = (error: any) => {
+    loader?.fail();
+    outputHttpError(error);
+
+    process.exit(1);
+  };
+
+  await upload({
+    data: apiOptions,
+    onUploadComplete,
+    onUploadFail,
+  });
+}
+
+export const upload = async ({
+  data,
+  onUploadComplete,
+  onUploadFail,
+}: TUploadArguments): Promise<void> => {
+  try {
+    const result = await uploadCustomScanResult(data);
+    onUploadComplete?.(result);
+  } catch (error) {
+    onUploadFail?.(error);
+    return;
+  }
+};
+
+type TParseCliResult = {
+  apiOptions: TUploadApiOptions;
+  cliOptions: TUploadCliOptions;
+};
+
+const parseCliOptions = async (
+  userCliOptions: TUploadUserCliOptions
+): Promise<TParseCliResult> => {
+  const apiOptions: TUploadApiOptions = {
+    repository_id: userCliOptions.repositoryId,
+    container_image_name: userCliOptions.containerImage ?? undefined,
+    payload_type: userCliOptions.type,
+    payload: '',
+  };
+
+  const cliOptions: TUploadCliOptions = {
+    payloadFile: userCliOptions.file,
+    payload: userCliOptions.payload,
+  };
+
+  // Additional validation
+  if (userCliOptions.type == TUploadPayloadType.JsonSbom) {
+    if (
+      userCliOptions.containerImage === undefined ||
+      userCliOptions.containerImage.trim() === ''
+    ) {
+      outputError(
+        'Please provide a valid container image name with --container-image'
+      );
+    }
+  }
+
+  if (userCliOptions.file) {
+    // Read '--payloadFile' if available...
+    try {
+      const data: string = await promisify(readFile)(
+        userCliOptions.file,
+        'utf8'
+      );
+      apiOptions.payload = data;
+    } catch (error) {
+      outputError('Cannot read file provided with --payloadFile, aborting');
+      process.exit(1);
+    }
+  } else if (cliOptions.payload?.trim() != '') {
+    // ... no payloadFile provided, use the --payload information
+    apiOptions.payload = cliOptions.payload!;
+  } else {
+    // No payload available? Abort
+    outputError('No payload provided, aborting');
+    process.exit(1);
+  }
+
+  return { apiOptions, cliOptions };
+};
+
+// Make an option required
+const requiredOption = (option: Option): Option => {
+  option.required = true;
+  return option;
+};
+
+export const cliSetup = (program: Command) =>
+  program
+    .command('upload')
+    .option('-s, --scan-id <scanid>', 'Set the scan id')
+    .requiredOption(
+      '-r, --repository-id <repositoryid>',
+      'Set the repository id'
+    )
+    .option(
+      '-i, --container-image <container-image-name>',
+      'Set the container image name. '
+    )
+    .addOption(
+      requiredOption(
+        new Option(
+          '-t, --type <type>',
+          'Set the provided payload type. Available options are: checkov, json-sbom'
+        ).choices(['checkov', 'json-sbom'])
+      )
+    )
+    .option(
+      '-f, --file <payloadFile>',
+      'Specify the payload file. The cli command wil read the file and use the contents as payload data.'
+    )
+    .option('-p, --payload <payload>', 'Set the payload')
+    .description('Upload a custom scan result.')
+    .action(cli);
+
+export default { cli, cliSetup };

package/src/configuration.ts

@@ -1,21 +1,21 @@
-import Configstore from 'configstore';
-import { program } from './index.js';
-
-// Load a new ConfigSture by using the commander program name, which is
-// set in the main index.js file
-export const getConfigStore = () => {
-  return new Configstore(program.name());
-};
-
-// Get the apikey set through the cli option or the
-// one stored in the configuration
-export const getApiKey = () => {
-  return program.getOptionValue('apikey')
-    ? program.getOptionValue('apikey')
-    : getConfigStore().get('apikey');
-};
-
-// Set the global apiKey
-export const setApiKey = (newApiKey: string) => {
-  return getConfigStore().set('apikey', newApiKey);
-};
+import Configstore from 'configstore';
+import { program } from './index.js';
+
+// Load a new ConfigSture by using the commander program name, which is
+// set in the main index.js file
+export const getConfigStore = () => {
+  return new Configstore(program.name());
+};
+
+// Get the apikey set through the cli option or the
+// one stored in the configuration
+export const getApiKey = () => {
+  return program.getOptionValue('apikey')
+    ? program.getOptionValue('apikey')
+    : getConfigStore().get('apikey');
+};
+
+// Set the global apiKey
+export const setApiKey = (newApiKey: string) => {
+  return getConfigStore().set('apikey', newApiKey);
+};

package/src/index.ts

@@ -1,74 +1,64 @@
-#!/usr/bin/env node
-import chalk from 'chalk';
-import { Command } from 'commander';
-import dotenv from 'dotenv';
-import { readFileSync } from 'fs';
-import { dirname, join } from 'path';
-import { fileURLToPath } from 'url';
-import apiKey from './commands/apiKey.js';
-import scan from './commands/scan.js';
-import upload from './commands/upload.js';
-
-// Determine current file location and path to
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-const __rootdirname = dirname(__dirname);
-
-// Load all .env configuration variables and auto-inject them into process.env
-dotenv.config(
-  process.env.NODE_ENV ? { path: `.env.${process.env.NODE_ENV}` } : {}
-);
-
-// Set commander instance info from package.json
-const pkgJsonPath = join('/', __rootdirname, 'package.json');
-export const pkgJson = JSON.parse(readFileSync(pkgJsonPath, 'utf8'));
-
-// Start up commander.js Command instance
-export const program = new Command();
-
-program
-  .name(pkgJson.name)
-  .description(pkgJson.description)
-  .version(pkgJson.version);
-
-// Load in all app commands and set them up in the `program` instance
-apiKey.cliSetup(program);
-scan.cliSetup(program);
-upload.cliSetup(program);
-
-// Override global process.env type
-declare global {
-  namespace NodeJS {
-    interface ProcessEnv {
-      [key: string]: any; // used any here
-      QUIET?: boolean;
-      CLI_DEBUG?: boolean | string;
-    }
-  }
-}
-
-// Add global option "--quiet"
-program
-  .option('-q, --quiet', 'Disable console output when executing commands')
-  .on('option:quiet', function () {
-    process.env.QUIET = true;
-  });
-
-// Add global option "--debug"
-program
-  .option('--debug', 'Add additional debug information to command output')
-  .on('option:debug', function () {
-    process.env.CLI_DEBUG = true;
-  });
-
-// Add global option "--apikey"
-program.option(
-  '--apikey <apikey>',
-  'Use a cli apikey instead of reading the key from the configuration'
-);
-
-program.configureOutput({
-  outputError: (str, write) => write(chalk.red(str)),
-});
-
-program.parse();
+#!/usr/bin/env node
+import chalk from 'chalk';
+import { Command } from 'commander';
+import dotenv from 'dotenv';
+import apiKey from './commands/apiKey.js';
+import scan from './commands/scan.js';
+import upload from './commands/upload.js';
+
+// Load all .env configuration variables and auto-inject them into process.env
+dotenv.config(
+  process.env.NODE_ENV ? { path: `.env.${process.env.NODE_ENV}` } : {}
+);
+
+// Start up commander.js Command instance
+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.1');
+
+// Load in all app commands and set them up in the `program` instance
+apiKey.cliSetup(program);
+scan.cliSetup(program);
+upload.cliSetup(program);
+
+// Override global process.env type
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      [key: string]: any; // used any here
+      QUIET?: boolean;
+      CLI_DEBUG?: boolean | string;
+    }
+  }
+}
+
+// Add global option "--quiet"
+program
+  .option('-q, --quiet', 'Disable console output when executing commands')
+  .on('option:quiet', function () {
+    process.env.QUIET = true;
+  });
+
+// Add global option "--debug"
+program
+  .option('--debug', 'Add additional debug information to command output')
+  .on('option:debug', function () {
+    process.env.CLI_DEBUG = true;
+  });
+
+// Add global option "--apikey"
+program.option(
+  '--apikey <apikey>',
+  'Use a cli apikey instead of reading the key from the configuration'
+);
+
+program.configureOutput({
+  outputError: (str, write) => write(chalk.red(str)),
+});
+
+program.parse();