feat(cli): 96e0969916661f30eaffb284d7b1d27a7427e4a9

Author: serverpod_cloud

serverpod_cloud_cli/lib/command_runner/commands/deploy_command.dart

@@ -4,6 +4,7 @@ import 'package:serverpod_cloud_cli/command_runner/cloud_cli_command.dart';
 import 'package:serverpod_cloud_cli/command_runner/helpers/command_options.dart';
 import 'package:serverpod_cloud_cli/commands/deploy/deploy.dart';
 import 'package:serverpod_cloud_cli/constants.dart';
+import 'package:serverpod_cloud_cli/shared/exceptions/exit_exceptions.dart';
 
 import 'categories.dart';
 
@@ -34,6 +35,14 @@ enum DeployCommandOption<V> implements OptionDefinition<V> {
       defaultsTo: false,
       negatable: false,
     ),
+  ),
+  output(
+    StringOption(
+      argName: 'output',
+      argAbbrev: 'o',
+      helpText:
+          'Save the deployment zip file to the specified path. Must end with .zip',
+    ),
   );
 
   const DeployCommandOption(this.option);
@@ -70,6 +79,14 @@ Examples
   
     \$ scloud deploy --dry-run --show-files
 
+  Save the deployment zip file locally
+
+    \$ scloud deploy --output deployment.zip --dry-run
+
+  Save the deployment zip and still upload it (unless --dry-run is set)
+
+    \$ scloud deploy --output deployment.zip
+
 ''';
 
   CloudDeployCommand({required super.logger})
@@ -83,6 +100,11 @@ Examples
     final concurrency = commandConfig.value(DeployCommandOption.concurrency);
     final dryRun = commandConfig.value(DeployCommandOption.dryRun);
     final showFiles = commandConfig.value(DeployCommandOption.showFiles);
+    final outputPath = commandConfig.optionalValue(DeployCommandOption.output);
+
+    if (outputPath != null && !outputPath.endsWith('.zip')) {
+      throw FailureException(errors: ['The --output path must end with .zip']);
+    }
 
     final projectDirectory = runner.verifiedProjectDirectory();
     logger.debug('Using project directory `${projectDirectory.path}`');
@@ -103,6 +125,7 @@ Examples
       concurrency: concurrency,
       dryRun: dryRun,
       showFiles: showFiles,
+      outputPath: outputPath,
     );
   }
 }

serverpod_cloud_cli/lib/commands/deploy/deploy.dart

@@ -25,6 +25,7 @@ abstract class Deploy {
     required final int concurrency,
     required final bool dryRun,
     required final bool showFiles,
+    final String? outputPath,
   }) async {
     logger.init('Deploying Serverpod Cloud project "$projectId".');
 
@@ -130,6 +131,22 @@ abstract class Deploy {
 
     if (!isZipped) throw ErrorExitException('Failed to zip project.');
 
+    if (outputPath != null) {
+      await logger.progress('Writing zip file to $outputPath...', () async {
+        try {
+          final file = File(outputPath);
+          await file.writeAsBytes(projectZip);
+          return true;
+        } on Exception catch (e, stackTrace) {
+          throw FailureException.nested(
+            e,
+            stackTrace,
+            'Failed to write zip file to $outputPath',
+          );
+        }
+      });
+    }
+
     if (dryRun) {
       await logger.progress('Dry run, skipping upload.', () async {
         return true;

serverpod_cloud_cli/test_integration/commands/deploy_command_test.dart

@@ -128,6 +128,40 @@ void main() {
       },
     );
 
+    group('and invalid output option value when running deploy command', () {
+      late Future cliCommandFuture;
+      setUp(() async {
+        await ProjectFactory.serverpodServerDir().create();
+        final testProjectDir = p.join(
+          d.sandbox,
+          ProjectFactory.defaultDirectoryName,
+        );
+
+        cliCommandFuture = cli.run([
+          'deploy',
+          '--output',
+          'deployment.txt',
+          '--project',
+          '123',
+          '--project-dir',
+          testProjectDir,
+        ]);
+      });
+
+      test('then ErrorExitException is thrown.', () async {
+        await expectLater(cliCommandFuture, throwsA(isA<ErrorExitException>()));
+      });
+
+      test('then error message is logged', () async {
+        await cliCommandFuture.catchError((final _) {});
+        expect(logger.errorCalls, isNotEmpty);
+        expect(
+          logger.errorCalls.first.message,
+          contains('The --output path must end with .zip'),
+        );
+      });
+    });
+
     group(
       'and current directory is not Serverpod server directory when running deploy command',
       () {
@@ -515,6 +549,36 @@ dependencies:
         });
       });
 
+      group('when deploying through CLI with --output and --dry-run', () {
+        late Future cliCommandFuture;
+        late String outputZipPath;
+        setUp(() async {
+          outputZipPath = p.join(d.sandbox, 'deployment.zip');
+          cliCommandFuture = cli.run([
+            'deploy',
+            '--dry-run',
+            '--output',
+            outputZipPath,
+            '--project',
+            BucketUploadDescription.projectId,
+            '--project-dir',
+            testProjectDir,
+          ]);
+        });
+
+        test('then command completes successfully.', () async {
+          await expectLater(cliCommandFuture, completes);
+        });
+
+        test('then zip file is created at output path.', () async {
+          await cliCommandFuture;
+
+          final outputFile = File(outputZipPath);
+          expect(outputFile.existsSync(), isTrue);
+          expect(outputFile.lengthSync(), greaterThan(0));
+        });
+      });
+
       group('when deploying through CLI with --show-files and --dry-run', () {
         late Future cliCommandFuture;
         setUp(() async {