Add wildcard command support

Peter Tihanyi · Peter Tihanyi · commit 4c44183ef71a · 2020-12-28T16:29:31.000+01:00
diff --git a/README.md b/README.md
@@ -73,11 +73,24 @@ Example:
 cli_console:register(["list", "partitions"], [All, Node, Limit], fun list_partitions/1, "List partitions").
 ```
 
+Or 
+
+Example: 
+```erlang
+cli_console:register(["list", "partitions", Node], [All, Limit], funlist_partitions/1, "List partitions").
+```
+
 ####Run command
 
 Example:
 ```erlang
-cli_console:run("list partitions --limit 123 -node=test --all").
+cli_console:run("list partitions --limit 123 -node=testnode --all").
+```
+
+or 
+
+```erlang
+cli_console:run("list partitions testnode --limit 123 --all").
 ```
 
 Output: 
diff --git a/src/cli_console_command.erl b/src/cli_console_command.erl
@@ -66,12 +66,14 @@ init(_) ->
 handle_call({run, Command, Args}, From, State = #state{}) ->
   case ets:lookup(?ETS_TABLE_NAME, Command) of
     [] ->
-      {reply, {error, command_not_found}, State};
-    [{_, ArgsDef, Fun, _Description}] ->
-      CommandPid = spawn_run_command(Command, Args, ArgsDef, From, Fun),
-      RunningCommands = State#state.running_commands,
-      {noreply,
-       State#state{running_commands = [{CommandPid, From} | RunningCommands]}}
+      case get_wildcard_command(Command) of
+        [] ->
+          {reply, {error, command_not_found}, State};
+        Result ->
+          evaluate_command_lookup_result(Result, Command, Args, From, State)
+      end;
+    Else ->
+      evaluate_command_lookup_result(Else, Command, Args, From, State)
   end;
 handle_call({get_help, Command}, _From, State = #state{}) ->
   Help = do_get_help(Command),
@@ -107,6 +109,13 @@ spawn_run_command(Command, Args, ArgsDef, From, Fun) ->
               gen_server:reply(From, CommandResult)
              end).
 
+evaluate_command_lookup_result([{CommandSpec, ArgsDef, Fun, _Description}],
+                               Command, Args, From, State) ->
+  NewArgs = extract_command_args(CommandSpec, Command, Args),
+  CommandPid = spawn_run_command(Command, NewArgs, ArgsDef, From, Fun),
+  RunningCommands = State#state.running_commands,
+  {noreply, State#state{running_commands = [{CommandPid, From} | RunningCommands]}}.
+
 run_command(Command, Args, ArgsDef, Fun) ->
   case convert(ArgsDef, Args) of
     {ok, NewArgs} ->
@@ -223,7 +232,7 @@ is_numeric(Value) ->
 do_get_help([]) ->
   ets:foldr(fun({Command, _, _, Desc}, Acc) ->
               [{Command, Desc} | Acc]
-            end, [], cli_commands);
+            end, [], ?ETS_TABLE_NAME);
 do_get_help(InCommands) ->
   case ets:lookup(?ETS_TABLE_NAME, InCommands) of
     [] ->
@@ -233,9 +242,9 @@ do_get_help(InCommands) ->
   end.
 
 do_help_lookup(InCommands) ->
-  case ets:select(cli_commands, get_select_matchspec(InCommands, false)) of
+  case ets:select(?ETS_TABLE_NAME, get_select_matchspec(InCommands, false)) of
     [] ->
-      ets:select(cli_commands, get_select_matchspec(InCommands, true));
+      ets:select(?ETS_TABLE_NAME, get_select_matchspec(InCommands, true));
     Else ->
       Else
   end.
@@ -267,9 +276,15 @@ format_command({Commands, Desc, Args}) ->
    cli_console_formatter:text("~nArguments: ") |
    [format_arg(Arg) || Arg <- Args]];
 format_command({Commands, Desc}) ->
-  CommandStr = string:pad(string:join(Commands, " "), 32),
+  NewCommands = lists:map(fun format_command_string/1, Commands),
+  CommandStr = string:pad(string:join(NewCommands, " "), 32),
   cli_console_formatter:text("~ts ~ts", [CommandStr, Desc]).
 
+format_command_string(#argument{name = Name}) ->
+  "<" ++ Name ++">";
+format_command_string(Command) ->
+  Command.
+
 format_arg(#argument{name = Name, optional = Optional,
                       default = Default, description = Desc}) ->
 
@@ -303,14 +318,31 @@ is_argument_defined(Arg, ArgsDef) ->
   end.
 
 register_command(Command, ArgsDef, Fun, Description) ->
-  case check_multiple_argdefs(ArgsDef) of
+  CommandArguments = get_command_arguments(Command),
+  case check_multiple_argdefs(ArgsDef ++ CommandArguments) of
     ok ->
+      ets:match_delete(?ETS_TABLE_NAME, {generate_match_head(Command),
+                                         generate_filter(Command), []}),
       true = ets:insert(?ETS_TABLE_NAME, {Command, ArgsDef, Fun, Description}),
       ok;
     Else ->
       Else
   end.
 
+get_command_arguments(Command) ->
+  lists:filter(fun(#argument{}) -> true;
+                  (_)           -> false
+               end, Command).
+
+get_command_arguments_with_index(Command) ->
+  {_, Result} =
+    lists:foldl(fun(#argument{} = Item, {ItemSeq, Acc}) ->
+                      {ItemSeq+1, [{ItemSeq, Item} | Acc]};
+                   (_, {ItemSeq, Acc}) ->
+                     {ItemSeq+1, Acc}
+                end, {1, []}, Command),
+  Result.
+
 check_multiple_argdefs(Argdefs) ->
   check_multiple_argdefs(Argdefs, []).
 
@@ -333,4 +365,40 @@ format_help(HelpCommand, Acc) ->
       lists:foldr(fun(Item, Acc2) -> [Item | Acc2] end, Acc, Result);
     Item ->
       [Item | Acc]
-  end.
+  end.
+
+get_wildcard_command(Command) ->
+  case ets:select(?ETS_TABLE_NAME, [{generate_match_head(Command),
+                                     generate_filter(Command), ['$_']}]) of
+    [] ->
+      [];
+    [{Commands, ArgsDef, Fun, Description}] ->
+      CommandArguments = get_command_arguments(Commands),
+      [{Commands, ArgsDef ++ CommandArguments, Fun, Description}]
+  end.
+
+generate_match_head(Command) ->
+  CommandHead = [item_num(ItemNum) || ItemNum <- lists:seq(1, length(Command))],
+  {CommandHead, '_', '_', '_'}.
+
+generate_filter(Command) ->
+  generate_filter(Command, 1, []).
+
+generate_filter([], _ItemCount, Where) ->
+  lists:reverse(Where);
+generate_filter([Command | Rest], ItemCount, Where) ->
+  Item = item_num(ItemCount),
+  Filter = {'orelse',
+    {'==', Command, Item},
+    {'==', argument, {element, 1, Item}}
+  },
+  generate_filter(Rest, ItemCount+1, [Filter | Where]).
+
+item_num(ItemNum) ->
+  list_to_atom("$" ++ integer_to_list(ItemNum)).
+
+extract_command_args(CommandSpec, Command, Args) ->
+  CommandArgWithIndex = get_command_arguments_with_index(CommandSpec),
+  lists:foldl(fun({Index, #argument{name = Name}}, Acc) ->
+                   [{Name, lists:nth(Index, Command)} | Acc]
+              end, Args, CommandArgWithIndex).
diff --git a/src/cli_console_command.hrl b/src/cli_console_command.hrl
@@ -20,6 +20,6 @@
 
 -type command_fun() :: fun((proplists:proplist()) -> [output_format()] | output_format() ).
 
--type command() :: string().
+-type command() :: string() | command_argument().
 
 -export_type([command_argument/0]).
diff --git a/test/cli_console_SUITE.erl b/test/cli_console_SUITE.erl
@@ -119,7 +119,8 @@ all() ->
     handle_errors,
     crash_in_function,
     default_value_flag,
-    pid_not_in_state
+    pid_not_in_state,
+    wild_card_argument_help
   ].
 
 %%--------------------------------------------------------------------
@@ -375,6 +376,13 @@ default_value_flag(_Config) ->
   ?assertEqual("\e[37;1mHelp\n\n\e[0mconnections                      List connections status\n\nArguments: \n -all                            desc\n                                 Default value: false\n -limit                          desc\n                                 Default value: 10\n -skip_echo                      desc\n                                \n",
                Output).
 
+wild_card_argument_help(_Config) ->
+  Fun = fun(_Args) -> [{text, "ok"}] end,
+  Arg1 = cli_console_command_arg:argument("table", string, "Table name"),
+  Arg2 = cli_console_command_arg:argument("type", string, "Table type"),
+  ok = cli_console_command:register(["wild", Arg1, Arg2], [], Fun, "Wild help"),
+  ?assertEqual("Command not found\n\n\e[37;1mHelp\n\n\e[0mwild <table> <type>              Wild help\n",
+               catch_output(fun() -> cli_console:run(["wild"]) end)).
 
 list_partitions(Args) ->
   [cli_console_formatter:title("List of partions"),
diff --git a/test/cli_console_command_SUITE.erl b/test/cli_console_command_SUITE.erl
@@ -107,6 +107,9 @@ groups() ->
 all() ->
   [ register_no_argument,
     register_the_twice,
+    register_wildcard,
+    register_multiple_wildcard,
+    register_wildcard_same_arg,
     command_not_found,
     mandatory_arg_not_set_found,
     mandatory_arg_not_set_but_has_default,
@@ -134,6 +137,34 @@ register_the_twice(_Config) ->
   ok = cli_console_command:register(["foo"], [], ?DUMMY_FUN(ok2), ""),
   ?assertEqual({ok, ok2}, cli_console_command:run(["foo"], [])).
 
+register_wildcard(_Config) ->
+  Fun = fun(Args) -> Args end,
+  WildcardArgument = cli_console_command_arg:argument("wildcard", string,
+                                                      "Desc of wildcard"),
+  ok = cli_console_command:register(["wild", WildcardArgument], [], Fun,
+                                    "Wild help"),
+  ?assertEqual({ok, [{"wildcard", "things"}]},
+               cli_console_command:run(["wild", "things"], [])).
+
+register_multiple_wildcard(_Config) ->
+  Fun = fun(Args) -> Args end,
+  WildcardArgument = cli_console_command_arg:argument("wildcard", string,
+                                                      "Desc of wildcard"),
+  WildcardArgument2 = cli_console_command_arg:argument("wildcard2", string,
+                                                      "Desc of wildcard2"),
+  ok = cli_console_command:register(["wild", WildcardArgument, WildcardArgument2],
+                                    [], Fun, "Wild help"),
+  ?assertEqual({ok, [{"wildcard2", "wild"}, {"wildcard", "things"}]},
+               cli_console_command:run(["wild", "things", "wild"], [])).
+
+register_wildcard_same_arg(_Config) ->
+  Fun = fun(Args) -> {ok, Args} end,
+  WildcardArgument = cli_console_command_arg:argument("wildcard", string,
+                                                      "Desc of wildcard"),
+  Result = cli_console_command:register(["wild", WildcardArgument],
+                                    [WildcardArgument], Fun, "Wild help"),
+  ?assertEqual({error, {multiple_argument_definitions, "wildcard"}}, Result).
+
 command_not_found(_Config) ->
   ?assertEqual({error, command_not_found},
                cli_console_command:run(["not_found_command"], [])).
diff --git a/test/prop_command.erl b/test/prop_command.erl
@@ -7,15 +7,17 @@
 %%%%%%%%%%%%%%%%%%
 prop_test() ->
   application:ensure_all_started(cli_console),
-    ?FORALL({ArgsDef, Args, Description}, {arguments_defs(), arguemnts(), string()},
+    ?FORALL({Command, ArgsDef, Args, Description},
+            {test_command(), arguments_defs(), arguemnts(), string()},
             begin
-              Command = ["cmd", "run"],
+              %Command = ["cmd", "run"],
               case cli_console_command:register(Command, ArgsDef, fun(A) -> A
                                                                   end,
                                                 Description) of
                 ok ->
+
                   % test against crash, or unhandled stuff
-                  case cli_console_command:run(Command, Args) of
+                  case cli_console_command:run(normalize_command(Command), Args) of
                     {ok, ArgsResult} ->
                       assert_ok(ArgsDef, ArgsResult, Args);
                     {error, Error} ->
@@ -60,6 +62,11 @@ assert_ok(_ArgsDef, [{format, _, _} | _], Args) ->
       true
   end.
 
+normalize_command([_, _] = Command) ->
+  Command;
+normalize_command([A, B, _C])  ->
+  [A, B, "1"].
+
 %%%%%%%%%%%%%%%%%%
 %%% Generators %%%
 %%%%%%%%%%%%%%%%%%
@@ -89,6 +96,10 @@ arguments_def() ->
             maybe_set_default(Default, Arg1)
         end).
 
+test_command() ->
+  frequency([{20, ["cmd", "run"]},
+             {1, ["cmd", "run", arguments_def()]}]).
+
 maybe_set_mandatory(true, Arg) ->
   cli_console_command_arg:mandatory(Arg);
 maybe_set_mandatory(false, Arg) ->
