Add admin script, + fixes

Author: Peter Tihanyi

README.md

@@ -1,11 +1,24 @@
 Command Line tool
 =====
 
-Parsing and executing console commands
+Parsing and executing console commands 
 
 ## Example
 Until i have time to write proper documentation here is an example how to use it:
 
+### Setup release
+Add to your project's relx overlay config:
+
+```erlang
+{relx, [
+  ...
+  {overlay, [{template, "_build/default/lib/cli_console/rel/admin.sh", "bin/admin"}
+            ]}
+]}.
+```
+
+In the release you can use it ex: `./bin/admin help`
+
 ### Defining arguments
 Available argument types: `flag | atom | string | binary | integer`
 Arguments converted to target type automatically. 

elvis.config

@@ -0,0 +1,19 @@
+[{elvis,
+    [{config,
+       [#{dirs => ["src"],
+           filter => "cli_console_output.erl",
+           rules => [{elvis_style, no_debug_call, disable}],
+           ruleset => erl_files
+         },
+         #{dirs => ["src"],
+          filter => "*.erl",
+          ruleset => erl_files,
+          ignore => [cli_console_output]
+        },
+        #{dirs => ["."],
+          filter => "rebar.config",
+          ruleset => rebar_config
+        }
+       ]
+    }]
+}].

rel/admin.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+# -*- tab-width:4;indent-tabs-mode:nil -*-
+# ex: ts=4 sw=4 et
+
+$(dirname "${BASH_SOURCE[0]}")/{{release_name}} rpc cli_console run "$@"

src/cli_console.erl

@@ -14,7 +14,9 @@
 -export([run/1, register/4]).
 
 %% @doc Execute commands
--spec run(string()) -> ok.
+-spec run(string() | list(string())) -> ok.
+run([Item | _] = Commands) when is_list(Item) ->
+  run(string:join(Commands, " "));
 run(ConsoleCommand) ->
   {ok, Command, Arguments} = cli_console_parser:parse(ConsoleCommand),
   Result = cli_console_command:run(Command, Arguments),

src/cli_console_app.erl

@@ -29,4 +29,4 @@ stop(_State) ->
 -spec get_help(term()) -> output_format().
 get_help(_) ->
     {ok, Data} = cli_console_command:get_help([]),
-    Data.
+    Data.

src/cli_console_command.erl

@@ -49,8 +49,11 @@ get_help(Command) ->
 %%% Spawning and gen_server implementation
 %%%===================================================================
 
+-spec start_link() ->
+  {ok, pid()} | {error, {already_started, pid()}} | {error, term()}.
 start_link() ->
-  gen_server:start_link({local, ?SERVER}, ?MODULE, [], []).
+  gen_server:start_link({local, ?SERVER}, ?MODULE, [],
+                        [{hibernate_after, timer:seconds(160)}]).
 
 -spec init(term()) -> {ok, state()}.
 init(_) ->
@@ -65,9 +68,10 @@ handle_call({run, Command, Args}, From, State = #state{}) ->
     [] ->
       {reply, {error, command_not_found}, State};
     [{_, ArgsDef, Fun, _Description}] ->
-      CommandPid = run_command(Command, Args, ArgsDef, From, Fun),
+      CommandPid = spawn_run_command(Command, Args, ArgsDef, From, Fun),
       RunningCommands = State#state.running_commands,
-      {noreply, State#state{running_commands = [{CommandPid, From} | RunningCommands]}}
+      {noreply,
+       State#state{running_commands = [{CommandPid, From} | RunningCommands]}}
   end;
 handle_call({get_help, Command}, _From, State = #state{}) ->
   Help = do_get_help(Command),
@@ -84,37 +88,39 @@ handle_cast(_Request, State = #state{}) ->
 -spec handle_info(Info :: term(), State :: term()) ->
   {noreply, NewState :: term()}.
 handle_info({'EXIT', Pid, normal}, #state{running_commands = Rc} = State) ->
-  {noreply, State#state{running_commands = lists:delete(Pid, Rc)}};
+  {noreply, State#state{running_commands = proplists:delete(Pid, Rc)}};
 handle_info({'EXIT', Pid, Reason}, #state{running_commands = Rc} = State) ->
   case lists:keyfind(Pid, 1, Rc) of
     false ->
       ok;
     {_, From} ->
       gen_server:reply(From, {error, Reason})
   end,
-  {noreply, State#state{running_commands = lists:delete(Pid, Rc)}}.
+  {noreply, State#state{running_commands = proplists:delete(Pid, Rc)}}.
 
 %%%===================================================================
 %%% Internal functions
 %%%===================================================================
-
-run_command(Command, Args, ArgsDef, From, Fun) ->
+spawn_run_command(Command, Args, ArgsDef, From, Fun) ->
   spawn_link(fun() ->
-    Result =
-      case convert(ArgsDef, Args) of
-        {ok, NewArgs} ->
-          case is_not_in_arg_def_but_set(ArgsDef, Args, "help") of
-            true ->
-              get_help(Command);
-            _ ->
-              MissingArguments = get_missing_arguments(ArgsDef, NewArgs),
-              evaluate_argument_check(MissingArguments, fun() -> execute_fun(Fun, NewArgs) end)
-          end;
-        Else ->
-          Else
-       end,
-      gen_server:reply(From, Result)
-    end).
+              CommandResult = run_command(Command, Args, ArgsDef, Fun),
+              gen_server:reply(From, CommandResult)
+             end).
+
+run_command(Command, Args, ArgsDef, Fun) ->
+  case convert(ArgsDef, Args) of
+    {ok, NewArgs} ->
+      case is_not_in_arg_def_but_set(ArgsDef, Args, "help") of
+        true ->
+          get_help(Command);
+        _ ->
+          MissingArguments = get_missing_arguments(ArgsDef, NewArgs),
+          evaluate_argument_check(MissingArguments,
+                                  fun() -> execute_fun(Fun, NewArgs) end)
+      end;
+    Else ->
+      Else
+   end.
 
 execute_fun(Fun, NewArgs) ->
   try
@@ -262,22 +268,22 @@ format_command({Commands, Desc, Args}) ->
    [format_arg(Arg) || Arg <- Args]];
 format_command({Commands, Desc}) ->
   CommandStr = string:pad(string:join(Commands, " "), 32),
-  cli_console_formatter:text("~s ~s", [CommandStr, Desc]).
+  cli_console_formatter:text("~ts ~ts", [CommandStr, Desc]).
 
 format_arg(#argument{name = Name, optional = Optional,
                       default = Default, description = Desc}) ->
 
   CommandStr = string:pad(Name, 30),
   ArgData = get_default_string(Default, get_optional_string(Optional, "")),
-  cli_console_formatter:text(" -~s ~s~n~s~s",
+  cli_console_formatter:text(" -~ts ~ts~n~ts~ts",
                              [CommandStr, Desc, lists:duplicate(32, " "), ArgData]).
 
 get_default_string(undefined, Acc) ->
   Acc;
 get_default_string(Default, Acc) when is_integer(Default) ->
-  Acc ++ " Default value: " ++ io_lib:format("~s", [integer_to_list(Default)]);
+  Acc ++ " Default value: " ++ io_lib:format("~ts", [integer_to_list(Default)]);
 get_default_string(Default, Acc) ->
-  Acc ++ " Default value: " ++ io_lib:format("~s", [Default]).
+  Acc ++ " Default value: " ++ io_lib:format("~ts", [Default]).
 
 get_optional_string(true, Acc) ->
   Acc;

src/cli_console_formatter.erl

@@ -15,13 +15,16 @@
 -behavior(cli_console_output).
 
 %% API
--export([text/1, text/2, title/1,
+-export([text/1, text/2,
+         title/1,
          separator/0,
          format/1,
          alert/1,
          list/1,
          table/1,
-         success/1, error/1, warning/1]).
+         success/1,
+         error/1,
+         warning/1]).
 
 -spec text(string()) -> {format, module(), {text, string()}}.
 text(String) ->

src/cli_console_output.erl

@@ -33,15 +33,15 @@ output({ok, Data}) ->
 format({text, Data}) ->
   io:format(Data);
 format({format, Module, Format}) ->
-  io:format(Module:format(Format)).
+  io:format(apply(Module, format, [Format])).
 
 -spec show_error(command_not_found |
                 {not_convertible, {Type :: atom(), Value :: term()}} |
                 {missing_arguments, [command_argument()]}) -> ok.
 show_error(command_not_found) ->
   io:format("Command not found~n");
 show_error({not_convertible, {Name, Type, Value}}) ->
-  io:format("Illegal parameter: ~s (~p) - ~p~n", [Name, Type, Value]);
+  io:format("Illegal parameter: ~ts (~p) - ~p~n", [Name, Type, Value]);
 show_error({missing_arguments, Args}) ->
   io:format("Missing argument: ~n", []),
   [missing_argument(Arg) || Arg <- Args],
@@ -53,4 +53,4 @@ show_error(Error) ->
 -spec missing_argument(command_argument()) -> ok.
 missing_argument(#argument{name = Name, description = Desc}) ->
   NameStr = string:pad(Name, 19),
-  io:format(" * ~s \t ~s~n", [NameStr, Desc]).
+  io:format(" * ~ts \t ~ts~n", [NameStr, Desc]).

src/cli_console_parser.erl

@@ -72,5 +72,3 @@ equal_sign_parse_evaluate([Key]) ->
   {Key, true};
 equal_sign_parse_evaluate([NewKey, Data]) ->
   {NewKey, Data}.
-
-

src/cli_console_sup.erl

@@ -16,18 +16,13 @@
 
 -define(SERVER, ?MODULE).
 
+-spec start_link() -> supervisor:startlink_ret().
 start_link() ->
     supervisor:start_link({local, ?SERVER}, ?MODULE, []).
 
-%% sup_flags() = #{strategy => strategy(),         % optional
-%%                 intensity => non_neg_integer(), % optional
-%%                 period => pos_integer()}        % optional
-%% child_spec() = #{id => child_id(),       % mandatory
-%%                  start => mfargs(),      % mandatory
-%%                  restart => restart(),   % optional
-%%                  shutdown => shutdown(), % optional
-%%                  type => worker(),       % optional
-%%                  modules => modules()}   % optional
+-spec init(Args :: term()) ->
+  {ok, {SupFlags :: supervisor:sup_flags(),
+        [ChildSpec :: supervisor:child_spec()]}}.
 init([]) ->
     SupFlags = #{strategy => one_for_all,
                  intensity => 1,

test/cli_console_SUITE.erl

@@ -160,12 +160,20 @@ simple_command(_Config) ->
 
   ?assertEqual("Command not found\n\n\e[37;1mHelp\n\n\e[0mhelp                             Print help\nshow commands                    show available commands\nshow tables                      show database tables\n",
                catch_output(fun() -> cli_console:run("unknown command") end)),
+  ?assertEqual("Command not found\n\n\e[37;1mHelp\n\n\e[0mhelp                             Print help\nshow commands                    show available commands\nshow tables                      show database tables\n",
+               catch_output(fun() -> cli_console:run(["unknown", "command"]) end)),
   ?assertEqual("Commands\n * show tables: list tales\n * help: print help\n",
                catch_output(fun() -> cli_console:run("show commands") end)),
+  ?assertEqual("Commands\n * show tables: list tales\n * help: print help\n",
+               catch_output(fun() -> cli_console:run(["show", "commands"]) end)),
   ?assertEqual("\e[37;1mTables\n\n\e[0m * users\n * permissions\n * tweats\n",
                catch_output(fun() -> cli_console:run("show tables") end)),
+  ?assertEqual("\e[37;1mTables\n\n\e[0m * users\n * permissions\n * tweats\n",
+               catch_output(fun() -> cli_console:run(["show", "tables"]) end)),
+  ?assertEqual("\e[37;1mTables\n\n\e[0mListing all tables\n---------------------------------------------------------------\n * users\n * permissions\n * tweats\n",
+               catch_output(fun() -> cli_console:run("show tables --all") end)),
   ?assertEqual("\e[37;1mTables\n\n\e[0mListing all tables\n---------------------------------------------------------------\n * users\n * permissions\n * tweats\n",
-               catch_output(fun() -> cli_console:run("show tables --all") end)).
+               catch_output(fun() -> cli_console:run(["show", "tables", "--all"]) end)).
 
 
 table(_Config) ->