feat: display warning on using gc with roleArn instead of throwing an error

Author: dgandhi62

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

@@ -475,7 +475,7 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
         // roleArn is defined for when cloudformation is invoked
         // This conflicts with direct sdk calls existing in the gc command to s3 and ecr
         if (args.roleArn) {
-          throw new ToolkitError('The --role-arn option is not supported for the gc command');
+          await ioHost.defaults.warn('The --role-arn option is not supported for the gc command and will be ignored.');
         }
         if (args.bootstrapStackName) {
           await ioHost.defaults.warn('--bootstrap-stack-name is deprecated and will be removed when gc is GA. Use --toolkit-stack-name.');

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

@@ -436,34 +436,45 @@ describe('notices configuration tests', () => {
   });
 });
 
-describe('gc command validation tests', () => {
+describe('gc command warning tests', () => {
   beforeEach(() => {
     jest.clearAllMocks();
   });
 
-  /**
-   * Tests that the gc does not support roleArn
-   */
-  test('should throw error when --role-arn is provided with gc command', async () => {
-    // Mock configuration to include 'gc' in unstable features
+  test('should warn when --role-arn is used with gc command', async () => {
+    const mockWarn = jest.fn();
     const mockConfig = {
+      settings: { get: (key: string[]) => key[0] === 'unstable' ? ['gc'] : [] },
+      context: { get: () => [] },
       loadConfigFiles: jest.fn().mockResolvedValue(undefined),
-      settings: {
-        get: jest.fn().mockImplementation((key: string[]) => {
-          if (key[0] === 'unstable') return ['gc'];
-          return undefined;
-        }),
-      },
-      context: {
-        get: jest.fn().mockReturnValue([]),
-      },
     };
-
+    
     (Configuration as any).mockImplementation(() => mockConfig);
     Configuration.fromArgsAndFiles = jest.fn().mockImplementation(() => mockConfig);
-    // Expects an error to be thrown when roleArn is used with gc
-    await expect(exec(['gc', '--role-arn', 'arn:aws:iam::123456789012:role/TestRole', '--unstable=gc']))
-      .rejects
-      .toThrow('The --role-arn option is not supported for the gc command');
+    jest.spyOn(cdkToolkitModule.CdkToolkit.prototype, 'garbageCollect').mockResolvedValue();
+    jest.spyOn(CliIoHost, 'instance').mockReturnValue({ 
+      defaults: { 
+        warn: mockWarn,
+        debug: jest.fn(),
+        info: jest.fn(),
+        error: jest.fn(),
+        trace: jest.fn()
+      },
+      noticesDestination: 'stderr',
+      notify: jest.fn(),
+      asIoHelper: () => ({
+        defaults: {
+          warn: mockWarn,
+          debug: jest.fn(),
+          info: jest.fn(),
+          error: jest.fn(),
+          trace: jest.fn()
+        }
+      }),
+      startTelemetry: jest.fn().mockResolvedValue(undefined)
+    } as any);
+    
+    await exec(['gc', '--role-arn', 'test-role', '--unstable=gc']);
+    expect(mockWarn).toHaveBeenCalledWith('The --role-arn option is not supported for the gc command and will be ignored.');
   });
 });