install 1/n: fixture to create VMs from template

Author: ydirson

conftest.py

@@ -331,6 +331,57 @@ def imported_vm(host, vm_ref):
         logging.info("<< Destroy VM")
         vm.destroy(verify=True)
 
+@pytest.fixture(scope="function")
+def create_vms(request, host):
+    """
+    Returns list of VM objects created from `vm_definitions` marker.
+
+    `vm_definitions` marker test author to specify one or more VMs,
+    using one `dict` per VM.
+
+    Mandatory keys:
+    - `name`: name of the VM to create (str)
+    - `template`: name (or UUID) of template to use (str)
+
+    Example:
+    -------
+    > @pytest.mark.vm_definitions(dict(name="vm 1", template="Other install media"),
+    >                             dict(name="vm 2", template="CentOS 7"))
+    > def test_foo(create_vms):
+    >    ...
+
+    """
+    marker = request.node.get_closest_marker("vm_definitions")
+    if marker is None:
+        raise Exception("No vm_definitions marker specified.")
+    for vm_def in marker.args:
+        assert "name" in vm_def
+        assert "template" in vm_def
+        # FIXME should check for extra args
+
+    try:
+        vms = []
+        for vm_def in marker.args:
+            vm_name = vm_def["name"]
+            vm_template = vm_def["template"]
+
+            logging.info(">> Install VM %r from template %r", vm_name, vm_template)
+
+            vm = host.vm_from_template(vm_name, vm_template)
+
+            vms.append(vm)
+
+        yield vms
+
+    except Exception:
+        logging.error("exception caught...")
+        raise
+
+    finally:
+        for vm in vms:
+            logging.info("<< Destroy VM %s", vm.uuid)
+            vm.destroy(verify=True)
+
 @pytest.fixture(scope="module")
 def running_vm(imported_vm):
     vm = imported_vm

lib/host.py

@@ -244,6 +244,15 @@ def import_vm(self, uri, sr_uuid=None, use_cache=False):
             vm.param_set('name-description', cache_key)
         return vm
 
+    def vm_from_template(self, name, template):
+        params = {
+            "new-name-label": name,
+            "template": template,
+            "sr-uuid": self.main_sr_uuid(),
+        }
+        vm_uuid = self.xe('vm-install', params)
+        return VM(vm_uuid, self)
+
     def pool_has_vm(self, vm_uuid, vm_type='vm'):
         if vm_type == 'snapshot':
             return self.xe('snapshot-list', {'uuid': vm_uuid}, minimal=True) == vm_uuid

pytest.ini

@@ -19,6 +19,9 @@ markers =
     unix_vm: tests that require a unix/linux VM to run.
     windows_vm: tests that require a Windows VM to run.
 
+    # * VM-related markers to give parameters to fixtures
+    vm_definitions: dicts of VM defs for create_vms fixture.
+
     # * Test targets related to VMs
     small_vm: tests that it is enough to run just once, using the smallest possible VM.
     big_vm: tests that it would be good to run with a big VM.

tests/install/__init__.py

@@ -0,0 +1,11 @@
+import logging
+import pytest
+
+class TestNested:
+    @pytest.mark.vm_definitions(
+        dict(name="vm 1",
+             template="Other install media",
+             ))
+    def test_nested_821_uefi(self, create_vms):
+        assert len(create_vms) == 1
+        host_vm = create_vms[0]