MB-70102 Add 3 new flags to the repo-add command

The new flags are --worm, --default-retention,
--cloud-retention-delete-versions. They to correspond to the body
parameters with the same name of the AddActiveRepository endpoint.

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

Author: lubomarinski

cbmgr.py

@@ -7349,6 +7349,9 @@ def __init__(self, subparser):
         group.add_argument('--location', metavar='<location>', help='The location to store the backups in',
                            required=True)
         group.add_argument('--bucket-name', metavar='<bucket_name>', help='The bucket to backup')
+        group.add_argument('--worm', type=int, metavar='<days>', help='The WORM compliance period in days')
+        group.add_argument('--default-retention', type=int, metavar='<days>',
+                           help='The default retention period in days')
 
         # the cloud arguments are given the own group so that the short help is a bit more readable
         cloud_group = repository_parser.add_argument_group('Backup repository cloud arguments')
@@ -7368,6 +7371,9 @@ def __init__(self, subparser):
                                       'Use for object store compatible third party solutions')
         cloud_group.add_argument('--cloud-force-path-style', action='store_true',
                                  help='When using S3 or S3 compatible storage it will use the old path style.')
+        cloud_group.add_argument('--cloud-retention-delete-versions', action='store_true',
+                                 help='Pruning expired backups will also delete old object versions. (This applies to'
+                                 'backups in a versioning-enabled object store)')
 
     @rest_initialiser(version_check=True, enterprise_check=True, cluster_init_check=True)
     def execute(self, opts):
@@ -7406,6 +7412,17 @@ def execute(self, opts):
         if opts.cloud_force_path_style is not None:
             request_body["cloud_force_path_style"] = opts.cloud_force_path_style
 
+        if opts.worm is not None:
+            if opts.worm < 3 or opts.worm > 36525:
+                _exit_if_errors(['the provided WORM period must be in the [3, 36525] range'])
+            request_body["worm"] = opts.worm
+
+        if opts.default_retention is not None:
+            request_body["default_retention"] = opts.default_retention
+
+        if opts.cloud_retention_delete_versions is not None:
+            request_body["cloud_retention_delete_versions"] = opts.cloud_retention_delete_versions
+
         _, errors = self.rest.add_backup_active_repository(opts.id, request_body)
         _exit_if_errors(errors)
         _success('Added repository')

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

@@ -20,7 +20,8 @@ _couchbase-cli backup-service_ [--cluster <url>] [--username <user>]
     [--cloud-credentials-name <name>] [--cloud-staging-dir <path>]
     [--cloud-credentials-id <id>] [--cloud-credentials-key <key>]
     [--cloud-credentials-refresh-token <token>] [--cloud-region <region>]
-    [--cloud-endpoint <endpoint>] [--cloud-force-path-style]
+    [--cloud-endpoint <endpoint>] [--cloud-force-path-style] [--worm <days>]
+    [--default-retention <days>] [--cloud-retention-delete-versions]
 
 == DESCRIPTION
 
@@ -50,6 +51,16 @@ directly in object storage such as S3, Azure, GCP or compatible stores.
     Optionally specify a single bucket to back up. If not provided, all
     buckets will be included in the backup.
 
+--worm <days>::
+    The repo WORM compliance period in days. Must be in the [3, 36525] range.
+    Used to enable WORM for the repository. Newly created backups will be immutable
+    for the provided period. The repo must be located in an object store to enable
+    WORM.
+
+--default-retention <days>::
+    The default retention period in days. Scheduled PRUNE tasks will automatically
+    delete backups with an expired retention period.
+
 == CLOUD OPTIONS
 
 The following options are used when creating a cloud backup repository that
@@ -88,6 +99,12 @@ stores data in object storage.
     instead of virtual-hosted-style URLs. Some S3-compatible stores require
     this option.
 
+--cloud-retention-delete-versions::
+    Pruning expired backups will also delete old object versions. If this is
+    set, whenever a backup's retention period expires we will also deleted old
+    versions of the cloud objects. This applies only to backups in a
+    versioning-enabled object store. Versioning permissions are required.
+
 include::{partialsdir}/cbcli/part-common-options.adoc[]
 
 include::{partialsdir}/cbcli/part-host-formats.adoc[]

test/test_cli.py

@@ -5303,6 +5303,59 @@ def test_add_repository_with_refresh_token(self):
         body = json.loads(self.server.rest_params[0])
         self.assertEqual('refresh-token-value', body['cloud_credentials_refresh_token'])
 
+    def test_add_repository_with_worm(self):
+        """Test adding a repository with WORM compliance period"""
+        self.server_args['POST:/api/v1/cluster/self/repository/active/wormrepo'] = {}
+
+        self.no_error_run(self.command + [
+            '--id', 'wormrepo',
+            '--plan', 'daily',
+            '--location', '/backup/archive',
+            '--worm', '365'
+        ], self.server_args)
+        self.assertIn('POST:/api/v1/cluster/self/repository/active/wormrepo', self.server.trace)
+        self.assertIn('Added repository', self.str_output)
+        # Verify JSON body contains expected parameters
+        self.assertEqual(1, len(self.server.rest_params))
+        body = json.loads(self.server.rest_params[0])
+        self.assertEqual(365, body['worm'])
+
+    def test_add_repository_with_default_retention(self):
+        """Test adding a repository with default retention period"""
+        self.server_args['POST:/api/v1/cluster/self/repository/active/retentionrepo'] = {}
+
+        self.no_error_run(self.command + [
+            '--id', 'retentionrepo',
+            '--plan', 'daily',
+            '--location', '/backup/archive',
+            '--default-retention', '30'
+        ], self.server_args)
+        self.assertIn('POST:/api/v1/cluster/self/repository/active/retentionrepo', self.server.trace)
+        self.assertIn('Added repository', self.str_output)
+        # Verify JSON body contains expected parameters
+        self.assertEqual(1, len(self.server.rest_params))
+        body = json.loads(self.server.rest_params[0])
+        self.assertEqual(30, body['default_retention'])
+
+    def test_add_repository_with_cloud_retention_delete_versions(self):
+        """Test adding a cloud repository with retention delete versions enabled"""
+        self.server_args['POST:/api/v1/cluster/self/repository/active/deleteversionrepo'] = {}
+
+        self.no_error_run(self.command + [
+            '--id', 'deleteversionrepo',
+            '--plan', 'daily',
+            '--location', 's3://mybucket/backup',
+            '--cloud-credentials-name', 'my-aws-creds',
+            '--cloud-staging-dir', '/tmp/staging',
+            '--cloud-retention-delete-versions'
+        ], self.server_args)
+        self.assertIn('POST:/api/v1/cluster/self/repository/active/deleteversionrepo', self.server.trace)
+        self.assertIn('Added repository', self.str_output)
+        # Verify JSON body contains expected parameters
+        self.assertEqual(1, len(self.server.rest_params))
+        body = json.loads(self.server.rest_params[0])
+        self.assertTrue(body['cloud_retention_delete_versions'])
+
 
 class TestBackupServiceRepoArchive(CommandTest):
     """Test the backup-service repo-archive subcommand"""