+Get Match
+ [Arguments] ${text} ${regexp} ${index}=0
+ [Documentation] Wrapper around Get Regexp Matches to return None if not found or the first match if found.
+ @{matches} = String.Get Regexp Matches ${text} ${regexp}
+ ${matches_length} = Get Length ${matches}
+ BuiltIn.Set Test Variable ${match} None
+ BuiltIn.Run Keyword If ${matches_length} > ${index} BuiltIn.Set Test Variable ${match} @{matches}[${index}]
+ [Return] ${match}
+
+Get VM IP
+ [Arguments] ${fail_on_none} ${vm}
+ [Documentation] Get the vm ip address and nameserver by scraping the vm's console log.
+ ... Get VM IP returns three values: [0] the vm IP, [1] the DHCP IP and [2] the vm console log.
+ ${rc} ${vm_console_output}= Run And Return Rc And Output openstack console log show ${vm}
+ ${vm_ip} = Set Variable None
+ ${dhcp_ip} = Set Variable None
+ ${match} = Get Match ${vm_console_output} ${REGEX_OBTAINED}
+ ${vm_ip} = Get Match ${match} ${REGEX_IPV4} 0
+ ${match} = Get Match ${vm_console_output} ${REGEX_IPROUTE}
+ ${dhcp_ip} = Get Match ${match} ${REGEX_IPV4} 1
+ BuiltIn.Run Keyword If '${fail_on_none}' == 'true' Should Not Contain ${vm_ip} None
+ BuiltIn.Run Keyword If '${fail_on_none}' == 'true' Should Not Contain ${dhcp_ip} None
+ [Return] ${vm_ip} ${dhcp_ip} ${vm_console_output}
+
+Get VM IPs
+ [Arguments] @{vms}
+ [Documentation] Get the instance IP addresses and nameserver address for the list of given vms.
+ ... First poll for the vm instance to be in the active state, then poll for the vm ip address and nameserver.
+ ... Get VM IPs returns two things: [0] a list of the ips for the vms passed to this keyword (may contain values
+ ... of None) and [1] the dhcp ip address found in the last vm checked.
+ ... TODO: there is a potential issue for a caller that passes in VMs belonging to different networks that
+ ... may have different dhcp server addresses. Not sure what TODO about that, but noting it here for reference.
+ @{vm_ips} BuiltIn.Create List @{EMPTY}
+ : FOR ${vm} IN @{vms}
+ \ Poll VM Is ACTIVE ${vm}
+ \ ${status} ${ips_and_console_log} Run Keyword And Ignore Error Wait Until Keyword Succeeds 120s 15s
+ \ ... Get VM IP true ${vm}
+ \ # If there is trouble with Get VM IP, the status will be FAIL and the return value will be a string of what went
+ \ # wrong. We need to handle both the PASS and FAIL cases. In the FAIL case we know we wont have access to the
+ \ # console log, as it would not be returned; so we need to grab it again to log it. We also can append 'None' to
+ \ # the vm ip list if status is FAIL.
+ \ Run Keyword If "${status}" == "PASS" BuiltIn.Log ${ips_and_console_log[2]}
+ \ BuiltIn.Run Keyword If "${status}" == "PASS" Collections.Append To List ${vm_ips} ${ips_and_console_log[0]}
+ \ BuiltIn.Run Keyword If "${status}" == "FAIL" Collections.Append To List ${vm_ips} None
+ \ ${rc} ${vm_console_output}= BuiltIn.Run Keyword If "${status}" == "FAIL" Run And Return Rc And Output openstack console log show ${vm}
+ \ BuiltIn.Run Keyword If "${status}" == "FAIL" BuiltIn.Log ${vm_console_output}
+ [Return] @{vm_ips} ${ips_and_console_log[1]}
+
+Collect VM IPv6 SLAAC Addresses
+ [Arguments] ${fail_on_none} ${prefix} @{vm_list}
+ [Documentation] Using the console-log on the provided ${vm_list} to search for the string "inet6" which
+ ... correlates to the instance generated IPv6 address, based on the ${prefix} received from ODL (SLAAC mode).
+ ${ip_list} Create List @{EMPTY}
+ : FOR ${vm} IN @{vm_list}
+ \ Log ${vm}
+ \ ${rc} ${vm_ip_line}= Run And Return Rc And Output openstack console log show ${vm} | grep -i "inet6"
+ \ Log ${vm_ip_line}
+ \ Log ${rc}
+ \ @{vm_ip_list} Get Regexp Matches ${vm_ip_line} ${prefix}
+ \ ${vm_ip_length} Get Length ${vm_ip_list}
+ \ Run Keyword If ${vm_ip_length}>0 Append To List ${ip_list} @{vm_ip_list}[0]
+ \ ... ELSE Append To List ${ip_list} None
+ \ Log ${ip_list}
+ Run Keyword If '${fail_on_none}' == 'true' Should Not Contain ${ip_list} None
+ Log ${ip_list}
+ [Return] ${ip_list}
+