MB-70103 Add backup-service repo-remove command

Also, marks the backup-service repository command as deprecated.

Duplicates the functionality of backup-service repository --remove
which will be deprecated.

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

Author: lubomarinski

cbmgr.py

@@ -7000,12 +7000,13 @@ def __init__(self):
         self.repo_get_cmd = BackupServiceRepoGet(self.subparser)
         self.repo_add_cmd = BackupServiceRepoAdd(self.subparser)
         self.repo_archive_cmd = BackupServiceRepoArchive(self.subparser)
+        self.repo_remove_cmd = BackupServiceRepoRemove(self.subparser)
         self.plan_cmd = BackupServicePlan(self.subparser)
         self.nodeThreads_cmd = BackupServiceNodeThreadsMap(self.subparser)
 
     def execute(self, opts):
-        subcommands = ['settings', 'repository', 'repo-list', 'repo-get', 'repo-add', 'repo-archive', 'plan',
-                       'node-threads']
+        subcommands = ['settings', 'repository', 'repo-list', 'repo-get', 'repo-add', 'repo-archive', 'repo-remove',
+                       'plan', 'node-threads']
 
         if opts.sub_cmd is None or opts.sub_cmd not in subcommands:
             _exit_if_errors([f'<subcommand> must be one of {subcommands}'])
@@ -7022,6 +7023,8 @@ def execute(self, opts):
             self.repo_add_cmd.execute(opts)
         elif opts.sub_cmd == 'repo-archive':
             self.repo_archive_cmd.execute(opts)
+        elif opts.sub_cmd == 'repo-remove':
+            self.repo_remove_cmd.execute(opts)
         elif opts.sub_cmd == 'plan':
             self.plan_cmd.execute(opts)
         elif opts.sub_cmd == 'node-threads':
@@ -7435,8 +7438,44 @@ def get_description():
         return 'Archive a repository'
 
 
+class BackupServiceRepoRemove:
+    """Removes a backup repository
+    """
+
+    def __init__(self, subparser):
+        """setup the parser"""
+        self.rest = None
+        repository_parser = subparser.add_parser('repo-remove', help='Remove a backup repository', add_help=False,
+                                                 allow_abbrev=False)
+
+        group = repository_parser.add_argument_group('Backup service repository configuration')
+        group.add_argument('--id', metavar='<id>', help='The repository id', required=True)
+        group.add_argument('--state', metavar='<state>', choices=['archived', 'imported'],
+                           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')
+
+    @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)
+        _exit_if_errors(errors)
+        _success('Repository was removed')
+
+    @staticmethod
+    def get_man_page_name():
+        return get_doc_page_name("couchbase-cli-backup-service-repo-remove")
+
+    @staticmethod
+    def get_description():
+        return 'Remove a repository'
+
+
 class BackupServiceRepository:
-    """This command manages backup services repositories.
+    """(Deprecated) This command manages backup services repositories.
 
     Things this command can do is:
     - List repositories
@@ -7496,6 +7535,9 @@ def __init__(self, subparser):
     @rest_initialiser(version_check=True, enterprise_check=True, cluster_init_check=True)
     def execute(self, opts):
         """Run the backup-service repository subcommand"""
+        _deprecated("The 'backup-service repository' subcommand is deprecated. Please use the 'repo-add', "
+                    "'repo-list', 'repo-get', 'repo-remove' and 'repo-archive' subcommands instead")
+
         if opts.list:
             self.list_repositories(opts.state, opts.output == 'json')
         elif opts.get:

docs/modules/cli/pages/_partials/cbcli/nav.adoc

@@ -8,6 +8,7 @@
  ** xref:cli:cbcli/couchbase-cli-backup-service-repo-archive.adoc[backup-service repo-archive]
  ** xref:cli:cbcli/couchbase-cli-backup-service-repo-get.adoc[backup-service repo-get]
  ** xref:cli:cbcli/couchbase-cli-backup-service-repo-list.adoc[backup-service repo-list]
+ ** xref:cli:cbcli/couchbase-cli-backup-service-repo-remove.adoc[backup-service repo-remove]
  ** xref:cli:cbcli/couchbase-cli-backup-service-repository.adoc[backup-service repository]
  ** xref:cli:cbcli/couchbase-cli-backup-service-settings.adoc[backup-service settings]
  ** xref:cli:cbcli/couchbase-cli-bucket-compact.adoc[bucket-compact]

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

@@ -185,6 +185,7 @@ man:couchbase-cli-backup-service[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-remove[1],
 man:couchbase-cli-backup-service-plan[1]
 
 

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

@@ -79,7 +79,8 @@ include::{partialsdir}/cbcli/part-common-env.adoc[]
 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-list[1],
+man:couchbase-cli-backup-service-repo-remove[1]
 
 include::{partialsdir}/cbcli/part-footer.adoc[]
 

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

@@ -114,7 +114,8 @@ include::{partialsdir}/cbcli/part-common-env.adoc[]
 man:couchbase-cli-backup-service[1],
 man:couchbase-cli-backup-service-repo-get[1],
 man:couchbase-cli-backup-service-repo-add[1],
-man:couchbase-cli-backup-service-repo-archive[1]
+man:couchbase-cli-backup-service-repo-archive[1],
+man:couchbase-cli-backup-service-repo-remove[1]
 
 include::{partialsdir}/cbcli/part-footer.adoc[]
 

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

@@ -0,0 +1,90 @@
+= couchbase-cli-backup-service-repo-remove(1)
+:description: Remove a backup service repository
+ifndef::doctype-manpage[:doctitle: backup-service repo-remove]
+
+ifdef::doctype-manpage[]
+== NAME
+
+couchbase-cli-backup-service-repo-remove -
+endif::[]
+Remove a backup service repository
+
+== SYNOPSIS
+
+[verse]
+_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]
+
+== DESCRIPTION
+
+Removes an archived or imported backup repository from the backup service.
+Optionally, the underlying backup data can also be deleted using the
+`--delete-data` flag (only valid for archived repositories).
+
+Note that active repositories cannot be removed directly. To remove an active
+repository, it must first be archived. This can be done using the `repo-archive` command.
+
+== OPTIONS
+
+--id <id>::
+    The ID of the repository to remove. This argument is required.
+
+--state <state>::
+    The state of the repository to remove. Valid states are 'archived' or
+    'imported'. This argument is required. Note that active repositories
+    cannot be removed directly.
+
+--delete-data::
+    If specified, the underlying backup data will also be deleted. This flag
+    is only valid for archived repositories. Imported repositories cannot have
+    their data deleted.
+
+include::{partialsdir}/cbcli/part-common-options.adoc[]
+
+include::{partialsdir}/cbcli/part-host-formats.adoc[]
+
+include::{partialsdir}/cbcli/part-certificate-authentication.adoc[]
+
+== EXAMPLES
+
+To remove an archived repository with ID 'old-backup' without deleting the
+underlying backup data, run the following command.
+
+----
+$ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p password \
+  repo-remove --id old-backup --state archived
+----
+
+To remove an archived repository and also delete the underlying backup data,
+use the `--delete-data` flag.
+
+----
+$ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p password \
+  repo-remove --id old-backup --state archived --delete-data
+----
+
+To remove an imported repository, specify `--state imported`. Note that
+the `--delete-data` flag cannot be used with imported repositories.
+
+----
+$ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p password \
+  repo-remove --id imported-repo --state imported
+----
+
+== ENVIRONMENT AND CONFIGURATION VARIABLES
+
+include::{partialsdir}/cbcli/part-common-env.adoc[]
+
+== SEE ALSO
+
+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]
+
+include::{partialsdir}/cbcli/part-footer.adoc[]
+

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

@@ -23,6 +23,11 @@ usage: couchbase-cli backup-service repository (--list | --get | --archive | --a
 
 == DESCRIPTION
 
+DEPRECATED: This subcommand is deprecated and will be removed in future
+releases. Please use the 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-remove[1] and
+man:couchbase-cli-backup-service-repo-archive[1] subcommands instead.
+
 Manage backup service repositories
 
 == ACTION OPTIONS
@@ -235,6 +240,11 @@ include::{partialsdir}/cbcli/part-common-env.adoc[]
 
 == SEE ALSO
 
-man:couchbase-cli-backup-service[1]
+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-remove[1],
+man:couchbase-cli-backup-service-repo-archive[1],
+man:couchbase-cli-backup-service-repo-list[1]
 
 include::{partialsdir}/cbcli/part-footer.adoc[]

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

@@ -28,9 +28,6 @@ include::{partialsdir}/cbcli/part-common-options.adoc[]
 man:couchbase-cli-backup-service-settings[1]::
   Manage backup service configuration.
 
-man:couchbase-cli-backup-service-repository[1]::
-  Manage backup repositories.
-
 man:couchbase-cli-backup-service-plan[1]::
   Manage backup plans.
 
@@ -49,6 +46,9 @@ man:couchbase-cli-backup-service-repo-add[1]::
 man:couchbase-cli-backup-service-repo-archive[1]::
   Archive a backup service repository.
 
+man:couchbase-cli-backup-service-repo-remove[1]::
+  Remove a backup service repository.
+
 include::{partialsdir}/cbcli/part-host-formats.adoc[]
 
 include::{partialsdir}/cbcli/part-certificate-authentication.adoc[]

test/test_cli.py

@@ -5347,6 +5347,69 @@ def test_archive_repository_request_body(self):
         self.assertEqual('weeklybackup_archived', body['id'])
 
 
+class TestBackupServiceRepoRemove(CommandTest):
+    """Test the backup-service repo-remove subcommand"""
+
+    def setUp(self):
+        self.server_args = {'enterprise': True, 'init': True, 'is_admin': True,
+                            '/pools/default/nodeServices': {'nodesExt': [{
+                                'hostname': host,
+                                'services': {
+                                    'backupAPI': port,
+                                },
+                            }]}}
+        self.command = ['couchbase-cli', 'backup-service'] + cluster_connect_args + ['repo-remove']
+        super(TestBackupServiceRepoRemove, self).setUp()
+
+    def test_missing_id(self):
+        """Test that the command fails if --id is not provided"""
+        self.system_exit_run(self.command + ['--state', 'archived'], self.server_args)
+        self.assertIn('--id', self.str_error)
+        self.assertIn('required', self.str_error)
+
+    def test_missing_state(self):
+        """Test that the command fails if --state is not provided"""
+        self.system_exit_run(self.command + ['--id', 'repo1'], self.server_args)
+        self.assertIn('--state', self.str_error)
+        self.assertIn('required', self.str_error)
+
+    def test_invalid_state(self):
+        """Test that only 'archived' or 'imported' are valid state values"""
+        self.system_exit_run(self.command + ['--id', 'repo1', '--state', 'active'], self.server_args)
+        self.assertIn('invalid choice', self.str_error)
+
+    def test_remove_archived_repository_success(self):
+        """Test that the command successfully removes an archived repository"""
+        self.no_error_run(self.command + ['--id', 'archivedrepo', '--state', 'archived'], self.server_args)
+        self.assertIn('DELETE:/api/v1/cluster/self/repository/archived/archivedrepo', self.server.trace)
+        self.assertIn('Repository was removed', self.str_output)
+
+    def test_remove_imported_repository_success(self):
+        """Test that the command successfully removes an imported repository"""
+        self.no_error_run(self.command + ['--id', 'importedrepo', '--state', 'imported'], self.server_args)
+        self.assertIn('DELETE:/api/v1/cluster/self/repository/imported/importedrepo', self.server.trace)
+        self.assertIn('Repository was removed', self.str_output)
+
+    def test_remove_archived_with_delete_data(self):
+        """Test that --delete-data flag is passed correctly for archived repositories"""
+        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('Repository was removed', self.str_output)
+
+    def test_cannot_delete_data_for_imported(self):
+        """Test that --delete-data fails for imported repositories"""
+        self.system_exit_run(self.command + ['--id', 'importedrepo', '--state', 'imported', '--delete-data'],
+                             self.server_args)
+        self.assertIn('cannot delete the data of an imported repository', self.str_output)
+
+    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)
+
+
 class TestBackupServiceSettings(CommandTest):
     """Test the backup-service settings subcommand"""