MB-66624 Fix spelling mistakes

Change-Id: I25a4f49d289f80b610a588fc31b4dd3d25f8d10d
Reviewed-on: https://review.couchbase.org/c/couchbase-cli/+/227463
Reviewed-by: Matt Hall <matt.hall@couchbase.com>
Tested-by: Build Bot <build@couchbase.com>

Author: lubomarinski

cbmgr.py

@@ -478,7 +478,7 @@ def apply_default_port(nodes):
     Adds the default port if the port is missing.
 
     @type  nodes: string
-    @param nodes: A comma seprated list of nodes
+    @param nodes: A comma separated list of nodes
     @rtype:       array of strings
     @return:      The nodes with the port postfixed on each one
     """
@@ -1130,7 +1130,7 @@ def __init__(self):
                            choices=[128, 1024], help="Sets the number of magma vBuckets, "
                            "either 128 (the default) or 1024")
 
-        group.add_argument("--encryption-key", dest="encryption_key", metavar="<keyid>",
+        group.add_argument("--encryption-key", dest="encryption_key", metavar="<key_id>",
                            help="The key id of the encryption key to use on this bucket")
         group.add_argument("--dek-rotate-every", dest="dek_rotate_interval", metavar="<days>", type=(int),
                            help="How often to rotate the DEK for this bucket")
@@ -1384,7 +1384,7 @@ def __init__(self):
                            help="Sets the rank of this bucket in case of failover/rebalance. Buckets with larger "
                            "ranks are prioritised over buckets with smaller ranks")
 
-        group.add_argument("--encryption-key", dest="encryption_key", metavar="<keyid>",
+        group.add_argument("--encryption-key", dest="encryption_key", metavar="<key_id>",
                            help="The key id of the encryption key to use on this bucket")
         group.add_argument("--dek-rotate-every", dest="dek_rotate_interval", metavar="<days>", type=(int),
                            help="How often to rotate the DEK for this bucket")
@@ -2977,7 +2977,7 @@ def execute(self, opts):
                                  " --audit-log-rotate-size, --disabled-users, --disable-events] is required with"
                                  " --set"])
 
-            # Match the behavior in the WebUI, which is to internally translate the '/couchbase' postfix into '/local'
+            # Match the behaviour in the WebUI, which is to internally translate the '/couchbase' postfix into '/local'
             # see MB-46970 for more information.
             if opts.disabled_users is not None:
                 opts.disabled_users = re.sub(r'\/couchbase', '/local', opts.disabled_users)
@@ -3068,15 +3068,15 @@ def __init__(self):
                            + "Couchbase Server Enterprise Edition only.")
         group.add_argument("--failover-data-disk-period", dest="failover_on_data_disk_period",
                            metavar="<seconds>", type=(int),
-                           help="The amount of time the Data Serivce disk failures has to be happening for to trigger"
+                           help="The amount of time the Data Service disk failures has to be happening for to trigger"
                                 " an auto-failover")
         group.add_argument("--enable-failover-on-data-disk-non-responsive",
                            dest="enable_failover_on_data_disk_non_responsive", metavar="<1|0>", choices=["0", "1"],
                            help="Enable/disable auto-failover when the Data Service reports disk is not responsive. "
                            + "Couchbase Server Enterprise Edition only.")
         group.add_argument("--failover-data-disk-non-responsive-period",
                            dest="failover_on_data_disk_non_responsive_period", metavar="<seconds>", type=(int),
-                           help="The amount of time the Data Serivce disk non-responsiveness has to be happening for to"
+                           help="The amount of time the Data Service disk non-responsiveness has to be happening for to"
                                 " trigger an auto-failover")
         group.add_argument("--allow-failover-for-ephemeral-without-replica", metavar="<1|0>", choices=["0", "1"],
                            help="Whether to allow autofailover on nodes with an ephemeral buckets that do not have at "
@@ -3357,18 +3357,18 @@ def __init__(self):
                               help="Set the encryption settings of config/log/audit")
         group_me.add_argument("--list-keys", dest="list_keys", action="store_true", help="List the encryption keys")
         group_me.add_argument("--add-key", dest="add_key", action="store_true", help="Create a new encryption key")
-        group_me.add_argument("--edit-key", dest="edit_key", metavar="<keyid>", help="Edit an encryption key")
-        group_me.add_argument("--rotate-key", dest="rotate_key", metavar="<keyid>",
+        group_me.add_argument("--edit-key", dest="edit_key", metavar="<key_id>", help="Edit an encryption key")
+        group_me.add_argument("--rotate-key", dest="rotate_key", metavar="<key_id>",
                               help="Rotate the specified encryption key")
-        group_me.add_argument("--delete-key", dest="delete_key", metavar="<keyid>",
+        group_me.add_argument("--delete-key", dest="delete_key", metavar="<key_id>",
                               help="Delete the specified encryption key")
 
         # --set arguments
         group.add_argument("--target", dest="target", choices=["config", "log", "audit"],
                            help="The type of files to configure the encryption of")
         group.add_argument("--type", dest="encryption_type", choices=["disabled", "master-password", "key"],
                            help="The type of encryption to use")
-        group.add_argument("--key", dest="key", metavar="<keyid>",
+        group.add_argument("--key", dest="key", metavar="<key_id>",
                            help="The id of the key to encrypt these files with")
         group.add_argument("--dek-rotate-every", dest="dek_rotation_interval", metavar="<days>", type=(int),
                            help="The number of days the DEK should be rotated")
@@ -3410,12 +3410,12 @@ def __init__(self):
         group_encrypt_me = group.add_mutually_exclusive_group(required=False)
         group_encrypt_me.add_argument("--encrypt-with-master-password", dest="encrypt_with_master", action="store_true",
                                       help="Encrypt this key with the master password")
-        group_encrypt_me.add_argument("--encrypt-with-key", dest="encrypt_with_key", metavar="<keyid>",
+        group_encrypt_me.add_argument("--encrypt-with-key", dest="encrypt_with_key", metavar="<key_id>",
                                       help="Encrypt this key with another key", type=(int))
 
         group.add_argument("--kmip-operations", dest="kmip_ops", choices=["get", "encrypt-decrypt"],
                            help="What operations to use with the KMIP server")
-        group.add_argument("--kmip-key", dest="kmip_key", metavar="<keyid>", help="The key on the KMIP server to use")
+        group.add_argument("--kmip-key", dest="kmip_key", metavar="<key_id>", help="The key on the KMIP server to use")
         group.add_argument("--kmip-host", dest="kmip_host", metavar="<host>", help="The hostname of the KMIP server")
         group.add_argument("--kmip-port", dest="kmip_port", metavar="<port>", type=(int),
                            help="The port of the KMIP server")
@@ -3666,7 +3666,7 @@ def __init__(self):
                            help="Allow gsi compaction to run before this time (Circular mode only)")
         group.add_argument("--enable-gsi-compaction-abort", dest="enable_gsi_abort", metavar="<1|0>",
                            choices=["0", "1"],
-                           help="Abort gsi compaction if when run outside of the accepted interaval"
+                           help="Abort gsi compaction if when run outside of the accepted interval"
                            + "(Circular mode only)")
 
     @rest_initialiser(cluster_init_check=True, version_check=True)
@@ -4858,7 +4858,7 @@ def _create(self, opts):
         if opts.collection_migration == '1' and opts.collection_explicit_mappings == '1':
             _exit_if_errors(['cannot enable both collection migration and explicit mappings'])
         if opts.filter_skip and opts.filter is None:
-            _exit_if_errors(["--filter-expersion is needed with the --filter-skip-restream option"])
+            _exit_if_errors(["--filter-expression is needed with the --filter-skip-restream option"])
         _, errors = self.rest.create_xdcr_replication(opts.cluster_name, opts.to_bucket, opts.from_bucket, opts.chk_int,
                                                       opts.worker_batch_size, opts.doc_batch_size, opts.fail_interval,
                                                       opts.rep_thresh, opts.src_nozzles, opts.dst_nozzles,
@@ -4919,7 +4919,7 @@ def _settings(self, opts):
         if opts.replicator_id is None:
             _exit_if_errors(["--xdcr-replicator is needed to change a replicators settings"])
         if opts.filter_skip and opts.filter is None:
-            _exit_if_errors(["--filter-expersion is needed with the --filter-skip-restream option"])
+            _exit_if_errors(["--filter-expression is needed with the --filter-skip-restream option"])
         if opts.collection_migration == '1' and opts.collection_explicit_mappings == '1':
             _exit_if_errors(['cannot enable both collection migration and explicit mappings'])
         _, errors = self.rest.xdcr_replicator_settings(opts.chk_int, opts.worker_batch_size, opts.doc_batch_size,
@@ -5060,7 +5060,7 @@ def _set(self, opts):
 
     def _delete(self, opts):
         if opts.name is None:
-            _exit_if_errors(["--xdcr-cluster-name is required to deleta a cluster connection"])
+            _exit_if_errors(["--xdcr-cluster-name is required to delete a cluster connection"])
 
         _, errors = self.rest.delete_xdcr_reference(opts.name)
         _exit_if_errors(errors)
@@ -5266,7 +5266,7 @@ def _deploy_undeploy(self, opts, deploy):
 
         _, errors = self.rest.deploy_undeploy_function(opts.name, opts.bucket, opts.scope, deploy, opts.boundary)
         self._exit_if_function_not_found(opts, errors)
-        # For backwards compatability we don't want to error if you try to (un)deploy an (un)deployed function
+        # For backwards compatibility we don't want to error if you try to (un)deploy an (un)deployed function
         if errors is not None and len(errors) == 1 and isinstance(errors[0], str) and \
                 errors[0].endswith(f'already in {"deployed" if deploy else "undeployed"} state.'):
             _success(f'Function is already in {"deployed" if deploy else "undeployed"} state')
@@ -5724,7 +5724,7 @@ def execute(self, opts):
         if opts.new_pass is None:
             _exit_if_errors(["--new-password is required"])
 
-        _, rv = self.rest.user_change_passsword(opts.new_pass)
+        _, rv = self.rest.user_change_password(opts.new_pass)
         _exit_if_errors(rv)
         _success(f'Changed password for {opts.username}')
 
@@ -6078,7 +6078,7 @@ def execute(self, opts):
                             print(f'{ports:{column_size}}', end='')
                         print()
                     else:
-                        # For cluster_run and single node clusters there is no hostanme
+                        # For cluster_run and single node clusters there is no hostname
                         try:
                             print(f'{node["hostname"]}')
                         except KeyError:
@@ -6440,21 +6440,21 @@ def _get(rest):
         nodes, err = rest.nodes_info()
         _exit_if_errors(err)
         encrypted_nodes = []
-        unencrpyted_nodes = []
+        unencrypted_nodes = []
         for n in nodes:
             if n['nodeEncryption']:
                 encrypted_nodes.append(n['hostname'])
             else:
-                unencrpyted_nodes.append(n['hostname'])
+                unencrypted_nodes.append(n['hostname'])
 
         if len(encrypted_nodes) == len(nodes):
             print('Node-to-node encryption is enabled')
-        elif len(unencrpyted_nodes) == len(nodes):
+        elif len(unencrypted_nodes) == len(nodes):
             print('Node-to-node encryption is disabled')
         else:
             print('Cluster is in mixed mode')
             print(f'Nodes with encryption enabled: {encrypted_nodes}')
-            print(f'Nodes with encryption disabled: {unencrpyted_nodes}')
+            print(f'Nodes with encryption disabled: {unencrypted_nodes}')
 
     @staticmethod
     def get_man_page_name():
@@ -6794,7 +6794,7 @@ def remove_repository(self, repository_id: str, state: str, delete_repo: bool =
         """
         if not repository_id:
             _exit_if_errors(['--id is required'])
-        # the following is devided in two options to give better error messages depending if state is missing or if it
+        # the following is divided in two options to give better error messages depending if state is missing or if it
         # is invalid
         if not state:
             _exit_if_errors(['--state is required'])
@@ -6946,10 +6946,10 @@ def get_repository(self, repository_id, state, json_out=False):
         if json_out:
             print(json.dumps(repository, indent=2))
         else:
-            self.human_firendly_print_repository(repository)
+            self.human_friendly_print_repository(repository)
 
     @staticmethod
-    def human_firendly_print_repository(repository):
+    def human_friendly_print_repository(repository):
         """Print the repository in a human friendly format
 
         Args:
@@ -6969,7 +6969,7 @@ def human_firendly_print_repository(repository):
 
         if 'scheduled' in repository and repository['scheduled']:
             print()
-            BackupServiceRepository.human_firendly_print_repository_scheduled_tasks(repository['scheduled'])
+            BackupServiceRepository.human_friendly_print_repository_scheduled_tasks(repository['scheduled'])
 
         one_off = repository['running_one_off'] if 'running_one_off' in repository else None
         running_scheduled = repository['running_tasks'] if 'running_tasks' in repository else None
@@ -7008,7 +7008,7 @@ def human_friendly_print_running_tasks(one_off, scheduled):
             print(f'{task["name"]:<{name_pad}}| {task["type"].title():<10}| {task["status"]:<8} | {task["start"]}')
 
     @staticmethod
-    def human_firendly_print_repository_scheduled_tasks(scheduled):
+    def human_friendly_print_repository_scheduled_tasks(scheduled):
         """Print the scheduled task in a tabular format"""
         name_pad = 5
         for name in scheduled:
@@ -7108,7 +7108,7 @@ def __init__(self, subparser):
 
     @rest_initialiser(version_check=True, enterprise_check=True, cluster_init_check=True)
     def execute(self, opts):
-        """Run the backup plan managment command"""
+        """Run the backup plan management command"""
         if opts.list:
             self.list_plans(opts.output == 'json')
         elif opts.get:
@@ -7201,7 +7201,7 @@ def human_print_plan(plan: object):
         print(f'Name: {plan["name"]}')
         print(f'Description: {plan["description"] if "description" in plan else "N/A"}')
         print(f'Services: {BackupServicePlan.service_list_to_str(plan["services"])}')
-        print(f'Default: {(plan["default"] if "deafult" in plan else False)!s}')
+        print(f'Default: {(plan["default"] if "default" in plan else False)!s}')
 
         # If the are no tasks return
         if not plan["tasks"]:

cluster_manager.py

@@ -407,7 +407,7 @@ def set_master_pwd(self, password):
         params = {"newPassword": password}
         return self._post_form_encoded(url, params)
 
-    def user_change_passsword(self, new_password):
+    def user_change_password(self, new_password):
         url = f'{self.hostname}/controller/changePassword'
         params = {'password': new_password}
         return self._post_form_encoded(url, params)
@@ -1073,17 +1073,17 @@ def create_key(self, name, typ, usages, data):
         params = {'name': name, 'type': typ, 'usage': usages, 'data': data}
         return self._post_json(url, params)
 
-    def edit_key(self, keyid, name, typ, usages, data):
-        url = f'{self.hostname}/settings/encryptionKeys/{keyid}'
+    def edit_key(self, key_id, name, typ, usages, data):
+        url = f'{self.hostname}/settings/encryptionKeys/{key_id}'
         params = {'name': name, 'type': typ, 'usage': usages, 'data': data}
         return self._put_json(url, params)
 
-    def rotate_key(self, keyid):
-        url = f'{self.hostname}/controller/rotateEncryptionKey/{keyid}'
+    def rotate_key(self, key_id):
+        url = f'{self.hostname}/controller/rotateEncryptionKey/{key_id}'
         return self._post_form_encoded(url, None)
 
-    def delete_key(self, keyid):
-        url = f'{self.hostname}/settings/encryptionKeys/{keyid}'
+    def delete_key(self, key_id):
+        url = f'{self.hostname}/settings/encryptionKeys/{key_id}'
         return self._delete(url, None)
 
     def create_bucket(
@@ -2047,9 +2047,9 @@ def set_certificate(self, pkey_settings, is_client_cert=False):
 
         Grabs chain.pem and pkey.pem from the <data folder>/inbox/ directory and
         applies them to the node. chain.pem contains the chain encoded certificates
-        starting from the node certificat and ending with the last intermediate
+        starting from the node certificate and ending with the last intermediate
         certificate before cluster CA. pkey.pem contains the pem encoded private
-        key for node certifiactes. Both files should exist on the server before
+        key for node certificates. Both files should exist on the server before
         this API is called."""
         params = {}
 
@@ -2368,14 +2368,14 @@ def export_functions(self):
         url = f'{hosts[0]}/api/v1/export'
         return self._get(url)
 
-    def import_functions(self, parms):
+    def import_functions(self, params):
         hosts, errors = self.get_hostnames_for_service(EVENT_SERVICE)
         if errors:
             return None, errors
         if not hosts:
             raise ServiceNotAvailableException(EVENT_SERVICE)
         url = f'{hosts[0]}/api/v1/import'
-        return self._post_json(url, parms)
+        return self._post_json(url, params)
 
     def delete_function(self, function, bucket, scope):
         hosts, errors = self.get_hostnames_for_service(EVENT_SERVICE)
@@ -2671,8 +2671,8 @@ def delete_backup_repository(self, repository_id: str, state: str, delete_repo:
         """Delete a backup repository
         Args:
             repository_id (str): The id to be deleted.
-            state (str): The state in which the isntance to be deleted is.
-            delete_repo (bool): Wheter or not to delete the backup Repository.
+            state (str): The state in which the instance to be deleted is.
+            delete_repo (bool): Whether or not to delete the backup Repository.
             cluster (str): Only 'self' is supported.
         """
         hosts, errors = self.get_hostnames_for_service(BACKUP_SERVICE)
@@ -2942,7 +2942,7 @@ def get_columnar_settings(self):
 
         return self._get(url)
 
-    def _columar_link_url(self, name):
+    def _columnar_link_url(self, name):
         hosts, errors = self.get_hostnames_for_service(CBAS_SERVICE)
         if errors:
             return None, errors
@@ -2953,22 +2953,22 @@ def _columar_link_url(self, name):
         return f'{hosts[0]}/api/v1/link{("/" + urllib.parse.quote_plus(name)) if name else ""}', None
 
     def set_columnar_link(self, opts):
-        url, errors = self._columar_link_url(opts.name)
+        url, errors = self._columnar_link_url(opts.name)
         if errors:
             return None, errors
 
         send_json = self._put_json if opts.edit else self._post_json
         return send_json(url, opts.parsed_link_details)
 
     def delete_columnar_link(self, opts):
-        url, errors = self._columar_link_url(opts.name)
+        url, errors = self._columnar_link_url(opts.name)
         if errors:
             return None, errors
 
         return self._delete(url, None)
 
     def get_columnar_links(self, opts):
-        url, errors = self._columar_link_url(opts.name)
+        url, errors = self._columnar_link_url(opts.name)
         if errors:
             return None, errors