feat(scloud): 3bbfc2ae55db0606a08a57de7362b4da8be9114d

Author: serverpod_cloud

serverpod_cloud_cli/lib/command_runner/commands/admin/admin_projects_commands.dart

@@ -10,11 +10,12 @@ class AdminProjectCommand extends CloudCliCommand {
   final name = 'project';
 
   @override
-  final description = 'Inspect Serverpod Cloud projects.';
+  final description = 'Manage Serverpod Cloud projects.';
 
   AdminProjectCommand({required super.logger}) {
     addSubcommand(AdminListProjectsCommand(logger: logger));
     addSubcommand(AdminProjectStatusCommand(logger: logger));
+    addSubcommand(AdminProjectDeleteCommand(logger: logger));
   }
 }
 
@@ -118,3 +119,47 @@ class AdminProjectStatusCommand
     table.writeLines(logger.line);
   }
 }
+
+enum AdminProjectDeleteOption<V> implements OptionDefinition<V> {
+  projectId(
+    StringOption(
+      argName: 'project',
+      argAbbrev: 'p',
+      argPos: 0,
+      mandatory: true,
+      helpText:
+          'The ID of the project. '
+          'Can be passed as the first argument.',
+    ),
+  );
+
+  const AdminProjectDeleteOption(this.option);
+
+  @override
+  final ConfigOptionBase<V> option;
+}
+
+class AdminProjectDeleteCommand
+    extends CloudCliCommand<AdminProjectDeleteOption> {
+  @override
+  final name = 'delete';
+
+  @override
+  final description = 'Delete a Serverpod Cloud project.';
+
+  AdminProjectDeleteCommand({required super.logger})
+    : super(options: AdminProjectDeleteOption.values);
+
+  @override
+  Future<void> runWithConfig(
+    final Configuration<AdminProjectDeleteOption> commandConfig,
+  ) async {
+    final projectId = commandConfig.value(AdminProjectDeleteOption.projectId);
+
+    await ProjectAdminCommands.deleteProject(
+      runner.serviceProvider.cloudApiClient,
+      logger: logger,
+      projectId: projectId,
+    );
+  }
+}

serverpod_cloud_cli/lib/command_runner/completion/completion_script_carapace.dart

@@ -106,6 +106,7 @@ commands:
       - name: link
         flags:
           -p, --project=!: "The ID of the project. Can be passed as the first argument."
+          --dart-version=: "Overrides the Dart SDK version to use for building the project."
 
       - name: user
 
@@ -131,6 +132,7 @@ commands:
       --dry-run: "Do not actually deploy, just print the deployment steps."
       --show-files: "Display the file tree that will be uploaded."
       -o, --output=: "Save the deployment zip file to the specified path. Must end with .zip"
+      --dart-version=: "Overrides the Dart SDK version to use for building the project."
 
   - name: variable
 
@@ -309,6 +311,7 @@ commands:
       --no-enable-db: "Flag to enable the database for the project."
       --deploy: "Flag to immediately deploy the project."
       --no-deploy: "Flag to immediately deploy the project."
+      --dart-version=: "Overrides the Dart SDK version to use for building the project."
     exclusiveFlags:
       - [enable-db, no-enable-db]
       - [deploy, no-deploy]

serverpod_cloud_cli/lib/command_runner/completion/completion_script_completely.dart

@@ -769,7 +769,7 @@ _scloud_completions() {
       ;;
 
     'project link'*)
-      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_scloud_completions_filter "--quiet -q --verbose -v --analytics --no-analytics -a --version --token --project-dir -d --project-config-file --timeout --yes --project -p")" -- "$cur")
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_scloud_completions_filter "--quiet -q --verbose -v --analytics --no-analytics -a --version --token --project-dir -d --project-config-file --timeout --yes --project -p --dart-version")" -- "$cur")
       ;;
 
     'project user'*)
@@ -889,15 +889,15 @@ _scloud_completions() {
       ;;
 
     'deploy'*)
-      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_scloud_completions_filter "--quiet -q --verbose -v --analytics --no-analytics -a --version --token --project-dir -d --project-config-file --timeout --yes --project -p --concurrency -c --dry-run --show-files --output -o")" -- "$cur")
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_scloud_completions_filter "--quiet -q --verbose -v --analytics --no-analytics -a --version --token --project-dir -d --project-config-file --timeout --yes --project -p --concurrency -c --dry-run --show-files --output -o --dart-version")" -- "$cur")
       ;;
 
     'log'*'-d')
       while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -A directory -- "$cur")
       ;;
 
     'launch'*)
-      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_scloud_completions_filter "--quiet -q --verbose -v --analytics --no-analytics -a --version --token --project-dir -d --project-config-file --timeout --yes --project --new-project --enable-db --no-enable-db --deploy --no-deploy")" -- "$cur")
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_scloud_completions_filter "--quiet -q --verbose -v --analytics --no-analytics -a --version --token --project-dir -d --project-config-file --timeout --yes --project --new-project --enable-db --no-enable-db --deploy --no-deploy --dart-version")" -- "$cur")
       ;;
 
     'domain'*)

serverpod_cloud_cli/lib/commands/admin/project_admin.dart

@@ -58,6 +58,35 @@ abstract class ProjectAdminCommands {
     );
   }
 
+  static Future<void> deleteProject(
+    final Client cloudApiClient, {
+    required final CommandLogger logger,
+    required final String projectId,
+  }) async {
+    final shouldDelete = await logger.confirm(
+      'Are you sure you want to delete the project "$projectId"?',
+      defaultValue: false,
+    );
+
+    if (!shouldDelete) {
+      throw UserAbortException();
+    }
+
+    try {
+      await cloudApiClient.adminProjects.deleteProject(
+        cloudProjectId: projectId,
+      );
+    } on Exception catch (e, s) {
+      throw FailureException.nested(
+        e,
+        s,
+        'Request to delete the project failed',
+      );
+    }
+
+    logger.success('Deleted the project "$projectId".', newParagraph: true);
+  }
+
   static String _formatProjectUsers(final Project project) {
     return project.roles
             ?.map((final r) {

serverpod_cloud_cli/test_integration/commands/admin/admin_project_delete_cmd_test.dart

@@ -0,0 +1,183 @@
+import 'dart:async';
+
+import 'package:ground_control_client/ground_control_client.dart';
+import 'package:ground_control_client/ground_control_client_test_tools.dart';
+import 'package:mocktail/mocktail.dart';
+import 'package:serverpod_cloud_cli/command_runner/cloud_cli_command_runner.dart';
+import 'package:serverpod_cloud_cli/command_runner/commands/admin/admin_projects_commands.dart';
+import 'package:serverpod_cloud_cli/command_runner/helpers/cloud_cli_service_provider.dart';
+import 'package:serverpod_cloud_cli/shared/exceptions/exit_exceptions.dart';
+import 'package:test/test.dart';
+
+import '../../../test_utils/command_logger_matchers.dart';
+import '../../../test_utils/test_command_logger.dart';
+
+void main() {
+  final logger = TestCommandLogger();
+  final client = ClientMock(
+    authKeyProvider: InMemoryKeyManager.authenticated(),
+  );
+  final cli = CloudCliCommandRunner.create(
+    logger: logger,
+    serviceProvider: CloudCliServiceProvider(
+      apiClientFactory: (final globalCfg) => client,
+    ),
+    adminUserMode: true,
+  );
+
+  tearDown(() async {
+    reset(client.adminProjects);
+    logger.clear();
+  });
+
+  const projectId = 'my-proj';
+
+  test(
+    'Given admin project delete command when instantiated then requires login',
+    () {
+      expect(AdminProjectDeleteCommand(logger: logger).requireLogin, isTrue);
+    },
+  );
+
+  group('Given authenticated', () {
+    group('when executing admin project delete and accepting the prompt', () {
+      late Future commandResult;
+      setUp(() async {
+        when(
+          () => client.adminProjects.deleteProject(
+            cloudProjectId: any(named: 'cloudProjectId'),
+          ),
+        ).thenAnswer(
+          (final invocation) async =>
+              ProjectBuilder().withCloudProjectId(projectId).build(),
+        );
+
+        logger.answerNextConfirmWith(true);
+
+        commandResult = cli.run(['admin', 'project', 'delete', projectId]);
+      });
+
+      test('then command completes successfully', () async {
+        await expectLater(commandResult, completes);
+        verify(
+          () => client.adminProjects.deleteProject(cloudProjectId: projectId),
+        ).called(1);
+      });
+
+      test('then command logs confirm message', () async {
+        await commandResult;
+
+        expect(logger.confirmCalls, isNotEmpty);
+        expect(
+          logger.confirmCalls.first,
+          equalsConfirmCall(
+            message: 'Are you sure you want to delete the project "my-proj"?',
+            defaultValue: false,
+          ),
+        );
+      });
+
+      test('then command outputs success message', () async {
+        await commandResult;
+
+        expect(logger.successCalls, isNotEmpty);
+        expect(
+          logger.successCalls.first,
+          equalsSuccessCall(
+            message: 'Deleted the project "my-proj".',
+            newParagraph: true,
+          ),
+        );
+      });
+    });
+
+    group('when executing admin project delete and rejecting the prompt', () {
+      late Future commandResult;
+      setUp(() async {
+        when(
+          () => client.adminProjects.deleteProject(
+            cloudProjectId: any(named: 'cloudProjectId'),
+          ),
+        ).thenAnswer(
+          (final invocation) async =>
+              ProjectBuilder().withCloudProjectId(projectId).build(),
+        );
+
+        logger.answerNextConfirmWith(false);
+
+        commandResult = cli.run(['admin', 'project', 'delete', projectId]);
+      });
+
+      test('then command throws exit exception', () async {
+        await expectLater(commandResult, throwsA(isA<ErrorExitException>()));
+      });
+
+      test('then logs confirm message', () async {
+        try {
+          await commandResult;
+        } catch (_) {}
+
+        expect(logger.confirmCalls, isNotEmpty);
+        expect(
+          logger.confirmCalls.first,
+          equalsConfirmCall(
+            message: 'Are you sure you want to delete the project "my-proj"?',
+            defaultValue: false,
+          ),
+        );
+      });
+
+      test('then logs no success message', () async {
+        try {
+          await commandResult;
+        } catch (_) {}
+
+        expect(logger.successCalls, isEmpty);
+      });
+
+      test('then deleteProject is not called', () async {
+        try {
+          await commandResult;
+        } catch (_) {}
+
+        verifyNever(
+          () => client.adminProjects.deleteProject(cloudProjectId: projectId),
+        );
+      });
+    });
+
+    group('when executing admin project delete and API returns not found', () {
+      late Future commandResult;
+      setUp(() async {
+        when(
+          () => client.adminProjects.deleteProject(
+            cloudProjectId: any(named: 'cloudProjectId'),
+          ),
+        ).thenThrow(NotFoundException(message: 'No such project: $projectId'));
+
+        logger.answerNextConfirmWith(true);
+
+        commandResult = cli.run(['admin', 'project', 'delete', projectId]);
+      });
+
+      test('then command throws exit exception', () async {
+        await expectLater(commandResult, throwsA(isA<ErrorExitException>()));
+      });
+
+      test('then logs error message', () async {
+        try {
+          await commandResult;
+        } catch (_) {}
+
+        expect(logger.errorCalls, isNotEmpty);
+        expect(
+          logger.errorCalls.first,
+          equalsErrorCall(
+            message: 'The requested resource did not exist.',
+            hint: 'No such project: my-proj',
+          ),
+        );
+      });
+    });
+  });
+}