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

Move virtmanager test cli handling to testmock.py 

We will be adding more stuff here, so let's move it out
of the main virt-manager script

Signed-off-by: Cole Robinson <crobinso@redhat.com>
This commit is contained in:
Cole Robinson 2020-08-24 16:03:00 -04:00
parent 5ccbcb898f
commit bb1180fb40
3 changed files with 95 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
tests/uitests/test_manager.py
View File

@ -15,7 +15,7 @@ class Manager(uiutils.UITestCase):
def _testVMLifecycle(self):
"""
Basic VM lifecycle test, shared between standard and --test-no-events
Basic VM lifecycle test, shared between standard and no-events
testing
"""
manager = self.app.topwin
@ -48,7 +48,7 @@ class Manager(uiutils.UITestCase):
self._testVMLifecycle()
def testVMNoEventsLifecycle(self):
self.app.open(extra_opts=["--test-no-events"])
self.app.open(extra_opts=["--test-options=no-events"])
# Change preferences timeout to 1 second
self.app.root.find("Edit", "menu").click()

87
virtManager/lib/testmock.py Normal file
View File

@ -0,0 +1,87 @@
# Copyright (C) 2020 Red Hat, Inc.
#
# This work is licensed under the GNU GPLv2 or later.
# See the COPYING file in the top-level directory.
class CLITestOptionsClass:
"""
Helper class for parsing and tracking --test-* options.
The suboptions are:
* first-run: Run the app with fresh gsettings values and
no config changes saved to disk, among a few other tweaks.
Heavily used by the UI test suite.
* xmleditor-enabled: Force the xmleditor preference on if
using first-run. Used by the test suite
* gsettings-keyfile: Override the gsettings values with those
from the passed in keyfile, to test with different default
settings.
* leak-debug: Enabling this will tell us, at app exit time,
which vmmGObjects were not garbage collected. This is caused
by circular references to other objects, like a signal that
wasn't disconnected. It's not a big deal, but if we have objects
that can be created and destroyed a lot over the course of
the app lifecycle, every non-garbage collected class is a
memory leak. So it's nice to poke at this every now and then
and try to track down what we need to add to class _cleanup handling.
* no-events: Force disable libvirt event APIs for testing fallback
* break_setfacl: For setfacl calls to fail, for test scenarios.
This is hit via the directory search permissions checking
for disk image usage for qemu
"""
def __init__(self, test_options_str, test_first_run):
optset = set()
for optstr in test_options_str:
optset.update(set(optstr.split(",")))
self._parse(optset)
if test_first_run:
self.first_run = True
self._process()
def _parse(self, optset):
def _get(optname):
if optname not in optset:
return False
optset.remove(optname)
return True
def _get_value(optname):
for opt in optset:
if opt.startswith(optname + "="):
optset.remove(opt)
return opt.split("=", 1)[1]
self.first_run = _get("first-run")
self.leak_debug = _get("leak-debug")
self.no_events = _get("no-events")
self.xmleditor_enabled = _get("xmleditor-enabled")
self.gsettings_keyfile = _get_value("gsettings-keyfile")
self.break_setfacl = _get("break-setfacl")
if optset: # pragma: no cover
raise RuntimeError("Unknown --test-options keys: %s" % optset)
def _process(self):
if self.first_run and not self.gsettings_keyfile:
import atexit
import tempfile
import os
filename = tempfile.mktemp(prefix="virtmanager-firstrun-keyfile")
self.gsettings_keyfile = filename
atexit.register(lambda: os.unlink(filename))
if self.break_setfacl:
import virtinst.diskbackend
def fake_search(*args, **kwargs):
raise RuntimeError("Fake search fix fail from test suite")
virtinst.diskbackend.SETFACL = "getfacl"
# pylint: disable=protected-access
virtinst.diskbackend._fix_perms_chmod = fake_search

74
virtManager/virtmanager.py
View File

@ -21,6 +21,8 @@ from virtinst import VirtinstConnection
from virtinst import cli
from virtinst import log
from .lib.testmock import CLITestOptionsClass
# This is massively heavy handed, but I can't figure out any way to shut
# up the slew of gtk deprecation warnings that clog up our very useful
# stdout --debug output. Of course we could drop use of deprecated APIs,
@ -144,22 +146,11 @@ def parse_commandline():
# PackageKit integration
parser.add_argument("--test-first-run",
help=argparse.SUPPRESS, action="store_true")
# Force disable use of libvirt object events
parser.add_argument("--test-no-events",
help=argparse.SUPPRESS, action="store_true")
# Enabling this will tell us, at app exit time, which vmmGObjects were not
# garbage collected. This is caused by circular references to other objects,
# like a signal that wasn't disconnected. It's not a big deal, but if we
# have objects that can be created and destroyed a lot over the course of
# the app lifecycle, every non-garbage collected class is a memory leak.
# So it's nice to poke at this every now and then and try to track down
# what we need to add to class _cleanup handling.
parser.add_argument("--test-leak-debug",
help=argparse.SUPPRESS, action="store_true")
# comma separated string of options to tweak app behavior,
# for manual and automated testing config
parser.add_argument("--test-options", help=argparse.SUPPRESS)
parser.add_argument("--test-options", action='append',
default=[], help=argparse.SUPPRESS)
parser.add_argument("-c", "--connect", dest="uri",
help="Connect to hypervisor at URI", metavar="URI")
@ -185,46 +176,6 @@ def parse_commandline():
return parser.parse_known_args()
class CLITestOptionsClass:
"""
Helper class for parsing and tracking --test-* options
"""
def __init__(self, test_options_str):
opts = []
if test_options_str:
opts = test_options_str.split(",")
def _get(optname):
if optname not in opts:
return False
opts.remove(optname)
return True
def _get_value(optname):
for opt in opts:
if opt.startswith(optname + "="):
opts.remove(opt)
return opt.split("=", 1)[1]
self.first_run = _get("first-run")
self.leak_debug = _get("leak-debug")
self.no_events = _get("no-events")
self.xmleditor_enabled = _get("xmleditor-enabled")
self.gsettings_keyfile = _get_value("gsettings-keyfile")
self.break_setfacl = _get("break-setfacl")
if opts:
print("Unknown --test-options keys: %s" % opts)
sys.exit(1)
if self.first_run and not self.gsettings_keyfile:
import atexit
import tempfile
filename = tempfile.mktemp(prefix="virtmanager-firstrun-keyfile")
self.gsettings_keyfile = filename
atexit.register(lambda: os.unlink(filename))
def main():
(options, leftovers) = parse_commandline()
@ -244,21 +195,8 @@ def main():
mainloop=(options.trace_libvirt == "mainloop"),
regex=None)
CLITestOptions = CLITestOptionsClass(options.test_options)
if options.test_first_run:
CLITestOptions.first_run = True
if options.test_leak_debug:
CLITestOptions.leak_debug = True
if options.test_no_events:
CLITestOptions.no_events = True
if CLITestOptions.break_setfacl:
import virtinst.diskbackend
def fake_search(*args, **kwargs):
raise RuntimeError("Fake search fix fail from test suite")
virtinst.diskbackend.SETFACL = "getfacl"
# pylint: disable=protected-access
virtinst.diskbackend._fix_perms_chmod = fake_search
CLITestOptions = CLITestOptionsClass(options.test_options,
options.test_first_run)
# With F27 gnome+wayland we need to set these before GTK import
os.environ["GSETTINGS_SCHEMA_DIR"] = BuildConfig.gsettings_dir