Add missing documentation
Changes:
Add missing documentation in test scripts
Tested:
NA
Change-Id: I7edfde924df15bce78e77010484eb25bf8ee1caf
Signed-off-by: Sridevi Ramesh <sridevra@in.ibm.com>
diff --git a/lib/bmc_date_and_time_utils.robot b/lib/bmc_date_and_time_utils.robot
index 0140b11..6dde95c 100644
--- a/lib/bmc_date_and_time_utils.robot
+++ b/lib/bmc_date_and_time_utils.robot
@@ -87,6 +87,8 @@
Set NTP state
[Documentation] Set NTP service inactive.
[Arguments] ${state}
+ # Description of argument(s):
+ # state NTP protocol state (True/False).
Redfish.Patch ${REDFISH_NW_PROTOCOL_URI} body={'NTP':{'ProtocolEnabled': ${state}}}
... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
diff --git a/lib/bmc_network_utils.robot b/lib/bmc_network_utils.robot
index 3ecf2f6..8cfb367 100644
--- a/lib/bmc_network_utils.robot
+++ b/lib/bmc_network_utils.robot
@@ -351,7 +351,10 @@
[Arguments] ${hostname} ${status_code}=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
# Description of argument(s):
- # hostname A hostname value which is to be configured on BMC.
+ # hostname A hostname value which is to be configured on BMC.
+ # status_codes Expected return code from patch operation
+ # (e.g. "200"). See prolog of rest_request
+ # method in redfish_plus.py for details.
${active_channel_config}= Get Active Channel Config
${ethernet_interface}= Set Variable ${active_channel_config['${CHANNEL_NUMBER}']['name']}
@@ -426,7 +429,10 @@
... ${valid_status_codes}=${HTTP_OK}
# Description of Argument(s):
- # static_name_servers: Address for static name server
+ # static_name_servers Address for static name server
+ # valid_status_codes Expected return code from patch operation
+ # (e.g. "200"). See prolog of rest_request
+ # method in redfish_plus.py for details.
${cli_nameservers}= CLI Get Nameservers
${cmd_status}= Run Keyword And Return Status
@@ -594,8 +600,8 @@
[Arguments] ${id} ${interface}=eth0 ${expected_result}=valid
# Description of argument(s):
- # id The VLAN ID (e.g. '53').
- # interface The physical interface for the VLAN(e.g. 'eth0').
+ # id The VLAN ID (e.g. '53').
+ # interface The physical interface for the VLAN(e.g. 'eth0').
# expected_result Expected status of VLAN configuration.
@{data_vlan_id}= Create List ${interface} ${id}
@@ -706,8 +712,8 @@
[Documentation] Get Valid Channel Number.
[Arguments] ${valid_channel_number_interface_names}
- #Description of argument(s):
- #valid_channel_number_interface_names Contains channel names in dict.
+ # Description of argument(s):
+ # valid_channel_number_interface_names Contains channel names in dict.
&{valid_channel_number_interface_name}= Create Dictionary
@@ -776,6 +782,9 @@
[Documentation] Get Available channels from channel_config.json file and return as list.
[Arguments] ${current_channel}=${0}
+ # Description of Arguments
+ # ${current_channel} Current channel number.
+
${valid_channel_number_interface_names}= Get Channel Number For All Interface
${valid_channel_number_interface_name}= Get Valid Channel Number ${valid_channel_number_interface_names}
@@ -904,6 +913,9 @@
# Description of the argument(s):
# static_name_servers A list of static name server IPs to be
# configured on the BMC.
+ # valid_status_codes Expected return code from patch operation
+ # (e.g. "200"). See prolog of rest_request
+ # method in redfish_plus.py for details.
${active_channel_config}= Get Active Channel Config
${ethernet_interface}= Set Variable ${active_channel_config['${CHANNEL_NUMBER}']['name']}
diff --git a/lib/dmtf_tools_utils.robot b/lib/dmtf_tools_utils.robot
index c379bf3..ca8893e 100644
--- a/lib/dmtf_tools_utils.robot
+++ b/lib/dmtf_tools_utils.robot
@@ -18,6 +18,7 @@
# Description of arguments:
# rsv_dir_path Directory path for rsv tool (e.g. "Redfish-Service-Validator").
# rsv_github_url Github URL link(e.g "https://github.com/DMTF/Redfish-Service-Validator").
+ # branch_name Name of the branch.
${cmd_buf} Catenate rm -rf ${rsv_dir_path} ;
... git clone --branch ${branch_name} ${rsv_github_url} ${rsv_dir_path}
@@ -42,6 +43,9 @@
[Documentation] Check tool output for errors.
[Arguments] ${tool_output}
+ # Description of arguments:
+ # tool_output DMTF tool output.
+
# Example:
# Validation has failed: 9 problems found
# Service could not be started: RetriesExhaustedError()
@@ -53,6 +57,9 @@
[Documentation] Check tool output for errors.
[Arguments] ${tool_output}
+ # Description of arguments:
+ # tool_output DMTF tool output.
+
# Example:
# 0 errors
Should Contain ${tool_output} 0 errors
diff --git a/lib/xcat/xcat_utils.robot b/lib/xcat/xcat_utils.robot
index 55131cf..b221290 100644
--- a/lib/xcat/xcat_utils.robot
+++ b/lib/xcat/xcat_utils.robot
@@ -44,9 +44,9 @@
[Arguments] ${node_cfg_file_path}=${NODE_CFG_FILE_PATH}
# Get the list of BMC nodes to be added.
- # This keyword expects file having list of BMC nodes
- # as an input.
- # File should have IP addresses of BMC nodes.
+ # node_cfg_file_path This keyword expects file having list of BMC nodes
+ # as an input.
+ # File should have IP addresses of BMC nodes.
OperatingSystem.File Should Exist ${node_cfg_file_path} msg=cfg file missing.
File Should Not Be Empty ${node_cfg_file_path} msg=Empty config file.
@@ -54,18 +54,22 @@
${bmc_list}= OperatingSystem.Get File ${node_cfg_file_path}
RETURN ${bmc_list}
+
Add Nodes To XCAT
[Documentation] Add nodes to XCAT configuration.
[Arguments] ${node} ${username}=${OPENBMC_USERNAME}
... ${password}=${OPENBMC_PASSWORD}
# Description of the argument(s):
- # node Name of the node to be added.
+ # node Name of the node to be added.
+ # username User name to login.
+ # password Password to login.
${cmd_buf}= Catenate ${XCAT_DIR_PATH}/mkdef ${node} bmc=${node}
... bmcusername=${username} bmcpassword=${password} mgt=openbmc groups=all
Execute Command ${cmd_buf}
+
Validate Added Node
[Documentation] Validate added node.
[Arguments] ${node}