Fix more typos (#7439)

* Fix more typos in plugins/.

* Fix typos in tests/unit/.

* Fix typos in tests/integration/.

* Fix more typos.

Co-authored-by: Sebastian Gumprich <rndmh3ro@users.noreply.github.com>

---------

Co-authored-by: Sebastian Gumprich <rndmh3ro@users.noreply.github.com>

plugins/action/iptables_state.py

@@ -44,7 +44,7 @@ class ActionModule(ActionBase):
 
     def _async_result(self, async_status_args, task_vars, timeout):
         '''
-        Retrieve results of the asynchonous task, and display them in place of
+        Retrieve results of the asynchronous task, and display them in place of
         the async wrapper results (those with the ansible_job_id key).
         '''
         async_status = self._task.copy()

plugins/cache/redis.py

@@ -150,7 +150,7 @@ class CacheModule(BaseCacheModule):
         # format: "localhost:26379;localhost2:26379;0:changeme"
         connections = uri.split(';')
         connection_args = connections.pop(-1)
-        if len(connection_args) > 0:  # hanle if no db nr is given
+        if len(connection_args) > 0:  # handle if no db nr is given
             connection_args = connection_args.split(':')
             kw['db'] = connection_args.pop(0)
             try:

plugins/callback/nrdp.py

@@ -14,7 +14,7 @@ DOCUMENTATION = '''
     short_description: Post task results to a Nagios server through nrdp
     description:
         - This callback send playbook result to Nagios.
-        - Nagios shall use NRDP to recive passive events.
+        - Nagios shall use NRDP to receive passive events.
         - The passive check is sent to a dedicated host/service for Ansible.
     options:
         url:

plugins/callback/null.py

@@ -15,7 +15,7 @@ DOCUMENTATION = '''
       - set as main display callback
     short_description: Don't display stuff to screen
     description:
-        - This callback prevents outputing events to screen.
+        - This callback prevents outputting events to screen.
 '''
 
 from ansible.plugins.callback import CallbackBase
@@ -24,7 +24,7 @@ from ansible.plugins.callback import CallbackBase
 class CallbackModule(CallbackBase):
 
     '''
-    This callback wont print messages to stdout when new callback events are received.
+    This callback won't print messages to stdout when new callback events are received.
     '''
 
     CALLBACK_VERSION = 2.0

plugins/connection/funcd.py

@@ -70,7 +70,7 @@ class Connection(ConnectionBase):
         if in_data:
             raise AnsibleError("Internal Error: this module does not support optimized module pipelining")
 
-        # totally ignores privlege escalation
+        # totally ignores privilege escalation
         display.vvv("EXEC %s" % cmd, host=self.host)
         p = self.client.command.run(cmd)[self.host]
         return p[0], p[1], p[2]

plugins/doc_fragments/nomad.py

@@ -53,6 +53,6 @@ options:
       type: str
     token:
       description:
-        - ACL token for authentification.
+        - ACL token for authentication.
       type: str
 '''

plugins/inventory/lxd.py

@@ -84,7 +84,7 @@ DOCUMENTATION = r'''
             version_added: 4.2.0
         prefered_instance_network_interface:
             description:
-            - If an instance has multiple network interfaces, select which one is the prefered as pattern.
+            - If an instance has multiple network interfaces, select which one is the preferred as pattern.
             - Combined with the first number that can be found e.g. 'eth' + 0.
             - The option has been renamed from O(prefered_container_network_interface) to O(prefered_instance_network_interface)
               in community.general 3.8.0. The old name still works as an alias.
@@ -94,7 +94,7 @@ DOCUMENTATION = r'''
               - prefered_container_network_interface
         prefered_instance_network_family:
             description:
-            - If an instance has multiple network interfaces, which one is the prefered by family.
+            - If an instance has multiple network interfaces, which one is the preferred by family.
             - Specify V(inet) for IPv4 and V(inet6) for IPv6.
             type: str
             default: inet
@@ -390,7 +390,7 @@ class InventoryModule(BaseInventoryPlugin):
     def get_instance_data(self, names):
         """Create Inventory of the instance
 
-        Iterate through the different branches of the instances and collect Informations.
+        Iterate through the different branches of the instances and collect Information.
 
         Args:
             list(names): List of instance names
@@ -412,7 +412,7 @@ class InventoryModule(BaseInventoryPlugin):
     def get_network_data(self, names):
         """Create Inventory of the instance
 
-        Iterate through the different branches of the instances and collect Informations.
+        Iterate through the different branches of the instances and collect Information.
 
         Args:
             list(names): List of instance names
@@ -465,9 +465,9 @@ class InventoryModule(BaseInventoryPlugin):
         return network_configuration
 
     def get_prefered_instance_network_interface(self, instance_name):
-        """Helper to get the prefered interface of thr instance
+        """Helper to get the preferred interface of thr instance
 
-        Helper to get the prefered interface provide by neme pattern from 'prefered_instance_network_interface'.
+        Helper to get the preferred interface provide by neme pattern from 'prefered_instance_network_interface'.
 
         Args:
             str(containe_name): name of instance
@@ -577,7 +577,7 @@ class InventoryModule(BaseInventoryPlugin):
             else:
                 path[instance_name][key] = value
         except KeyError as err:
-            raise AnsibleParserError("Unable to store Informations: {0}".format(to_native(err)))
+            raise AnsibleParserError("Unable to store Information: {0}".format(to_native(err)))
 
     def extract_information_from_instance_configs(self):
         """Process configuration information
@@ -697,7 +697,7 @@ class InventoryModule(BaseInventoryPlugin):
                     continue
             # add instance
             self.inventory.add_host(instance_name)
-            # add network informations
+            # add network information
             self.build_inventory_network(instance_name)
             # add os
             v = self._get_data_entry('inventory/{0}/os'.format(instance_name))

plugins/lookup/onepassword.py

@@ -494,7 +494,7 @@ class OnePassCLIv2(OnePassCLIBase):
                 if field.get("id") == field_name:
                     return field.get("value", "")
 
-            # Look at the section data and get an indentifier. The value of 'id' is either a unique ID
+            # Look at the section data and get an identifier. The value of 'id' is either a unique ID
             # or a human-readable string. If a 'label' field exists, prefer that since
             # it is the value visible in the 1Password UI when both 'id' and 'label' exist.
             section = field.get("section", {})

plugins/lookup/random_string.py

@@ -72,7 +72,7 @@ DOCUMENTATION = r"""
         type: int
       override_special:
         description:
-        - Overide a list of special characters to use in the string.
+        - Override a list of special characters to use in the string.
         - If set O(min_special) should be set to a non-default value.
         type: str
       override_all:
@@ -89,7 +89,7 @@ DOCUMENTATION = r"""
         version_added: 7.5.0
       similar_chars:
         description:
-        - Overide a list of characters not to be use in the string.
+        - Override a list of characters not to be use in the string.
         default: "il1LoO0"
         type: str
         version_added: 7.5.0
@@ -116,7 +116,7 @@ EXAMPLES = r"""
     var: lookup('community.general.random_string', base64=True)
   # Example result: ['NHZ6eWN5Qk0=']
 
-- name: Generate a random string with 1 lower, 1 upper, 1 number and 1 special char (atleast)
+- name: Generate a random string with 1 lower, 1 upper, 1 number and 1 special char (at least)
   ansible.builtin.debug:
     var: lookup('community.general.random_string', min_lower=1, min_upper=1, min_special=1, min_numeric=1)
   # Example result: ['&Qw2|E[-']

plugins/module_utils/dimensiondata.py

@@ -39,7 +39,7 @@ except ImportError:
     LIBCLOUD_IMP_ERR = traceback.format_exc()
     HAS_LIBCLOUD = False
 
-# MCP 2.x version patten for location (datacenter) names.
+# MCP 2.x version pattern for location (datacenter) names.
 #
 # Note that this is not a totally reliable way of determining MCP version.
 # Unfortunately, libcloud's NodeLocation currently makes no provision for extended properties.

plugins/module_utils/hwc_utils.py

@@ -203,7 +203,7 @@ class Config(object):
 
         if url == "":
             raise HwcClientException(
-                0, "Can not find the enpoint for %s" % service_type)
+                0, "Cannot find the endpoint for %s" % service_type)
 
         if url[-1] != "/":
             url += "/"
@@ -351,7 +351,7 @@ def wait_to_finish(target, pending, refresh, timeout, min_interval=1, delay=3):
 
             if pending and status not in pending:
                 raise HwcModuleException(
-                    "unexpect status(%s) occurred" % status)
+                    "unexpected status(%s) occurred" % status)
 
         if not is_last_time:
             wait *= 2
@@ -362,7 +362,7 @@ def wait_to_finish(target, pending, refresh, timeout, min_interval=1, delay=3):
 
             time.sleep(wait)
 
-    raise HwcModuleException("asycn wait timeout after %d seconds" % timeout)
+    raise HwcModuleException("async wait timeout after %d seconds" % timeout)
 
 
 def navigate_value(data, index, array_index=None):

plugins/module_utils/identity/keycloak/keycloak.py

@@ -544,7 +544,7 @@ class KeycloakAPI(object):
         return None
 
     def get_client_group_available_rolemappings(self, gid, cid, realm="master"):
-        """ Fetch the available role of a client in a specified goup on the Keycloak server.
+        """ Fetch the available role of a client in a specified group on the Keycloak server.
 
         :param gid: ID of the group from which to obtain the rolemappings.
         :param cid: ID of the client from which to obtain the rolemappings.
@@ -627,7 +627,7 @@ class KeycloakAPI(object):
                                       % (rid, realm, str(e)))
 
     def add_group_rolemapping(self, gid, cid, role_rep, realm="master"):
-        """ Fetch the composite role of a client in a specified goup on the Keycloak server.
+        """ Fetch the composite role of a client in a specified group on the Keycloak server.
 
         :param gid: ID of the group from which to obtain the rolemappings.
         :param cid: ID of the client from which to obtain the rolemappings.
@@ -1238,7 +1238,7 @@ class KeycloakAPI(object):
 
         :param realm: Realm in which the clientscope resides.
         :param client_id: The client in which the clientscope resides.
-        :return The optinal clientscopes of this realm or client
+        :return The optional clientscopes of this realm or client
         """
         url = URL_OPTIONAL_CLIENTSCOPES if client_id is None else URL_CLIENT_OPTIONAL_CLIENTSCOPES
         return self._get_clientscopes_of_type(realm, url, 'optional', client_id)
@@ -1251,7 +1251,7 @@ class KeycloakAPI(object):
 
         :param realm: Realm in which the clientscope resides.
         :param url_template the template for the right type
-        :param scope_type this can be either optinal or default
+        :param scope_type this can be either optional or default
         :param client_id: The client in which the clientscope resides.
         :return The clientscopes of the specified type of this realm
         """
@@ -1273,7 +1273,7 @@ class KeycloakAPI(object):
 
     def _decide_url_type_clientscope(self, client_id=None, scope_type="default"):
         """Decides which url to use.
-        :param scope_type this can be either optinal or default
+        :param scope_type this can be either optional or default
         :param client_id: The client in which the clientscope resides.
         """
         if client_id is None:
@@ -1520,7 +1520,7 @@ class KeycloakAPI(object):
     def get_subgroup_direct_parent(self, parents, realm="master", children_to_resolve=None):
         """ Get keycloak direct parent group API object for a given chain of parents.
 
-        To succesfully work the API for subgroups we actually dont need
+        To successfully work the API for subgroups we actually don't need
         to "walk the whole tree" for nested groups but only need to know
         the ID for the direct predecessor of current subgroup. This
         method will guarantee us this information getting there with
@@ -2879,7 +2879,7 @@ class KeycloakAPI(object):
             groups_to_add_and_remove = self.extract_groups_to_add_to_and_remove_from_user(groups)
             # If group membership need to be changed
             if not is_struct_included(groups_to_add_and_remove['add'], user_existing_groups):
-                # Get available goups in the realm
+                # Get available groups in the realm
                 realm_groups = self.get_groups(realm=realm)
                 for realm_group in realm_groups:
                     if "name" in realm_group and realm_group["name"] in groups_to_add_and_remove['add']:

plugins/module_utils/memset.py

@@ -79,7 +79,7 @@ def memset_api_call(api_key, api_method, payload=None):
             msg = "Memset API returned an error ({0}, {1})." . format(response.json()['error_type'], response.json()['error'])
     except urllib_error.URLError as e:
         has_failed = True
-        msg = "An URLError occured ({0})." . format(type(e))
+        msg = "An URLError occurred ({0})." . format(type(e))
         response.stderr = "{0}" . format(e)
 
     if msg is None:

plugins/module_utils/net_tools/pritunl/api.py

@@ -331,7 +331,7 @@ def pritunl_auth_request(
 ):
     """
     Send an API call to a Pritunl server.
-    Taken from https://pritunl.com/api and adaped work with Ansible open_url
+    Taken from https://pritunl.com/api and adapted to work with Ansible open_url
     """
     auth_timestamp = str(int(time.time()))
     auth_nonce = uuid.uuid4().hex

plugins/module_utils/oracle/oci_utils.py

@@ -434,7 +434,7 @@ def check_and_update_attributes(
     target_instance, attr_name, input_value, existing_value, changed
 ):
     """
-    This function checks the difference between two resource attributes of literal types and sets the attrbute
+    This function checks the difference between two resource attributes of literal types and sets the attribute
     value in the target instance type holding the attribute.
     :param target_instance: The instance which contains the attribute whose values to be compared
     :param attr_name: Name of the attribute whose value required to be compared
@@ -785,7 +785,7 @@ def _get_attributes_to_consider(exclude_attributes, model, module):
         attributes_to_consider = list(model.attribute_map)
         if "freeform_tags" in attributes_to_consider:
             attributes_to_consider.remove("freeform_tags")
-        # Temporarily removing node_count as the exisiting resource does not reflect it
+        # Temporarily removing node_count as the existing resource does not reflect it
         if "node_count" in attributes_to_consider:
             attributes_to_consider.remove("node_count")
     _debug("attributes to consider: {0}".format(attributes_to_consider))
@@ -1771,7 +1771,7 @@ def update_class_type_attr_difference(
 ):
     """
     Checks the difference and updates an attribute which is represented by a class
-    instance. Not aplicable if the attribute type is a primitive value.
+    instance. Not applicable if the attribute type is a primitive value.
     For example, if a class name is A with an attribute x, then if A.x = X(), then only
     this method works.
     :param update_class_details The instance which should be updated if there is change in
@@ -1933,7 +1933,7 @@ def get_target_resource_from_list(
     module, list_resource_fn, target_resource_id=None, **kwargs
 ):
     """
-    Returns a resource filtered by identifer from a list of resources. This method should be
+    Returns a resource filtered by identifier from a list of resources. This method should be
     used as an alternative of 'get resource' method when 'get resource' is nor provided by
     resource api. This method returns a wrapper of response object but that should not be
     used as an input to 'wait_until' utility as this is only a partial wrapper of response object.

plugins/module_utils/redfish_utils.py

@@ -327,7 +327,7 @@ class RedfishUtils(object):
         found in ansible.module_utils.urls, but it takes files and encodes them
         as Base64 strings, which is not expected by Redfish services.  It also
         adds escaping of certain bytes in the payload, such as inserting '\r'
-        any time it finds a standlone '\n', which corrupts the image payload
+        any time it finds a standalone '\n', which corrupts the image payload
         send to the service.  This implementation is simplified to Redfish's
         usage and doesn't necessarily represent an exhaustive method of
         building multipart requests.
@@ -3703,12 +3703,12 @@ class RedfishUtils(object):
                 rsp_uri = loc['Uri']
                 if vendor == 'HPE':
                     # WORKAROUND
-                    # HPE systems with iLO 4 will have BIOS Atrribute Registries location URI as a dictonary with key 'extref'
+                    # HPE systems with iLO 4 will have BIOS Attribute Registries location URI as a dictionary with key 'extref'
                     # Hence adding condition to fetch the Uri
                     if type(loc['Uri']) is dict and "extref" in loc['Uri'].keys():
                         rsp_uri = loc['Uri']['extref']
         if not rsp_uri:
-            msg = "Language 'en' not found in BIOS Atrribute Registries location, URI: %s, response: %s"
+            msg = "Language 'en' not found in BIOS Attribute Registries location, URI: %s, response: %s"
             return {
                 "ret": False,
                 "msg": msg % (resp_uri, str(resp_data))

plugins/module_utils/scaleway.py

@@ -303,7 +303,7 @@ class Scaleway(object):
         wait_timeout = self.module.params["wait_timeout"]
         wait_sleep_time = self.module.params["wait_sleep_time"]
 
-        # Prevent requesting the ressource status too soon
+        # Prevent requesting the resource status too soon
         time.sleep(wait_sleep_time)
 
         start = datetime.datetime.utcnow()

plugins/module_utils/vardict.py

@@ -49,7 +49,7 @@ class _Variable(object):
             output (bool, optional): flag indicating whether the variable should be in the output of the module. Defaults to None.
             diff (bool, optional): flag indicating whether to generate diff mode output for this variable. Defaults to None.
             change (bool, optional): flag indicating whether to track if changes happened to this variable. Defaults to None.
-            fact (bool, optional): flag indicating whether the varaiable should be exposed as a fact of the module. Defaults to None.
+            fact (bool, optional): flag indicating whether the variable should be exposed as a fact of the module. Defaults to None.
             initial_value (any, optional): initial value of the variable, to be used with `change`. Defaults to NOTHING.
             verbosity (int, optional): level of verbosity in which this variable is reported by the module as `output`, `fact` or `diff`. Defaults to None.
         """
@@ -143,7 +143,7 @@ class VarDict(object):
             output (bool, optional): flag indicating whether the variable should be in the output of the module. Defaults to None.
             diff (bool, optional): flag indicating whether to generate diff mode output for this variable. Defaults to None.
             change (bool, optional): flag indicating whether to track if changes happened to this variable. Defaults to None.
-            fact (bool, optional): flag indicating whether the varaiable should be exposed as a fact of the module. Defaults to None.
+            fact (bool, optional): flag indicating whether the variable should be exposed as a fact of the module. Defaults to None.
             initial_value (any, optional): initial value of the variable, to be used with `change`. Defaults to NOTHING.
             verbosity (int, optional): level of verbosity in which this variable is reported by the module as `output`, `fact` or `diff`. Defaults to None.
         """

plugins/module_utils/wdc_redfish_utils.py

@@ -182,7 +182,7 @@ class WdcRedfishUtils(RedfishUtils):
 
         :param str bundle_uri:  HTTP URI of the firmware bundle.
         :return: Firmware version number contained in the bundle, and whether or not the bundle is multi-tenant.
-        Either value will be None if unable to deterine.
+        Either value will be None if unable to determine.
         :rtype: str or None, bool or None
         """
         bundle_temp_filename = fetch_file(module=self.module,

plugins/modules/homectl.py

@@ -393,7 +393,7 @@ class Homectl(object):
             user_metadata.pop('status', None)
             # Let last change Usec be updated by homed when command runs.
             user_metadata.pop('lastChangeUSec', None)
-            # Now only change fields that are called on leaving whats currently in the record intact.
+            # Now only change fields that are called on leaving what's currently in the record intact.
             record = user_metadata
 
         record['userName'] = self.name

plugins/modules/imgadm.py

@@ -174,7 +174,7 @@ class Imgadm(object):
 
         # There is no feedback from imgadm(1M) to determine if anything
         # was actually changed. So treat this as an 'always-changes' operation.
-        # Note that 'imgadm -v' produces unparseable JSON...
+        # Note that 'imgadm -v' produces unparsable JSON...
         self.changed = True
 
     def manage_sources(self):

plugins/modules/jira.py

@@ -799,7 +799,7 @@ class JIRA(StateModuleHelper):
                 if msg:
                     self.module.fail_json(msg=', '.join(msg))
                 self.module.fail_json(msg=to_native(error))
-            # Fallback print body, if it cant be decoded
+            # Fallback print body, if it can't be decoded
             self.module.fail_json(msg=to_native(info['body']))
 
         body = response.read()

plugins/modules/lvg.py

@@ -480,7 +480,7 @@ def main():
                         module.fail_json(msg="Failed to remove volume group %s" % (vg), rc=rc, err=err)
                 else:
                     module.fail_json(msg="Refuse to remove non-empty volume group %s without force=true" % (vg))
-        # activate/inactivate existing VG
+        # activate/deactivate existing VG
         elif state == 'active':
             changed = activate_vg(module=module, vg=vg, active=True)
         elif state == 'inactive':

plugins/modules/lxc_container.py

@@ -1277,7 +1277,7 @@ class LxcContainerManagement(object):
         """
 
         vg = self._get_lxc_vg()
-        free_space, messurement = self._get_vg_free_pe(vg_name=vg)
+        free_space, measurement = self._get_vg_free_pe(vg_name=vg)
 
         if free_space < float(snapshot_size_gb):
             message = (

plugins/modules/solaris_zone.py

@@ -46,8 +46,8 @@ options:
     description:
       - Zone name.
       - A zone name must be unique name.
-      - A zone name must begin with an alpha-numeric character.
-      - The name can contain alpha-numeric characters, underscores V(_), hyphens V(-), and periods V(.).
+      - A zone name must begin with an alphanumeric character.
+      - The name can contain alphanumeric characters, underscores V(_), hyphens V(-), and periods V(.).
       - The name cannot be longer than 64 characters.
     type: str
     required: true

plugins/modules/sysrc.py

@@ -222,7 +222,7 @@ def main():
     # OID style names are not supported
     if not re.match('^[a-zA-Z0-9_]+$', name):
         module.fail_json(
-            msg="Name may only contain alpha-numeric and underscore characters"
+            msg="Name may only contain alphanumeric and underscore characters"
         )
 
     value = module.params.pop('value')

plugins/modules/timezone.py

@@ -53,7 +53,7 @@ options:
     choices: [ local, UTC ]
 notes:
   - On SmartOS the C(sm-set-timezone) utility (part of the smtools package) is required to set the zone timezone
-  - On AIX only Olson/tz database timezones are useable (POSIX is not supported).
+  - On AIX only Olson/tz database timezones are usable (POSIX is not supported).
     - An OS reboot is also required on AIX for the new timezone setting to take effect.
 author:
   - Shinichi TAMURA (@tmshn)