MB-55692 Add support for editing collections history field

Change-Id: I601f493f46b858f7f316ed8d9353682205667a1f
Reviewed-on: https://review.couchbase.org/c/couchbase-cli/+/187445
Well-Formed: Restriction Checker
Tested-by: Build Bot <build@couchbase.com>
Reviewed-by: James Lee <james.lee@couchbase.com>

Author: yonsken

cbmgr.py

@@ -4721,6 +4721,8 @@ def __init__(self):
                            help="List all of the scopes in the bucket")
         group.add_argument("--create-collection", dest="create_collection", metavar="<collection>", default=None,
                            help="The path to the collection to make")
+        group.add_argument("--edit-collection", dest="edit_collection", metavar="<collection>", default=None,
+                           help="The path to the collection to edit")
         group.add_argument("--drop-collection", dest="drop_collection", metavar="<collection>", default=None,
                            help="The path to the collection to remove")
         group.add_argument("--list-collections", dest="list_collections", metavar="<scope_list>", default=None,
@@ -4733,12 +4735,12 @@ def __init__(self):
 
     @rest_initialiser(cluster_init_check=True, version_check=True)
     def execute(self, opts):
-        cmds = [opts.create_scope, opts.drop_scope, opts.list_scopes, opts.create_collection, opts.drop_collection,
-                opts.list_collections]
+        cmds = [opts.create_scope, opts.drop_scope, opts.list_scopes, opts.create_collection, opts.edit_collection,
+                opts.drop_collection, opts.list_collections]
         cmd_total = sum(cmd is not None for cmd in cmds)
 
-        args = "--create-scope, --drop-scope, --list-scopes, --create-collection, --drop-collection, or " \
-               "--list-collections"
+        args = "--create-scope, --drop-scope, --list-scopes, --create-collection, --edit-collection, " \
+               "--drop-collection, or --list-collections"
         if cmd_total == 0:
             _exit_if_errors([f'Must specify one of the following: {args}'])
         elif cmd_total != 1:
@@ -4747,8 +4749,14 @@ def execute(self, opts):
         if opts.max_ttl is not None and opts.create_collection is None:
             _exit_if_errors(["--max-ttl can only be set with --create-collection"])
 
-        if opts.enable_history is not None and opts.create_collection is None:
-            _exit_if_errors(["--enable-history-retention can only be set with --create-collection"])
+        if opts.enable_history is not None and opts.create_collection is None and opts.edit_collection is None:
+            _exit_if_errors(["--enable-history-retention can only be set with --create-collection or "
+                             "--edit-collection"])
+
+        if opts.edit_collection is not None and opts.enable_history is None:
+            _exit_if_errors(["--enable-history-retention should be set with --edit-collection"])
+        if opts.edit_collection is not None and opts.max_ttl is not None:
+            _exit_if_errors(["--max-ttl cannot be set with --edit-collection"])
 
         if opts.create_scope:
             self._create_scope(opts)
@@ -4758,6 +4766,8 @@ def execute(self, opts):
             self._list_scopes(opts)
         if opts.create_collection:
             self._create_collection(opts)
+        if opts.edit_collection:
+            self._edit_collection(opts)
         if opts.drop_collection:
             self._drop_collection(opts)
         if opts.list_collections is not None:
@@ -4785,6 +4795,12 @@ def _create_collection(self, opts):
         _exit_if_errors(errors)
         _success("Collection created")
 
+    def _edit_collection(self, opts):
+        scope, collection = self._get_scope_collection(opts.edit_collection)
+        _, errors = self.rest.edit_collection(opts.bucket, scope, collection, opts.enable_history)
+        _exit_if_errors(errors)
+        _success("Collection edited")
+
     def _drop_collection(self, opts):
         scope, collection = self._get_scope_collection(opts.drop_collection)
         _, errors = self.rest.drop_collection(opts.bucket, scope, collection)

cluster_manager.py

@@ -2233,8 +2233,17 @@ def create_collection(self, bucket, scope, collection, max_ttl, enable_history):
 
         return self._post_form_encoded(url, params)
 
+    def edit_collection(self, bucket, scope, collection, enable_history):
+        url = f'{self.hostname}/pools/default/buckets/{urllib.parse.quote_plus(bucket)}/scopes/' \
+            f'{urllib.parse.quote_plus(scope)}/collections/{urllib.parse.quote_plus(collection)}'
+        params = {}
+        if enable_history:
+            params["history"] = one_zero_boolean_to_string(enable_history)
+
+        return self._patch_form_encoded(url, params)
+
     def drop_collection(self, bucket, scope, collection):
-        url = f'{self.hostname}/pools/default/buckets/{urllib.parse.quote_plus(bucket)}/scopes/'\
+        url = f'{self.hostname}/pools/default/buckets/{urllib.parse.quote_plus(bucket)}/scopes/' \
             f'{urllib.parse.quote_plus(scope)}/collections/{urllib.parse.quote_plus(collection)}'
         return self._delete(url, None)
 
@@ -2406,6 +2415,21 @@ def _post_json(self, url, params):
         return self._handle_response(self.session.post(url, auth=(self.username, self.password), json=params,
                                                        verify=self.ca_cert, timeout=self.timeout, headers=self.headers))
 
+    @request
+    def _patch_form_encoded(self, url, params):
+        if self.debug:
+            print(f'PATCH {url} {self._url_encode_params(params)}')
+
+        return self._handle_response(
+            self.session.patch(
+                url, auth=(
+                    self.username,
+                    self.password),
+                data=params,
+                verify=self.ca_cert,
+                timeout=self.timeout,
+                headers=self.headers))
+
     @request
     def _patch_json(self, url, params):
         if self.debug:

docs/modules/cli/pages/cbcli/couchbase-cli-collection-manage.adoc

@@ -16,9 +16,9 @@ _couchbase-cli collection-manage_ [--cluster <url>] [--username <user>]
     [--password <password>] [--client-cert <path>] [--client-cert-password <password>]
     [--client-key <path>] [--client-key-password <password>] [--bucket <bucket>]
     [--create-scope <scope>] [--drop-scope <scope>] [--list-scopes]
-    [--create-collection <collection>] [--drop-collection <collection>]
-    [--list-collections [<scope_list>]] [--max-ttl <seconds>]
-    [--enable-history-retention <0|1>]
+    [--create-collection <collection>] [--edit-collection <collection>]
+    [--drop-collection <collection>] [--list-collections [<scope_list>]]
+    [--max-ttl <seconds>] [--enable-history-retention <0|1>]
 
 == DESCRIPTION
 
@@ -58,6 +58,11 @@ include::{partialsdir}/cbcli/part-common-options.adoc[]
   format (scope.collection), specifying the scope in which the
   collection and the name to be created.
 
+--edit-collection <collection>::
+  Edits the collection in the scope. The option takes a path in dot
+  format (scope.collection), specifying the collection in a scope which is
+  to be edited.
+
 --drop-collection <collection>::
   Removes the collection from the scope. The option takes a path in
   dot format (scope.collection), specifying the scope from which
@@ -73,12 +78,14 @@ include::{partialsdir}/cbcli/part-common-options.adoc[]
   collection, in seconds. If enabled and a document is mutated with
   no TTL or a TTL greater than than the maximum, its TTL will be set
   to the maximum TTL. Setting this option to 0 disables the use of
-  max-TTL, and the largest TTL that is allowed is 2147483647.
+  max-TTL, and the largest TTL that is allowed is 2147483647. This setting
+  cannot be edited after a collection has been created.
 
 --enable-history-retention <0|1>::
   Specifies whether or not the document history retention should be enabled for
   the collection. To enable the document history retention, set this option to
   "1". To disable the document history retention, set this option to "0".
+  This setting can be edited after a collection has been created.
 
 
 include::{partialsdir}/cbcli/part-host-formats.adoc[]
@@ -98,6 +105,13 @@ furniture bucket.
   $ couchbase-cli collection-manage -c 192.168.1.5 -u Administrator \
    -p password --bucket furniture --create-collection chairs.couches
 
+To edit the collection called "couches" in the chairs scope in the furniture
+bucket.
+
+  $ couchbase-cli collection-manage -c 192.168.1.5 -u Administrator \
+   -p password --bucket furniture --edit-collection chairs.couches
+   --enable-history-retention 1
+
 To list all of the collections in the chairs and tables scopes in the furniture
 bucket.
 

test/mock_server.py

@@ -518,6 +518,7 @@ def export_eventing_functions(rest_params=None, server_args=None, path="", endpo
     (r'/pools/default/buckets/\w+/scopes/\w+$', {'DELETE': do_nothing}),
     (r'/pools/default/buckets/\w+/scopes/\w+/collections$', {'POST': do_nothing}),
     (r'/pools/default/buckets/\w+/scopes/\w+/collections/\w+$', {'DELETE': do_nothing}),
+    (r'/pools/default/buckets/\w+/scopes/\w+/collections/\w+$', {'PATCH': do_nothing}),
     (r'/pools/default/trustedCAs/\d+$', {'DELETE': get_by_path}),
     (r'/pools/nodes', {'GET': get_by_path}),
     (r'/settings/analytics', {'POST': do_nothing, 'GET': get_by_path}),

test/test_cli.py

@@ -2718,6 +2718,36 @@ def setUp(self):
         self.server_args = {'enterprise': True, 'init': True, 'is_admin': True}
         super(TestCollectionManage, self).setUp()
 
+    def test_missing_cmd(self):
+        self.system_exit_run(self.command + ['--max-ttl', '100'], self.server_args)
+        self.assertIn("Must specify one of the following: --create-scope, --drop-scope, --list-scopes, "
+                      "--create-collection, --edit-collection, --drop-collection, or --list-collections",
+                      self.str_output)
+
+    def test_more_than_one_cmd(self):
+        self.system_exit_run(self.command + ['--create-scope', 'scope_1', '--list-collections'], self.server_args)
+        self.assertIn("Only one of the following may be specified: --create-scope, --drop-scope, --list-scopes, "
+                      "--create-collection, --edit-collection, --drop-collection, or --list-collections",
+                      self.str_output)
+
+    def test_max_ttl_set_with_not_create_collection(self):
+        self.system_exit_run(self.command + ['--list-collections', '--max-ttl', '100'], self.server_args)
+        self.assertIn("--max-ttl can only be set with --create-collection", self.str_output)
+
+    def test_enable_history_set_with_not_create_collection_or_edit_collection(self):
+        self.system_exit_run(self.command + ['--list-collections', '--enable-history-retention', '1'], self.server_args)
+        self.assertIn("--enable-history-retention can only be set with --create-collection or --edit-collection",
+                      self.str_output)
+
+    def test_enable_history_should_be_set_with_edit_collection(self):
+        self.system_exit_run(self.command + ['--edit-collection', 'scope_1.collection_1'], self.server_args)
+        self.assertIn("--enable-history-retention should be set with --edit-collection", self.str_output)
+
+    def test_max_ttl_cannot_be_set_with_edit_collection(self):
+        self.system_exit_run(self.command + ['--edit-collection', 'scope_1.collection_1', "--max-ttl", "100"],
+                             self.server_args)
+        self.assertIn("--max-ttl can only be set with --create-collection", self.str_output)
+
     def test_create_scope(self):
         self.no_error_run(self.command + ['--create-scope', 'scope_1'], self.server_args)
         self.assertIn('POST:/pools/default/buckets/name/scopes', self.server.trace)
@@ -2743,6 +2773,13 @@ def test_create_collection(self):
         expected_params = ['name=collection_1', 'maxTTL=100', 'history=true']
         self.rest_parameter_match(expected_params)
 
+    def test_edit_collection(self):
+        self.no_error_run(self.command + ['--edit-collection', 'scope_1.collection_1', '--enable-history-retention',
+                                          '1'], self.server_args)
+        self.assertIn('PATCH:/pools/default/buckets/name/scopes/scope_1/collections/collection_1', self.server.trace)
+        expected_params = ['history=true']
+        self.rest_parameter_match(expected_params)
+
     def test_delete_collection(self):
         self.no_error_run(self.command + ['--drop-collection', 'scope_1.collection_1'], self.server_args)
         self.assertIn('DELETE:/pools/default/buckets/name/scopes/scope_1/collections/collection_1', self.server.trace)