2 Documentation General Utils library. This library has broad scope, it can be used by any robot system tests.
4 Library HttpLibrary.HTTP
9 Library RequestsLibrary
10 Library OperatingSystem
11 Library ${CURDIR}/UtilLibrary.py
12 Resource ${CURDIR}/SSHKeywords.robot
13 Resource ${CURDIR}/TemplatedRequests.robot
14 Resource ${CURDIR}/../variables/Variables.robot
17 # TODO: Introduce ${tree_size} and use instead of 1 in the next line.
18 ${start} sudo mn --controller=remote,ip=${ODL_SYSTEM_IP} --topo tree,1 --switch ovsk,protocols=OpenFlow13
22 [Arguments] ${system}=${TOOLS_SYSTEM_IP} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${timeout}=30s
23 [Documentation] Basic setup/cleanup work that can be done safely before any system
25 Log Start the test on the base edition
27 ${mininet_conn_id}= Open Connection ${system} prompt=${prompt} timeout=${timeout}
28 Set Suite Variable ${mininet_conn_id}
29 SSHKeywords.Flexible Mininet Login user=${user} password=${password}
30 Execute Command sudo ovs-vsctl set-manager ptcp:6644
35 [Arguments] ${prompt}=${DEFAULT_LINUX_PROMPT}
36 [Documentation] Cleanup/Shutdown work that should be done at the completion of all
38 Log Stop the test on the base edition
39 Switch Connection ${mininet_conn_id}
45 Report Failure Due To Bug
46 [Arguments] ${number} ${include_bug_in_tags}=True
47 [Documentation] Report that a test failed due to a known Bugzilla bug whose
48 ... number is provided as an argument.
49 ... Not FAILED (incl. SKIPPED) test are not reported.
50 ... This keyword must be used in the [Teardown] setting of the affected test
51 ... or as the first line of the test if FastFail module is not being
52 ... used. It reports the URL of the bug on console and also puts it
53 ... into the Robot log file.
54 ${test_skipped}= BuiltIn.Evaluate len(re.findall('SKIPPED', """${TEST_MESSAGE}""")) > 0 modules=re
55 BuiltIn.Return From Keyword If ('${TEST_STATUS}' != 'FAIL') or ${test_skipped}
56 Comment Jira tickets are {PROJECT}-{NUMBER} while Bugzilla tickets are {NUMBER}
57 ${match} BuiltIn.Run Keyword And Return Status Should Contain ${number} -
58 ${bug_url}= BuiltIn.Set Variable If ${match} https://jira.opendaylight.org/browse/${number} https://bugs.opendaylight.org/show_bug.cgi?id=${number}
59 ${msg}= BuiltIn.Set_Variable This test fails due to ${bug_url}
60 ${newline}= BuiltIn.Evaluate chr(10)
61 BuiltIn.Set Test Message ${msg}${newline}${newline}${TEST_MESSAGE}
63 BuiltIn.Run Keyword If "${include_bug_in_tags}"=="True" Set Tags ${bug_url}
65 Report_Failure_And_Point_To_Linked_Bugs
66 [Documentation] Report that a test failed and point to linked Bugzilla bug(s).
67 ... Linked bugs must contain the ${reference} inside comments (workaround
68 ... becasue of currently missing suitable field for external references and
69 ... not correctly working the CONTENT MATCHES filter).
70 ... Not FAILED (incl. SKIPPED) test are not reported.
71 ... This keyword must be used in the [Teardown] setting of the affected test
72 ... or as the first line of the test if FastFail module is not being
73 ... used. It reports the URL of the bug on console and also puts it
74 ... into the Robot log file.
75 ${test_skipped}= BuiltIn.Evaluate len(re.findall('SKIPPED', """${TEST_MESSAGE}""")) > 0 modules=re
76 BuiltIn.Return From Keyword If ('${TEST_STATUS}' != 'FAIL') or ${test_skipped}
77 ${newline}= BuiltIn.Evaluate chr(10)
78 ${reference}= String.Replace_String_Using_Regexp ${SUITE_NAME}_${TEST_NAME} [ /\.-] _
79 ${reference}= String.Convert_To_Lowercase ${reference}
80 ${msg}= BuiltIn.Set_Variable ... click for list of related bugs or create a new one if needed (with the${newline}"${reference}"${newline}reference somewhere inside)
81 ${bugs}= BuiltIn.Set_Variable "https://bugs.opendaylight.org/buglist.cgi?f1=cf_external_ref&o1=substring&v1=${reference}&order=bug_status"
82 BuiltIn.Set Test Message ${msg}${newline}${bugs}${newline}${newline}${TEST_MESSAGE}
83 BuiltIn.Log ${msg}${newline}${bugs}
86 [Arguments] ${node} ${session}=session
87 [Documentation] A GET on the /node/${node} API is made and specific flow stat
88 ... strings are checked for existence.
89 ${resp} RequestsLibrary.Get Request ${session} ${OPERATIONAL_NODES_API}/node/${node}
90 Should Be Equal As Strings ${resp.status_code} 200
91 Should Contain ${resp.content} flow-capable-node-connector-statistics
92 Should Contain ${resp.content} flow-table-statistics
94 Check For Specific Number Of Elements At URI
95 [Arguments] ${uri} ${element} ${expected_count} ${session}=session
96 [Documentation] A GET is made to the specified ${URI} and the specific count of a
97 ... given element is done (as supplied by ${element} and ${expected_count})
98 ${resp} RequestsLibrary.Get Request ${session} ${uri}
100 Should Be Equal As Strings ${resp.status_code} 200
101 Should Contain X Times ${resp.content} ${element} ${expected_count}
104 [Arguments] ${resp_content}
105 ${resp_json} = BuiltIn.Run Keyword If '''${resp_content}''' != '${EMPTY}' RequestsLibrary.To Json ${resp_content} pretty_print=True
106 ... ELSE BuiltIn.Set Variable ${EMPTY}
107 BuiltIn.Log ${resp_json}
108 [Return] ${resp_json}
110 Check For Elements At URI
111 [Arguments] ${uri} ${elements} ${session}=session ${pretty_print_json}=False
112 [Documentation] A GET is made at the supplied ${URI} and every item in the list of
113 ... ${elements} is verified to exist in the response
114 ${resp} RequestsLibrary.Get Request ${session} ${uri}
115 BuiltIn.Run Keyword If "${pretty_print_json}" == "True" Log Content ${resp.content}
116 ... ELSE BuiltIn.Log ${resp.content}
117 Should Be Equal As Strings ${resp.status_code} 200
118 : FOR ${i} IN @{elements}
119 \ Should Contain ${resp.content} ${i}
121 Check For Elements Not At URI
122 [Arguments] ${uri} ${elements} ${session}=session ${pretty_print_json}=False ${check_for_null}=False
123 [Documentation] A GET is made at the supplied ${uri} and every item in the list of
124 ... ${elements} is verified to NOT exist in the response. If ${check_for_null} is True
125 ... return of 404 is treated as empty list. From Neon onwards, an empty list is always
126 ... returned as null, giving 404 on rest call.
127 ${resp} RequestsLibrary.Get Request ${session} ${uri}
128 BuiltIn.Run Keyword If "${pretty_print_json}" == "True" Log Content ${resp.content}
129 ... ELSE BuiltIn.Log ${resp.content}
130 BuiltIn.Run Keyword If "${check_for_null}" == "True" Builtin.Return From Keyword If ${resp.status_code} == 404
131 Should Be Equal As Strings ${resp.status_code} 200
132 : FOR ${i} IN @{elements}
133 \ Should Not Contain ${resp.content} ${i}
136 [Arguments] ${system}=${TOOLS_SYSTEM_IP}
137 Run Command On Mininet ${system} sudo mn -c
138 Run Command On Mininet ${system} sudo ps -elf | egrep 'usr/local/bin/mn' | egrep python | awk '{print "sudo kill -9",$4}' | sh
141 [Arguments] ${system}=${TOOLS_SYSTEM_IP}
142 [Documentation] Cleans up the OVS instance and remove any existing common known bridges.
143 ${output}= Run Command On Mininet ${system} sudo ovs-vsctl list-br
145 : FOR ${i} IN ${output}
146 \ Run Command On Mininet ${system} sudo ovs-vsctl --if-exists del-br ${i}
147 Run Command On Mininet ${system} sudo ovs-vsctl del-manager
149 Extract Value From Content
150 [Arguments] ${content} ${index} ${strip}=nostrip
151 [Documentation] Will take the given response content and return the value at the given index as a string
152 ${value}= Get Json Value ${content} ${index}
153 ${value}= Convert To String ${value}
154 ${value}= Run Keyword If '${strip}' == 'strip' Strip Quotes ${value}
157 Get Process ID Based On Regex On Remote System
158 [Arguments] ${system} ${regex_string_to_match_on} ${user}=${TOOLS_SYSTEM_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s
159 [Documentation] Uses ps to find a process that matches the supplied regex. Returns the PID of that process
160 ... The ${regex_string_to_match_on} should produce a unique process otherwise the PID returned may not be
162 # doing the extra -v grep in this command to exclude the grep process itself from the output
163 ${cmd}= Set Variable ps -elf | grep -v grep | grep ${regex_string_to_match_on} | awk '{print $4}'
164 ${output}= Run Command On Remote System ${system} ${cmd} user=${user} password=${password} prompt=${prompt}
165 ... prompt_timeout=${prompt_timeout}
166 # ${output} contains the system prompt and all we want is the value of the number
167 ${pid}= Fetch From Left ${output} \r
168 # TODO: Get Process * keywords have perhaps non-standard default credentials.
169 # ... Should there be * On Mininet and * On Controller specializations?
172 Get Process Thread Count On Remote System
173 [Arguments] ${system} ${pid} ${user}=${TOOLS_SYSTEM_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s
174 [Documentation] Executes the ps command to retrieve the lightweight process (aka thread) count.
175 ${cmd}= Set Variable ps --no-headers -o nlwp ${pid}
176 ${output}= Run Command On Remote System ${system} ${cmd} user=${user} password=${password} prompt=${prompt}
177 ... prompt_timeout=${prompt_timeout}
178 # ${output} contains the system prompt and all we want is the value of the number
179 ${thread_count}= Fetch From Left ${output} \r
180 [Return] ${thread_count}
183 [Arguments] ${string_to_strip}
184 [Documentation] Will strip ALL quotes from given string and return the new string
185 ${string_to_return}= Replace String ${string_to_strip} " \ count=-1
186 [Return] ${string_to_return}
188 Run Command On Remote System
189 [Arguments] ${system} ${cmd} ${user}=${DEFAULT_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=${DEFAULT_TIMEOUT}
190 ... ${return_stdout}=True ${return_stderr}=False
191 [Documentation] Reduces the common work of running a command on a remote system to a single higher level
192 ... robot keyword, taking care to log in with a public key and. The command given is written and the return value
193 ... depends on the passed argument values of return_stdout (default: True) and return_stderr (default: False).
194 ... At least one should be True, or the keyword will exit and FAIL. If both are True, the resulting return value
195 ... will be a two element list containing both. Otherwise the resulting return value is a string.
196 ... No test conditions are checked.
197 Run Keyword If "${return_stdout}"!="True" and "${return_stderr}"!="True" Fail At least one of {return_stdout} or {return_stderr} args should be set to True
198 ${current_ssh_connection}= SSHLibrary.Get Connection
199 BuiltIn.Log Attempting to execute command "${cmd}" on remote system "${system}" by user "${user}" with keyfile pass "${keyfile_pass}" and prompt "${prompt}" and password "${password}"
200 ${conn_id}= SSHLibrary.Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
201 SSHKeywords.Flexible SSH Login ${user} ${password}
202 ${stdout} ${stderr} SSHLibrary.Execute Command ${cmd} return_stderr=True
203 SSHLibrary.Close Connection
205 Run Keyword If "${return_stdout}"!="True" Return From Keyword ${stderr}
206 Run Keyword If "${return_stderr}"!="True" Return From Keyword ${stdout}
207 [Teardown] SSHKeywords.Restore_Current_SSH_Connection_From_Index ${current_ssh_connection.index}
208 [Return] ${stdout} ${stderr}
210 Run Command On Remote System And Log
211 [Arguments] ${system} ${cmd} ${user}=${DEFAULT_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=${DEFAULT_TIMEOUT}
212 [Documentation] Reduces the common work of running a command on a remote system to a single higher level
213 ... robot keyword, taking care to log in with a public key and. The command given is written
214 ... and the output returned. No test conditions are checked.
215 ${output} = Run Command On Remote System ${system} ${cmd} ${user} ${password} ${prompt}
216 ... ${prompt_timeout}
220 Run Command On Mininet
221 [Arguments] ${system}=${TOOLS_SYSTEM_IP} ${cmd}=echo ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${TOOLS_SYSTEM_PROMPT}
222 [Documentation] Call Run Comand On Remote System, but with default values suitable for Mininet machine.
223 BuiltIn.Run Keyword And Return Run Command On Remote System ${system} ${cmd} ${user} ${password} prompt=${prompt}
225 Run Command On Controller
226 [Arguments] ${system}=${ODL_SYSTEM_IP} ${cmd}=echo ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT}
227 [Documentation] Call Run Comand On Remote System, but with default values suitable for Controller machine.
228 BuiltIn.Run Keyword And Return Run Command On Remote System ${system} ${cmd} ${user} ${password} prompt=${prompt}
230 Run Command On Existing Connection
231 [Arguments] ${conn_id}=${EMPTY} ${cmd}=echo ${return_stdout}=True ${return_stderr}=False
232 [Documentation] Switch to and run command on an already existing SSH connection and switch back
233 Run Keyword If "${return_stdout}"!="True" and "${return_stderr}"!="True" Fail At least one of {return_stdout} or {return_stderr} args should be set to True
234 ${current_ssh_connection}= SSHLibrary.Get Connection
235 BuiltIn.Log Attempting to execute command "${cmd}" on existing connection "${conn_id}
236 SSHLibrary.Switch Connection ${conn_id}
237 ${stdout} ${stderr} SSHLibrary.Execute Command ${cmd} return_stderr=True
239 Run Keyword If "${return_stdout}"!="True" Return From Keyword ${stderr}
240 Run Keyword If "${return_stderr}"!="True" Return From Keyword ${stdout}
241 [Teardown] SSHKeywords.Restore_Current_SSH_Connection_From_Index ${current_ssh_connection.index}
242 [Return] ${stdout} ${stderr}
244 Verify File Exists On Remote System
245 [Arguments] ${system} ${file} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=5s
246 [Documentation] Will create connection with public key and will PASS if the given ${file} exists,
247 ... otherwise will FAIL
248 ${conn_id}= Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
249 SSHKeywords.Flexible SSH Login ${user} ${password}
250 SSHLibrary.File Should Exist ${file}
253 Check Karaf Log File Does Not Have Messages
254 [Arguments] ${ip} ${message} ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT} ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log
255 [Documentation] Fails if the provided ${message} is found in the karaf.log file. Uses grep to search. The
256 ... karaf.log file can be overridden with ${log_file} to be any file on the given system @ ${ip}
257 ${output}= Run Command On Controller ${ip} grep -c '${message}' ${log_file} user=${user} password=${password} prompt=${prompt}
258 Should Be Equal As Strings ${output} 0
260 Verify Controller Is Not Dead
261 [Arguments] ${controller_ip}=${ODL_SYSTEM_IP}
262 [Documentation] Will execute any tests to verify the controller is not dead. Some checks are
263 ... Out Of Memory Execptions.
264 Check Karaf Log File Does Not Have Messages ${controller_ip} java.lang.OutOfMemoryError
265 # TODO: Should Verify Controller * keywords also accept user, password, prompt and karaf_log arguments?
267 Verify Controller Has No Null Pointer Exceptions
268 [Arguments] ${controller_ip}=${ODL_SYSTEM_IP}
269 [Documentation] Will execute any tests to verify the controller is not having any null pointer eceptions.
270 Check Karaf Log File Does Not Have Messages ${controller_ip} java.lang.NullPointerException
274 [Documentation] Get the Epoc time from MM/DD/YYYY HH:MM:SS
275 ${epoch_time}= Convert Date ${time} epoch exclude_milles=True date_format=%m/%d/%Y %H:%M:%S
276 ${epoch_time}= Convert To Integer ${epoch_time}
277 [Return] ${epoch_time}
279 Remove Space on String
280 [Arguments] ${str} ${count}=-1
281 [Documentation] Remove the empty space from given string.count is optional,if its given
282 ... that many occurence of space will be removed from left
283 ${x}= Convert To String ${str}
284 ${x}= Replace String ${str} ${SPACE} ${EMPTY} count=${count}
287 Split Value from String
288 [Arguments] ${str} ${splitter}
289 [Documentation] Split the String based on given splitter and return as list
290 @{x}= Split String ${str} ${splitter}
293 Concatenate the String
294 [Arguments] ${str1} ${str2}
295 [Documentation] Catenate the two non-string objects and return as String
296 ${str1}= Convert to String ${str1}
297 ${str2}= Convert to String ${str2}
298 ${output}= Catenate ${str1} ${str2}
302 [Arguments] ${rest_uri} ${data} ${headers}=${headers} ${session}=session
303 [Documentation] Perform a POST rest operation, using the URL and data provided
304 ${resp} = RequestsLibrary.Post Request ${session} ${rest_uri} data=${data} headers=${headers}
306 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
308 Remove All Elements At URI
309 [Arguments] ${uri} ${session}=session
310 ${resp} RequestsLibrary.Delete Request ${session} ${uri}
311 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
313 Remove All Elements At URI And Verify
314 [Arguments] ${uri} ${session}=session
315 ${resp} RequestsLibrary.Delete Request ${session} ${uri}
316 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
317 ${resp} RequestsLibrary.Get Request ${session} ${uri}
318 Should Be Equal As Strings ${resp.status_code} 404
320 Remove All Elements If Exist
321 [Arguments] ${uri} ${session}=session
322 [Documentation] Delete all elements from an URI if the configuration was not empty
323 ${resp} RequestsLibrary.Get Request ${session} ${uri}
324 Run Keyword If '${resp.status_code}'!='404' Remove All Elements At URI ${uri} ${session}
326 Add Elements To URI From File
327 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
328 [Documentation] Put data from a file to a URI
329 ${body} OperatingSystem.Get File ${data_file}
330 ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} data=${body} headers=${headers}
331 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
333 Add Elements To URI From File And Verify
334 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
335 [Documentation] Put data from a file to a URI and verify the HTTP response
336 ${body} OperatingSystem.Get File ${data_file}
337 Add Elements to URI And Verify ${dest_uri} ${body} ${headers} ${session}
339 Add Elements To URI And Verify
340 [Arguments] ${dest_uri} ${data} ${headers}=${headers} ${session}=session
341 [Documentation] Put data to a URI and verify the HTTP response
342 ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} ${data} headers=${headers}
343 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
344 ${resp} RequestsLibrary.Get Request ${session} ${dest_uri}
345 Should Not Be Equal ${resp.status_code} 404
347 Add Elements To URI From File And Check Validation Error
348 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
349 [Documentation] Shorthand for PUTting data from file and expecting status code 400.
350 BuiltIn.Comment TODO: Does this have any benefits, considering TemplatedRequests can also do this in one line?
351 ${body} OperatingSystem.Get File ${data_file}
352 ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} data=${body} headers=${headers}
353 Should Contain ${DATA_VALIDATION_ERROR} ${resp.status_code}
355 Add Elements To URI From File And Check Server Error
356 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
357 [Documentation] Shorthand for PUTting data from file and expecting status code 500.
358 ... Consider opening a Bug against ODL, as in most test cases, 400 is the http code to expect.
359 BuiltIn.Comment TODO: Does this have any benefits, considering TemplatedRequests can also do this in one line?
360 ${body} OperatingSystem.Get File ${data_file}
361 ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} data=${body} headers=${headers}
362 Should Contain ${INTERNAL_SERVER_ERROR} ${resp.status_code}
364 Post Elements To URI From File
365 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
366 ${body} OperatingSystem.Get File ${data_file}
367 ${resp} RequestsLibrary.Post Request ${session} ${dest_uri} data=${body} headers=${headers}
368 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
370 Run Process With Logging And Status Check
371 [Arguments] @{proc_args}
372 [Documentation] Execute an OS command, log STDOUT and STDERR output and check exit code to be 0
373 ${result}= Run Process @{proc_args}
376 Should Be Equal As Integers ${result.rc} 0
380 [Arguments] ${session} ${uri} ${headers}=${NONE}
381 [Documentation] Issue a GET request and return the data obtained or on error log the error and fail.
382 ... Issues a GET request for ${uri} in ${session} using headers from
383 ... ${headers}. If the request returns a HTTP error, fails. Otherwise
384 ... returns the data obtained by the request.
385 ${response}= RequestsLibrary.Get Request ${session} ${uri} ${headers}
386 Builtin.Return_From_Keyword_If ${response.status_code} == 200 ${response.text}
387 Builtin.Log ${response.text}
388 Builtin.Fail The request failed with code ${response.status_code}
391 [Arguments] ${uri} ${session}=session ${headers}=${NONE}
392 [Documentation] Issue a GET request and verify a successfull HTTP return.
393 ... Issues a GET request for ${uri} in ${session} using headers from ${headers}.
394 ${response} = RequestsLibrary.Get Request ${session} ${uri} ${headers}
395 Builtin.Log ${response.status_code}
396 Should Contain ${ALLOWED_STATUS_CODES} ${response.status_code}
399 [Arguments] ${session} ${uri} ${headers}=${NONE}
400 [Documentation] Issue a GET request and return on error 404 (No content) or will fail and log the content.
401 ... Issues a GET request for ${uri} in ${session} using headers from
402 ... ${headers}. If the request returns a HTTP error, fails. Otherwise
403 ... returns the data obtained by the request.
404 ${response}= RequestsLibrary.Get Request ${session} ${uri} ${headers}
405 Builtin.Return_From_Keyword_If ${response.status_code} == 404
406 Builtin.Log ${response.text}
407 Builtin.Fail The request failed with code ${response.status_code}
409 Get Index From List Of Dictionaries
410 [Arguments] ${dictionary_list} ${key} ${value}
411 [Documentation] Extract index for the dictionary in a list that contains a key-value pair. Returns -1 if key-value is not found.
412 ${length}= Get Length ${dictionary_list}
413 ${index}= Set Variable -1
414 : FOR ${i} IN RANGE ${length}
415 \ ${dictionary}= Get From List ${dictionary_list} ${i}
416 \ Run Keyword If """&{dictionary}[${key}]""" == """${value}""" Set Test Variable ${index} ${i}
419 Check Item Occurrence
420 [Arguments] ${string} ${dictionary_item_occurrence}
421 [Documentation] Check string for occurrences of items expressed in a list of dictionaries {item=occurrences}. 0 occurences means item is not present.
422 : FOR ${item} IN @{dictionary_item_occurrence}
423 \ Should Contain X Times ${string} ${item} &{dictionary_item_occurrence}[${item}]
426 [Arguments] ${uri} ${body} ${status_code}=200 ${session}=session
427 [Documentation] Post body to ${uri}, log response content, and check status
428 ${resp}= RequestsLibrary.Post Request ${session} ${uri} ${body}
430 Should Be Equal As Strings ${resp.status_code} ${status_code}
434 [Arguments] ${testtool} ${testcase}=${EMPTY}
435 [Documentation] Get the name of the suite sanitized to be usable as a part of filename.
436 ... These names are used to constructs names of the log files produced
437 ... by the testing tools so two suites using a tool wont overwrite the
438 ... log files if they happen to run in one job.
439 ${name}= BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","-").replace("/","-").replace(".","-")
440 ${suffix}= BuiltIn.Set_Variable_If '${testcase}' != '' --${testcase} ${EMPTY}
441 ${date} = DateTime.Get Current Date
442 ${timestamp} = DateTime.Convert Date ${date} epoch
443 [Return] ${testtool}--${name}${suffix}.${timestamp}.log
445 Set_User_Configurable_Variable_Default
446 [Arguments] ${name} ${value}
447 [Documentation] Set a default value for an user configurable variable.
448 ... This keyword is needed if your default value is calculated using
449 ... a complex expression which needs BuiltIn.Evaluate or even more
450 ... complex keywords. It sets the variable ${name} (the name of the
451 ... variable MUST be specified WITHOUT the ${} syntactic sugar due
452 ... to limitations of Robot Framework) to ${value} but only if the
453 ... variable ${name} was not set previously. This keyword is intended
454 ... for user configurable variables which are supposed to be set only
455 ... with pybot -v; calling this keyword on a variable that was already
456 ... set by another keyword will silently turn the call into a NOP and
457 ... thus is a bug in the suite or resource trying to call this
459 # TODO: Figure out how to make the ${value} evaluation "lazy" (meaning
460 # evaluating it only when the user did not set anything and thus the
461 # default is needed). This might be needed to avoid potentially costly
462 # keyword invocations when they are not needed. Currently no need for
463 # this was identified, thus leaving it here as a TODO. Based on
464 # comments the best approach would be to create another keyword that
465 # expects a ScalarClosure in the place of ${value} and calls the
466 # closure to get the value but only if the value is needed).
467 # The best idea how to implement this "laziness" would be to have the
468 # used to define another keyword that will be responsible for getting
469 # the default value and then passing the name of this getter keyword
470 # to this keyword. Then this keyword would call the getter (to obtain
471 # the expensive default value) only if it discovers that this value
472 # is really needed (because the variable is not set yet).
473 # TODO: Is the above TODO really necessary? Right now we don't have any
474 # examples of "expensive default values" where to obtain the default
475 # value is so expensive on resources (e.g. need to SSH somewhere to
476 # check something) that we would want to skip the calculation if the
477 # variable for which it is needed has a value already provided by the
478 # user using "pybot -v" or something. One example would be
479 # JAVA_HOME if it would be designed as user-configurable variable
480 # (currently it is not; users can specify "use jdk7" or "use jdk8"
481 # but not "use the jdk over there"; and there actually is no JAVA_HOME
482 # present in the resource, rather the Java invocation command uses the
483 # Java invocation with a full path). The default value of JAVA_HOME
484 # has to be obtained by issuing commands on the SSH connection where
485 # the resulting Java invocation command will be used (to check
486 # multiple candidate paths until one that fits is found) and we could
487 # skip all this checking if a JAVA_HOME was supplied by the user using
489 ${value}= BuiltIn.Get_Variable_Value \${${name}} ${value}
490 BuiltIn.Set_Suite_Variable \${${name}} ${value}
494 [Documentation] Convert a Robot time string to an integer expressing the time in minutes, rounded up
495 ... This is a wrapper around DateTime.Convert_Time which does not
496 ... provide this functionality directly nor is even able to produce
497 ... an integer directly. It is needed for RestPerfClient which
498 ... cannot accept floats for its --timeout parameter and interprets
499 ... the value supplied in this parameter in minutes.
500 ${seconds}= DateTime.Convert_Time ${time} result_format=number
501 ${minutes}= BuiltIn.Evaluate int(math.ceil(${seconds}/60.0)) modules=math
504 Write Commands Until Expected Prompt
505 [Arguments] ${cmd} ${prompt} ${timeout}=${DEFAULT_TIMEOUT}
506 [Documentation] quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable
507 BuiltIn.Log cmd: ${cmd}
508 SSHLibrary.Set Client Configuration timeout=${timeout}
510 SSHLibrary.Write ${cmd}
511 ${output}= SSHLibrary.Read Until ${prompt}
514 Write Commands Until Expected Regexp
515 [Arguments] ${cmd} ${regexp} ${timeout}=${DEFAULT_TIMEOUT}
516 [Documentation] quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable
517 BuiltIn.Log cmd: ${cmd}
518 SSHLibrary.Set Client Configuration timeout=${timeout}
520 SSHLibrary.Write ${cmd}
521 ${output}= SSHLibrary.Read Until Regexp ${regexp}
524 Install Package On Ubuntu System
525 [Arguments] ${package_name} ${system}=${TOOLS_SYSTEM_IP} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s
526 [Documentation] Keyword to install packages for testing to Ubuntu Mininet VM
527 Log Keyword to install package to Mininet Ubuntu VM
528 Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
529 SSHKeywords.Flexible Mininet Login user=${user} password=${password}
530 Write sudo apt-get install -y ${package_name}
533 Json Parse From String
534 [Arguments] ${plain_string_with_json}
535 [Documentation] Parse given plain string into json (dictionary)
536 ${json_data} Evaluate json.loads('''${plain_string_with_json}''') json
537 [Return] ${json_data}
540 [Arguments] ${json_file}
541 [Documentation] Parse given file content into json (dictionary)
542 ${json_plain_string} OperatingSystem.Get file ${json_file}
543 ${json_data} Json Parse From String ${json_plain_string}
544 [Return] ${json_data}
546 Modify Iptables On Remote System
547 [Arguments] ${remote_system_ip} ${iptables_rule} ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT}
548 [Documentation] Wrapper keyword to run iptables with any given ${iptables_rule} string on the remote system given
549 ... by ${remote_system_ip}. The iptables listing will be output before and after the command is run
550 ${list_iptables_command} = BuiltIn.Set Variable sudo /sbin/iptables -L -n
551 ${output} = Utils.Run Command On Remote System ${remote_system_ip} ${list_iptables_command} ${user} ${password} prompt=${prompt}
552 BuiltIn.Log ${output}
553 Utils.Run Command On Remote System ${remote_system_ip} sudo /sbin/iptables ${iptables_rule} ${user} ${password} prompt=${prompt}
554 ${output} = Utils.Run Command On Remote System ${remote_system_ip} ${list_iptables_command} ${user} ${password} prompt=${prompt}
555 BuiltIn.Log ${output}
557 Get_Sysstat_Statistics
558 [Arguments] ${ip_address}=${ODL_SYSTEM_IP}
559 [Documentation] Store current connection index, open new connection to ip_address. Run command to get sysstat results from script,
560 ... which is running on all children nodes. Returns cpu, network, memory usage statistics from the node for each 10 minutes
561 ... that node was running. Used for debug purposes. Returns whole output of sysstat.
562 ${current_connection}= SSHLibrary.Get_Connection
563 SSHKeywords.Open_Connection_To_ODL_System ${ip_address}
564 SSHLibrary.Write sar -A -f /var/log/sa/sa*
565 ${output} SSHLibrary.Read_Until_Prompt
566 BuiltIn.Log ${output}
567 SSHLibrary.Close_Connection
568 [Teardown] SSHKeywords.Restore_Current_SSH_Connection_From_Index ${current_connection.index}
572 [Arguments] ${ip_address}=${ODL_SYSTEM_IP} ${check_status}=True ${expected_status}=${200}
573 [Documentation] GET http://${ip_address}:${RESTCONFPORT}/diagstatus and return the response. ${check_status}
574 ... and ${expected_status_code} can be used to ignore the status code, or validate any status code value.
575 ... By default, this keyword will pass if the status code returned is 200, and fail otherwise.
576 RequestsLibrary.Create Session diagstatus_session http://${ip_address}:${RESTCONFPORT}
577 ${resp} RequestsLibrary.Get Request diagstatus_session /diagstatus
578 Run Keyword If "${check_status}" == "True" BuiltIn.Should Be Equal As Strings ${resp.status_code} ${expected_status}
581 Download File On Openstack Node
582 [Arguments] ${conn_id} ${save_file_name} ${url}
583 [Documentation] Download a file from web to the node. the input will be a session ID with established SSH connection.
584 SSHLibrary.Switch Connection ${conn_id}
585 Utils.Write Commands Until Expected Prompt wget -O /tmp/${save_file_name} ${url} ${DEFAULT_LINUX_PROMPT_STRICT}