FIX: Remove old restart sequence - Honeycomb
[csit.git] / resources / libraries / robot / honeycomb / honeycomb.robot
index 7418078..d446b7c 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2017 Cisco and/or its affiliates.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at:
 # limitations under the License.
 
 *** Settings ***
-| Library | resources/libraries/python/HoneycombSetup.py
-| Library | resources/libraries/python/HoneycombUtil.py
-| Library | resources/libraries/python/HTTPRequest.py
+| Library | resources.libraries.python.honeycomb.HoneycombSetup
+| Library | resources.libraries.python.honeycomb.HoneycombUtil
+| Library | resources.libraries.python.honeycomb.HcPersistence
+| Library | resources.libraries.python.DUTSetup
+| Library | resources.libraries.python.InterfaceUtil
+| Resource | resources/libraries/robot/shared/default.robot
 
 *** Keywords ***
-| Setup Honeycomb service on DUTs
-| | [Documentation] | *Setup environment for honeycomb testing*
+| Configure Honeycomb service on DUTs
+| | [Documentation] | *Setup environment for honeycomb testing.*
 | | ...
 | | ... | _Setup steps:_
 | | ... | - 1. Login to each honeycomb node using ssh
 | | ... | connection refused -> 404 -> 401 -> 503 or 500 -> 200 (pass)
 | | ... | - 4. Configure honeycomb nodes using HTTP PUT request
 | | ...
+| | ... | _Arguments:_
+| | ... | - duts - list of nodes to setup Honeycomb on
+| | ...
 | | ... | _Used global constants and variables:_
 | | ... | - RESOURCES_TPL_HC - path to honeycomb templates directory
 | | ... | - HTTPCodes - HTTP protocol status codes
-| | ... | - ${nodes} - dictionary of all nodes in topology.YAML file
 | | ...
 | | [Arguments] | @{duts}
 | | Start honeycomb on DUTs | @{duts}
-| | Wait until keyword succeeds | 4min | 20sec
-| | ... | Check honeycomb startup state | @{duts}
+| | :FOR | ${dut} | IN | @{duts}
+| | | Check honeycomb startup state | @{duts}
+| | | Sleep | 5s | Make sure all modules are loaded and ready.
 
-| Stop honeycomb service on DUTs
-| | [Documentation] | *Cleanup environment after honeycomb testing*
+| Stop Honeycomb service on DUTs
+| | [Documentation] | *Cleanup environment after honeycomb testing.*
 | | ...
 | | ... | _Teardown steps:_
 | | ... | - 1. Login to each honeycomb node using ssh
 | | ... | Expected sequence of HTTP replies:
 | | ... | 200 -> 404 -> connection refused (pass)
 | | ...
+| | ... | _Arguments:_
+| | ... | - duts - list of nodes to stop Honeycomb on
+| | ...
 | | ... | _Used global constants and variables:_
 | | ... | - RESOURCES_TPL_HC - path to honeycomb templates directory
 | | ... | - HTTPCodes - HTTP protocol status codes
-| | ... | - ${nodes} - dictionary of all nodes in topology.YAML file
 | | ...
 | | [Arguments] | @{duts}
 | | Stop honeycomb on DUTs | @{duts}
-| | Wait until keyword succeeds | 2m | 10s
-| | ... | Check honeycomb shutdown state | @{duts}
+| | :FOR | ${dut} | IN | @{duts}
+| | | Wait until keyword succeeds | 60sec | 15sec
+| | | ... | Check honeycomb shutdown state | @{duts}
+
+| Clear persisted Honeycomb configuration
+| | [Documentation] | *Delete saved configuration.*
+| | ...
+| | ... | *Arguments:*
+| | ... | - duts - one or more nodes to clear persistence on. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Clear persisted Honeycomb configuration \| ${nodes['DUT1']} \|
+| | ...
+| | [Arguments] | @{duts}
+| | Clear persisted Honeycomb config | @{duts}
+
+| Restart Honeycomb and VPP and clear persisted configuration
+| | [Documentation] | Restarts Honeycomb and VPP with default configuration.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Restart Honeycomb and VPP and clear persisted configuration \
+| | ... | \| ${nodes['DUT1']} \|
+| | ...
+| | [Arguments] | ${node}
+| | Stop Honeycomb service on DUTs | ${node}
+| | Clear persisted Honeycomb configuration | ${node}
+| | Restart Vpp Service | ${node}
+| | Verify Vpp | ${node}
+| | VPP Enable Traces On DUT | ${node}
+| | Configure Honeycomb service on DUTs | ${node}
+
+| Restart Honeycomb and VPP
+| | [Documentation] | Stops the Honeycomb service and verifies it is stopped.
+| | ... | Then restarts VPP, starts Honeycomb again and verifies it is running.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Restart Honeycomb and VPP \| ${nodes['DUT1']} \|
+| | ...
+| | [Arguments] | ${node}
+| | Stop Honeycomb service on DUTs | ${node}
+| | Restart Vpp Service | ${node}
+| | Verify Vpp | ${node}
+| | VPP Enable Traces On DUT | ${node}
+| | Configure Honeycomb service on DUTs | ${node}
+
+| Restart Honeycomb and VPP in performance test
+| | [Documentation] | Stops Honeycomb and VPP and verifies HC is stopped.
+| | ... | Then restarts VPP, starts Honeycomb again and verifies it is running.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Restart Honeycomb and VPP \| ${nodes['DUT1']} \|
+| | ...
+| | [Arguments] | ${node}
+| | Stop Honeycomb service on DUTs | ${node}
+| | Restart Vpp Service | ${node}
+| | Verify Vpp | ${node}
+| | VPP Enable Traces On DUT | ${node}
+| | Configure Honeycomb service on DUTs | ${node}
+| | Check honeycomb startup state | ${node} | timeout=120
+
+| Archive Honeycomb logs
+| | [Documentation] | Copies log files from Honeycomb node\
+| | ... | to test executor.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - perf - Running on performance testbed? Yes/no Type: boolean
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Archive Honeycomb logs \| ${nudes['DUT1']} \|
+| | ...
+| | [Arguments] | ${node} | ${perf}=${False}
+| | Archive Honeycomb log | ${node} | ${perf}
+| | Archive ODL log | ${node}
+
+| Configure ODL Client Service On DUT
+| | [Documentation] | Configure and start ODL client, then repeatedly check if
+| | ... | it is running.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - odl_name - Name of ODL client version. Type: string
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Configure ODL Client Service on DUT \| ${nodes['DUT1']} \
+| | ... | \| carbon-SR1 \|
+| | ...
+| | [Arguments] | ${node} | ${odl_name}
+| | Copy ODL Client | ${node} | ${odl_name} | /mnt/common | /tmp
+| | Setup ODL Client | ${node} | /tmp
+| | Wait until keyword succeeds | 3min | 30sec
+| | ... | Install ODL Features | ${node} | /tmp
+| | Wait until keyword succeeds | 4min | 15sec
+| | ... | Mount Honeycomb on ODL | ${node}
+| | Wait until keyword succeeds | 2min | 15sec
+| | ... | Check ODL startup state | ${node}
+| | Check honeycomb startup state | ${node} | timeout=120
+
+| Configure Honeycomb for functional testing
+| | [Documentation] | Configure Honeycomb with parameters for functional
+| | ... | testing, then start Honeycomb and repeatedly check startup status.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Configure Honeycomb for functional testing \| ${nodes['DUT1']} \|
+| | ...
+| | [Arguments] | ${node}
+| | Configure Restconf binding address | ${node}
+| | Configure Log Level | ${node} | TRACE
+| | Configure Persistence | ${node} | disable
+| | Configure jVPP timeout | ${node} | ${10}
+| | Generate Honeycomb startup configuration for ODL test | ${node}
+| | Clear Persisted Honeycomb Configuration | ${node}
+| | Configure Honeycomb service on DUTs | ${node}
+
+| Configure ODL Client for functional testing
+| | [Documentation] | Read external variable HC_ODL. Depending on its
+| | ... | value either: do nothing, or setup ODL client for testing and
+| | ... | create a global variable that modifies Restconf requests to use ODL.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Configure ODL Client for functional testing \| ${nodes['DUT1']} \|
+| | ...
+| | [Arguments] | ${node}
+| | ${use_odl_client}= | Get Variable Value | ${HC_ODL}
+| | Run Keyword If | '${use_odl_client}' != '${NONE}'
+| | ... | Run Keywords
+| | ... | Set Global Variable | ${use_odl_client} | AND
+| | ... | Configure ODL Client Service On DUT | ${node} | ${use_odl_client}
+| | ... | ELSE | Log | Variable HC_ODL is not present. Not using ODL.
+| | ... | level=INFO
+
+| Set Up Honeycomb Functional Test Suite
+| | [Documentation] | Generic test suite setup for Honeycomb functional tests.
+| | ... | Restarts VPP, then enables Honeycomb and optionally ODL, based
+| | ... | on external variable.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Set Up Honeycomb Functional Test Suite \| ${nodes['DUT1']} \|
+| | ...
+| | [Arguments] | ${node}
+| | Restart Vpp Service | ${node}
+| | Verify Vpp | ${node}
+| | VPP Enable Traces On DUT | ${node}
+| | Configure all TGs for traffic script
+| | Configure Honeycomb for functional testing | ${node}
+| | Configure ODL Client for functional testing | ${node}
+
+| Tear Down Honeycomb Functional Test Suite
+| | [Documentation] | Generic test suite teardown for Honeycomb functional
+| | ... | tests. Stops ODL client (if used), then stops Honeycomb and verifies
+| | ... | that they are both stopped.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Tear Down Honeycomb Functional Test Suite \| ${nodes['DUT1']} \|
+| | ...
+| | [Arguments] | ${node}
+| | Append suite to Honeycomb log file | ${node}
+| | ${use_odl_client}= | Get Variable Value | ${HC_ODL}
+| | Run Keyword If | '${use_odl_client}' != '${NONE}'
+| | ... | Run Keywords
+| | ... | Append suite to ODL log file | ${node} | ${use_odl_client} | AND
+| | ... | Stop ODL Client | ${node} | /tmp | AND
+| | ... | Wait until keyword succeeds | 3min | 15sec
+| | ... | Check ODL shutdown state | ${node} | AND
+| | ... | Set Global Variable | ${use_odl_client} | ${NONE}
+| | Stop Honeycomb service on DUTs | ${node}
+| | Clear Honeycomb Log | ${node}
+| | Stop VPP Service on DUT | ${node}
+
+| Enable Honeycomb Feature
+| | [Documentation] | Enable the specified feature in Honeycomb configuration.
+| | ... | Requires a restart of Honeycomb to take effect.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Enable Honeycomb Feature \| ${nodes['DUT1']} \| NSH \|
+| | ...
+| | [arguments] | ${node} | ${feature}
+| | Manage Honeycomb Features | ${node} | ${feature}
+
+| Disable Honeycomb Feature
+| | [Documentation] | Disable the specified feature in Honeycomb configuration.
+| | ... | Requires a restart of Honeycomb to take effect.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Disable Honeycomb Feature \| ${nodes['DUT1']} \| NSH \|
+| | ...
+| | [arguments] | ${node} | ${feature}
+| | Manage Honeycomb Features | ${node} | ${feature} | disable=${True}
+
+| Honeycomb Performance Suite Setup Generic
+| | [Documentation] | Generic test suite setup for Honeycomb performance tests.
+| | ... | Performs multiple attempts to start Honeycomb+VPP stack.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Honeycomb Performance Suite Setup Generic \| ${nodes['DUT1']} \|
+| | ...
+| | [Arguments] | ${node}
+| | Wait until keyword succeeds | 8min | 2min
+| | ... | Restart Honeycomb and VPP in Performance test | ${node}
+
+| Honeycomb Performance Suite Teardown Generic
+| | [Documentation] | Generic test suite teardown for Honeycomb performance
+| | ... | tests. Logs CPU usage before stopping Honeycomb.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Honeycomb Performance Suite Teardown Generic \| ${nodes['DUT1']} \|
+| | ...
+| | [Arguments] | ${node}
+| | Log Honeycomb and VPP process distribution on cores | ${node}
+| | Append suite to Honeycomb log file | ${node}
+| | Stop Honeycomb service on DUTs | ${node}
+| | Clear Honeycomb Log | ${node}
+| | Stop VPP Service on DUT | ${node}
+
+| Append suite to Honeycomb log file
+| | [Documentation] | Add the contents of honeycomb.log for the current suite\
+| | ... | to the full log which will be archived.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Append suite to Honeycomb log file \| ${nodes['DUT1']} \|
+| | ...
+| | [Arguments] | ${node}
+| | Append Honeycomb log | ${node} | ${SUITE_NAME}
+
+| Append suite to ODL log file
+| | [Documentation] | Add the contents of ODL karaf.log for the current suite\
+| | ... | to the full log which will be archived.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - odl_name - name of ODL client version. Type: string
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Append suite to ODL karaf log file \| ${nodes['DUT1']} \
+| | ... | \| Oxygen \|
+| | ...
+| | [Arguments] | ${node} | ${odl_name}
+| | Append ODL log | ${node} | ${odl_name} | ${SUITE_NAME}
+
+| Generate Honeycomb startup configuration for ODL test
+| | [Documentation] | Create HC startup configuration and apply to config
+| | ... | file on DUT. Requires Honeycomb restart to take effect.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - Honeycomb node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Generate Honeycomb startup configuration for ODL test \
+| | ... | \| ${nodes[DUT1]} \|
+| | ...
+| | [Arguments] | ${node}
+| | Import Library | resources.libraries.python.honeycomb.HoneycombSetup.HoneycombStartupConfig
+| | ... | WITH NAME | HC_config
+| | Run Keyword | HC_config.Set SSH Security provider
+| | Run Keyword | HC_config.Set Memory Size | ${32}
+| | Run Keyword | HC_config.Set Metaspace Size | ${32}
+| | Run Keyword | HC_config.Apply config | ${node}
\ No newline at end of file