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 Variables ${CURDIR}/../variables/Variables.py
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 ${bug_url}= BuiltIn.Set_Variable https://bugs.opendaylight.org/show_bug.cgi?id=${number}
57 ${msg}= BuiltIn.Set_Variable This test fails due to ${bug_url}
58 ${newline}= BuiltIn.Evaluate chr(10)
59 BuiltIn.Set Test Message ${msg}${newline}${newline}${TEST_MESSAGE}
61 BuiltIn.Run_Keyword_If "${include_bug_in_tags}"=="True" Set Tags ${bug_url}
63 Report_Failure_And_Point_To_Linked_Bugs
64 [Documentation] Report that a test failed and point to linked Bugzilla bug(s).
65 ... Linked bugs must contain the ${reference} inside comments (workaround
66 ... becasue of currently missing suitable field for external references and
67 ... not correctly working the CONTENT MATCHES filter).
68 ... Not FAILED (incl. SKIPPED) test are not reported.
69 ... This keyword must be used in the [Teardown] setting of the affected test
70 ... or as the first line of the test if FastFail module is not being
71 ... used. It reports the URL of the bug on console and also puts it
72 ... into the Robot log file.
73 ${test_skipped}= BuiltIn.Evaluate len(re.findall('SKIPPED', """${TEST_MESSAGE}""")) > 0 modules=re
74 BuiltIn.Return From Keyword If ('${TEST_STATUS}' != 'FAIL') or ${test_skipped}
75 ${newline}= BuiltIn.Evaluate chr(10)
76 ${reference}= String.Replace_String_Using_Regexp ${SUITE_NAME}_${TEST_NAME} [ /\.-] _
77 ${reference}= String.Convert_To_Lowercase ${reference}
78 ${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)
79 ${bugs}= BuiltIn.Set_Variable "https://bugs.opendaylight.org/buglist.cgi?f1=cf_external_ref&o1=substring&v1=${reference}&order=bug_status"
80 BuiltIn.Set Test Message ${msg}${newline}${bugs}${newline}${newline}${TEST_MESSAGE}
81 BuiltIn.Log ${msg}${newline}${bugs}
84 [Arguments] ${node} ${session}=session
85 [Documentation] A GET on the /node/${node} API is made and specific flow stat
86 ... strings are checked for existence.
87 ${resp} RequestsLibrary.Get Request ${session} ${OPERATIONAL_NODES_API}/node/${node}
88 Should Be Equal As Strings ${resp.status_code} 200
89 Should Contain ${resp.content} flow-capable-node-connector-statistics
90 Should Contain ${resp.content} flow-table-statistics
92 Check For Specific Number Of Elements At URI
93 [Arguments] ${uri} ${element} ${expected_count} ${session}=session
94 [Documentation] A GET is made to the specified ${URI} and the specific count of a
95 ... given element is done (as supplied by ${element} and ${expected_count})
96 ${resp} RequestsLibrary.Get Request ${session} ${uri}
98 Should Be Equal As Strings ${resp.status_code} 200
99 Should Contain X Times ${resp.content} ${element} ${expected_count}
102 [Arguments] ${resp_content}
103 ${resp_json} = BuiltIn.Run Keyword If '''${resp_content}''' != '${EMPTY}' RequestsLibrary.To Json ${resp_content} pretty_print=True
104 ... ELSE BuiltIn.Set Variable ${EMPTY}
105 BuiltIn.Log ${resp_json}
106 [Return] ${resp_json}
108 Check For Elements At URI
109 [Arguments] ${uri} ${elements} ${session}=session ${pretty_print_json}=False
110 [Documentation] A GET is made at the supplied ${URI} and every item in the list of
111 ... ${elements} is verified to exist in the response
112 ${resp} RequestsLibrary.Get Request ${session} ${uri}
113 BuiltIn.Run Keyword If "${pretty_print_json}" == "True" Log Content ${resp.content}
114 ... ELSE BuiltIn.Log ${resp.content}
115 Should Be Equal As Strings ${resp.status_code} 200
116 : FOR ${i} IN @{elements}
117 \ Should Contain ${resp.content} ${i}
119 Check For Elements Not At URI
120 [Arguments] ${uri} ${elements} ${session}=session ${pretty_print_json}=False
121 [Documentation] A GET is made at the supplied ${URI} and every item in the list of
122 ... ${elements} is verified to NOT exist in the response
123 ${resp} RequestsLibrary.Get Request ${session} ${uri}
124 BuiltIn.Run Keyword If "${pretty_print_json}" == "True" Log Content ${resp.content}
125 ... ELSE BuiltIn.Log ${resp.content}
126 Should Be Equal As Strings ${resp.status_code} 200
127 : FOR ${i} IN @{elements}
128 \ Should Not Contain ${resp.content} ${i}
131 [Arguments] ${system}=${TOOLS_SYSTEM_IP}
132 Run Command On Mininet ${system} sudo mn -c
133 Run Command On Mininet ${system} sudo ps -elf | egrep 'usr/local/bin/mn' | egrep python | awk '{print "sudo kill -9",$4}' | sh
136 [Arguments] ${system}=${TOOLS_SYSTEM_IP}
137 [Documentation] Cleans up the OVS instance and remove any existing common known bridges.
138 ${output}= Run Command On Mininet ${system} sudo ovs-vsctl list-br
140 : FOR ${i} IN ${output}
141 \ Run Command On Mininet ${system} sudo ovs-vsctl --if-exists del-br ${i}
142 Run Command On Mininet ${system} sudo ovs-vsctl del-manager
144 Extract Value From Content
145 [Arguments] ${content} ${index} ${strip}=nostrip
146 [Documentation] Will take the given response content and return the value at the given index as a string
147 ${value}= Get Json Value ${content} ${index}
148 ${value}= Convert To String ${value}
149 ${value}= Run Keyword If '${strip}' == 'strip' Strip Quotes ${value}
152 Get Process ID Based On Regex On Remote System
153 [Arguments] ${system} ${regex_string_to_match_on} ${user}=${TOOLS_SYSTEM_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s
154 [Documentation] Uses ps to find a process that matches the supplied regex. Returns the PID of that process
155 ... The ${regex_string_to_match_on} should produce a unique process otherwise the PID returned may not be
157 # doing the extra -v grep in this command to exclude the grep process itself from the output
158 ${cmd}= Set Variable ps -elf | grep -v grep | grep ${regex_string_to_match_on} | awk '{print $4}'
159 ${output}= Run Command On Remote System ${system} ${cmd} user=${user} password=${password} prompt=${prompt}
160 ... prompt_timeout=${prompt_timeout}
161 # ${output} contains the system prompt and all we want is the value of the number
162 ${pid}= Fetch From Left ${output} \r
163 # TODO: Get Process * keywords have perhaps non-standard default credentials.
164 # ... Should there be * On Mininet and * On Controller specializations?
167 Get Process Thread Count On Remote System
168 [Arguments] ${system} ${pid} ${user}=${TOOLS_SYSTEM_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s
169 [Documentation] Executes the ps command to retrieve the lightweight process (aka thread) count.
170 ${cmd}= Set Variable ps --no-headers -o nlwp ${pid}
171 ${output}= Run Command On Remote System ${system} ${cmd} user=${user} password=${password} prompt=${prompt}
172 ... prompt_timeout=${prompt_timeout}
173 # ${output} contains the system prompt and all we want is the value of the number
174 ${thread_count}= Fetch From Left ${output} \r
175 [Return] ${thread_count}
178 [Arguments] ${string_to_strip}
179 [Documentation] Will strip ALL quotes from given string and return the new string
180 ${string_to_return}= Replace String ${string_to_strip} " \ count=-1
181 [Return] ${string_to_return}
183 Run Command On Remote System
184 [Arguments] ${system} ${cmd} ${user}=${DEFAULT_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=${DEFAULT_TIMEOUT}
185 ... ${return_stdout}=True ${return_stderr}=False
186 [Documentation] Reduces the common work of running a command on a remote system to a single higher level
187 ... robot keyword, taking care to log in with a public key and. The command given is written and the return value
188 ... depends on the passed argument values of return_stdout (default: True) and return_stderr (default: False).
189 ... At least one should be True, or the keyword will exit and FAIL. If both are True, the resulting return value
190 ... will be a two element list containing both. Otherwise the resulting return value is a string.
191 ... No test conditions are checked.
192 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
193 ${current_ssh_connection}= SSHLibrary.Get Connection
194 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}"
195 ${conn_id}= SSHLibrary.Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
196 SSHKeywords.Flexible SSH Login ${user} ${password}
197 ${stdout} ${stderr} SSHLibrary.Execute Command ${cmd} return_stderr=True
198 SSHLibrary.Close Connection
200 Run Keyword If "${return_stdout}"!="True" Return From Keyword ${stderr}
201 Run Keyword If "${return_stderr}"!="True" Return From Keyword ${stdout}
202 [Teardown] SSHKeywords.Restore_Current_SSH_Connection_From_Index ${current_ssh_connection.index}
203 [Return] ${stdout} ${stderr}
205 Run Command On Remote System And Log
206 [Arguments] ${system} ${cmd} ${user}=${DEFAULT_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=${DEFAULT_TIMEOUT}
207 [Documentation] Reduces the common work of running a command on a remote system to a single higher level
208 ... robot keyword, taking care to log in with a public key and. The command given is written
209 ... and the output returned. No test conditions are checked.
210 ${output} = Run Command On Remote System ${system} ${cmd} ${user} ${password} ${prompt}
211 ... ${prompt_timeout}
215 Run Command On Mininet
216 [Arguments] ${system}=${TOOLS_SYSTEM_IP} ${cmd}=echo ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${TOOLS_SYSTEM_PROMPT}
217 [Documentation] Call Run Comand On Remote System, but with default values suitable for Mininet machine.
218 BuiltIn.Run Keyword And Return Run Command On Remote System ${system} ${cmd} ${user} ${password} prompt=${prompt}
220 Run Command On Controller
221 [Arguments] ${system}=${ODL_SYSTEM_IP} ${cmd}=echo ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT}
222 [Documentation] Call Run Comand On Remote System, but with default values suitable for Controller machine.
223 BuiltIn.Run Keyword And Return Run Command On Remote System ${system} ${cmd} ${user} ${password} prompt=${prompt}
225 Verify File Exists On Remote System
226 [Arguments] ${system} ${file} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=5s
227 [Documentation] Will create connection with public key and will PASS if the given ${file} exists,
228 ... otherwise will FAIL
229 ${conn_id}= Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
230 SSHKeywords.Flexible SSH Login ${user} ${password}
231 SSHLibrary.File Should Exist ${file}
234 Check Karaf Log File Does Not Have Messages
235 [Arguments] ${ip} ${message} ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT} ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log
236 [Documentation] Fails if the provided ${message} is found in the karaf.log file. Uses grep to search. The
237 ... karaf.log file can be overridden with ${log_file} to be any file on the given system @ ${ip}
238 ${output}= Run Command On Controller ${ip} grep -c '${message}' ${log_file} user=${user} password=${password} prompt=${prompt}
239 Should Be Equal As Strings ${output} 0
241 Verify Controller Is Not Dead
242 [Arguments] ${controller_ip}=${ODL_SYSTEM_IP}
243 [Documentation] Will execute any tests to verify the controller is not dead. Some checks are
244 ... Out Of Memory Execptions.
245 Check Karaf Log File Does Not Have Messages ${controller_ip} java.lang.OutOfMemoryError
246 # TODO: Should Verify Controller * keywords also accept user, password, prompt and karaf_log arguments?
248 Verify Controller Has No Null Pointer Exceptions
249 [Arguments] ${controller_ip}=${ODL_SYSTEM_IP}
250 [Documentation] Will execute any tests to verify the controller is not having any null pointer eceptions.
251 Check Karaf Log File Does Not Have Messages ${controller_ip} java.lang.NullPointerException
255 [Documentation] Get the Epoc time from MM/DD/YYYY HH:MM:SS
256 ${epoch_time}= Convert Date ${time} epoch exclude_milles=True date_format=%m/%d/%Y %H:%M:%S
257 ${epoch_time}= Convert To Integer ${epoch_time}
258 [Return] ${epoch_time}
260 Remove Space on String
261 [Arguments] ${str} ${count}=-1
262 [Documentation] Remove the empty space from given string.count is optional,if its given
263 ... that many occurence of space will be removed from left
264 ${x}= Convert To String ${str}
265 ${x}= Replace String ${str} ${SPACE} ${EMPTY} count=${count}
268 Split Value from String
269 [Arguments] ${str} ${splitter}
270 [Documentation] Split the String based on given splitter and return as list
271 @{x}= Split String ${str} ${splitter}
274 Concatenate the String
275 [Arguments] ${str1} ${str2}
276 [Documentation] Catenate the two non-string objects and return as String
277 ${str1}= Convert to String ${str1}
278 ${str2}= Convert to String ${str2}
279 ${output}= Catenate ${str1} ${str2}
283 [Arguments] ${rest_uri} ${data} ${headers}=${headers} ${session}=session
284 [Documentation] Perform a POST rest operation, using the URL and data provided
285 ${resp} = RequestsLibrary.Post Request ${session} ${rest_uri} data=${data} headers=${headers}
287 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
289 Remove All Elements At URI
290 [Arguments] ${uri} ${session}=session
291 ${resp} RequestsLibrary.Delete Request ${session} ${uri}
292 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
294 Remove All Elements At URI And Verify
295 [Arguments] ${uri} ${session}=session
296 ${resp} RequestsLibrary.Delete Request ${session} ${uri}
297 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
298 ${resp} RequestsLibrary.Get Request ${session} ${uri}
299 Should Be Equal As Strings ${resp.status_code} 404
301 Remove All Elements If Exist
302 [Arguments] ${uri} ${session}=session
303 [Documentation] Delete all elements from an URI if the configuration was not empty
304 ${resp} RequestsLibrary.Get Request ${session} ${uri}
305 Run Keyword If '${resp.status_code}'!='404' Remove All Elements At URI ${uri} ${session}
307 Add Elements To URI From File
308 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
309 ${body} OperatingSystem.Get File ${data_file}
310 ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} data=${body} headers=${headers}
311 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
313 Add Elements To URI From File And Verify
314 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
315 ${body} OperatingSystem.Get File ${data_file}
316 ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} data=${body} headers=${headers}
317 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
318 ${resp} RequestsLibrary.Get Request ${session} ${dest_uri}
319 Should Not Be Equal ${resp.status_code} 404
321 Add Elements To URI And Verify
322 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
323 ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} ${data_file} headers=${headers}
324 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
325 ${resp} RequestsLibrary.Get Request ${session} ${dest_uri}
326 Should Not Be Equal ${resp.status_code} 404
328 Add Elements To URI From File And Check Validation Error
329 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
330 [Documentation] Shorthand for PUTting data from file and expecting status code 400.
331 BuiltIn.Comment TODO: Does this have any benefits, considering TemplatedRequests can also do this in one line?
332 ${body} OperatingSystem.Get File ${data_file}
333 ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} data=${body} headers=${headers}
334 Should Contain ${DATA_VALIDATION_ERROR} ${resp.status_code}
336 Add Elements To URI From File And Check Server Error
337 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
338 [Documentation] Shorthand for PUTting data from file and expecting status code 500.
339 ... Consider opening a Bug against ODL, as in most test cases, 400 is the http code to expect.
340 BuiltIn.Comment TODO: Does this have any benefits, considering TemplatedRequests can also do this in one line?
341 ${body} OperatingSystem.Get File ${data_file}
342 ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} data=${body} headers=${headers}
343 Should Contain ${INTERNAL_SERVER_ERROR} ${resp.status_code}
345 Post Elements To URI From File
346 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
347 ${body} OperatingSystem.Get File ${data_file}
348 ${resp} RequestsLibrary.Post Request ${session} ${dest_uri} data=${body} headers=${headers}
349 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
351 Run Process With Logging And Status Check
352 [Arguments] @{proc_args}
353 [Documentation] Execute an OS command, log STDOUT and STDERR output and check exit code to be 0
354 ${result}= Run Process @{proc_args}
357 Should Be Equal As Integers ${result.rc} 0
361 [Arguments] ${session} ${uri} ${headers}=${NONE}
362 [Documentation] Issue a GET request and return the data obtained or on error log the error and fail.
363 ... Issues a GET request for ${uri} in ${session} using headers from
364 ... ${headers}. If the request returns a HTTP error, fails. Otherwise
365 ... returns the data obtained by the request.
366 ${response}= RequestsLibrary.Get Request ${session} ${uri} ${headers}
367 Builtin.Return_From_Keyword_If ${response.status_code} == 200 ${response.text}
368 Builtin.Log ${response.text}
369 Builtin.Fail The request failed with code ${response.status_code}
372 [Arguments] ${session} ${uri} ${headers}=${NONE}
373 [Documentation] Issue a GET request and return on error 404 (No content) or will fail and log the content.
374 ... Issues a GET request for ${uri} in ${session} using headers from
375 ... ${headers}. If the request returns a HTTP error, fails. Otherwise
376 ... returns the data obtained by the request.
377 ${response}= RequestsLibrary.Get Request ${session} ${uri} ${headers}
378 Builtin.Return_From_Keyword_If ${response.status_code} == 404
379 Builtin.Log ${response.text}
380 Builtin.Fail The request failed with code ${response.status_code}
382 Get Index From List Of Dictionaries
383 [Arguments] ${dictionary_list} ${key} ${value}
384 [Documentation] Extract index for the dictionary in a list that contains a key-value pair. Returns -1 if key-value is not found.
385 ${length}= Get Length ${dictionary_list}
386 ${index}= Set Variable -1
387 : FOR ${i} IN RANGE ${length}
388 \ ${dictionary}= Get From List ${dictionary_list} ${i}
389 \ Run Keyword If """&{dictionary}[${key}]""" == """${value}""" Set Test Variable ${index} ${i}
392 Check Item Occurrence
393 [Arguments] ${string} ${dictionary_item_occurrence}
394 [Documentation] Check string for occurrences of items expressed in a list of dictionaries {item=occurrences}. 0 occurences means item is not present.
395 : FOR ${item} IN @{dictionary_item_occurrence}
396 \ Should Contain X Times ${string} ${item} &{dictionary_item_occurrence}[${item}]
399 [Arguments] ${uri} ${body} ${status_code}=200 ${session}=session
400 [Documentation] Post body to ${uri}, log response content, and check status
401 ${resp}= RequestsLibrary.Post Request ${session} ${uri} ${body}
403 Should Be Equal As Strings ${resp.status_code} ${status_code}
407 [Arguments] ${testtool} ${testcase}=${EMPTY}
408 [Documentation] Get the name of the suite sanitized to be usable as a part of filename.
409 ... These names are used to constructs names of the log files produced
410 ... by the testing tools so two suites using a tool wont overwrite the
411 ... log files if they happen to run in one job.
412 ${name}= BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","-").replace("/","-").replace(".","-")
413 ${suffix}= BuiltIn.Set_Variable_If '${testcase}' != '' --${testcase} ${EMPTY}
414 [Return] ${testtool}--${name}${suffix}.log
416 Set_User_Configurable_Variable_Default
417 [Arguments] ${name} ${value}
418 [Documentation] Set a default value for an user configurable variable.
419 ... This keyword is needed if your default value is calculated using
420 ... a complex expression which needs BuiltIn.Evaluate or even more
421 ... complex keywords. It sets the variable ${name} (the name of the
422 ... variable MUST be specified WITHOUT the ${} syntactic sugar due
423 ... to limitations of Robot Framework) to ${value} but only if the
424 ... variable ${name} was not set previously. This keyword is intended
425 ... for user configurable variables which are supposed to be set only
426 ... with pybot -v; calling this keyword on a variable that was already
427 ... set by another keyword will silently turn the call into a NOP and
428 ... thus is a bug in the suite or resource trying to call this
430 # TODO: Figure out how to make the ${value} evaluation "lazy" (meaning
431 # evaluating it only when the user did not set anything and thus the
432 # default is needed). This might be needed to avoid potentially costly
433 # keyword invocations when they are not needed. Currently no need for
434 # this was identified, thus leaving it here as a TODO. Based on
435 # comments the best approach would be to create another keyword that
436 # expects a ScalarClosure in the place of ${value} and calls the
437 # closure to get the value but only if the value is needed).
438 # The best idea how to implement this "laziness" would be to have the
439 # used to define another keyword that will be responsible for getting
440 # the default value and then passing the name of this getter keyword
441 # to this keyword. Then this keyword would call the getter (to obtain
442 # the expensive default value) only if it discovers that this value
443 # is really needed (because the variable is not set yet).
444 # TODO: Is the above TODO really necessary? Right now we don't have any
445 # examples of "expensive default values" where to obtain the default
446 # value is so expensive on resources (e.g. need to SSH somewhere to
447 # check something) that we would want to skip the calculation if the
448 # variable for which it is needed has a value already provided by the
449 # user using "pybot -v" or something. One example would be
450 # JAVA_HOME if it would be designed as user-configurable variable
451 # (currently it is not; users can specify "use jdk7" or "use jdk8"
452 # but not "use the jdk over there"; and there actually is no JAVA_HOME
453 # present in the resource, rather the Java invocation command uses the
454 # Java invocation with a full path). The default value of JAVA_HOME
455 # has to be obtained by issuing commands on the SSH connection where
456 # the resulting Java invocation command will be used (to check
457 # multiple candidate paths until one that fits is found) and we could
458 # skip all this checking if a JAVA_HOME was supplied by the user using
460 ${value}= BuiltIn.Get_Variable_Value \${${name}} ${value}
461 BuiltIn.Set_Suite_Variable \${${name}} ${value}
465 [Documentation] Convert a Robot time string to an integer expressing the time in minutes, rounded up
466 ... This is a wrapper around DateTime.Convert_Time which does not
467 ... provide this functionality directly nor is even able to produce
468 ... an integer directly. It is needed for RestPerfClient which
469 ... cannot accept floats for its --timeout parameter and interprets
470 ... the value supplied in this parameter in minutes.
471 ${seconds}= DateTime.Convert_Time ${time} result_format=number
472 ${minutes}= BuiltIn.Evaluate int(math.ceil(${seconds}/60.0)) modules=math
475 Write Commands Until Expected Prompt
476 [Arguments] ${cmd} ${prompt} ${timeout}=30s
477 [Documentation] quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable
478 SSHLibrary.Set Client Configuration timeout=${timeout}
480 SSHLibrary.Write ${cmd}
481 ${output}= SSHLibrary.Read Until ${prompt}
484 Install Package On Ubuntu System
485 [Arguments] ${package_name} ${system}=${TOOLS_SYSTEM_IP} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s
486 [Documentation] Keyword to install packages for testing to Ubuntu Mininet VM
487 Log Keyword to install package to Mininet Ubuntu VM
488 Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
489 SSHKeywords.Flexible Mininet Login user=${user} password=${password}
490 Write sudo apt-get install -y ${package_name}
493 Json Parse From String
494 [Arguments] ${plain_string_with_json}
495 [Documentation] Parse given plain string into json (dictionary)
496 ${json_data} Evaluate json.loads('''${plain_string_with_json}''') json
497 [Return] ${json_data}
500 [Arguments] ${json_file}
501 [Documentation] Parse given file content into json (dictionary)
502 ${json_plain_string} OperatingSystem.Get file ${json_file}
503 ${json_data} Json Parse From String ${json_plain_string}
504 [Return] ${json_data}
506 Modify Iptables On Remote System
507 [Arguments] ${remote_system_ip} ${iptables_rule} ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT}
508 [Documentation] Wrapper keyword to run iptables with any given ${iptables_rule} string on the remote system given
509 ... by ${remote_system_ip}. The iptables listing will be output before and after the command is run
510 ${list_iptables_command} = BuiltIn.Set Variable sudo /sbin/iptables -L -n
511 ${output} = Utils.Run Command On Remote System ${remote_system_ip} ${list_iptables_command} ${user} ${password} prompt=${prompt}
512 BuiltIn.Log ${output}
513 Utils.Run Command On Remote System ${remote_system_ip} sudo /sbin/iptables ${iptables_rule} ${user} ${password} prompt=${prompt}
514 ${output} = Utils.Run Command On Remote System ${remote_system_ip} ${list_iptables_command} ${user} ${password} prompt=${prompt}
515 BuiltIn.Log ${output}