cli: change interface to use subcommands

psafont · ydirson · commit 0019fccc96a8 · 2025-09-04T11:00:17.000+02:00
This alineates usage of the tools with the trend from the last 5 years or so, hopefully making it easier to use. The CLI has been split into 3 actions: shell, run and build. They have independent arguments, and they are visible when using --help. It also requires users to specify the development environment or backend that they want to use to complete the action. Currently only container is supported. Examples of commands: - xcp-ng-dev container shell --rm --branch 8.3 - xcp-ng-dev container run --rm --branch 8.3 dune build @check - xcp-ng-dev container build --rm --branch 8.3 ./xapi Signed-off-by: Pau Ruiz Safont <pau.safont@vates.tech>
diff --git a/README.md b/README.md
@@ -86,7 +86,7 @@ git clone https://github.com/xcp-ng-rpms/xapi.git
 # ... Here add your patches ...
 
 # Build.
-xcp-ng-dev -b 8.2 --build-local xapi/ --rm
+xcp-ng-dev container build -b 8.2 --rm xapi/
 ```
 
 **Important switches**
@@ -106,7 +106,7 @@ fully automated.
    `%autopatch` in the `%prep` block; add `BuildRequires: quilt`
 2. let quilt apply them in a 8.3 buildenv (`quilt` in 8.3 is only in EPEL) and get you a shell:
 ```sh
-xcp-ng-dev --rm -b 8.3 -l . --rpmbuild-stage=p -n --enablerepo=epel
+xcp-ng-dev container build --rm -b 8.3 --rpmbuild-stage=p -n --enablerepo=epel .
 ```
 3. ask `quilt` to refresh all your patches (alternatively just the one you want)
 ```sh
@@ -156,5 +156,5 @@ example, if I clone some repos into a directory on my host, say `/work/code/`,
 then I can mount it inside the container as follows:
 
 ```sh
-xcp-ng-dev -b 8.2 -v /work/code:/mnt/repos
+xcp-ng-dev container shell -b 8.2 -v /work/code:/mnt/repos
 ```
diff --git a/src/xcp_ng_dev/cli.py b/src/xcp_ng_dev/cli.py
@@ -37,38 +37,27 @@ def is_podman(runner):
         return True
     return False
 
-def main():
-    """ Main entry point. """
-    parser = argparse.ArgumentParser()
+def add_common_args(parser):
     parser.add_argument('-b', '--branch',
                         help='XCP-ng version: 7.6, %s, etc. If not set, '
                              'will default to %s.' % (DEFAULT_BRANCH, DEFAULT_BRANCH))
-    parser.add_argument('-l', '--build-local',
-                        help="Install dependencies for the spec file(s) found in the SPECS/ subdirectory "
-                             "of the directory passed as parameter, then build the RPM(s). "
-                             "Built RPMs and SRPMs will be in RPMS/ and SRPMS/ subdirectories. "
-                             "Any preexisting BUILD, BUILDROOT, RPMS or SRPMS directories will be removed first. "
-                             "If --output-dir is set, the RPMS and SRPMS directories will be copied to it "
-                             "after the build.")
-    parser.add_argument('--define',
-                        help="Definitions to be passed to rpmbuild (if --build-local is "
-                             "passed too). Example: --define 'xcp_ng_section extras', for building the 'extras' "
-                             "version of a package which exists in both 'base' and 'extras' versions.")
-    parser.add_argument('--rpmbuild-opts', action='append',
-                        help="Pass additional option(s) to rpmbuild")
-    parser.add_argument('--rpmbuild-stage', action='store',
-                        help=f"Request given -bX stage rpmbuild, X in [{RPMBUILD_STAGES}]")
-    parser.add_argument('-o', '--output-dir',
-                        help="Output directory for --build-local.")
     parser.add_argument('-n', '--no-exit', action='store_true',
-                        help='After executing either an automated build or a custom command passed as parameter, '
-                             'drop user into a shell')
+                        help='After finishing the execution of the action, drop user into a shell')
     parser.add_argument('-d', '--dir', action='append',
                         help='Local dir to mount in the '
                         'image. Will be mounted at /external/<dirname>')
     parser.add_argument('-e', '--env', action='append',
                         help='Environment variables passed directly to '
                              f'{RUNNER} -e')
+    parser.add_argument('-a', '--enablerepo',
+                        help='additional repositories to enable before installing build dependencies. '
+                             'Same syntax as yum\'s --enablerepo parameter. Available additional repositories: '
+                             'check files/xcp-ng.repo.*.x.in.')
+    parser.add_argument('--disablerepo',
+                        help='disable repositories. Same syntax as yum\'s --disablerepo parameter. '
+                             'If both --enablerepo and --disablerepo are set, --disablerepo will be applied first')
+
+def add_container_args(parser):
     parser.add_argument('-v', '--volume', action='append',
                         help=f'Volume mounts passed directly to {RUNNER} -v')
     parser.add_argument('--rm', action='store_true',
@@ -78,26 +67,78 @@ def main():
     parser.add_argument('--name', help='Assign a name to the container')
     parser.add_argument('--ulimit', action='append',
                         help=f'Ulimit options passed directly to {RUNNER} run')
-    parser.add_argument('-a', '--enablerepo',
-                        help='additional repositories to enable before installing build dependencies. '
-                             'Same syntax as yum\'s --enablerepo parameter. Available additional repositories: '
-                             'check files/xcp-ng.repo.*.x.in.')
-    parser.add_argument('--disablerepo',
-                        help='disable repositories. Same syntax as yum\'s --disablerepo parameter. '
-                             'If both --enablerepo and --disablerepo are set, --disablerepo will be applied first')
     parser.add_argument('--platform', action='store',
                         help="Override the default platform for the build container. "
                         "Can notably be used to workaround podman bug #6185 fixed in v5.5.1.")
     parser.add_argument('--fail-on-error', action='store_true',
                         help='If container initialisation fails, exit rather than dropping the user '
-                             'into a command shell')
+                             'into a shell')
     parser.add_argument('--debug', action='store_true',
                         help='Enable script tracing in container initialization (sh -x)')
-    parser.add_argument('command', nargs=argparse.REMAINDER,
-                        help='Command to run inside the prepared container')
 
-    args = parser.parse_args(sys.argv[1:])
 
+def buildparser():
+    parser = argparse.ArgumentParser()
+    subparsers_env = parser.add_subparsers(
+        required=True, title="Development environments",
+        help="Available environments")
+
+    # container-based workflow
+    parser_container = subparsers_env.add_parser('container', help="Use a local container to build a package")
+    parser_container.set_defaults(func=container)
+    subparsers_container = parser_container.add_subparsers(
+        dest='action', required=True,
+        help="Actions available for developing packages")
+
+    # build -- build an rpm using a container
+    parser_build = subparsers_container.add_parser(
+        'build',
+        help="Install dependencies for the spec file(s) found in the SPECS/ subdirectory "
+             "of the directory passed as parameter, then build the RPM(s). "
+             "Built RPMs and SRPMs will be in RPMS/ and SRPMS/ subdirectories. "
+             "Any preexisting BUILD, BUILDROOT, RPMS or SRPMS directories will be removed first.")
+    parser_build.add_argument('build_local',
+                              help="Root path where SPECS/ and SOURCES are available")
+    parser_build.add_argument(
+        '--define',
+        help="Definitions to be passed to rpmbuild. Example: --define "
+             "'xcp_ng_section extras', for building the 'extras' "
+             "version of a package which exists in both 'base' and 'extras' versions.")
+    parser_build.add_argument(
+        '-o', '--output-dir',
+        help="Directory where the RPMs, SRPMs and the build logs will appear. "
+             "The directory is created if it doesn't exist")
+    parser_build.add_argument(
+        '--rpmbuild-opts', action='append',
+        help="Pass additional option(s) to rpmbuild")
+    parser_build.add_argument(
+        '--rpmbuild-stage', action='store',
+        help=f"Request given -bX stage rpmbuild, X in [{RPMBUILD_STAGES}]")
+    add_container_args(parser_build)
+    add_common_args(parser_build)
+
+    # run -- execute commands inside a container
+    parser_run = subparsers_container.add_parser(
+        'run',
+        help='Execute a command inside a container')
+    parser_run.add_argument(
+        'command', nargs=argparse.REMAINDER,
+        help='Command to run inside the prepared container')
+    add_container_args(parser_run)
+    add_common_args(parser_run)
+
+    # shell -- like run bash
+    parser_shell = argparse.ArgumentParser()
+    parser_shell = subparsers_container.add_parser(
+        'shell',
+        help='Drop a shell into the prepared container')
+    add_container_args(parser_shell)
+    add_common_args(parser_shell)
+
+    return parser
+
+def container(args):
+    build = args.action == 'build'
     branch = args.branch or DEFAULT_BRANCH
     docker_arch = args.platform or ("linux/amd64/v2" if branch == "9.0" else "linux/amd64")
 
@@ -110,24 +151,24 @@ def main():
     if args.rm:
         docker_args += ["--rm=true"]
 
-    if args.command != []:
+    if hasattr(args, 'command') and args.command != []:
         docker_args += ["-e", "COMMAND=%s" % ' '.join(args.command)]
-    if args.build_local:
+    if build:
         docker_args += ["-v", "%s:/home/builder/rpmbuild" %
                         os.path.abspath(args.build_local)]
         docker_args += ["-e", "BUILD_LOCAL=1"]
-    if args.define:
+    if hasattr(args, 'define') and args.define:
         docker_args += ["-e", "RPMBUILD_DEFINE=%s" % args.define]
-    if args.rpmbuild_opts:
+    if hasattr(args, 'rpmbuild_opts') and args.rpmbuild_opts:
         docker_args += ["-e", "RPMBUILD_OPTS=%s" % ' '.join(args.rpmbuild_opts)]
-    if args.rpmbuild_stage:
+    if hasattr(args, 'rpmbuild_stage') and args.rpmbuild_stage:
         if args.rpmbuild_stage not in RPMBUILD_STAGES:
             parser.error(f"--rpmbuild-stage={args.rpmbuild_stage} not in '{RPMBUILD_STAGES}'")
         docker_args += ["-e", f"RPMBUILD_STAGE={args.rpmbuild_stage}"]
-    if args.output_dir:
+    if hasattr(args, 'output_dir') and args.output_dir:
         if not os.path.isdir(args.output_dir):
-            parser.error("%s is not a valid output directory." %
-                         args.output_dir)
+            print(f"{args.output_dir} is not a valid output directory.")
+            sys.exit(1)
         docker_args += ["-v", "%s:/home/builder/output" %
                         os.path.abspath(args.output_dir)]
     if args.no_exit:
@@ -171,7 +212,15 @@ def main():
     docker_args += ["%s:%s" % (CONTAINER_PREFIX, branch),
                     "/usr/local/bin/init-container.sh"]
     print("Launching docker with args %s" % docker_args, file=sys.stderr)
-    return_code = subprocess.call(docker_args)
+    return subprocess.call(docker_args)
+
+def main():
+    """ Main entry point. """
+    parser = buildparser()
+
+    args = parser.parse_args()
+
+    return_code = args.func(args)
 
     sys.exit(return_code)
 
diff --git a/test/test.sh b/test/test.sh
@@ -14,9 +14,9 @@ for REPO in ${REPOS}; do
     REPO_PATH=/tmp/"$REPO"
     git clone --branch "$TARGET_XCP_NG_VERSION" https://github.com/xcp-ng-rpms/"$REPO" "$REPO_PATH"
 
-    xcp-ng-dev --name "$CONTAINER_NAME" \
+    xcp-ng-dev container build "$REPO_PATH" \
+        --name "$CONTAINER_NAME" \
         --fail-on-error \
-        -l "$REPO_PATH" \
         -b "$TARGET_XCP_NG_VERSION" \
         --rm
 
