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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 1997-2014. All Rights Reserved.
%%
%% Licensed 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.
%%
%% %CopyrightEnd%
%%
-module(compile_SUITE).
%% Tests compile:file/1 and compile:file/2 with various options.
-include_lib("common_test/include/ct.hrl").
-export([all/0, suite/0,groups/0,init_per_suite/1, end_per_suite/1,
init_per_group/2,end_per_group/2,
app_test/1,appup_test/1,
file_1/1, forms_2/1, module_mismatch/1, big_file/1, outdir/1,
binary/1, makedep/1, cond_and_ifdef/1, listings/1, listings_big/1,
other_output/1, encrypted_abstr/1,
strict_record/1,
missing_testheap/1, cover/1, env/1, core/1, asm/1,
sys_pre_attributes/1, dialyzer/1,
warnings/1
]).
-export([init/3]).
suite() -> [{ct_hooks,[ts_install_cth]}].
%% To cover the stripping of 'type' and 'spec' in beam_asm.
-type all_return_type() :: [atom()].
-spec all() -> all_return_type().
all() ->
test_lib:recompile(?MODULE),
[app_test, appup_test, file_1, forms_2, module_mismatch, big_file, outdir,
binary, makedep, cond_and_ifdef, listings, listings_big,
other_output, encrypted_abstr,
strict_record,
missing_testheap, cover, env, core, asm,
sys_pre_attributes, dialyzer, warnings].
groups() ->
[].
init_per_suite(Config) ->
Config.
end_per_suite(_Config) ->
ok.
init_per_group(_GroupName, Config) ->
Config.
end_per_group(_GroupName, Config) ->
Config.
%% Test that the Application file has no `basic' errors.";
app_test(Config) when is_list(Config) ->
test_server:app_test(compiler).
%% Test that the Application upgrade file has no `basic' errors.";
appup_test(Config) when is_list(Config) ->
ok = test_server:appup_test(compiler).
%% Tests that we can compile and run a simple Erlang program,
%% using compile:file/1.
file_1(Config) when is_list(Config) ->
process_flag(trap_exit, true),
{Simple, Target} = get_files(Config, simple, "file_1"),
?line {ok, Cwd} = file:get_cwd(),
?line ok = file:set_cwd(filename:dirname(Target)),
%% Native from BEAM without compilation info.
?line {ok,simple} = compile:file(Simple, [slim]), %Smoke test only.
?line {ok,simple} = compile:file(Target, [native,from_beam]), %Smoke test.
%% Native from BEAM with compilation info.
?line {ok,simple} = compile:file(Simple), %Smoke test only.
?line {ok,simple} = compile:file(Target, [native,from_beam]), %Smoke test.
?line {ok,simple} = compile:file(Simple, [native,report]), %Smoke test.
?line compile_and_verify(Simple, Target, []),
?line compile_and_verify(Simple, Target, [native]),
?line compile_and_verify(Simple, Target, [debug_info]),
?line {ok,simple} = compile:file(Simple, [no_line_info]), %Coverage
{ok,simple} = compile:file(Simple, [{eprof,beam_z}]), %Coverage
?line ok = file:set_cwd(Cwd),
?line true = exists(Target),
?line passed = run(Target, test, []),
%% Cleanup.
?line ok = file:delete(Target),
?line ok = file:del_dir(filename:dirname(Target)),
%% There should not be any messages in the messages.
receive
Any ->
ct:fail({unexpected,Any})
after 10 ->
ok
end,
ok.
forms_2(Config) when is_list(Config) ->
Src = "/foo/bar",
AbsSrc = filename:absname(Src),
Anno = erl_anno:new(1),
{ok,simple,Binary} = compile:forms([{attribute,Anno,module,simple}],
[binary,{source,Src}]),
code:load_binary(simple, Src, Binary),
Info = simple:module_info(compile),
%% Test that the proper source is returned.
AbsSrc = proplists:get_value(source, Info),
%% Ensure that the options are not polluted with 'source'.
[] = proplists:get_value(options, Info),
%% Cleanup.
true = code:delete(simple),
false = code:purge(simple),
ok.
module_mismatch(Config) when is_list(Config) ->
DataDir = proplists:get_value(data_dir, Config),
?line File = filename:join(DataDir, "wrong_module_name.erl"),
{error,[{"wrong_module_name.beam",
[{none,compile,{module_name,arne,"wrong_module_name"}}]}],
[]} = compile:file(File, [return]),
?line error = compile:file(File, [report]),
?line {ok,arne,[]} = compile:file(File,
[return,no_error_module_mismatch]),
ok.
big_file(Config) when is_list(Config) ->
{Big,Target} = get_files(Config, big, "big_file"),
ok = file:set_cwd(filename:dirname(Target)),
?line compile_and_verify(Big, Target, []),
?line compile_and_verify(Big, Target, [debug_info]),
?line compile_and_verify(Big, Target, [no_postopt]),
%% Cleanup.
?line ok = file:delete(Target),
ok.
%% Tests that the {outdir, Dir} option works.
outdir(Config) when is_list(Config) ->
{Simple, Target} = get_files(Config, simple, "outdir"),
?line {ok, simple} = compile:file(Simple, [{outdir, filename:dirname(Target)}]),
?line true = exists(Target),
?line passed = run(Target, test, []),
?line ok = file:delete(Target),
?line ok = file:del_dir(filename:dirname(Target)),
ok.
%% Tests that the binary option works.
binary(Config) when is_list(Config) ->
{Simple, Target} = get_files(Config, simple, "binary"),
?line {ok, simple, Binary} = compile:file(Simple, [binary]),
?line code:load_binary(simple, Target, Binary),
?line passed = simple:test(),
?line true = code:delete(simple),
?line false = code:purge(simple),
?line ok = file:del_dir(filename:dirname(Target)),
ok.
%% Tests that the dependencies-Makefile-related options work.
makedep(Config) when is_list(Config) ->
{Simple,Target} = get_files(Config, simple, "makedep"),
DataDir = proplists:get_value(data_dir, Config),
?line SimpleRootname = filename:rootname(Simple),
?line IncludeDir = filename:join(filename:dirname(Simple), "include"),
?line IncludeOptions = [
{d,need_foo},
{d,foo_value,42},
{d,include_generated},
{i,IncludeDir}
],
%% Basic rule.
?line BasicMf1Name = SimpleRootname ++ "-basic1.mk",
?line {ok,BasicMf1} = file:read_file(BasicMf1Name),
?line {ok,_,Mf1} = compile:file(Simple, [binary,makedep]),
?line BasicMf1 = makedep_canonicalize_result(Mf1, DataDir),
%% Basic rule with one existing header.
?line BasicMf2Name = SimpleRootname ++ "-basic2.mk",
?line {ok,BasicMf2} = file:read_file(BasicMf2Name),
?line {ok,_,Mf2} = compile:file(Simple, [binary,makedep|IncludeOptions]),
?line BasicMf2 = makedep_canonicalize_result(Mf2, DataDir),
%% Rule with one existing header and one missing header.
?line MissingMfName = SimpleRootname ++ "-missing.mk",
?line {ok,MissingMf} = file:read_file(MissingMfName),
?line {ok,_,Mf3} = compile:file(Simple,
[binary,makedep,makedep_add_missing|IncludeOptions]),
?line MissingMf = makedep_canonicalize_result(Mf3, DataDir),
%% Rule with modified target.
?line TargetMf1Name = SimpleRootname ++ "-target1.mk",
?line {ok,TargetMf1} = file:read_file(TargetMf1Name),
?line {ok,_,Mf4} = compile:file(Simple,
[binary,makedep,{makedep_target,"$target"}|IncludeOptions]),
?line TargetMf1 = makedep_modify_target(
makedep_canonicalize_result(Mf4, DataDir), "$$target"),
%% Rule with quoted modified target.
?line TargetMf2Name = SimpleRootname ++ "-target2.mk",
?line {ok,TargetMf2} = file:read_file(TargetMf2Name),
?line {ok,_,Mf5} = compile:file(Simple,
[binary,makedep,{makedep_target,"$target"},makedep_quote_target|
IncludeOptions]),
?line TargetMf2 = makedep_modify_target(
makedep_canonicalize_result(Mf5, DataDir), "$$target"),
%% Basic rule written to some file.
?line {ok,_} = compile:file(Simple,
[makedep,{makedep_output,Target}|IncludeOptions]),
?line {ok,Mf6} = file:read_file(Target),
?line BasicMf2 = makedep_canonicalize_result(Mf6, DataDir),
%% Rule with creating phony target.
?line PhonyMfName = SimpleRootname ++ "-phony.mk",
?line {ok,PhonyMf} = file:read_file(PhonyMfName),
?line {ok,_,Mf7} = compile:file(Simple,
[binary,makedep,makedep_phony|IncludeOptions]),
?line PhonyMf = makedep_canonicalize_result(Mf7, DataDir),
?line ok = file:delete(Target),
?line ok = file:del_dir(filename:dirname(Target)),
ok.
makedep_canonicalize_result(Mf, DataDir) ->
Mf0 = binary_to_list(Mf),
%% Replace the Datadir by "$(srcdir)".
Mf1 = re:replace(Mf0, DataDir, "$(srcdir)/",
[global,multiline,{return,list}]),
%% Long lines are splitted, put back everything on one line.
Mf2 = re:replace(Mf1, "\\\\\n ", "", [global,multiline,{return,list}]),
list_to_binary(Mf2).
makedep_modify_target(Mf, Target) ->
Mf0 = binary_to_list(Mf),
Mf1 = re:replace(Mf0, Target, "$target", [{return,list}]),
list_to_binary(Mf1).
%% Tests that conditional compilation, defining values, including files work.
cond_and_ifdef(Config) when is_list(Config) ->
{Simple, Target} = get_files(Config, simple, "cond_and_ifdef"),
?line IncludeDir = filename:join(filename:dirname(Simple), "include"),
?line Options = [{outdir, filename:dirname(Target)},
{d, need_foo}, {d, foo_value, 42},
{i, IncludeDir}, report],
?line {ok, simple} = compile:file(Simple, Options),
?line true = exists(Target),
?line {hiker, 42} = run(Target, foo, []),
?line ok = file:delete(Target),
?line ok = file:del_dir(filename:dirname(Target)),
ok.
listings(Config) when is_list(Config) ->
DataDir = proplists:get_value(data_dir, Config),
PrivDir = proplists:get_value(priv_dir, Config),
ok = do_file_listings(DataDir, PrivDir, [
"simple",
"small",
"small_maps"
]),
ok.
do_file_listings(_, _, []) -> ok;
do_file_listings(DataDir, PrivDir, [File|Files]) ->
Simple = filename:join(DataDir, File),
TargetDir = filename:join(PrivDir, listings),
ok = file:make_dir(TargetDir),
%% Test all dedicated listing options.
do_listing(Simple, TargetDir, 'S'),
do_listing(Simple, TargetDir, 'E'),
do_listing(Simple, TargetDir, 'P'),
do_listing(Simple, TargetDir, dpp, ".pp"),
do_listing(Simple, TargetDir, dabstr, ".abstr"),
do_listing(Simple, TargetDir, dexp, ".expand"),
do_listing(Simple, TargetDir, dcore, ".core"),
do_listing(Simple, TargetDir, doldinline, ".oldinline"),
do_listing(Simple, TargetDir, dinline, ".inline"),
do_listing(Simple, TargetDir, dcore, ".core"),
do_listing(Simple, TargetDir, dcopt, ".copt"),
do_listing(Simple, TargetDir, dsetel, ".dsetel"),
do_listing(Simple, TargetDir, dkern, ".kernel"),
do_listing(Simple, TargetDir, dlife, ".life"),
do_listing(Simple, TargetDir, dcg, ".codegen"),
do_listing(Simple, TargetDir, dblk, ".block"),
do_listing(Simple, TargetDir, dexcept, ".except"),
do_listing(Simple, TargetDir, dbs, ".bs"),
do_listing(Simple, TargetDir, dbool, ".bool"),
do_listing(Simple, TargetDir, dtype, ".type"),
do_listing(Simple, TargetDir, ddead, ".dead"),
do_listing(Simple, TargetDir, djmp, ".jump"),
do_listing(Simple, TargetDir, dclean, ".clean"),
do_listing(Simple, TargetDir, dpeep, ".peep"),
do_listing(Simple, TargetDir, dopt, ".optimize"),
%% First clean up.
Listings = filename:join(PrivDir, listings),
lists:foreach(fun(F) -> ok = file:delete(F) end,
filelib:wildcard(filename:join(Listings, "*"))),
%% Test options that produce a listing file if 'binary' is not given.
do_listing(Simple, TargetDir, to_pp, ".P"),
do_listing(Simple, TargetDir, to_exp, ".E"),
do_listing(Simple, TargetDir, to_core0, ".core"),
ok = file:delete(filename:join(Listings, File ++ ".core")),
do_listing(Simple, TargetDir, to_core, ".core"),
do_listing(Simple, TargetDir, to_kernel, ".kernel"),
%% Final clean up.
lists:foreach(fun(F) -> ok = file:delete(F) end,
filelib:wildcard(filename:join(Listings, "*"))),
ok = file:del_dir(Listings),
do_file_listings(DataDir,PrivDir,Files).
listings_big(Config) when is_list(Config) ->
{Big,Target} = get_files(Config, big, listings_big),
TargetDir = filename:dirname(Target),
?line do_listing(Big, TargetDir, 'S'),
?line do_listing(Big, TargetDir, 'E'),
?line do_listing(Big, TargetDir, 'P'),
?line do_listing(Big, TargetDir, dkern, ".kernel"),
TargetNoext = filename:rootname(Target, code:objfile_extension()),
{ok,big} = compile:file(TargetNoext, [from_asm,{outdir,TargetDir}]),
%% Cleanup.
ok = file:delete(Target),
?line lists:foreach(fun(F) -> ok = file:delete(F) end,
filelib:wildcard(filename:join(TargetDir, "*"))),
?line ok = file:del_dir(TargetDir),
ok.
other_output(Config) when is_list(Config) ->
{Simple,_Target} = get_files(Config, simple, "other_output"),
io:put_chars("to_pp"),
?line {ok,[],PP} = compile:file(Simple, [to_pp,binary,time]),
?line [] = [E || E <- PP,
begin
case element(1, E) of
attribute -> false;
function -> false;
eof -> false
end
end],
io:put_chars("to_exp (file)"),
?line {ok,simple,Expand} = compile:file(Simple, [to_exp,binary,time]),
?line case Expand of
{simple,Exports,Forms} when is_list(Exports), is_list(Forms) -> ok
end,
io:put_chars("to_exp (forms)"),
?line {ok,simple,Expand} = compile:forms(PP, [to_exp,binary,time]),
io:put_chars("to_core (file)"),
?line {ok,simple,Core} = compile:file(Simple, [to_core,binary,time]),
?line c_module = element(1, Core),
?line {ok,_} = core_lint:module(Core),
io:put_chars("to_core (forms)"),
?line {ok,simple,Core} = compile:forms(PP, [to_core,binary,time]),
io:put_chars("to_kernel (file)"),
?line {ok,simple,Kernel} = compile:file(Simple, [to_kernel,binary,time]),
?line k_mdef = element(1, Kernel),
io:put_chars("to_kernel (forms)"),
?line {ok,simple,Kernel} = compile:forms(PP, [to_kernel,binary,time]),
io:put_chars("to_asm (file)"),
?line {ok,simple,Asm} = compile:file(Simple, [to_asm,binary,time]),
?line {simple,_,_,_,_} = Asm,
io:put_chars("to_asm (forms)"),
?line {ok,simple,Asm} = compile:forms(PP, [to_asm,binary,time]),
ok.
encrypted_abstr(Config) when is_list(Config) ->
{Simple,Target} = get_files(Config, simple, "encrypted_abstr"),
Res = case has_crypto() of
false ->
%% No crypto.
?line encrypted_abstr_no_crypto(Simple, Target),
{comment,"The crypto application is missing or broken"};
true ->
%% Simulate not having crypto by removing
%% the crypto application from the path.
?line OldPath = code:get_path(),
try
?line NewPath = OldPath -- [filename:dirname(code:which(crypto))],
?line (catch crypto:stop()),
?line code:delete(crypto),
?line code:purge(crypto),
?line code:set_path(NewPath),
?line encrypted_abstr_no_crypto(Simple, Target)
after
code:set_path(OldPath)
end,
%% Now run the tests that require crypto.
?line encrypted_abstr_1(Simple, Target),
?line ok = file:delete(Target),
?line ok = file:del_dir(filename:dirname(Target))
end,
%% Cleanup.
Res.
encrypted_abstr_1(Simple, Target) ->
?line TargetDir = filename:dirname(Target),
?line Key = "ablurf123BX#$;3",
?line install_crypto_key(Key),
?line {ok,simple} = compile:file(Simple,
[debug_info,{debug_info_key,Key},
{outdir,TargetDir}]),
?line verify_abstract(Target),
?line {ok,simple} = compile:file(Simple,
[{debug_info_key,Key},
{outdir,TargetDir}]),
?line verify_abstract(Target),
?line {ok,simple} = compile:file(Simple,
[debug_info,{debug_info_key,{des3_cbc,Key}},
{outdir,TargetDir}]),
?line verify_abstract(Target),
?line {ok,{simple,[{compile_info,CInfo}]}} =
beam_lib:chunks(Target, [compile_info]),
{_,Opts} = lists:keyfind(options, 1, CInfo),
{_,'********'} = lists:keyfind(debug_info_key, 1, Opts),
%% Try some illegal forms of crypto keys.
?line error = compile:file(Simple,
[debug_info,{debug_info_key,{blurf,"ss"}},report]),
?line error = compile:file(Simple,
[debug_info,{debug_info_key,{blurf,1,"ss"}},report]),
?line error = compile:file(Simple,
[debug_info,{debug_info_key,42},report]),
%% Place the crypto key in .erlang.crypt.
?line beam_lib:clear_crypto_key_fun(),
?line {ok,OldCwd} = file:get_cwd(),
?line ok = file:set_cwd(TargetDir),
?line error = compile:file(Simple, [encrypt_debug_info,report]),
?line NewKey = "better use another key here",
?line write_crypt_file(["[{debug_info,des3_cbc,simple,\"",NewKey,"\"}].\n"]),
?line {ok,simple} = compile:file(Simple, [encrypt_debug_info,report]),
?line verify_abstract("simple.beam"),
?line ok = file:delete(".erlang.crypt"),
?line beam_lib:clear_crypto_key_fun(),
?line {error,beam_lib,{key_missing_or_invalid,"simple.beam",abstract_code}} =
beam_lib:chunks("simple.beam", [abstract_code]),
?line ok = file:set_cwd(OldCwd),
%% Test key compatibility by reading a BEAM file produced before
%% the update to the new crypto functions.
install_crypto_key("an old key"),
KeyCompat = filename:join(filename:dirname(Simple),
"key_compatibility"),
{ok,{key_compatibility,[Chunk]}} = beam_lib:chunks(KeyCompat,
[abstract_code]),
{abstract_code,{raw_abstract_v1,_}} = Chunk,
ok.
write_crypt_file(Contents0) ->
Contents = list_to_binary([Contents0]),
io:format("~s\n", [binary_to_list(Contents)]),
ok = file:write_file(".erlang.crypt", Contents).
encrypted_abstr_no_crypto(Simple, Target) ->
io:format("simpe: ~p~n", [Simple]),
?line TargetDir = filename:dirname(Target),
?line Key = "ablurf123BX#$;3",
?line error = compile:file(Simple,
[debug_info,{debug_info_key,Key},
{outdir,TargetDir},report]),
ok.
verify_abstract(Target) ->
{ok,{simple,[Chunk]}} = beam_lib:chunks(Target, [abstract_code]),
{abstract_code,{raw_abstract_v1,_}} = Chunk.
has_crypto() ->
try
crypto:start(),
<<_,_,_,_,_>> = crypto:rand_bytes(5),
crypto:stop(),
true
catch
error:_ -> false
end.
install_crypto_key(Key) ->
F = fun (init) -> ok;
({debug_info,des3_cbc,_,_}) -> Key;
(clear) -> ok
end,
ok = beam_lib:crypto_key_fun(F).
%% Miscellanous tests, mainly to get better coverage.
cover(Config) when is_list(Config) ->
?line io:format("~p\n", [compile:options()]),
ok.
do_listing(Source, TargetDir, Type) ->
do_listing(Source, TargetDir, Type, "." ++ atom_to_list(Type)).
do_listing(Source, TargetDir, Type, Ext) ->
io:format("Source: ~p TargetDir: ~p\n Type: ~p Ext: ~p\n",
[Source, TargetDir, Type, Ext]),
case compile:file(Source, [Type, time, {outdir, TargetDir}]) of
{ok, _} -> ok;
Other -> ct:fail({unexpected_result, Other})
end,
SourceBase = filename:rootname(filename:basename(Source)),
Target = filename:join(TargetDir, SourceBase ++ Ext),
true = exists(Target).
get_files(Config, Module, OutputName) ->
code:delete(Module),
code:purge(Module),
DataDir = proplists:get_value(data_dir, Config),
PrivDir = proplists:get_value(priv_dir, Config),
Src = filename:join(DataDir, atom_to_list(Module)),
TargetDir = filename:join(PrivDir, OutputName),
ok = file:make_dir(TargetDir),
File = atom_to_list(Module) ++ code:objfile_extension(),
Target = filename:join(TargetDir, File),
{Src, Target}.
run(Target, Func, Args) ->
?line Module = list_to_atom(filename:rootname(filename:basename(Target))),
?line {module, Module} = code:load_abs(filename:rootname(Target)),
?line Result = (catch apply(Module, Func, Args)),
?line true = code:delete(Module),
?line false = code:purge(Module),
Result.
exists(Name) ->
case file:read_file_info(Name) of
{ok, _} -> true;
{error, _} -> false
end.
strict_record(Config) when is_list(Config) ->
Priv = proplists:get_value(priv_dir, Config),
ok = file:set_cwd(proplists:get_value(data_dir, Config)),
?line Opts = [{outdir,Priv},report_errors],
M = record_access,
?line {ok,M} = c:c(M, [strict_record_tests|Opts]),
?line Turtle = test_strict(),
?line {ok,M} = c:c(M, [no_strict_record_tests|Opts]),
?line Turtle = test_sloppy(),
%% The option first given wins.
?line {ok,M} = c:c(M, [no_strict_record_tests,strict_record_tests|Opts]),
?line Turtle = test_sloppy(),
?line {ok,M} = c:c(M, [strict_record_tests,no_strict_record_tests|Opts]),
?line Turtle = test_strict(),
%% Default (possibly influenced by ERL_COMPILER_OPTIONS).
?line {ok,M} = c:c(M, [{outdir,Priv},report_errors]),
?line try
{1,2} = record_access:test(Turtle),
{comment,"Default: no_strict_record_tests"}
catch
error:{badrecord,tortoise} ->
{comment,"Default: strict_record_tests"}
end.
test_strict() ->
Turtle = record_access:turtle(),
?line try
record_access:test(Turtle)
catch
error:{badrecord,tortoise} ->
ok
end,
Turtle.
test_sloppy() ->
Turtle = record_access:turtle(),
{1,2} = record_access:test(Turtle),
Turtle.
missing_testheap(Config) when is_list(Config) ->
DataDir = proplists:get_value(data_dir, Config),
PrivDir = proplists:get_value(priv_dir, Config),
Opts = [{outdir,PrivDir}],
OldPath = code:get_path(),
try
code:add_patha(PrivDir),
c:c(filename:join(DataDir, "missing_testheap1"), Opts),
c:c(filename:join(DataDir, "missing_testheap2"), Opts),
?line ok = test(fun() ->
missing_testheap1:f({a,self()},{state,true,b})
end, {a,b}),
?line ok = test(fun() ->
missing_testheap2:f({a,self()},16#80000000) end,
bigger)
after
code:set_path(OldPath),
file:delete(filename:join(PrivDir, "missing_testheap1.beam")),
file:delete(filename:join(PrivDir, "missing_testheap2.beam"))
end,
ok.
test(Fun, Result) ->
test(500, Fun, Result, []).
test(0, _, _, _) ->
ok;
test(Iter, Fun, Result, Filler) ->
spawn(?MODULE, init, [self(), Fun, list_to_tuple(Filler)]),
receive
{result, Result} ->
test(Iter-1, Fun, Result, [0|Filler]);
{result, Other} ->
io:format("Expected ~p; got ~p~n", [Result, Other]),
ct:fail(failed)
end.
init(ReplyTo, Fun, _Filler) ->
ReplyTo ! {result, Fun()}.
env(Config) when is_list(Config) ->
{Simple,Target} = get_files(Config, simple, env),
?line {ok,Cwd} = file:get_cwd(),
?line ok = file:set_cwd(filename:dirname(Target)),
true = os:putenv("ERL_COMPILER_OPTIONS", "binary"),
try
env_1(Simple, Target)
after
true = os:putenv("ERL_COMPILER_OPTIONS", "ignore_me"),
file:set_cwd(Cwd),
file:delete(Target),
file:del_dir(filename:dirname(Target))
end,
ok.
env_1(Simple, Target) ->
%% file
?line {ok,simple,<<_/binary>>} = compile:file(Simple),
?line {ok,simple} = compile:noenv_file(Simple, [debug_info]),
?line true = exists(Target),
?line {ok,{simple,[{abstract_code,Abstr0}]}} =
beam_lib:chunks(Target, [abstract_code]),
?line {raw_abstract_v1,Forms} = Abstr0,
%% forms
?line true = os:putenv("ERL_COMPILER_OPTIONS", "strong_validation"),
?line {ok,simple} = compile:forms(Forms),
?line {ok,simple,<<"FOR1",_/binary>>} = compile:noenv_forms(Forms, []),
%% output_generated
?line false = compile:output_generated([]),
?line true = compile:noenv_output_generated([]),
?line ok = file:delete(Target),
ok.
%% Test pretty-printing in Core Erlang format and then try to
%% compile the generated Core Erlang files.
core(Config) when is_list(Config) ->
PrivDir = proplists:get_value(priv_dir, Config),
Outdir = filename:join(PrivDir, "core"),
ok = file:make_dir(Outdir),
Wc = filename:join(filename:dirname(code:which(?MODULE)), "*.beam"),
TestBeams = filelib:wildcard(Wc),
Abstr = [begin {ok,{Mod,[{abstract_code,
{raw_abstract_v1,Abstr}}]}} =
beam_lib:chunks(Beam, [abstract_code]),
{Mod,Abstr} end || Beam <- TestBeams],
test_lib:p_run(fun(F) -> do_core(F, Outdir) end, Abstr).
do_core({M,A}, Outdir) ->
try
do_core_1(M, A, Outdir)
catch
throw:{error,Error} ->
io:format("*** compilation failure '~p' for module ~s\n",
[Error,M]),
error;
Class:Error ->
io:format("~p: ~p ~p\n~p\n",
[M,Class,Error,erlang:get_stacktrace()]),
error
end.
do_core_1(M, A, Outdir) ->
{ok,M,Core0} = compile:forms(A, [to_core]),
CoreFile = filename:join(Outdir, atom_to_list(M)++".core"),
CorePP = core_pp:format(Core0),
ok = file:write_file(CoreFile, CorePP),
%% Parse the .core file and return the result as Core Erlang Terms.
Core = case compile:file(CoreFile, [report_errors,from_core,no_copt,to_core,binary]) of
{ok,M,Core1} -> Core1;
Other -> throw({error,Other})
end,
ok = file:delete(CoreFile),
%% Compile as usual (including optimizations).
compile_forms(Core, [clint,from_core,binary]),
%% Don't optimize to test that we are not dependent
%% on the Core Erlang optmimization passes.
%% (Example of a previous bug: The core_parse pass
%% would not turn map literals into #c_literal{}
%% records; if sys_core_fold was run it would fix
%% that; if sys_core_fold was not run v3_kernel would
%% crash.)
compile_forms(Core, [clint,from_core,no_copt,binary]),
ok.
compile_forms(Forms, Opts) ->
case compile:forms(Forms, [report_errors|Opts]) of
{ok,[],_} -> ok;
Other -> throw({error,Other})
end.
%% Compile to Beam assembly language (.S) and then try to
%% run .S through the compiler again.
asm(Config) when is_list(Config) ->
PrivDir = proplists:get_value(priv_dir, Config),
?line Outdir = filename:join(PrivDir, "asm"),
?line ok = file:make_dir(Outdir),
?line Wc = filename:join(filename:dirname(code:which(?MODULE)), "*.beam"),
?line TestBeams = filelib:wildcard(Wc),
?line Res = test_lib:p_run(fun(F) -> do_asm(F, Outdir) end, TestBeams),
Res.
do_asm(Beam, Outdir) ->
{ok,{M,[{abstract_code,{raw_abstract_v1,A}}]}} =
beam_lib:chunks(Beam, [abstract_code]),
try
{ok,M,Asm} = compile:forms(A, ['S']),
AsmFile = filename:join(Outdir, atom_to_list(M)++".S"),
{ok,Fd} = file:open(AsmFile, [write,{encoding,utf8}]),
beam_listing:module(Fd, Asm),
ok = file:close(Fd),
case compile:file(AsmFile, [from_asm,binary,report]) of
{ok,M,_} ->
ok = file:delete(AsmFile);
Other ->
io:format("*** failure '~p' for ~s\n",
[Other,AsmFile]),
error
end
catch Class:Error ->
io:format("~p: ~p ~p\n~p\n",
[M,Class,Error,erlang:get_stacktrace()]),
error
end.
sys_pre_attributes(Config) ->
DataDir = proplists:get_value(data_dir, Config),
File = filename:join(DataDir, "attributes.erl"),
Mod = attributes,
CommonOpts = [binary,report,verbose,
{parse_transform,sys_pre_attributes}],
PreOpts = [{attribute,delete,deleted}],
PostOpts = [{attribute,insert,inserted,"value"}],
PrePostOpts = [{attribute,replace,replaced,42},
{attribute,replace,replace_nonexisting,new}],
{ok,Mod,Code} = compile:file(File, PrePostOpts ++ PreOpts ++
PostOpts ++ CommonOpts),
code:load_binary(Mod, File, Code),
Attr = Mod:module_info(attributes),
io:format("~p", [Attr]),
{inserted,"value"} = lists:keyfind(inserted, 1, Attr),
{replaced,[42]} = lists:keyfind(replaced, 1, Attr),
{replace_nonexisting,[new]} = lists:keyfind(replace_nonexisting, 1, Attr),
false = lists:keymember(deleted, 1, Attr),
%% Cover more code.
{ok,Mod,_} = compile:file(File, PostOpts ++ CommonOpts),
{ok,Mod,_} = compile:file(File, CommonOpts -- [verbose]),
{ok,Mod,_} = compile:file(File, PreOpts ++ CommonOpts),
{ok,Mod,_} = compile:file(File,
[{attribute,replace,replaced,42}|CommonOpts]),
{ok,Mod,_} = compile:file(File, PrePostOpts ++ PreOpts ++
PostOpts ++ CommonOpts --
[report,verbose]),
ok.
%% Test the dialyzer option to cover more code.
dialyzer(Config) ->
Priv = proplists:get_value(priv_dir, Config),
ok = file:set_cwd(proplists:get_value(data_dir, Config)),
Opts = [{outdir,Priv},report_errors],
M = dialyzer_test,
{ok,M} = c:c(M, [dialyzer|Opts]),
[{a,b,c}] = M:M(),
%% Cover huge line numbers without the 'dialyzer' option.
{ok,M} = c:c(M, Opts),
[{a,b,c}] = M:M(),
ok.
%% Test that warnings contain filenames and line numbers.
warnings(_Config) ->
TestDir = filename:dirname(code:which(?MODULE)),
Files = filelib:wildcard(filename:join(TestDir, "*.erl")),
test_lib:p_run(fun do_warnings/1, Files).
do_warnings(F) ->
{ok,_,_,Ws} = compile:file(F, [binary,bin_opt_info,return]),
do_warnings_1(Ws, F).
do_warnings_1([{"no_file",Ws}|_], F) ->
io:format("~s:\nMissing file for warnings: ~p\n",
[F,Ws]),
error;
do_warnings_1([{Name,Ws}|T], F) ->
case filename:extension(Name) of
".erl" ->
do_warnings_2(Ws, T, F);
_ ->
io:format("~s:\nNo .erl extension\n", [F]),
error
end;
do_warnings_1([], _) -> ok.
do_warnings_2([{Int,_,_}=W|T], Next, F) ->
if
is_integer(Int) ->
do_warnings_2(T, Next, F);
true ->
io:format("~s:\nMissing line number: ~p\n",
[F,W]),
error
end;
do_warnings_2([], Next, F) ->
do_warnings_1(Next, F).
%%%
%%% Utilities.
%%%
compile_and_verify(Name, Target, Opts) ->
Mod = list_to_atom(filename:basename(Name, ".erl")),
{ok,Mod} = compile:file(Name, Opts),
{ok,{Mod,[{compile_info,CInfo}]}} =
beam_lib:chunks(Target, [compile_info]),
{options,BeamOpts} = lists:keyfind(options, 1, CInfo),
Opts = BeamOpts.
|