Merge pull request #415 from xcp-ng/ohu/xcpng-539/001

ohu/xcpng/001 - Tools - adds update scenario

Author: olivierh-pro

lib/tools/__init__.py

@@ -0,0 +1,13 @@
+"""Tools for automation.
+
+This sub package is intended for scripting and automation tasks.
+Code is sometimes too long to be written as a standalone script
+(e.g. like ``scripts`` directory in root project).
+"""
+
+import logging
+
+logger = logging.getLogger()
+logging.basicConfig(
+    format="%(asctime)s.%(msecs)03d %(levelname)s %(message)s", datefmt="%b %d %H:%M:%S", level=logging.INFO
+)

lib/tools/tasks/__init__.py

@@ -0,0 +1,5 @@
+"""Tasks
+
+Tasks are actions performed on a remote target. Perhaps, it could be done on local targets too.
+Tasks can be used before and after running xcp-ng tests suite.
+"""

lib/tools/tasks/update.py

@@ -0,0 +1,51 @@
+"""Update tasks.
+
+This module is intended for performing update actions on existing remote targets.
+"""
+from concurrent.futures import ThreadPoolExecutor
+
+from lib.common import HostAddress
+from lib.host import Host
+from lib.pool import Pool
+
+from .. import logger
+
+def update_all(master_hosts: list[HostAddress], enablerepos: list[str]) -> None:
+    """Updates all master (primary) hosts.
+
+    .. note:: Host must be a master
+
+        Throws error if hosts are not master (primary).
+
+    :param :py:class:`list[lib.common.HostAddress]` master_hosts:
+        A list of hosts to update.
+    :param list[str] enablerepos:
+        Repositories to enable when updating.
+    """
+    logger.debug(f"[{master_hosts}] enablerepos: {enablerepos}")
+    # init related pools
+    pools = [Pool(h) for h in master_hosts]
+
+    with ThreadPoolExecutor() as executor:
+        for p in pools:
+            executor.submit(update_host, p.master, enablerepos)
+
+
+def update_host(host: Host, enablerepos: list[str] = []):
+    """Updates the target host.
+
+    An helper function that wraps update tasks on specific host.
+
+    :param :py:class:`lib.host.Host` host:
+        Target host to update.
+    :param list[str] enablerepos:
+        Repositories to enable when updating.
+    """
+    logger.info(f"[{host}] Updating...")
+
+    host.yum_clean_metadata()
+    host.yum_update(enablerepos=enablerepos)
+    # Everything's ok, just reboot
+    host.reboot(verify=True)
+
+    logger.info(f"[{host}] Updated successfully!")