X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=csit%2Flibraries%2FDevstackUtils.robot;h=08168c0ae734cac1296cc0ec91e79910245d8c3a;hb=37357a310ff2161994025eaaff45572175f627d5;hp=ccb55a3cc4cd18524197be8d10dfc2cba08f20d5;hpb=e5f40f64a6cf3cc33f661f909cc140e85b78062c;p=integration%2Ftest.git diff --git a/csit/libraries/DevstackUtils.robot b/csit/libraries/DevstackUtils.robot index ccb55a3cc4..08168c0ae7 100644 --- a/csit/libraries/DevstackUtils.robot +++ b/csit/libraries/DevstackUtils.robot @@ -9,101 +9,220 @@ Library RequestsLibrary Library ./UtilLibrary.py Resource KarafKeywords.robot Resource OpenStackOperations.robot -Variables ../variables/Variables.py +Resource SSHKeywords.robot +Resource ../variables/Variables.robot *** Variables *** -${ODL_VERSION} lithium-SR3 -${OPENSTACK_BRANCH} stable/liberty -${NETWORKING-ODL_BRANCH} ${OPENSTACK_BRANCH} -${TEMPEST_REGEX} tempest.api.network -${ODL_BOOT_WAIT_URL} restconf/operational/network-topology:network-topology/topology/netvirt:1 ${default_devstack_prompt_timeout} 10s -${devstack_workspace} ~/ds_workspace ${DEVSTACK_SYSTEM_PASSWORD} \ # set to empty, but provide for others to override if desired -${CLEAN_DEVSTACK_HOST} False +${blacklist_file} /tmp/blacklist.txt +@{stable/newton_exclusion_regexes} ${EMPTY} +@{stable/ocata_exclusion_regexes} ${EMPTY} +@{stable/pike_exclusion_regexes} ${EMPTY} +@{master_exclusion_regexes} ${EMPTY} +${tempest_dir} /opt/stack/tempest +${tempest_config_file} ${tempest_dir}/etc/tempest.conf +${external_physical_network} physnet1 +${external_net_name} external-net +${external_subnet_name} external-subnet +# Parameter values below are based on releng/builder - changing them requires updates in releng/builder as well +${external_gateway} 10.10.10.250 +${external_subnet_allocation_pool} start=10.10.10.2,end=10.10.10.249 +${external_subnet} 10.10.10.0/24 +${TEMPEST_TIMEOUT} 420s +${OS_CNTL_CONN_ID} None +${OS_CMP1_CONN_ID} None +${OS_CMP2_CONN_ID} None +${OS_CNTL_IP} ${EMPTY} +${OS_CMP1_IP} ${EMPTY} +${OS_CMP2_IP} ${EMPTY} +@{OS_ALL_IPS} @{EMPTY} +@{OS_CMP_IPS} @{EMPTY} *** Keywords *** Run Tempest Tests - [Arguments] ${tempest_regex} ${tempest_exclusion_regex}="" ${tempest_conf}="" ${tempest_directory}=/opt/stack/tempest ${timeout}=600s - [Documentation] Execute the tempest tests. - ${devstack_conn_id}= Get ControlNode Connection - Switch Connection ${devstack_conn_id} + [Arguments] ${tempest_regex} ${timeout}=${TEMPEST_TIMEOUT} ${debug}=False + Run Keyword If "${debug}"=="False" Run Tempest Tests Without Debug ${tempest_regex} timeout=${timeout} + Run Keyword If "${debug}"=="True" Run Tempest Tests With Debug ${tempest_regex} timeout=${timeout} + Run Keyword If "${debug}"!="True" and "${debug}"!="False" Fail debug argument must be True or False + +Run Tempest Tests Without Debug + [Arguments] ${tempest_regex} ${tempest_directory}=${tempest_dir} ${timeout}=${TEMPEST_TIMEOUT} + [Documentation] Using ostestr will allow us to (by default) run tests in paralllel. + ... Because of the parallel fashion, we must ensure there is no pause on teardown so that flag in tempest.conf is + ... explicitly set to False. + Return From Keyword If "skip_if_${OPENSTACK_BRANCH}" in @{TEST_TAGS} + Return From Keyword If "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS} + ${tempest_conn_id}= SSHLibrary.Open Connection ${OS_CONTROL_NODE_IP} prompt=${DEFAULT_LINUX_PROMPT_STRICT} + SSHKeywords.Flexible SSH Login ${OS_USER} ${DEVSTACK_SYSTEM_PASSWORD} + Write Commands Until Prompt source ${DEVSTACK_DEPLOY_PATH}/openrc admin admin + Write Commands Until Prompt cd ${tempest_directory} + SSHLibrary.Read + Tempest Conf Modify Pause On Test Teardown False + SSHLibrary.Set Client Configuration timeout=${timeout} + # There are tons of deprecation error messages when we use ostestr in our CSIT environment (openstack via devstack) + # The robot log files are very large and one culprit is all these deprecation warnings. If we redirect stderr to + # /dev/null we should be able to ignore them. We will miss any other errors, however. + ${output}= Write Commands Until Prompt ostestr --regex ${tempest_regex} 2>/dev/null timeout=${timeout} + Log ${output} + SSHLibrary.Close Connection + Should Contain ${output} Failed: 0 + +Run Tempest Tests With Debug + [Arguments] ${tempest_regex} ${tempest_directory}=${tempest_dir} ${timeout}=${TEMPEST_TIMEOUT} + [Documentation] After setting pause_teardown=True in tempest.conf, use the python -m testtools.run module to execute + ... a single tempest test case. We need to run only one tempest test case at a time as there will + ... be potentional for an unkown number of debug pdb() prompts to catch and continue if we are running multiple + ... test cases with a single command. Essentially, this keyword only handles one breakpoint at a single teardown. + Return From Keyword If "skip_if_${OPENSTACK_BRANCH}" in @{TEST_TAGS} + Return From Keyword If "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS} + ${tempest_conn_id}= SSHLibrary.Open Connection ${OS_CONTROL_NODE_IP} prompt=${DEFAULT_LINUX_PROMPT_STRICT} + SSHKeywords.Flexible SSH Login ${OS_USER} ${DEVSTACK_SYSTEM_PASSWORD} Write Commands Until Prompt source ${DEVSTACK_DEPLOY_PATH}/openrc admin admin Write Commands Until Prompt cd ${tempest_directory} - Write Commands Until Prompt sudo testr list-tests | egrep ${tempest_regex} | egrep -v ${tempest_exclusion_regex} > tests_to_execute.txt - ${tests_to_execute}= Write Commands Until Prompt sudo cat tests_to_execute.txt - Log ${tests_to_execute} - # run_tempests.sh is a wrapper to testr, and we are providing the config file - ${results}= Write Commands Until Prompt sudo -E ${tempest_directory}/run_tempest.sh -C ${tempest_conf} -N ${tempest_regex} -- --load-list tests_to_execute.txt timeout=${timeout} - Log ${results} - # Save stdout to file - Create File tempest_output_${tempest_regex}.log data=${results} - # output tempest generated log file which may have different debug levels than what stdout would show - # FIXME: having the INFO level tempest logs is helpful as it gives details like the UUIDs of nouns used in the - # the tests which can sometimes be tracked in ODL and Openstack logs when debugging. However, this "cat" step - # does not even complete for the tempest.api.network tests in under 2min. We need a faster way to get this - # info. Probably pulling the log file and storing it on the log server is best. Hopefully someone can get - # to this. For now, commenting out this next debug step. - # ${output}= Write Commands Until Prompt cat ${tempest_directory}/tempest.log timeout=120s - # Log ${output} - Should Contain ${results} Failed: 0 - # TODO: also need to verify some non-zero pass count as well as other results are ok (e.g. skipped, etc) + SSHLibrary.Read + Tempest Conf Modify Pause On Test Teardown True + SSHLibrary.Set Client Configuration timeout=${timeout} + SSHLibrary.Write python -m testtools.run ${tempest_regex} + ${output}= SSHLibrary.Read Until Regexp ${DEFAULT_LINUX_PROMPT_STRICT}|pdb.set_trace() + Log ${output} + Show Debugs + Get Test Teardown Debugs + SSHLibrary.Switch Connection ${tempest_conn_id} + SSHLibrary.Write continue + ${output}= SSHLibrary.Read Until Regexp ${DEFAULT_LINUX_PROMPT_STRICT}|pdb.set_trace() + Log ${output} + SSHLibrary.Write continue + ${output}= SSHLibrary.Read Until Prompt + Log ${output} + SSHLibrary.Close Connection + Should Contain ${output} OK + Should Not Contain ${output} FAILED + +Suite Setup + OpenStackOperations.OpenStack Suite Setup + Log In To Tempest Executor And Setup Test Environment + +Log In To Tempest Executor And Setup Test Environment + [Documentation] Initialize SetupUtils, open SSH connection to a devstack system and source the openstack + ... credentials needed to run the tempest tests. The (sometimes empty) tempest blacklist file will be created + ... and pushed to the tempest executor. + Create Blacklist File + # Tempest tests need an existing external network in order to create routers. + Create Network ${external_net_name} --external --default --provider-network-type flat --provider-physical-network ${PUBLIC_PHYSICAL_NETWORK} + Create Subnet ${external_net_name} ${external_subnet_name} ${external_subnet} --gateway ${external_gateway} --allocation-pool ${external_subnet_allocation_pool} + List Networks + ${control_node_conn_id}= SSHLibrary.Open Connection ${OS_CONTROL_NODE_IP} prompt=${DEFAULT_LINUX_PROMPT_STRICT} + SSHKeywords.Flexible SSH Login ${OS_USER} + Write Commands Until Prompt source ${DEVSTACK_DEPLOY_PATH}/openrc admin admin + Write Commands Until Prompt sudo rm -rf /opt/stack/tempest/.testrepository + ${net_id}= Get Net Id ${external_net_name} + Tempest Conf Add External Network And Floating Network Name ${net_id} + +Tempest Conf Add External Network And Floating Network Name + [Arguments] ${external_network_id} + [Documentation] Tempest will be run with a config file - this function will add the + ... given external network ID to the configuration file. + Modify Config In File On Existing SSH Connection ${tempest_config_file} set network public_network_id ${external_network_id} + Modify Config In File On Existing SSH Connection ${tempest_config_file} set DEFAULT debug False + Modify Config In File On Existing SSH Connection ${tempest_config_file} set DEFAULT log_level INFO + Modify Config In File On Existing SSH Connection ${tempest_config_file} set network floating_network_name ${external_net_name} + Write Commands Until Prompt sudo cat ${tempest_config_file} + Write Commands Until Prompt sudo chmod 777 ${tempest_config_file} + +Tempest Conf Modify Pause On Test Teardown + [Arguments] ${pause_flag} + [Documentation] Sets the DEFAULT section flag for pausing the test teardown. If True the tempest test case + ... being executed will break to a pdb() debug shell when it hits it's teardown() function. + Modify Config In File On Existing SSH Connection ${tempest_config_file} set DEFAULT pause_teardown ${pause_flag} + +Modify Config In File On Existing SSH Connection + [Arguments] ${config_file} ${modifier} ${config_section} ${config_key} ${config_value}=${EMPTY} + [Documentation] uses crudini to populate oslo cofg file. + # this keyword is only one line so seems like extra overhead, but this may be a good candidate to move + # to a library at some point, when/if other suites need to use it, so wanted to make it generic. + Write Commands Until Prompt sudo -E crudini --${modifier} ${config_file} ${config_section} ${config_key} ${config_value} + +Create Blacklist File + [Documentation] For each exclusion regex in the required @{${OPENSTACK_BRANCH}_exclusion_regexes} list a new + ... line will be created in the required ${blacklist_file} location. This file is pushed to the OS_CONTROL_NODE + ... which is assumed to be the tempest executor. + OperatingSystem.Create File ${blacklist_file} + : FOR ${exclusion} IN @{${OPENSTACK_BRANCH}_exclusion_regexes} + \ OperatingSystem.Append To File ${blacklist_file} ${exclusion}\n + Log File ${blacklist_file} + SSHKeywords.Copy File To Remote System ${OS_CONTROL_NODE_IP} ${blacklist_file} ${blacklist_file} + +Open Connection + [Arguments] ${name} ${ip} + ${conn_id} = SSHLibrary.Open Connection ${ip} prompt=${DEFAULT_LINUX_PROMPT} + SSHKeywords.Flexible SSH Login ${OS_USER} ${DEVSTACK_SYSTEM_PASSWORD} + BuiltIn.Set Suite Variable \${${name}} ${conn_id} + [Return] ${conn_id} Devstack Suite Setup - [Arguments] ${source_pwd}=no ${odl_ip}=${ODL_SYSTEM_IP} - [Documentation] Login to the Openstack Control Node to run tempest suite + [Arguments] ${odl_ip}=${ODL_SYSTEM_IP} + [Documentation] Open connections to the nodes + Get DevStack Nodes Data Create Session session http://${odl_ip}:${RESTCONFPORT} auth=${AUTH} headers=${HEADERS} - ${devstack_conn_id}= SSHLibrary.Open Connection ${OS_CONTROL_NODE_IP} prompt=${DEFAULT_LINUX_PROMPT} - Set Suite Variable ${devstack_conn_id} - Set Suite Variable ${source_pwd} - Log ${devstack_conn_id} - Utils.Flexible SSH Login ${OS_USER} ${DEVSTACK_SYSTEM_PASSWORD} - SSHLibrary.Set Client Configuration timeout=${default_devstack_prompt_timeout} - -Clean DevStack Host In Case It Is Not Sterile - [Documentation] In upstream CI, the expectation is that the devstack VM is fresh, sterile and ready - ... for any version of devstack, networking-odl, and OpenDaylight. During local test development, - ... it can be faster to just clean the needed packages, configurations, repos, files, etc. instead of - ... spinning up a new system. This keyword serves as a living list of those items needed to prep a - ... potentially non-sterile devstack system. - Write Commands Until Prompt pgrep python | awk '{print "sudo kill",$1}' | sh - Write Commands Until Prompt pgrep java | awk '{print "sudo kill",$1}' | sh - Write Commands Until Prompt rpm -qa | grep rdo - Write Commands Until Prompt sudo rpm -e $(sudo rpm -qa | grep rdo) - Write Commands Until Prompt sudo yum remove -y pyOpenSSL - Write Commands Until Prompt sudo -H pip uninstall -y virtualenv - Write Commands Until Prompt sudo rm -rf /tmp/ansible /opt/stack - Write Commands Until Prompt rm -rf ${devstack_workspace} ~/os-testr - Write Commands Until Prompt sudo ovs-vsctl del-br br-ex - Write Commands Until Prompt sudo ovs-vsctl del-br br-int - Write Commands Until Prompt sudo ovs-vsctl del-manager + SSHLibrary.Set Default Configuration timeout=${default_devstack_prompt_timeout} + Run Keyword If 0 < ${NUM_OS_SYSTEM} Open Connection OS_CNTL_CONN_ID ${OS_CONTROL_NODE_IP} + Run Keyword If 1 < ${NUM_OS_SYSTEM} Open Connection OS_CMP1_CONN_ID ${OS_COMPUTE_1_IP} + Run Keyword If 2 < ${NUM_OS_SYSTEM} Open Connection OS_CMP2_CONN_ID ${OS_COMPUTE_2_IP} Write Commands Until Prompt [Arguments] ${cmd} ${timeout}=${default_devstack_prompt_timeout} [Documentation] quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable SSHLibrary.Set Client Configuration timeout=${timeout} - SSHLibrary.Write ${cmd} + SSHLibrary.Read + SSHLibrary.Write ${cmd};echo Command Returns $? ${output}= SSHLibrary.Read Until Prompt [Return] ${output} -Get Networking ODL Version Of Release - [Arguments] ${version} - [Documentation] Get version of ODL to be installed - # once Beryllium SR1 goes out, we can change beryllium-latest to use 0.4.2 - Return From Keyword If "${version}" == "beryllium-latest" beryllium-snapshot-0.4.2 - Return From Keyword If "${version}" == "beryllium-SR1" beryllium-snapshot-0.4.1 - Return From Keyword If "${version}" == "beryllium" beryllium-snapshot-0.4.0 - Return From Keyword If "${version}" == "lithium-latest" lithium-snapshot-0.3.5 - Return From Keyword If "${version}" == "lithium-SR4" lithium-snapshot-0.3.4 - Return From Keyword If "${version}" == "lithium-SR3" lithium-snapshot-0.3.3 - Return From Keyword If "${version}" == "lithium-SR2" lithium-snapshot-0.3.2 - Return From Keyword If "${version}" == "lithium-SR1" lithium-snapshot-0.3.1 - # FYI networking-odl no longer has this for some reason. - Return From Keyword If "${version}" == "lithium" lithium-snapshot-0.3.0 - Return From Keyword If "${version}" == "helium" helium - -Show Devstack Debugs - [Documentation] Collect the devstack logs to debug in case of failure - Write Commands Until Prompt gunzip /opt/stack/logs/devstacklog.txt.gz - Write Commands Until Prompt tail -n2000 /opt/stack/logs/devstacklog.txt timeout=600s - Write Commands Until Prompt grep 'distribution-karaf.*zip' /opt/stack/logs/devstacklog.txt +Write Commands Until Prompt And Log + [Arguments] ${cmd} ${timeout}=${default_devstack_prompt_timeout} + [Documentation] quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable + ${output} = Write Commands Until Prompt ${cmd} ${timeout} + Log ${output} + [Return] ${output} + +Log Devstack Nodes Data + ${output} = BuiltIn.Catenate SEPARATOR=\n OS_CNTL_HOSTNAME: ${OS_CNTL_HOSTNAME} - OS_CNTL_IP: ${OS_CNTL_IP} - OS_CONTROL_NODE_IP: ${OS_CONTROL_NODE_IP} OS_CMP1_HOSTNAME: ${OS_CMP1_HOSTNAME} - OS_CMP1_IP: ${OS_CMP1_IP} - OS_COMPUTE_1_IP: ${OS_COMPUTE_1_IP} OS_CMP2_HOSTNAME: ${OS_CMP2_HOSTNAME} - OS_CMP2_IP: ${OS_CMP2_IP} - OS_COMPUTE_2_IP: ${OS_COMPUTE_2_IP} OS_ALL_IPS: @{OS_ALL_IPS} + ... OS_CMP_IPS: @{OS_CMP_IPS} + BuiltIn.Log DevStack Nodes Data:\n${output} + +Get DevStack Hostnames + [Documentation] Assign hostname global variables for DevStack nodes + ${OS_CNTL_HOSTNAME} = OpenStackOperations.Get Hypervisor Hostname From IP ${OS_CNTL_IP} + ${OS_CMP1_HOSTNAME} = OpenStackOperations.Get Hypervisor Hostname From IP ${OS_CMP1_IP} + ${OS_CMP2_HOSTNAME} = OpenStackOperations.Get Hypervisor Hostname From IP ${OS_CMP2_IP} + BuiltIn.Set Suite Variable ${OS_CNTL_HOSTNAME} + BuiltIn.Set Suite Variable ${OS_CMP1_HOSTNAME} + BuiltIn.Set Suite Variable ${OS_CMP2_HOSTNAME} + +Set Node Data For AllinOne Setup + [Documentation] Assign global variables for DevStack nodes where the Control Node enables Compute service also. + BuiltIn.Set Suite Variable @{OS_ALL_IPS} ${OS_CNTL_IP} + +Set Node Data For Control And Compute Node Setup + [Documentation] Assign global variables for DevStack nodes where the control node is also the compute + BuiltIn.Set Suite Variable ${OS_CMP1_IP} ${OS_CNTL_IP} + BuiltIn.Set Suite Variable ${OS_CMP2_IP} ${OS_COMPUTE_1_IP} + BuiltIn.Set Suite Variable @{OS_ALL_IPS} ${OS_CNTL_IP} ${OS_CMP2_IP} + BuiltIn.Set Suite Variable @{OS_CMP_IPS} ${OS_CMP1_IP} ${OS_CMP2_IP} + +Set Node Data For Control Only Node Setup + [Documentation] Assign global variables for DevStack nodes where the control node is different than the compute + BuiltIn.Set Suite Variable ${OS_CMP1_IP} ${OS_COMPUTE_1_IP} + BuiltIn.Set Suite Variable ${OS_CMP2_IP} ${OS_COMPUTE_2_IP} + BuiltIn.Set Suite Variable @{OS_ALL_IPS} ${OS_CNTL_IP} ${OS_CMP1_IP} ${OS_CMP2_IP} + BuiltIn.Set Suite Variable @{OS_CMP_IPS} ${OS_CMP1_IP} ${OS_CMP2_IP} + +Get DevStack Nodes Data + [Documentation] Assign global variables for DevStack nodes + BuiltIn.Set Suite Variable ${OS_CNTL_IP} ${OS_CONTROL_NODE_IP} + Run Keyword If ${NUM_OS_SYSTEM} == 1 Set Node Data For AllinOne Setup + ... ELSE IF ${NUM_OS_SYSTEM} == 2 Set Node Data For Control And Compute Node Setup + ... ELSE IF ${NUM_OS_SYSTEM} == 3 Set Node Data For Control Only Node Setup + Get DevStack Hostnames + Log Devstack Nodes Data