%% -*- erlang-indent-level: 4; indent-tabs-mode: nil; fill-column: 80 -*- %%% Copyright 2012 Erlware, LLC. All Rights Reserved. %%% %%% This file is provided to you under the Apache License, %%% Version 2.0 (the "License"); you may not use this file %%% except in compliance with the License. You may obtain %%% a copy of the License at %%% %%% http://www.apache.org/licenses/LICENSE-2.0 %%% %%% Unless required by applicable law or agreed to in writing, %%% software distributed under the License is distributed on an %%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY %%% KIND, either express or implied. See the License for the %%% specific language governing permissions and limitations %%% under the License. %%%--------------------------------------------------------------------------- %%% @author Eric Merritt %%% @copyright (C) 2012 Erlware, LLC. %%% @doc -module(relx). -export([main/1, main/2, do/2, do/7, do/8, do/9, format_error/1, opt_spec_list/0]). -export_type([error/0]). -include("relx.hrl"). %%============================================================================ %% types %%============================================================================ -type error() :: {error, {Module::module(), Reason::term()}}. -type goal() :: string() | binary() | rlx_depsolver:constraint(). %%============================================================================ %% API %%============================================================================ -spec main([string()]) -> ok | error() | {ok, rlx_state:t()}. main(Args) -> main([], Args). main(ApiOptions, Args) -> OptSpecList = opt_spec_list(), Result = case getopt:parse(OptSpecList, Args) of {ok, {Options, NonOptions}} -> case lists:member(version, Options) of true -> application:load(relx), {ok, Vsn} = application:get_key(relx, vsn), io:format("~s~n", [Vsn]); false -> case lists:member(help, Options) of true -> usage(); false -> application:start(relx), do(ApiOptions++[{caller, command_line} | Options], NonOptions) end end; {error, Detail} -> ?RLX_ERROR({opt_parse, Detail}) end, case Result of {error, _} -> report_error(rlx_state:caller(rlx_state:new([], undefined), command_line), Result); _ -> Result end. %% @doc provides an API to run the Relx process from erlang applications %% %% @param RelName - The release name to build (maybe `undefined`) %% @param RelVsn - The release version to build (maybe `undefined`) %% @param Goals - The release goals for the system in depsolver or Relx goal %% format %% @param LibDirs - The library dirs that should be used for the system %% @param OutputDir - The directory where the release should be built to %% @param Configs - The list of config files for the system -spec do(atom(), string(), [goal()], [file:name()], ec_cmd_log:log_level(), [file:name()], file:name() | undefined) -> ok | error() | {ok, rlx_state:t()}. do(RelName, RelVsn, Goals, LibDirs, LogLevel, OutputDir, Config) -> {ok, Cwd} = file:get_cwd(), do(Cwd, RelName, RelVsn, Goals, LibDirs, LogLevel, OutputDir, [], Config). %% @doc provides an API to run the Relx process from erlang applications %% %% @param RootDir - The root directory for the project %% @param RelName - The release name to build (maybe `undefined`) %% @param RelVsn - The release version to build (maybe `undefined`) %% @param Goals - The release goals for the system in depsolver or Relx goal %% format %% @param LibDirs - The library dirs that should be used for the system %% @param OutputDir - The directory where the release should be built to %% @param Configs - The list of config files for the system -spec do(file:name(), atom(), string(), [goal()], [file:name()], ec_cmd_log:log_level(), [file:name()], file:name() | undefined) -> ok | error() | {ok, rlx_state:t()}. do(RootDir, RelName, RelVsn, Goals, LibDirs, LogLevel, OutputDir, Configs) -> do(RootDir, RelName, RelVsn, Goals, LibDirs, LogLevel, OutputDir, [], Configs). %% @doc provides an API to run the Relx process from erlang applications %% %% @param RootDir - The root directory for the system %% @param RelName - The release name to build (maybe `undefined`) %% @param RelVsn - The release version to build (maybe `undefined`) %% @param Goals - The release goals for the system in depsolver or Relx goal %% format %% @param LibDirs - The library dirs that should be used for the system %% @param OutputDir - The directory where the release should be built to %% @param Overrides - A list of overrides for the system %% @param Configs - The list of config files for the system -spec do(file:name(), atom(), string(), [goal()], [file:name()], ec_cmd_log:log_level(), [file:name()], [{atom(), file:name()}], file:name() | undefined) -> ok | error() | {ok, rlx_state:t()}. do(RootDir, RelName, RelVsn, Goals, LibDirs, LogLevel, OutputDir, Overrides, Config) -> do([{relname, RelName}, {relvsn, RelVsn}, {goals, Goals}, {overrides, Overrides}, {output_dir, OutputDir}, {lib_dirs, LibDirs}, {root_dir, RootDir}, {log_level, LogLevel}, {config, Config}], ["release"]). %% @doc provides an API to run the Relx process from erlang applications %% %% @param Opts - A proplist of options. There are good defaults for each of %% these entries, so any or all may be omitted. Individual options may be: %% %%
%% 
{relname, RelName}
%%
The release name to build
%% 
{relvsn, RelVsn}
%%
The release version to build
%% 
{goals, Goals}
%%
The release goals for the system in depsolver or Relx goal %% format (@see goals())
%% 
{lib_dirs, LibDirs}
%%
A list of library dirs that should be used for the system
%% 
{lib_dir, LibDir}
%%
A single lib dir that should be used for the system, may appear any %% number of times and may be used in conjunction with lib_dirs
%% 
{output_dir, OutputDir}
%%
The directory where the release should be built to
%% 
{root_dir, RootDir}
%%
The base directory for this run of relx.
%% 
{config, Config}
%%
The path to a relx config file
%% 
{log_level, LogLevel}
%%
Defines the verbosity of output. Maybe a number between 0 and 2, with %% with higher values being more verbose
%% 
{overrides, Overrides}
%%
A list of app overrides for the system in the form of [{AppName:atom(), %% Dir:string() | binary()} | string() | binary()] where the string or binary %% is in the form "AppName:AppDir"
%% 
{override, Override}
%%
A single of app override for the system in the same form as entries for %% Overrides
%%
-spec do(proplists:proplist(), [string()]) -> ok | error() | {ok, rlx_state:t()}. do(Opts, NonOpts) -> case rlx_cmd_args:args2state(Opts, NonOpts) of {ok, State} -> run_relx_process(State); Error={error, _} -> Error end. -spec opt_spec_list() -> [getopt:option_spec()]. opt_spec_list() -> [{relname, $n, "relname", string, "Specify the name for the release that will be generated"}, {relvsn, $v, "relvsn", string, "Specify the version for the release"}, {goal, $g, "goal", string, "Specify a target constraint on the system. These are usually the OTP"}, {upfrom, $u, "upfrom", string, "Only valid with relup target, specify the release to upgrade from"}, {output_dir, $o, "output-dir", string, "The output directory for the release. This is `./` by default."}, {help, $h, "help", undefined, "Print usage"}, {lib_dir, $l, "lib-dir", string, "Additional dir that should be searched for OTP Apps"}, {path, $p, "path", string, "Additional dir to add to the code path"}, {default_libs, undefined, "default-libs", boolean, "Whether to use the default system added lib dirs (means you must add them all manually). Default is true"}, {log_level, $V, "verbose", {integer, 2}, "Verbosity level, maybe between 0 and 3"}, {dev_mode, $d, "dev-mode", boolean, "Symlink the applications and configuration into the release instead of copying"}, {include_erts, $i, "include-erts", string, "If true include a copy of erts used to build with, if a path include erts at that path. If false, do not include erts"}, {override, $a, "override", string, "Provide an app name and a directory to override in the form :"}, {config, $c, "config", {string, ""}, "The path to a config file"}, {overlay_vars, undefined, "overlay_vars", string, "Path to a file of overlay variables"}, {vm_args, undefined, "vm_args", string, "Path to a file to use for vm.args"}, {sys_config, undefined, "sys_config", string, "Path to a file to use for sys.config"}, {system_libs, undefined, "system_libs", string, "Path to dir of Erlang system libs"}, {version, undefined, "version", undefined, "Print relx version"}, {root_dir, $r, "root", string, "The project root directory"}]. -spec format_error(Reason::term()) -> string(). format_error({invalid_return_value, Provider, Value}) -> io_lib:format(lists:flatten([providers:format(Provider), " returned an invalid value ", io_lib:format("~p", [Value])]), []); format_error({opt_parse, {invalid_option, Opt}}) -> io_lib:format("invalid option ~s~n", [Opt]); format_error({opt_parse, Arg}) -> io_lib:format("~p~n", [Arg]); format_error({invalid_action, Action}) -> io_lib:format("Invalid action specified: ~p~n", [Action]); format_error({error, {relx, Reason}}) -> format_error(Reason); format_error({error, {Module, Reason}}) -> io_lib:format("~s~n", [Module:format_error(Reason)]). %%============================================================================ %% internal api %%============================================================================ run_relx_process(State) -> ec_cmd_log:info(rlx_state:log(State), "Starting relx build process ..."), ec_cmd_log:debug(rlx_state:log(State), fun() -> rlx_state:format(State) end), run_providers(State). %% @doc for now the 'config' provider is special in that it generates the %% providers used by the rest of the system. We expect the config provider to be %% the first provider in the system. Once the config provider is run, we get the %% providers again and run the rest of them (because they could have been %% updated by the config process). run_providers(State0) -> case rlx_config:do(State0) of {ok, State1} -> Actions = rlx_state:actions(State1), AllProviders = rlx_state:providers(State1), case check_actions_correctness(Actions, AllProviders) of ok -> run_providers_for_actions(Actions, State1); Err -> Err end; Err -> Err end. check_actions_correctness(Actions, Providers) -> lists:foldl(fun(Action, ok) -> case providers:get_provider(Action, Providers) of not_found -> ?RLX_ERROR({invalid_action, Action}); _ -> ok end; (_Action, Error) -> Error end, ok, Actions). run_providers_for_actions(Actions, State) -> AllProviders = rlx_state:providers(State), TargetProviders = lists:flatmap(fun(Target) -> providers:get_target_providers(Target, AllProviders) end, Actions), Providers1 = lists:map(fun(P) -> providers:get_provider(P, AllProviders) end, TargetProviders), %% Unique Sort Providers Providers2 = providers:process_deps(Providers1, AllProviders), RootDir = rlx_state:root_dir(State), ok = file:set_cwd(RootDir), Result = lists:foldl(fun run_provider/2, {ok, State}, Providers2), handle_output(State, rlx_state:caller(State), Result). handle_output(State, command_line, E={error, _}) -> report_error(State, E), init:stop(127); handle_output(_State, command_line, _) -> init:stop(0); handle_output(_State, api, Result) -> Result. -spec run_provider(atom(), {ok, rlx_state:t()} | error()) -> {ok, rlx_state:t()} | error(). run_provider(ProviderName, {ok, State0}) -> Provider = providers:get_provider(ProviderName, rlx_state:providers(State0)), ec_cmd_log:debug(rlx_state:log(State0), "Running provider ~p~n", [providers:impl(Provider)]), case providers:do(Provider, State0) of {ok, State1} -> ec_cmd_log:debug(rlx_state:log(State0), "Provider successfully run: ~p~n", [providers:impl(Provider)]), {ok, State1}; E={error, _} -> ec_cmd_log:debug(rlx_state:log(State0), "Provider (~p) failed with: ~p~n", [providers:impl(Provider), E]), E end; run_provider(_ProviderName, Error) -> Error. -spec usage() -> ok. usage() -> getopt:usage(opt_spec_list(), "relx", "[]"), io:format("Several tasks are available:~n~nrelease\t\tCreate release.~nrelup\t\tGenerate a release upgrade.~ntar\t\tCreate tarball archive of a release.~n~n"). -spec report_error(rlx_state:t(), error()) -> none() | error(). report_error(State, Error) -> case Error of {error, {relx, {opt_parse, _}}} -> io:format(standard_error, format_error(Error), []), usage(); {error, {rlx_cmd_args, _}} -> io:format(standard_error, format_error(Error), []), usage(); _ -> io:format(standard_error, format_error(Error), []) end, case rlx_state:caller(State) of command_line -> erlang:halt(127); api -> Error end.