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
|
%% ``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.
%%
%% The Initial Developer of the Original Code is Ericsson Utvecklings AB.
%% Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings
%% AB. All Rights Reserved.''
%%
-module(edoc_SUITE).
-include_lib("common_test/include/ct.hrl").
%% Test server specific exports
-export([all/0, suite/0,groups/0,init_per_suite/1, end_per_suite/1,
init_per_group/2,end_per_group/2]).
%% Test cases
-export([app/1,appup/1,build_std/1,build_map_module/1,otp_12008/1,
build_app/1, otp_14285/1, infer_module_app_test/1]).
suite() -> [{ct_hooks,[ts_install_cth]}].
all() ->
[app,appup,build_std,build_map_module,otp_12008, build_app, otp_14285,
infer_module_app_test].
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 .app file does not contain any `basic' errors
app(Config) when is_list(Config) ->
ok = test_server:app_test(edoc).
%% Test that the .appup file does not contain any `basic' errors
appup(Config) when is_list(Config) ->
ok = test_server:appup_test(edoc).
build_std(suite) -> [];
build_std(doc) -> ["Build some documentation using standard EDoc layout"];
build_std(Config) when is_list(Config) ->
DataDir = ?config(data_dir, Config),
Overview1 = filename:join(DataDir, "overview.edoc"),
Overview2 = filename:join(DataDir, "overview.syntax_tools"),
PrivDir = ?config(priv_dir, Config),
ok = edoc:application(edoc, [{overview, Overview1},
{def, {vsn,"TEST"}},
{dir, PrivDir}]),
ok = edoc:application(syntax_tools, [{overview, Overview2},
{def, {vsn,"TEST"}},
{dir, PrivDir}]),
MF = fun(_MacroArg="", _Line, _Env) -> "TEST" end,
ok = edoc:application(syntax_tools, [{overview, Overview2},
{def, {vsn,MF}},
{dir, PrivDir}]),
ok = edoc:application(xmerl, [{preprocess,true},{dir, PrivDir}]),
ok.
build_map_module(Config) when is_list(Config) ->
DataDir = ?config(data_dir, Config),
PrivDir = ?config(priv_dir, Config),
Filename = filename:join(DataDir, "map_module.erl"),
ok = edoc:file(Filename, [{dir, PrivDir}]),
ok.
otp_12008(Config) when is_list(Config) ->
DataDir = ?config(data_dir, Config),
PrivDir = ?config(priv_dir, Config),
Un1 = filename:join(DataDir, "un1.erl"),
Un2 = filename:join(DataDir, "un2.erl"),
Un3 = filename:join(DataDir, "un3.erl"),
%% epp_dodger
Opts1 = [{dir, PrivDir}],
ok = edoc:files([Un1], Opts1),
ok = edoc:files([Un2], Opts1),
{'EXIT', error} = (catch edoc:files([Un3], Opts1)),
%% epp
Opts2 = [{preprocess, true}, {dir, PrivDir}],
ok = edoc:files([Un1], Opts2),
ok = edoc:files([Un2], Opts2),
{'EXIT', error} = (catch edoc:files([Un3], Opts2)),
ok.
build_app(suite) -> [];
build_app(doc) -> ["Build a local app with nested source directories"];
build_app(Config) ->
DataDir = ?config(data_dir, Config),
PrivDir = ?config(priv_dir, Config),
OutDir = filename:join(PrivDir, "myapp"),
Src = filename:join(DataDir, "myapp"),
ok = edoc:application(myapp, Src, [{dir, OutDir}, {subpackages, false}]),
true = filelib:is_regular(filename:join(OutDir, "a.html")),
false = filelib:is_regular(filename:join(OutDir, "b.html")),
ok = edoc:application(myapp, Src, [{dir, OutDir}]),
true = filelib:is_regular(filename:join(OutDir, "a.html")),
true = filelib:is_regular(filename:join(OutDir, "b.html")),
ok.
otp_14285(Config) ->
DataDir = ?config(data_dir, Config),
PrivDir = ?config(priv_dir, Config),
Un1 = filename:join(DataDir, "un_atom1.erl"),
Un2 = filename:join(DataDir, "un_atom2.erl"),
%% epp_dodger
Opts1 = [{dir, PrivDir}],
ok = edoc:files([Un1], Opts1),
ok = edoc:files([Un2], Opts1),
%% epp
Opts2 = [{preprocess, true}, {dir, PrivDir}],
ok = edoc:files([Un1], Opts2),
ok = edoc:files([Un2], Opts2),
ok.
infer_module_app_test(Config) ->
Modules = lists:map(fun ({M, _, _}) ->
{list_to_atom(M), M ++ ".beam"}
end, code:all_available()),
true = lists:all(fun infer_module_app_test_/1, Modules).
infer_module_app_test_({M, Beam}) ->
case edoc_lib:infer_module_app(M) of
no_app ->
true;
{app, App} when is_atom(App) ->
%% When `App' is actually returned, the corresponding
%% BEAM file is expected to be found on disk in the app's
%% ebin dir.
%% `preloaded' modules should be found under `erts/ebin'
%% or under `erts/preloaded/ebin' in case of running tests
%% from the source tree.
BeamPath1 = filename:join([code:lib_dir(App), "ebin", Beam]),
BeamPath2 = filename:join([code:lib_dir(App), "preloaded", "ebin", Beam]),
R1 = filelib:is_regular(BeamPath1),
R2 = filelib:is_regular(BeamPath2),
R1 orelse R2
end.
|
