Initial version of the Manifest plugin (experimental)

apps/rebar/src/rebar.app.src.script

@@ -66,6 +66,7 @@
                      rebar_prv_local_install,
                      rebar_prv_local_upgrade,
                      rebar_prv_lock,
+                     rebar_prv_manifest,
                      rebar_prv_new,
                      rebar_prv_packages,
                      rebar_prv_path,

apps/rebar/src/rebar_prv_manifest.erl

@@ -0,0 +1,138 @@
+%% ===================================================================
+%% Manifest Provider
+%% ===================================================================
+-module(rebar_prv_manifest).
+-behaviour(provider).
+-export([init/1,
+         do/1,
+         format_error/1]).
+
+-include_lib("providers/include/providers.hrl").
+
+-define(PROVIDER, manifest).
+-define(DEFAULT_FORMAT, erlang).
+
+-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()}.
+-type manifest() :: #{
+                      apps := [app_context()],
+                      deps := [app_context()],
+                      otp_lib_dir := string(),
+                      source_root := string()
+                     }.
+
+-type format() :: erlang | eetf.
+
+%% ===================================================================
+%% Provider Callbacks
+%% ===================================================================
+-spec init(rebar_state:t()) -> {ok, rebar_state:t()}.
+init(State) ->
+
+  %% By default, the provider outputs the manifest to stdout, so disable logs
+  %% not to interfere.
+  ok = rebar_log:init(api, 0),
+
+  State1 = rebar_state:add_provider(
+             State,
+             providers:create([
+                               {name, ?PROVIDER},
+                               {module, ?MODULE},
+                               {bare, true},
+                               {deps, [install_deps]},
+                               {example, "rebar3 manifest"},
+                               {short_desc, short_desc()},
+                               {desc, desc()},
+                               {opts, options()}
+                              ])
+            ),
+  {ok, State1}.
+
+-spec do(rebar_state:t()) -> {ok, rebar_state:t()} | {error, string()}.
+do(State) ->
+
+  {Opts, _} = rebar_state:command_parsed_args(State),
+  Format = proplists:get_value(format, Opts),
+  To = proplists:get_value(to, Opts),
+
+  Manifest = get_manifest(State),
+  case format(Manifest, Format) of
+    {ok, Formatted} ->
+      case output_manifest(Formatted, To) of
+        ok ->
+          {ok, State};
+        {error, Error} ->
+          ?PRV_ERROR({output_error, To, Error})
+      end;
+    {error, Error} ->
+      ?PRV_ERROR(Error)
+  end.
+
+-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({output_error, To, Error}) ->
+  io_lib:format("Could not output manifest to ~p (~p)", [To, Error]);
+format_error(Reason) ->
+  io_lib:format("~p", [Reason]).
+
+%% ===================================================================
+%% Internal Helpers
+%% ===================================================================
+-spec short_desc() -> string().
+short_desc() ->
+  "Produce a project manifest".
+
+-spec desc() -> string().
+desc() ->
+  short_desc().
+
+-spec options() -> [tuple()].
+options() ->
+  [
+   {format, $f, "format", {atom, ?DEFAULT_FORMAT},
+    "Format for the manifest. "
+    "Supported formats are: erlang, eetf (Erlang External Binary Format)"},
+   {to, $t, "to", {string, undefined},
+    "If specified, write the manifest to file"}
+  ].
+
+-spec get_manifest(rebar_state:t()) -> manifest().
+get_manifest(State) ->
+  ProjectApps = rebar_state:project_apps(State),
+  DepApps = rebar_state:all_deps(State),
+  #{
+    apps => [adapt_context(App) || App <- ProjectApps],
+    deps => [adapt_context(App) || App <- DepApps],
+    otp_lib_dir => code:lib_dir(),
+    source_root => rebar_state:dir(State)
+   }.
+
+-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).
+
+-spec output_manifest(binary(), string() | undefined) -> ok | {error, term()}.
+output_manifest(Manifest, undefined) ->
+  rebar_log:log(info, "Writing manifest to stdout:~n", []),
+  io:fwrite("~s~n", [Manifest]);
+output_manifest(Manifest, 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()}}.
+format(Manifest, eetf) ->
+  {ok, term_to_binary(Manifest)};
+format(Manifest, erlang) ->
+  {ok, unicode:characters_to_binary(io_lib:format("~p.", [Manifest]))};
+format(_Manifest, Format) ->
+  {error, {format_not_supported, Format}}.

apps/rebar/test/rebar_manifest_SUITE.erl

@@ -0,0 +1,67 @@
+-module(rebar_manifest_SUITE).
+
+-export([all/0,
+         init_per_testcase/2,
+         end_per_testcase/2,
+         basic_check/1,
+         write_to_file_erlang/1,
+         write_to_file_eetf/1,
+         non_supported_format/1
+        ]).
+
+-include_lib("common_test/include/ct.hrl").
+-include_lib("stdlib/include/assert.hrl").
+
+all() -> [
+          basic_check,
+          write_to_file_erlang,
+          write_to_file_eetf,
+          non_supported_format
+         ].
+
+init_per_testcase(Case, Config0) ->
+    %% Create a project directory in the test run's priv_dir
+    Config = rebar_test_utils:init_rebar_state(Config0),
+    %% Create toy applications
+    AppDir = ?config(apps, Config),
+    Name = rebar_test_utils:create_random_name("app1_"++atom_to_list(Case)),
+    Vsn = rebar_test_utils:create_random_vsn(),
+    rebar_test_utils:create_app(AppDir, Name, Vsn, [kernel, stdlib]),
+    %% Add the data to the test config
+    [{name, unicode:characters_to_binary(Name)} | Config].
+
+end_per_testcase(_, Config) ->
+    Config.
+
+basic_check(Config) ->
+  rebar_test_utils:run_and_check(Config, [],
+                                 ["manifest"],
+                                 {ok, []}).
+
+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, [],
+                                 ["manifest", "--to", FilePath],
+                                 {ok, []}),
+  {ok, [Manifest]} = file:consult(FilePath),
+  ?assertMatch(#{deps := [], apps := [#{name := AppName}]}, Manifest).
+
+write_to_file_eetf(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, [],
+                                 ["manifest", "--to", FilePath, "--format", "eetf"],
+                                 {ok, []}),
+  {ok, Content} = file:read_file(FilePath),
+  Manifest = binary_to_term(Content),
+  ?assertMatch(#{deps := [], apps := [#{name := AppName}]}, Manifest).
+
+non_supported_format(Config) ->
+  PrivDir = proplists:get_value(priv_dir, Config),
+  FilePath = filename:join([PrivDir, "manifest"]),
+  rebar_test_utils:run_and_check(Config, [],
+                                 ["manifest", "--to", FilePath, "--format", "non-existing"],
+                                 {error,{rebar_prv_manifest,{format_not_supported,'non-existing'}}}).