From 98a226b9c69a24559264729c5bfdb93c0f46a669 Mon Sep 17 00:00:00 2001 From: Sharpz7 Date: Thu, 25 Jan 2024 21:22:07 +0000 Subject: [PATCH] [codespell] Fixing Spelling Mistakes This is the first in a series of commits to add support for codespell. This is continuning the process completed in ironic-python-agent. Future Commits will add a Tox Target, CI support and potentially a git-blame-ignore-revs file if their are lots of spelling mistakes that could clutter git blame. Change-Id: Icb4e66359c3e79618c916b35793ea7b5f79b030d --- ironic_inspector/common/lldp_tlvs.py | 2 +- ironic_inspector/common/swift.py | 2 +- ironic_inspector/db/api.py | 4 ++-- .../18440d0834af_introducing_the_aborting_state.py | 2 +- ironic_inspector/main.py | 2 +- ironic_inspector/node_cache.py | 10 +++++----- ironic_inspector/plugins/local_link_connection.py | 2 +- ironic_inspector/policy.py | 2 +- ironic_inspector/test/unit/test_introspect.py | 2 +- .../notes/accelerators-2aa4f0cedf359810.yaml | 2 +- releasenotes/notes/extra-check-9cf0a7d89e534ccd.yaml | 2 +- .../notes/keystoneauth-plugins-aab6cbe1d0e884bf.yaml | 12 ++++++------ .../notes/policy-engine-c44828e3131e6c62.yaml | 2 +- ...dd-deny-unknown-host-option-b84b2aa1f7f49a17.yaml | 2 +- ...-for-openstack-rbac-changes-7ca8533f76e504d5.yaml | 2 +- .../sqlalchemy-minimum-version-cd34a2e10d7946fd.yaml | 2 +- .../source/locale/en_GB/LC_MESSAGES/releasenotes.po | 12 ++++++------ 17 files changed, 32 insertions(+), 32 deletions(-) diff --git a/ironic_inspector/common/lldp_tlvs.py b/ironic_inspector/common/lldp_tlvs.py index 39ac09086..d45e373d7 100644 --- a/ironic_inspector/common/lldp_tlvs.py +++ b/ironic_inspector/common/lldp_tlvs.py @@ -246,7 +246,7 @@ def get_autoneg_cap(pmd): Dependent (PMD) capability bits. :param pmd: PMD bits - :return: Sorted ist containing capability strings + :return: Sorted list containing capability strings """ caps_set = set() diff --git a/ironic_inspector/common/swift.py b/ironic_inspector/common/swift.py index dd59f754d..ed46ef3aa 100644 --- a/ironic_inspector/common/swift.py +++ b/ironic_inspector/common/swift.py @@ -45,7 +45,7 @@ class SwiftAPI(object): def __init__(self): """Constructor for creating a SwiftAPI object. - Authentification is loaded from config file. + Authentication is loaded from config file. """ global SWIFT_SESSION diff --git a/ironic_inspector/db/api.py b/ironic_inspector/db/api.py index 763c960d8..99700931b 100644 --- a/ironic_inspector/db/api.py +++ b/ironic_inspector/db/api.py @@ -487,7 +487,7 @@ def get_rules_conditions(**fields): :returns: list of conditions """ # NOTE(TheJulia): This appears to exist largely to help unit - # testing of rules funcitonality. + # testing of rules functionality. with session_for_read() as session: query = session.query( model.RuleCondition @@ -510,7 +510,7 @@ def get_rules_actions(**fields): :returns: list of actions """ # NOTE(TheJulia): This appears to exist largely to help unit - # testing of rules funcitonality. + # testing of rules functionality. with session_for_read() as session: query = session.query( model.RuleAction diff --git a/ironic_inspector/db/migrations/versions/18440d0834af_introducing_the_aborting_state.py b/ironic_inspector/db/migrations/versions/18440d0834af_introducing_the_aborting_state.py index 61aaf1de7..0289aa49d 100644 --- a/ironic_inspector/db/migrations/versions/18440d0834af_introducing_the_aborting_state.py +++ b/ironic_inspector/db/migrations/versions/18440d0834af_introducing_the_aborting_state.py @@ -51,7 +51,7 @@ def upgrade(): # # The prior net effect was that the field was being altered to # be varchar(10), to house the largest enum value, except the added - # value only requres varchar(9), so this is sort of entirely + # value only requires varchar(9), so this is sort of entirely # redundant at this point. For what it is worth, while # batch_alter_table *does* include an option to prevent # recration, column widths cannot be modified dynamically with diff --git a/ironic_inspector/main.py b/ironic_inspector/main.py index 519f511e0..d11d391a4 100644 --- a/ironic_inspector/main.py +++ b/ironic_inspector/main.py @@ -281,7 +281,7 @@ def api(path, is_public_api=False, rule=None, verb_to_rule_map=None, as public, with minimal access enforcement :param rule: API access policy rule to enforce. If rule is None, the 'default' policy rule will be enforced, - which is "deny all" if not overridden in policy confif file. + which is "deny all" if not overridden in policy config file. :param verb_to_rule_map: if both rule and this are given, defines mapping between http verbs (uppercase) and strings to format the 'rule' string with diff --git a/ironic_inspector/node_cache.py b/ironic_inspector/node_cache.py index 49a241c82..3b91f24d7 100644 --- a/ironic_inspector/node_cache.py +++ b/ironic_inspector/node_cache.py @@ -62,7 +62,7 @@ class NodeInfo(object): self.invalidate_cache() # NOTE(TheJulia): version_id is unused at this time and can be # removed at a later point in time. Primarily it remains for - # compatability. + # compatibility. self._version_id = version_id self._state = state self._node = node @@ -676,7 +676,7 @@ def start_introspection(uuid, **kwargs): recorded_state = node_info.state if istate.States.error == recorded_state: # If there was a failure, return to starting state to avoid - # letting the cache block new runs from occuring. + # letting the cache block new runs from occurring. state = istate.States.starting else: state = recorded_state @@ -698,7 +698,7 @@ def add_node(uuid, state, manage_boot=True, **attributes): """ started_at = timeutils.utcnow() with db.session_for_write() as session: - # TODO(TheJulia): This needs ot be moved to the DBAPI, but for change + # TODO(TheJulia): This needs to be moved to the DBAPI, but for change # reviewer sanity, is here for now. session.execute( delete(db_model.Attribute).where( @@ -1006,7 +1006,7 @@ def store_introspection_data(node_id, introspection_data, processed=True): :param processed: Specify the type of introspected data, set to False indicates the data is unprocessed. """ - # NOTE(TheJulia): For compatability, but at the same time there is + # NOTE(TheJulia): For compatibility, but at the same time there is # two nodes of introspection data operation, DB and originally swift. db.store_introspection_data( node_id=node_id, @@ -1022,6 +1022,6 @@ def get_introspection_data(node_id, processed=True): indicates retrieving the unprocessed data. :return: A dictionary representation of intropsected data """ - # NOTE(TheJulia): Moved to db api, here for compatability. + # NOTE(TheJulia): Moved to db api, here for compatibility. return db.get_introspection_data(node_id=node_id, processed=processed) diff --git a/ironic_inspector/plugins/local_link_connection.py b/ironic_inspector/plugins/local_link_connection.py index cb48e338f..09fa00309 100644 --- a/ironic_inspector/plugins/local_link_connection.py +++ b/ironic_inspector/plugins/local_link_connection.py @@ -53,7 +53,7 @@ class GenericLocalLinkConnectionHook(base.ProcessingHook): except TypeError: LOG.warning("TLV value for TLV type %d not in correct" "format, ensure TLV value is in " - "hexidecimal format when sent to " + "hexadecimal format when sent to " "inspector", tlv_type, node_info=node_info) return diff --git a/ironic_inspector/policy.py b/ironic_inspector/policy.py index f2aeb6509..0323e3c41 100644 --- a/ironic_inspector/policy.py +++ b/ironic_inspector/policy.py @@ -264,7 +264,7 @@ def init_enforcer(policy_file=None, rules=None, default_rule=default_rule, use_conf=use_conf) - # NOTE(gmann): Explictly disable the warnings for policies + # NOTE(gmann): Explicitly disable the warnings for policies # changing their default check_str. With new RBAC policy # work, all the policy defaults have been changed and warning for # each policy started filling the logs limit for various tool. diff --git a/ironic_inspector/test/unit/test_introspect.py b/ironic_inspector/test/unit/test_introspect.py index 2f9e76536..d92569869 100644 --- a/ironic_inspector/test/unit/test_introspect.py +++ b/ironic_inspector/test/unit/test_introspect.py @@ -579,7 +579,7 @@ class TestAbort(BaseTest): self.assertEqual(0, self.sync_filter_mock.call_count) self.assertEqual(0, cli.set_node_power_state.call_count) - self.assertEqual(0, self.node_info.finshed.call_count) + self.assertEqual(0, self.node_info.finished.call_count) self.assertEqual(0, self.node_info.fsm_event.call_count) def test_firewall_update_exception(self, client_mock, get_mock): diff --git a/releasenotes/notes/accelerators-2aa4f0cedf359810.yaml b/releasenotes/notes/accelerators-2aa4f0cedf359810.yaml index 2b7a368ab..1f76a11f0 100644 --- a/releasenotes/notes/accelerators-2aa4f0cedf359810.yaml +++ b/releasenotes/notes/accelerators-2aa4f0cedf359810.yaml @@ -1,7 +1,7 @@ --- features: - | - Adds an ``accelerators`` plugin to identify acclerator devices and update + Adds an ``accelerators`` plugin to identify accelerator devices and update the bare metal node for future scheduling. The accelerator devices will be saved to node properties under the key ``accelerators``. Introduces a configuration option ``[accelerators]known_devices`` to specify a diff --git a/releasenotes/notes/extra-check-9cf0a7d89e534ccd.yaml b/releasenotes/notes/extra-check-9cf0a7d89e534ccd.yaml index 1cb5557cf..04bdc212d 100644 --- a/releasenotes/notes/extra-check-9cf0a7d89e534ccd.yaml +++ b/releasenotes/notes/extra-check-9cf0a7d89e534ccd.yaml @@ -3,7 +3,7 @@ fixes: - | The ``extra_hardware`` processing hook no longer refuses to parse extra data if some records are empty or have unexpected length. These records - are now discared. + are now discarded. The previous behavior can be returned by setting the new option ``[extra_hardware]strict`` to ``True``. diff --git a/releasenotes/notes/keystoneauth-plugins-aab6cbe1d0e884bf.yaml b/releasenotes/notes/keystoneauth-plugins-aab6cbe1d0e884bf.yaml index f0d0db554..b03739105 100644 --- a/releasenotes/notes/keystoneauth-plugins-aab6cbe1d0e884bf.yaml +++ b/releasenotes/notes/keystoneauth-plugins-aab6cbe1d0e884bf.yaml @@ -2,16 +2,16 @@ features: - Ironic-Inspector is now using keystoneauth and proper auth_plugins instead of keystoneclient for communicating with Ironic and Swift. - It allows to finely tune authentification for each service independently. + It allows to finely tune authentication for each service independently. For each service, the keystone session is created and reused, minimizing - the number of authentification requests to Keystone. + the number of authentication requests to Keystone. upgrade: - Operators are advised to specify a proper keystoneauth plugin and its appropriate settings in [ironic] and [swift] config sections. - Backward compatibility with previous authentification options is included. - Using authentification informaiton for Ironic and Swift from + Backward compatibility with previous authentication options is included. + Using authentication information for Ironic and Swift from [keystone_authtoken] config section is no longer supported. deprecations: - - Most of current authentification options for either Ironic or Swift are + - Most of current authentication options for either Ironic or Swift are deprecated and will be removed in a future release. Please configure - the keystoneauth auth plugin authentification instead. + the keystoneauth auth plugin authentication instead. diff --git a/releasenotes/notes/policy-engine-c44828e3131e6c62.yaml b/releasenotes/notes/policy-engine-c44828e3131e6c62.yaml index 41284ee97..278578d6a 100644 --- a/releasenotes/notes/policy-engine-c44828e3131e6c62.yaml +++ b/releasenotes/notes/policy-engine-c44828e3131e6c62.yaml @@ -1,7 +1,7 @@ --- features: - | - Adds an API access policy enforcment based on **oslo.policy** rules. + Adds an API access policy enforcement based on **oslo.policy** rules. Similar to other OpenStack services, operators now can configure fine-grained access policies using ``policy.yaml`` file. See `policy.yaml.sample`_ in the code tree for the list of available policies diff --git a/releasenotes/notes/pxe-filter-add-deny-unknown-host-option-b84b2aa1f7f49a17.yaml b/releasenotes/notes/pxe-filter-add-deny-unknown-host-option-b84b2aa1f7f49a17.yaml index 265e38b26..fe866edf6 100644 --- a/releasenotes/notes/pxe-filter-add-deny-unknown-host-option-b84b2aa1f7f49a17.yaml +++ b/releasenotes/notes/pxe-filter-add-deny-unknown-host-option-b84b2aa1f7f49a17.yaml @@ -9,7 +9,7 @@ features: ironic may boot the inspection image. A new option was added ``[pxe_filter]deny_unknown_macs`` which allow - changeing this behaviour so that the DHCP server only allow enrolled nodes + changing this behaviour so that the DHCP server only allow enrolled nodes being introspected and deny everything else. .. Note:: If this option is ``True``, nodes must have at least one diff --git a/releasenotes/notes/role-service-for-openstack-rbac-changes-7ca8533f76e504d5.yaml b/releasenotes/notes/role-service-for-openstack-rbac-changes-7ca8533f76e504d5.yaml index 76e080a0c..139dab71c 100644 --- a/releasenotes/notes/role-service-for-openstack-rbac-changes-7ca8533f76e504d5.yaml +++ b/releasenotes/notes/role-service-for-openstack-rbac-changes-7ca8533f76e504d5.yaml @@ -8,7 +8,7 @@ fixes: as the Inspector service is considered an "admin-only" service. Also in alignment with overall community position changes, where the - ``admin`` role is sufficent without an explicit ``system`` scope. To + ``admin`` role is sufficient without an explicit ``system`` scope. To help ensure a high level of security, explicit testing was also added for the ``manager`` role, which is unavailable as that role is reserved for administrative functions inside of a tenant's project. diff --git a/releasenotes/notes/sqlalchemy-minimum-version-cd34a2e10d7946fd.yaml b/releasenotes/notes/sqlalchemy-minimum-version-cd34a2e10d7946fd.yaml index 2c2574a83..76c21936b 100644 --- a/releasenotes/notes/sqlalchemy-minimum-version-cd34a2e10d7946fd.yaml +++ b/releasenotes/notes/sqlalchemy-minimum-version-cd34a2e10d7946fd.yaml @@ -22,7 +22,7 @@ deprecations: - | Plugin maintainers should be aware that the Node Cache object field ``version_id`` filed is no longer in use. It is still returned - by the data model if stored for the purposes of compatability, but + by the data model if stored for the purposes of compatibility, but Inspector will not update the field through the normal course of it's operation. other: diff --git a/releasenotes/source/locale/en_GB/LC_MESSAGES/releasenotes.po b/releasenotes/source/locale/en_GB/LC_MESSAGES/releasenotes.po index a855e52cd..ba937f042 100644 --- a/releasenotes/source/locale/en_GB/LC_MESSAGES/releasenotes.po +++ b/releasenotes/source/locale/en_GB/LC_MESSAGES/releasenotes.po @@ -226,7 +226,7 @@ msgstr "" msgid "" "A new option was added ``[pxe_filter]deny_unknown_macs`` which allow " -"changeing this behaviour so that the DHCP server only allow enrolled nodes " +"changing this behaviour so that the DHCP server only allow enrolled nodes " "being introspected and deny everything else." msgstr "" "A new option was added ``[pxe_filter]deny_unknown_macs`` which allow " @@ -377,7 +377,7 @@ msgstr "" "at the web server root resource." msgid "" -"Adds an ``accelerators`` plugin to identify acclerator devices and update " +"Adds an ``accelerators`` plugin to identify accelerator devices and update " "the bare metal node for future scheduling. The accelerator devices will be " "saved to node properties under the key ``accelerators``. Introduces a " "configuration option ``[accelerators]known_devices`` to specify a " @@ -1195,7 +1195,7 @@ msgstr "Pike Series (6.0.0 - 6.0.x) Release Notes" msgid "" "Plugin maintainers should be aware that the Node Cache object field " "``version_id`` filed is no longer in use. It is still returned by the data " -"model if stored for the purposes of compatability, but Inspector will not " +"model if stored for the purposes of compatibility, but Inspector will not " "update the field through the normal course of it's operation." msgstr "" "Plugin maintainers should be aware that the Node Cache object field " @@ -1353,7 +1353,7 @@ msgstr "Stein Series (8.1.0 - 8.2.x) Release Notes" msgid "" "Stops introspection when setting boot device is failed, as the node is not " -"guarenteed to perform a PXE boot in this case." +"guaranteed to perform a PXE boot in this case." msgstr "" "Stops introspection when setting boot device is failed, as the node is not " "guaranteed to perform a PXE boot in this case." @@ -1431,7 +1431,7 @@ msgstr "" msgid "" "The ``extra_hardware`` processing hook no longer refuses to parse extra data " "if some records are empty or have unexpected length. These records are now " -"discared." +"discarded." msgstr "" "The ``extra_hardware`` processing hook no longer refuses to parse extra data " "if some records are empty or have unexpected length. These records are now " @@ -1552,7 +1552,7 @@ msgstr "" "iptables pxe-filter.)" msgid "" -"The filter uses the systemd service name used by the RDO distrubution " +"The filter uses the systemd service name used by the RDO distribution " "(``openstack-ironic-inspector-dnsmasq.service``)." msgstr "" "The filter uses the systemd service name used by the RDO distribution "