tools/inventory: move hosts into subkey hosts

To prepare the snapshot creation and the new data
in inventory at root level, every host must be
moved into a subkey 'hosts'

Signed-off-by: Olivier Hoareau <olivier.hoareau@vates.tech>

Author: olivierh-pro

README.md

@@ -618,6 +618,6 @@ enablerepos = ["xcp-ng-updates"]
 > Config values under `servers` override values under `all`. For instance, the above inventory would produce
 > the following python dict:
 >
-> `{'ip_or_hostname-1': {'enablerepos': ['xcp-ng-base']}, 'ip_or_hostname-2': {'enablerepos': ['xcp-ng-updates']}}`
+> `{'hosts': {'ip_or_hostname-1': {'enablerepos': ['xcp-ng-base']}, 'ip_or_hostname-2': {'enablerepos': ['xcp-ng-updates']}}}`
 >
 > Using *enablerepo flag* `-e` with inventory is still possible, it won't be used though.

lib/tools/inventory.py

@@ -13,36 +13,41 @@ class Server(TypedDict):
     enablerepos: list[str]
 
 
-Inventory: TypeAlias = dict[HostAddress, Server]
+Servers: TypeAlias = dict[HostAddress, Server]
+
+class Inventory(TypedDict):
+    hosts: Servers
 
 
 def load_inventory(inventory_path: Path) -> Inventory:
     """Create an inventory object from loaded inventory file."""
-    inventory: Inventory = {}
-
     with open(inventory_path, "rb") as f:
         data = tomllib.load(f)
 
     all = data.get("all", {})
     servers = data.get("servers", [])
 
+    inventory_hosts: Servers = {}
     for server, config in servers.items():
         repos = config.get("enablerepos", [])
         host: Server = {"enablerepos": repos or all.get("enablerepos", [])}
-        inventory[server] = host
+        inventory_hosts[server] = host
 
-    return inventory
+    return {
+        "hosts": inventory_hosts,
+    }
 
 
 def into_inventory(hosts: list[HostAddress], enablerepos: list[str]) -> Inventory:
     """Create an inventory object from arguments.
 
     Basically, it is used as compatibility when we don't want inventory from file.
     """
-    inventory: Inventory = {}
-
+    inventory_hosts: Servers = {}
     for h in hosts:
         host: Server = {"enablerepos": enablerepos or []}
-        inventory[h] = host
+        inventory_hosts[h] = host
 
-    return inventory
+    return {
+        "hosts": inventory_hosts,
+    }

lib/tools/tasks/update.py

@@ -7,10 +7,11 @@
 from concurrent.futures import ThreadPoolExecutor
 
 from lib.pool import NotAMasterHostError, Pool
+from lib.tools.inventory import Inventory
 
 from .. import logger
 
-def update_pools(inventory: dict) -> None:
+def update_pools(inventory: Inventory) -> None:
     """Updates hosts in pool(s).
 
     .. note::
@@ -23,24 +24,25 @@ def update_pools(inventory: dict) -> None:
         Each host (key) holds its own config data (values, eg: `enablerepos`).
     """
     logger.debug(f"Inventory: {inventory}")
+    inventory_hosts = inventory["hosts"]
     # init related pools
-    pools = []
-    for h in inventory:
+    pools: list[Pool] = []
+    for host in inventory_hosts:
         try:
-            p = Pool(h)
+            p = Pool(host)
             pools.append(p)
         except NotAMasterHostError:
-            logger.warning(f"[{h}] Skipping: not a master host")
+            logger.warning(f"[{host}] Skipping: not a master host")
 
     with ThreadPoolExecutor() as executor:
         for p in pools:
-            executor.submit(p.master.update, inventory[p.master.hostname_or_ip]["enablerepos"])
+            executor.submit(p.master.update, inventory_hosts[p.master.hostname_or_ip]["enablerepos"])
 
     # secondary hosts
     with ThreadPoolExecutor() as executor:
         for p in pools:
             # omit first item because it is a primary (master)
-            for h in p.hosts[1:]:
+            for secondary in p.hosts[1:]:
                 # repos are the same as the primary (master)
-                repos = inventory[p.master.hostname_or_ip]["enablerepos"]
-                executor.submit(h.update, repos)
+                repos = inventory_hosts[p.master.hostname_or_ip]["enablerepos"]
+                executor.submit(secondary.update, repos)