tests: work around malformed serial XML

The serial elements in fakelibvirt's XMLDesc() are malformed. They are
only enough to pass existing unit tests, but are not future-proof, and
would not work with something like migration._update_serial_xml(). In
addition, two of them (type=file and type=pty) are not actually used by
anything.

This patch removes the unused types and starts checking the
CONF.serial_console.enabled flag before including any serial XML in
the fake domain. This allows tests that don't set
serial_console_enabled (like the subsequent NUMA LM func test) to not
have to deal with the broken serial XML, while tests that relied on it
in the past now just set serial_console_enabled = True.

Change-Id: Ie74fcd689a627c178f80ec60df2dfef40576f182

Author: notartom

nova/tests/unit/virt/libvirt/fakelibvirt.py

@@ -21,6 +21,7 @@
 from oslo_log import log as logging
 from oslo_utils.fixture import uuidsentinel as uuids
 
+from nova import conf
 from nova.objects import fields as obj_fields
 from nova.tests.unit.virt.libvirt import fake_libvirt_data
 from nova.virt.libvirt import config as vconfig
@@ -40,6 +41,7 @@ def _reset():
 
 
 LOG = logging.getLogger(__name__)
+CONF = conf.CONF
 
 # virDomainState
 VIR_DOMAIN_NOSTATE = 0
@@ -1066,6 +1068,12 @@ def XMLDesc(self, flags):
     </memory>
             ''' % vpmem
 
+        serial_console = ''
+        if CONF.serial_console.enabled:
+            serial_console = """<serial type="tcp">
+                <source host="-1" service="-1" mode="bind"/>
+                </serial>"""
+
         return '''<domain type='kvm'>
   <name>%(name)s</name>
   <uuid>%(uuid)s</uuid>
@@ -1093,17 +1101,7 @@ def XMLDesc(self, flags):
                function='0x1'/>
     </controller>
     %(nics)s
-    <serial type='file'>
-      <source path='dummy.log'/>
-      <target port='0'/>
-    </serial>
-    <serial type='pty'>
-      <source pty='/dev/pts/27'/>
-      <target port='1'/>
-    </serial>
-    <serial type='tcp'>
-      <source host="-1" service="-1" mode="bind"/>
-    </serial>
+    %(serial_console)s
     <console type='file'>
       <source path='dummy.log'/>
       <target port='0'/>
@@ -1132,7 +1130,8 @@ def XMLDesc(self, flags):
                 'disks': disks,
                 'nics': nics,
                 'hostdevs': hostdevs,
-                'vpmems': vpmems}
+                'vpmems': vpmems,
+                'serial_console': serial_console}
 
     def managedSave(self, flags):
         self._connection._mark_not_running(self)

nova/tests/unit/virt/test_virt_drivers.py

@@ -572,6 +572,7 @@ def test_get_rdp_console(self):
 
     @catch_notimplementederror
     def test_get_serial_console(self):
+        self.flags(enabled=True, group='serial_console')
         instance_ref, network_info = self._get_running_instance()
         serial_console = self.connection.get_serial_console(self.ctxt,
                                                             instance_ref)