2 Documentation Basic tests for odl-bgpcep-bgp-all feature.
4 ... Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
6 ... This program and the accompanying materials are made available under the
7 ... terms of the Eclipse Public License v1.0 which accompanies this distribution,
8 ... and is available at http://www.eclipse.org/legal/epl-v10.html
11 ... Brief description of what this suite should do:
12 ... https://wiki.opendaylight.org/view/BGP_LS_PCEP:Lithium_Feature_Tests#How_to_test_2
13 Suite Setup Setup_Everything
14 Suite Teardown Teardown_Everything
15 Test Setup FailFast.Fail_This_Fast_On_Previous_Error
16 Test Teardown FailFast.Start_Failing_Fast_If_This_Failed
17 Library OperatingSystem
18 Library SSHLibrary prompt=]> timeout=10s # FIXME: The prompt should have default value from a common resource, and should be overwritable by pybot -v in scripts.
19 Library RequestsLibrary
20 Library ${CURDIR}/../../../libraries/HsfJson/hsf_json.py
21 Variables ${CURDIR}/../../../variables/Variables.py
22 Variables ${CURDIR}/../../../variables/bgpuser/variables.py ${MININET}
23 Resource ${CURDIR}/../../../libraries/ConfigViaRestconf.robot
24 Resource ${CURDIR}/../../../libraries/FailFast.robot
25 Resource ${CURDIR}/../../../libraries/KillPythonTool.robot
26 Resource ${CURDIR}/../../../libraries/WaitForFailure.robot
29 ${directory_for_actual_responses} ${TEMPDIR}/actual
30 ${directory_for_expected_responses} ${TEMPDIR}/expected
31 ${directory_with_template_folders} ${CURDIR}/../../../variables/bgpuser/
34 Check_For_Empty_Topology_Before_Talking
35 [Documentation] Sanity check example-ipv4-topology is up but empty.
37 Wait_For_Topology_To_Change_To ${empty_json} 010_Empty.json timeout=120s
38 # TODO: Verify that 120 seconds is not too short if this suite is run immediatelly after ODL is started.
40 Reconfigure_ODL_To_Accept_Connection
41 [Documentation] Configure BGP peer module with initiate-connection set to false.
42 ${template_as_string}= BuiltIn.Set_Variable {'IP': '${MININET}', 'INITIATE': 'false'}
43 Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}bgp_peer ${template_as_string}
45 Start_Talking_BGP_speaker
46 [Documentation] Start Python speaker to connect to ODL, verify that the tool does not promptly exit.
47 ${command}= BuiltIn.Set_Variable python play.py --amount 2 --myip=${MININET} --myport=17900 --peerip=${CONTROLLER} --peerport=1790
48 # Myport value is needed for checking whether connection at precise port was established.
49 # TODO: Do we want to define ${BGP_PORT} in Variables.py?
50 BuiltIn.Log ${command}
51 ${output}= SSHLibrary.Write ${command}
52 Read_And_Fail_If_Prompt_Is_Seen
54 Check_Talking_Connection_Is_Established
55 [Documentation] See TCP (BGP) connection in established state.
56 # This case is separate from the previous one, to resemble structure of the second half of this suite more closely.
57 Check_Speaker_Is_Connected
59 Check_Talking_Topology_Is_Filled
60 [Documentation] See new routes in example-ipv4-topology as a proof that synchronization was correct.
62 Wait_For_Topology_To_Change_To ${filled_json} 020_Filled.json
64 Kill_Talking_BGP_Speaker
65 [Documentation] Abort the Python speaker. Also, attempt to stop failing fast.
66 [Setup] FailFast.Run_Even_When_Failing_Fast
68 FailFast.Do_Not_Fail_Fast_From_Now_On
69 # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
70 [Teardown] FailFast.Do_Not_Start_Failing_If_This_Failed
72 Check_For_Empty_Topology_After_Talking
73 [Documentation] See example-ipv4-topology empty again.
75 Wait_For_Topology_To_Change_To ${empty_json} 030_Empty.json
77 Start_Listening_BGP_Speaker
78 [Documentation] Start Python speaker in listening mode, verify that the tool does not exit quickly.
79 ${command}= BuiltIn.Set_Variable python play.py --amount 2 --listen --myip=${MININET} --myport=17900 --peerip=${CONTROLLER}
80 # TODO: ${BGP_TOOL_PORT} is probably not worth the trouble.
81 Builtin.Log ${command}
82 ${output}= SSHLibrary.Write ${command}
83 Read_And_Fail_If_Prompt_Is_Seen
85 Check_Listening_Connection_Is_Not_Established_Yet
86 [Documentation] See no TCP connection, as both ODL and tool are in listening mode.
87 Check_Speaker_Is_Not_Connected
89 Check_For_Empty_Topology_Before_Listening
90 [Documentation] Sanity check example-ipv4-topology is still empty.
92 Verify_That_Topology_Does_Not_Change_From ${empty_json} 040_Empty.json
94 Reconfigure_ODL_To_Initiate_Connection
95 [Documentation] Replace BGP peer config module, now with initiate-connection set to true.
96 ${template_as_string}= BuiltIn.Set_Variable {'IP': '${MININET}', 'INITIATE': 'true'}
97 Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}bgp_peer ${template_as_string}
99 Check_Listening_Connection_Is_Established
100 [Documentation] See TCP (BGP) connection in established state.
101 Check_Speaker_Is_Connected
103 Check_Listening_Topology_Is_Filled
104 [Documentation] See new routes in example-ipv4-topology as a proof that synchronization was correct.
106 Wait_For_Topology_To_Change_To ${filled_json} 050_Filled.json
108 Kill_Listening_BGP_Speaker
109 [Documentation] Abort the Python speaker. Also, attempt to stop failing fast.
110 [Setup] FailFast.Run_Even_When_Failing_Fast
112 FailFast.Do_Not_Fail_Fast_From_Now_On
113 # NOTE: It is still possible to remain failing, if both previous and this test failed.
114 [Teardown] FailFast.Do_Not_Start_Failing_If_This_Failed
116 Check_For_Empty_Topology_After_Listening
117 [Documentation] Post-condition: Check example-ipv4-topology is empty again.
119 Wait_For_Topology_To_Change_To ${empty_json} 060_Empty.json
121 Delete_Bgp_Peer_Configuration
122 [Documentation] Revert the BGP configuration to the original state: without any configured peers.
123 Delete_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}bgp_peer
124 # TODO: Do we need to check something else?
128 [Documentation] SSH-login to mininet machine, save prompt to variable, create HTTP session,
129 ... prepare directories for responses, put Python tool to mininet machine, setup imported resources.
130 SSHLibrary.Open_Connection ${MININET}
131 SSHLibrary.Login_With_Public_Key ${MININET_USER} ${USER_HOME}/.ssh/id_rsa any
132 ${current_connection}= Get_Connection
133 ${current_prompt}= BuiltIn.Set_Variable ${current_connection.prompt}
134 BuiltIn.Log ${current_prompt}
135 Builtin.Set_Suite_Variable ${prompt} ${current_prompt}
136 RequestsLibrary.Create_Session ses http://${CONTROLLER}:${RESTCONFPORT}${OPERATIONAL_TOPO_API} auth=${AUTH}
137 # TODO: Do not include slash in ${OPERATIONAL_TOPO_API}, having it typed here is more readable.
138 # TODO: Alternatively, create variable in Variables which starts with http.
139 # Both TODOs would probably need to update every suite relying on current Variables.
140 OperatingSystem.Remove_Directory ${directory_for_expected_responses} recursive=True
141 OperatingSystem.Remove_Directory ${directory_for_actual_responses} recursive=True
142 # The previous suite may have been using the same directories.
143 OperatingSystem.Create_Directory ${directory_for_expected_responses}
144 OperatingSystem.Create_Directory ${directory_for_actual_responses}
145 SSHLibrary.Put_File ${CURDIR}/../../../../tools/fastbgp/play.py
146 ConfigViaRestconf.Setup_Config_Via_Restconf
147 FailFast.Do_Not_Fail_Fast_From_Now_On
150 [Documentation] Create and Log the diff between expected and actual responses, make sure Python tool was killed.
151 ... Tear down imported Resources.
152 ${diff}= OperatingSystem.Run diff -dur ${directory_for_expected_responses} ${directory_for_actual_responses}
154 KillPythonTool.Search_And_Kill_Remote_Python 'play\.py'
155 ConfigViaRestconf.Teardown_Config_Via_Restconf
156 RequestsLibrary.Delete_All_Sessions
157 SSHLibrary.Close_All_Connections
159 Wait_For_Topology_To_Change_To
160 [Arguments] ${json_topology} ${filename} ${timeout}=10s ${refresh}=1s
161 [Documentation] Normalize the expected json topology and save it to ${directory_for_expected_responses}.
162 ... Wait until Compare_Topology matches. ${directory_for_actual_responses} will hold its last result.
163 ${topology_normalized}= Normalize_And_Save_Expected_Json ${json_topology} ${filename} ${directory_for_expected_responses}
164 BuiltIn.Wait_Until_Keyword_Succeeds ${timeout} ${refresh} Compare_Topology ${topology_normalized} ${filename}
166 Verify_That_Topology_Does_Not_Change_From
167 [Arguments] ${json_topology} ${filename} ${timeout}=10s ${refresh}=1s
168 [Documentation] Normalize the expected json topology and save it to ${directory_for_expected_responses}.
169 ... Verify that Compare_Topology keeps passing. ${directory_for_actual_responses} will hold its last result.
170 ${topology_normalized}= Normalize_And_Save_Expected_Json ${json_topology} ${filename} ${directory_for_expected_responses}
171 WaitForFailure.Verify_Keyword_Does_Not_Fail_Within_Timeout ${timeout} ${refresh} Compare_Topology ${topology_normalized} ${filename}
174 [Arguments] ${expected_normalized} ${filename}
175 [Documentation] Get current example-ipv4-topology as json, normalize it, save to ${directory_for_actual_responses}.
176 ... Check that status code is 200, check that normalized jsons match exactly.
177 ${response}= RequestsLibrary.Get_Request ses topology/example-ipv4-topology
178 BuiltIn.Log ${response.status_code}
179 BuiltIn.Log ${response.text}
180 ${actual_normalized}= Normalize_And_Save_Expected_Json ${response.text} ${filename} ${directory_for_actual_responses}
181 BuiltIn.Should_Be_Equal_As_Strings ${response.status_code} 200
182 BuiltIn.Should_Be_Equal ${actual_normalized} ${expected_normalized}
184 Normalize_And_Save_Expected_Json
185 [Arguments] ${json_text} ${filename} ${directory}
186 [Documentation] Normalize given json using hsf_json library. Log and save the result to given filename under given directory.
187 ${json_normalized}= hsf_json.Hsf_Json ${json_text}
188 BuiltIn.Log ${json_normalized}
189 OperatingSystem.Create_File ${directory}${/}${filename} ${json_normalized}
190 # TODO: Should we prepend .json to the filename? When we detect it is not already prepended?
193 [Documentation] Interrupt play.py, fail if no prompt is seen within SSHLibrary timeout.
194 ... Also, check that TCP connection is no longer established.
196 SSHLibrary.Read_Until_Prompt
197 Check_Speaker_Is_Not_Connected
199 Check_Speaker_Is_Not_Connected
200 [Documentation] Give it a few tries to see zero established connections.
201 BuiltIn.Wait_Until_Keyword_Succeeds 3s 1s Check_Number_Of_Speaker_Connections 0
203 Check_Speaker_Is_Connected
204 [Documentation] Give it several tries to see exactly one established connection.
205 BuiltIn.Wait_Until_Keyword_Succeeds 5s 1s Check_Number_Of_Speaker_Connections 1
207 Check_Number_Of_Speaker_Connections
208 [Arguments] ${howmany}
209 [Documentation] Run netstat in mininet machine and parse it for number of established connections. Check it is ${howmany}.
210 ${output}= SSHLibrary.Execute_Command netstat -npt 2> /dev/null | grep -E ":17900 .+ ESTABLISHED .+python" | wc -l
211 BuiltIn.Should_Be_Equal_As_Strings ${output} ${howmany}
213 Read_And_Fail_If_Prompt_Is_Seen
214 [Documentation] Try to read SSH to see prompt, but expect to see no prompt within SSHLibrary's timeout.
215 BuiltIn.Run_Keyword_And_Expect_Error No match found for '${prompt}' in *. Read_Text_Before_Prompt
217 Read_Text_Before_Prompt
218 [Documentation] Log text gathered by SSHLibrary.Read_Until_Prompt.
219 ... This needs to be a separate keyword just because how Read_And_Fail_If_Prompt_Is_Seen is implemented.
220 ${text}= SSHLibrary.Read_Until_Prompt
224 [Documentation] Construct ctrl+c character and SSH-write it (without endline). Do not read anything yet.
225 # TODO: Place this keyword to some Resource so that it can be re-used in other suites.
226 ${command}= BuiltIn.Evaluate chr(int(3))
227 SSHLibrary.Write_Bare ${command}