Test documentation typo fixes using codespell tool
Changes:
- Fix typo in code documentation and test name
Tested: - Using codespell tool.
Change-Id: Ia1b65bddc01a4b1c103af9f2094d87da11c88953
Signed-off-by: George Keishing <gkeishin@in.ibm.com>
diff --git a/.flake8-ignore b/.flake8-ignore
index e2331f3..aad6d4f 100644
--- a/.flake8-ignore
+++ b/.flake8-ignore
@@ -25,7 +25,6 @@
lib/bmc_redfish_utils.py
lib/boot_data.py
lib/disable_warning_urllib.py
-lib/dump_utils.py
lib/external_intf/management_console_utils.py
lib/func_args.py
lib/gen_arg.py
@@ -51,6 +50,5 @@
lib/utilities.py
lib/utils_files.py
lib/var_funcs.py
-syslib/utils_keywords.py
templates/python_pgm_template
tools/ct_metrics/gen_csv_results.py
diff --git a/extended/code_update/host_code_update.robot b/extended/code_update/host_code_update.robot
index 68f41ef..418f87f 100644
--- a/extended/code_update/host_code_update.robot
+++ b/extended/code_update/host_code_update.robot
@@ -155,7 +155,7 @@
Set RequestedActivation And Activation To Invalid Value
- [Documentation] Set the RequestedActivation and Activation propreties of
+ [Documentation] Set the RequestedActivation and Activation properties of
... the image to an invalid value and verify that it was not
... changed.
[Template] Set Property To Invalid Value And Verify No Change
diff --git a/ffdc/ffdc_collector.py b/ffdc/ffdc_collector.py
index b21044c..875ec81 100644
--- a/ffdc/ffdc_collector.py
+++ b/ffdc/ffdc_collector.py
@@ -792,7 +792,7 @@
Description of argument(s):
targ_dir_path The path of the directory to receive the files.
- targ_file_prefix Prefix which will be pre-pended to each
+ targ_file_prefix Prefix which will be prepended to each
target file's name.
file_dict A dictionary of files to scp from targeted system to this system
diff --git a/ipmi/test_get_bios_post_code.robot b/ipmi/test_get_bios_post_code.robot
index 7d81702..8605c90 100644
--- a/ipmi/test_get_bios_post_code.robot
+++ b/ipmi/test_get_bios_post_code.robot
@@ -13,7 +13,7 @@
*** Test Cases ***
IPMI Chassis Status On
- [Documentation] This test case verfies system power on status
+ [Documentation] This test case verifies system power on status
... using IPMI Get Chassis status command.
[Tags] IPMI_Chassis_Status_On
diff --git a/ipmi/test_ipmi_chassis.robot b/ipmi/test_ipmi_chassis.robot
index 9383425..1c4280f 100644
--- a/ipmi/test_ipmi_chassis.robot
+++ b/ipmi/test_ipmi_chassis.robot
@@ -19,7 +19,7 @@
*** Test Cases ***
IPMI Chassis Status On
- [Documentation] This test case verfies system power on status
+ [Documentation] This test case verifies system power on status
... using IPMI Get Chassis status command.
[Tags] IPMI_Chassis_Status_On
@@ -29,7 +29,7 @@
Should Contain ${power_status} on
IPMI Chassis Status Off
- [Documentation] This test case verfies system power off status
+ [Documentation] This test case verifies system power off status
... using IPMI Get Chassis status command.
[Tags] IPMI_Chassis_Status_Off
diff --git a/ipmi/test_ipmi_systeminfo_parameters.robot b/ipmi/test_ipmi_systeminfo_parameters.robot
index 29ad99d..0ca45da 100644
--- a/ipmi/test_ipmi_systeminfo_parameters.robot
+++ b/ipmi/test_ipmi_systeminfo_parameters.robot
@@ -230,7 +230,7 @@
${system_name}= Generate Random String 15 [LETTERS]
${system_name} ${name_hex_data}= Identify Request Data ${system_name}
# Consider random string generated is 'zwclMXwfczMvcYz'.
- # The request data bytes will be 15 bytes, in which 14 bytes are only exepcted.
+ # The request data bytes will be 15 bytes, in which 14 bytes are only expected.
# Check if the Set System Info Parameter for param 2 - System Name throws error for invalid request data.
Run Keyword and Expect Error *${IPMI_RAW_CMD['System_Info']['param2_System_Name']['Set'][1]}*
diff --git a/lib/common_utils.robot b/lib/common_utils.robot
index c3b217c..2ec9d85 100755
--- a/lib/common_utils.robot
+++ b/lib/common_utils.robot
@@ -345,7 +345,7 @@
... ${targ_file_path}=${EXECDIR}${/}logs${/}
... ${return_data}=${1}
- # If there are muliple system console processes, they will all be stopped.
+ # If there are multiple system console processes, they will all be stopped.
# If there is no existing log file this keyword will return an error
# message to that effect (and write that message to targ_file_path, if
# specified).
diff --git a/lib/dump_utils.py b/lib/dump_utils.py
index ee70850..1f00683 100755
--- a/lib/dump_utils.py
+++ b/lib/dump_utils.py
@@ -12,7 +12,6 @@
import gen_misc as gm
import gen_print as gp
import gen_robot_keyword as grk
-import var_funcs as vf
from robot.libraries.BuiltIn import BuiltIn
base_path = (
@@ -107,7 +106,7 @@
Description of argument(s):
targ_dir_path The path of the directory to receive the
dump files.
- targ_file_prefix Prefix which will be pre-pended to each
+ targ_file_prefix Prefix which will be prepended to each
target file's name.
dump_dict A dump dictionary such as the one returned
by get_dump_dict. If this value is None,
diff --git a/lib/gen_print.py b/lib/gen_print.py
index 8372832..3f1a1fd 100755
--- a/lib/gen_print.py
+++ b/lib/gen_print.py
@@ -1986,7 +1986,7 @@
replace_dict Please see the create_func_def_string function in wrap_utils.py for
details on this parameter. This parameter will be passed directly to
create_func_def_string.
- func_prefix Prefix to be pre-pended to the generated function name.
+ func_prefix Prefix to be prepended to the generated function name.
"""
buffer = ""
diff --git a/lib/gen_robot_valid.py b/lib/gen_robot_valid.py
index d1e8d23..c25d9ab 100755
--- a/lib/gen_robot_valid.py
+++ b/lib/gen_robot_valid.py
@@ -73,7 +73,7 @@
BuiltIn().fail(error_message)
-# The docstring header will be pre-pended to each validation function's existing docstring.
+# The docstring header will be prepended to each validation function's existing docstring.
docstring_header = r"""
Fail if the variable named by var_name is invalid.
"""
diff --git a/lib/ipmi_client.py b/lib/ipmi_client.py
index 7d4e582..243df4e 100644
--- a/lib/ipmi_client.py
+++ b/lib/ipmi_client.py
@@ -144,7 +144,7 @@
def process_ipmi_user_options(command):
r"""
- Return the buffer with any ipmi_user_options pre-pended.
+ Return the buffer with any ipmi_user_options prepended.
Description of argument(s):
command An IPMI command (e.g. "power status").
diff --git a/lib/pel_utils.py b/lib/pel_utils.py
index a0c52be..9899478 100644
--- a/lib/pel_utils.py
+++ b/lib/pel_utils.py
@@ -180,7 +180,7 @@
)
except Exception as e:
raise peltool_exception(
- "Exception occured during PEL and Event log "
+ "Exception occurred during PEL and Event log "
"comparison for SRC or event ID and created "
"time : "
+ str(e)
diff --git a/lib/rest_client.robot b/lib/rest_client.robot
index d5462fd..c82087f 100644
--- a/lib/rest_client.robot
+++ b/lib/rest_client.robot
@@ -210,7 +210,7 @@
... X-Auth-Token=${XAUTH_TOKEN}
${data}= Create dictionary data=@{EMPTY}
- # If there is no active sesion it will throw the following exception
+ # If there is no active session it will throw the following exception
# "Non-existing index or alias 'openbmc'"
${resp}= POST On Session openbmc
... /logout json=${data} headers=${headers}
diff --git a/openpower/tests_openbmctool/test_openbmctool_network.robot b/openpower/tests_openbmctool/test_openbmctool_network.robot
index c776edf..f154c9f 100755
--- a/openpower/tests_openbmctool/test_openbmctool_network.robot
+++ b/openpower/tests_openbmctool/test_openbmctool_network.robot
@@ -1,5 +1,5 @@
*** Settings ***
-Documentation Verify OBMC tool's network fuctionality.
+Documentation Verify OBMC tool's network functionality.
Library String
diff --git a/redfish/managers/test_bmc_ipv6.robot b/redfish/managers/test_bmc_ipv6.robot
index 913ace8..55c07c7 100644
--- a/redfish/managers/test_bmc_ipv6.robot
+++ b/redfish/managers/test_bmc_ipv6.robot
@@ -17,7 +17,7 @@
${test_ipv6_addr} 2001:db8:3333:4444:5555:6666:7777:8888
${test_ipv6_invalid_addr} 2001:db8:3333:4444:5555:6666:7777:JJKK
-# Valid prefix length is a intiger ranges from 1 to 128.
+# Valid prefix length is a integer ranges from 1 to 128.
${test_prefix_lenght} 64
diff --git a/redfish/service_root/test_service_root.robot b/redfish/service_root/test_service_root.robot
index f5c03ce..573cca3 100644
--- a/redfish/service_root/test_service_root.robot
+++ b/redfish/service_root/test_service_root.robot
@@ -131,7 +131,7 @@
*** Keywords ***
GET And Verify Redfish Response
- [Documentation] GET given resource and verfiy response.
+ [Documentation] GET given resource and verify response.
[Arguments] ${valid_status_codes} ${resource_path}
# Description of argument(s):
diff --git a/redfish/update_service/test_firmware_inventory.robot b/redfish/update_service/test_firmware_inventory.robot
index 2c25fbe..c8fabe6 100644
--- a/redfish/update_service/test_firmware_inventory.robot
+++ b/redfish/update_service/test_firmware_inventory.robot
@@ -322,7 +322,7 @@
[Arguments] ${image}
# Description of argument(s):
- # image Fucntional Image or Backup Image
+ # image Functional Image or Backup Image
Verify Firmware Version Same In Firmware Inventory And Managers
diff --git a/syslib/utils_keywords.py b/syslib/utils_keywords.py
index 2a33736..456af6f 100644
--- a/syslib/utils_keywords.py
+++ b/syslib/utils_keywords.py
@@ -10,7 +10,7 @@
from robot.libraries.BuiltIn import BuiltIn
except ImportError:
pass
-import os
+import re
import time
@@ -189,7 +189,7 @@
error_list = []
error_list = htx_error_log_to_list(htx_error_log_output)
- # dictionary which holds the error dictionry entry.
+ # dictionary which holds the error dictionary entry.
error_dict = {}
temp_error_dict = {}
diff --git a/tests/test_remote_logging.robot b/tests/test_remote_logging.robot
index eafc645..580442a 100644
--- a/tests/test_remote_logging.robot
+++ b/tests/test_remote_logging.robot
@@ -156,9 +156,9 @@
... msg=${bmc_journald} doesn't contain rsyslog retry entries.
-Verfiy BMC Journald Synced To Remote Logging Server
+Verify BMC Journald Synced To Remote Logging Server
[Documentation] Check that BMC journald is sync to remote rsyslog.
- [Tags] Verfiy_BMC_Journald_Synced_To_Remote_Logging_Server
+ [Tags] Verify_BMC_Journald_Synced_To_Remote_Logging_Server
# Restart BMC dump service and get the last entry of the journald.
# Example: