WIP answerfile generation

This process has several steps:
- building of a data structure holding all of the answerfile data,
  from a customizable base in data.py and from tests-specific items
- serialization as XML to be read by host-installer
- necessary changes to the ISO for host-installer to use it

This is needed so:
- different tests can use different parameters without the need for
  provisionning every answerfile to be used
- tests can dynamically add contents for their own needs, before the
  XML gets actualy written

FIXME:
- this covers boot from remastered ISO and not PXE, install on UEFI/NVMe disk (xml needs generation there too) and not BIOS/ATA (needs clever parametrization)
- doc

Author: ydirson

data.py-dist

@@ -5,6 +5,7 @@
 # You need to have an SSH key into the hosts' /root/.ssh/authorized_keys.
 HOST_DEFAULT_USER = "root"
 HOST_DEFAULT_PASSWORD = ""
+HOST_DEFAULT_PASSWORD_HASH = "" # FIXME
 
 # Public key for a private key available to the test runner
 TEST_SSH_PUBKEY = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDKz9uQOoxq6Q0SQ0XTzQHhDolvuo/7EyrDZsYQbRELhcPJG8MT/o5u3HyJFhIP2+HqBSXXgmqRPJUkwz9wUwb2sUwf44qZm/pyPUWOoxyVtrDXzokU/uiaNKUMhbnfaXMz6Ogovtjua63qld2+ZRXnIgrVtYKtYBeu/qKGVSnf4FTOUKl1w3uKkr59IUwwAO8ay3wVnxXIHI/iJgq6JBgQNHbn3C/SpYU++nqL9G7dMyqGD36QPFuqH/cayL8TjNZ67TgAzsPX8OvmRSqjrv3KFbeSlpS/R4enHkSemhgfc8Z2f49tE7qxWZ6x4Uyp5E6ur37FsRf/tEtKIUJGMRXN XCP-ng CI"
@@ -119,6 +120,16 @@ LVMOISCSI_DEVICE_CONFIG = {
 #    'SCSIid': 'id'
 }
 
+BASE_ANSWERFILES = dict(
+    INSTALL={
+        "root": {"tag": "installation"},
+        "root-password": {"type": "hash", "text": HOST_DEFAULT_PASSWORD_HASH},
+        "admin-interface": {"name": "eth0", "proto": "dhcp"},
+        "timezone": {"text": "Europe/Paris"},
+        "keymap": {"text": "us"},
+    },
+)
+
 # compatibility settings for older tests
 DEFAULT_NFS_DEVICE_CONFIG = NFS_DEVICE_CONFIG
 DEFAULT_NFS4_DEVICE_CONFIG = NFS4_DEVICE_CONFIG

pytest.ini

@@ -23,6 +23,7 @@ markers =
     vm_definitions: dicts of VM defs for create_vms fixture.
 
     # * installation-related markers to customize installer run
+    answerfile: dict defining an answerfile
     installer_iso: key of data.ISO_IMAGES identifying an installer ISO
 
     # * Test targets related to VMs

tests/install/conftest.py

@@ -1,16 +1,52 @@
+from copy import deepcopy
 import logging
 import os
 import pytest
 import tempfile
 
 from lib.commands import local_cmd, scp, ssh
 
+@pytest.fixture(scope='function')
+def answerfile(request):
+    marker = request.node.get_closest_marker("answerfile")
+
+    if marker is None:
+        yield None              # no answerfile to generate
+        return
+
+    # construct answerfile definition from option "base", and explicit bits
+    marker_def = deepcopy(marker.args[0])
+    if "base" in marker_def:
+        from data import BASE_ANSWERFILES
+        answerfile_def = deepcopy(BASE_ANSWERFILES[marker_def["base"]])
+        del marker_def["base"]
+    else:
+        answerfile_def = {}
+    answerfile_def.update(marker_def)
+
+    # convert to a ElementTree.Element tree suitable for further
+    # modification before we serialize it to XML
+    import xml.etree.ElementTree as ET
+
+    # root element special case
+    root_def = answerfile_def.pop("root")
+    root_tag = root_def.pop("tag")
+    root = ET.Element(root_tag, **root_def)
+
+    # contents of root element
+    for name, defn in answerfile_def.items():
+        text = defn.pop("text", None)
+        element = ET.SubElement(root, name, **defn)
+        if text:
+            element.text = text
+
+    yield ET.ElementTree(root)
+
 @pytest.fixture(scope='function')
 def iso_remaster(request, answerfile):
     marker = request.node.get_closest_marker("installer_iso")
     assert marker is not None, "iso_remaster fixture requires 'installer_iso' marker"
     iso_key = marker.args[0]
-    ANSWERFILE_URL = "http://pxe/configs/custom/ydi/install-8.2-uefi-iso-ext.xml" # FIXME
 
     from data import ISO_IMAGES, ISOSR_SRV, ISOSR_PATH, TEST_SSH_PUBKEY, TOOLS
     assert "iso-remaster" in TOOLS
@@ -24,6 +60,13 @@ def iso_remaster(request, answerfile):
         remastered_iso = os.path.join(isotmp, "image.iso")
         iso_patcher_script = os.path.join(isotmp, "iso-patcher")
         img_patcher_script = os.path.join(isotmp, "img-patcher")
+        answerfile_xml = os.path.join(isotmp, "answerfile.xml")
+
+        if answerfile:
+            logging.info("generating answerfile %s", answerfile_xml)
+            answerfile.write(answerfile_xml)
+        else:
+            logging.info("no answerfile")
 
         logging.info("Remastering %s to %s", SOURCE_ISO, remastered_iso)
 
@@ -36,7 +79,8 @@ def iso_remaster(request, answerfile):
 mkdir -p "$INSTALLIMG/root/.ssh"
 echo "{TEST_SSH_PUBKEY}" > "$INSTALLIMG/root/.ssh/authorized_keys"
 
-curl {ANSWERFILE_URL} -o "$INSTALLIMG/root/answerfile.xml"
+test ! -e "{answerfile_xml}" ||
+    cp "{answerfile_xml}" "$INSTALLIMG/root/answerfile.xml"
 """,
                   file=patcher_fd)
             os.chmod(patcher_fd.fileno(), 0o755)
@@ -47,8 +91,9 @@ def iso_remaster(request, answerfile):
             print(f"""#!/bin/bash
 set -ex
 ISODIR="$1"
-SED_COMMANDS=(-e "s@/vmlinuz@/vmlinuz sshpassword={passwd} atexit=shell@")
-SED_COMMANDS+=(-e "s@/vmlinuz@/vmlinuz install answerfile=file:///root/answerfile.xml network_device=all@")
+SED_COMMANDS=(-e "s@/vmlinuz@/vmlinuz sshpassword={passwd} atexit=shell network_device=all@")
+test ! -e "{answerfile_xml}" ||
+    SED_COMMANDS+=(-e "s@/vmlinuz@/vmlinuz install answerfile=file:///root/answerfile.xml@")
 
 sed -i "${{SED_COMMANDS[@]}}" \
     "$ISODIR"/*/*/grub*.cfg \

tests/install/test.py

@@ -25,6 +25,12 @@ class TestNested:
              vdis=[dict(name="vm 1 system disk", size="100GiB", device="xvda", userdevice="0")],
              vifs=[dict(index=0, network_uuid="eabc1038-e40f-2ae5-0781-a3adbec1cae8")], # FIXME
              ))
+    @pytest.mark.answerfile(
+        {
+            "base": "INSTALL",
+            "source": {"type": "local"},
+            "primary-disk": {"text": "nvme0n1"},
+        })
     @pytest.mark.installer_iso("xcpng-8.2.1-2023")
     def test_install_821_uefi(self, iso_remaster, create_vms):
         assert len(create_vms) == 1

tests/install/test_fixtures.py

@@ -0,0 +1,21 @@
+import logging
+import pytest
+
+class TestFixtures:
+    # test the answerfile fixture can run on 2 parametrized instances
+    # of the test in one run
+    @pytest.mark.answerfile(
+        {
+            "base": "INSTALL",
+            "source": {"type": "local"},
+            "primary-disk": {"text": "nvme0n1"},
+        })
+    @pytest.mark.parametrize("parm", [
+        1,
+        pytest.param(2, marks=[
+            pytest.mark.dependency(depends=["TestFixtures::test_parametrized_answerfile[1]"]),
+        ]),
+    ])
+    @pytest.mark.dependency
+    def test_parametrized_answerfile(self, answerfile, parm):
+        logging.debug("test_parametrized_answerfile with parm=%s", parm)