def generate_vnc_graphic_xml(params, expected_result):
"""
Generate VNC graphics XML using input parameters.
"""
autoport = params.get("vnc_autoport", "yes")
port = params.get("vnc_port", "not_set")
listen_type = params.get("vnc_listen_type", "not_set")
graphic = Graphics(type_name='vnc')
if autoport != 'not_set':
graphic.autoport = autoport
if port != 'not_set':
graphic.port = port
if listen_type == 'network':
net_type = params.get("vnc_network_type", "vnet")
listen = {'type': 'network', 'network': 'virt-test-%s' % net_type}
graphic.listens = [listen]
elif listen_type == 'address':
address = params.get("vnc_listen_address", "127.0.0.1")
if address in ['valid_ipv4', 'valid_ipv6']:
address = str(expected_result['vnc_ips'][0])
listen = {'type': 'address', 'address': address}
graphic.listens = [listen]
return graphic
def prepare_spice_graphics_device():
"""
Prepare a spice graphics device XML according to parameters
"""
graphic = Graphics(type_name='spice')
graphic.autoport = "yes"
graphic.port = "-1"
graphic.tlsPort = "-1"
return graphic
def prepare_spice_graphics_device():
"""
Prepare a spice graphics device XML according to parameters
"""
graphic = Graphics(type_name='spice')
graphic.autoport = "yes"
graphic.port = "-1"
graphic.tlsPort = "-1"
return graphic
def configure_spice(vm_name):
"""
Configure spice
:params vm_name: guest name
"""
vm_spice_xml = VMXML.new_from_inactive_dumpxml(vm_name)
vm_spice_xml.remove_all_device_by_type('graphics')
graphic = Graphics(type_name='spice')
graphic.autoport = "yes"
graphic.port = "-1"
graphic.tlsPort = "-1"
vm_spice_xml.add_device(graphic)
vm_spice_xml.sync()
def generate_vnc_graphic_xml(params, expected_result):
"""
Generate VNC graphics XML using input parameters.
"""
autoport = params.get("vnc_autoport", "yes")
port = params.get("vnc_port", "not_set")
listen_type = params.get("vnc_listen_type", "not_set")
graphic_passwd = params.get("graphic_passwd")
vnc_passwd_place = params.get("vnc_passwd_place", "not_set")
graphic = Graphics(type_name='vnc')
if autoport != 'not_set':
graphic.autoport = autoport
if port != 'not_set':
graphic.port = port
if listen_type == 'network':
net_type = params.get("vnc_network_type", "vnet")
listen = {'type': 'network', 'network': 'virt-test-%s' % net_type}
graphic.listens = [listen]
elif listen_type == 'address':
address = params.get("vnc_listen_address", "127.0.0.1")
if address in ['valid_ipv4', 'valid_ipv6']:
address = str(expected_result['vnc_ips'][0].addr)
listen = {'type': 'address', 'address': address}
graphic.listens = [listen]
if graphic_passwd and vnc_passwd_place == "guest":
graphic.passwd = graphic_passwd
return graphic
def run(test, params, env):
"""
Test virsh domdisplay command, return the graphic url
This test covered vnc and spice type, also readonly and readwrite mode
If have --include-passwd option, also need to check passwd list in result
"""
if not virsh.has_help_command('domdisplay'):
test.cancel("This version of libvirt doesn't support "
"domdisplay test")
vm_name = params.get("main_vm", "avocado-vt-vm1")
status_error = ("yes" == params.get("status_error", "no"))
options = params.get("domdisplay_options", "")
graphic = params.get("domdisplay_graphic", "vnc")
readonly = ("yes" == params.get("readonly", "no"))
passwd = params.get("domdisplay_passwd")
is_ssl = ("yes" == params.get("domdisplay_ssl", "no"))
is_domid = ("yes" == params.get("domdisplay_domid", "no"))
is_domuuid = ("yes" == params.get("domdisplay_domuuid", "no"))
qemu_conf = params.get("qemu_conf_file", "/etc/libvirt/qemu.conf")
# Do xml backup for final recovery
vmxml_backup = vm_xml.VMXML.new_from_inactive_dumpxml(vm_name)
tmp_file = os.path.join(data_dir.get_tmp_dir(), "qemu.conf.bk")
if "--type" in options:
if not libvirt_version.version_compare(1, 2, 6):
test.cancel("--type option is not supported in this"
" libvirt version.")
elif "vnc" in options and graphic != "vnc" or \
"spice" in options and graphic != "spice":
status_error = True
def restart_libvirtd():
# make modification effect
libvirtd_instance = utils_libvirtd.Libvirtd()
libvirtd_instance.restart()
def clean_ssl_env():
"""
Clean ssl spice connection firstly
"""
# modify qemu.conf
with open(qemu_conf, "r") as f_obj:
cont = f_obj.read()
# remove the existing setting
left_cont = re.sub(r'\s*spice_tls\s*=.*', '', cont)
left_cont = re.sub(r'\s*spice_tls_x509_cert_dir\s*=.*', '', left_cont)
# write back to origin file with cut left content
with open(qemu_conf, "w") as f_obj:
f_obj.write(left_cont)
def prepare_ssl_env():
"""
Do prepare for ssl spice connection
"""
# modify qemu.conf
clean_ssl_env()
# Append ssl spice configuration
with open(qemu_conf, "a") as f_obj:
f_obj.write("spice_tls = 1\n")
f_obj.write("spice_tls_x509_cert_dir = \"/etc/pki/libvirt-spice\"")
# Generate CA cert
utils_misc.create_x509_dir("/etc/pki/libvirt-spice",
"/C=IL/L=Raanana/O=Red Hat/CN=my CA",
"/C=IL/L=Raanana/O=Red Hat/CN=my server",
passwd)
os.chmod('/etc/pki/libvirt-spice/server-key.pem', 0o644)
os.chmod('/etc/pki/libvirt-spice/ca-key.pem', 0o644)
try:
graphic_count = len(vmxml_backup.get_graphics_devices())
shutil.copyfile(qemu_conf, tmp_file)
if is_ssl:
# Do backup for qemu.conf in tmp_file
prepare_ssl_env()
restart_libvirtd()
if graphic_count:
Graphics.del_graphic(vm_name)
Graphics.add_graphic(vm_name, passwd, "spice", True)
else:
clean_ssl_env()
restart_libvirtd()
if graphic_count:
Graphics.del_graphic(vm_name)
Graphics.add_graphic(vm_name, passwd, graphic)
vm = env.get_vm(vm_name)
if not vm.is_alive():
vm.start()
dom_id = virsh.domid(vm_name).stdout.strip()
dom_uuid = virsh.domuuid(vm_name).stdout.strip()
if is_domid:
vm_name = dom_id
if is_domuuid:
vm_name = dom_uuid
# Do test
result = virsh.domdisplay(vm_name,
options,
readonly=readonly,
debug=True)
logging.debug("result is %s", result)
if result.exit_status:
if not status_error:
test.fail("Fail to get domain display info. Error:"
"%s." % result.stderr.strip())
else:
logging.info(
"Get domain display info failed as expected. "
"Error:%s.", result.stderr.strip())
return
elif status_error:
test.fail("Expect fail, but succeed indeed!")
output = result.stdout.strip()
# Different result depends on the domain xml listen address
if output.find("localhost:") >= 0:
expect_addr = "localhost"
else:
expect_addr = "127.0.0.1"
# Get active domain xml info
vmxml_act = vm_xml.VMXML.new_from_dumpxml(vm_name, "--security-info")
logging.debug("xml is %s", vmxml_act.get_xmltreefile())
graphics = vmxml_act.devices.by_device_tag('graphics')
for graph in graphics:
if graph.type_name == graphic:
graphic_act = graph
port = graph.port
# Do judgement for result
if graphic == "vnc":
expect = "vnc://%s:%s" % (expect_addr, str(int(port) - 5900))
elif graphic == "spice" and is_ssl:
tlsport = graphic_act.tlsPort
expect = "spice://%s:%s?tls-port=%s" % \
(expect_addr, port, tlsport)
elif graphic == "spice":
expect = "spice://%s:%s" % (expect_addr, port)
if options == "--include-password" and passwd is not None:
# have --include-passwd and have passwd in xml
if graphic == "vnc":
expect = "vnc://:%s@%s:%s" % \
(passwd, expect_addr, str(int(port)-5900))
elif graphic == "spice" and is_ssl:
expect = expect + "&password="******"spice":
expect = expect + "?password="******"Get correct display:%s", output)
else:
test.fail("Expect %s, but get %s" % (expect, output))
finally:
# qemu.conf recovery
shutil.move(tmp_file, qemu_conf)
restart_libvirtd()
# Domain xml recovery
vmxml_backup.sync()
def generate_spice_graphic_xml(params, expected_result):
"""
Generate SPICE graphics XML using input parameters.
"""
autoport = params.get("spice_autoport", "yes")
default_mode = params.get("defaultMode", "not_set")
channels_str = params.get("channels", "")
port = params.get("spice_port", "not_set")
tls_port = params.get("spice_tlsPort", "not_set")
image_compression = params.get("image_compression", "not_set")
jpeg_compression = params.get("jpeg_compression", "not_set")
zlib_compression = params.get("zlib_compression", "not_set")
playback_compression = params.get("playback_compression", "not_set")
listen_type = params.get("spice_listen_type", "not_set")
graphic = Graphics(type_name='spice')
if autoport != 'not_set':
graphic.autoport = autoport
if port != 'not_set':
graphic.port = port
if tls_port != 'not_set':
graphic.tlsPort = tls_port
if default_mode != 'not_set':
graphic.defaultMode = default_mode
if image_compression != 'not_set':
graphic.image_compression = image_compression
if jpeg_compression != 'not_set':
graphic.jpeg_compression = jpeg_compression
if zlib_compression != 'not_set':
graphic.zlib_compression = zlib_compression
if playback_compression != 'not_set':
graphic.playback_compression = playback_compression
channels = []
if channels_str:
for channel_str in channels_str.strip().split(','):
name, mode = channel_str.split(':')
channels.append({'name': name, 'mode': mode})
graphic.channel = channels
if listen_type == 'network':
net_type = params.get("spice_network_type", "vnet")
listen = {'type': 'network', 'network': 'virt-test-%s' % net_type}
graphic.listens = [listen]
elif listen_type == 'address':
address = params.get("spice_listen_address", "127.0.0.1")
if address in ['valid_ipv4', 'valid_ipv6']:
address = str(expected_result['spice_ips'][0])
listen = {'type': 'address', 'address': address}
graphic.listens = [listen]
return graphic
def generate_spice_graphic_xml(params, expected_result):
"""
Generate SPICE graphics XML using input parameters.
"""
autoport = params.get("spice_autoport", "yes")
default_mode = params.get("defaultMode", "not_set")
channels_str = params.get("channels", "")
port = params.get("spice_port", "not_set")
tls_port = params.get("spice_tlsPort", "not_set")
image_compression = params.get("image_compression", "not_set")
jpeg_compression = params.get("jpeg_compression", "not_set")
zlib_compression = params.get("zlib_compression", "not_set")
playback_compression = params.get("playback_compression", "not_set")
listen_type = params.get("spice_listen_type", "not_set")
graphic = Graphics(type_name='spice')
if autoport != 'not_set':
graphic.autoport = autoport
if port != 'not_set':
graphic.port = port
if tls_port != 'not_set':
graphic.tlsPort = tls_port
if default_mode != 'not_set':
graphic.defaultMode = default_mode
if image_compression != 'not_set':
graphic.image_compression = image_compression
if jpeg_compression != 'not_set':
graphic.jpeg_compression = jpeg_compression
if zlib_compression != 'not_set':
graphic.zlib_compression = zlib_compression
if playback_compression != 'not_set':
graphic.playback_compression = playback_compression
channels = []
if channels_str:
for channel_str in channels_str.strip().split(','):
name, mode = channel_str.split(':')
channels.append({'name': name, 'mode': mode})
graphic.channel = channels
if listen_type == 'network':
net_type = params.get("spice_network_type", "vnet")
listen = {'type': 'network', 'network': 'virt-test-%s' % net_type}
graphic.listens = [listen]
elif listen_type == 'address':
address = params.get("spice_listen_address", "127.0.0.1")
if address in ['valid_ipv4', 'valid_ipv6']:
address = str(expected_result['spice_ips'][0])
listen = {'type': 'address', 'address': address}
graphic.listens = [listen]
return graphic
def run(test, params, env):
"""
Test virsh domdisplay command, return the graphic url
This test covered vnc and spice type, also readonly and readwrite mode
If have --include-passwd option, also need to check passwd list in result
"""
if not virsh.has_help_command('domdisplay'):
raise error.TestNAError("This version of libvirt doesn't support "
"domdisplay test")
vm_name = params.get("main_vm", "virt-tests-vm1")
status_error = ("yes" == params.get("status_error", "no"))
options = params.get("domdisplay_options", "")
graphic = params.get("domdisplay_graphic", "vnc")
readonly = ("yes" == params.get("readonly", "no"))
passwd = params.get("domdisplay_passwd")
is_ssl = ("yes" == params.get("domdisplay_ssl", "no"))
is_domid = ("yes" == params.get("domdisplay_domid", "no"))
is_domuuid = ("yes" == params.get("domdisplay_domuuid", "no"))
qemu_conf = params.get("qemu_conf_file", "/etc/libvirt/qemu.conf")
# Do xml backup for final recovery
vmxml_backup = vm_xml.VMXML.new_from_inactive_dumpxml(vm_name)
tmp_file = os.path.join(test.tmpdir, "qemu.conf.bk")
def prepare_ssl_env():
"""
Do prepare for ssl spice connection
"""
# modify qemu.conf
f_obj = open(qemu_conf, "r")
cont = f_obj.read()
# remove the existing setting
left_cont = re.sub(r'\s*spice_tls\s*=.*', '', cont)
left_cont = re.sub(r'\s*spice_tls_x509_cert_dir\s*=.*', '',
left_cont)
# write back to origin file with cut left content
f_obj = open(qemu_conf, "w")
f_obj.write(left_cont)
f_obj.write("spice_tls = 1\n")
f_obj.write("spice_tls_x509_cert_dir = \"/etc/pki/libvirt-spice\"")
f_obj.close()
# make modification effect
utils_libvirtd.libvirtd_restart()
# Generate CA cert
utils_misc.create_x509_dir("/etc/pki/libvirt-spice",
"/C=IL/L=Raanana/O=Red Hat/CN=my CA",
"/C=IL/L=Raanana/O=Red Hat/CN=my server",
passwd)
try:
graphic_count = len(vmxml_backup.get_graphics_devices())
if is_ssl:
# Do backup for qemu.conf in tmp_file
shutil.copyfile(qemu_conf, tmp_file)
prepare_ssl_env()
if graphic_count:
Graphics.del_graphic(vm_name)
Graphics.add_graphic(vm_name, passwd, "spice", True)
else:
if not graphic_count:
Graphics.add_graphic(vm_name, passwd, graphic)
# Only change graphic type and passwd
Graphics.change_graphic_type_passwd(vm_name, graphic, passwd)
vm = env.get_vm(vm_name)
if not vm.is_alive():
vm.start()
dom_id = virsh.domid(vm_name).stdout.strip()
dom_uuid = virsh.domuuid(vm_name).stdout.strip()
if is_domid:
vm_name = dom_id
if is_domuuid:
vm_name = dom_uuid
# Do test
result = virsh.domdisplay(vm_name, options, readonly=readonly,
debug=True)
logging.debug("result is %s", result)
if result.exit_status:
if not status_error:
raise error.TestFail("Fail to get domain display info. Error:"
"%s." % result.stderr.strip())
else:
logging.info("Get domain display info failed as expected. "
"Error:%s.", result.stderr.strip())
return
elif status_error:
raise error.TestFail("Expect fail, but succeed indeed!")
output = result.stdout.strip()
# Different result depends on the domain xml listen address
if output.find("localhost:") >= 0:
expect_addr = "localhost"
else:
expect_addr = "127.0.0.1"
# Get active domain xml info
vmxml_act = vm_xml.VMXML.new_from_dumpxml(vm_name, "--security-info")
logging.debug("xml is %s", vmxml_act.get_xmltreefile())
graphic_act = vmxml_act.devices.by_device_tag('graphics')[0]
port = graphic_act.port
# Do judgement for result
if graphic == "vnc":
expect = "vnc://%s:%s" % (expect_addr, str(int(port)-5900))
elif graphic == "spice" and is_ssl:
tlsport = graphic_act.tlsPort
expect = "spice://%s:%s?tls-port=%s" % \
(expect_addr, port, tlsport)
elif graphic == "spice":
expect = "spice://%s:%s" % (expect_addr, port)
if options != "" and passwd is not None:
# have --include-passwd and have passwd in xml
if graphic == "vnc":
expect = "vnc://:%s@%s:%s" % \
(passwd, expect_addr, str(int(port)-5900))
elif graphic == "spice" and is_ssl:
expect = expect + "&password="******"spice":
expect = expect + "?password="******"Get correct display:%s", output)
else:
raise error.TestFail("Expect %s, but get %s"
% (expect, output))
finally:
# Domain xml recovery
vmxml_backup.sync()
if is_ssl:
# qemu.conf recovery
shutil.move(tmp_file, qemu_conf)
utils_libvirtd.libvirtd_restart()
def run(test, params, env):
"""
Test virsh domdisplay command, return the graphic url
This test covered vnc and spice type, also readonly and readwrite mode
If have --include-passwd option, also need to check passwd list in result
"""
if not virsh.has_help_command('domdisplay'):
raise error.TestNAError("This version of libvirt doesn't support "
"domdisplay test")
vm_name = params.get("main_vm", "virt-tests-vm1")
status_error = ("yes" == params.get("status_error", "no"))
options = params.get("domdisplay_options", "")
graphic = params.get("domdisplay_graphic", "vnc")
readonly = ("yes" == params.get("readonly", "no"))
passwd = params.get("domdisplay_passwd")
is_ssl = ("yes" == params.get("domdisplay_ssl", "no"))
is_domid = ("yes" == params.get("domdisplay_domid", "no"))
is_domuuid = ("yes" == params.get("domdisplay_domuuid", "no"))
qemu_conf = params.get("qemu_conf_file", "/etc/libvirt/qemu.conf")
# Do xml backup for final recovery
vmxml_backup = vm_xml.VMXML.new_from_inactive_dumpxml(vm_name)
tmp_file = os.path.join(test.tmpdir, "qemu.conf.bk")
def prepare_ssl_env():
"""
Do prepare for ssl spice connection
"""
# modify qemu.conf
f_obj = open(qemu_conf, "r")
cont = f_obj.read()
# remove the existing setting
left_cont = re.sub(r'\s*spice_tls\s*=.*', '', cont)
left_cont = re.sub(r'\s*spice_tls_x509_cert_dir\s*=.*', '', left_cont)
# write back to origin file with cut left content
f_obj = open(qemu_conf, "w")
f_obj.write(left_cont)
f_obj.write("spice_tls = 1\n")
f_obj.write("spice_tls_x509_cert_dir = \"/etc/pki/libvirt-spice\"")
f_obj.close()
# make modification effect
utils_libvirtd.libvirtd_restart()
# Generate CA cert
utils_misc.create_x509_dir("/etc/pki/libvirt-spice",
"/C=IL/L=Raanana/O=Red Hat/CN=my CA",
"/C=IL/L=Raanana/O=Red Hat/CN=my server",
passwd)
try:
if is_ssl:
# Do backup for qemu.conf in tmp_file
shutil.copyfile(qemu_conf, tmp_file)
prepare_ssl_env()
Graphics.del_graphic(vm_name)
Graphics.add_ssl_spice_graphic(vm_name, passwd)
else:
# Only change graphic type and passwd
Graphics.change_graphic_type_passwd(vm_name, graphic, passwd)
vm = env.get_vm(vm_name)
if not vm.is_alive():
vm.start()
dom_id = virsh.domid(vm_name).stdout.strip()
dom_uuid = virsh.domuuid(vm_name).stdout.strip()
if is_domid:
vm_name = dom_id
if is_domuuid:
vm_name = dom_uuid
# Do test
result = virsh.domdisplay(vm_name,
options,
readonly=readonly,
debug=True)
logging.debug("result is %s", result)
if result.exit_status:
if not status_error:
raise error.TestFail("Fail to get domain display info. Error:"
"%s." % result.stderr.strip())
else:
logging.info(
"Get domain display info failed as expected. "
"Error:%s.", result.stderr.strip())
return
elif status_error:
raise error.TestFail("Expect fail, but succeed indeed!")
output = result.stdout.strip()
# Different result depends on the domain xml listen address
if output.find("localhost:") >= 0:
expect_addr = "localhost"
else:
expect_addr = "127.0.0.1"
# Get active domain xml info
vmxml_act = vm_xml.VMXML.new_from_dumpxml(vm_name, "--security-info")
logging.debug("xml is %s", vmxml_act.get_xmltreefile())
graphic_act = vmxml_act.devices.by_device_tag('graphics')[0]
port = graphic_act.port
# Do judgement for result
if graphic == "vnc":
expect = "vnc://%s:%s" % (expect_addr, str(int(port) - 5900))
elif graphic == "spice" and is_ssl:
tlsport = graphic_act.tlsPort
expect = "spice://%s:%s?tls-port=%s" % \
(expect_addr, port, tlsport)
elif graphic == "spice":
expect = "spice://%s:%s" % (expect_addr, port)
if options != "" and passwd is not None:
# have --include-passwd and have passwd in xml
if graphic == "vnc":
expect = "vnc://:%s@%s:%s" % \
(passwd, expect_addr, str(int(port)-5900))
elif graphic == "spice" and is_ssl:
expect = expect + "&password="******"spice":
expect = expect + "?password="******"Get correct display:%s", output)
else:
raise error.TestFail("Expect %s, but get %s", expect, output)
finally:
# Domain xml recovery
vmxml_backup.sync()
if is_ssl:
# qemu.conf recovery
shutil.move(tmp_file, qemu_conf)
utils_libvirtd.libvirtd_restart()
