2 Documentation Library containing Keywords used for SXP cluster testing
3 Library RequestsLibrary
4 Resource ./ClusterManagement.robot
5 Resource ./SetupUtils.robot
6 Resource ./SxpLib.robot
9 @{SHARD_OPER_LIST} inventory topology default entity-ownership
10 @{SHARD_CONF_LIST} inventory topology default
11 @{SXP_PACKAGE} org.opendaylight.sxp
12 ${DEVICE_SESSION} device_1
13 ${CONTROLLER_SESSION} ClusterManagement__session_1
14 ${VIRTUAL_IP} ${TOOLS_SYSTEM_2_IP}
15 ${VIRTUAL_IP_MASK} 255.255.255.0
16 ${VIRTUAL_INTERFACE} dummy0
17 ${MAC_ADDRESS_TABLE} &{EMPTY}
18 ${DEVICE_NODE_ID} ${TOOLS_SYSTEM_IP}
19 ${CLUSTER_NODE_ID} ${TOOLS_SYSTEM_2_IP}
23 Setup SXP Cluster Session
24 [Documentation] Create sessions asociated with SXP cluster setup
25 ClusterManagement.ClusterManagement_Setup
26 SetupUtils.Setup_Utils_For_Setup_And_Teardown
27 SetupUtils.Setup_Logging_For_Debug_Purposes_On_List_Or_All DEBUG ${SXP_PACKAGE}
30 [Documentation] Create session on the SXP device
31 RequestsLibrary.Create Session ${DEVICE_SESSION} url=http://${DEVICE_NODE_ID}:${RESTCONFPORT} auth=${AUTH} timeout=${DEFAULT_TIMEOUT_HTTP} max_retries=0
33 Setup SXP Cluster Session With Device
34 [Documentation] Create sessions asociated with SXP cluster setup and one SXP device
35 Setup SXP Cluster Session
38 Clean SXP Cluster Session
39 [Documentation] Clean sessions asociated with SXP cluster setup
40 ClusterManagement.Flush_Iptables_From_List_Or_All
41 RequestsLibrary.Delete All Sessions
42 SetupUtils.Setup_Logging_For_Debug_Purposes_On_List_Or_All INFO ${SXP_PACKAGE}
45 [Documentation] Check Status for all shards in SXP application.
46 ClusterManagement.Check_Cluster_Is_In_Sync
47 ClusterManagement.Verify_Leader_Exists_For_Each_Shard shard_name_list=${SHARD_OPER_LIST} shard_type=operational
48 ClusterManagement.Verify_Leader_Exists_For_Each_Shard shard_name_list=${SHARD_CONF_LIST} shard_type=config
51 [Arguments] ${peer_mode}=listener
52 [Documentation] Setup and connect SXP cluster topology
53 SxpLib.Add Node ${DEVICE_NODE_ID} session=${DEVICE_SESSION}
54 BuiltIn.Wait Until Keyword Succeeds 240x 1s SxpLib.Check Node Started ${DEVICE_NODE_ID} session=${DEVICE_SESSION}
55 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
56 \ SxpLib.Add Connection version4 ${peer_mode} ${ODL_SYSTEM_${i+1}_IP} 64999 node=${DEVICE_NODE_ID}
57 \ ... session=${DEVICE_SESSION}
58 ${cluster_mode} = Sxp.Get Opposing Mode ${peer_mode}
59 SxpLib.Add Node ${INADDR_ANY} session=${CONTROLLER_SESSION}
60 BuiltIn.Wait Until Keyword Succeeds 240x 1s Check Cluster Node Started ${INADDR_ANY} ip=${EMPTY}
61 SxpLib.Add Connection version4 ${cluster_mode} ${DEVICE_NODE_ID} 64999 ${INADDR_ANY} session=${CONTROLLER_SESSION}
62 BuiltIn.Wait Until Keyword Succeeds 480x 1s Check Device is Connected ${DEVICE_NODE_ID} session=${DEVICE_SESSION}
65 [Documentation] Disconnect SXP cluster topology
66 SxpLib.Delete Node ${DEVICE_NODE_ID} session=${DEVICE_SESSION}
67 BuiltIn.Wait Until Keyword Succeeds 240x 1s SxpLib.Check Node Stopped ${DEVICE_NODE_ID} session=${DEVICE_SESSION}
68 BuiltIn.Wait Until Keyword Succeeds 60x 1s SxpLib.Delete Node ${INADDR_ANY} session=${CONTROLLER_SESSION}
69 BuiltIn.Wait Until Keyword Succeeds 240x 1s SxpClusterLib.Check Cluster Node Stopped ${INADDR_ANY} ip=${EMPTY}
71 Check Cluster Node Started
72 [Arguments] ${node} ${port}=64999 ${ip}=${node}
73 [Documentation] Verify that SxpNode has data written to Operational datastore and Node is running on one of cluster nodes
74 ${resp} = RequestsLibrary.Get Request ${CONTROLLER_SESSION} /restconf/operational/network-topology:network-topology/topology/sxp/node/${node}/
75 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
76 ${started} = BuiltIn.Set Variable ${False}
77 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
78 \ ${rc} = Utils.Run Command On Remote System ${ODL_SYSTEM_${i+1}_IP} netstat -tln | grep -q ${ip}:${port} && echo 0 || echo 1 ${ODL_SYSTEM_USER} ${ODL_SYSTEM_PASSWORD}
79 \ ... prompt=${ODL_SYSTEM_PROMPT}
80 \ ${started} = BuiltIn.Set Variable If '${rc}' == '0' ${True} ${started}
81 BuiltIn.Should Be True ${started}
83 Check Cluster Node Stopped
84 [Arguments] ${node} ${port}=64999 ${ip}=${node}
85 [Documentation] Verify that SxpNode has data removed from Operational datastore and Node is stopped
86 ${resp} = RequestsLibrary.Get Request ${CONTROLLER_SESSION} /restconf/operational/network-topology:network-topology/topology/sxp/node/${node}/
87 BuiltIn.Should Be Equal As Strings ${resp.status_code} 404
88 ${stopped} = BuiltIn.Set Variable ${False}
89 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
90 \ ${rc} = Utils.Run Command On Remote System ${ODL_SYSTEM_${i+1}_IP} netstat -tln | grep -q ${ip}:${port} && echo 0 || echo 1 ${ODL_SYSTEM_USER} ${ODL_SYSTEM_PASSWORD}
91 \ ... prompt=${ODL_SYSTEM_PROMPT}
92 \ ${stopped} = BuiltIn.Set Variable If '${rc}' == '1' ${True} ${stopped}
93 BuiltIn.Should Be True ${stopped}
95 Check Device is Connected
96 [Arguments] ${node} ${version}=version4 ${port}=64999 ${session}=session
97 [Documentation] Checks if SXP device is connected to the cluster. It means it has connection in state "on" with one of the cluster members.
98 ${resp} = SxpLib.Get Connections node=${node} session=${session}
99 ${is_connected} = BuiltIn.Set Variable ${False}
100 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
101 \ ${is_connected} = Sxp.Find Connection ${resp} ${version} any ${ODL_SYSTEM_${i+1}_IP}
103 \ BuiltIn.Exit For Loop If ${is_connected}
104 BuiltIn.Should Be True ${is_connected}
106 Check Cluster is Connected
107 [Arguments] ${node} ${version}=version4 ${port}=64999 ${mode}=speaker ${session}=session
108 [Documentation] Get SXP connections of cluster ${node} and verify that they contain a connection to the device ${DEVICE_NODE_ID} in state "on"
109 ${resp} = SxpLib.Get Connections node=${node} session=${session}
110 SxpLib.Should Contain Connection ${resp} ${DEVICE_NODE_ID} ${port} ${mode} ${version} on
113 [Arguments] ${running_member}=1
114 [Documentation] Find cluster controller that is marked as cluster owner by requesting ownership data from ${running_member} node of the cluster
115 ${owner} ${candidates} = BuiltIn.Wait Until Keyword Succeeds 60x 1s ClusterManagement.Get_Owner_And_Successors_For_Device org.opendaylight.sxp.controller.boot.SxpControllerInstance
116 ... Sxp ${running_member}
119 Get Not Owner Controller
120 [Documentation] Find cluster controller that is not marked as owner for SXP service in cluster
121 ${owner_controller} = Get Owner Controller
122 ${controller} = BuiltIn.Evaluate random.choice( filter( lambda i: i!=${owner_controller}, range(1, ${NUM_ODL_SYSTEM} + 1))) random
123 [Return] ${controller}
126 [Documentation] Get any controller from cluster range
127 ${follower} = BuiltIn.Evaluate random.choice( range(1, ${NUM_ODL_SYSTEM} + 1)) random
130 Map Followers To Mac Addresses
131 [Documentation] Creates Map containing ODL_SYSTEM_IP to corresponding MAC-ADDRESS
132 ${mac_addresses} = BuiltIn.Create dictionary
133 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
134 \ ${mac_address} Find Mac Address Of Ip Address ${ODL_SYSTEM_${i+1}_IP}
135 \ Collections.Set To Dictionary ${mac_addresses} ${ODL_SYSTEM_${i+1}_IP} ${mac_address}
136 BuiltIn.Log ${mac_addresses}
137 [Return] ${mac_addresses}
139 Find Mac Address Of Ip Address
141 [Documentation] Finds out MAC-ADDRESS of specified IP by pinging it from TOOLS_SYSTEM machine
142 ${mac_address} = Utils.Run Command On Remote System And Log ${TOOLS_SYSTEM_IP} ping -c 10 -W 10 ${ip} >/dev/null && sudo ip neighbor show ${ip} | awk '{print $5}' ${TOOLS_SYSTEM_USER} ${TOOLS_SYSTEM_PASSWORD}
143 [Return] ${mac_address}
145 Ip Addres Should Not Be Routed To Follower
146 [Arguments] ${mac_addresses} ${ip_address} ${follower_index}
147 [Documentation] Verify that IP-ADDRESS is not routed to follower specified by ID
148 ${mac_address_assigned} = Collections.Get From Dictionary ${mac_addresses} ${ODL_SYSTEM_${follower_index}_IP}
149 ${mac_address_resolved} = Find Mac Address Of Ip Address ${ip_address}
150 BuiltIn.Should Not Be Equal As Strings ${mac_address_assigned} ${mac_address_resolved}
152 Ip Addres Should Be Routed To Follower
153 [Arguments] ${mac_addresses} ${ip_address} ${follower_index}
154 [Documentation] Verify that IP-ADDRESS is routed to follower specified by ID
155 ${mac_address_assigned} = Collections.Get From Dictionary ${mac_addresses} ${ODL_SYSTEM_${follower_index}_IP}
156 ${mac_address_resolved} = Find Mac Address Of Ip Address ${ip_address}
157 BuiltIn.Should Not Be Empty ${mac_address_resolved}
158 BuiltIn.Should Be Equal As Strings ${mac_address_assigned} ${mac_address_resolved}
161 [Arguments] ${ip_address}=${TOOLS_SYSTEM_2_IP} ${user}=${TOOLS_SYSTEM_USER} ${passwd}=${TOOLS_SYSTEM_PASSWORD}
162 [Documentation] Shutdown Tools node to avoid conflict in resolving virtual ip that is overlaping that node.
163 ${rc} = OperatingSystem.Run And Return Rc ping -q -c 3 ${ip_address}
164 ${stdout} = BuiltIn.Run Keyword And Return If ${rc} == 0 Utils.Run Command On Remote System ${ip_address} sudo shutdown -P 0 ${user}
166 BuiltIn.Log ${stdout}
168 Create Virtual Interface
169 [Documentation] Create virtual interface on all of the cluster nodes
170 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
171 \ Utils.Run Command On Remote System ${ODL_SYSTEM_${i+1}_IP} sudo modprobe dummy ${ODL_SYSTEM_USER} ${ODL_SYSTEM_PASSWORD}
172 \ Utils.Run Command On Remote System And Log ${ODL_SYSTEM_${i+1}_IP} sudo ip link show ${ODL_SYSTEM_USER} ${ODL_SYSTEM_PASSWORD}
174 Delete Virtual Interface
175 [Documentation] Create virtual interface on all of the cluster nodes
176 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
177 \ Utils.Run Command On Remote System ${ODL_SYSTEM_${i+1}_IP} sudo ip link delete ${VIRTUAL_INTERFACE} type dummy ${ODL_SYSTEM_USER} ${ODL_SYSTEM_PASSWORD}
178 \ Utils.Run Command On Remote System ${ODL_SYSTEM_${i+1}_IP} sudo rmmod dummy ${ODL_SYSTEM_USER} ${ODL_SYSTEM_PASSWORD}
179 \ Utils.Run Command On Remote System And Log ${ODL_SYSTEM_${i+1}_IP} sudo ip link show ${ODL_SYSTEM_USER} ${ODL_SYSTEM_PASSWORD}