Enforced robotframework standards.
- The standards are enforced using the rflint static anylysis tool.
- More standards will be added in future commits but this is a base
starting point.
Change-Id: I7dd8a2b0b42a51327b748cb730609d7ee2538de3
Signed-off-by: Joy Onyerikwu <onyekachukwu.joy.onyerikwu@ibm.com>
diff --git a/tests/__init__.robot b/tests/__init__.robot
index 412821e..e3699c8 100644
--- a/tests/__init__.robot
+++ b/tests/__init__.robot
@@ -30,6 +30,7 @@
Run Keyword And Ignore Error Clear BMC Gard Record
Set Boot Defaults
+ [Documentation] Set boot defaults.
Set Control Boot Mode ${CONTROL_HOST_URI}/boot ${BOOT_MODE_REGULAR}
Set Control Boot Mode
... ${CONTROL_HOST_URI}/boot/one_time ${BOOT_MODE_REGULAR}
diff --git a/tests/test_boot_devices.robot b/tests/test_boot_devices.robot
index 3584eec..9811532 100644
--- a/tests/test_boot_devices.robot
+++ b/tests/test_boot_devices.robot
@@ -219,10 +219,12 @@
Response Should Be Equal
+ [Documentation] Verify that the output is equal to the given args.
[Arguments] ${args}
Should Be Equal ${OUTPUT} ${args}
Read the Attribute
+ [Documentation] Read the given attribute.
[Arguments] ${uri} ${parm}
${output}= Read Attribute ${uri} ${parm}
Set Test Variable ${OUTPUT} ${output}
diff --git a/tests/test_boot_policies.robot b/tests/test_boot_policies.robot
index f4c2bd7..02b049e 100644
--- a/tests/test_boot_policies.robot
+++ b/tests/test_boot_policies.robot
@@ -139,12 +139,14 @@
*** Keywords ***
Set Boot Mode
+ [Documentation] Set the host boot mode via REST.
[Arguments] ${args}
${bootmode}= Set Variable ${args}
${valueDict}= Create Dictionary data=${bootmode}
Write Attribute ${CONTROL_HOST_URI}/boot/ BootMode data=${valueDict}
Set Boot Policy
+ [Documentation] Set the host boot policy via REST.
[Arguments] ${args}
${bootpolicy}= Set Variable ${args}
${valueDict}= Create Dictionary data=${bootpolicy}
diff --git a/tests/test_hardware_sensors.robot b/tests/test_hardware_sensors.robot
index 237bcb8..eb7cc57 100644
--- a/tests/test_hardware_sensors.robot
+++ b/tests/test_hardware_sensors.robot
@@ -250,7 +250,7 @@
Enable Power Redundancy And Verify Using REST
[Documentation] Enable power redundancy and verify that it is enabled.
- [Tags] Enable_Power_Redundancy_And_Verify_Using REST
+ [Tags] Enable_Power_Redundancy_And_Verify_Using_REST
# Example:
# /xyz/openbmc_project/sensors/chassis/PowerSupplyRedundancy
diff --git a/tests/test_inventory.robot b/tests/test_inventory.robot
index 1f075c4..0d177e3 100644
--- a/tests/test_inventory.robot
+++ b/tests/test_inventory.robot
@@ -302,7 +302,7 @@
${core_list}= Get Endpoint Paths ${HOST_INVENTORY_URI}system core
:FOR ${core_uri} IN @{core_list}
\ ${status}= Run Keyword And Return Status
- ... Check URL Property If Functional ${core_uri}
+ ... Check URL Property Is Functional ${core_uri}
\ Continue For Loop If '${status}' == '${False}'
\ ${present}= Read Attribute ${core_uri} Present
\ Should Be True ${present}
@@ -331,7 +331,7 @@
${dimm_list}= Get Endpoint Paths ${HOST_INVENTORY_URI}system dimm
:FOR ${dimm_uri} IN @{dimm_list}
\ ${status}= Run Keyword And Return Status
- ... Check URL Property If Functional ${dimm_uri}
+ ... Check URL Property Is Functional ${dimm_uri}
\ Continue For Loop If '${status}' == '${False}'
\ ${present}= Read Attribute ${dimm_uri} Present
\ Should Be True ${present}
@@ -353,7 +353,7 @@
Should Not Be Empty ${fan_list}
:FOR ${fan_uri} IN @{fan_list}
\ ${status}= Run Keyword And Return Status
- ... Check URL Property If Functional ${fan_uri}
+ ... Check URL Property Is Functional ${fan_uri}
\ Continue For Loop If '${status}' == '${False}'
\ ${present}= Read Attribute ${fan_uri} Present
\ Should Be True ${present}
@@ -375,7 +375,7 @@
Should Not Be Empty ${cpu_list}
:FOR ${cpu_uri} IN @{cpu_list}
\ ${status}= Run Keyword And Return Status
- ... Check URL Property If Functional ${cpu_uri}
+ ... Check URL Property Is Functional ${cpu_uri}
\ Continue For Loop If '${status}' == '${False}'
\ ${present}= Read Attribute ${cpu_uri} Present
\ Should Be True ${present}
@@ -400,7 +400,7 @@
Should Not Be Empty ${gpu_list}
:FOR ${gpu_uri} IN @{gpu_list}
\ ${status}= Run Keyword And Return Status
- ... Check URL Property If Functional ${gpu_uri}
+ ... Check URL Property Is Functional ${gpu_uri}
\ Continue For Loop If '${status}' == '${False}'
\ ${present}= Read Attribute ${gpu_uri} Present
\ Should Be True ${present}
@@ -616,7 +616,8 @@
\ Should Be Equal ${fru_field.viewkeys()} ${fru_set}
-Check URL Property If Functional
+Check URL Property Is Functional
+ [Documentation] Verify that the given url property is functional.
[Arguments] ${url_path}
# Description of arguments:
# url_path Full url path of the inventory object.
diff --git a/tests/test_power_restore.robot b/tests/test_power_restore.robot
index f9479f6..c4dca6b 100644
--- a/tests/test_power_restore.robot
+++ b/tests/test_power_restore.robot
@@ -46,6 +46,7 @@
${ALWAYS_POWER_OFF} Running Running
+ [Documentation] Verify that the BMC restore policy is ALWAYS_POWER_OFF while the Host is running.
[Template] Verify Restore Policy
[Tags] Test_Restore_Policy_ALWAYS_POWER_OFF_With_Host_Running
@@ -74,6 +75,7 @@
${ALWAYS_POWER_ON} Running Running
+ [Documentation] Verify the BMC restore policy is ALWAYS_POWER_ON while the Host is running.
[Template] Verify Restore Policy
[Tags] Test_Restore_Policy_ALWAYS_POWER_ON_With_Host_Running
@@ -102,7 +104,7 @@
${RESTORE_LAST_STATE} Off Off
-
+ [Documentation] Verify the RESTORE_LAST_STATE restore policy functionality while the Host is off.
[Template] Verify Restore Policy
[Tags] Test_Restore_Policy_Restore_Last_State_With_Host_Off
diff --git a/tests/test_rest_interfaces.robot b/tests/test_rest_interfaces.robot
index 87db39b..82d621f 100644
--- a/tests/test_rest_interfaces.robot
+++ b/tests/test_rest_interfaces.robot
@@ -94,7 +94,8 @@
# Example:
# Response code:404, Content:{
# "data": {
- # "description": "org.freedesktop.DBus.Error.FileNotFound: path or object not found: /xyz/idont/exist"
+ # "description": "org.freedesktop.DBus.Error.FileNotFound: path or object not found:
+ # /xyz/idont/exist"
# },
# "message": "404 Not Found",
# "status": "error"
@@ -102,8 +103,8 @@
${resp}= OpenBMC Get Request /xyz/idont/exist/
${jsondata}= To JSON ${resp.content}
- Should Be Equal As Strings
- ... ${jsondata["data"]["description"]} org.freedesktop.DBus.Error.FileNotFound: path or object not found: /xyz/idont/exist
+ Should Be Equal As Strings ${jsondata["data"]["description"]}
+ ... org.freedesktop.DBus.Error.FileNotFound: path or object not found: /xyz/idont/exist
Should Be Equal As Strings ${jsondata["message"]} 404 Not Found
Should Be Equal As Strings ${jsondata["status"]} error
@@ -328,7 +329,8 @@
#--------------------------------------------------------------------
# URL Path Parm Data
#--------------------------------------------------------------------
- /xyz/openbmc_project/state/host0/attr/RequestedHostTransition xyz.openbmc_project.State.Host.Transition.Off
+ /xyz/openbmc_project/state/host0/attr/RequestedHostTransition
+ ... xyz.openbmc_project.State.Host.Transition.Off
[Tags] Put_Data_Validation
[Template] Execute Put And Expect Success
diff --git a/tests/test_sensors.robot b/tests/test_sensors.robot
index 5db2436..05840c6 100644
--- a/tests/test_sensors.robot
+++ b/tests/test_sensors.robot
@@ -24,11 +24,13 @@
*** Test Cases ***
io_board Present
+ [Documentation] Verify that the IO board is present.
[Tags] io_board_Present
${uri}= Get System component io_board
Verify The Attribute ${uri} Present ${True}
io_board Fault
+ [Documentation] Verify that the IO board signals "fault".
[Tags] io_board_Fault
${uri}= Get System component io_board
Verify The Attribute ${uri} fault ${False}
@@ -46,6 +48,7 @@
log Dictionary ${resp}
Get System component
+ [Documentation] Get the system component.
[Arguments] ${type}
${list}= Get Dictionary Keys ${SYSTEM_INFO}
${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${type}[0-9]*$
diff --git a/tests/test_soft_boot_sensors.robot b/tests/test_soft_boot_sensors.robot
index d90fec2..aca4055 100644
--- a/tests/test_soft_boot_sensors.robot
+++ b/tests/test_soft_boot_sensors.robot
@@ -36,6 +36,7 @@
Verify Boot AttemptsLeft At Host Booted
+ [Documentation] Verify the number of Host boot attempts left.
[Tags] Verify_Boot_AttemptsLeft_At_Host_Booted
[Template] Validate Boot AttemptsLeft
@@ -44,6 +45,7 @@
Verify Boot AttemptsLeft When Host Reboot
+ [Documentation] Verify the number of Host reboots left.
[Tags] Verify_Boot_AttemptsLeft_When_Host_Reboot
[Template] Validate Boot AttemptsLeft
@@ -52,6 +54,7 @@
Verify Boot AttemptsLeft When Power Off
+ [Documentation] Verify the number of boots left while the system is poweref off.
[Tags] Verify_Boot_AttemptsLeft_When_Power_Off
[Template] Validate Boot AttemptsLeft