%%% -*- mode: Erlang; fill-column: 80; comment-column: 75; -*-
%%% 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 Merrit <[email protected]>
%%% @copyright (C) 2012, Eric Merrit
-module(rclt_release_SUITE).
-export([suite/0,
init_per_suite/1,
end_per_suite/1,
init_per_testcase/2,
all/0,
make_release/1,
make_overridden_release/1,
make_rerun_overridden_release/1,
make_implicit_config_release/1,
overlay_release/1]).
-include_lib("common_test/include/ct.hrl").
-include_lib("eunit/include/eunit.hrl").
-include_lib("kernel/include/file.hrl").
suite() ->
[{timetrap,{seconds,30}}].
init_per_suite(Config) ->
Config.
end_per_suite(_Config) ->
ok.
init_per_testcase(_, Config) ->
DataDir = proplists:get_value(data_dir, Config),
LibDir1 = filename:join([DataDir, create_random_name("lib_dir1_")]),
ok = rcl_util:mkdir_p(LibDir1),
State = rcl_state:new([{lib_dirs, [LibDir1]}], []),
[{lib1, LibDir1},
{state, State} | Config].
all() ->
[make_release, make_overridden_release, make_implicit_config_release,
make_rerun_overridden_release, overlay_release].
make_release(Config) ->
LibDir1 = proplists:get_value(lib1, Config),
[(fun({Name, Vsn}) ->
create_app(LibDir1, Name, Vsn, [kernel, stdlib], [])
end)(App)
||
App <-
[{create_random_name("lib_app1_"), create_random_vsn()}
|| _ <- lists:seq(1, 100)]],
create_app(LibDir1, "goal_app_1", "0.0.1", [stdlib,kernel,non_goal_1], []),
create_app(LibDir1, "lib_dep_1", "0.0.1", [stdlib,kernel], []),
create_app(LibDir1, "goal_app_2", "0.0.1", [stdlib,kernel,goal_app_1,non_goal_2], []),
create_app(LibDir1, "non_goal_1", "0.0.1", [stdlib,kernel], [lib_dep_1]),
create_app(LibDir1, "non_goal_2", "0.0.1", [stdlib,kernel], []),
ConfigFile = filename:join([LibDir1, "relcool.config"]),
write_config(ConfigFile,
[{release, {foo, "0.0.1"},
[goal_app_1,
goal_app_2]}]),
OutputDir = filename:join([proplists:get_value(data_dir, Config),
create_random_name("relcool-output")]),
{ok, State} = relcool:do(undefined, undefined, [], [LibDir1], 2,
OutputDir, [ConfigFile]),
[{{foo, "0.0.1"}, Release}] = ec_dictionary:to_list(rcl_state:releases(State)),
AppSpecs = rcl_release:applications(Release),
?assert(lists:keymember(stdlib, 1, AppSpecs)),
?assert(lists:keymember(kernel, 1, AppSpecs)),
?assert(lists:member({non_goal_1, "0.0.1"}, AppSpecs)),
?assert(lists:member({non_goal_2, "0.0.1"}, AppSpecs)),
?assert(lists:member({goal_app_1, "0.0.1"}, AppSpecs)),
?assert(lists:member({goal_app_2, "0.0.1"}, AppSpecs)),
?assert(lists:member({lib_dep_1, "0.0.1", load}, AppSpecs)).
make_overridden_release(Config) ->
DataDir = proplists:get_value(data_dir, Config),
OverrideDir1 = filename:join([DataDir, create_random_name("override_dir_")]),
LibDir1 = proplists:get_value(lib1, Config),
[(fun({Name, Vsn}) ->
create_app(LibDir1, Name, Vsn, [kernel, stdlib], [])
end)(App)
||
App <-
[{create_random_name("lib_app1_"), create_random_vsn()}
|| _ <- lists:seq(1, 100)]],
OverrideApp = create_random_name("override_app"),
OverrideVsn = create_random_vsn(),
OverrideAppDir = filename:join(OverrideDir1, OverrideApp),
OverrideAppName = erlang:list_to_atom(OverrideApp),
create_app(LibDir1, "goal_app_1", "0.0.1", [stdlib,kernel,non_goal_1], []),
create_app(LibDir1, "lib_dep_1", "0.0.1", [stdlib,kernel], []),
create_app(LibDir1, "goal_app_2", "0.0.1", [stdlib,kernel,goal_app_1,non_goal_2], []),
create_app(LibDir1, "non_goal_1", "0.0.1", [stdlib,kernel], [lib_dep_1]),
create_app(LibDir1, "non_goal_2", "0.0.1", [stdlib,kernel], []),
create_app(OverrideDir1, OverrideApp, OverrideVsn, [stdlib,kernel], []),
ConfigFile = filename:join([LibDir1, "relcool.config"]),
write_config(ConfigFile,
[{release, {foo, "0.0.1"},
[goal_app_1,
erlang:list_to_atom(OverrideApp),
goal_app_2]}]),
OutputDir = filename:join([proplists:get_value(data_dir, Config),
create_random_name("relcool-output")]),
{ok, State} = relcool:do(undefined, undefined, [], [LibDir1], 2,
OutputDir, [{OverrideAppName, OverrideAppDir}],
[ConfigFile]),
[{{foo, "0.0.1"}, Release}] = ec_dictionary:to_list(rcl_state:releases(State)),
AppSpecs = rcl_release:applications(Release),
?assert(lists:keymember(stdlib, 1, AppSpecs)),
?assert(lists:keymember(kernel, 1, AppSpecs)),
?assert(lists:member({non_goal_1, "0.0.1"}, AppSpecs)),
?assert(lists:member({non_goal_2, "0.0.1"}, AppSpecs)),
?assert(lists:member({goal_app_1, "0.0.1"}, AppSpecs)),
?assert(lists:member({goal_app_2, "0.0.1"}, AppSpecs)),
?assert(lists:member({OverrideAppName, OverrideVsn}, AppSpecs)),
?assert(lists:member({lib_dep_1, "0.0.1", load}, AppSpecs)),
{ok, Real} = file:read_link(filename:join([OutputDir, "lib",
OverrideApp ++ "-" ++ OverrideVsn])),
?assertMatch(OverrideAppDir, Real).
make_implicit_config_release(Config) ->
LibDir1 = proplists:get_value(lib1, Config),
FooRoot = filename:join([LibDir1, "foodir1", "foodir2"]),
filelib:ensure_dir(filename:join([FooRoot, "tmp"])),
[(fun({Name, Vsn}) ->
create_app(LibDir1, Name, Vsn, [kernel, stdlib], [])
end)(App)
||
App <-
[{create_random_name("lib_app1_"), create_random_vsn()}
|| _ <- lists:seq(1, 100)]],
create_app(LibDir1, "goal_app_1", "0.0.1", [stdlib,kernel,non_goal_1], []),
create_app(LibDir1, "lib_dep_1", "0.0.1", [stdlib,kernel], []),
create_app(LibDir1, "goal_app_2", "0.0.1", [stdlib,kernel,goal_app_1,non_goal_2], []),
create_app(LibDir1, "non_goal_1", "0.0.1", [stdlib,kernel], [lib_dep_1]),
create_app(LibDir1, "non_goal_2", "0.0.1", [stdlib,kernel], []),
ConfigFile = filename:join([LibDir1, "relcool.config"]),
write_config(ConfigFile,
[{release, {foo, "0.0.1"},
[goal_app_1,
goal_app_2]}]),
OutputDir = filename:join([proplists:get_value(data_dir, Config),
create_random_name("relcool-output")]),
ok = file:set_cwd(FooRoot),
{ok, FooRoot} = file:get_cwd(),
{ok, State} = relcool:do(undefined, undefined, [], [LibDir1], 2,
OutputDir, []),
[{{foo, "0.0.1"}, Release}] = ec_dictionary:to_list(rcl_state:releases(State)),
?assert(ec_file:exists(OutputDir)),
AppSpecs = rcl_release:applications(Release),
?assert(lists:keymember(stdlib, 1, AppSpecs)),
?assert(lists:keymember(kernel, 1, AppSpecs)),
?assert(lists:member({non_goal_1, "0.0.1"}, AppSpecs)),
?assert(lists:member({non_goal_2, "0.0.1"}, AppSpecs)),
?assert(lists:member({goal_app_1, "0.0.1"}, AppSpecs)),
?assert(lists:member({goal_app_2, "0.0.1"}, AppSpecs)),
?assert(lists:member({lib_dep_1, "0.0.1", load}, AppSpecs)).
make_rerun_overridden_release(Config) ->
DataDir = proplists:get_value(data_dir, Config),
OverrideDir1 = filename:join([DataDir, create_random_name("override_dir_")]),
LibDir1 = proplists:get_value(lib1, Config),
[(fun({Name, Vsn}) ->
create_app(LibDir1, Name, Vsn, [kernel, stdlib], [])
end)(App)
||
App <-
[{create_random_name("lib_app1_"), create_random_vsn()}
|| _ <- lists:seq(1, 100)]],
OverrideApp = create_random_name("override_app"),
OverrideVsn = create_random_vsn(),
OverrideAppDir = filename:join(OverrideDir1, OverrideApp),
OverrideAppName = erlang:list_to_atom(OverrideApp),
create_app(LibDir1, "goal_app_1", "0.0.1", [stdlib,kernel,non_goal_1], []),
create_app(LibDir1, "lib_dep_1", "0.0.1", [stdlib,kernel], []),
create_app(LibDir1, "goal_app_2", "0.0.1", [stdlib,kernel,goal_app_1,non_goal_2], []),
create_app(LibDir1, "non_goal_1", "0.0.1", [stdlib,kernel], [lib_dep_1]),
create_app(LibDir1, "non_goal_2", "0.0.1", [stdlib,kernel], []),
create_app(OverrideDir1, OverrideApp, OverrideVsn, [stdlib,kernel], []),
ConfigFile = filename:join([LibDir1, "relcool.config"]),
write_config(ConfigFile,
[{release, {foo, "0.0.1"},
[goal_app_1,
erlang:list_to_atom(OverrideApp),
goal_app_2]}]),
OutputDir = filename:join([proplists:get_value(data_dir, Config),
create_random_name("relcool-output")]),
{ok, State} = relcool:do(undefined, undefined, [], [LibDir1], 2,
OutputDir, [{OverrideAppName, OverrideAppDir}],
[ConfigFile]),
%% Now we run it again to see if it failse.
{ok, State} = relcool:do(undefined, undefined, [], [LibDir1], 2,
OutputDir, [{OverrideAppName, OverrideAppDir}],
[ConfigFile]),
[{{foo, "0.0.1"}, Release}] = ec_dictionary:to_list(rcl_state:releases(State)),
AppSpecs = rcl_release:applications(Release),
?assert(lists:keymember(stdlib, 1, AppSpecs)),
?assert(lists:keymember(kernel, 1, AppSpecs)),
?assert(lists:member({non_goal_1, "0.0.1"}, AppSpecs)),
?assert(lists:member({non_goal_2, "0.0.1"}, AppSpecs)),
?assert(lists:member({goal_app_1, "0.0.1"}, AppSpecs)),
?assert(lists:member({goal_app_2, "0.0.1"}, AppSpecs)),
?assert(lists:member({OverrideAppName, OverrideVsn}, AppSpecs)),
?assert(lists:member({lib_dep_1, "0.0.1", load}, AppSpecs)),
{ok, Real} = file:read_link(filename:join([OutputDir, "lib",
OverrideApp ++ "-" ++ OverrideVsn])),
?assertMatch(OverrideAppDir, Real).
overlay_release(Config) ->
LibDir1 = proplists:get_value(lib1, Config),
[(fun({Name, Vsn}) ->
create_app(LibDir1, Name, Vsn, [kernel, stdlib], [])
end)(App)
||
App <-
[{create_random_name("lib_app1_"), create_random_vsn()}
|| _ <- lists:seq(1, 100)]],
create_app(LibDir1, "goal_app_1", "0.0.1", [stdlib,kernel,non_goal_1], []),
create_app(LibDir1, "lib_dep_1", "0.0.1", [stdlib,kernel], []),
create_app(LibDir1, "goal_app_2", "0.0.1", [stdlib,kernel,goal_app_1,non_goal_2], []),
create_app(LibDir1, "non_goal_1", "0.0.1", [stdlib,kernel], [lib_dep_1]),
create_app(LibDir1, "non_goal_2", "0.0.1", [stdlib,kernel], []),
ConfigFile = filename:join([LibDir1, "relcool.config"]),
OverlayVars = filename:join([LibDir1, "vars.config"]),
Template = filename:join([LibDir1, "test_template"]),
write_config(ConfigFile,
[{overlay_vars, OverlayVars},
{overlay, [{mkdir, "{{target_dir}}/fooo"},
{copy, OverlayVars,
"{{target_dir}}/{{foo_dir}}/vars.config"},
{template, Template,
"{{target_dir}}/test_template_resolved"}]},
{release, {foo, "0.0.1"},
[goal_app_1,
goal_app_2]}]),
VarsFile = filename:join([LibDir1, "vars.config"]),
write_config(VarsFile, [{yahoo, "yahoo"},
{yahoo2, [{foo, "bar"}]},
{foo_dir, "foodir"}]),
TemplateFile = filename:join([LibDir1, "test_template"]),
ok = file:write_file(TemplateFile, test_template_contents()),
OutputDir = filename:join([proplists:get_value(data_dir, Config),
create_random_name("relcool-output")]),
{ok, State} = relcool:do(undefined, undefined, [], [LibDir1], 2,
OutputDir, [ConfigFile]),
[{{foo, "0.0.1"}, Release}] = ec_dictionary:to_list(rcl_state:releases(State)),
AppSpecs = rcl_release:applications(Release),
?assert(lists:keymember(stdlib, 1, AppSpecs)),
?assert(lists:keymember(kernel, 1, AppSpecs)),
?assert(lists:member({non_goal_1, "0.0.1"}, AppSpecs)),
?assert(lists:member({non_goal_2, "0.0.1"}, AppSpecs)),
?assert(lists:member({goal_app_1, "0.0.1"}, AppSpecs)),
?assert(lists:member({goal_app_2, "0.0.1"}, AppSpecs)),
?assert(lists:member({lib_dep_1, "0.0.1", load}, AppSpecs)),
?assert(ec_file:exists(filename:join(OutputDir, "fooo"))),
?assert(ec_file:exists(filename:join([OutputDir, "foodir", "vars.config"]))),
TemplateData = case file:consult(filename:join([OutputDir, test_template_resolved])) of
{ok, Details} ->
Details;
Error ->
erlang:throw({failed_to_consult, Error})
end,
?assertEqual(erlang:system_info(version),
proplists:get_value(erts_vsn, TemplateData)),
?assertEqual(erlang:system_info(version),
proplists:get_value(release_erts_version, TemplateData)),
?assertEqual("0.0.1",
proplists:get_value(release_version, TemplateData)),
?assertEqual(foo,
proplists:get_value(release_name, TemplateData)),
?assertEqual([kernel,stdlib,lib_dep_1,non_goal_2,non_goal_1,
goal_app_1,goal_app_2],
proplists:get_value(release_applications, TemplateData)),
?assert(proplists:is_defined(std_version, TemplateData)),
?assert(proplists:is_defined(kernel_version, TemplateData)),
?assertEqual("0.0.1",
proplists:get_value(non_goal_1_version, TemplateData)),
?assertEqual("0.0.1",
proplists:get_value(non_goal_2_version, TemplateData)),
?assertEqual("0.0.1",
proplists:get_value(goal_app_1_version, TemplateData)),
?assertEqual("0.0.1",
proplists:get_value(goal_app_2_version, TemplateData)),
?assertEqual("0.0.1",
proplists:get_value(lib_dep_1, TemplateData)),
?assert(proplists:is_defined(lib_dep_1_dir, TemplateData)),
?assertEqual([stdlib,kernel],
proplists:get_value(lib_dep_1_active, TemplateData)),
?assertEqual([],
proplists:get_value(lib_dep_1_library, TemplateData)),
?assertEqual("false",
proplists:get_value(lib_dep_1_link, TemplateData)),
?assertEqual("(2:debug)",
proplists:get_value(log, TemplateData)),
?assertEqual(OutputDir,
proplists:get_value(output_dir, TemplateData)),
?assertEqual(OutputDir,
proplists:get_value(target_dir, TemplateData)),
?assertEqual([],
proplists:get_value(overridden, TemplateData)),
?assertEqual([""],
proplists:get_value(goals, TemplateData)),
?assert(proplists:is_defined(lib_dirs, TemplateData)),
?assert(proplists:is_defined(config_files, TemplateData)),
?assertEqual([""],
proplists:get_value(goals, TemplateData)),
?assertEqual("undefined",
proplists:get_value(sys_config, TemplateData)),
?assert(proplists:is_defined(root_dir, TemplateData)),
?assertEqual(foo,
proplists:get_value(default_release_name, TemplateData)),
?assertEqual("0.0.1",
proplists:get_value(default_release_version, TemplateData)),
?assertEqual("foo-0.0.1",
proplists:get_value(default_release, TemplateData)),
?assertEqual("yahoo",
proplists:get_value(yahoo, TemplateData)),
?assertEqual("bar",
proplists:get_value(yahoo2_foo, TemplateData)),
?assertEqual("foodir",
proplists:get_value(foo_dir, TemplateData)).
%%%===================================================================
%%% Helper Functions
%%%===================================================================
create_app(Dir, Name, Vsn, Deps, LibDeps) ->
AppDir = filename:join([Dir, Name]),
write_app_file(AppDir, Name, Vsn, Deps, LibDeps),
write_beam_file(AppDir, Name),
rcl_app_info:new(erlang:list_to_atom(Name), Vsn, AppDir,
Deps, []).
write_beam_file(Dir, Name) ->
Beam = filename:join([Dir, "ebin", "not_a_real_beam" ++ Name ++ ".beam"]),
ok = filelib:ensure_dir(Beam),
ok = ec_file:write_term(Beam, testing_purposes_only).
write_app_file(Dir, Name, Version, Deps, LibDeps) ->
Filename = filename:join([Dir, "ebin", Name ++ ".app"]),
ok = filelib:ensure_dir(Filename),
ok = ec_file:write_term(Filename, get_app_metadata(Name, Version, Deps, LibDeps)).
get_app_metadata(Name, Vsn, Deps, LibDeps) ->
{application, erlang:list_to_atom(Name),
[{description, ""},
{vsn, Vsn},
{modules, []},
{included_applications, LibDeps},
{registered, []},
{applications, Deps}]}.
create_random_name(Name) ->
random:seed(erlang:now()),
Name ++ erlang:integer_to_list(random:uniform(1000000)).
create_random_vsn() ->
random:seed(erlang:now()),
lists:flatten([erlang:integer_to_list(random:uniform(100)),
".", erlang:integer_to_list(random:uniform(100)),
".", erlang:integer_to_list(random:uniform(100))]).
write_config(Filename, Values) ->
ok = ec_file:write(Filename,
[io_lib:format("~p.\n", [Val]) || Val <- Values]).
test_template_contents() ->
"{erts_vsn, \"{{erts_vsn}}\"}.\n"
"{release_erts_version, \"{{release_erts_version}}\"}.\n"
"{release_name, {{release_name}}}.\n"
"{rel_vsn, \"{{release_version}}\"}.\n"
"{release_version, \"{{release_version}}\"}.\n"
"{release_applications, [{{ release_applications|join:\", \" }}]}.\n"
"{std_version, \"{{release.stdlib.version}}\"}.\n"
"{kernel_version, \"{{release.kernel.version}}\"}.\n"
"{non_goal_1_version, \"{{release.non_goal_1.version}}\"}.\n"
"{non_goal_2_version, \"{{release.non_goal_2.version}}\"}.\n"
"{goal_app_1_version, \"{{release.goal_app_1.version}}\"}.\n"
"{goal_app_2_version, \"{{release.goal_app_2.version}}\"}.\n"
"{lib_dep_1, \"{{release.lib_dep_1.version}}\"}.\n"
"{lib_dep_1_dir, \"{{release.lib_dep_1.dir}}\"}.\n"
"{lib_dep_1_active, [{{ release.lib_dep_1.active_dependencies|join:\", \" }}]}.\n"
"{lib_dep_1_library, [{{ release.lib_dep_1.library_dependencies|join:\", \" }}]}.\n"
"{lib_dep_1_link, \"{{release.lib_dep_1.link}}\"}.\n"
"{log, \"{{log}}\"}.\n"
"{output_dir, \"{{output_dir}}\"}.\n"
"{target_dir, \"{{target_dir}}\"}.\n"
"{overridden, [{{ overridden|join:\", \" }}]}.\n"
"{goals, [\"{{ goals|join:\", \" }}\"]}.\n"
"{lib_dirs, [\"{{ lib_dirs|join:\", \" }}\"]}.\n"
"{config_files, [\"{{ config_files|join:\", \" }}\"]}.\n"
"{providers, [{{ providers|join:\", \" }}]}.\n"
"{sys_config, \"{{sys_config}}\"}.\n"
"{root_dir, \"{{root_dir}}\"}.\n"
"{default_release_name, {{default_release_name}}}.\n"
"{default_release_version, \"{{default_release_version}}\"}.\n"
"{default_release, \"{{default_release}}\"}.\n"
"{yahoo, \"{{yahoo}}\"}.\n"
"{yahoo2_foo, \"{{yahoo2.foo}}\"}.\n"
"{foo_dir, \"{{foo_dir}}\"}.\n".
