%% %% %CopyrightBegin% %% %% Copyright Ericsson AB 2000-2013. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in %% compliance with the License. You should have received a copy of the %% Erlang Public License along with this software. If not, it can be %% retrieved online at http://www.erlang.org/. %% %% Software distributed under the License is distributed on an "AS IS" %% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See %% the License for the specific language governing rights and limitations %% under the License. %% %% %CopyrightEnd% %% -module(otp_SUITE). -export([all/0, suite/0,groups/0,init_per_group/2,end_per_group/2, init_per_suite/1,end_per_suite/1]). -export([undefined_functions/1,deprecated_not_in_obsolete/1, obsolete_but_not_deprecated/1,call_to_deprecated/1, call_to_size_1/1,strong_components/1, erl_file_encoding/1,xml_file_encoding/1,runtime_dependencies/1]). -include_lib("test_server/include/test_server.hrl"). -import(lists, [filter/2,foldl/3,foreach/2]). suite() -> [{ct_hooks,[ts_install_cth]}]. all() -> [undefined_functions, deprecated_not_in_obsolete, obsolete_but_not_deprecated, call_to_deprecated, call_to_size_1, strong_components, erl_file_encoding, xml_file_encoding, runtime_dependencies]. groups() -> []. init_per_group(_GroupName, Config) -> Config. end_per_group(_GroupName, Config) -> Config. init_per_suite(Config) -> Dog = test_server:timetrap(?t:minutes(10)), Root = code:root_dir(), Server = daily_xref, ?line xref:start(Server), ?line xref:set_default(Server, [{verbose,false}, {warnings,false}, {builtins,true}]), ?line {ok,_Relname} = xref:add_release(Server, Root, {name,otp}), %% If we are running the tests in the source tree, the ERTS application %% is not in the code path. We must add it explicitly. case code:lib_dir(erts) of {error,bad_name} -> Erts = filename:join([code:root_dir(),"erts","preloaded","ebin"]), ?line {ok,_} = xref:add_directory(Server, Erts, []); _ -> ok end, ?line ?t:timetrap_cancel(Dog), [{xref_server,Server}|Config]. end_per_suite(Config) -> Server = ?config(xref_server, Config), catch xref:stop(Server), Config. undefined_functions(Config) when is_list(Config) -> Server = ?config(xref_server, Config), %% Exclude calls from generated modules in the SSL application. ExcludeFrom = "SSL-PKIX|PKIX.*|ssl_pkix_oid", ?line UndefS = xref_base:analysis(undefined_function_calls), ?line Q = io_lib:format("Undef = ~s," "ExcludedFrom = ~p:_/_," "Undef - Undef | ExcludedFrom", [UndefS,ExcludeFrom]), {ok,Undef0} = xref:q(Server, lists:flatten(Q)), Undef1 = hipe_filter(Undef0), Undef2 = ssl_crypto_filter(Undef1), Undef3 = edoc_filter(Undef2), Undef4 = eunit_filter(Undef3), Undef5 = dialyzer_filter(Undef4), Undef6 = wx_filter(Undef5), Undef = gs_filter(Undef6), case Undef of [] -> ok; _ -> Fd = open_log(Config, "undefined_functions"), foreach(fun ({MFA1,MFA2}) -> io:format("~s calls undefined ~s", [format_mfa(Server, MFA1), format_mfa(MFA2)]), io:format(Fd, "~s ~s\n", [format_mfa(Server, MFA1), format_mfa(MFA2)]) end, Undef), close_log(Fd), ?line ?t:fail({length(Undef),undefined_functions_in_otp}) end. hipe_filter(Undef) -> case erlang:system_info(hipe_architecture) of undefined -> filter(fun ({_,{hipe_bifs,_,_}}) -> false; ({_,{hipe,_,_}}) -> false; ({_,{hipe_consttab,_,_}}) -> false; ({_,{hipe_converters,_,_}}) -> false; ({{code,_,_},{Mod,_,_}}) -> not is_hipe_module(Mod); ({{code_server,_,_},{Mod,_,_}}) -> not is_hipe_module(Mod); ({{compile,_,_},{Mod,_,_}}) -> not is_hipe_module(Mod); ({{hipe,_,_},{Mod,_,_}}) -> %% See comment for the next clause. not is_hipe_module(Mod); ({{cerl_to_icode,translate_flags1,2}, {hipe_rtl_arch,endianess,0}}) -> false; ({{Caller,_,_},{Callee,_,_}}) -> %% Part of the hipe application is here %% for the sake of Dialyzer. There are many %% undefined calls within the hipe application. not is_hipe_module(Caller) orelse not is_hipe_module(Callee); (_) -> true end, Undef); _Arch -> filter(fun ({{Mod,_,_},{hipe_bifs,write_u64,2}}) -> %% Unavailable except in 64 bit AMD. Ignore it. not is_hipe_module(Mod); (_) -> true end, Undef) end. is_hipe_module(Mod) -> case atom_to_list(Mod) of "hipe_"++_ -> true; _ -> false end. ssl_crypto_filter(Undef) -> case {app_exists(crypto),app_exists(ssl)} of {false,false} -> filter(fun({_,{ssl,_,_}}) -> false; ({_,{crypto,_,_}}) -> false; ({_,{ssh,_,_}}) -> false; ({_,{ssh_connection,_,_}}) -> false; ({_,{ssh_sftp,_,_}}) -> false; (_) -> true end, Undef); {_,_} -> Undef end. edoc_filter(Undef) -> %% Filter away function call that is catched. filter(fun({{edoc_lib,uri_get_http,1},{http,request_sync,2}}) -> false; (_) -> true end, Undef). eunit_filter(Undef) -> filter(fun({{eunit_test,wrapper_test_exported_,0}, {eunit_test,nonexisting_function,0}}) -> false; (_) -> true end, Undef). dialyzer_filter(Undef) -> case app_exists(dialyzer) of false -> filter(fun({_,{dialyzer_callgraph,_,_}}) -> false; ({_,{dialyzer_codeserver,_,_}}) -> false; ({_,{dialyzer_contracts,_,_}}) -> false; ({_,{dialyzer_cl_parse,_,_}}) -> false; ({_,{dialyzer_timing,_,_}}) -> false; ({_,{dialyzer_plt,_,_}}) -> false; ({_,{dialyzer_succ_typings,_,_}}) -> false; ({_,{dialyzer_utils,_,_}}) -> false; (_) -> true end, Undef); _ -> Undef end. wx_filter(Undef) -> case app_exists(wx) of false -> filter(fun({_,{MaybeWxModule,_,_}}) -> case atom_to_list(MaybeWxModule) of "wx"++_ -> false; _ -> true end end, Undef); _ -> Undef end. gs_filter(Undef) -> case code:lib_dir(gs) of {error,bad_name} -> filter(fun({_,{gs,_,_}}) -> false; ({_,{gse,_,_}}) -> false; ({_,{tool_utils,_,_}}) -> false; (_) -> true end, Undef); _ -> Undef end. deprecated_not_in_obsolete(Config) when is_list(Config) -> ?line Server = ?config(xref_server, Config), ?line {ok,DeprecatedFunctions} = xref:q(Server, "DF"), ?line L = foldl(fun({M,F,A}=MFA, Acc) -> case otp_internal:obsolete(M, F, A) of no -> [MFA|Acc]; _ -> Acc end end, [], DeprecatedFunctions), case L of [] -> ok; _ -> io:put_chars("The following functions have -deprecated() attributes,\n" "but are not listed in otp_internal:obsolete/3.\n"), print_mfas(group_leader(), Server, L), Fd = open_log(Config, "deprecated_not_obsolete"), print_mfas(Fd, Server, L), close_log(Fd), ?line ?t:fail({length(L),deprecated_but_not_obsolete}) end. obsolete_but_not_deprecated(Config) when is_list(Config) -> ?line Server = ?config(xref_server, Config), ?line {ok,NotDeprecated} = xref:q(Server, "X - DF"), ?line L = foldl(fun({M,F,A}=MFA, Acc) -> case otp_internal:obsolete(M, F, A) of no -> Acc; _ -> [MFA|Acc] end end, [], NotDeprecated), case L of [] -> ok; _ -> io:put_chars("The following functions are listed " "in otp_internal:obsolete/3,\n" "but don't have -deprecated() attributes.\n"), print_mfas(group_leader(), Server, L), Fd = open_log(Config, "obsolete_not_deprecated"), print_mfas(Fd, Server, L), close_log(Fd), ?line ?t:fail({length(L),obsolete_but_not_deprecated}) end. call_to_deprecated(Config) when is_list(Config) -> Server = ?config(xref_server, Config), ?line {ok,DeprecatedCalls} = xref:q(Server, "strict(E || DF)"), foreach(fun ({MFA1,MFA2}) -> io:format("~s calls deprecated ~s", [format_mfa(MFA1),format_mfa(MFA2)]) end, DeprecatedCalls), {comment,integer_to_list(length(DeprecatedCalls))++" calls to deprecated functions"}. call_to_size_1(Config) when is_list(Config) -> Server = ?config(xref_server, Config), %% Applications that do not call erlang:size/1: Apps = [asn1,compiler,debugger,kernel,observer,parsetools, runtime_tools,stdlib,tools,webtool], Fs = [{erlang,size,1}], Q1 = io_lib:format("E || ~p : Fun", [Fs]), ?line {ok,AllCallsToSize1} = xref:q(Server, lists:flatten(Q1)), Q2 = io_lib:format("E | ~p : App || ~p : Fun", [Apps,Fs]), ?line {ok,CallsToSize1} = xref:q(Server, lists:flatten(Q2)), case CallsToSize1 of [] -> ok; _ -> io:format("These calls cause an error:~n"), foreach(fun ({MFA1,MFA2}) -> io:format("~s calls soon to be deprecated ~s", [format_mfa(MFA1),format_mfa(MFA2)]) end, CallsToSize1) end, %% Enumerate calls to erlang:size/1 from other applications than %% the ones known not to call erlang:size/1: case AllCallsToSize1--CallsToSize1 of [] -> ok; Calls -> io:format("~n~nThese calls do not cause an error (yet):~n"), foreach(fun ({MFA1,MFA2}) -> io:format("~s calls soon to be deprecated ~s", [format_mfa(MFA1),format_mfa(MFA2)]) end, Calls) end, case CallsToSize1 of [] -> ok; _ -> ?line ?t:fail({length(CallsToSize1),calls_to_size_1}) end. strong_components(Config) when is_list(Config) -> Server = ?config(xref_server, Config), ?line {ok,Cs} = xref:q(Server, "components AE"), io:format("\n\nStrong components:\n\n~p\n", [Cs]), ok. erl_file_encoding(_Config) -> Root = code:root_dir(), Wc = filename:join([Root,"**","*.erl"]), ErlFiles = ordsets:subtract(ordsets:from_list(filelib:wildcard(Wc)), release_files(Root, "*.erl")), Fs = [F || F <- ErlFiles, case epp:read_encoding(F) of none -> false; _ -> true end], case Fs of [] -> ok; [_|_] -> io:put_chars("Files with \"coding:\":\n"), [io:put_chars(F) || F <- Fs], ?t:fail() end. xml_file_encoding(_Config) -> XmlFiles = xml_files(), Fs = [F || F <- XmlFiles, is_bad_encoding(F)], case Fs of [] -> ok; [_|_] -> io:put_chars("Encoding should be \"utf-8\" or \"UTF-8\":\n"), [io:put_chars(F) || F <- Fs], ?t:fail() end. xml_files() -> Root = code:root_dir(), AllWc = filename:join([Root,"**","*.xml"]), AllXmlFiles = ordsets:from_list(filelib:wildcard(AllWc)), TestsWc = filename:join([Root,"lib","*","test","**","*.xml"]), TestXmlFiles = ordsets:from_list(filelib:wildcard(TestsWc)), XmerlWc = filename:join([Root,"lib","xmerl","**","*.xml"]), XmerlXmlFiles = ordsets:from_list(filelib:wildcard(XmerlWc)), Ignore = ordsets:union([TestXmlFiles,XmerlXmlFiles, release_files(Root, "*.xml")]), ordsets:subtract(AllXmlFiles, Ignore). release_files(Root, Ext) -> Wc = filename:join([Root,"release","**",Ext]), filelib:wildcard(Wc). is_bad_encoding(File) -> {ok,Bin} = file:read_file(File), case Bin of <<"<?xml version=\"1.0\" encoding=\"utf-8\"",_/binary>> -> false; <<"<?xml version=\"1.0\" encoding=\"UTF-8\"",_/binary>> -> false; _ -> true end. runtime_dependencies(Config) -> %% Verify that (at least) OTP application runtime dependencies found %% by xref are listed in the runtime_dependencies field of the .app file %% of each application. Server = ?config(xref_server, Config), {ok, AE} = xref:q(Server, "AE"), SAE = lists:keysort(1, AE), {AppDep, AppDeps} = lists:foldl(fun ({App, App}, Acc) -> Acc; ({App, Dep}, {undefined, []}) -> {{App, [Dep]}, []}; ({App, Dep}, {{App, Deps}, AppDeps}) -> {{App, [Dep|Deps]}, AppDeps}; ({App, Dep}, {AppDep, AppDeps}) -> {{App, [Dep]}, [AppDep | AppDeps]} end, {undefined, []}, SAE), [] = check_apps_deps([AppDep|AppDeps]), ok. have_rdep(_App, [], _Dep) -> false; have_rdep(App, [RDep | RDeps], Dep) -> [AppStr, _VsnStr] = string:tokens(RDep, "-"), case Dep == list_to_atom(AppStr) of true -> io:format("~p -> ~s~n", [App, RDep]), true; false -> have_rdep(App, RDeps, Dep) end. check_app_deps(_App, _AppFile, _AFDeps, []) -> []; check_app_deps(App, AppFile, AFDeps, [XRDep | XRDeps]) -> ResOtherDeps = check_app_deps(App, AppFile, AFDeps, XRDeps), case have_rdep(App, AFDeps, XRDep) of true -> ResOtherDeps; false -> [{missing_runtime_dependency, AppFile, XRDep} | ResOtherDeps] end. check_apps_deps([]) -> []; check_apps_deps([{App, Deps}|AppDeps]) -> ResOtherApps = check_apps_deps(AppDeps), AppFile = code:where_is_file(atom_to_list(App) ++ ".app"), {ok,[{application, App, Info}]} = file:consult(AppFile), case lists:keyfind(runtime_dependencies, 1, Info) of {runtime_dependencies, RDeps} -> check_app_deps(App, AppFile, RDeps, Deps) ++ ResOtherApps; false -> [{missing_runtime_dependencies_key, AppFile} | ResOtherApps] end. %%% %%% Common help functions. %%% print_mfas(Fd, Server, MFAs) -> [io:format(Fd, "~s\n", [format_mfa(Server, MFA)]) || MFA <- MFAs], ok. format_mfa({M,F,A}) -> lists:flatten(io_lib:format("~s:~s/~p", [M,F,A])). format_mfa(Server, MFA) -> MFAString = format_mfa(MFA), AQ = "(App)" ++ MFAString, AppPrefix = case xref:q(Server, AQ) of {ok,[App]} -> "[" ++ atom_to_list(App) ++ "]"; _ -> "" end, AppPrefix ++ MFAString. open_log(Config, Name) -> PrivDir = ?config(priv_dir, Config), RunDir = filename:dirname(filename:dirname(PrivDir)), Path = filename:join(RunDir, "system_"++Name++".log"), {ok,Fd} = file:open(Path, [write]), Fd. close_log(Fd) -> ok = file:close(Fd). app_exists(AppAtom) -> case code:lib_dir(AppAtom) of {error,bad_name} -> false; Path -> case file:read_file_info(filename:join(Path,"ebin")) of {ok,_} -> true; _ -> false end end.