Merge pull request #824 from JupiterOne/823-cli-api-key

Fix #823 - Do not modify `JUPITERONE_API_KEY` env var in CLI defaults

Author: austinkelleher

CHANGELOG.md

@@ -9,6 +9,11 @@ and this project adheres to
 
 ## Unreleased
 
+### Fixed
+
+- Do not modify the value supplied to `JUPITERONE_API_KEY` when using the
+  integration CLI
+
 ## 8.29.2 - 2022-11-15
 
 ### Fixed

packages/integration-sdk-cli/src/__tests__/cli-run.test.ts

@@ -275,3 +275,25 @@ test('does not publish events for source "api" since there is no integrationJobI
   expect(log.displayExecutionResults).toHaveBeenCalledTimes(1);
   expect(log.displaySynchronizationResults).toHaveBeenCalledTimes(1);
 });
+
+test('should use JUPITERONE_API_KEY value in Authorization request header', async () => {
+  expect.assertions(1);
+  const job = generateSynchronizationJob();
+
+  setupSynchronizerApi({
+    polly,
+    job,
+    baseUrl: 'https://api.us.jupiterone.io',
+    onSyncJobCreateResponse(req, res) {
+      expect(req.headers['Authorization']).toEqual('Bearer testing-key');
+    },
+  });
+
+  await createCli().parseAsync([
+    'node',
+    'j1-integration',
+    'run',
+    '--integrationInstanceId',
+    'test',
+  ]);
+});

packages/integration-sdk-cli/src/__tests__/util/synchronization.ts

@@ -1,4 +1,4 @@
-import { Polly } from '@pollyjs/core';
+import { Polly, Request, Response } from '@pollyjs/core';
 import {
   SynchronizationJob,
   SynchronizationJobStatus,
@@ -8,14 +8,22 @@ interface SetupOptions {
   baseUrl: string;
   polly: Polly;
   job: SynchronizationJob;
+  onSyncJobCreateResponse?: (req: Request<{}>, res: Response) => void;
 }
 
-export function setupSynchronizerApi({ polly, job, baseUrl }: SetupOptions) {
+export function setupSynchronizerApi({
+  polly,
+  job,
+  baseUrl,
+  onSyncJobCreateResponse,
+}: SetupOptions) {
   polly.server
     .post(`${baseUrl}/persister/synchronization/jobs`)
     .intercept((req, res) => {
       allowCrossOrigin(req, res);
       res.status(200).json({ job });
+
+      if (onSyncJobCreateResponse) onSyncJobCreateResponse(req, res);
     });
 
   polly.server

packages/integration-sdk-cli/src/commands/options.ts

@@ -5,7 +5,7 @@ import {
   JUPITERONE_DEV_API_BASE_URL,
   JUPITERONE_PROD_API_BASE_URL,
 } from '@jupiterone/integration-sdk-runtime';
-import { Command, OptionValues } from 'commander';
+import { Command, Option, OptionValues } from 'commander';
 import path from 'path';
 
 export interface PathOptions {
@@ -138,25 +138,32 @@ export interface ApiClientOptions {
 
 export function addApiClientOptionsToCommand(command: Command): Command {
   return command
-    .option(
-      '--api-base-url <url>',
-      'specify synchronization API base URL',
-      JUPITERONE_PROD_API_BASE_URL,
+    .addOption(
+      new Option(
+        '--api-base-url <url>',
+        'specify synchronization API base URL',
+      ).default(JUPITERONE_PROD_API_BASE_URL),
     )
-    .option(
-      '-d, --development',
-      '"true" to target apps.dev.jupiterone.io (JUPITERONE_DEV environment variable)',
-      !!process.env.JUPITERONE_DEV,
+    .addOption(
+      new Option(
+        '-d, --development',
+        '"true" to target apps.dev.jupiterone.io',
+      ).default(
+        !!process.env.JUPITERONE_DEV,
+        'JUPITERONE_DEV environment variable value',
+      ),
     )
-    .option(
-      '--account <account>',
-      'JupiterOne account ID (JUPITERONE_ACCOUNT environment variable)',
-      process.env.JUPITERONE_ACCOUNT,
+    .addOption(
+      new Option('--account <account>', 'JupiterOne account ID').default(
+        process.env.JUPITERONE_ACCOUNT,
+        'JUPITERONE_ACCOUNT environment variable value',
+      ),
     )
-    .option(
-      '--api-key <key>',
-      'JupiterOne API key (JUPITERONE_API_KEY environment variable)',
-      process.env.JUPITERONE_API_KEY?.replace(/./, '*'),
+    .addOption(
+      new Option('--api-key <key>', 'JupiterOne API key').default(
+        process.env.JUPITERONE_API_KEY,
+        'JUPITERONE_API_KEY environment variable value',
+      ),
     );
 }