Merge pull request #535 from lrascao/feature/optional_permafy_relup

Feature/optional permafy relup

2 files changed, 115 insertions, 17 deletions

diff --git a/priv/templates/extended_bin b/priv/templates/extended_bin
index 0881a08..5cb1c04 100755
--- a/priv/templates/extended_bin
+++ b/priv/templates/extended_bin
@@ -31,6 +31,66 @@ REL_DIR="$RELEASE_ROOT_DIR/releases/$REL_VSN"
 ERL_OPTS="{{ erl_opts }}"
 RUNNER_LOG_DIR="${RUNNER_LOG_DIR:-$RELEASE_ROOT_DIR/log}"
 
+relx_usage() {
+    command="$1"
+
+    case "$command" in
+        unpack)
+            echo "Usage: $REL_NAME unpack [VERSION]"
+            echo "Unpacks a release package VERSION, it assumes that this"
+            echo "release package tarball has already been deployed at one"
+            echo "of the following locations:"
+            echo "      releases/<relname>-<version>.tar.gz"
+            echo "      releases/<version>/<relname>-<version>.tar.gz"
+            echo "      releases/<version>/<relname>.tar.gz"
+            ;;
+        install)
+            echo "Usage: $REL_NAME install [VERSION]"
+            echo "Installs a release package VERSION, it assumes that this"
+            echo "release package tarball has already been deployed at one"
+            echo "of the following locations:"
+            echo "      releases/<relname>-<version>.tar.gz"
+            echo "      releases/<version>/<relname>-<version>.tar.gz"
+            echo "      releases/<version>/<relname>.tar.gz"
+            echo ""
+            echo "     --no-permanent   Install release package VERSION but"
+            echo "                      don't make it permanent"
+            ;;
+        uninstall)
+            echo "Usage: $REL_NAME uninstall [VERSION]"
+            echo "Uninstalls a release VERSION, it will only accept"
+            echo "versions that are not currently in use"
+            ;;
+        upgrade)
+            echo "Usage: $REL_NAME upgrade [VERSION]"
+            echo "Upgrades the currently running release to VERSION, it assumes"
+            echo "that a release package tarball has already been deployed at one"
+            echo "of the following locations:"
+            echo "      releases/<relname>-<version>.tar.gz"
+            echo "      releases/<version>/<relname>-<version>.tar.gz"
+            echo "      releases/<version>/<relname>.tar.gz"
+            echo ""
+            echo "     --no-permanent   Install release package VERSION but"
+            echo "                      don't make it permanent"
+            ;;
+        downgrade)
+            echo "Usage: $REL_NAME downgrade [VERSION]"
+            echo "Downgrades the currently running release to VERSION, it assumes"
+            echo "that a release package tarball has already been deployed at one"
+            echo "of the following locations:"
+            echo "      releases/<relname>-<version>.tar.gz"
+            echo "      releases/<version>/<relname>-<version>.tar.gz"
+            echo "      releases/<version>/<relname>.tar.gz"
+            echo ""
+            echo "     --no-permanent   Install release package VERSION but"
+            echo "                      don't make it permanent"
+            ;;
+        *)
+            echo "Usage: $REL_NAME {start|start_boot <file>|foreground|stop|restart|reboot|pid|ping|console|console_clean|console_boot <file>|attach|remote_console|upgrade|downgrade|install|uninstall|versions|escript|rpc|rpcterms|eval}"
+            ;;
+    esac
+}
+
 find_erts_dir() {
     __erts_dir="$RELEASE_ROOT_DIR/erts-$ERTS_VSN"
     if [ -d "$__erts_dir" ]; then
@@ -460,8 +520,17 @@ case "$1" in
         shift
         relx_nodetool "eval" $@
         ;;
+    help)
+        if [ -z "$2" ]; then
+            relx_usage
+            exit 1
+        fi
+
+        TOPIC="$2"; shift
+        relx_usage $TOPIC
+        ;;
     *)
-        echo "Usage: $REL_NAME {start|start_boot <file>|foreground|stop|restart|reboot|pid|ping|console|console_clean|console_boot <file>|attach|remote_console|upgrade|downgrade|install|uninstall|versions|escript|rpc|rpcterms|eval}"
+        relx_usage
         exit 1
         ;;
 esac
diff --git a/priv/templates/install_upgrade_escript b/priv/templates/install_upgrade_escript
index 9c74445..dc09f9c 100644
--- a/priv/templates/install_upgrade_escript
+++ b/priv/templates/install_upgrade_escript
@@ -20,15 +20,17 @@ main([Command0, DistInfoStr | CommandArgs]) ->
     {ok, Tokens, _} = erl_scan:string(DistInfoStr ++ "."),
     {ok, DistInfo} = erl_parse:parse_term(Tokens),
     Command = list_to_atom(Command0),
+    %% convert arguments into a proplist
+    Opts = parse_arguments(CommandArgs),
     %% invoke the command passed as argument
-    erlang:apply(?MODULE, Command, [DistInfo, CommandArgs]);
+    erlang:apply(?MODULE, Command, [DistInfo, Opts]);
 main(Args) ->
     ?INFO("unknown args: ~p\n", [Args]),
     erlang:halt(1).
 
-unpack({RelName, NameTypeArg, NodeName, Cookie}, [VersionArg]) ->
+unpack({RelName, NameTypeArg, NodeName, Cookie}, Opts) ->
     TargetNode = start_distribution(NodeName, NameTypeArg, Cookie),
-    Version = parse_version(VersionArg),
+    Version = proplists:get_value(version, Opts),
     case unpack_release(RelName, TargetNode, Version) of
         {ok, Vsn} ->
             ?INFO("Unpacked successfully: ~p~n", [Vsn]);
@@ -49,23 +51,33 @@ unpack({RelName, NameTypeArg, NodeName, Cookie}, [VersionArg]) ->
 unpack(_, Args) ->
     ?INFO("unpack: unknown args ~p\n", [Args]).
 
-install({RelName, NameTypeArg, NodeName, Cookie}, [VersionArg]) ->
+install({RelName, NameTypeArg, NodeName, Cookie}, Opts) ->
     TargetNode = start_distribution(NodeName, NameTypeArg, Cookie),
-    Version = parse_version(VersionArg),
+    Version = proplists:get_value(version, Opts),
     case unpack_release(RelName, TargetNode, Version) of
         {ok, Vsn} ->
             ?INFO("Unpacked successfully: ~p~n", [Vsn]),
-            install_and_permafy(TargetNode, RelName, Vsn);
+            check_and_install(TargetNode, Vsn),
+            maybe_permafy(TargetNode, RelName, Vsn, Opts);
         old ->
             %% no need to unpack, has been installed previously
             ?INFO("Release ~s is marked old, switching to it.~n",[Version]),
-            install_and_permafy(TargetNode, RelName, Version);
+            check_and_install(TargetNode, Version),
+            maybe_permafy(TargetNode, RelName, Version, Opts);
         unpacked ->
             ?INFO("Release ~s is already unpacked, now installing.~n",[Version]),
-            install_and_permafy(TargetNode, RelName, Version);
+            check_and_install(TargetNode, Version),
+            maybe_permafy(TargetNode, RelName, Version, Opts);
         current ->
-            ?INFO("Release ~s is already installed and current, making permanent.~n",[Version]),
-            permafy(TargetNode, RelName, Version);
+            case proplists:get_value(permanent, Opts, true) of
+                true ->
+                    ?INFO("Release ~s is already installed and current, making permanent.~n",
+                        [Version]),
+                    permafy(TargetNode, RelName, Version);
+                false ->
+                    ?INFO("Release ~s is already installed and current.~n",
+                        [Version])
+            end;
         permanent ->
             ?INFO("Release ~s is already installed and set permanent.~n",[Version]);
         {error, Reason} ->
@@ -82,18 +94,19 @@ upgrade(DistInfo, Args) ->
 downgrade(DistInfo, Args) ->
     install(DistInfo, Args).
 
-uninstall({_RelName, NameTypeArg, NodeName, Cookie}, [VersionArg]) ->
+uninstall({_RelName, NameTypeArg, NodeName, Cookie}, Opts) ->
     TargetNode = start_distribution(NodeName, NameTypeArg, Cookie),
     WhichReleases = which_releases(TargetNode),
-    Version = parse_version(VersionArg),
+    Version = proplists:get_value(version, Opts),
     case proplists:get_value(Version, WhichReleases) of
         undefined ->
             ?INFO("Release ~s is already uninstalled.~n", [Version]);
         old ->
-            ?INFO("Release ~s is marked old.~n", [Version]),
+            ?INFO("Release ~s is marked old, uninstalling it.~n", [Version]),
             remove_release(TargetNode, Version);
         unpacked ->
-            ?INFO("Release ~s is marked unpacked.~n", [Version]),
+            ?INFO("Release ~s is marked unpacked, uninstalling it~n",
+                [Version]),
             remove_release(TargetNode, Version);
         current ->
             ?INFO("Uninstall failed: Release ~s is marked current.~n", [Version]),
@@ -109,6 +122,16 @@ versions({_RelName, NameTypeArg, NodeName, Cookie}, []) ->
     TargetNode = start_distribution(NodeName, NameTypeArg, Cookie),
     print_existing_versions(TargetNode).
 
+parse_arguments(Args) ->
+    parse_arguments(Args, []).
+
+parse_arguments([], Acc) -> Acc;
+parse_arguments(["--no-permanent"|Rest], Acc) ->
+    parse_arguments(Rest, [{permanent, false}] ++ Acc);
+parse_arguments([VersionStr|Rest], Acc) ->
+    Version = parse_version(VersionStr),
+    parse_arguments(Rest, [{version, Version}] ++ Acc).
+
 unpack_release(RelName, TargetNode, Version) ->
     WhichReleases = which_releases(TargetNode),
     case proplists:get_value(Version, WhichReleases) of
@@ -191,7 +214,7 @@ first_value(Fun, [Value | Rest]) ->
 parse_version(V) when is_list(V) ->
     hd(string:tokens(V,"/")).
 
-install_and_permafy(TargetNode, RelName, Vsn) ->
+check_and_install(TargetNode, Vsn) ->
     case rpc:call(TargetNode, release_handler,
                   check_install_release, [Vsn], ?TIMEOUT) of
         {ok, _OtherVsn, _Desc} ->
@@ -204,7 +227,6 @@ install_and_permafy(TargetNode, RelName, Vsn) ->
                   [Vsn, [{update_paths, true}]], ?TIMEOUT) of
         {ok, _, _} ->
             ?INFO("Installed Release: ~s~n", [Vsn]),
-            permafy(TargetNode, RelName, Vsn),
             ok;
         {error, {no_such_release, Vsn}} ->
             VerList =
@@ -226,6 +248,13 @@ install_and_permafy(TargetNode, RelName, Vsn) ->
             erlang:halt(4)
     end.
 
+maybe_permafy(TargetNode, RelName, Vsn, Opts) ->
+    case proplists:get_value(permanent, Opts, true) of
+        true ->
+            permafy(TargetNode, RelName, Vsn);
+        false -> ok
+    end.
+
 permafy(TargetNode, RelName, Vsn) ->
     ok = rpc:call(TargetNode, release_handler,
                   make_permanent, [Vsn], ?TIMEOUT),