virt-install: Add more flexible --soundhw option, deprecate --sound

Author: crobinso

man/en/virt-install.pod.in

@@ -573,10 +573,15 @@ PCI device (via lspci).
 
 =back
 
-=item --sound
+=item --soundhw MODEL
 
-Attach a virtual audio device to the guest. The device model will be AC97
-if the hypervisor supports it, otherwise will be ES1370
+Attach a virtual audio device to the guest. MODEL specifies the emulated
+sound card model. Possible values are ac97, es1370, sb16, pcspk, or default.
+'default' willl be AC97 if the hypervisor supports it, otherwise it will be
+ES1370.
+
+This deprecates the old boolean --sound model (which still works the same
+as a single '--soundhw default')
 
 =item --watchdog MODEL[,action=ACTION]
 

tests/clitest.py

@@ -360,19 +360,25 @@
         "--hvm --nodisks --pxe --description \"foobar & baz\"",
         # HVM windows install with disk
         "--hvm --cdrom %(EXISTIMG2)s --file %(EXISTIMG1)s --os-variant win2k3 --wait 0",
-        # Watchdog dev default
+        # --watchdog dev default
         "--hvm --nodisks --pxe --watchdog default",
-        # Watchdog opts
+        # --watchdog opts
         "--hvm --nodisks --pxe --watchdog ib700,action=pause",
+        # --sound option
+        "--hvm --nodisks --pxe --sound",
+        # --soundhw option
+        "--hvm --nodisks --pxe --soundhw default --soundhw ac97",
       ],
 
       "invalid": [
         # pxe and nonetworks
         "--nodisks --pxe --nonetworks",
         # Colliding name
         "--nodisks --pxe --name test",
-        # Busted watchdog
+        # Busted --watchdog
         "--hvm --nodisks --pxe --watchdog default,action=foobar",
+        # Busted --soundhw
+        "--hvm --nodisks --pxe --soundhw default --soundhw foobar",
       ],
      }, # category "misc"
 

virt-install

@@ -642,14 +642,19 @@ def parse_args():
     devg.add_option("", "--host-device", type="string", dest="hostdevs",
                     action="callback", callback=cli.check_before_append,
                     help=_("Physical host device to attach to the domain."))
-    devg.add_option("", "--sound", action="store_true", dest="sound",
-                    default=False, help=_("Use sound device emulation"))
+    devg.add_option("", "--soundhw", type='string', action="callback",
+                    callback=cli.check_before_append, dest="soundhw",
+                    help=_("Use sound device emulation"))
     devg.add_option("", "--watchdog", type="string", dest="watchdog",
                     action="callback", callback=cli.check_before_append,
                     help=_("Add a watchdog device to the domain."))
     devg.add_option("", "--video", dest="video", type="string",
                     action="callback", callback=cli.check_before_append,
                     help=_("Specify video hardware type."))
+
+    # Deprecated
+    devg.add_option("", "--sound", action="store_true", dest="sound",
+                    default=False, help=optparse.SUPPRESS_HELP)
     parser.add_option_group(devg)
 
     virg = OptionGroup(parser, _("Virtualization Platform Options"))
@@ -787,7 +792,7 @@ def main():
     cli.get_cpuset(options.cpuset, guest.memory, guest, conn)
     if ishvm:
         get_watchdog(options.watchdog, guest)
-        cli.get_sound(options.sound, guest)
+        cli.get_sound(options.sound, options.soundhw, guest)
         get_chardevs(VirtualDevice.VIRTUAL_DEV_SERIAL, options.serials, guest)
         get_chardevs(VirtualDevice.VIRTUAL_DEV_PARALLEL, options.parallels,
                      guest)

virtinst/cli.py

@@ -794,11 +794,18 @@ def get_graphics(vnc, vncport, vnclisten, nographics, sdl, keymap,
 
         guest.graphics_dev.keymap = use_keymap
 
-def get_sound(sound, guest):
+def get_sound(old_sound_bool, sound_opts, guest):
+    if not sound_opts:
+        if old_sound_bool:
+            # Use os default
+            guest.sound_devs.append(VirtualAudio(conn=guest.conn))
+        return
+
+    for model in listify(sound_opts):
+        dev = VirtualAudio(conn=guest.conn)
+        dev.model = model
+        guest.add_device(dev)
 
-    # Use os default
-    if sound:
-        guest.sound_devs.append(VirtualAudio(conn=guest.conn))
 
 def get_hostdevs(hostdevs, guest):
     if not hostdevs: