MB-70102 Add --cloud-versions flag to the repo-remove command

If passed, old versions of cloud objects will be deleted as well. The
--delete-data flags should also be provided.

Change-Id: Iae7f5960a89b0513686220c609d574cf4b3592c1
Reviewed-on: https://review.couchbase.org/c/couchbase-cli/+/238418
Reviewed-by: Safian Ali <safian.ali@couchbase.com>
Tested-by: Build Bot <build@couchbase.com>

Author: lubomarinski

cbmgr.py

@@ -7483,14 +7483,19 @@ def __init__(self, subparser):
                            help='The repository state.', required=True)
         group.add_argument('--delete-data', action='store_true',
                            help='Used to delete the repository data of an archived repository')
+        group.add_argument('--cloud-versions', action='store_true',
+                           help='Delete all versions of cloud repository objects')
 
     @rest_initialiser(version_check=True, enterprise_check=True, cluster_init_check=True)
     def execute(self, opts):
         """Run the backup-service repo-remove subcommand"""
         if opts.delete_data and opts.state == 'imported':
             _exit_if_errors(['cannot delete the data of an imported repository'])
 
-        _, errors = self.rest.delete_backup_repository(opts.id, opts.state, opts.delete_data)
+        if opts.cloud_versions and not opts.delete_data:
+            _exit_if_errors(['to delete old object versions, the repository data must also be deleted'])
+
+        _, errors = self.rest.delete_backup_repository(opts.id, opts.state, opts.delete_data, opts.cloud_versions)
         _exit_if_errors(errors)
         _success('Repository was removed')
 
@@ -7743,7 +7748,7 @@ def remove_repository(self, repository_id: str, state: str, delete_repo: bool =
         if delete_repo and state == 'imported':
             _exit_if_errors(['cannot delete the repository for an imported repository'])
 
-        _, errors = self.rest.delete_backup_repository(repository_id, state, delete_repo)
+        _, errors = self.rest.delete_backup_repository(repository_id, state, delete_repo, False)
         _exit_if_errors(errors)
         _success('Repository was deleted')
 

cluster_manager.py

@@ -2785,21 +2785,21 @@ def delete_backup_plan(self, name: str):
 
         return self._delete(f'{hosts[0]}/api/v1/plan/{name}', None)
 
-    def delete_backup_repository(self, repository_id: str, state: str, delete_repo: bool, cluster: str = 'self'):
+    def delete_backup_repository(self, repository_id: str, state: str, delete_repo: bool, cloud_versions: bool):
         """Delete a backup repository
         Args:
             repository_id (str): The id to be deleted.
             state (str): The state in which the instance to be deleted is.
             delete_repo (bool): Whether or not to delete the backup Repository.
-            cluster (str): Only 'self' is supported.
         """
         hosts, errors = self.get_hostnames_for_service(BACKUP_SERVICE)
         if errors:
             return None, errors
 
         if not hosts:
             raise ServiceNotAvailableException(BACKUP_SERVICE)
-        url = f'{hosts[0]}/api/v1/cluster/{cluster}/repository/{state}/{repository_id}?remove_repository={delete_repo!s}'
+        query_params = f'remove_repository={delete_repo!s}&cloud_versions={cloud_versions!s}'
+        url = f'{hosts[0]}/api/v1/cluster/self/repository/{state}/{repository_id}?{query_params}'
         return self._delete(url, None)
 
     def add_backup_plan(self, name: str, plan: Dict[str, Any]):

docs/modules/cli/pages/cbcli/couchbase-cli-backup-service-repo-remove.adoc

@@ -16,7 +16,7 @@ _couchbase-cli backup-service_ [--cluster <url>] [--username <user>]
     [--password <password>] [--client-cert <path>]
     [--client-cert-password <password>] [--client-key <path>]
     [--client-key-password <password>] _repo-remove_ [--id <id>]
-    [--state <state>] [--delete-data]
+    [--state <state>] [--delete-data] [--cloud-versions]
 
 == DESCRIPTION
 
@@ -42,6 +42,13 @@ repository, it must first be archived. This can be done using the `repo-archive`
     is only valid for archived repositories. Imported repositories cannot have
     their data deleted.
 
+--cloud-versions::
+    If specified, all versions of cloud repository objects will be deleted. The
+    --delete-data flag must also be provided. Versioning permissions are also
+    required. In case versioning permissions have been disabled for the repo, they
+    can be re-enabled using the man:couchbase-cli-backup-service-repo-cloud-config[1]
+    command.
+
 include::{partialsdir}/cbcli/part-common-options.adoc[]
 
 include::{partialsdir}/cbcli/part-host-formats.adoc[]
@@ -84,7 +91,8 @@ man:couchbase-cli-backup-service[1],
 man:couchbase-cli-backup-service-repo-add[1],
 man:couchbase-cli-backup-service-repo-get[1],
 man:couchbase-cli-backup-service-repo-list[1],
-man:couchbase-cli-backup-service-repo-archive[1]
+man:couchbase-cli-backup-service-repo-archive[1],
+man:couchbase-cli-backup-service-repo-cloud-config[1]
 
 include::{partialsdir}/cbcli/part-footer.adoc[]
 

docs/modules/cli/pages/cbcli/couchbase-cli-backup-service-repo-worm.adoc

@@ -28,6 +28,9 @@ This command allows you to either set a WORM compliance period (in days) or
 disable WORM for a repository once its validity period has expired. Only paused
 repositories can have their WORM configuration modified.
 
+Object versioning needs to be enabled. In case it has been disabled, it can be
+re-enabled using the man:couchbase-cli-backup-service-repo-cloud-config[1] command.
+
 == OPTIONS
 
 --id <id>::
@@ -85,6 +88,7 @@ include::{partialsdir}/cbcli/part-common-env.adoc[]
 == SEE ALSO
 
 man:couchbase-cli-backup-service[1],
+man:couchbase-cli-backup-service-repo-cloud-config[1],
 man:couchbase-cli-backup-service-repo-list[1],
 man:couchbase-cli-backup-service-repo-get[1],
 man:couchbase-cli-backup-service-repo-add[1],

test/test_cli.py

@@ -5448,7 +5448,7 @@ def test_remove_archived_with_delete_data(self):
         self.no_error_run(self.command + ['--id', 'archivedrepo', '--state', 'archived', '--delete-data'],
                           self.server_args)
         self.assertIn('DELETE:/api/v1/cluster/self/repository/archived/archivedrepo', self.server.trace)
-        self.assertIn('remove_repository=True', self.server.queries)
+        self.assertIn('remove_repository=True', self.server.queries[0])
         self.assertIn('Repository was removed', self.str_output)
 
     def test_cannot_delete_data_for_imported(self):
@@ -5460,7 +5460,27 @@ def test_cannot_delete_data_for_imported(self):
     def test_remove_repository_without_delete_data(self):
         """Test that remove_repository=False is passed when --delete-data is not specified"""
         self.no_error_run(self.command + ['--id', 'repo1', '--state', 'archived'], self.server_args)
-        self.assertIn('remove_repository=False', self.server.queries)
+        self.assertIn('remove_repository=False', self.server.queries[0])
+
+    def test_cloud_versions_without_delete_data_fails(self):
+        """Test that --cloud-versions fails without --delete-data"""
+        self.system_exit_run(self.command + ['--id', 'repo1', '--state', 'archived', '--cloud-versions'],
+                             self.server_args)
+        self.assertIn('to delete old object versions, the repository data must also be deleted', self.str_output)
+
+    def test_cloud_versions_with_delete_data_success(self):
+        """Test that --cloud-versions with --delete-data succeeds"""
+        self.no_error_run(self.command + ['--id', 'archivedrepo', '--state', 'archived', '--delete-data',
+                                          '--cloud-versions'], self.server_args)
+        self.assertIn('DELETE:/api/v1/cluster/self/repository/archived/archivedrepo', self.server.trace)
+        self.assertIn('remove_repository=True', self.server.queries[0])
+        self.assertIn('cloud_versions=True', self.server.queries[0])
+        self.assertIn('Repository was removed', self.str_output)
+
+    def test_cloud_versions_false_when_not_specified(self):
+        """Test that cloud_versions=False is passed when --cloud-versions is not specified"""
+        self.no_error_run(self.command + ['--id', 'repo1', '--state', 'archived', '--delete-data'], self.server_args)
+        self.assertIn('cloud_versions=False', self.server.queries[0])
 
 
 class TestBackupServiceRepoPause(CommandTest):
@@ -5934,7 +5954,7 @@ def test_remove_valid_request(self):
         self.no_error_run(self.command + ['--remove', '--id', 'r', '--state', 'archived', '--remove-data'],
                           self.server_args)
         self.assertIn('DELETE:/api/v1/cluster/self/repository/archived/r', self.server.trace)
-        self.assertIn('remove_repository=True', self.server.queries)
+        self.assertIn('remove_repository=True', self.server.queries[0])
 
 
 class TestBackupServicePlan(CommandTest):