Merge pull request #417 from xcp-ng/ohu/xcpng-539/002

Tools - Add CLI for using update scripts

Author: olivierh-pro

README.md

@@ -555,3 +555,26 @@ INFO:root:Setting bridge to xenbr0
 ```
 
 For more details, see `xva_bridge.py --help`.
+
+## Tools
+
+Helper tools are available through the entrypoint `scripts/tools.py`:
+
+```bash
+uv run scripts/tools.py -h
+```
+
+### Update
+
+This command performs an update operation on remote targets.
+
+```bash
+uv run scripts/tools.py update primary1 primary2
+```
+
+For each primary target :
+
+1. Clean cached metadata
+2. Update with repository manager (yum): Optionally enables repositories
+3. Reboot
+4. Get attached secondary hosts and repeats three previous steps for each secondary

lib/tools/cli.py

@@ -0,0 +1,47 @@
+"""CLI Entrypoint
+
+The main entrypoint for running tools script.
+"""
+import argparse
+import logging
+
+from lib.common import HostAddress
+from lib.tools import logger
+from lib.tools.tasks.update import update_all
+
+def _command_update(args):
+    update_all(args.hosts, args.repos)
+
+
+def cli():
+    parser = argparse.ArgumentParser(
+        description="Tools that help developers for running recurrent tasks on their XCP-ng sandbox."
+    )
+    parser.add_argument("-d", "--debug", action="store_true", default=False, help="Enable debug level")
+
+    subparsers = parser.add_subparsers(required=True, metavar="COMMAND")
+
+    # subparser - command: update
+    subparser_cmd_update = subparsers.add_parser(
+        name="update",
+        description="Run update tasks on target(s)",
+        help="Run update tasks on target(s)",
+    )
+    subparser_cmd_update.add_argument(
+        "hosts", type=HostAddress, metavar="HOST", nargs="+", help="Hostname(s) or ip address(es) of target(s)"
+    )
+    subparser_cmd_update.add_argument(
+        "--enablerepo",
+        metavar="REPO",
+        action="append",
+        dest="repos",
+        help="repositories to enable when updating",
+    )
+    subparser_cmd_update.set_defaults(func=_command_update)
+
+    args = parser.parse_args()
+
+    if args.debug:
+        logger.setLevel(logging.DEBUG)
+
+    args.func(args)

scripts/tools.py

@@ -0,0 +1,13 @@
+"""Just a wrapper to run cli tools package.
+"""
+import sys
+from pathlib import Path
+
+# Add root project directory into PYTHONPATH
+sys.path.append(str(Path(__file__).absolute().parent.parent))
+
+# flake8: noqa: E402 module level import not at top of file
+from lib.tools.cli import cli
+
+if __name__ == "__main__":
+    cli()