61cc9850e0f042422b973a54ee38465149ba8d64
[integration/test.git] / csit / libraries / DevstackUtils.robot
1 *** Settings ***
2 Documentation     General Utils library. This library has broad scope, it can be used by any robot system tests.
3 Library           SSHLibrary
4 Library           String
5 Library           DateTime
6 Library           Process
7 Library           Collections
8 Library           RequestsLibrary
9 Library           ./UtilLibrary.py
10 Resource          KarafKeywords.robot
11 Variables         ../variables/Variables.py
12
13 *** Variables ***
14 ${ODL_VERSION}    lithium-SR3
15 ${OPENSTACK_BRANCH}    stable/liberty
16 ${NETWORKING-ODL_BRANCH}    ${OPENSTACK_BRANCH}
17 ${TEMPEST_REGEX}    tempest.api.network
18 ${ODL_BOOT_WAIT_URL}    restconf/operational/network-topology:network-topology/topology/netvirt:1
19 ${default_devstack_prompt_timeout}    10s
20 ${devstack_workspace}    ~/ds_workspace
21 ${DEVSTACK_SYSTEM_PASSWORD}    \    # set to empty, but provide for others to override if desired
22 ${CLEAN_DEVSTACK_HOST}    False
23
24 *** Keywords ***
25 Run Tempest Tests
26     [Arguments]    ${tempest_regex}    ${timeout}=600s
27     [Documentation]  Execute the tempest tests
28     Write Commands Until Prompt    cd /opt/stack/new/tempest
29     Write Commands Until Prompt    sudo rm -rf /opt/stack/new/tempest/.testrepository
30     Write Commands Until Prompt    sudo testr init
31     ${results}=    Write Commands Until Prompt    sudo -E testr run ${tempest_regex} --subunit | subunit-trace --no-failure-debug -f    timeout=${timeout}
32     Should Contain    ${results}    Failed: 0
33     # TODO: also need to verify some non-zero pass count as well as other results are ok (e.g. skipped, etc)
34
35 Devstack Suite Setup Tests
36     [Documentation]  Login to  the Openstack Control Node to run tempest suite
37     SSHLibrary.Open Connection    ${OS_CONTROL_NODE_IP}    prompt=${DEFAULT_LINUX_PROMPT}
38     Utils.Flexible SSH Login    ${OS_USER}    ${DEVSTACK_SYSTEM_PASSWORD}
39     SSHLibrary.Set Client Configuration    timeout=${default_devstack_prompt_timeout}
40
41 Devstack Suite Setup
42     [Documentation]  Login to  the Openstack Control Node to run tempest suite
43     SSHLibrary.Open Connection    ${DEVSTACK_SYSTEM_IP}    prompt=${DEFAULT_LINUX_PROMPT}
44     Utils.Flexible SSH Login    ${DEVSTACK_SYSTEM_USER}    ${DEVSTACK_SYSTEM_PASSWORD}
45     SSHLibrary.Set Client Configuration    timeout=${default_devstack_prompt_timeout}
46     Run Keyword If    ${CLEAN_DEVSTACK_HOST}    Clean DevStack Host In Case It Is Not Sterile
47     Write Commands Until Prompt    export PATH=$PATH:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin:/usr/local/sbin
48     Write Commands Until Prompt    export ODL_VERSION=${ODL_VERSION}
49     Write Commands Until Prompt    export OPENSTACK_BRANCH=${OPENSTACK_BRANCH}
50     Write Commands Until Prompt    export TEMPEST_REGEX=${TEMPEST_REGEX}
51     Write Commands Until Prompt    export ODL_BOOT_WAIT_URL=${ODL_BOOT_WAIT_URL}
52     ${odl_version_to_install}=    Get Networking ODL Version Of Release    ${ODL_VERSION}
53     Write Commands Until Prompt    export DEVSTACK_LOCAL_CONFIG="enable_plugin networking-odl https://git.openstack.org/openstack/networking-odl ${NETWORKING-ODL_BRANCH};"
54     Write Commands Until Prompt    export DEVSTACK_LOCAL_CONFIG+="ODL_NETVIRT_DEBUG_LOGS=True;ODL_RELEASE=${odl_version_to_install};"
55     Write Commands Until Prompt    echo $DEVSTACK_LOCAL_CONFIG
56     Write Commands Until Prompt    export OVERRIDE_ZUUL_BRANCH=${OPENSTACK_BRANCH}
57     Write Commands Until Prompt    export PYTHONUNBUFFERED=true
58     Write Commands Until Prompt    export DEVSTACK_GATE_TIMEOUT=120
59     Write Commands Until Prompt    export DEVSTACK_GATE_TEMPEST=1
60     Write Commands Until Prompt    export DEVSTACK_GATE_NEUTRON=1
61     Write Commands Until Prompt    export KEEP_LOCALRC=1
62     Write Commands Until Prompt    export PROJECTS="openstack/networking-odl $PROJECTS"
63     Write Commands Until Prompt    export DEVSTACK_GATE_TEMPEST_REGEX=tempest.api.network.test_ports.PortsTestJSON.test_show_port
64     Write Commands Until Prompt    sudo yum -y install redhat-lsb-core indent python-testrepository    timeout=120s
65     Write Commands Until Prompt    sudo /usr/sbin/groupadd ${DEVSTACK_SYSTEM_USER}
66     Write Commands Until Prompt    sudo mkdir -p /opt/stack/new
67     Write Commands Until Prompt    sudo chown -R ${DEVSTACK_SYSTEM_USER}:${DEVSTACK_SYSTEM_USER} /opt/stack/new
68     Write Commands Until Prompt    sudo bash -c 'echo "stack ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers'
69     Write Commands Until Prompt    sudo mkdir -p /usr/local/${DEVSTACK_SYSTEM_USER}/slave_scripts
70     Write Commands Until Prompt    git clone https://github.com/openstack/os-testr.git    timeout=30s
71     Write Commands Until Prompt    cd os-testr/os_testr
72     Write Commands Until Prompt    sudo cp subunit2html.py /usr/local/${DEVSTACK_SYSTEM_USER}/slave_scripts
73     Write Commands Until Prompt    mkdir -p ${devstack_workspace}
74     Write Commands Until Prompt    cd ${devstack_workspace}
75     Write Commands Until Prompt    export WORKSPACE=${devstack_workspace}
76     Write Commands Until Prompt    rm -rf devstack-gate
77     Write Commands Until Prompt    git clone https://git.openstack.org/openstack-infra/devstack-gate    timeout=30s
78
79 Clean DevStack Host In Case It Is Not Sterile
80     [Documentation]    In upstream CI, the expectation is that the devstack VM is fresh, sterile and ready
81     ...    for any version of devstack, networking-odl, and OpenDaylight. During local test development,
82     ...    it can be faster to just clean the needed packages, configurations, repos, files, etc. instead of
83     ...    spinning up a new system. This keyword serves as a living list of those items needed to prep a
84     ...    potentially non-sterile devstack system.
85     Write Commands Until Prompt    pgrep python | awk '{print "sudo kill",$1}' | sh
86     Write Commands Until Prompt    pgrep java | awk '{print "sudo kill",$1}' | sh
87     Write Commands Until Prompt    rpm -qa | grep rdo
88     Write Commands Until Prompt    sudo rpm -e $(sudo rpm -qa | grep rdo)
89     Write Commands Until Prompt    sudo yum remove -y pyOpenSSL
90     Write Commands Until Prompt    sudo -H pip uninstall -y virtualenv
91     Write Commands Until Prompt    sudo rm -rf /tmp/ansible /opt/stack
92     Write Commands Until Prompt    rm -rf ${devstack_workspace} ~/os-testr
93     Write Commands Until Prompt    sudo ovs-vsctl del-br br-ex
94     Write Commands Until Prompt    sudo ovs-vsctl del-br br-int
95     Write Commands Until Prompt    sudo ovs-vsctl del-manager
96
97 Write Commands Until Prompt
98     [Arguments]    ${cmd}    ${timeout}=${default_devstack_prompt_timeout}
99     [Documentation]    quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable
100     SSHLibrary.Set Client Configuration    timeout=${timeout}
101     SSHLibrary.Write    ${cmd}
102     ${output}=    SSHLibrary.Read Until Prompt
103     [Return]    ${output}
104
105 Get Networking ODL Version Of Release
106     [Documentation]   Get version of ODL to be installed
107     [Arguments]    ${version}
108     # once Beryllium SR1 goes out, we can change beryllium-latest to use 0.4.2
109     Return From Keyword If    "${version}" == "beryllium-latest"    beryllium-snapshot-0.4.2
110     Return From Keyword If    "${version}" == "beryllium-SR1"    beryllium-snapshot-0.4.1
111     Return From Keyword If    "${version}" == "beryllium"    beryllium-snapshot-0.4.0
112     Return From Keyword If    "${version}" == "lithium-latest"    lithium-snapshot-0.3.5
113     Return From Keyword If    "${version}" == "lithium-SR4"    lithium-snapshot-0.3.4
114     Return From Keyword If    "${version}" == "lithium-SR3"    lithium-snapshot-0.3.3
115     Return From Keyword If    "${version}" == "lithium-SR2"    lithium-snapshot-0.3.2
116     Return From Keyword If    "${version}" == "lithium-SR1"    lithium-snapshot-0.3.1
117     # FYI networking-odl no longer has this for some reason.
118     Return From Keyword If    "${version}" == "lithium"    lithium-snapshot-0.3.0
119     Return From Keyword If    "${version}" == "helium"    helium
120
121 Show Devstack Debugs
122     [Documentation]   Collect the devstack logs to debug in case of failure
123     Write Commands Until Prompt    gunzip /opt/stack/logs/devstacklog.txt.gz
124     Write Commands Until Prompt    tail -n2000 /opt/stack/logs/devstacklog.txt    timeout=600s
125     Write Commands Until Prompt    grep 'distribution-karaf.*zip' /opt/stack/logs/devstacklog.txt