openkylin
/
virt-manager
mirror of https://gitee.com/openkylin/virt-manager.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

cli: Have parser classes reference property names, not xmlbuilders 

propertys already give us ways to access the backing class, and
switching to this method lets us drop some infrastructure in
xmlbuilder
This commit is contained in:
Cole Robinson 2018-03-20 19:38:18 -04:00
parent 256f0df8c2
commit 8d0b1f80f1
3 changed files with 88 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
virt-xml
View File

@ -92,10 +92,7 @@ def get_domain_and_guest(conn, domstr):
################ ################
def _find_objects_to_edit(guest, action_name, editval, parserclass): def _find_objects_to_edit(guest, action_name, editval, parserclass):
if issubclass(parserclass.objclass, virtinst.Device): objlist = util.listify(parserclass.lookup_prop(guest))
objlist = guest.devices.list_children_for_class(parserclass.objclass)
else:
objlist = guest.list_children_for_class(parserclass.objclass)
idx = None idx = None
if editval is None: if editval is None:
@ -170,7 +167,7 @@ def check_xmlopt_collision(options):
def action_edit(guest, options, parserclass): def action_edit(guest, options, parserclass):
if parserclass.objclass: if parserclass.propname:
inst = _find_objects_to_edit(guest, "edit", options.edit, parserclass) inst = _find_objects_to_edit(guest, "edit", options.edit, parserclass)
else: else:
inst = guest inst = guest
@ -182,22 +179,14 @@ def action_edit(guest, options, parserclass):
return cli.parse_option_strings(options, guest, inst, update=True) return cli.parse_option_strings(options, guest, inst, update=True)
def _is_singleton(guest, objclass):
if not objclass:
return True
if issubclass(objclass, virtinst.devices.Device):
return False
return guest.child_class_is_singleton(objclass)
def action_add_device(guest, options, parserclass): def action_add_device(guest, options, parserclass):
if _is_singleton(guest, parserclass.objclass): if not parserclass.prop_is_list(guest):
fail(_("Cannot use --add-device with --%s") % parserclass.cli_arg_name) fail(_("Cannot use --add-device with --%s") % parserclass.cli_arg_name)
return cli.parse_option_strings(options, guest, None) return cli.parse_option_strings(options, guest, None)
def action_remove_device(guest, options, parserclass): def action_remove_device(guest, options, parserclass):
if _is_singleton(guest, parserclass.objclass): if not parserclass.prop_is_list(guest):
fail(_("Cannot use --remove-device with --%s") % fail(_("Cannot use --remove-device with --%s") %
parserclass.cli_arg_name) parserclass.cli_arg_name)
@ -211,12 +200,16 @@ def action_remove_device(guest, options, parserclass):
def action_build_xml(conn, options, parserclass): def action_build_xml(conn, options, parserclass):
if not parserclass.objclass: if not parserclass.propname:
fail(_("--build-xml not supported for --%s") % fail(_("--build-xml not supported for --%s") %
parserclass.cli_arg_name) parserclass.cli_arg_name)
guest = virtinst.Guest(conn) guest = virtinst.Guest(conn)
inst = parserclass.objclass(conn) inst = parserclass.lookup_prop(guest)
if parserclass.prop_is_list(guest):
inst = inst.new()
else:
inst = inst.__class__(conn)
return cli.parse_option_strings(options, guest, inst) return cli.parse_option_strings(options, guest, inst)
@ -426,7 +419,7 @@ def main(conn=None):
check_action_collision(options) check_action_collision(options)
parserclass = check_xmlopt_collision(options) parserclass = check_xmlopt_collision(options)
if options.update and not parserclass.objclass: if options.update and not parserclass.propname:
fail(_("Don't know how to --update for --%s") % fail(_("Don't know how to --update for --%s") %
(parserclass.cli_arg_name)) (parserclass.cli_arg_name))

139
virtinst/cli.py
View File

@ -23,8 +23,9 @@ import libvirt
from virtcli import CLIConfig from virtcli import CLIConfig
from . import util from . import util
from .devices import * # pylint: disable=wildcard-import from .devices import (Device, DeviceController, DeviceDisk, DeviceGraphics,
from .domain import * # pylint: disable=wildcard-import DeviceInterface, DevicePanic)
from .domain import DomainClock, DomainOs
from .nodedev import NodeDevice from .nodedev import NodeDevice
from .storage import StoragePool, StorageVolume from .storage import StoragePool, StorageVolume
@ -1036,7 +1037,7 @@ class VirtCLIParser(object):
@cli_arg_name: The command line argument this maps to, so @cli_arg_name: The command line argument this maps to, so
"hostdev" for --hostdev "hostdev" for --hostdev
""" """
objclass = None propname = None
remove_first = None remove_first = None
stub_none = True stub_none = True
support_cb = None support_cb = None
@ -1063,6 +1064,26 @@ class VirtCLIParser(object):
print(" %s" % arg.cliname) print(" %s" % arg.cliname)
print("") print("")
@classmethod
def lookup_prop(cls, obj):
"""
For the passed obj, return the equivalent of
getattr(obj, cls.propname), but handle '.' in the propname
"""
if not cls.propname:
return None
parent = obj
pieces = cls.propname.split(".")
for piece in pieces[:-1]:
parent = getattr(parent, piece)
return getattr(parent, pieces[-1])
@classmethod
def prop_is_list(cls, obj):
inst = cls.lookup_prop(obj)
return isinstance(inst, list)
def __init__(self, guest, optstr): def __init__(self, guest, optstr):
self.guest = guest self.guest = guest
@ -1074,7 +1095,7 @@ class VirtCLIParser(object):
""" """
Callback that handles virt-xml clearxml=yes|no magic Callback that handles virt-xml clearxml=yes|no magic
""" """
if not self.objclass: if not self.propname:
raise RuntimeError("Don't know how to clearxml --%s" % raise RuntimeError("Don't know how to clearxml --%s" %
self.cli_arg_name) self.cli_arg_name)
if val is not True: if val is not True:
@ -1162,7 +1183,7 @@ class VirtCLIParser(object):
For virt-xml, 'inst' is the virtinst object we are editing, For virt-xml, 'inst' is the virtinst object we are editing,
ex. a DeviceDisk from a parsed Guest object. ex. a DeviceDisk from a parsed Guest object.
For virt-install, 'inst' is None, and we will create a new For virt-install, 'inst' is None, and we will create a new
inst from self.objclass, or edit a singleton object in place inst for self.propname, or edit a singleton object in place
like Guest.features/DomainFeatures like Guest.features/DomainFeatures
""" """
if not self.optstr: if not self.optstr:
@ -1171,27 +1192,24 @@ class VirtCLIParser(object):
return None return None
new_object = False new_object = False
if self.objclass and not inst: if self.propname and not inst:
if (not issubclass(self.objclass, Device) and inst = self.lookup_prop(self.guest)
self.guest.child_class_is_singleton(self.objclass)): new_object = self.prop_is_list(self.guest)
inst = self.guest.list_children_for_class(self.objclass)[0] if new_object:
else: inst = inst.new()
new_object = True
inst = self.objclass( # pylint: disable=not-callable
self.guest.conn)
ret = [] ret = []
try: try:
objs = self._parse(inst or self.guest) objs = self._parse(inst or self.guest)
for obj in util.listify(objs): if new_object:
if not new_object: for obj in util.listify(objs):
break if validate:
if validate: obj.validate()
obj.validate()
if isinstance(obj, Device): if isinstance(obj, Device):
self.guest.add_device(obj) self.guest.add_device(obj)
else: else:
self.guest.add_child(obj) self.guest.add_child(obj)
ret += util.listify(objs) ret += util.listify(objs)
except Exception as e: except Exception as e:
@ -1211,10 +1229,7 @@ class VirtCLIParser(object):
Used only by virt-xml --edit lookups Used only by virt-xml --edit lookups
""" """
ret = [] ret = []
if issubclass(self.objclass, Device): objlist = util.listify(self.lookup_prop(self.guest))
objlist = self.guest.devices.list_children_for_class(self.objclass)
else:
objlist = self.guest.list_children_for_class(self.objclass)
try: try:
for inst in objlist: for inst in objlist:
@ -1313,7 +1328,7 @@ ParserEvents.add_arg("on_lockfailure", "on_lockfailure")
class ParserResource(VirtCLIParser): class ParserResource(VirtCLIParser):
cli_arg_name = "resource" cli_arg_name = "resource"
objclass = DomainResource propname = "resource"
remove_first = "partition" remove_first = "partition"
_register_virt_parser(ParserResource) _register_virt_parser(ParserResource)
@ -1326,7 +1341,7 @@ ParserResource.add_arg("partition", "partition")
class ParserNumatune(VirtCLIParser): class ParserNumatune(VirtCLIParser):
cli_arg_name = "numatune" cli_arg_name = "numatune"
objclass = DomainNumatune propname = "numatune"
remove_first = "nodeset" remove_first = "nodeset"
_register_virt_parser(ParserNumatune) _register_virt_parser(ParserNumatune)
@ -1361,7 +1376,7 @@ ParserMemory.add_arg("hotplugmemoryslots", "hotplugmemoryslots")
class ParserMemtune(VirtCLIParser): class ParserMemtune(VirtCLIParser):
cli_arg_name = "memtune" cli_arg_name = "memtune"
objclass = DomainMemtune propname = "memtune"
remove_first = "soft_limit" remove_first = "soft_limit"
_register_virt_parser(ParserMemtune) _register_virt_parser(ParserMemtune)
@ -1377,7 +1392,7 @@ ParserMemtune.add_arg("min_guarantee", "min_guarantee")
class ParserBlkiotune(VirtCLIParser): class ParserBlkiotune(VirtCLIParser):
cli_arg_name = "blkiotune" cli_arg_name = "blkiotune"
objclass = DomainBlkiotune propname = "blkiotune"
remove_first = "weight" remove_first = "weight"
_register_virt_parser(ParserBlkiotune) _register_virt_parser(ParserBlkiotune)
@ -1392,7 +1407,7 @@ ParserBlkiotune.add_arg("device_weight", "device_weight")
class ParserMemoryBacking(VirtCLIParser): class ParserMemoryBacking(VirtCLIParser):
cli_arg_name = "memorybacking" cli_arg_name = "memorybacking"
objclass = DomainMemoryBacking propname = "memoryBacking"
_register_virt_parser(ParserMemoryBacking) _register_virt_parser(ParserMemoryBacking)
ParserMemoryBacking.add_arg("hugepages", "hugepages", is_onoff=True) ParserMemoryBacking.add_arg("hugepages", "hugepages", is_onoff=True)
@ -1409,7 +1424,7 @@ ParserMemoryBacking.add_arg("locked", "locked", is_onoff=True)
class ParserCPU(VirtCLIParser): class ParserCPU(VirtCLIParser):
cli_arg_name = "cpu" cli_arg_name = "cpu"
objclass = DomainCpu propname = "cpu"
remove_first = "model" remove_first = "model"
stub_none = False stub_none = False
@ -1523,7 +1538,7 @@ ParserCPU.add_arg("level", "cache.level", find_inst_cb=ParserCPU.set_l3_cache_cb
class ParserCputune(VirtCLIParser): class ParserCputune(VirtCLIParser):
cli_arg_name = "cputune" cli_arg_name = "cputune"
objclass = DomainCputune propname = "cputune"
remove_first = "model" remove_first = "model"
stub_none = False stub_none = False
@ -1602,7 +1617,7 @@ ParserVCPU.add_arg("vcpu_placement", "placement")
class ParserBoot(VirtCLIParser): class ParserBoot(VirtCLIParser):
cli_arg_name = "boot" cli_arg_name = "boot"
objclass = DomainOs propname = "os"
def set_uefi_cb(self, inst, val, virtarg): def set_uefi_cb(self, inst, val, virtarg):
self.guest.set_uefi_default() self.guest.set_uefi_default()
@ -1689,7 +1704,7 @@ for _bootdev in DomainOs.BOOT_DEVICES:
class ParserIdmap(VirtCLIParser): class ParserIdmap(VirtCLIParser):
cli_arg_name = "idmap" cli_arg_name = "idmap"
objclass = DomainIdmap propname = "idmap"
_register_virt_parser(ParserIdmap) _register_virt_parser(ParserIdmap)
ParserIdmap.add_arg("uid_start", "uid_start") ParserIdmap.add_arg("uid_start", "uid_start")
@ -1706,7 +1721,7 @@ ParserIdmap.add_arg("gid_count", "gid_count")
class ParserSecurity(VirtCLIParser): class ParserSecurity(VirtCLIParser):
cli_arg_name = "security" cli_arg_name = "security"
objclass = DomainSeclabel propname = "seclabels"
_register_virt_parser(ParserSecurity) _register_virt_parser(ParserSecurity)
ParserSecurity.add_arg("type", "type") ParserSecurity.add_arg("type", "type")
@ -1722,7 +1737,7 @@ ParserSecurity.add_arg("baselabel", "label", can_comma=True)
class ParserFeatures(VirtCLIParser): class ParserFeatures(VirtCLIParser):
cli_arg_name = "features" cli_arg_name = "features"
objclass = DomainFeatures propname = "features"
def set_smm_cb(self, inst, val, virtarg): def set_smm_cb(self, inst, val, virtarg):
if not inst.conn.check_support(inst.conn.SUPPORT_DOMAIN_FEATURE_SMM): if not inst.conn.check_support(inst.conn.SUPPORT_DOMAIN_FEATURE_SMM):
@ -1764,7 +1779,7 @@ ParserFeatures.add_arg("vmcoreinfo", "vmcoreinfo", is_onoff=True)
class ParserClock(VirtCLIParser): class ParserClock(VirtCLIParser):
cli_arg_name = "clock" cli_arg_name = "clock"
objclass = DomainClock propname = "clock"
def set_timer(self, inst, val, virtarg): def set_timer(self, inst, val, virtarg):
tname, attrname = virtarg.cliname.split("_") tname, attrname = virtarg.cliname.split("_")
@ -1798,7 +1813,7 @@ for _tname in DomainClock.TIMER_NAMES:
class ParserPM(VirtCLIParser): class ParserPM(VirtCLIParser):
cli_arg_name = "pm" cli_arg_name = "pm"
objclass = DomainPm propname = "pm"
_register_virt_parser(ParserPM) _register_virt_parser(ParserPM)
ParserPM.add_arg("suspend_to_mem", "suspend_to_mem", is_onoff=True) ParserPM.add_arg("suspend_to_mem", "suspend_to_mem", is_onoff=True)
@ -1811,7 +1826,7 @@ ParserPM.add_arg("suspend_to_disk", "suspend_to_disk", is_onoff=True)
class ParserSysinfo(VirtCLIParser): class ParserSysinfo(VirtCLIParser):
cli_arg_name = "sysinfo" cli_arg_name = "sysinfo"
objclass = DomainSysinfo propname = "sysinfo"
remove_first = "type" remove_first = "type"
def set_type_cb(self, inst, val, virtarg): def set_type_cb(self, inst, val, virtarg):
@ -1877,7 +1892,7 @@ ParserSysinfo.add_arg("baseBoard_location", "baseBoard_location")
class ParserQemuCLI(VirtCLIParser): class ParserQemuCLI(VirtCLIParser):
cli_arg_name = "qemu_commandline" cli_arg_name = "qemu_commandline"
objclass = DomainXMLNSQemu propname = "xmlns_qemu"
def args_cb(self, inst, val, virtarg): def args_cb(self, inst, val, virtarg):
for opt in shlex.split(val): for opt in shlex.split(val):
@ -1969,7 +1984,7 @@ def _generate_new_volume_name(guest, poolobj, fmt):
class ParserDisk(VirtCLIParser): class ParserDisk(VirtCLIParser):
cli_arg_name = "disk" cli_arg_name = "disk"
objclass = DeviceDisk propname = "devices.disk"
remove_first = "path" remove_first = "path"
stub_none = False stub_none = False
@ -2140,7 +2155,7 @@ ParserDisk.add_arg("label", "seclabel[0-9]*.label", can_comma=True,
class ParserNetwork(VirtCLIParser): class ParserNetwork(VirtCLIParser):
cli_arg_name = "network" cli_arg_name = "network"
objclass = DeviceInterface propname = "devices.interface"
remove_first = "type" remove_first = "type"
stub_none = False stub_none = False
@ -2227,7 +2242,7 @@ ParserNetwork.add_arg("virtualport.interfaceid", "virtualport_interfaceid")
class ParserGraphics(VirtCLIParser): class ParserGraphics(VirtCLIParser):
cli_arg_name = "graphics" cli_arg_name = "graphics"
objclass = DeviceGraphics propname = "devices.graphics"
remove_first = "type" remove_first = "type"
stub_none = False stub_none = False
@ -2328,7 +2343,7 @@ ParserGraphics.add_arg("rendernode", "rendernode")
class ParserController(VirtCLIParser): class ParserController(VirtCLIParser):
cli_arg_name = "controller" cli_arg_name = "controller"
objclass = DeviceController propname = "devices.controller"
remove_first = "type" remove_first = "type"
def set_server_cb(self, inst, val, virtarg): def set_server_cb(self, inst, val, virtarg):
@ -2360,7 +2375,7 @@ ParserController.add_arg(None, "address", cb=ParserController.set_server_cb)
class ParserInput(VirtCLIParser): class ParserInput(VirtCLIParser):
cli_arg_name = "input" cli_arg_name = "input"
objclass = DeviceInput propname = "devices.input"
remove_first = "type" remove_first = "type"
_register_virt_parser(ParserInput) _register_virt_parser(ParserInput)
@ -2375,7 +2390,7 @@ ParserInput.add_arg("bus", "bus")
class ParserSmartcard(VirtCLIParser): class ParserSmartcard(VirtCLIParser):
cli_arg_name = "smartcard" cli_arg_name = "smartcard"
objclass = DeviceSmartcard propname = "devices.smartcard"
remove_first = "mode" remove_first = "mode"
_register_virt_parser(ParserSmartcard) _register_virt_parser(ParserSmartcard)
@ -2390,7 +2405,7 @@ ParserSmartcard.add_arg("type", "type")
class ParserRedir(VirtCLIParser): class ParserRedir(VirtCLIParser):
cli_arg_name = "redirdev" cli_arg_name = "redirdev"
objclass = DeviceRedirdev propname = "devices.redirdev"
remove_first = "bus" remove_first = "bus"
stub_none = False stub_none = False
@ -2417,7 +2432,7 @@ ParserRedir.add_arg(None, "server", cb=ParserRedir.set_server_cb)
class ParserTPM(VirtCLIParser): class ParserTPM(VirtCLIParser):
cli_arg_name = "tpm" cli_arg_name = "tpm"
objclass = DeviceTpm propname = "devices.tpm"
remove_first = "type" remove_first = "type"
def _parse(self, inst): def _parse(self, inst):
@ -2438,7 +2453,7 @@ ParserTPM.add_arg("device_path", "path")
class ParserRNG(VirtCLIParser): class ParserRNG(VirtCLIParser):
cli_arg_name = "rng" cli_arg_name = "rng"
objclass = DeviceRng propname = "devices.rng"
remove_first = "type" remove_first = "type"
stub_none = False stub_none = False
@ -2507,7 +2522,7 @@ ParserRNG.add_arg("rate_period", "rate_period")
class ParserWatchdog(VirtCLIParser): class ParserWatchdog(VirtCLIParser):
cli_arg_name = "watchdog" cli_arg_name = "watchdog"
objclass = DeviceWatchdog propname = "devices.watchdog"
remove_first = "model" remove_first = "model"
_register_virt_parser(ParserWatchdog) _register_virt_parser(ParserWatchdog)
@ -2522,7 +2537,7 @@ ParserWatchdog.add_arg("action", "action")
class ParseMemdev(VirtCLIParser): class ParseMemdev(VirtCLIParser):
cli_arg_name = "memdev" cli_arg_name = "memdev"
objclass = DeviceMemory propname = "devices.memory"
remove_first = "model" remove_first = "model"
def set_target_size(self, inst, val, virtarg): def set_target_size(self, inst, val, virtarg):
@ -2546,7 +2561,7 @@ ParseMemdev.add_arg("source.nodemask", "source_nodemask", can_comma=True)
class ParserMemballoon(VirtCLIParser): class ParserMemballoon(VirtCLIParser):
cli_arg_name = "memballoon" cli_arg_name = "memballoon"
objclass = DeviceMemballoon propname = "devices.memballoon"
remove_first = "model" remove_first = "model"
stub_none = False stub_none = False
@ -2561,7 +2576,7 @@ ParserMemballoon.add_arg("model", "model")
class ParserPanic(VirtCLIParser): class ParserPanic(VirtCLIParser):
cli_arg_name = "panic" cli_arg_name = "panic"
objclass = DevicePanic propname = "devices.panic"
remove_first = "model" remove_first = "model"
compat_mode = False compat_mode = False
@ -2646,25 +2661,25 @@ _ParserChar.add_arg("log_append", "log.append", is_onoff=True)
class ParserSerial(_ParserChar): class ParserSerial(_ParserChar):
cli_arg_name = "serial" cli_arg_name = "serial"
objclass = DeviceSerial propname = "devices.serial"
_register_virt_parser(ParserSerial) _register_virt_parser(ParserSerial)
class ParserParallel(_ParserChar): class ParserParallel(_ParserChar):
cli_arg_name = "parallel" cli_arg_name = "parallel"
objclass = DeviceParallel propname = "devices.parallel"
_register_virt_parser(ParserParallel) _register_virt_parser(ParserParallel)
class ParserChannel(_ParserChar): class ParserChannel(_ParserChar):
cli_arg_name = "channel" cli_arg_name = "channel"
objclass = DeviceChannel propname = "devices.channel"
_register_virt_parser(ParserChannel) _register_virt_parser(ParserChannel)
class ParserConsole(_ParserChar): class ParserConsole(_ParserChar):
cli_arg_name = "console" cli_arg_name = "console"
objclass = DeviceConsole propname = "devices.console"
_register_virt_parser(ParserConsole) _register_virt_parser(ParserConsole)
@ -2674,7 +2689,7 @@ _register_virt_parser(ParserConsole)
class ParserFilesystem(VirtCLIParser): class ParserFilesystem(VirtCLIParser):
cli_arg_name = "filesystem" cli_arg_name = "filesystem"
objclass = DeviceFilesystem propname = "devices.filesystem"
remove_first = ["source", "target"] remove_first = ["source", "target"]
_register_virt_parser(ParserFilesystem) _register_virt_parser(ParserFilesystem)
@ -2691,7 +2706,7 @@ ParserFilesystem.add_arg("target", "target")
class ParserVideo(VirtCLIParser): class ParserVideo(VirtCLIParser):
cli_arg_name = "video" cli_arg_name = "video"
objclass = DeviceVideo propname = "devices.video"
remove_first = "model" remove_first = "model"
def _parse(self, inst): def _parse(self, inst):
@ -2725,7 +2740,7 @@ ParserVideo.add_arg("vgamem", "vgamem")
class ParserSound(VirtCLIParser): class ParserSound(VirtCLIParser):
cli_arg_name = "sound" cli_arg_name = "sound"
objclass = DeviceSound propname = "devices.sound"
remove_first = "model" remove_first = "model"
stub_none = False stub_none = False
@ -2746,7 +2761,7 @@ ParserSound.add_arg("model", "model", ignore_default=True)
class ParserHostdev(VirtCLIParser): class ParserHostdev(VirtCLIParser):
cli_arg_name = "hostdev" cli_arg_name = "hostdev"
objclass = DeviceHostdev propname = "devices.hostdev"
remove_first = "name" remove_first = "name"
def set_name_cb(self, inst, val, virtarg): def set_name_cb(self, inst, val, virtarg):

17
virtinst/xmlbuilder.py
View File

@ -715,23 +715,6 @@ class XMLBuilder(object):
self._xmlstate.xmlapi.node_force_remove(xpath) self._xmlstate.xmlapi.node_force_remove(xpath)
self._set_child_xpaths() self._set_child_xpaths()
def list_children_for_class(self, klass):
"""
Return a list of all XML child objects with the passed class
"""
ret = []
for prop in list(self._all_child_props().values()):
ret += [obj for obj in util.listify(prop._get(self))
if obj.__class__ == klass]
return ret
def child_class_is_singleton(self, klass):
"""
Return True if the passed class is registered as a singleton
child property
"""
return self._find_child_prop(klass, return_single=True).is_single
################################# #################################
# Private XML building routines # # Private XML building routines #