Skip to content

Commit 561183f

Browse files
Zuulopenstack-gerrit
Zuul
authored and
openstack-gerrit
committed
Merge "libvirt: Remove support for '[libvirt] use_usb_tablet'"
2 parents 17c00fe + 5b0343d commit 561183f

File tree

5 files changed

+33
-96
lines changed

5 files changed

+33
-96
lines changed

‎nova/conf/libvirt.py

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -218,26 +218,6 @@
218218
config option. A more verbose output will help in debugging issues.
219219
* ``virt_type``: If you use ``lxc`` as virt_type it will be treated as a
220220
single partition image
221-
"""),
222-
cfg.BoolOpt('use_usb_tablet',
223-
default=True,
224-
deprecated_for_removal=True,
225-
deprecated_reason="This option is being replaced by the "
226-
"'pointer_model' option.",
227-
deprecated_since='14.0.0',
228-
help="""
229-
Enable a mouse cursor within a graphical VNC or SPICE sessions.
230-
231-
This will only be taken into account if the VM is fully virtualized and VNC
232-
and/or SPICE is enabled. If the node doesn't support a graphical framebuffer,
233-
then it is valid to set this to False.
234-
235-
Related options:
236-
237-
* ``[vnc]enabled``: If VNC is enabled, ``use_usb_tablet`` will have an effect.
238-
* ``[spice]enabled`` + ``[spice].agent_enabled``: If SPICE is enabled and the
239-
spice agent is disabled, the config value of ``use_usb_tablet`` will have
240-
an effect.
241221
"""),
242222
cfg.StrOpt('live_migration_scheme',
243223
help="""

‎nova/tests/functional/regressions/test_bug_1595962.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ def setUp(self):
5757
self.flags(enabled=True, group="serial_console")
5858
self.flags(enabled=False, group="vnc")
5959
self.flags(enabled=False, group="spice")
60-
self.flags(use_usb_tablet=False, group="libvirt")
6160

6261
self.start_service('conductor')
6362
self.start_service('scheduler')

‎nova/tests/unit/virt/libvirt/test_driver.py

Lines changed: 21 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -5653,10 +5653,9 @@ def test_get_guest_config_with_vnc(self):
56535653

56545654
def test_get_guest_config_with_vnc_and_tablet(self):
56555655
self.flags(enabled=True, group='vnc')
5656-
self.flags(virt_type='kvm',
5657-
use_usb_tablet=True,
5658-
group='libvirt')
5656+
self.flags(virt_type='kvm', group='libvirt')
56595657
self.flags(enabled=False, group='spice')
5658+
self.flags(pointer_model='usbtablet')
56605659

56615660
cfg = self._get_guest_config_with_graphics()
56625661

@@ -5685,13 +5684,12 @@ def test_get_guest_config_with_vnc_and_tablet(self):
56855684

56865685
def test_get_guest_config_with_spice_and_tablet(self):
56875686
self.flags(enabled=False, group='vnc')
5688-
self.flags(virt_type='kvm',
5689-
use_usb_tablet=True,
5690-
group='libvirt')
5687+
self.flags(virt_type='kvm', group='libvirt')
56915688
self.flags(enabled=True,
56925689
agent_enabled=False,
56935690
server_listen='10.0.0.1',
56945691
group='spice')
5692+
self.flags(pointer_model='usbtablet')
56955693

56965694
cfg = self._get_guest_config_with_graphics()
56975695

@@ -5722,12 +5720,9 @@ def test_get_guest_config_with_spice_and_tablet(self):
57225720

57235721
def test_get_guest_config_with_spice_and_agent(self):
57245722
self.flags(enabled=False, group='vnc')
5725-
self.flags(virt_type='kvm',
5726-
use_usb_tablet=True,
5727-
group='libvirt')
5728-
self.flags(enabled=True,
5729-
agent_enabled=True,
5730-
group='spice')
5723+
self.flags(virt_type='kvm', group='libvirt')
5724+
self.flags(enabled=True, agent_enabled=True, group='spice')
5725+
self.flags(pointer_model='usbtablet')
57315726

57325727
cfg = self._get_guest_config_with_graphics()
57335728

@@ -6166,11 +6161,8 @@ def _test_get_scsi_controller_next_unit_from_guest(self, xml,
61666161

61676162
def test_get_guest_config_with_type_xen(self):
61686163
self.flags(enabled=True, group='vnc')
6169-
self.flags(virt_type='xen',
6170-
use_usb_tablet=False,
6171-
group='libvirt')
6172-
self.flags(enabled=False,
6173-
group='spice')
6164+
self.flags(virt_type='xen', group='libvirt')
6165+
self.flags(enabled=False, group='spice')
61746166

61756167
drvr = libvirt_driver.LibvirtDriver(fake.FakeVirtAPI(), True)
61766168
instance_ref = objects.Instance(**self.test_instance)
@@ -6204,9 +6196,7 @@ def test_get_guest_config_with_type_xen(self):
62046196
return_value=fields.Architecture.S390X)
62056197
def test_get_guest_config_with_type_kvm_on_s390(self, mock_get_arch):
62066198
self.flags(enabled=False, group='vnc')
6207-
self.flags(virt_type='kvm',
6208-
use_usb_tablet=False,
6209-
group='libvirt')
6199+
self.flags(virt_type='kvm', group='libvirt')
62106200

62116201
self._stub_host_capabilities_cpu_arch(fields.Architecture.S390X)
62126202

@@ -6249,11 +6239,8 @@ def _get_guest_config_via_fake_api(self, instance):
62496239

62506240
def test_get_guest_config_with_type_xen_pae_hvm(self):
62516241
self.flags(enabled=True, group='vnc')
6252-
self.flags(virt_type='xen',
6253-
use_usb_tablet=False,
6254-
group='libvirt')
6255-
self.flags(enabled=False,
6256-
group='spice')
6242+
self.flags(virt_type='xen', group='libvirt')
6243+
self.flags(enabled=False, group='spice')
62576244

62586245
drvr = libvirt_driver.LibvirtDriver(fake.FakeVirtAPI(), True)
62596246
instance_ref = objects.Instance(**self.test_instance)
@@ -6279,11 +6266,8 @@ def test_get_guest_config_with_type_xen_pae_hvm(self):
62796266

62806267
def test_get_guest_config_with_type_xen_pae_pvm(self):
62816268
self.flags(enabled=True, group='vnc')
6282-
self.flags(virt_type='xen',
6283-
use_usb_tablet=False,
6284-
group='libvirt')
6285-
self.flags(enabled=False,
6286-
group='spice')
6269+
self.flags(virt_type='xen', group='libvirt')
6270+
self.flags(enabled=False, group='spice')
62876271

62886272
drvr = libvirt_driver.LibvirtDriver(fake.FakeVirtAPI(), True)
62896273
instance_ref = objects.Instance(**self.test_instance)
@@ -6303,12 +6287,9 @@ def test_get_guest_config_with_type_xen_pae_pvm(self):
63036287

63046288
def test_get_guest_config_with_vnc_and_spice(self):
63056289
self.flags(enabled=True, group='vnc')
6306-
self.flags(virt_type='kvm',
6307-
use_usb_tablet=True,
6308-
group='libvirt')
6309-
self.flags(enabled=True,
6310-
agent_enabled=True,
6311-
group='spice')
6290+
self.flags(virt_type='kvm', group='libvirt')
6291+
self.flags(enabled=True, agent_enabled=True, group='spice')
6292+
self.flags(pointer_model='usbtablet')
63126293

63136294
drvr = libvirt_driver.LibvirtDriver(fake.FakeVirtAPI(), True)
63146295
instance_ref = objects.Instance(**self.test_instance)
@@ -6404,7 +6385,7 @@ def test_use_ps2_mouse(self):
64046385
self.assertIsNone(tablet)
64056386

64066387
def test_get_guest_usb_tablet_wipe(self):
6407-
self.flags(use_usb_tablet=True, group='libvirt')
6388+
self.flags(pointer_model='usbtablet')
64086389

64096390
tablet = self._test_get_guest_usb_tablet(
64106391
True, True, fields.VMMode.HVM)
@@ -6431,7 +6412,7 @@ def test_get_guest_usb_tablet_wipe(self):
64316412
self.assertIsNone(tablet)
64326413

64336414
def test_get_guest_usb_tablet_image_meta(self):
6434-
self.flags(use_usb_tablet=True, group='libvirt')
6415+
self.flags(pointer_model='usbtablet')
64356416
image_meta = {"properties": {"hw_pointer_model": "usbtablet"}}
64366417

64376418
tablet = self._test_get_guest_usb_tablet(
@@ -6459,7 +6440,6 @@ def test_get_guest_usb_tablet_image_meta(self):
64596440
self.assertIsNone(tablet)
64606441

64616442
def test_get_guest_usb_tablet_image_meta_no_vnc(self):
6462-
self.flags(use_usb_tablet=False, group='libvirt')
64636443
self.flags(pointer_model=None)
64646444

64656445
image_meta = {"properties": {"hw_pointer_model": "usbtablet"}}
@@ -6468,22 +6448,7 @@ def test_get_guest_usb_tablet_image_meta_no_vnc(self):
64686448
self._test_get_guest_usb_tablet,
64696449
False, False, fields.VMMode.HVM, True, image_meta=image_meta)
64706450

6471-
def test_get_guest_no_pointer_model_usb_tablet_set(self):
6472-
self.flags(use_usb_tablet=True, group='libvirt')
6473-
self.flags(pointer_model=None)
6474-
6475-
tablet = self._test_get_guest_usb_tablet(True, True, fields.VMMode.HVM)
6476-
self.assertIsNotNone(tablet)
6477-
6478-
def test_get_guest_no_pointer_model_usb_tablet_not_set(self):
6479-
self.flags(use_usb_tablet=False, group='libvirt')
6480-
self.flags(pointer_model=None)
6481-
6482-
tablet = self._test_get_guest_usb_tablet(True, True, fields.VMMode.HVM)
6483-
self.assertIsNone(tablet)
6484-
64856451
def test_get_guest_pointer_model_usb_tablet(self):
6486-
self.flags(use_usb_tablet=False, group='libvirt')
64876452
self.flags(pointer_model='usbtablet')
64886453
tablet = self._test_get_guest_usb_tablet(True, True, fields.VMMode.HVM)
64896454
self.assertIsNotNone(tablet)
@@ -6496,7 +6461,6 @@ def test_get_guest_pointer_model_usb_tablet_image(self):
64966461

64976462
def test_get_guest_pointer_model_usb_tablet_image_no_HVM(self):
64986463
self.flags(pointer_model=None)
6499-
self.flags(use_usb_tablet=False, group='libvirt')
65006464
image_meta = {"properties": {"hw_pointer_model": "usbtablet"}}
65016465
self.assertRaises(
65026466
exception.UnsupportedPointerModelRequested,
@@ -7100,10 +7064,8 @@ def test_get_guest_config_with_rng_backend(self, mock_path):
71007064

71017065
@mock.patch('nova.virt.libvirt.driver.os.path.exists')
71027066
def test_get_guest_config_with_rng_dev_not_present(self, mock_path):
7103-
self.flags(virt_type='kvm',
7104-
use_usb_tablet=False,
7105-
rng_dev_path='/dev/hw_rng',
7106-
group='libvirt')
7067+
self.flags(
7068+
virt_type='kvm', rng_dev_path='/dev/hw_rng', group='libvirt')
71077069
mock_path.return_value = False
71087070

71097071
drvr = libvirt_driver.LibvirtDriver(fake.FakeVirtAPI(), True)

‎nova/virt/libvirt/driver.py

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6398,16 +6398,6 @@ def _guest_add_video_device(guest):
63986398
def _get_guest_pointer_model(self, os_type, image_meta):
63996399
pointer_model = image_meta.properties.get(
64006400
'hw_pointer_model', CONF.pointer_model)
6401-
if pointer_model is None and CONF.libvirt.use_usb_tablet:
6402-
# TODO(sahid): We set pointer_model to keep compatibility
6403-
# until the next release O*. It means operators can continue
6404-
# to use the deprecated option "use_usb_tablet" or set a
6405-
# specific device to use
6406-
pointer_model = "usbtablet"
6407-
LOG.warning('The option "use_usb_tablet" has been '
6408-
'deprecated for Newton in favor of the more '
6409-
'generic "pointer_model". Please update '
6410-
'nova.conf to address this change.')
64116401

64126402
if pointer_model == "usbtablet":
64136403
# We want a tablet if VNC is enabled, or SPICE is enabled and
@@ -6418,7 +6408,7 @@ def _get_guest_pointer_model(self, os_type, image_meta):
64186408
CONF.spice.enabled and not CONF.spice.agent_enabled):
64196409
return self._get_guest_usb_tablet(os_type)
64206410
else:
6421-
if CONF.pointer_model or CONF.libvirt.use_usb_tablet:
6411+
if CONF.pointer_model:
64226412
# For backward compatibility We don't want to break
64236413
# process of booting an instance if host is configured
64246414
# to use USB tablet without VNC or SPICE and SPICE
@@ -6438,14 +6428,14 @@ def _get_guest_usb_tablet(self, os_type):
64386428
tablet.type = "tablet"
64396429
tablet.bus = "usb"
64406430
else:
6441-
if CONF.pointer_model or CONF.libvirt.use_usb_tablet:
6431+
if CONF.pointer_model:
64426432
# For backward compatibility We don't want to break
64436433
# process of booting an instance if virtual machine mode
64446434
# is not configured as HVM.
6445-
LOG.warning('USB tablet requested for guests by host '
6446-
'configuration. In order to accept this '
6447-
'request the machine mode should be '
6448-
'configured as HVM.')
6435+
LOG.warning(
6436+
'USB tablet requested for guests by host configuration. '
6437+
'In order to accept this request the machine mode should '
6438+
'be configured as HVM.')
64496439
else:
64506440
raise exception.UnsupportedPointerModelRequested(
64516441
model="usbtablet")

‎releasenotes/notes/remove-deprecated-libvirt-use_usb_tablet-opt-b01058905240b8ce.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
upgrade:
3+
- |
4+
The ``[libvirt] use_usb_tablet`` config option, which was first deprecated
5+
in the 14.0.0 (Newton) release, has now been removed. It has been replaced
6+
by the ``[DEFAULT] pointer_model`` config option.

0 commit comments

Comments
 (0)