Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Tweak manifest plugin to return ELP compatible information. #2910

Merged
merged 3 commits into from
Aug 11, 2024
Merged

Tweak manifest plugin to return ELP compatible information. #2910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
053b12e
Tweak manifest plugin to return ELP compatible information.
robertoaloi Aug 7, 2024
9353ecb
Introduce JSON output (requires OTP 27) and make it default
robertoaloi Aug 8, 2024
f1afc05
Fix spelling for error message in case of missing json module
robertoaloi Aug 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 71 additions & 25 deletions apps/rebar/src/rebar_prv_manifest.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,30 @@

-export([init/1,
do/1,
format_error/1]).
format_error/1,
is_json_available/0]).

-include_lib("providers/include/providers.hrl").

-define(PROVIDER, manifest).
-define(NAMESPACE, experimental).
-define(DEFAULT_FORMAT, erlang).
-define(DEFAULT_FORMAT, json).

-type extension() :: string().
-type app_context() :: #{name := binary(),
src_dirs := [file:filename()],
include_dirs := [file:filename()],
src_ext := extension(),
out_mappings := [#{extension := extension(),
path := file:filename()}],
dependencies_opts => any()}.
dir => file:filename_all(),
ebin => file:filename_all(),
src_dirs := [file:filename_all()],
extra_src_dirs := [file:filename_all()],
include_dirs := [file:filename_all()],
macros => [macro()],
parse_transforms => [any()]}.
-type macro() :: #{key := atom(), value => any()}.
-type manifest() :: #{ apps := [app_context()],
deps := [app_context()],
otp_lib_dir := file:filename(),
source_root := file:filename()}.
otp_lib_dir := file:filename_all(),
source_root := file:filename_all()}.

-type format() :: erlang | eetf.
-type format() :: erlang | eetf | json.

%% ===================================================================
%% Public API
Expand Down Expand Up @@ -72,6 +74,8 @@ do(State) ->
-spec format_error(any()) -> iolist().
format_error({format_not_supported, Format}) ->
io_lib:format("Format '~p' is not supported. Try 'erlang' or 'eetf'.", [Format]);
format_error(no_json_module) ->
io_lib:format("The 'json' module is not available. Either upgrade to OTP 27 or newer, or select a different output format.", []);
format_error({output_error, To, Error}) ->
io_lib:format("Could not output manifest to ~p (~p)", [To, Error]);
format_error(Reason) ->
Expand All @@ -92,7 +96,7 @@ desc() ->
options() ->
[{format, $f, "format", {atom, ?DEFAULT_FORMAT},
"Format for the manifest. "
"Supported formats are: erlang, eetf (Erlang External Binary Format)"},
"Supported formats are: erlang, eetf (Erlang External Binary Format), json"},
{to, $t, "to", {string, undefined},
"If specified, write the manifest to file"}].

Expand All @@ -102,8 +106,8 @@ get_manifest(State) ->
DepApps = rebar_state:all_deps(State),
#{apps => [adapt_context(App) || App <- ProjectApps, is_supported(App)],
deps => [adapt_context(App) || App <- DepApps, is_supported(App)],
otp_lib_dir => code:lib_dir(),
source_root => rebar_state:dir(State)}.
otp_lib_dir => to_binary(code:lib_dir()),
source_root => to_binary(rebar_state:dir(State))}.

-spec is_supported(rebar_app_info:t()) -> boolean().
is_supported(App) ->
Expand All @@ -112,29 +116,71 @@ is_supported(App) ->

-spec adapt_context(rebar_app_info:t()) -> app_context().
adapt_context(App) ->
Context0 = rebar_compiler_erl:context(App),
Context1 = maps:put(name, rebar_app_info:name(App), Context0),
OutMappings = [#{extension => Extension, path => Path} ||
{Extension, Path} <- maps:get(out_mappings, Context1)],
maps:put(out_mappings, OutMappings, Context1).
Context = rebar_compiler_erl:context(App),
#{src_dirs := SrcDirs,
include_dirs := IncludeDirs,
dependencies_opts := DependenciesOpts} = Context,
Name = rebar_app_info:name(App),
Dir = rebar_app_info:dir(App),
EbinDir = rebar_app_info:ebin_dir(App),
RebarOpts = rebar_app_info:opts(App),
ExtraSrcDirs = rebar_dir:extra_src_dirs(RebarOpts),
Macros = proplists:get_value(macros, DependenciesOpts),
ParseTransforms = proplists:get_value(parse_transforms, DependenciesOpts),
#{name => Name,
dir => to_binary(Dir),
ebin => to_binary(EbinDir),
src_dirs => [to_binary(D) || D <- SrcDirs],
extra_src_dirs => [to_binary(D) || D <- ExtraSrcDirs],
include_dirs => [to_binary(D) || D <- IncludeDirs],
macros => [to_macro(M) || M <- Macros],
parse_transforms => ParseTransforms}.

-spec output_manifest(binary(), format(), string() | undefined) -> ok | {error, term()}.
output_manifest(Manifest, Format, undefined) ->
rebar_log:log(info, "Writing manifest to stdout:~n", []),
case Format of
erlang ->
io:fwrite("~ts~n", [Manifest]);
eetf ->
io:fwrite("~s~n", [Manifest])
eetf ->
io:fwrite("~s~n", [Manifest]);
_ ->
io:fwrite("~ts~n", [Manifest])
end;
output_manifest(Manifest, _Format, File) ->
rebar_log:log(info, "Build info written to: ~ts~n", [File]),
file:write_file(File, Manifest).

-spec format(manifest(), format()) -> {ok, binary()} | {error, {format_not_supported, term()}}.
-spec format(manifest(), format()) -> {ok, binary()} | {error, {format_not_supported, term()} | no_json_module}.
format(Manifest, eetf) ->
{ok, term_to_binary(Manifest)};
format(Manifest, erlang) ->
{ok, unicode:characters_to_binary(io_lib:format("~p.", [Manifest]))};
format(Manifest, json) ->
case is_json_available() of
true ->
Encoded = erlang:apply(json, encode, [Manifest]),
{ok, Encoded};
false ->
{error, no_json_module}
end;
format(_Manifest, Format) ->
{error, {format_not_supported, Format}}.

-spec to_binary(file:filename()) -> file:filename_all().
to_binary(Path) ->
unicode:characters_to_binary(Path).

-spec to_macro(atom() | {atom() | any()}) -> macro().
to_macro({Key, Value}) when is_atom(Key) ->
#{key => Key, value => Value};
to_macro(Key) when is_atom(Key) ->
#{key => Key, value => true}.

-spec is_json_available() -> boolean().
is_json_available() ->
% Requires OTP 27
case code:ensure_loaded(json) of
{module, _} ->
true;
{error, _} ->
false
end.
35 changes: 31 additions & 4 deletions apps/rebar/test/rebar_manifest_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
basic_check/1,
write_to_file_erlang/1,
write_to_file_eetf/1,
write_to_file_json/1,
non_supported_format/1]).

-include_lib("common_test/include/ct.hrl").
Expand All @@ -16,6 +17,7 @@
all() -> [basic_check,
write_to_file_erlang,
write_to_file_eetf,
write_to_file_json,
non_supported_format].

init_per_testcase(Case, Config0) ->
Expand All @@ -33,16 +35,23 @@ end_per_testcase(_, Config) ->
Config.

basic_check(Config) ->
rebar_test_utils:run_and_check(Config, [],
[?NAMESPACE, "manifest"],
{ok, []}).
case rebar_prv_manifest:is_json_available() of
true ->
rebar_test_utils:run_and_check(Config, [],
[?NAMESPACE, "manifest"],
{ok, []});
false ->
rebar_test_utils:run_and_check(Config, [],
[?NAMESPACE, "manifest"],
{error, {rebar_prv_manifest, no_json_module}})
end.

write_to_file_erlang(Config) ->
AppName = proplists:get_value(name, Config),
PrivDir = proplists:get_value(priv_dir, Config),
FilePath = filename:join([PrivDir, "manifest"]),
rebar_test_utils:run_and_check(Config, [],
[?NAMESPACE, "manifest", "--to", FilePath],
[?NAMESPACE, "manifest", "--to", FilePath, "--format", "erlang"],
{ok, []}),
{ok, [Manifest]} = file:consult(FilePath),
?assertMatch(#{deps := [], apps := [#{name := AppName}]}, Manifest).
Expand All @@ -58,6 +67,24 @@ write_to_file_eetf(Config) ->
Manifest = binary_to_term(Content),
?assertMatch(#{deps := [], apps := [#{name := AppName}]}, Manifest).

write_to_file_json(Config) ->
AppName = proplists:get_value(name, Config),
PrivDir = proplists:get_value(priv_dir, Config),
FilePath = filename:join([PrivDir, "manifest"]),
case rebar_prv_manifest:is_json_available() of
true ->
rebar_test_utils:run_and_check(Config, [],
[?NAMESPACE, "manifest", "--to", FilePath],
{ok, []}),
{ok, Content} = file:read_file(FilePath),
Manifest = erlang:apply(json, decode, [Content]),
?assertMatch(#{<<"deps">> := [], <<"apps">> := [#{<<"name">> := AppName}]}, Manifest);
false ->
rebar_test_utils:run_and_check(Config, [],
[?NAMESPACE, "manifest", "--to", FilePath, "--format", "json"],
{error, {rebar_prv_manifest, no_json_module}})
end.

non_supported_format(Config) ->
PrivDir = proplists:get_value(priv_dir, Config),
FilePath = filename:join([PrivDir, "manifest"]),
Expand Down
Loading