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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
%% ex: ts=4 sw=4 et
%% -------------------------------------------------------------------
%%
%% rebar: Erlang Build Tools
%%
%% Copyright (c) 2010 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.
%% -------------------------------------------------------------------
%% @author Dave Smith <dizzyd@dizzyd.com>
%% @doc rebar_dialyzer supports the following commands:
%% <ul>
%% <li>dialyze (essentially "dialyzer ebin" or "dialyzer --src src")</li>
%% <li>build-plt (essentially "dialyzer --build_plt -r <app_dirs>")</li>
%% <li>check-plt (essentially "dialyzer --check_plt")</li>
%% </ul>
%% A single option <code>plt</code> can be presented in the
%% <code>dialyzer_opts</code> options in <code>rebar.config</code>. If it
%% is present, it is used as the PLT for the supported commands. Should it
%% not be present, then the default is <code>$HOME/.dialyzer_plt</code>.
%%
%% @reference <a href="http://user.it.uu.se/~kostis/Papers/bugs05.pdf">
%% Experience from developing the Dialyzer: A static analysis tool detecting
%% defects in Erlang applications</a>
%% @reference <a href="http://user.it.uu.se/~kostis/Papers/contracts.pdf">
%% A Language for Specifying Type Contracts in Erlang and its Interaction
%% with Success Typings</a>
%% @reference <a href="http://user.it.uu.se/~kostis/Papers/wrangler.pdf">Gradual
%% Typing of Erlang Programs: A Wrangler Experience</a>
%% @copyright 2010 Dave Smith
%% -------------------------------------------------------------------
-module(rebar_dialyzer).
-export([dialyze/2,
'build-plt'/2,
'check-plt'/2]).
-include("rebar.hrl").
-type(warning() :: {atom(), {string(), integer()}, any()}).
%% ===================================================================
%% Public API
%% ===================================================================
%% @doc Perform static analysis on the contents of the ebin directory.
-spec dialyze(Config::rebar_config:config(), File::file:filename()) -> ok.
dialyze(Config, File) ->
Plt = existing_plt_path(Config, File),
case dialyzer:plt_info(Plt) of
{ok, _} ->
FromSrc = proplists:get_bool(src, rebar_config:get(Config,
dialyzer_opts,
[])),
DialyzerOpts0 = case FromSrc of
true ->
[{files_rec, ["src"]}, {init_plt, Plt},
{from, src_code}];
false ->
[{files_rec, ["ebin"]}, {init_plt, Plt}]
end,
WarnOpts = warnings(Config),
DialyzerOpts = case WarnOpts of
[] -> DialyzerOpts0;
_ -> [{warnings, WarnOpts}|DialyzerOpts0]
end,
?DEBUG("DialyzerOpts: ~p~n", [DialyzerOpts]),
try dialyzer:run(DialyzerOpts) of
Warnings -> output_warnings(Warnings)
catch
throw:{dialyzer_error, Reason} ->
?ABORT("~s~n", [Reason])
end;
{error, no_such_file} ->
?ABORT("The PLT ~s does not exist. Please perform the build-plt "
"command to ~n"
"produce the initial PLT. Be aware that this operation may "
"take several minutes.~n", [Plt]);
{error, read_error} ->
?ABORT("Unable to read PLT ~n~n", [Plt]);
{error, not_valid} ->
?ABORT("The PLT ~s is not valid.~n", [Plt])
end,
ok.
%% @doc Build the PLT.
-spec 'build-plt'(Config::rebar_config:config(), File::file:filename()) -> ok.
'build-plt'(Config, File) ->
Plt = new_plt_path(Config, File),
Apps = rebar_app_utils:app_applications(File),
?DEBUG("Build PLT ~s including following apps:~n~p~n", [Plt, Apps]),
Warnings = dialyzer:run([{analysis_type, plt_build},
{files_rec, app_dirs(Apps)},
{output_plt, Plt}]),
case Warnings of
[] ->
?INFO("The built PLT can be found in ~s~n", [Plt]);
_ ->
output_warnings(Warnings)
end,
ok.
%% @doc Check whether the PLT is up-to-date (rebuilding it if not).
-spec 'check-plt'(Config::rebar_config:config(), File::file:filename()) -> ok.
'check-plt'(Config, File) ->
Plt = existing_plt_path(Config, File),
try dialyzer:run([{analysis_type, plt_check}, {init_plt, Plt}]) of
[] ->
?CONSOLE("The PLT ~s is up-to-date~n", [Plt]);
_ ->
%% @todo Determine whether this is the correct summary.
?CONSOLE("The PLT ~s is not up-to-date~n", [Plt])
catch
throw:{dialyzer_error, _Reason} ->
?CONSOLE("The PLT ~s is not valid.~n", [Plt])
end,
ok.
%% ===================================================================
%% Internal functions
%% ===================================================================
%% @doc Obtain the library paths for the supplied applications.
-spec app_dirs(Apps::[atom()]) -> [file:filename()].
app_dirs(Apps) ->
[filename:join(Path, "ebin")
|| Path <- [code:lib_dir(App) || App <- Apps], erlang:is_list(Path)].
%% @doc Render the warnings on the console.
-spec output_warnings(Warnings::[warning()]) -> 'ok'.
output_warnings(Warnings) ->
lists:foreach(fun(Warning) ->
?CONSOLE("~s", [dialyzer:format_warning(Warning)])
end, Warnings).
%% @doc If the plt option is present in rebar.config return its value,
%% otherwise return $HOME/.dialyzer_plt.
-spec new_plt_path(Config::rebar_config:config(),
File::file:filename()) -> file:filename().
new_plt_path(Config, File) ->
AppName = rebar_app_utils:app_name(File),
DialyzerOpts = rebar_config:get(Config, dialyzer_opts, []),
case proplists:get_value(plt, DialyzerOpts) of
undefined ->
filename:join(os:getenv("HOME"),
"." ++ atom_to_list(AppName) ++ "_dialyzer_plt");
Plt ->
Plt
end.
%% @doc If the plt option is present in rebar.config and the file exists
%% return its value or if ~/.AppName_dialyzer_plt exists return that.
%% Otherwise return ~/.dialyzer_plt if it exists or abort.
-spec existing_plt_path(Config::rebar_config:config(),
File::file:filename()) -> file:filename().
existing_plt_path(Config, File) ->
AppName = rebar_app_utils:app_name(File),
DialyzerOpts = rebar_config:get(Config, dialyzer_opts, []),
Home = os:getenv("HOME"),
case proplists:get_value(plt, DialyzerOpts) of
undefined ->
AppPlt = filename:join(Home, "." ++ atom_to_list(AppName)
++ "_dialyzer_plt"),
case filelib:is_regular(AppPlt) of
true ->
AppPlt;
false ->
HomePlt = filename:join(Home, ".dialyzer_plt"),
case filelib:is_regular(HomePlt) of
true ->
HomePlt;
false ->
?ABORT("No PLT found~n", [])
end
end;
"~/" ++ Plt ->
filename:join(Home,Plt);
Plt ->
Plt
end.
%% @doc If the warnings option is present in rebar.config return its value,
%% otherwise return [].
-spec warnings(Config::rebar_config:config()) -> list().
warnings(Config) ->
DialyzerOpts = rebar_config:get(Config, dialyzer_opts, []),
proplists:get_value(warnings, DialyzerOpts, []).
|
