1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
%% ex: ts=4 sw=4 et
%% -------------------------------------------------------------------
%%
%% rebar: Erlang Build Tools
%%
%% Copyright (c) 2009 Dave Smith (dizzyd@dizzyd.com)
%%
%% Permission is hereby granted, free of charge, to any person obtaining a copy
%% of this software and associated documentation files (the "Software"), to deal
%% in the Software without restriction, including without limitation the rights
%% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
%% copies of the Software, and to permit persons to whom the Software is
%% furnished to do so, subject to the following conditions:
%%
%% The above copyright notice and this permission notice shall be included in
%% all copies or substantial portions of the Software.
%%
%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
%% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
%% THE SOFTWARE.
%% -------------------------------------------------------------------
-module(rebar_config).
-export([consult/1
,consult_app_file/1
,consult_file/1
,consult_lock_file/1
,verify_config_format/1
,format_error/1
,merge_locks/2]).
-include("rebar.hrl").
-include_lib("providers/include/providers.hrl").
%% ===================================================================
%% Public API
%% ===================================================================
-spec consult(file:name()) -> [any()].
consult(Dir) ->
consult_file(filename:join(Dir, ?DEFAULT_CONFIG_FILE)).
consult_app_file(File) ->
consult_file_(File).
consult_lock_file(File) ->
consult_file_(File).
consult_file(File) ->
Terms = consult_file_(File),
true = verify_config_format(Terms),
Terms.
-spec consult_file_(file:name()) -> [any()].
consult_file_(File) when is_binary(File) ->
consult_file_(binary_to_list(File));
consult_file_(File) ->
case filename:extension(File) of
".script" ->
{ok, Terms} = consult_and_eval(remove_script_ext(File), File),
[Terms];
_ ->
Script = File ++ ".script",
case filelib:is_regular(Script) of
true ->
{ok, Terms} = consult_and_eval(File, Script),
Terms;
false ->
rebar_file_utils:try_consult(File)
end
end.
verify_config_format([]) ->
true;
verify_config_format([{_Key, _Value} | T]) ->
verify_config_format(T);
verify_config_format([Term | _]) ->
throw(?PRV_ERROR({bad_config_format, Term})).
%% no lockfile
merge_locks(Config, []) ->
Config;
%% empty lockfile
merge_locks(Config, [[]]) ->
Config;
%% lockfile with entries
merge_locks(Config, [Locks]) ->
ConfigDeps = proplists:get_value(deps, Config, []),
%% We want the top level deps only from the lock file.
%% This ensures deterministic overrides for configs.
%% Then check if any new deps have been added to the config
%% since it was locked.
Deps = [X || X <- Locks, element(3, X) =:= 0],
NewDeps = find_newly_added(ConfigDeps, Locks),
[{{locks, default}, Locks}, {{deps, default}, NewDeps++Deps} | Config].
format_error({bad_config_format, Term}) ->
io_lib:format("Unable to parse config. Term is not in {Key, Value} format:~n~p", [Term]);
format_error({bad_dep_name, Dep}) ->
io_lib:format("Dependency name must be an atom, instead found: ~p", [Dep]).
%% ===================================================================
%% Internal functions
%% ===================================================================
consult_and_eval(File, Script) ->
?DEBUG("Evaluating config script ~p", [Script]),
StateData = rebar_file_utils:try_consult(File),
file:script(Script, bs([{'CONFIG', StateData}, {'SCRIPT', Script}])).
remove_script_ext(F) ->
filename:rootname(F, ".script").
bs(Vars) ->
lists:foldl(fun({K,V}, Bs) ->
erl_eval:add_binding(K, V, Bs)
end, erl_eval:new_bindings(), Vars).
%% Find deps that have been added to the config after the lock was created
find_newly_added(ConfigDeps, LockedDeps) ->
rebar_utils:filtermap(fun(Dep) when is_tuple(Dep) ->
check_newly_added(element(1, Dep), LockedDeps);
(Dep) ->
check_newly_added(Dep, LockedDeps)
end, ConfigDeps).
check_newly_added(Dep, LockedDeps) when is_atom(Dep) ->
NewDep = ec_cnv:to_binary(Dep),
case lists:keyfind(NewDep, 1, LockedDeps) of
false ->
true;
Match ->
case element(3, Match) of
0 ->
true;
_ ->
?WARN("Newly added dep ~s is locked at a lower level. "
"If you really want to unlock it, use 'rebar3 upgrade ~s'",
[NewDep, NewDep]),
false
end
end;
check_newly_added(Dep, _) ->
throw(?PRV_ERROR({bad_dep_name, Dep})).
|
