def run_rv_connect(test, params, env):
"""
Simple test for Remote Desktop connection
Tests expectes that Remote Desktop client (spice/vnc) will be executed
from within a second guest so we won't be limited to Linux only clients
The plan is to support remote-viewer at first place
:param test: QEMU test object. :param params: Dictionary with the test parameters.
:param env: Dictionary with test environment.
"""
guest_vm = env.get_vm(params["guest_vm"])
guest_vm.verify_alive()
guest_session = guest_vm.wait_for_login(
timeout=int(params.get("login_timeout", 360)))
client_vm = env.get_vm(params["client_vm"])
client_vm.verify_alive()
client_session = client_vm.wait_for_login(
timeout=int(params.get("login_timeout", 360)))
if params.get("clear_interface", "yes") == "yes":
isRHEL7 = False
for vm in params.get("vms").split():
utils_spice.clear_interface(env.get_vm(vm),
int(params.get("login_timeout", "360")))
if env.get_vm(vm).params.get("os_type") == "linux":
session = env.get_vm(vm).wait_for_login(timeout=360)
output = session.cmd('cat /etc/redhat-release')
isRHEL7 = ("release 7." in output) or isRHEL7
if isRHEL7:
utils_spice.wait_timeout(60)
else:
utils_spice.wait_timeout(15)
launch_rv(client_vm, guest_vm, params)
client_session.close()
guest_session.close()
def run_rv_connect(test, params, env):
"""
Simple test for Remote Desktop connection
Tests expectes that Remote Desktop client (spice/vnc) will be executed
from within a second guest so we won't be limited to Linux only clients
The plan is to support remote-viewer at first place
:param test: QEMU test object. :param params: Dictionary with the test parameters.
:param env: Dictionary with test environment.
"""
guest_vm = env.get_vm(params["guest_vm"])
guest_vm.verify_alive()
guest_session = guest_vm.wait_for_login(
timeout=int(params.get("login_timeout", 360)))
client_vm = env.get_vm(params["client_vm"])
client_vm.verify_alive()
client_session = client_vm.wait_for_login(
timeout=int(params.get("login_timeout", 360)))
if params.get("clear_interface", "yes") == "yes":
isRHEL7 = False
for vm in params.get("vms").split():
utils_spice.clear_interface(
env.get_vm(vm), int(params.get("login_timeout", "360")))
if env.get_vm(vm).params.get("os_type") == "linux":
session = env.get_vm(vm).wait_for_login(timeout=360)
output = session.cmd('cat /etc/redhat-release')
isRHEL7 = ("release 7." in output) or isRHEL7
if isRHEL7:
utils_spice.wait_timeout(60)
else:
utils_spice.wait_timeout(15)
launch_rv(client_vm, guest_vm, params)
client_session.close()
guest_session.close()
def launch_rv(client_vm, guest_vm, params):
"""
Launches rv_binary with args based on spice configuration
inside client_session on background.
remote-viewer will try to connect from vm1 from vm2
:param client_vm - vm object
:param guest_vm - vm object
:param params
"""
rv_binary = params.get("rv_binary", "remote-viewer")
rv_ld_library_path = params.get("rv_ld_library_path")
display = params.get("display")
proxy = params.get("spice_proxy", None)
host_ip = utils_net.get_host_ip_address(params)
host_port = None
if guest_vm.get_spice_var("listening_addr") == "ipv6":
host_ip = ("[" + utils_misc.convert_ipv4_to_ipv6(host_ip) +
"]")
host_tls_port = None
disable_audio = params.get("disable_audio", "no")
full_screen = params.get("full_screen")
check_spice_info = params.get("spice_info")
ssltype = params.get("ssltype", "")
test_type = params.get("test_type")
# cmd var keeps final remote-viewer command line
# to be executed on client
cmd = rv_binary
if client_vm.params.get("os_type") != "windows":
cmd = cmd + " --display=:0.0"
# If qemu_ticket is set, set the password
# of the VM using the qemu-monitor
ticket = None
ticket_send = params.get("spice_password_send")
qemu_ticket = params.get("qemu_password")
if qemu_ticket:
guest_vm.monitor.cmd("set_password spice %s" % qemu_ticket)
logging.info("Sending to qemu monitor: set_password spice %s"
% qemu_ticket)
gencerts = params.get("gencerts")
certdb = params.get("certdb")
smartcard = params.get("smartcard")
host_subj = None
cacert_host = None
cacert_client = None
rv_parameters_from = params.get("rv_parameters_from", "cmd")
if rv_parameters_from == 'file':
cmd += " " + params.get("rv_file")
client_session = client_vm.wait_for_login(
timeout=int(params.get("login_timeout", 360)))
if display == "spice":
ticket = guest_vm.get_spice_var("spice_password")
if guest_vm.get_spice_var("spice_ssl") == "yes":
#client needs cacert file
cacert_host = "%s/%s" % (params.get("spice_x509_prefix"),
params.get("spice_x509_cacert_file"))
cacert_client = cacert_host
if client_vm.params.get("os_type") == "linux":
client_session.cmd("rm -rf %s && mkdir -p %s" % (
params.get("spice_x509_prefix"),
params.get("spice_x509_prefix")))
if client_vm.params.get("os_type") == "windows":
cacert_client = "C:\\%s" % params.get("spice_x509_cacert_file")
client_vm.copy_files_to(cacert_host, cacert_client)
host_tls_port = guest_vm.get_spice_var("spice_tls_port")
host_port = guest_vm.get_spice_var("spice_port")
#cacert subj is in format for create certificate(with '/' delimiter)
#remote-viewer needs ',' delimiter. And also is needed to remove
#first character (it's '/')
host_subj = guest_vm.get_spice_var("spice_x509_server_subj")
host_subj = host_subj.replace('/', ',')[1:]
if ssltype == "invalid_explicit_hs":
host_subj = "Invalid Explicit HS"
else:
host_subj += host_ip
# If it's invalid implicit, a remote-viewer connection
# will be attempted with the hostname, since ssl certs were
# generated with the ip address
hostname = socket.gethostname()
escape_char = client_vm.params.get("shell_escape_char",'\\')
if ssltype == "invalid_implicit_hs" or "explicit" in ssltype:
spice_url = " spice://%s?tls-port=%s%s&port=%s" % (hostname,
host_tls_port,
escape_char,
host_port)
else:
spice_url = " spice://%s?tls-port=%s%s&port=%s" % (host_ip,
host_tls_port,
escape_char,
host_port)
if rv_parameters_from == "menu":
line = spice_url
elif rv_parameters_from == "file":
pass
else:
cmd += spice_url
if not rv_parameters_from == "file":
cmd += " --spice-ca-file=%s" % cacert_client
if ( params.get("spice_client_host_subject") == "yes" and not
rv_parameters_from == "file" ):
cmd += " --spice-host-subject=\"%s\"" % host_subj
else:
host_port = guest_vm.get_spice_var("spice_port")
if rv_parameters_from == "menu":
#line to be sent through monitor once r-v is started
#without spice url
line = "spice://%s?port=%s" % (host_ip, host_port)
elif rv_parameters_from == "file":
pass
else:
cmd += " spice://%s?port=%s" % (host_ip, host_port)
elif display == "vnc":
raise NotImplementedError("remote-viewer vnc")
else:
raise Exception("Unsupported display value")
#usbredirection support
if params.get("usb_redirection_add_device_vm2") == "yes":
logging.info("USB redirection set auto redirect on connect for device \
class 0x08")
cmd += " --spice-usbredir-redirect-on-connect=\"0x08,-1,-1,-1,1\""
client_root_session = client_vm.wait_for_login(
timeout=int(params.get("login_timeout", 360)),
username="******", password="******")
usb_mount_path = params.get("file_path")
#USB was created by qemu (root). This prevents right issue.
client_root_session.cmd("chown test:test %s" % usb_mount_path)
if not check_usb_policy(client_vm, params):
logging.info("No USB policy.")
add_usb_policy(client_vm)
utils_spice.wait_timeout(3)
else:
logging.info("USB policy OK")
else:
logging.info("No USB redirection")
# Check to see if the test is using the full screen option.
if full_screen == "yes" and not rv_parameters_from == "file" :
logging.info("Remote Viewer Set to use Full Screen")
cmd += " --full-screen"
if disable_audio == "yes":
logging.info("Remote Viewer Set to disable audio")
cmd += " --spice-disable-audio"
# Check to see if the test is using a smartcard.
if smartcard == "yes":
logging.info("remote viewer Set to use a smartcard")
if not rv_parameters_from == file:
cmd += " --spice-smartcard"
if certdb is not None:
logging.debug("Remote Viewer set to use the following certificate"
" database: " + certdb)
cmd += " --spice-smartcard-db " + certdb
if gencerts is not None:
logging.debug("Remote Viewer set to use the following certs: " +
gencerts)
cmd += " --spice-smartcard-certificates " + gencerts
if client_vm.params.get("os_type") == "linux":
cmd = "nohup " + cmd + " &> ~/rv.log &" # Launch it on background
if rv_ld_library_path:
cmd = "export LD_LIBRARY_PATH=" + rv_ld_library_path + ";" + cmd
if rv_parameters_from == "file":
print "Generating file"
utils_spice.gen_rv_file(params, guest_vm, host_subj, cacert_host)
print "Uploading file to client"
client_vm.copy_files_to("rv_file.vv", params.get("rv_file"))
# Launching the actual set of commands
try:
if rv_ld_library_path:
print_rv_version(client_session, "LD_LIBRARY_PATH=/usr/local/lib " +
rv_binary)
else:
print_rv_version(client_session, rv_binary)
except ShellStatusError, ShellProcessTerminatedError:
# Sometimes It fails with Status error, ingore it and continue.
# It's not that important to have printed versions in the log.
logging.debug("Ignoring a Status Exception that occurs from calling "
"print versions of remote-viewer or spice-gtk")
if client_vm.params.get("os_type") == "linux":
client_session.cmd("export SPICE_PROXY=%s" % proxy)
elif client_vm.params.get("os_type") == "windows":
client_session.cmd_output("SET SPICE_PROXY=%s" % proxy)
if not params.get("rv_verify") == "only":
try:
logging.info("spice,connection: %s", client_session.cmd(cmd))
except ShellStatusError:
logging.debug("Ignoring a status exception, will check connection"
"of remote-viewer later")
#Send command line through monitor since url was not provided
if rv_parameters_from == "menu":
utils_spice.wait_timeout(1)
str_input(client_vm, line)
# client waits for user entry (authentication) if spice_password is set
# use qemu monitor password if set, else, if set, try normal password.
if qemu_ticket:
# Wait for remote-viewer to launch
utils_spice.wait_timeout(5)
str_input(client_vm, qemu_ticket)
elif ticket:
if ticket_send:
ticket = ticket_send
utils_spice.wait_timeout(5) # Wait for remote-viewer to launch
str_input(client_vm, ticket)
def launch_rv(client_vm, guest_vm, params):
"""
Launches rv_binary with args based on spice configuration
inside client_session on background.
remote-viewer will try to connect from vm1 from vm2
:param client_vm - vm object
:param guest_vm - vm object
:param params
"""
rv_binary = params.get("rv_binary", "remote-viewer")
rv_ld_library_path = params.get("rv_ld_library_path")
display = params.get("display")
proxy = params.get("spice_proxy", None)
host_ip = utils_net.get_host_ip_address(params)
host_port = None
if guest_vm.get_spice_var("listening_addr") == "ipv6":
host_ip = ("[" + utils_misc.convert_ipv4_to_ipv6(host_ip) + "]")
host_tls_port = None
disable_audio = params.get("disable_audio", "no")
full_screen = params.get("full_screen")
check_spice_info = params.get("spice_info")
ssltype = params.get("ssltype", "")
test_type = params.get("test_type")
# cmd var keeps final remote-viewer command line
# to be executed on client
cmd = rv_binary
if client_vm.params.get("os_type") != "windows":
cmd = cmd + " --display=:0.0"
# If qemu_ticket is set, set the password
# of the VM using the qemu-monitor
ticket = None
ticket_send = params.get("spice_password_send")
qemu_ticket = params.get("qemu_password")
if qemu_ticket:
guest_vm.monitor.cmd("set_password spice %s" % qemu_ticket)
logging.info("Sending to qemu monitor: set_password spice %s" %
qemu_ticket)
gencerts = params.get("gencerts")
certdb = params.get("certdb")
smartcard = params.get("smartcard")
host_subj = None
cacert_host = None
cacert_client = None
rv_parameters_from = params.get("rv_parameters_from", "cmd")
if rv_parameters_from == 'file':
cmd += " " + params.get("rv_file")
client_session = client_vm.wait_for_login(
timeout=int(params.get("login_timeout", 360)))
if display == "spice":
ticket = guest_vm.get_spice_var("spice_password")
if guest_vm.get_spice_var("spice_ssl") == "yes":
#client needs cacert file
cacert_host = "%s/%s" % (params.get("spice_x509_prefix"),
params.get("spice_x509_cacert_file"))
cacert_client = cacert_host
if client_vm.params.get("os_type") == "linux":
client_session.cmd("rm -rf %s && mkdir -p %s" %
(params.get("spice_x509_prefix"),
params.get("spice_x509_prefix")))
if client_vm.params.get("os_type") == "windows":
cacert_client = "C:\\%s" % params.get("spice_x509_cacert_file")
client_vm.copy_files_to(cacert_host, cacert_client)
host_tls_port = guest_vm.get_spice_var("spice_tls_port")
host_port = guest_vm.get_spice_var("spice_port")
#cacert subj is in format for create certificate(with '/' delimiter)
#remote-viewer needs ',' delimiter. And also is needed to remove
#first character (it's '/')
host_subj = guest_vm.get_spice_var("spice_x509_server_subj")
host_subj = host_subj.replace('/', ',')[1:]
if ssltype == "invalid_explicit_hs":
host_subj = "Invalid Explicit HS"
else:
host_subj += host_ip
# If it's invalid implicit, a remote-viewer connection
# will be attempted with the hostname, since ssl certs were
# generated with the ip address
hostname = socket.gethostname()
escape_char = client_vm.params.get("shell_escape_char", '\\')
if ssltype == "invalid_implicit_hs" or "explicit" in ssltype:
spice_url = " spice://%s?tls-port=%s%s&port=%s" % (
hostname, host_tls_port, escape_char, host_port)
else:
spice_url = " spice://%s?tls-port=%s%s&port=%s" % (
host_ip, host_tls_port, escape_char, host_port)
if rv_parameters_from == "menu":
line = spice_url
elif rv_parameters_from == "file":
pass
else:
cmd += spice_url
if not rv_parameters_from == "file":
cmd += " --spice-ca-file=%s" % cacert_client
if (params.get("spice_client_host_subject") == "yes"
and not rv_parameters_from == "file"):
cmd += " --spice-host-subject=\"%s\"" % host_subj
else:
host_port = guest_vm.get_spice_var("spice_port")
if rv_parameters_from == "menu":
#line to be sent through monitor once r-v is started
#without spice url
line = "spice://%s?port=%s" % (host_ip, host_port)
elif rv_parameters_from == "file":
pass
else:
cmd += " spice://%s?port=%s" % (host_ip, host_port)
elif display == "vnc":
raise NotImplementedError("remote-viewer vnc")
else:
raise Exception("Unsupported display value")
#usbredirection support
if params.get("usb_redirection_add_device_vm2") == "yes":
logging.info("USB redirection set auto redirect on connect for device \
class 0x08")
cmd += " --spice-usbredir-redirect-on-connect=\"0x08,-1,-1,-1,1\""
client_root_session = client_vm.wait_for_login(timeout=int(
params.get("login_timeout", 360)),
username="******",
password="******")
usb_mount_path = params.get("file_path")
#USB was created by qemu (root). This prevents right issue.
client_root_session.cmd("chown test:test %s" % usb_mount_path)
if not check_usb_policy(client_vm, params):
logging.info("No USB policy.")
add_usb_policy(client_vm)
utils_spice.wait_timeout(3)
else:
logging.info("USB policy OK")
else:
logging.info("No USB redirection")
# Check to see if the test is using the full screen option.
if full_screen == "yes" and not rv_parameters_from == "file":
logging.info("Remote Viewer Set to use Full Screen")
cmd += " --full-screen"
if disable_audio == "yes":
logging.info("Remote Viewer Set to disable audio")
cmd += " --spice-disable-audio"
# Check to see if the test is using a smartcard.
if smartcard == "yes":
logging.info("remote viewer Set to use a smartcard")
if not rv_parameters_from == file:
cmd += " --spice-smartcard"
if certdb is not None:
logging.debug("Remote Viewer set to use the following certificate"
" database: " + certdb)
cmd += " --spice-smartcard-db " + certdb
if gencerts is not None:
logging.debug("Remote Viewer set to use the following certs: " +
gencerts)
cmd += " --spice-smartcard-certificates " + gencerts
if client_vm.params.get("os_type") == "linux":
cmd = "nohup " + cmd + " &> ~/rv.log &" # Launch it on background
if rv_ld_library_path:
cmd = "export LD_LIBRARY_PATH=" + rv_ld_library_path + ";" + cmd
if rv_parameters_from == "file":
print "Generating file"
utils_spice.gen_rv_file(params, guest_vm, host_subj, cacert_host)
print "Uploading file to client"
client_vm.copy_files_to("rv_file.vv", params.get("rv_file"))
# Launching the actual set of commands
try:
if rv_ld_library_path:
print_rv_version(client_session,
"LD_LIBRARY_PATH=/usr/local/lib " + rv_binary)
else:
print_rv_version(client_session, rv_binary)
except ShellStatusError, ShellProcessTerminatedError:
# Sometimes It fails with Status error, ingore it and continue.
# It's not that important to have printed versions in the log.
logging.debug("Ignoring a Status Exception that occurs from calling "
"print versions of remote-viewer or spice-gtk")
if rv_parameters_from != "file":
if client_vm.params.get("os_type") == "linux":
client_session.cmd("export SPICE_PROXY=%s" % proxy)
elif client_vm.params.get("os_type") == "windows":
client_session.cmd_output("SET SPICE_PROXY=%s" % proxy)
if not params.get("rv_verify") == "only":
try:
logging.info("spice,connection: %s", client_session.cmd(cmd))
except ShellStatusError:
logging.debug("Ignoring a status exception, will check connection"
"of remote-viewer later")
#Send command line through monitor since url was not provided
if rv_parameters_from == "menu":
utils_spice.wait_timeout(1)
str_input(client_vm, line)
# client waits for user entry (authentication) if spice_password is set
# use qemu monitor password if set, else, if set, try normal password.
if qemu_ticket:
# Wait for remote-viewer to launch
utils_spice.wait_timeout(5)
str_input(client_vm, qemu_ticket)
elif ticket:
if ticket_send:
ticket = ticket_send
utils_spice.wait_timeout(5) # Wait for remote-viewer to launch
str_input(client_vm, ticket)
