add possibility to specify output format in pipeline-deploy command (#1686)

Author: Kamil Sobol

.changeset/selfish-pumpkins-sparkle.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-cli': minor
+---
+
+add possibility to specify output format in pipeline-deploy command

packages/cli/src/commands/pipeline-deploy/pipeline_deploy_command.test.ts

@@ -20,6 +20,7 @@ import {
 } from '@aws-amplify/cli-core';
 import { ClientConfigGeneratorAdapter } from '../../client-config/client_config_generator_adapter.js';
 import {
+  ClientConfigFormat,
   ClientConfigVersionOption,
   DEFAULT_CLIENT_CONFIG_VERSION,
 } from '@aws-amplify/client-config';
@@ -156,6 +157,7 @@ void describe('deploy command', () => {
       },
       DEFAULT_CLIENT_CONFIG_VERSION,
       'src',
+      undefined,
     ]);
   });
 
@@ -192,6 +194,44 @@ void describe('deploy command', () => {
       },
       ClientConfigVersionOption.V0,
       undefined,
+      undefined,
+    ]);
+  });
+
+  void it('allows --outputs-format argument', async () => {
+    const backendDeployerFactory = new BackendDeployerFactory(
+      packageManagerControllerFactory.getPackageManagerController(),
+      formatterStub
+    );
+    const mockDeploy = mock.method(
+      backendDeployerFactory.getInstance(),
+      'deploy',
+      () => Promise.resolve()
+    );
+    await getCommandRunner(true).runCommand(
+      'pipeline-deploy --app-id abc --branch test-branch --outputs-format dart'
+    );
+    assert.strictEqual(mockDeploy.mock.callCount(), 1);
+    assert.deepStrictEqual(mockDeploy.mock.calls[0].arguments, [
+      {
+        name: 'test-branch',
+        namespace: 'abc',
+        type: 'branch',
+      },
+      {
+        validateAppSources: true,
+      },
+    ]);
+    assert.equal(generateClientConfigMock.mock.callCount(), 1);
+    assert.deepStrictEqual(generateClientConfigMock.mock.calls[0].arguments, [
+      {
+        name: 'test-branch',
+        namespace: 'abc',
+        type: 'branch',
+      },
+      DEFAULT_CLIENT_CONFIG_VERSION,
+      undefined,
+      ClientConfigFormat.DART,
     ]);
   });
 });

packages/cli/src/commands/pipeline-deploy/pipeline_deploy_command.ts

@@ -5,6 +5,7 @@ import { ClientConfigGeneratorAdapter } from '../../client-config/client_config_
 import { ArgumentsKebabCase } from '../../kebab_case.js';
 import { BackendIdentifier } from '@aws-amplify/plugin-types';
 import {
+  ClientConfigFormat,
   ClientConfigVersion,
   ClientConfigVersionOption,
   DEFAULT_CLIENT_CONFIG_VERSION,
@@ -16,6 +17,7 @@ export type PipelineDeployCommandOptions =
 type PipelineDeployCommandOptionsCamelCase = {
   branch: string;
   appId: string;
+  outputsFormat: ClientConfigFormat | undefined;
   outputsVersion: string;
   outputsOutDir?: string;
 };
@@ -72,7 +74,8 @@ export class PipelineDeployCommand
     await this.clientConfigGenerator.generateClientConfigToFile(
       backendId,
       args.outputsVersion as ClientConfigVersion,
-      args.outputsOutDir
+      args.outputsOutDir,
+      args.outputsFormat
     );
   };
 
@@ -104,6 +107,12 @@ export class PipelineDeployCommand
         array: false,
         choices: Object.values(ClientConfigVersionOption),
         default: DEFAULT_CLIENT_CONFIG_VERSION,
+      })
+      .option('outputs-format', {
+        describe: 'amplify_outputs file format',
+        type: 'string',
+        array: false,
+        choices: Object.values(ClientConfigFormat),
       });
   };
 }