feat(cli): add non-interactive mode support to CLI

Author: ren-yamanashi

packages/aws-cdk/lib/cli/cli-config.ts

@@ -44,6 +44,7 @@ export async function makeConfig(): Promise<CliConfig> {
       'ci': { type: 'boolean', desc: 'Force CI detection. If CI=true then logs will be sent to stdout instead of stderr', default: YARGS_HELPERS.isCI() },
       'unstable': { type: 'array', desc: 'Opt in to unstable features. The flag indicates that the scope and API of a feature might still change. Otherwise the feature is generally production ready and fully supported. Can be specified multiple times.', default: [] },
       'telemetry-file': { type: 'string', desc: 'Send telemetry data to a local file.', default: undefined },
+      'yes': { type: 'boolean', alias: 'y', desc: 'Skip interactive prompts. If yes=true then the operation will proceed without confirmation.', default: false },
     },
     commands: {
       'list': {

packages/aws-cdk/lib/cli/cli-type-registry.json

@@ -127,6 +127,12 @@
     "telemetry-file": {
       "type": "string",
       "desc": "Send telemetry data to a local file."
+    },
+    "yes": {
+      "type": "boolean",
+      "alias": "y",
+      "desc": "Skip interactive prompts. If yes=true then the operation will proceed without confirmation.",
+      "default": false
     }
   },
   "commands": {

packages/aws-cdk/lib/cli/cli.ts

@@ -70,6 +70,7 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
     isCI: Boolean(argv.ci),
     currentAction: cmd,
     stackProgress: argv.progress,
+    nonInteractive: argv.yes,
   }, true);
   const ioHelper = asIoHelper(ioHost, ioHost.currentAction as any);
 

packages/aws-cdk/lib/cli/convert-to-user-input.ts

@@ -35,6 +35,7 @@ export function convertYargsToUserInput(args: any): UserInput {
     ci: args.ci,
     unstable: args.unstable,
     telemetryFile: args.telemetryFile,
+    yes: args.yes,
   };
   let commandOptions;
   switch (args._[0] as Command) {
@@ -344,6 +345,7 @@ export function convertConfigToUserInput(config: any): UserInput {
     ci: config.ci,
     unstable: config.unstable,
     telemetryFile: config.telemetryFile,
+    yes: config.yes,
   };
   const listOptions = {
     long: config.list?.long,

packages/aws-cdk/lib/cli/io-host/cli-io-host.ts

@@ -81,6 +81,14 @@ export interface CliIoHostProps {
    * @default StackActivityProgress.BAR
    */
   readonly stackProgress?: StackActivityProgress;
+
+  /**
+   * Whether the CLI is running in non-interactive mode.
+   * When true, operation will proceed without confirmation.
+   *
+   * @default false
+   */
+  readonly nonInteractive?: boolean;
 }
 
 /**
@@ -160,6 +168,8 @@ export class CliIoHost implements IIoHost {
   private corkedCounter = 0;
   private readonly corkedLoggingBuffer: IoMessage<unknown>[] = [];
 
+  private readonly nonInteractive: boolean;
+
   public telemetry?: TelemetrySession;
 
   private constructor(props: CliIoHostProps = {}) {
@@ -170,6 +180,7 @@ export class CliIoHost implements IIoHost {
     this.requireDeployApproval = props.requireDeployApproval ?? RequireApproval.BROADENING;
 
     this.stackProgress = props.stackProgress ?? StackActivityProgress.BAR;
+    this.nonInteractive = props.nonInteractive ?? false;
   }
 
   public async startTelemetry(args: any, context: Context, _proxyAgent?: Agent) {
@@ -423,6 +434,11 @@ export class CliIoHost implements IIoHost {
         throw new ToolkitError(`${motivation}, but concurrency is greater than 1 so we are unable to get a confirmation from the user`);
       }
 
+      // In non-interactive mode, always return success (true).
+      if (this.nonInteractive) {
+        return true;
+      }
+
       // Special approval prompt
       // Determine if the message needs approval. If it does, continue (it is a basic confirmation prompt)
       // If it does not, return success (true). We only check messages with codes that we are aware

packages/aws-cdk/lib/cli/parse-command-line-arguments.ts

@@ -161,6 +161,12 @@ export function parseCommandLineArguments(args: Array<string>): any {
       type: 'string',
       desc: 'Send telemetry data to a local file.',
     })
+    .option('yes', {
+      default: false,
+      type: 'boolean',
+      alias: 'y',
+      desc: 'Skip interactive prompts. If yes=true then the operation will proceed without confirmation.',
+    })
     .command(['list [STACKS..]', 'ls [STACKS..]'], 'Lists all stacks in the app', (yargs: Argv) =>
       yargs
         .option('long', {

packages/aws-cdk/lib/cli/user-input.ts

@@ -327,6 +327,13 @@ export interface GlobalOptions {
    * @default - undefined
    */
   readonly telemetryFile?: string;
+
+  /**
+   * Skip interactive prompts. If yes=true then the operation will proceed without confirmation.
+   *
+   * @default - false
+   */
+  readonly yes?: boolean;
 }
 
 /**

packages/aws-cdk/test/cli/cli-arguments.test.ts

@@ -35,6 +35,7 @@ describe('yargs', () => {
         unstable: [],
         notices: undefined,
         output: undefined,
+        yes: false,
       },
       deploy: {
         STACKS: undefined,

packages/aws-cdk/test/cli/cli.test.ts

@@ -79,6 +79,10 @@ jest.mock('../../lib/cli/parse-command-line-arguments', () => ({
       result = { ...result, verbose: parseInt(args[verboseIndex + 1], 10) };
     }
 
+    if (args.includes('--yes')) {
+      result = { ...result, yes: true };
+    }
+
     return Promise.resolve(result);
   }),
 }));
@@ -481,3 +485,23 @@ describe('gc command tests', () => {
     expect(gcSpy).toHaveBeenCalled();
   });
 });
+
+test('when --yes option is provided, CliIoHost is in non-interactive mode', async () => {
+  // GIVEN
+  const migrateSpy = jest.spyOn(cdkToolkitModule.CdkToolkit.prototype, 'deploy').mockResolvedValue();
+  const execSpy = jest.spyOn(CliIoHost, 'instance');
+
+  // WHEN
+  await exec(['deploy', '--yes']);
+
+  // THEN
+  expect(execSpy).toHaveBeenCalledWith(
+    expect.objectContaining({
+      nonInteractive: true,
+    }),
+    true,
+  );
+
+  migrateSpy.mockRestore();
+  execSpy.mockRestore();
+});

packages/aws-cdk/test/cli/io-host/cli-io-host.test.ts

@@ -494,6 +494,47 @@ describe('CliIoHost', () => {
       });
     });
 
+    describe('non-interactive mode', () => {
+      const nonInteractiveIoHost = CliIoHost.instance({
+        logLevel: 'trace',
+        nonInteractive: true,
+        isCI: false,
+        isTTY: true,
+      }, true);
+
+      test('it does not prompt the user and return true', async () => {
+        // WHEN
+        const response = await nonInteractiveIoHost.requestResponse(plainMessage({
+          time: new Date(),
+          level: 'info',
+          action: 'synth',
+          code: 'CDK_TOOLKIT_I0001',
+          message: 'test message',
+          defaultResponse: true,
+        }));
+
+        // THEN
+        expect(mockStdout).not.toHaveBeenCalledWith(chalk.cyan('test message') + ' (y/n) ');
+        expect(response).toBe(true);
+      });
+
+      test('approvalToolkitCodes also skip', async () => {
+        // WHEN
+        const response = await nonInteractiveIoHost.requestResponse(plainMessage({
+          time: new Date(),
+          level: 'info',
+          action: 'synth',
+          code: 'CDK_TOOLKIT_I5060',
+          message: 'test message',
+          defaultResponse: true,
+        }));
+
+        // THEN
+        expect(mockStdout).not.toHaveBeenCalledWith(chalk.cyan('test message') + ' (y/n) ');
+        expect(response).toBe(true);
+      });
+    });
+
     describe('non-promptable data', () => {
       test('logs messages and returns default unchanged', async () => {
         const response = await ioHost.requestResponse(plainMessage({