Add fan testing

Add power-on system fan automation tests, and
update the fan utilities.  Update the power-off
fan tests due to changes in the utilities.
Add 'Error Logs Should Exist' keyword.

Resolves openbmc/openbmc-test-automation#1174
Resolves openbmc/openbmc-test-automation#999
Resolves openbmc/openbmc-test-automation#616

Change-Id: Ic957516c53513dad16bc4cf188d6dfd20ddc5228
Signed-off-by: Steven Sombar <ssombar@us.ibm.com>
diff --git a/lib/fan_utils.robot b/lib/fan_utils.robot
index 7eb9ad7..9bde67b 100755
--- a/lib/fan_utils.robot
+++ b/lib/fan_utils.robot
@@ -1,12 +1,12 @@
 *** Settings ***
-Documentation     Utilities for fan tests.
+Documentation  Utilities for fan tests.
 
-Library       ../lib/bmc_ssh_utils.py
-Variables     ../data/variables.py
+Library        ../lib/bmc_ssh_utils.py
+Resource       ../lib/openbmc_ffdc_utils.robot
+Variables      ../data/variables.py
 
 *** Keywords ***
 
-
 Is Water Cooled
     [Documentation]  Return 1 if system is water cooled, 0 othersise.
 
@@ -15,26 +15,87 @@
     [Return]  ${water_cooled}
 
 
-Get Number Of Fans
-    [Documentation]  Get the number of fans currently present in inventory.
+Get Fan Names
+    [Documentation]  Get the names of fans marked present in inventory.
+    [Arguments]  ${fan_names}
+    # This keyword populates the fan_names list with the names of
+    # fans present in inventory e.g. fan0, fan2, fan3.
 
-    ${num_fans}  Set Variable  ${0}
+    # Description of Argument(s):
+    # fan_names   The list of fan names to which new fan names are to be
+    #             added to.  This list is returned to the caller.
+
     ${fan_uris}=  Get Endpoint Paths  ${HOST_INVENTORY_URI}/system  fan
-
     : FOR  ${fan_uri}  IN  @{fan_uris}
-    \  ${fan_record}=  Read Properties  ${fan_uri}
-    \  Continue For Loop If  ${fan_record['Present']} != 1
-    \  ${num_fans}=  Set Variable  ${num_fans+1}
-    [Return]  ${num_fans}
+    \  ${fan_properties}=  Read Properties  ${fan_uri}
+    \  Continue For Loop If  ${fan_properties['Present']} != 1
+    \  ${remaining_uri}  ${fan_name}=  Split Path  ${fan_uri}
+    \  Append To List  ${fan_names}  ${fan_name}
+
+    [Return]  ${fan_names}
+
+
+Verify System Error Indication Due To Fans
+    [Documentation]  Verify enclosure LEDs are on and there's an error log.
+
+    # Both enclosure LEDs should now be On.
+    Verify Front And Rear LED State  On
+
+    # An error log should now exist.
+    Error Logs Should Exist
+
+
+Verify Front And Rear LED State
+    [Documentation]  Check state of the front and rear enclsure fault LEDs.
+    [Arguments]  ${state}
+    # Both LEDs should be in the specified state.  If not fail the test case.
+
+    # Description of Argument(s):
+    # state    The state to check for, either 'Off' or 'On'.
+
+    ${front_fault}=  Get System LED State  front_fault
+    ${rear_fault}=  Get System LED State  rear_fault
+    Run Keyword If
+    ...  '${front_fault}' != '${state}' or '${rear_fault}' != '${state}'
+    ...  Fail  msg=Expecting both enclosure LEDs to be ${state}.
+
+
+Set Fan State
+    [Documentation]  Set the fan state, either functional or non-functional.
+    [Arguments]  ${fan_name}  ${fan_state}
+
+    # Description of Argument(s):
+    # fan_name     The name of the fan, e.g. "fan2".
+    # fan_state    The state to set, 1 for functional, 2 for non-functional.
+
+    ${valueDict}=  Create Dictionary  data=${fan_state}
+    Write Attribute
+    ...  ${HOST_INVENTORY_URI}system/chassis/motherboard/${fan_name}
+    ...  Functional  data=${valueDict}
+
+
+Get Target Speed Of Fans
+    [Documentation]  Return the maximum target RPM speed of the system fans.
+
+    ${max_target}=  Set Variable  0
+    ${paths}=  Get Endpoint Paths  ${SENSORS_URI}fan_tach/  0
+    :FOR  ${path}  IN  @{paths}
+    \  ${response}=  OpenBMC Get Request  ${path}
+    \  ${json}=  To JSON  ${response.content}
+    \  ${target_speed}=  Set Variable  ${json["data"]["Target"]}
+    \  ${max_target}=  Run Keyword If  ${target_speed} > ${max_target}
+    ...  Set Variable  ${target_speed}  ELSE  Set Variable  ${max_target}
+    [Return]  ${max_target}
 
 
 Verify Minimum Number Of Fans With Cooling Type
     [Documentation]  Verify minimum number of fans.
-    [Arguments]  ${water_cooled}
+    [Arguments]  ${num_fans}  ${water_cooled}
 
     # Description of argument(s):
+    # num_fans       The number of fans present in the system.
     # water_cooled   The value 1 if the system is water cooled,
-    #                the value 0 if air cooled.
+    #                0 if air cooled.
 
     # For a water cooled system.
     ${min_fans_water}=  Set Variable  2
@@ -42,10 +103,8 @@
     # For an air cooled system.
     ${min_fans_air}=  Set Variable  3
 
-    ${num_fans}=  Get Number Of Fans
-
     Rprintn
-    Rpvars  water_cooled  num_fans
+    Rpvars  num_fans  water_cooled
 
     # If water cooled must have at least min_fans_water fans, otherwise
     # issue Fatal Error and terminate testing.
@@ -61,10 +120,10 @@
 
 Verify Fan Monitors With State
     [Documentation]  Verify fan monitor daemons in the system state.
+    [Arguments]  ${power_state}
     # The number of monitoring daemons is dependent upon the system
     # power state.  If power is off there should be 0, if power
     # is on there should be several.
-    [Arguments]  ${power_state}
 
     # Description of argument(s):
     # power_state   Power staet of the system, either "On" or "Off"
diff --git a/lib/openbmc_ffdc_utils.robot b/lib/openbmc_ffdc_utils.robot
index a2efabe..35e83fa 100644
--- a/lib/openbmc_ffdc_utils.robot
+++ b/lib/openbmc_ffdc_utils.robot
@@ -122,3 +122,11 @@
 
     ${resp}=  OpenBMC Get Request  ${BMC_LOGGING_ENTRY}/list  quiet=${1}
     Should Be Equal As Strings  ${resp.status_code}  ${HTTP_NOT_FOUND}
+
+
+Error Logs Should Exist
+    [Documentation]  Verify that error logs exist.
+
+    ${resp}=  OpenBMC Get Request  ${BMC_LOGGING_ENTRY}/list  quiet=${1}
+    Run Keyword If  ${resp.status_code} != ${HTTP_OK}  Fail
+    ...  msg=Expected BMC error log(s) are not present.