From 8f5b8fac33910f743ed5ee17950f8fe541384415 Mon Sep 17 00:00:00 2001
From: Peter Krempa <pkrempa@redhat.com>
Date: Thu, 4 Mar 2021 15:47:28 +0100
Subject: [PATCH] vsh: Introduce '--completers-missing' for 'self-test' command

Make it simple to spot which options of which commands are missing
autocompletion functions by introducing this hidden option.

In the future when we'll have completers for everything this can be also
used as a hard fail so that completers are always added.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
---
 tools/vsh.c | 28 ++++++++++++++++++++++++----
 tools/vsh.h |  3 ++-
 2 files changed, 26 insertions(+), 5 deletions(-)

diff --git a/tools/vsh.c b/tools/vsh.c
index 05da50eace..9c6783dad1 100644
--- a/tools/vsh.c
+++ b/tools/vsh.c
@@ -261,11 +261,13 @@ vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
 /* Check if the internal command definitions are correct */
 static int
 vshCmddefCheckInternals(vshControl *ctl,
-                        const vshCmdDef *cmd)
+                        const vshCmdDef *cmd,
+                        bool missingCompleters)
 {
     size_t i;
     const char *help = NULL;
     bool seenOptionalOption = false;
+    g_auto(virBuffer) complbuf = VIR_BUFFER_INITIALIZER;
 
     /* in order to perform the validation resolve the alias first */
     if (cmd->flags & VSH_CMD_FLAG_ALIAS) {
@@ -309,6 +311,11 @@ vshCmddefCheckInternals(vshControl *ctl,
             return -1; /* too many options */
         }
 
+        if (missingCompleters &&
+            (opt->type == VSH_OT_STRING || opt->type == VSH_OT_DATA) &&
+            !opt->completer)
+            virBufferStrcat(&complbuf, opt->name, ", ", NULL);
+
         switch (opt->type) {
         case VSH_OT_STRING:
         case VSH_OT_BOOL:
@@ -391,6 +398,12 @@ vshCmddefCheckInternals(vshControl *ctl,
             break;
         }
     }
+
+    virBufferTrim(&complbuf, ", ");
+
+    if (missingCompleters && virBufferUse(&complbuf) > 0)
+        vshPrintExtra(ctl, "%s: %s\n", cmd->name, virBufferCurrentContent(&complbuf));
+
     return 0;
 }
 
@@ -3250,6 +3263,13 @@ cmdQuit(vshControl *ctl, const vshCmd *cmd G_GNUC_UNUSED)
  * Command self-test
  * ----------------- */
 
+const vshCmdOptDef opts_selftest[] = {
+    {.name = "completers-missing",
+     .type = VSH_OT_BOOL,
+     .help = N_("output the list of options which are missing completers")
+    },
+    {.name = NULL}
+};
 const vshCmdInfo info_selftest[] = {
     {.name = "help",
      .data = N_("internal command for testing virt shells")
@@ -3261,15 +3281,15 @@ const vshCmdInfo info_selftest[] = {
 };
 
 bool
-cmdSelfTest(vshControl *ctl,
-            const vshCmd *cmd G_GNUC_UNUSED)
+cmdSelfTest(vshControl *ctl, const vshCmd *cmd)
 {
     const vshCmdGrp *grp;
     const vshCmdDef *def;
+    bool completers = vshCommandOptBool(cmd, "completers-missing");
 
     for (grp = cmdGroups; grp->name; grp++) {
         for (def = grp->commands; def->name; def++) {
-            if (vshCmddefCheckInternals(ctl, def) < 0)
+            if (vshCmddefCheckInternals(ctl, def, completers) < 0)
                 return false;
         }
     }
diff --git a/tools/vsh.h b/tools/vsh.h
index ae50f6b220..e208d957bb 100644
--- a/tools/vsh.h
+++ b/tools/vsh.h
@@ -375,6 +375,7 @@ extern const vshCmdOptDef opts_echo[];
 extern const vshCmdInfo info_echo[];
 extern const vshCmdInfo info_pwd[];
 extern const vshCmdInfo info_quit[];
+extern const vshCmdOptDef opts_selftest[];
 extern const vshCmdInfo info_selftest[];
 extern const vshCmdOptDef opts_complete[];
 extern const vshCmdInfo info_complete[];
@@ -445,7 +446,7 @@ bool cmdComplete(vshControl *ctl, const vshCmd *cmd);
     { \
         .name = "self-test", \
         .handler = cmdSelfTest, \
-        .opts = NULL, \
+        .opts = opts_selftest, \
         .info = info_selftest, \
         .flags = VSH_CMD_FLAG_NOCONNECT | VSH_CMD_FLAG_HIDDEN, \
     }