aboutsummaryrefslogtreecommitdiffstats
path: root/test/plugin_dialyzer.mk
blob: 44ba4038010d30d43e5255b72140e6dffab08b1f (plain) (blame)
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# Dialyzer plugin.

DIALYZER_TARGETS = $(call list_targets,dialyzer)

ifneq ($(shell which sem 2>/dev/null),)
	DIALYZER_MUTEX = sem --fg --id dialyzer
endif

.PHONY: dialyzer $(C_SRC_TARGETS)

dialyzer: $(DIALYZER_TARGETS)

dialyzer-app: build clean

	$i "Bootstrap a new OTP application named $(APP)"
	$t mkdir $(APP)/
	$t cp ../erlang.mk $(APP)/
	$t $(MAKE) -C $(APP) -f erlang.mk bootstrap $v

	$i "Run Dialyzer"
	$t $(DIALYZER_MUTEX) $(MAKE) -C $(APP) dialyze $v

	$i "Check that the PLT file was created"
	$t test -f $(APP)/.$(APP).plt

	$i "Create a module with a function that has no local return"
	$t printf "%s\n" \
		"-module(warn_me)." \
		"doit() -> 1 = 2, ok." > $(APP)/src/warn_me.erl

	$i "Confirm that Dialyzer errors out"
	$t ! $(DIALYZER_MUTEX) $(MAKE) -C $(APP) dialyze $v

	$i "Distclean the application"
	$t $(MAKE) -C $(APP) distclean $v

	$i "Check that the PLT file was removed"
	$t test ! -e $(APP)/.$(APP).plt

dialyzer-apps-only: build clean

	$i "Create a multi application repository with no root application"
	$t mkdir $(APP)/
	$t cp ../erlang.mk $(APP)/
	$t echo "include erlang.mk" > $(APP)/Makefile

	$i "Create a new application my_app"
	$t $(MAKE) -C $(APP) new-app in=my_app $v

	$i "Create a module my_server from gen_server template in my_app"
	$t $(MAKE) -C $(APP) new t=gen_server n=my_server in=my_app $v

	$i "Add Cowlib to the list of dependencies"
	$t perl -ni.bak -e 'print;if ($$.==1) {print "DEPS = cowlib\n"}' $(APP)/apps/my_app/Makefile

	$i "Run Dialyzer"
	$t $(DIALYZER_MUTEX) $(MAKE) -C $(APP) dialyze $v

	$i "Check that the PLT file was created automatically"
	$t test -f $(APP)/.$(APP).plt

	$i "Confirm that Cowlib was included in the PLT"
	$t dialyzer --plt_info --plt $(APP)/.$(APP).plt | grep -q cowlib

	$i "Create a module with a function that has no local return"
	$t printf "%s\n" \
		"-module(warn_me)." \
		"doit() -> 1 = 2, ok." > $(APP)/apps/my_app/src/warn_me.erl

	$i "Confirm that Dialyzer errors out"
	$t ! $(DIALYZER_MUTEX) $(MAKE) -C $(APP) dialyze $v

dialyzer-apps-with-local-deps: build clean

	$i "Create a multi application repository with no root application"
	$t mkdir $(APP)/
	$t cp ../erlang.mk $(APP)/
	$t echo "include erlang.mk" > $(APP)/Makefile

	$i "Create a new application my_app"
	$t $(MAKE) -C $(APP) new-app in=my_app $v

	$i "Create a new application my_core_app"
	$t $(MAKE) -C $(APP) new-app in=my_core_app $v

	$i "Add my_core_app to the list of local dependencies for my_app"
	$t perl -ni.bak -e 'print;if ($$.==1) {print "LOCAL_DEPS = my_core_app\n"}' $(APP)/apps/my_app/Makefile

	$i "Run Dialyzer"
	$t $(DIALYZER_MUTEX) $(MAKE) -C $(APP) dialyze $v

	$i "Check that the PLT file was created automatically"
	$t test -f $(APP)/.$(APP).plt

	$i "Confirm that my_core_app was NOT included in the PLT"
	$t ! dialyzer --plt_info --plt $(APP)/.$(APP).plt | grep -q my_core_app

dialyzer-beam: build clean

	$i "Bootstrap a new OTP application named $(APP)"
	$t mkdir $(APP)/
	$t cp ../erlang.mk $(APP)/
	$t $(MAKE) -C $(APP) -f erlang.mk bootstrap $v

	$i "Add lager to the list of dependencies"
	$t perl -ni.bak -e 'print;if ($$.==1) {print "DEPS = lager\n"}' $(APP)/Makefile

	$i "Add lager_transform to ERLC_OPTS"
	$t echo "ERLC_OPTS += +'{parse_transform, lager_transform}'" >> $(APP)/Makefile

	$i "Make Dialyzer use the beam files"
	$t echo "DIALYZER_DIRS = -r ebin" >> $(APP)/Makefile

	$i "Create a module that calls lager"
	$t printf "%s\n" \
		"-module(use_lager)." \
		"-export([doit/0])." \
		"doit() -> lager:error(\"Some message\")." > $(APP)/src/use_lager.erl

	$i "Run Dialyzer"
	$t $(DIALYZER_MUTEX) $(MAKE) -C $(APP) dialyze $v

dialyzer-check: build clean

	$i "Bootstrap a new OTP application named $(APP)"
	$t mkdir $(APP)/
	$t cp ../erlang.mk $(APP)/
	$t $(MAKE) -C $(APP) -f erlang.mk bootstrap $v

	$i "Run 'make check'"
	$t $(DIALYZER_MUTEX) $(MAKE) -C $(APP) check $v

	$i "Check that the PLT file was created"
	$t test -f $(APP)/.$(APP).plt

	$i "Create a module with a function that has no local return"
	$t printf "%s\n" \
		"-module(warn_me)." \
		"doit() -> 1 = 2, ok." > $(APP)/src/warn_me.erl

	$i "Confirm that Dialyzer errors out on 'make check'"
	$t ! $(DIALYZER_MUTEX) $(MAKE) -C $(APP) check $v

dialyzer-custom-plt: build clean

	$i "Bootstrap a new OTP application named $(APP)"
	$t mkdir $(APP)/
	$t cp ../erlang.mk $(APP)/
	$t $(MAKE) -C $(APP) -f erlang.mk bootstrap $v

	$i "Set a custom DIALYZER_PLT location"
	$t perl -ni.bak -e 'print;if ($$.==1) {print "DIALYZER_PLT = custom.plt\n"}' $(APP)/Makefile

	$i "Run Dialyzer"
	$t $(DIALYZER_MUTEX) $(MAKE) -C $(APP) dialyze $v

	$i "Check that the PLT file was created"
	$t test -f $(APP)/custom.plt

	$i "Distclean the application"
	$t $(MAKE) -C $(APP) distclean $v

	$i "Check that the PLT file was removed"
	$t test ! -e $(APP)/custom.plt

dialyzer-deps: build clean

	$i "Bootstrap a new OTP application named $(APP)"
	$t mkdir $(APP)/
	$t cp ../erlang.mk $(APP)/
	$t $(MAKE) -C $(APP) -f erlang.mk bootstrap $v

	$i "Add Cowlib to the list of dependencies"
	$t perl -ni.bak -e 'print;if ($$.==1) {print "DEPS = cowlib\n"}' $(APP)/Makefile

	$i "Run Dialyzer"
	$t $(DIALYZER_MUTEX) $(MAKE) -C $(APP) dialyze $v

	$i "Check that the PLT file was created"
	$t test -f $(APP)/.$(APP).plt

	$i "Confirm that Cowlib was included in the PLT"
	$t dialyzer --plt_info --plt $(APP)/.$(APP).plt | grep -q cowlib

dialyzer-erlc-opts: build clean

	$i "Bootstrap a new OTP application named $(APP)"
	$t mkdir $(APP)/
	$t cp ../erlang.mk $(APP)/
	$t $(MAKE) -C $(APP) -f erlang.mk bootstrap $v

	$i "Create a header file in a non-standard directory"
	$t mkdir $(APP)/exotic-include-path/
	$t touch $(APP)/exotic-include-path/dialyze.hrl

	$i "Create a module that includes this header"
	$t printf "%s\n" \
		"-module(no_warn)." \
		"-export([doit/0])." \
		"-include(\"dialyze.hrl\")." \
		"doit() -> ?OK." > $(APP)/src/no_warn.erl

	$i "Point ERLC_OPTS to the non-standard include directory"
	$t perl -ni.bak -e 'print;if ($$.==1) {print "ERLC_OPTS += -I exotic-include-path -DOK=ok\n"}' $(APP)/Makefile

	$i "Run Dialyzer"
	$t $(DIALYZER_MUTEX) $(MAKE) -C $(APP) dialyze $v

dialyzer-local-deps: build clean

	$i "Bootstrap a new OTP application named $(APP)"
	$t mkdir $(APP)/
	$t cp ../erlang.mk $(APP)/
	$t $(MAKE) -C $(APP) -f erlang.mk bootstrap $v

	$i "Add runtime_tools to the list of local dependencies"
	$t perl -ni.bak -e 'print;if ($$.==1) {print "LOCAL_DEPS = runtime_tools\n"}' $(APP)/Makefile

	$i "Build the PLT"
	$t $(DIALYZER_MUTEX) $(MAKE) -C $(APP) plt $v

	$i "Confirm that runtime_tools was included in the PLT"
	$t dialyzer --plt_info --plt $(APP)/.$(APP).plt | grep -q runtime_tools

dialyzer-opts: build clean

	$i "Bootstrap a new OTP application named $(APP)"
	$t mkdir $(APP)/
	$t cp ../erlang.mk $(APP)/
	$t $(MAKE) -C $(APP) -f erlang.mk bootstrap $v

	$i "Make Dialyzer save output to a file"
	$t perl -ni.bak -e 'print;if ($$.==1) {print "DIALYZER_OPTS = -o output.txt\n"}' $(APP)/Makefile

	$i "Create a module with a function that has no local return"
	$t printf "%s\n" \
		"-module(warn_me)." \
		"-export([doit/0])." \
		"doit() -> gen_tcp:connect(a, b, c), ok." > $(APP)/src/warn_me.erl

	$i "Run Dialyzer"
	$t ! $(DIALYZER_MUTEX) $(MAKE) -C $(APP) dialyze $v

	$i "Check that the PLT file was created"
	$t test -f $(APP)/.$(APP).plt

	$i "Check that the output file was created"
	$t test -f $(APP)/output.txt

dialyzer-plt-apps: build clean

	$i "Bootstrap a new OTP application named $(APP)"
	$t mkdir $(APP)/
	$t cp ../erlang.mk $(APP)/
	$t $(MAKE) -C $(APP) -f erlang.mk bootstrap $v

	$i "Add runtime_tools to PLT_APPS"
	$t perl -ni.bak -e 'print;if ($$.==1) {print "PLT_APPS = runtime_tools\n"}' $(APP)/Makefile

	$i "Build the PLT"
	$t $(DIALYZER_MUTEX) $(MAKE) -C $(APP) plt $v

	$i "Confirm that runtime_tools was included in the PLT"
	$t dialyzer --plt_info --plt $(APP)/.$(APP).plt | grep -q runtime_tools

dialyzer-plt-ebin-only: build clean

	$i "Bootstrap a new OTP application named $(APP)"
	$t mkdir $(APP)/
	$t cp ../erlang.mk $(APP)/
	$t $(MAKE) -C $(APP) -f erlang.mk bootstrap $v

	$i "Add Cowlib to the list of dependencies"
	$t perl -ni.bak -e 'print;if ($$.==1) {print "DEPS = cowlib\ndep_cowlib_commit = master\n"}' $(APP)/Makefile

	$i "Build the application"
	$t $(MAKE) -C $(APP) $v

	$i "Run Cowlib tests to fetch autopatched dependencies"
	$t $(MAKE) -C $(APP)/deps/cowlib tests $v

	$i "Run Dialyzer"
	$t $(DIALYZER_MUTEX) $(MAKE) -C $(APP) dialyze $v

	$i "Check that the PLT file was created"
	$t test -f $(APP)/.$(APP).plt

	$i "Confirm that Cowlib was included in the PLT"
	$t dialyzer --plt_info --plt $(APP)/.$(APP).plt | grep -q cowlib

	$i "Confirm that rebar files were not included in the PLT"
	$t ! dialyzer --plt_info --plt $(APP)/.$(APP).plt | grep -q rebar