Add register command callback mode

Author: Peter Tihanyi

README.md

@@ -75,12 +75,46 @@ cli_console:register(["list", "partitions"], [All, Node, Limit], fun list_partit
 
 Or 
 
-Example: 
 ```erlang
 cli_console:register(["list", "partitions", Node], [All, Limit], funlist_partitions/1, "List partitions").
 ```
 
-####Run command
+This ad-hoc register command method does not survive if the cli_console service
+has restarted due to crash or anything else. Use register command callbacks
+instead.
+ 
+#### Register command callbacks
+ 
+There is `cli_console:register/2` function where the module and function parameters
+must be given.
+
+First there mush define a function which contains the desired commands.
+It should return a list with tuples.
+Tuple should look like this (same as `cli_console:register/4` arguments):
+`{Commands :: [command()], Arguments::  [command_argument()], command_fun(), Description ::string()}` 
+ 
+Example module for callback:
+```erlang
+-module(test_module).
+
+%% API
+-export([register_cli/0]).
+
+-spec register_cli() -> [].
+register_cli() ->
+  [  
+    {["clustre", "status"], [], fun(_) -> {text, "status: ok"} end, "Listpartitions" }
+  ].  
+````
+
+Registering callback:
+```erlang  
+ok = cli_console:register(test_module, register_cli).
+```
+
+Cluster status command will survive if cli_console process crashes or restarted. 
+
+#### Run command
 
 Example:
 ```erlang

rebar.config

@@ -16,5 +16,5 @@
 
 {alias,[{test,[eunit,
                {ct,"--name ct --sys_config=config/sys.config --readable true --cover --verbose true"},
-               {proper, "-n 1000"},
+               {proper, "-n 2500"},
                dialyzer]}]}.

src/cli_console.erl

@@ -11,7 +11,7 @@
 -include("cli_console_command.hrl").
 
 %% API
--export([run/1, register/4]).
+-export([run/1, register/4, register/2]).
 
 %% @doc Execute commands
 -spec run(string() | list(string())) -> ok.
@@ -21,11 +21,18 @@ run(ConsoleCommand) ->
   cli_console_output:output(Result),
   maybe_print_help(Result, Command).
 
-%% @doc Register command
--spec register([command()], [command_argument()], command_fun(), string()) -> ok.
+%% @doc Register ad-hoc command
+-spec register([command()], [command_argument()], command_fun(), string()) ->
+  ok | {error, {multiple_argument_definitions, Name :: string()}}.
 register(Command, Arguments, Fun, Description) ->
   cli_console_command:register(Command, Arguments, Fun, Description).
 
+%% @doc Register command register callback
+-spec register(module(), atom()) ->
+  ok | {error, {multiple_argument_definitions, Name :: string()}}.
+register(Module, Function) ->
+  cli_console_command:register(Module, Function).
+
 maybe_print_help({error, command_not_found}, Command) ->
   cli_console_output:output(cli_console_command:get_help(Command));
 maybe_print_help(_, _) ->

src/cli_console_command.erl

@@ -12,11 +12,12 @@
 -include("cli_console_command.hrl").
 -include_lib("stdlib/include/ms_transform.hrl").
 
--export([start_link/0, register/4, run/2, get_help/1, handle_info/2]).
--export([init/1, handle_call/3, handle_cast/2]).
+-export([start_link/0, register/4, register/2, run/2, get_help/1]).
+-export([init/1, handle_call/3, handle_cast/2, handle_info/2]).
 
 -define(SERVER, ?MODULE).
 -define(ETS_TABLE_NAME, cli_commands).
+-define(PERSISTENT_TERM_KEY, {?MODULE, register_command_callbacks}).
 
 -record(state, {
   running_commands = [] :: [{CommandPid :: pid(), From :: {pid(), term()}}]
@@ -28,10 +29,16 @@
 %%% API
 %%%===================================================================
 
--spec register([command()], [command_argument()], command_fun(), string()) -> ok.
+-spec register([command()], [command_argument()], command_fun(), string()) ->
+  ok | {error, {multiple_argument_definitions, Name :: string()}}.
 register(Command, Arguments, Fun, Description) ->
   gen_server:call(?SERVER, {register, Command, Arguments, Fun, Description}).
 
+-spec register(module(), atom()) ->
+  ok | {error, {multiple_argument_definitions, Name :: string()}}.
+register(Module, Function) ->
+  gen_server:call(?SERVER, {register, Module, Function}).
+
 -spec run([string()], proplists:proplist()) ->
   {ok, term()} |
   {error, command_not_found} |
@@ -58,7 +65,8 @@ start_link() ->
 -spec init(term()) -> {ok, state()}.
 init(_) ->
   process_flag(trap_exit, true),
-  ets:new(cli_commands, [set, protected, named_table]),
+  ets:new(?ETS_TABLE_NAME, [set, protected, named_table]),
+  init_commands_from_registered_callback(),
   {ok, #state{}}.
 
 -spec handle_call(term(), {pid(), Tag :: term()}, state()) ->
@@ -81,7 +89,15 @@ handle_call({get_help, Command}, _From, State = #state{}) ->
   {reply, {ok, [cli_console_formatter:title("Help~n") | Output]}, State};
 handle_call({register, Command, ArgsDef, Fun, Description}, _From,
             State = #state{}) ->
-  {reply, register_command(Command, ArgsDef, Fun, Description), State}.
+  {reply, register_command(Command, ArgsDef, Fun, Description), State};
+handle_call({register, Module, Function}, _From, State = #state{}) ->
+  case catch register_commands_via_callback([{Module, Function}]) of
+    ok ->
+      store_command_register_callback(Module, Function),
+      {reply, ok, State};
+    Else ->
+      {reply, {error, Else}, State}
+  end.
 
 -spec handle_cast(term(), state()) -> {noreply, state()}.
 handle_cast(_Request, State = #state{}) ->
@@ -123,9 +139,7 @@ run_command(Command, Args, ArgsDef, Fun) ->
         true ->
           get_help(Command);
         _ ->
-          MissingArguments = get_missing_arguments(ArgsDef, NewArgs),
-          evaluate_argument_check(MissingArguments,
-                                  fun() -> execute_fun(Fun, NewArgs) end)
+          evaluate_argument_check(ArgsDef, NewArgs, Fun)
       end;
     Else ->
       Else
@@ -141,6 +155,10 @@ execute_fun(Fun, NewArgs) ->
     ]}
   end.
 
+evaluate_argument_check(ArgsDef, NewArgs, Fun) ->
+  MissingArguments = get_missing_arguments(ArgsDef, NewArgs),
+  evaluate_argument_check(MissingArguments, fun() -> execute_fun(Fun, NewArgs) end).
+
 evaluate_argument_check([], Fun) ->
   Fun();
 evaluate_argument_check(MissingArguments, _Fun) ->
@@ -281,7 +299,7 @@ format_command({Commands, Desc}) ->
   cli_console_formatter:text("~ts ~ts", [CommandStr, Desc]).
 
 format_command_string(#argument{name = Name}) ->
-  "<" ++ Name ++">";
+  "<" ++ Name ++ ">";
 format_command_string(Command) ->
   Command.
 
@@ -321,8 +339,10 @@ register_command(Command, ArgsDef, Fun, Description) ->
   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), []}),
+      % need to clean up previous commands to make does not register multiple
+      % wildcard argument command
+      [ets:delete(?ETS_TABLE_NAME, PrevCommand) ||
+        {PrevCommand, _, _, _} <- get_wildcard_command(Command)],
       true = ets:insert(?ETS_TABLE_NAME, {Command, ArgsDef, Fun, Description}),
       ok;
     Else ->
@@ -388,17 +408,53 @@ 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}}
-  },
+  Filter = generate_filter(Command, Item),
   generate_filter(Rest, ItemCount+1, [Filter | Where]).
 
+generate_filter(#argument{}, Item) ->
+  {'==', argument, {element, 1, Item}};
+generate_filter(Command, Item) ->
+  {'orelse',
+   {'==', Command, Item},
+   {'==', argument, {element, 1, Item}}
+  }.
+
 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).
+              end, Args, CommandArgWithIndex).
+
+store_command_register_callback(Module, Function) ->
+  Callbacks = get_command_register_callbacks(),
+  Data = {Module, Function},
+  NewCallbacks =
+    case lists:member(Data, Callbacks) of
+      true ->
+        Callbacks;
+      false ->
+        [Data | Callbacks]
+    end,
+  persistent_term:put(?PERSISTENT_TERM_KEY, NewCallbacks).
+
+get_command_register_callbacks() ->
+  persistent_term:get(?PERSISTENT_TERM_KEY, []).
+
+init_commands_from_registered_callback() ->
+  register_commands_via_callback(get_command_register_callbacks()).
+
+register_commands_via_callback([]) ->
+  ok;
+register_commands_via_callback([{Module, Function} | Rest]) ->
+  Result = apply(Module, Function, []),
+  register_command_callback_result(Result),
+  register_commands_via_callback(Rest).
+
+register_command_callback_result([]) ->
+  ok;
+register_command_callback_result([{Command, ArgDef, Fun, Description} | Rest]) ->
+  ok = register_command(Command, ArgDef, Fun, Description),
+  register_command_callback_result(Rest).

src/cli_console_command.hrl

@@ -22,4 +22,4 @@
 
 -type command() :: string() | command_argument().
 
--export_type([command_argument/0]).
+-export_type([command_argument/0, command/0]).

src/cli_console_sup.erl

@@ -25,8 +25,8 @@ start_link() ->
         [ChildSpec :: supervisor:child_spec()]}}.
 init([]) ->
     SupFlags = #{strategy => one_for_all,
-                 intensity => 1,
-                 period => 10},
+                 intensity => 3,
+                 period => 100},
     ChildSpecs = [
                   #{id => cli_command_server,
                     start => {cli_console_command, start_link, []},

test/cli_console_SUITE.erl

@@ -120,7 +120,11 @@ all() ->
     crash_in_function,
     default_value_flag,
     pid_not_in_state,
-    wild_card_argument_help
+    wild_card_argument_help,
+    register_callback_ok,
+    register_callback_empty,
+    register_callback_bad_return,
+    register_callback_restart
   ].
 
 %%--------------------------------------------------------------------
@@ -384,6 +388,44 @@ wild_card_argument_help(_Config) ->
   ?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)).
 
+register_callback_ok(_Config) ->
+  Fun = fun(_Args) -> [{text, "ok"}] end,
+  Arg1 = cli_console_command_arg:argument("arg1", string, "Arg1 desc"),
+
+  ok = meck:new(cli_test_callback, [non_strict, passthrough]),
+  meck:expect(cli_test_callback, register_cli,
+              fun() -> [{["test", "cb"], [Arg1], Fun, "Test cb help"}] end),
+
+  ?assertEqual(ok, cli_console:register(cli_test_callback, register_cli)),
+  ?assertEqual("ok",
+               catch_output(fun() -> cli_console:run("test cb --arg1=ok") end)).
+
+register_callback_empty(_Config) ->
+  ok = meck:new(cli_test_callback, [non_strict, passthrough]),
+  meck:expect(cli_test_callback, register_cli, fun() -> [] end),
+
+  ?assertEqual(ok, cli_console:register(cli_test_callback, register_cli)).
+
+register_callback_bad_return(_Config) ->
+  ok = meck:new(cli_test_callback, [non_strict, passthrough]),
+  meck:expect(cli_test_callback, register_cli, fun() -> foo end),
+
+  ?assertMatch({error, _}, cli_console:register(cli_test_callback, register_cli)).
+
+register_callback_restart(Config) ->
+  register_callback_ok(Config),
+
+  % restart command sever
+  [exit(Pid, kill) ||
+    {Id, Pid, worker, _} <- supervisor:which_children(cli_console_sup),
+    Id =:= cli_command_server],
+
+  % wait a litle to supervisor restart the died process
+  ct:sleep(200),
+  ?assertEqual("ok",
+               catch_output(fun() -> cli_console:run("test cb --arg1=ok") end)).
+
+
 list_partitions(Args) ->
   [cli_console_formatter:title("List of partions"),
    cli_console_formatter:separator(),

test/cli_console_command_SUITE.erl

@@ -110,6 +110,7 @@ all() ->
     register_wildcard,
     register_multiple_wildcard,
     register_wildcard_same_arg,
+    register_wildcard_different_args,
     command_not_found,
     mandatory_arg_not_set_found,
     mandatory_arg_not_set_but_has_default,
@@ -165,6 +166,21 @@ register_wildcard_same_arg(_Config) ->
                                     [WildcardArgument], Fun, "Wild help"),
   ?assertEqual({error, {multiple_argument_definitions, "wildcard"}}, Result).
 
+register_wildcard_different_args(_Config) ->
+  WildcardArgument = cli_console_command_arg:argument("wildcard", string,
+                                                      "Desc of wildcard"),
+  WildcardArgumentDefault =
+    cli_console_command_arg:set_default(WildcardArgument, "test"),
+  ok = cli_console_command:register(["wild", WildcardArgument], [],
+                                    fun(_Args) -> {text, "1"} end,
+                                    "Wild help"),
+
+  ok = cli_console_command:register(["wild", WildcardArgumentDefault], [],
+                                    fun(_Args) -> {text, "2"} end,
+                                    "Wild help"),
+  ?assertEqual({ok, {text, "2"}},
+               cli_console_command:run(["wild", "things"], [])).
+
 command_not_found(_Config) ->
   ?assertEqual({error, command_not_found},
                cli_console_command:run(["not_found_command"], [])).

test/cli_test_callback.erl

@@ -0,0 +1,16 @@
+%%%-------------------------------------------------------------------
+%%% @author Peter Tihanyi
+%%% @copyright (C) 2021, Systream
+%%% @doc
+%%%
+%%% @end
+%%%-------------------------------------------------------------------
+-module(cli_test_callback).
+-author("Peter Tihanyi").
+
+%% API
+-export([register_cli/0]).
+
+-spec register_cli() -> [].
+register_cli() ->
+  [].