Add missing description for args
Changes:
Add missing description for keyword arguments
Testing:
NA
Change-Id: Ie75ba980a17a3d49e0eb1e5ca85ba1eb2e8a0201
Signed-off-by: Sridevi Ramesh <sridevra@in.ibm.com>
diff --git a/ipmi/test_ipmi_chassis.robot b/ipmi/test_ipmi_chassis.robot
index 2f0cf48..dca1230 100644
--- a/ipmi/test_ipmi_chassis.robot
+++ b/ipmi/test_ipmi_chassis.robot
@@ -26,7 +26,7 @@
IPMI Chassis Status On
[Documentation] This test case verifies system power on status
- ... using IPMI Get Chassis status command.
+ ... using IPMI Get Chassis status command.
[Tags] IPMI_Chassis_Status_On
Redfish Power On stack_mode=skip quiet=1
@@ -36,7 +36,7 @@
IPMI Chassis Status Off
[Documentation] This test case verifies system power off status
- ... using IPMI Get Chassis status command.
+ ... using IPMI Get Chassis status command.
[Tags] IPMI_Chassis_Status_Off
Redfish Power Off stack_mode=skip quiet=1
@@ -169,6 +169,9 @@
[Documentation] Set Chassis Status via IPMI and verify and verify chassis status.
[Arguments] ${power_policy}
+ # Description of argument(s):
+ # power_policy Chassis power policy to be set(e.g. "always-off", "always-on").
+
# Sets power policy according to requested policy
Set Chassis Power Policy Via IPMI And Verify ${power_policy}
@@ -195,16 +198,22 @@
Should Be Equal As Strings ${policy} 11
END
- # Last Power Event - 4th bit should be 1b i.e, last ‘Power is on’ state was entered via IPMI command
+ # Last Power Event - 4th bit should be 1b i.e, last ‘Power is on’ state
+ # was entered via IPMI command
${last_power_event}= Convert To Binary ${status[1]} base=16
${last_power_event}= Zfill Data ${last_power_event} 8
Should Be Equal As Strings ${last_power_event[3]} 1
Verify Chassis Capabilities Response
- [Documentation] Will compare the ipmi response with thh busctl response for given property.
+ [Documentation] Compare the IPMI response with the busctl response for given property.
[Arguments] ${ipmi_response} ${busctl_response} ${property}
+ # Description of argument(s):
+ # ipmi_response IPMI response.
+ # busctl_response busctl command response.
+ # property property type (e.g. CapabilitiesFlags).
+
${ipmi_response}= Convert To Integer ${ipmi_response} 16
${busctl_value}= Get Regexp Matches ${busctl_response}
diff --git a/ipmi/test_ipmi_cipher.robot b/ipmi/test_ipmi_cipher.robot
index 5dea4f5..e6cb1cc 100644
--- a/ipmi/test_ipmi_cipher.robot
+++ b/ipmi/test_ipmi_cipher.robot
@@ -1,5 +1,6 @@
*** Settings ***
Documentation Module to test IPMI chipher functionality.
+
Resource ../lib/ipmi_client.robot
Resource ../lib/openbmc_ffdc.robot
Resource ../lib/bmc_network_utils.robot
@@ -79,7 +80,8 @@
Verify Cipher Suite And Supported Algorithms Via IPMI Raw Command
- [Documentation] Verify cipher ID and Supported Algorithms for all Available Channels.
+ [Documentation] Verify cipher ID and Supported Algorithms for all Available
+ ... Channels.
[Tags] Verify_Cipher_Suite_And_Supported_Algorithms_Via_IPMI_Raw_Command
[Template] Verify Cipher ID and Supported Algorithm For Channel
@@ -134,8 +136,9 @@
[Arguments] ${data_list} ${channel_number}
# Description of argument(s):
- # data_list cipher suite records in list
- # e.g [01, c0, 11, 03, 44, 81]
+ # data_list cipher suite records in list
+ # e.g [01, c0, 11, 03, 44, 81]
+ # channel_number Interface channel number
${supported_algorithms}= Split String ${IPMI_RAW_CMD['Cipher Suite']['get'][1]}
${cipher_suite_id}= Convert To Integer ${data_list}[2] base=16
@@ -152,9 +155,9 @@
[Arguments] ${response_data} ${channel_number}
# Description of argument(s):
- # response_data response data of get channel cipher suite ipmi raw command
+ # response_data Response data of get channel cipher suite IPMI raw command
# e.g 01 c0 11 03 44 81 ---> list of algorithms by cipher suite (0x80 in request data 3rd byte)
- # ${channel_number} Interface channel number
+ # channel_number Interface channel number
@{expected_data_list}= Split String ${response_data}
@@ -167,7 +170,7 @@
[Arguments] ${response_data} ${channel_number}
# Description of argument(s):
- # response_data response data of get channel cipher suite ipmi raw command.
+ # response_data response data of get channel cipher suite IPMI raw command.
# channel_number Interface Channel Number.
# expected data will be like " 01 03 44 81 ".
@@ -180,8 +183,8 @@
[Arguments] ${channel_num} ${payload_type} ${index_value}
# Description of argument(s):
- # channel_num Interface channel number.
- # payload_type IPMI(0x00) or Sol(0x01).
+ # channel_num Interface channel number.
+ # payload_type IPMI(0x00) or SOL(0x01).
# index_value 0x80 for list algorithm by cipher suite.
# 0x00 for supported algorithms.
diff --git a/ipmi/test_ipmi_fru_device.robot b/ipmi/test_ipmi_fru_device.robot
index 533a95f..9f325be 100644
--- a/ipmi/test_ipmi_fru_device.robot
+++ b/ipmi/test_ipmi_fru_device.robot
@@ -323,9 +323,9 @@
[Documentation] Read FRU data using IPMI raw command.
[Arguments] ${fru_id} ${offset}
- # Description of Argument(s):
- # fru_id FRU id.
- # offset Offset byte for read FRU command.
+ # Description of Argument(s):
+ # fru_id FRU id.
+ # offset Offset byte for read FRU command.
# IPMI Read FRU Data Command.
# 0xff - Count to read --- count is ‘1’ based
@@ -339,11 +339,11 @@
[Documentation] Write FRU data using IPMI raw command.
[Arguments] ${fru_id} ${offset} ${data} ${length}
- # Description of Argument(s):
- # fru_id FRU id.
- # offset Offset byte for read FRU command.
- # data Data to write for write FRU command.
- # length Count of bytes that gets written in write FRU command.
+ # Description of Argument(s):
+ # fru_id FRU id.
+ # offset Offset byte for read FRU command.
+ # data Data to write for write FRU command.
+ # length Count of bytes that gets written in write FRU command.
# IPMI Write FRU Data Command.
${resp}= Run IPMI Command
diff --git a/ipmi/test_ipmi_general.robot b/ipmi/test_ipmi_general.robot
index 5cede0e..3ddb048 100644
--- a/ipmi/test_ipmi_general.robot
+++ b/ipmi/test_ipmi_general.robot
@@ -319,13 +319,14 @@
Set Session Privilege Level And Verify
- [Documentation] Set session privilege with given privilege level and verify the response with
- ... expected level.
+ [Documentation] Set session privilege with given privilege level and
+ ... verify the response with expected level.
[Arguments] ${privilege_level} ${expected_level}
+
# Description of argument(s):
# privilege_level Requested Privilege Level.
- # expected_level New Privilege Level (or present level if ‘return present privilege level’
- # was selected).
+ # expected_level New Privilege Level (or present level if
+ # ‘return present privilege level’ was selected).
${resp}= Run External IPMI Raw Command
... 0x06 0x3b ${privilege_level}
@@ -335,6 +336,7 @@
Set Invalid Session Privilege Level And Verify
[Documentation] Set invalid session privilege level and verify the response.
[Arguments] ${privilege_level}
+
# Description of argument(s):
# privilege_level Requested Privilege Level.
@@ -356,8 +358,9 @@
Verify Identify LED State Via Redfish
[Documentation] Verify that Redfish identify LED system with given state.
[Arguments] ${expected_state}
+
# Description of argument(s):
- # expected_led_status Expected value of Identify LED.
+ # expected_state Expected state of Identify LED.
# Get the following URI(s) and iterate to find the attribute IndicatorLED.
# Example:
diff --git a/ipmi/test_ipmi_inband_sdr.robot b/ipmi/test_ipmi_inband_sdr.robot
index 75f645f..63bfe50 100644
--- a/ipmi/test_ipmi_inband_sdr.robot
+++ b/ipmi/test_ipmi_inband_sdr.robot
@@ -507,7 +507,8 @@
Suite Setup Execution
- [Documentation] Do suite setup tasks.
+ [Documentation] Do suite setup tasks.
+
Redfish.Login
Should Not Be Empty ${OS_HOST} msg=Please provide required parameter OS_HOST
Should Not Be Empty ${OS_USERNAME} msg=Please provide required parameter OS_USERNAME
diff --git a/ipmi/test_ipmi_kcs.robot b/ipmi/test_ipmi_kcs.robot
index 64d24d0..fc207d9 100644
--- a/ipmi/test_ipmi_kcs.robot
+++ b/ipmi/test_ipmi_kcs.robot
@@ -26,7 +26,7 @@
Verify KCS Raw IPMI Multiple Times
- [Documentation] Verify KCS interface raw ipmi command for multiple times.
+ [Documentation] Verify KCS interface raw IPMI command for multiple times.
[Tags] Verify_KCS_Raw_IPMI_Multiple_Times
Repeat Keyword ${LOOP_COUNT} times Verify KCS Interface Commands
diff --git a/ipmi/test_ipmi_lanplus.robot b/ipmi/test_ipmi_lanplus.robot
index 34dc5fe..84d40a8 100644
--- a/ipmi/test_ipmi_lanplus.robot
+++ b/ipmi/test_ipmi_lanplus.robot
@@ -17,7 +17,7 @@
*** Test Cases ***
Verify Lanplus Raw IPMI Commands Multiple Times
- [Documentation] Verify Lanplus interface With raw ipmi command for multiple times.
+ [Documentation] Verify Lanplus interface With raw IPMI command for multiple times.
[Tags] Verify_Lanplus_Raw_IPMI_Commands_Multiple_Times
Repeat Keyword ${LOOP_COUNT} times Verify Lanplus Interface Commands