MB-70102 Add subcommand for modifying the repo cloud config

Add a 'repo-cloud-config' subcommand to modify the cloud options for
and existing repository. Currently supports only the
--retention-delete-versions flag.

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

Author: lubomarinski

cbmgr.py

@@ -7004,12 +7004,13 @@ def __init__(self):
         self.repo_pause_cmd = BackupServiceRepoPause(self.subparser)
         self.repo_resume_cmd = BackupServiceRepoResume(self.subparser)
         self.repo_worm_cmd = BackupServiceRepoWORM(self.subparser)
+        self.repo_cloud_config_cmd = BackupServiceRepoCloudConfig(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', 'repo-remove',
-                       'repo-pause', 'repo-resume', 'repo-worm', 'plan', 'node-threads']
+                       'repo-pause', 'repo-resume', 'repo-worm', 'repo-cloud-config', '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}'])
@@ -7034,6 +7035,8 @@ def execute(self, opts):
             self.repo_resume_cmd.execute(opts)
         elif opts.sub_cmd == 'repo-worm':
             self.repo_worm_cmd.execute(opts)
+        elif opts.sub_cmd == 'repo-cloud-config':
+            self.repo_cloud_config_cmd.execute(opts)
         elif opts.sub_cmd == 'plan':
             self.plan_cmd.execute(opts)
         elif opts.sub_cmd == 'node-threads':
@@ -7579,6 +7582,48 @@ def get_description():
         return 'Set WORM for a repository'
 
 
+class BackupServiceRepoCloudConfig:
+    """Modify the cloud config for a repository.
+    """
+
+    def __init__(self, subparser):
+        """setup the parser"""
+        self.rest = None
+        repository_parser = subparser.add_parser('repo-cloud-config', help='Modify the cloud config for a repository',
+                                                 add_help=False, allow_abbrev=False)
+
+        repository_parser.add_argument('--id', metavar='<id>', help='The repository id', required=True)
+
+        cloud_group = repository_parser.add_argument_group('Backup repository cloud arguments')
+        cloud_group.add_argument('--retention-delete-versions', metavar="<0|1>", choices=["0", "1"],
+                                 help='Enable or disable deleting old object versions when pruning backups with '
+                                 'expired retention period')
+
+    @rest_initialiser(version_check=True, enterprise_check=True, cluster_init_check=True)
+    def execute(self, opts):
+        """Run the backup-service repo-cloud-config subcommand"""
+
+        body = {}
+
+        if opts.retention_delete_versions is not None:
+            body["retention_delete_versions"] = opts.retention_delete_versions == "1"
+
+        if body == {}:
+            _exit_if_errors(['At least one cloud argument is required'])
+
+        _, errors = self.rest.modify_repository_cloud_config(opts.id, body)
+        _exit_if_errors(errors)
+        _success('Repository cloud config was modified successfully')
+
+    @staticmethod
+    def get_man_page_name():
+        return get_doc_page_name("couchbase-cli-backup-service-repo-cloud-config")
+
+    @staticmethod
+    def get_description():
+        return 'Modify the cloud config for a repository'
+
+
 class BackupServiceRepository:
     """(Deprecated) This command manages backup services repositories.
 

cluster_manager.py

@@ -2719,6 +2719,22 @@ def set_worm_for_backup_repo(self, repository_id: str, period: Optional[int], di
 
         return self._post_json(f'{hosts[0]}/api/v1/cluster/self/repository/active/{repository_id}/worm', body)
 
+    def modify_repository_cloud_config(self, repository_id: str, body: Dict[str, Any]):
+        """Modify repository cloud config
+
+        Args:
+            repository_id (str): The repository id
+            body (dict): The request body
+        """
+        hosts, errors = self.get_hostnames_for_service(BACKUP_SERVICE)
+        if errors:
+            return None, errors
+
+        if not hosts:
+            raise ServiceNotAvailableException(BACKUP_SERVICE)
+
+        return self._post_json(f'{hosts[0]}/api/v1/cluster/self/repository/active/{repository_id}/cloudConfig', body)
+
     def add_backup_active_repository(self, repository_id: str, body: Dict[str, Any], cluster: str = 'self'):
         """Add an active repository
 

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

@@ -6,6 +6,7 @@
  ** xref:cli:cbcli/couchbase-cli-backup-service-plan.adoc[backup-service plan]
  ** xref:cli:cbcli/couchbase-cli-backup-service-repo-add.adoc[backup-service repo-add]
  ** xref:cli:cbcli/couchbase-cli-backup-service-repo-archive.adoc[backup-service repo-archive]
+ ** xref:cli:cbcli/couchbase-cli-backup-service-repo-cloud-config.adoc[backup-service repo-cloud-config]
  ** 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-pause.adoc[backup-service repo-pause]

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

@@ -0,0 +1,80 @@
+= couchbase-cli-backup-service-repo-cloud-config(1)
+:description: Modify the cloud config for a backup service repository
+ifndef::doctype-manpage[:doctitle: backup-service repo-cloud-config]
+
+ifdef::doctype-manpage[]
+== NAME
+
+couchbase-cli-backup-service-repo-cloud-config -
+endif::[]
+Modify the cloud config for 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-cloud-config_ [--id <id>]
+    [--retention-delete-versions <0|1>]
+
+== DESCRIPTION
+
+Modifies the cloud configuration for a backup service repository. This command
+allows you to control cloud versioning behavior and retention settings for
+repositories stored in cloud object storage.
+
+== OPTIONS
+
+--id <id>::
+    The repository ID. This argument is required.
+
+--retention-delete-versions <0|1>::
+    Enable or disable deleting old object versions when pruning backups with
+    expired retention period. Set to `1` to enable deletion of old versions,
+    or `0` to disable.
+
+include::{partialsdir}/cbcli/part-common-options.adoc[]
+
+include::{partialsdir}/cbcli/part-host-formats.adoc[]
+
+include::{partialsdir}/cbcli/part-certificate-authentication.adoc[]
+
+== EXAMPLES
+
+To enable deleting old object versions when pruning backups for a repository
+named 'cloud-backup', run the following command:
+
+----
+$ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p password \
+  repo-cloud-config --id cloud-backup --retention-delete-versions 1
+----
+
+If successful, the following output will be displayed:
+
+----
+Repository cloud config was modified successfully
+----
+
+To disable deleting old object versions when pruning backups for the same
+repository:
+
+----
+$ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p password \
+  repo-cloud-config --id cloud-backup --retention-delete-versions 0
+----
+
+== 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-list[1],
+man:couchbase-cli-backup-service-repo-get[1],
+man:couchbase-cli-backup-service-repo-add[1],
+man:couchbase-cli-backup-service-repo-worm[1]
+
+include::{partialsdir}/cbcli/part-footer.adoc[]
+

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

@@ -46,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-cloud-config[1]::
+  Modify cloud configuration for a backup service repository.
+
 man:couchbase-cli-backup-service-repo-remove[1]::
   Remove a backup service repository.
 

test/mock_server.py

@@ -633,6 +633,7 @@ def export_eventing_functions(rest_params=None, server_args=None, path="", endpo
     (r'/api/v1/cluster/self/repository/active/[\w-]+/pause$', {'POST': do_nothing}),
     (r'/api/v1/cluster/self/repository/active/[\w-]+/resume$', {'POST': do_nothing}),
     (r'/api/v1/cluster/self/repository/active/[\w-]+/worm$', {'POST': do_nothing}),
+    (r'/api/v1/cluster/self/repository/active/[\w-]+/cloudConfig$', {'POST': do_nothing}),
     (r'/api/v1/plan$', {'GET': get_by_path}),
     (r'/api/v1/plan/\w+$', {'GET': get_by_path, 'DELETE': do_nothing, 'POST': do_nothing}),
     (r'/api/v1/cluster/self/repository/(:?active|archived|imported)/\w+(:?\?remove_repository=\w+)?$',

test/test_cli.py

@@ -5535,6 +5535,51 @@ def test_disable_worm_success(self):
         self.assertIn('Repository WORM config was set', self.str_output)
 
 
+class TestBackupServiceRepoCloudConfig(CommandTest):
+    """Test the backup-service repo-cloud-config 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-cloud-config']
+        super(TestBackupServiceRepoCloudConfig, self).setUp()
+
+    def test_missing_id(self):
+        """Test that the command fails if --id is not provided"""
+        self.system_exit_run(self.command + ['--retention-delete-versions', '1'], self.server_args)
+        self.assertIn('--id', self.str_error)
+        self.assertIn('required', self.str_error)
+
+    def test_invalid_retention_delete_versions_value(self):
+        """Test that --retention-delete-versions only accepts 0 or 1"""
+        self.system_exit_run(self.command + ['--id', 'myrepo', '--retention-delete-versions', 'yes'], self.server_args)
+        self.assertIn('invalid choice', self.str_error)
+
+    def test_set_retention_delete_versions_enable(self):
+        """Test that the command successfully enables retention-delete-versions for a repository"""
+        self.no_error_run(self.command + ['--id', 'myrepo', '--retention-delete-versions', '1'], self.server_args)
+        self.assertIn('POST:/api/v1/cluster/self/repository/active/myrepo/cloudConfig', self.server.trace)
+        self.rest_parameter_match([json.dumps({'retention_delete_versions': True}, sort_keys=True)])
+        self.assertIn('Repository cloud config was modified successfully', self.str_output)
+
+    def test_set_retention_delete_versions_disable(self):
+        """Test that the command successfully disables retention-delete-versions for a repository"""
+        self.no_error_run(self.command + ['--id', 'myrepo', '--retention-delete-versions', '0'], self.server_args)
+        self.assertIn('POST:/api/v1/cluster/self/repository/active/myrepo/cloudConfig', self.server.trace)
+        self.rest_parameter_match([json.dumps({'retention_delete_versions': False}, sort_keys=True)])
+        self.assertIn('Repository cloud config was modified successfully', self.str_output)
+
+    def test_no_cloud_options_provided(self):
+        """Test that the command fails if no cloud options are provided"""
+        self.system_exit_run(self.command + ['--id', 'myrepo'], self.server_args)
+        self.assertIn('At least one cloud argument is required', self.str_output)
+
+
 class TestBackupServiceSettings(CommandTest):
     """Test the backup-service settings subcommand"""