mrgrain's changes

Author: mrgrain

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

@@ -44,7 +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 },
+      'yes': { type: 'boolean', alias: 'y', desc: 'Automatically answer interactive prompts with the recommended response. This includes confirming actions.', default: false },
     },
     commands: {
       'list': {

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

@@ -131,7 +131,7 @@
     "yes": {
       "type": "boolean",
       "alias": "y",
-      "desc": "Skip interactive prompts. If yes=true then the operation will proceed without confirmation.",
+      "desc": "Automatically answer interactive prompts with the recommended response. This includes confirming actions.",
       "default": false
     }
   },

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

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

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

@@ -83,12 +83,14 @@ export interface CliIoHostProps {
   readonly stackProgress?: StackActivityProgress;
 
   /**
-   * Whether the CLI is running in non-interactive mode.
-   * When true, operation will proceed without confirmation.
+   * Whether the CLI should attempt to automatically respond to prompts.
+   *
+   * When true, operation will usually proceed without interactive confirmation.
+   * Confirmations are responded to with yes. Other prompts will respond with the default value.
    *
    * @default false
    */
-  readonly nonInteractive?: boolean;
+  readonly autoRespond?: boolean;
 }
 
 /**
@@ -168,7 +170,7 @@ export class CliIoHost implements IIoHost {
   private corkedCounter = 0;
   private readonly corkedLoggingBuffer: IoMessage<unknown>[] = [];
 
-  private readonly nonInteractive: boolean;
+  private readonly autoRespond: boolean;
 
   public telemetry?: TelemetrySession;
 
@@ -180,7 +182,7 @@ export class CliIoHost implements IIoHost {
     this.requireDeployApproval = props.requireDeployApproval ?? RequireApproval.BROADENING;
 
     this.stackProgress = props.stackProgress ?? StackActivityProgress.BAR;
-    this.nonInteractive = props.nonInteractive ?? false;
+    this.autoRespond = props.autoRespond ?? false;
   }
 
   public async startTelemetry(args: any, context: Context, _proxyAgent?: Agent) {
@@ -424,6 +426,29 @@ export class CliIoHost implements IIoHost {
       const concurrency = data.concurrency ?? 0;
       const responseDescription = data.responseDescription;
 
+      // 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
+      // are requires approval codes.
+      if (this.skipApprovalStep(msg)) {
+        return true;
+      }
+
+      // In --yes mode, respond for the user if we can
+      if (this.autoRespond) {
+        // respond with yes to all confirmations
+        if (isConfirmationPrompt(msg)) {
+          // @TODO print message and confirmation
+          return true;
+        }
+
+        // respond with the default for all other messages
+        if (msg.defaultResponse) {
+          // @TODO print message and response
+          return msg.defaultResponse;
+        }
+      }
+
       // only talk to user if STDIN is a terminal (otherwise, fail)
       if (!this.isTTY) {
         throw new ToolkitError(`${motivation}, but terminal (TTY) is not attached so we are unable to get a confirmation from the user`);
@@ -434,19 +459,6 @@ 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
-      // are requires approval codes.
-      if (this.skipApprovalStep(msg)) {
-        return true;
-      }
-
       // Basic confirmation prompt
       // We treat all requests with a boolean response as confirmation prompts
       if (isConfirmationPrompt(msg)) {

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

@@ -165,7 +165,7 @@ export function parseCommandLineArguments(args: Array<string>): any {
       default: false,
       type: 'boolean',
       alias: 'y',
-      desc: 'Skip interactive prompts. If yes=true then the operation will proceed without confirmation.',
+      desc: 'Automatically answer interactive prompts with the recommended response. This includes confirming actions.',
     })
     .command(['list [STACKS..]', 'ls [STACKS..]'], 'Lists all stacks in the app', (yargs: Argv) =>
       yargs

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

@@ -329,7 +329,7 @@ export interface GlobalOptions {
   readonly telemetryFile?: string;
 
   /**
-   * Skip interactive prompts. If yes=true then the operation will proceed without confirmation.
+   * Automatically answer interactive prompts with the recommended response. This includes confirming actions.
    *
    * @default - false
    */

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

@@ -59,6 +59,12 @@ jest.mock('../../lib/cli/parse-command-line-arguments', () => ({
       if (args.includes('--role-arn')) {
         result = { ...result, roleArn: 'arn:aws:iam::123456789012:role/TestRole' };
       }
+    } else if (args.includes('deploy')) {
+      result = {
+        ...result,
+        _: ['deploy'],
+        parameters: [],
+      };
     }
 
     // Handle notices flags
@@ -486,22 +492,24 @@ describe('gc command tests', () => {
   });
 });
 
-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');
+describe('--yes', () => {
+  test('when --yes option is provided, CliIoHost is using autoRespond', async () => {
+    // GIVEN
+    const migrateSpy = jest.spyOn(cdkToolkitModule.CdkToolkit.prototype, 'deploy').mockResolvedValue();
+    const execSpy = jest.spyOn(CliIoHost, 'instance');
 
-  // WHEN
-  await exec(['deploy', '--yes']);
+    // WHEN
+    await exec(['deploy', '--yes']);
 
-  // THEN
-  expect(execSpy).toHaveBeenCalledWith(
-    expect.objectContaining({
-      nonInteractive: true,
-    }),
-    true,
-  );
+    // THEN
+    expect(execSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        autoRespond: true,
+      }),
+      true,
+    );
 
-  migrateSpy.mockRestore();
-  execSpy.mockRestore();
+    migrateSpy.mockRestore();
+    execSpy.mockRestore();
+  });
 });

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

@@ -494,17 +494,17 @@ describe('CliIoHost', () => {
       });
     });
 
-    describe('non-interactive mode', () => {
-      const nonInteractiveIoHost = CliIoHost.instance({
+    describe('--yes mode', () => {
+      const autoRespondingIoHost = CliIoHost.instance({
         logLevel: 'trace',
-        nonInteractive: true,
+        autoRespond: true,
         isCI: false,
         isTTY: true,
       }, true);
 
       test('it does not prompt the user and return true', async () => {
         // WHEN
-        const response = await nonInteractiveIoHost.requestResponse(plainMessage({
+        const response = await autoRespondingIoHost.requestResponse(plainMessage({
           time: new Date(),
           level: 'info',
           action: 'synth',
@@ -518,20 +518,20 @@ describe('CliIoHost', () => {
         expect(response).toBe(true);
       });
 
-      test('approvalToolkitCodes also skip', async () => {
+      test('messages with default are skipped', async () => {
         // WHEN
-        const response = await nonInteractiveIoHost.requestResponse(plainMessage({
+        const response = await autoRespondingIoHost.requestResponse(plainMessage({
           time: new Date(),
           level: 'info',
           action: 'synth',
           code: 'CDK_TOOLKIT_I5060',
           message: 'test message',
-          defaultResponse: true,
+          defaultResponse: 'foobar',
         }));
 
         // THEN
         expect(mockStdout).not.toHaveBeenCalledWith(chalk.cyan('test message') + ' (y/n) ');
-        expect(response).toBe(true);
+        expect(response).toBe('foobar');
       });
     });