MB-70103 Add backup-service repo-archive command

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

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

Author: lubomarinski

cbmgr.py

@@ -6999,11 +6999,13 @@ def __init__(self):
         self.repo_list_cmd = BackupServiceRepoList(self.subparser)
         self.repo_get_cmd = BackupServiceRepoGet(self.subparser)
         self.repo_add_cmd = BackupServiceRepoAdd(self.subparser)
+        self.repo_archive_cmd = BackupServiceRepoArchive(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', 'plan', 'node-threads']
+        subcommands = ['settings', 'repository', 'repo-list', 'repo-get', 'repo-add', 'repo-archive', '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}'])
@@ -7018,6 +7020,8 @@ def execute(self, opts):
             self.repo_get_cmd.execute(opts)
         elif opts.sub_cmd == 'repo-add':
             self.repo_add_cmd.execute(opts)
+        elif opts.sub_cmd == 'repo-archive':
+            self.repo_archive_cmd.execute(opts)
         elif opts.sub_cmd == 'plan':
             self.plan_cmd.execute(opts)
         elif opts.sub_cmd == 'node-threads':
@@ -7400,6 +7404,37 @@ def get_description():
         return 'Adds a new active repository'
 
 
+class BackupServiceRepoArchive:
+    """Archive a repository. The archived repository will have a new id.
+    """
+
+    def __init__(self, subparser):
+        """setup the parser"""
+        self.rest = None
+        repository_parser = subparser.add_parser('repo-archive', help='Archive a 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('--new-id', metavar='<id>', help='The new repository id', required=True)
+
+    @rest_initialiser(version_check=True, enterprise_check=True, cluster_init_check=True)
+    def execute(self, opts):
+        """Run the backup-service repo-archive subcommand"""
+
+        _, errors = self.rest.archive_backup_repository(opts.id, opts.new_id)
+        _exit_if_errors(errors)
+        _success('Repository was archived')
+
+    @staticmethod
+    def get_man_page_name():
+        return get_doc_page_name("couchbase-cli-backup-service-repo-archive")
+
+    @staticmethod
+    def get_description():
+        return 'Archive a repository'
+
+
 class BackupServiceRepository:
     """This command manages backup services repositories.
 

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

@@ -5,6 +5,7 @@
  ** xref:cli:cbcli/couchbase-cli-backup-service-nodes-threads-map.adoc[backup-service nodes-threads-map]
  ** 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-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-repository.adoc[backup-service repository]

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

@@ -184,7 +184,9 @@ 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-list[1],
+man:couchbase-cli-backup-service-repo-archive[1],
 man:couchbase-cli-backup-service-plan[1]
 
+
 include::{partialsdir}/cbcli/part-footer.adoc[]
 

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

@@ -0,0 +1,85 @@
+= couchbase-cli-backup-service-repo-archive(1)
+:description: Archive a backup service repository
+ifndef::doctype-manpage[:doctitle: backup-service repo-archive]
+
+ifdef::doctype-manpage[]
+== NAME
+
+couchbase-cli-backup-service-repo-archive -
+endif::[]
+Archive 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-archive_ [--id <id>]
+    [--new-id <new_id>]
+
+== DESCRIPTION
+
+Archives an active backup repository. When a repository is archived, it is
+moved from the active state to the archived state and is assigned a new ID.
+This action is not reversible. Archived repositories no longer run scheduled
+backup tasks but their data remains accessible for restore operations.
+
+This command is useful when you want to stop scheduled backups for a repository
+while keeping the backup data available.
+
+== OPTIONS
+
+--id <id>::
+    The ID of the active repository to archive. This argument is required.
+
+--new-id <new_id>::
+    The new ID to assign to the archived repository. This argument is required.
+    The new ID must be unique and cannot conflict with existing repository IDs.
+
+include::{partialsdir}/cbcli/part-common-options.adoc[]
+
+include::{partialsdir}/cbcli/part-host-formats.adoc[]
+
+include::{partialsdir}/cbcli/part-certificate-authentication.adoc[]
+
+== EXAMPLES
+
+To archive an active repository with ID 'weekly-backup' and assign it a new
+ID of 'weekly-backup-archived', run the following command.
+
+----
+$ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p password \
+  repo-archive --id weekly-backup --new-id weekly-backup-archived
+----
+
+After archiving, the repository will no longer run scheduled backup tasks.
+You can verify the repository has been archived using the `repo-get` command
+with the `--state archived` flag.
+
+----
+$ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p password \
+  repo-get --id weekly-backup-archived --state archived
+
+ID: weekly-backup-archived
+State: archived
+Healthy: True
+Archive: /path/to/archive
+Repository: 179a36cc-2ad9-4360-a080-42ddc98e53c7
+plan: _daily_backups
+Creation time: 2025-12-19T14:15:02.29496Z
+----
+
+== 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]
+
+include::{partialsdir}/cbcli/part-footer.adoc[]
+

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

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

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

@@ -113,7 +113,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-add[1],
+man:couchbase-cli-backup-service-repo-archive[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-get[1]::
 man:couchbase-cli-backup-service-repo-add[1]::
   Add a new backup service repository.
 
+man:couchbase-cli-backup-service-repo-archive[1]::
+  Archive a backup service repository.
+
 include::{partialsdir}/cbcli/part-host-formats.adoc[]
 
 include::{partialsdir}/cbcli/part-certificate-authentication.adoc[]

test/test_cli.py

@@ -5304,6 +5304,49 @@ def test_add_repository_with_refresh_token(self):
         self.assertEqual('refresh-token-value', body['cloud_credentials_refresh_token'])
 
 
+class TestBackupServiceRepoArchive(CommandTest):
+    """Test the backup-service repo-archive 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-archive']
+        super(TestBackupServiceRepoArchive, self).setUp()
+
+    def test_missing_id(self):
+        """Test that the command fails if --id is not provided"""
+        self.system_exit_run(self.command + ['--new-id', 'archivedrepo'], self.server_args)
+        self.assertIn('--id', self.str_error)
+        self.assertIn('required', self.str_error)
+
+    def test_missing_new_id(self):
+        """Test that the command fails if --new-id is not provided"""
+        self.system_exit_run(self.command + ['--id', 'activerepo'], self.server_args)
+        self.assertIn('--new-id', self.str_error)
+        self.assertIn('required', self.str_error)
+
+    def test_archive_repository_success(self):
+        """Test that the command successfully archives a repository with both required parameters"""
+        self.no_error_run(self.command + ['--id', 'activerepo', '--new-id', 'archivedrepo'], self.server_args)
+        self.assertIn('POST:/api/v1/cluster/self/repository/active/activerepo/archive', self.server.trace)
+        self.assertIn('Repository was archived', self.str_output)
+
+    def test_archive_repository_request_body(self):
+        """Test that the correct JSON body is sent in the archive request"""
+        self.no_error_run(self.command + ['--id', 'weeklybackup', '--new-id', 'weeklybackup_archived'],
+                          self.server_args)
+        self.assertIn('POST:/api/v1/cluster/self/repository/active/weeklybackup/archive', self.server.trace)
+        # Verify JSON body contains expected parameters
+        self.assertEqual(1, len(self.server.rest_params))
+        body = json.loads(self.server.rest_params[0])
+        self.assertEqual('weeklybackup_archived', body['id'])
+
+
 class TestBackupServiceSettings(CommandTest):
     """Test the backup-service settings subcommand"""