aboutsummaryrefslogtreecommitdiffstats
path: root/src/rlx_app_discovery.erl
diff options
context:
space:
mode:
authorJordan Wilberding <[email protected]>2013-05-14 20:59:32 -0700
committerJordan Wilberding <[email protected]>2013-05-14 20:59:32 -0700
commit834fc00544e4222e5fe1713c33d16e5192de33fe (patch)
tree1ae9a327feeb420983f9a85fdb6c800900369480 /src/rlx_app_discovery.erl
parentd2698281ff1b0a46b2bcf6c2579cc811a3f62500 (diff)
parentc5f0a8c9175b2d152c69f72da15e7ceff411f86b (diff)
downloadrelx-834fc00544e4222e5fe1713c33d16e5192de33fe.tar.gz
relx-834fc00544e4222e5fe1713c33d16e5192de33fe.tar.bz2
relx-834fc00544e4222e5fe1713c33d16e5192de33fe.zip
Merge pull request #2 from ericbmerritt/rename-to-relx
Relup + rename support
Diffstat (limited to 'src/rlx_app_discovery.erl')
-rw-r--r--src/rlx_app_discovery.erl207
1 files changed, 207 insertions, 0 deletions
diff --git a/src/rlx_app_discovery.erl b/src/rlx_app_discovery.erl
new file mode 100644
index 0000000..e6b6e2c
--- /dev/null
+++ b/src/rlx_app_discovery.erl
@@ -0,0 +1,207 @@
+%% -*- 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 <[email protected]>
+%%% @copyright (C) 2012 Erlware, LLC.
+%%%
+%%% @doc This provider uses the lib_dir setting of the state. It searches the
+%%% Lib Dirs looking for all OTP Applications that are available. When it finds
+%%% those OTP Applications it loads the information about them and adds them to
+%%% the state of available apps. This implements the rlx_provider behaviour.
+-module(rlx_app_discovery).
+
+-export([do/2,
+ format_error/1]).
+
+-include_lib("relx/include/relx.hrl").
+
+%%============================================================================
+%% API
+%%============================================================================
+
+%% @doc recursively dig down into the library directories specified in the state
+%% looking for OTP Applications
+-spec do(rlx_state:t(), [filename:name()]) -> {ok, [rlx_app_info:t()]} | relx:error().
+do(State, LibDirs) ->
+ rlx_log:info(rlx_state:log(State),
+ fun() ->
+ ["Resolving OTP Applications from directories:\n",
+ [[rlx_util:indent(1), LibDir, "\n"] || LibDir <- LibDirs]]
+ end),
+ resolve_app_metadata(State, LibDirs).
+
+-spec format_error([ErrorDetail::term()]) -> iolist().
+format_error(ErrorDetails)
+ when erlang:is_list(ErrorDetails) ->
+ [[format_detail(ErrorDetail), "\n"] || ErrorDetail <- ErrorDetails].
+
+%%%===================================================================
+%%% Internal Functions
+%%%===================================================================
+resolve_app_metadata(State, LibDirs) ->
+ AppMeta0 = lists:flatten(rlx_dscv_util:do(fun discover_dir/2, LibDirs)),
+ case [case Err of
+ {error, Ret} ->
+ Ret
+ end
+ || Err <- AppMeta0,
+ case Err of
+ {error, _} ->
+ true;
+ _ ->
+ false
+ end] of
+ [] ->
+ SkipApps = rlx_state:skip_apps(State),
+ AppMeta1 = [App || {ok, App} <- setup_overrides(State, AppMeta0),
+ not lists:keymember(rlx_app_info:name(App), 1, SkipApps)],
+ rlx_log:debug(rlx_state:log(State),
+ fun() ->
+ ["Resolved the following OTP Applications from the system: \n",
+ [[rlx_app_info:format(1, App), "\n"] || App <- AppMeta1]]
+ end),
+ {ok, AppMeta1};
+ Errors ->
+ ?RLX_ERROR(Errors)
+ end.
+
+app_name({error, _}) ->
+ undefined;
+app_name({ok, AppMeta}) ->
+ rlx_app_info:name(AppMeta).
+
+setup_overrides(State, AppMetas0) ->
+ Overrides = rlx_state:overrides(State),
+ AppMetas1 = [AppMeta || AppMeta <- AppMetas0,
+ not lists:keymember(app_name(AppMeta), 1, Overrides)],
+ [case is_valid_otp_app(filename:join([FileName, <<"ebin">>,
+ erlang:atom_to_list(AppName) ++ ".app"])) of
+ {noresult, false} ->
+ {error, {invalid_override, AppName, FileName}};
+ Error = {error, _} ->
+ Error;
+ {ok, App} ->
+ {ok, rlx_app_info:link(App, true)}
+ end || {AppName, FileName} <- Overrides] ++ AppMetas1.
+
+
+-spec format_detail(ErrorDetail::term()) -> iolist().
+format_detail({error, {invalid_override, AppName, FileName}}) ->
+ io_lib:format("Override {~p, ~p} is not a valid OTP App. Perhaps you forgot to build it?",
+ [AppName, FileName]);
+format_detail({accessing, File, eaccess}) ->
+ io_lib:format("permission denied accessing file ~s", [File]);
+format_detail({accessing, File, Type}) ->
+ io_lib:format("error (~p) accessing file ~s", [Type, File]);
+format_detail({no_beam_files, EbinDir}) ->
+ io_lib:format("no beam files found in directory ~s", [EbinDir]);
+format_detail({not_a_directory, EbinDir}) ->
+ io_lib:format("~s is not a directory when it should be a directory", [EbinDir]);
+format_detail({unable_to_load_app, AppDir, _}) ->
+ io_lib:format("Unable to load the application metadata from ~s", [AppDir]);
+format_detail({invalid_app_file, File}) ->
+ io_lib:format("Application metadata file exists but is malformed: ~s",
+ [File]);
+format_detail({unversioned_app, AppDir, _AppName}) ->
+ io_lib:format("Application metadata exists but version is not available: ~s",
+ [AppDir]);
+format_detail({app_info_error, {Module, Detail}}) ->
+ Module:format_error(Detail).
+
+-spec discover_dir([file:name()], directory | file) ->
+ {ok, rlx_app_info:t()} | {error, Reason::term()}.
+discover_dir(_File, directory) ->
+ {noresult, true};
+discover_dir(File, file) ->
+ is_valid_otp_app(File).
+
+-spec is_valid_otp_app(file:name()) -> {ok, rlx_app_info:t()} | {error, Reason::term()} |
+ {noresult, false}.
+
+is_valid_otp_app(File) ->
+ %% Is this an ebin dir?
+ EbinDir = filename:dirname(File),
+ case filename:basename(EbinDir) of
+ <<"ebin">> ->
+ case filename:extension(File) of
+ <<".app">> ->
+ has_at_least_one_beam(EbinDir, File);
+ _ ->
+ {noresult, false}
+ end;
+ _ ->
+ {noresult, false}
+ end.
+
+-spec has_at_least_one_beam(file:name(), file:filename()) ->
+ {ok, rlx_app_info:t()} | {error, Reason::term()}.
+has_at_least_one_beam(EbinDir, File) ->
+ case file:list_dir(EbinDir) of
+ {ok, List} ->
+ case lists:any(fun(NFile) -> lists:suffix(".beam", NFile) end, List) of
+ true ->
+ gather_application_info(EbinDir, File);
+ false ->
+ {error, {no_beam_files, EbinDir}}
+ end;
+ _ ->
+ {error, {not_a_directory, EbinDir}}
+ end.
+
+-spec gather_application_info(file:name(), file:filename()) ->
+ {ok, rlx_app_info:t()} | {error, Reason::term()}.
+gather_application_info(EbinDir, File) ->
+ AppDir = filename:dirname(EbinDir),
+ case file:consult(File) of
+ {ok, [{application, AppName, AppDetail}]} ->
+ get_vsn(AppDir, AppName, AppDetail);
+ {error, Reason} ->
+ {error, {unable_to_load_app, AppDir, Reason}};
+ _ ->
+ {error, {invalid_app_file, File}}
+ end.
+
+-spec get_vsn(file:name(), atom(), proplists:proplist()) ->
+ {ok, rlx_app_info:t()} | {error, Reason::term()}.
+get_vsn(AppDir, AppName, AppDetail) ->
+ case proplists:get_value(vsn, AppDetail) of
+ undefined ->
+ {error, {unversioned_app, AppDir, AppName}};
+ AppVsn ->
+ case get_deps(AppDir, AppName, AppVsn, AppDetail) of
+ {ok, App} ->
+ {ok, App};
+ {error, Detail} ->
+ {error, {app_info_error, Detail}}
+ end
+ end.
+
+-spec get_deps(file:name(), atom(), string(), proplists:proplist()) ->
+ {ok, rlx_app_info:t()} | {error, Reason::term()}.
+get_deps(AppDir, AppName, AppVsn, AppDetail) ->
+ ActiveApps = proplists:get_value(applications, AppDetail, []),
+ LibraryApps = proplists:get_value(included_applications, AppDetail, []),
+ rlx_app_info:new(AppName, AppVsn, AppDir, ActiveApps, LibraryApps).
+
+%%%===================================================================
+%%% Test Functions
+%%%===================================================================
+
+-ifndef(NOTEST).
+-include_lib("eunit/include/eunit.hrl").
+
+-endif.