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 ${CURDIR}/UtilLibrary.py
11 Resource ${CURDIR}/SSHKeywords.robot
12 Resource ${CURDIR}/TemplatedRequests.robot
13 Variables ${CURDIR}/../variables/Variables.py
16 # TODO: Introduce ${tree_size} and use instead of 1 in the next line.
17 ${start} sudo mn --controller=remote,ip=${ODL_SYSTEM_IP} --topo tree,1 --switch ovsk,protocols=OpenFlow13
21 [Arguments] ${system}=${TOOLS_SYSTEM_IP} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${timeout}=30s
22 [Documentation] Basic setup/cleanup work that can be done safely before any system
24 Log Start the test on the base edition
26 ${mininet_conn_id}= Open Connection ${system} prompt=${prompt} timeout=${timeout}
27 Set Suite Variable ${mininet_conn_id}
28 Flexible Mininet Login user=${user} password=${password}
29 Execute Command sudo ovs-vsctl set-manager ptcp:6644
34 [Arguments] ${prompt}=${DEFAULT_LINUX_PROMPT}
35 [Documentation] Cleanup/Shutdown work that should be done at the completion of all
37 Log Stop the test on the base edition
38 Switch Connection ${mininet_conn_id}
44 Report_Failure_Due_To_Bug
46 [Documentation] Report that a test failed due to a known Bugzilla bug whose
47 ... number is provided as an argument.
48 ... Not FAILED (incl. SKIPPED) test are not reported.
49 ... This keyword must be used in the [Teardown] setting of the affected test
50 ... or as the first line of the test if FastFail module is not being
51 ... used. It reports the URL of the bug on console and also puts it
52 ... into the Robot log file.
53 ${test_skipped}= BuiltIn.Evaluate len(re.findall('SKIPPED', """${TEST_MESSAGE}""")) > 0 modules=re
54 BuiltIn.Return From Keyword If ('${TEST_STATUS}' != 'FAIL') or ${test_skipped}
55 ${newline}= BuiltIn.Evaluate chr(10)
56 ${msg}= BuiltIn.Set_Variable This test fails due to https://bugs.opendaylight.org/show_bug.cgi?id=${number}
57 BuiltIn.Set Test Message ${msg}${newline}${newline}${TEST_MESSAGE}
60 Report_Failure_And_Point_To_Linked_Bugs
61 [Documentation] Report that a test failed and point to linked Bugzilla bug(s).
62 ... Linked bugs must contain the ${reference} inside comments (workaround
63 ... becasue of currently missing suitable field for external references and
64 ... not correctly working the CONTENT MATCHES filter).
65 ... Not FAILED (incl. SKIPPED) test are not reported.
66 ... This keyword must be used in the [Teardown] setting of the affected test
67 ... or as the first line of the test if FastFail module is not being
68 ... used. It reports the URL of the bug on console and also puts it
69 ... into the Robot log file.
70 ${test_skipped}= BuiltIn.Evaluate len(re.findall('SKIPPED', """${TEST_MESSAGE}""")) > 0 modules=re
71 BuiltIn.Return From Keyword If ('${TEST_STATUS}' != 'FAIL') or ${test_skipped}
72 ${newline}= BuiltIn.Evaluate chr(10)
73 ${reference}= String.Replace_String_Using_Regexp ${SUITE_NAME}_${TEST_NAME} [ /\.-] _
74 ${reference}= String.Convert_To_Lowercase ${reference}
75 ${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)
76 ${bugs}= BuiltIn.Set_Variable "https://bugs.opendaylight.org/buglist.cgi?f1=cf_external_ref&o1=substring&v1=${reference}&order=bug_status"
77 BuiltIn.Set Test Message ${msg}${newline}${bugs}${newline}${newline}${TEST_MESSAGE}
78 BuiltIn.Log ${msg}${newline}${bugs}
81 [Arguments] ${node} ${session}=session
82 [Documentation] A GET on the /node/${node} API is made and specific flow stat
83 ... strings are checked for existence.
84 ${resp} RequestsLibrary.Get Request ${session} ${OPERATIONAL_NODES_API}/node/${node}
85 Should Be Equal As Strings ${resp.status_code} 200
86 Should Contain ${resp.content} flow-capable-node-connector-statistics
87 Should Contain ${resp.content} flow-table-statistics
89 Check For Specific Number Of Elements At URI
90 [Arguments] ${uri} ${element} ${expected_count} ${session}=session
91 [Documentation] A GET is made to the specified ${URI} and the specific count of a
92 ... given element is done (as supplied by ${element} and ${expected_count})
93 ${resp} RequestsLibrary.Get Request ${session} ${uri}
95 Should Be Equal As Strings ${resp.status_code} 200
96 Should Contain X Times ${resp.content} ${element} ${expected_count}
98 Check For Elements At URI
99 [Arguments] ${uri} ${elements} ${session}=session
100 [Documentation] A GET is made at the supplied ${URI} and every item in the list of
101 ... ${elements} is verified to exist in the response
102 ${resp} RequestsLibrary.Get Request ${session} ${uri}
104 Should Be Equal As Strings ${resp.status_code} 200
105 : FOR ${i} IN @{elements}
106 \ Should Contain ${resp.content} ${i}
108 Check For Elements Not At URI
109 [Arguments] ${uri} ${elements} ${session}=session
110 [Documentation] A GET is made at the supplied ${URI} and every item in the list of
111 ... ${elements} is verified to NOT exist in the response
112 ${resp} RequestsLibrary.Get Request ${session} ${uri}
114 Should Be Equal As Strings ${resp.status_code} 200
115 : FOR ${i} IN @{elements}
116 \ Should Not Contain ${resp.content} ${i}
119 [Arguments] ${system}=${TOOLS_SYSTEM_IP}
120 Run Command On Mininet ${system} sudo mn -c
121 Run Command On Mininet ${system} sudo ps -elf | egrep 'usr/local/bin/mn' | egrep python | awk '{print "sudo kill -9",$4}' | sh
124 [Arguments] ${system}=${TOOLS_SYSTEM_IP}
125 [Documentation] Cleans up the OVS instance and remove any existing common known bridges.
126 ${output}= Run Command On Mininet ${system} sudo ovs-vsctl list-br
128 : FOR ${i} IN ${output}
129 \ Run Command On Mininet ${system} sudo ovs-vsctl --if-exists del-br ${i}
130 Run Command On Mininet ${system} sudo ovs-vsctl del-manager
132 Extract Value From Content
133 [Arguments] ${content} ${index} ${strip}=nostrip
134 [Documentation] Will take the given response content and return the value at the given index as a string
135 ${value}= Get Json Value ${content} ${index}
136 ${value}= Convert To String ${value}
137 ${value}= Run Keyword If '${strip}' == 'strip' Strip Quotes ${value}
140 Get Process ID Based On Regex On Remote System
141 [Arguments] ${system} ${regex_string_to_match_on} ${user}=${TOOLS_SYSTEM_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s
142 [Documentation] Uses ps to find a process that matches the supplied regex. Returns the PID of that process
143 ... The ${regex_string_to_match_on} should produce a unique process otherwise the PID returned may not be
145 # doing the extra -v grep in this command to exclude the grep process itself from the output
146 ${cmd}= Set Variable ps -elf | grep -v grep | grep ${regex_string_to_match_on} | awk '{print $4}'
147 ${output}= Run Command On Remote System ${system} ${cmd} user=${user} password=${password} prompt=${prompt}
148 ... prompt_timeout=${prompt_timeout}
149 # ${output} contains the system prompt and all we want is the value of the number
150 ${pid}= Fetch From Left ${output} \r
151 # TODO: Get Process * keywords have perhaps non-standard default credentials.
152 # ... Should there be * On Mininet and * On Controller specializations?
155 Get Process Thread Count On Remote System
156 [Arguments] ${system} ${pid} ${user}=${TOOLS_SYSTEM_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s
157 [Documentation] Executes the ps command to retrieve the lightweight process (aka thread) count.
158 ${cmd}= Set Variable ps --no-headers -o nlwp ${pid}
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 ${thread_count}= Fetch From Left ${output} \r
163 [Return] ${thread_count}
166 [Arguments] ${string_to_strip}
167 [Documentation] Will strip ALL quotes from given string and return the new string
168 ${string_to_return}= Replace String ${string_to_strip} " \ count=-1
169 [Return] ${string_to_return}
172 [Arguments] ${user} ${password}=${EMPTY} ${delay}=0.5s
173 [Documentation] On active SSH session: if given non-empty password, do Login, else do Login With Public Key.
174 ${pwd_length} = BuiltIn.Get Length ${password}
175 # ${pwd_length} is guaranteed to be an integer, so we are safe to evaluate it as Python expression.
176 BuiltIn.Run Keyword And Return If ${pwd_length} > 0 SSHLibrary.Login ${user} ${password} delay=${delay}
177 BuiltIn.Run Keyword And Return SSHLibrary.Login With Public Key ${user} ${USER_HOME}/.ssh/${SSH_KEY} ${KEYFILE_PASS} delay=${delay}
179 Flexible Mininet Login
180 [Arguments] ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${delay}=0.5s
181 [Documentation] Call Flexible SSH Login, but with default values suitable for Mininet machine.
182 BuiltIn.Run Keyword And Return Flexible SSH Login user=${user} password=${password} delay=${delay}
184 Flexible Controller Login
185 [Arguments] ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${delay}=0.5s
186 [Documentation] Call Flexible SSH Login, but with default values suitable for Controller machine.
187 BuiltIn.Run Keyword And Return Flexible SSH Login user=${user} password=${password} delay=${delay}
189 Run Command On Remote System
190 [Arguments] ${system} ${cmd} ${user}=${DEFAULT_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=${DEFAULT_TIMEOUT}
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
193 ... and the output returned. No test conditions are checked.
194 ${current_ssh_connection}= SSHLibrary.Get Connection
195 BuiltIn.Log Attempting to execute command "${cmd}" on remote system "${system}" by user "${user}" with keyfile pass "${keyfile_pass}" and prompt "${prompt}"
196 BuiltIn.Log ${password}
197 ${conn_id}= SSHLibrary.Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
198 Flexible SSH Login ${user} ${password}
199 ${stdout} ${stderr} SSHLibrary.Execute Command ${cmd} return_stderr=True
200 SSHLibrary.Close Connection
202 [Teardown] SSHKeywords.Restore_Current_SSH_Connection_From_Index ${current_ssh_connection.index}
206 [Documentation] Construct ctrl+c character and SSH-write it (without endline) to the current SSH connection.
207 ... Do not read anything yet.
208 BuiltIn.Comment Use RemoteBash.Write_Bare_Ctrl_C instead.
209 ${ctrl_c}= BuiltIn.Evaluate chr(int(3))
210 SSHLibrary.Write_Bare ${ctrl_c}
213 [Documentation] Construct ctrl+d character and SSH-write it (without endline) to the current SSH connection.
214 ... Do not read anything yet.
215 BuiltIn.Comment Use RemoteBash.Write_Bare_Ctrl_D instead.
216 ${ctrl_d}= BuiltIn.Evaluate chr(int(4))
217 SSHLibrary.Write Bare ${ctrl_d}
219 Run Command On Mininet
220 [Arguments] ${system}=${TOOLS_SYSTEM_IP} ${cmd}=echo ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${TOOLS_SYSTEM_PROMPT}
221 [Documentation] Call Run Comand On Remote System, but with default values suitable for Mininet machine.
222 BuiltIn.Run Keyword And Return Run Command On Remote System ${system} ${cmd} ${user} ${password} prompt=${prompt}
224 Run Command On Controller
225 [Arguments] ${system}=${ODL_SYSTEM_IP} ${cmd}=echo ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT}
226 [Documentation] Call Run Comand On Remote System, but with default values suitable for Controller machine.
227 BuiltIn.Log ${password}
228 BuiltIn.Run Keyword And Return Run Command On Remote System ${system} ${cmd} ${user} ${password} prompt=${prompt}
230 Verify File Exists On Remote System
231 [Arguments] ${system} ${file} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=5s
232 [Documentation] Will create connection with public key and will PASS if the given ${file} exists,
233 ... otherwise will FAIL
234 ${conn_id}= Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
235 Flexible SSH Login ${user} ${password}
236 SSHLibrary.File Should Exist ${file}
239 Copy File To Remote System
240 [Arguments] ${system} ${source} ${destination} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT}
241 ... ${prompt_timeout}=5s
242 [Documentation] Simplifies copy file operations to remote system
243 ${conn_id}= Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
244 Flexible SSH Login ${user} ${password}
245 SSHLibrary.Put File ${source} ${destination}
248 Check Karaf Log File Does Not Have Messages
249 [Arguments] ${ip} ${message} ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT} ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log
250 [Documentation] Fails if the provided ${message} is found in the karaf.log file. Uses grep to search. The
251 ... karaf.log file can be overridden with ${log_file} to be any file on the given system @ ${ip}
252 ${output}= Run Command On Controller ${ip} grep -c '${message}' ${log_file} user=${user} password=${password} prompt=${prompt}
253 Should Be Equal As Strings ${output} 0
255 Verify Controller Is Not Dead
256 [Arguments] ${controller_ip}=${ODL_SYSTEM_IP}
257 [Documentation] Will execute any tests to verify the controller is not dead. Some checks are
258 ... Out Of Memory Execptions.
259 Check Karaf Log File Does Not Have Messages ${controller_ip} java.lang.OutOfMemoryError
260 # TODO: Should Verify Controller * keywords also accept user, password, prompt and karaf_log arguments?
262 Verify Controller Has No Null Pointer Exceptions
263 [Arguments] ${controller_ip}=${ODL_SYSTEM_IP}
264 [Documentation] Will execute any tests to verify the controller is not having any null pointer eceptions.
265 Check Karaf Log File Does Not Have Messages ${controller_ip} java.lang.NullPointerException
269 [Documentation] Get the Epoc time from MM/DD/YYYY HH:MM:SS
270 ${epoch_time}= Convert Date ${time} epoch exclude_milles=True date_format=%m/%d/%Y %H:%M:%S
271 ${epoch_time}= Convert To Integer ${epoch_time}
272 [Return] ${epoch_time}
274 Remove Space on String
275 [Arguments] ${str} ${count}=-1
276 [Documentation] Remove the empty space from given string.count is optional,if its given
277 ... that many occurence of space will be removed from left
278 ${x}= Convert To String ${str}
279 ${x}= Replace String ${str} ${SPACE} ${EMPTY} count=${count}
282 Split Value from String
283 [Arguments] ${str} ${splitter}
284 [Documentation] Split the String based on given splitter and return as list
285 @{x}= Split String ${str} ${splitter}
288 Concatenate the String
289 [Arguments] ${str1} ${str2}
290 [Documentation] Catenate the two non-string objects and return as String
291 ${str1}= Convert to String ${str1}
292 ${str2}= Convert to String ${str2}
293 ${output}= Catenate ${str1} ${str2}
297 [Arguments] ${rest_uri} ${data} ${headers}=${headers} ${session}=session
298 [Documentation] Perform a POST rest operation, using the URL and data provided
299 ${resp} = RequestsLibrary.Post Request ${session} ${rest_uri} data=${data} headers=${headers}
301 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
303 Remove All Elements At URI
304 [Arguments] ${uri} ${session}=session
305 ${resp} RequestsLibrary.Delete Request ${session} ${uri}
306 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
308 Remove All Elements At URI And Verify
309 [Arguments] ${uri} ${session}=session
310 ${resp} RequestsLibrary.Delete Request ${session} ${uri}
311 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
312 ${resp} RequestsLibrary.Get Request ${session} ${uri}
313 Should Be Equal As Strings ${resp.status_code} 404
315 Remove All Elements If Exist
316 [Arguments] ${uri} ${session}=session
317 [Documentation] Delete all elements from an URI if the configuration was not empty
318 ${resp} RequestsLibrary.Get Request ${session} ${uri}
319 Run Keyword If '${resp.status_code}'!='404' Remove All Elements At URI ${uri} ${session}
321 Add Elements To URI From File
322 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
323 ${body} OperatingSystem.Get File ${data_file}
324 ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} data=${body} headers=${headers}
325 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
327 Add Elements To URI From File And Verify
328 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
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}
332 ${resp} RequestsLibrary.Get Request ${session} ${dest_uri}
333 Should Not Be Equal ${resp.status_code} 404
335 Add Elements To URI And Verify
336 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
337 ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} ${data_file} headers=${headers}
338 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
339 ${resp} RequestsLibrary.Get Request ${session} ${dest_uri}
340 Should Not Be Equal ${resp.status_code} 404
342 Add Elements To URI From File And Check Validation Error
343 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
344 ${body} OperatingSystem.Get File ${data_file}
345 ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} data=${body} headers=${headers}
346 Should Contain ${DATA_VALIDATION_ERROR} ${resp.status_code}
348 Post Elements To URI From File
349 [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
350 ${body} OperatingSystem.Get File ${data_file}
351 ${resp} RequestsLibrary.Post Request ${session} ${dest_uri} data=${body} headers=${headers}
352 Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
354 Run Process With Logging And Status Check
355 [Arguments] @{proc_args}
356 [Documentation] Execute an OS command, log STDOUT and STDERR output and check exit code to be 0
357 ${result}= Run Process @{proc_args}
360 Should Be Equal As Integers ${result.rc} 0
364 [Arguments] ${session} ${uri} ${headers}=${NONE}
365 [Documentation] Issue a GET request and return the data obtained or on error log the error and fail.
366 ... Issues a GET request for ${uri} in ${session} using headers from
367 ... ${headers}. If the request returns a HTTP error, fails. Otherwise
368 ... returns the data obtained by the request.
369 ${response}= RequestsLibrary.Get Request ${session} ${uri} ${headers}
370 Builtin.Return_From_Keyword_If ${response.status_code} == 200 ${response.text}
371 Builtin.Log ${response.text}
372 Builtin.Fail The request failed with code ${response.status_code}
375 [Arguments] ${session} ${uri} ${headers}=${NONE}
376 [Documentation] Issue a GET request and return on error 404 (No content) or will fail and log the content.
377 ... Issues a GET request for ${uri} in ${session} using headers from
378 ... ${headers}. If the request returns a HTTP error, fails. Otherwise
379 ... returns the data obtained by the request.
380 ${response}= RequestsLibrary.Get Request ${session} ${uri} ${headers}
381 Builtin.Return_From_Keyword_If ${response.status_code} == 404
382 Builtin.Log ${response.text}
383 Builtin.Fail The request failed with code ${response.status_code}
385 Get Index From List Of Dictionaries
386 [Arguments] ${dictionary_list} ${key} ${value}
387 [Documentation] Extract index for the dictionary in a list that contains a key-value pair. Returns -1 if key-value is not found.
388 ${length}= Get Length ${dictionary_list}
389 ${index}= Set Variable -1
390 : FOR ${i} IN RANGE ${length}
391 \ ${dictionary}= Get From List ${dictionary_list} ${i}
392 \ Run Keyword If """&{dictionary}[${key}]""" == """${value}""" Set Test Variable ${index} ${i}
395 Check Item Occurrence
396 [Arguments] ${string} ${dictionary_item_occurrence}
397 [Documentation] Check string for occurrences of items expressed in a list of dictionaries {item=occurrences}. 0 occurences means item is not present.
398 : FOR ${item} IN @{dictionary_item_occurrence}
399 \ Should Contain X Times ${string} ${item} &{dictionary_item_occurrence}[${item}]
402 [Arguments] ${uri} ${body} ${status_code}=200 ${session}=session
403 [Documentation] Post body to ${uri}, log response content, and check status
404 ${resp}= RequestsLibrary.Post Request ${session} ${uri} ${body}
406 Should Be Equal As Strings ${resp.status_code} ${status_code}
410 [Arguments] ${testtool} ${testcase}=${EMPTY}
411 [Documentation] Get the name of the suite sanitized to be usable as a part of filename.
412 ... These names are used to constructs names of the log files produced
413 ... by the testing tools so two suites using a tool wont overwrite the
414 ... log files if they happen to run in one job.
415 ${name}= BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","-").replace("/","-").replace(".","-")
416 ${suffix}= BuiltIn.Set_Variable_If '${testcase}' != '' --${testcase} ${EMPTY}
417 [Return] ${testtool}--${name}${suffix}.log
419 Set_User_Configurable_Variable_Default
420 [Arguments] ${name} ${value}
421 [Documentation] Set a default value for an user configurable variable.
422 ... This keyword is needed if your default value is calculated using
423 ... a complex expression which needs BuiltIn.Evaluate or even more
424 ... complex keywords. It sets the variable ${name} (the name of the
425 ... variable MUST be specified WITHOUT the ${} syntactic sugar due
426 ... to limitations of Robot Framework) to ${value} but only if the
427 ... variable ${name} was not set previously. This keyword is intended
428 ... for user configurable variables which are supposed to be set only
429 ... with pybot -v; calling this keyword on a variable that was already
430 ... set by another keyword will silently turn the call into a NOP and
431 ... thus is a bug in the suite or resource trying to call this
433 # TODO: Figure out how to make the ${value} evaluation "lazy" (meaning
434 # evaluating it only when the user did not set anything and thus the
435 # default is needed). This might be needed to avoid potentially costly
436 # keyword invocations when they are not needed. Currently no need for
437 # this was identified, thus leaving it here as a TODO. Based on
438 # comments the best approach would be to create another keyword that
439 # expects a ScalarClosure in the place of ${value} and calls the
440 # closure to get the value but only if the value is needed).
441 # The best idea how to implement this "laziness" would be to have the
442 # used to define another keyword that will be responsible for getting
443 # the default value and then passing the name of this getter keyword
444 # to this keyword. Then this keyword would call the getter (to obtain
445 # the expensive default value) only if it discovers that this value
446 # is really needed (because the variable is not set yet).
447 # TODO: Is the above TODO really necessary? Right now we don't have any
448 # examples of "expensive default values" where to obtain the default
449 # value is so expensive on resources (e.g. need to SSH somewhere to
450 # check something) that we would want to skip the calculation if the
451 # variable for which it is needed has a value already provided by the
452 # user using "pybot -v" or something. One example would be
453 # JAVA_HOME if it would be designed as user-configurable variable
454 # (currently it is not; users can specify "use jdk7" or "use jdk8"
455 # but not "use the jdk over there"; and there actually is no JAVA_HOME
456 # present in the resource, rather the Java invocation command uses the
457 # Java invocation with a full path). The default value of JAVA_HOME
458 # has to be obtained by issuing commands on the SSH connection where
459 # the resulting Java invocation command will be used (to check
460 # multiple candidate paths until one that fits is found) and we could
461 # skip all this checking if a JAVA_HOME was supplied by the user using
463 ${value}= BuiltIn.Get_Variable_Value \${${name}} ${value}
464 BuiltIn.Set_Suite_Variable \${${name}} ${value}
468 [Documentation] Convert a Robot time string to an integer expressing the time in minutes, rounded up
469 ... This is a wrapper around DateTime.Convert_Time which does not
470 ... provide this functionality directly nor is even able to produce
471 ... an integer directly. It is needed for RestPerfClient which
472 ... cannot accept floats for its --timeout parameter and interprets
473 ... the value supplied in this parameter in minutes.
474 ${seconds}= DateTime.Convert_Time ${time} result_format=number
475 ${minutes}= BuiltIn.Evaluate int(math.ceil(${seconds}/60.0)) modules=math
478 Write Commands Until Expected Prompt
479 [Arguments] ${cmd} ${prompt} ${timeout}=30s
480 [Documentation] quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable
481 SSHLibrary.Set Client Configuration timeout=${timeout}
483 SSHLibrary.Write ${cmd}
484 ${output}= SSHLibrary.Read Until ${prompt}
487 Install Package On Ubuntu System
488 [Arguments] ${package_name} ${system}=${TOOLS_SYSTEM_IP} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s
489 [Documentation] Keyword to install packages for testing to Ubuntu Mininet VM
490 Log Keyword to install package to Mininet Ubuntu VM
491 Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
492 Flexible Mininet Login user=${user} password=${password}
493 Write sudo apt-get install -y ${package_name}