MB-70102 Add subcommands for pausing/resuming backup service repos

This is needed because worm can only be enabled for a paused repo so
without this it would not be possible to configure WORM just trough the
CLI.

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

Author: lubomarinski

cbmgr.py

@@ -7001,12 +7001,14 @@ def __init__(self):
         self.repo_add_cmd = BackupServiceRepoAdd(self.subparser)
         self.repo_archive_cmd = BackupServiceRepoArchive(self.subparser)
         self.repo_remove_cmd = BackupServiceRepoRemove(self.subparser)
+        self.repo_pause_cmd = BackupServiceRepoPause(self.subparser)
+        self.repo_resume_cmd = BackupServiceRepoResume(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',
-                       'plan', 'node-threads']
+                       'repo-pause', 'repo-resume', '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}'])
@@ -7025,6 +7027,10 @@ def execute(self, opts):
             self.repo_archive_cmd.execute(opts)
         elif opts.sub_cmd == 'repo-remove':
             self.repo_remove_cmd.execute(opts)
+        elif opts.sub_cmd == 'repo-pause':
+            self.repo_pause_cmd.execute(opts)
+        elif opts.sub_cmd == 'repo-resume':
+            self.repo_resume_cmd.execute(opts)
         elif opts.sub_cmd == 'plan':
             self.plan_cmd.execute(opts)
         elif opts.sub_cmd == 'node-threads':
@@ -7474,6 +7480,64 @@ def get_description():
         return 'Remove a repository'
 
 
+class BackupServiceRepoPause:
+    """Pause a repository.
+    """
+
+    def __init__(self, subparser):
+        """setup the parser"""
+        self.rest = None
+        repository_parser = subparser.add_parser('repo-pause', help='Pause a repository', add_help=False,
+                                                 allow_abbrev=False)
+
+        repository_parser.add_argument('--id', metavar='<id>', help='The 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-pause subcommand"""
+
+        _, errors = self.rest.pause_backup_repository(opts.id)
+        _exit_if_errors(errors)
+        _success('Repository was paused')
+
+    @staticmethod
+    def get_man_page_name():
+        return get_doc_page_name("couchbase-cli-backup-service-repo-pause")
+
+    @staticmethod
+    def get_description():
+        return 'Pause a repository'
+
+
+class BackupServiceRepoResume:
+    """Resume a repository.
+    """
+
+    def __init__(self, subparser):
+        """setup the parser"""
+        self.rest = None
+        repository_parser = subparser.add_parser('repo-resume', help='Resume a repository', add_help=False,
+                                                 allow_abbrev=False)
+
+        repository_parser.add_argument('--id', metavar='<id>', help='The 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-resume subcommand"""
+
+        _, errors = self.rest.resume_backup_repository(opts.id)
+        _exit_if_errors(errors)
+        _success('Repository was resumed')
+
+    @staticmethod
+    def get_man_page_name():
+        return get_doc_page_name("couchbase-cli-backup-service-repo-resume")
+
+    @staticmethod
+    def get_description():
+        return 'Resume a repository'
+
+
 class BackupServiceRepository:
     """(Deprecated) This command manages backup services repositories.
 

cluster_manager.py

@@ -2651,7 +2651,7 @@ def archive_backup_repository(self, repository_id, new_id, cluster='self'):
         """Archive an active repository
 
         Args:
-            repository_id (str): The repository id to be retrieved
+            repository_id (str): The repository id
             new_id (str): The id that will be given to the archived repository
             cluster (str): Only 'self' is supported.
         """
@@ -2665,6 +2665,36 @@ def archive_backup_repository(self, repository_id, new_id, cluster='self'):
         return self._post_json(f'{hosts[0]}/api/v1/cluster/{cluster}/repository/active/{repository_id}/archive',
                                {'id': new_id})
 
+    def pause_backup_repository(self, repository_id):
+        """Pause an active repository
+
+        Args:
+            repository_id (str): The repository id
+        """
+        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}/pause', None)
+
+    def resume_backup_repository(self, repository_id):
+        """Resume an active repository
+
+        Args:
+            repository_id (str): The repository id
+        """
+        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}/resume', None)
+
     def add_backup_active_repository(self, repository_id: str, body: Dict[str, Any], cluster: str = 'self'):
         """Archive an active repository
 

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

@@ -8,7 +8,9 @@
  ** 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-pause.adoc[backup-service repo-pause]
  ** xref:cli:cbcli/couchbase-cli-backup-service-repo-remove.adoc[backup-service repo-remove]
+ ** xref:cli:cbcli/couchbase-cli-backup-service-repo-resume.adoc[backup-service repo-resume]
  ** 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-pause.adoc

@@ -0,0 +1,72 @@
+= couchbase-cli-backup-service-repo-pause(1)
+:description: Pause a backup service repository
+ifndef::doctype-manpage[:doctitle: backup-service repo-pause]
+
+ifdef::doctype-manpage[]
+== NAME
+
+couchbase-cli-backup-service-repo-pause -
+endif::[]
+Pause 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-pause_ [--id <id>]
+
+== DESCRIPTION
+
+Pauses an active backup repository. When a repository is paused, all scheduled
+backup and merge tasks for that repository are temporarily suspended. The
+repository remains in the active state but no new backup operations will be
+started until the repository is resumed.
+
+This command is useful when you need to temporarily stop backup operations,
+for example during maintenance windows or when troubleshooting issues, without
+permanently archiving the repository.
+
+== OPTIONS
+
+--id <id>::
+    The ID of the active repository to pause. This argument is required.
+
+include::{partialsdir}/cbcli/part-common-options.adoc[]
+
+include::{partialsdir}/cbcli/part-host-formats.adoc[]
+
+include::{partialsdir}/cbcli/part-certificate-authentication.adoc[]
+
+== EXAMPLES
+
+To pause an active repository with ID 'weekly-backup', run the following
+command.
+
+----
+$ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p password \
+  repo-pause --id weekly-backup
+----
+
+To resume backup operations for the paused repository, use the `repo-resume`
+command.
+
+----
+$ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p password \
+  repo-resume --id weekly-backup
+----
+
+== 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-resume[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-resume.adoc

@@ -0,0 +1,63 @@
+= couchbase-cli-backup-service-repo-resume(1)
+:description: Resume a backup service repository
+ifndef::doctype-manpage[:doctitle: backup-service repo-resume]
+
+ifdef::doctype-manpage[]
+== NAME
+
+couchbase-cli-backup-service-repo-resume -
+endif::[]
+Resume 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-resume_ [--id <id>]
+
+== DESCRIPTION
+
+Resumes a paused backup repository. When a repository is resumed, all scheduled
+backup and merge tasks that were previously suspended will be reactivated. The
+repository will continue running backup operations according to its configured
+schedule.
+
+This command is used to restore normal backup operations for a repository that
+was previously paused.
+
+== OPTIONS
+
+--id <id>::
+    The ID of the repository to resume. This argument is required.
+
+include::{partialsdir}/cbcli/part-common-options.adoc[]
+
+include::{partialsdir}/cbcli/part-host-formats.adoc[]
+
+include::{partialsdir}/cbcli/part-certificate-authentication.adoc[]
+
+== EXAMPLES
+
+To resume a paused repository with ID 'weekly-backup', run the following
+command.
+
+----
+$ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p password \
+  repo-resume --id weekly-backup
+----
+
+== 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-pause[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.adoc

@@ -49,6 +49,12 @@ man:couchbase-cli-backup-service-repo-archive[1]::
 man:couchbase-cli-backup-service-repo-remove[1]::
   Remove a backup service repository.
 
+man:couchbase-cli-backup-service-repo-pause[1]::
+  Pause a backup service repository.
+
+man:couchbase-cli-backup-service-repo-resume[1]::
+  Resume a backup service repository.
+
 include::{partialsdir}/cbcli/part-host-formats.adoc[]
 
 include::{partialsdir}/cbcli/part-certificate-authentication.adoc[]

test/mock_server.py

@@ -630,6 +630,8 @@ def export_eventing_functions(rest_params=None, server_args=None, path="", endpo
     (r'/api/v1/config', {'GET': get_by_path, 'PATCH': do_nothing}),
     (r'/api/v1/cluster/self/repository/(:?active|archived|imported)$', {'GET': get_by_path}),
     (r'/api/v1/cluster/self/repository/active/\w+/archive$', {'POST': do_nothing}),
+    (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/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

@@ -5410,6 +5410,60 @@ def test_remove_repository_without_delete_data(self):
         self.assertIn('remove_repository=False', self.server.queries)
 
 
+class TestBackupServiceRepoPause(CommandTest):
+    """Test the backup-service repo-pause 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-pause']
+        super(TestBackupServiceRepoPause, self).setUp()
+
+    def test_missing_id(self):
+        """Test that the command fails if --id is not provided"""
+        self.system_exit_run(self.command, self.server_args)
+        self.assertIn('--id', self.str_error)
+        self.assertIn('required', self.str_error)
+
+    def test_pause_repository_success(self):
+        """Test that the command successfully pauses a repository"""
+        self.no_error_run(self.command + ['--id', 'myrepo'], self.server_args)
+        self.assertIn('POST:/api/v1/cluster/self/repository/active/myrepo/pause', self.server.trace)
+        self.assertIn('Repository was paused', self.str_output)
+
+
+class TestBackupServiceRepoResume(CommandTest):
+    """Test the backup-service repo-resume 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-resume']
+        super(TestBackupServiceRepoResume, self).setUp()
+
+    def test_missing_id(self):
+        """Test that the command fails if --id is not provided"""
+        self.system_exit_run(self.command, self.server_args)
+        self.assertIn('--id', self.str_error)
+        self.assertIn('required', self.str_error)
+
+    def test_resume_repository_success(self):
+        """Test that the command successfully resumes a repository"""
+        self.no_error_run(self.command + ['--id', 'myrepo'], self.server_args)
+        self.assertIn('POST:/api/v1/cluster/self/repository/active/myrepo/resume', self.server.trace)
+        self.assertIn('Repository was resumed', self.str_output)
+
+
 class TestBackupServiceSettings(CommandTest):
     """Test the backup-service settings subcommand"""