The R13B03 release.OTP_R13B03

1 files changed, 525 insertions, 0 deletions

diff --git a/lib/snmp/test/snmp_test_lib.erl b/lib/snmp/test/snmp_test_lib.erl
new file mode 100644
index 0000000000..2586b66a13
--- /dev/null
+++ b/lib/snmp/test/snmp_test_lib.erl
@@ -0,0 +1,525 @@
+%% 
+%% %CopyrightBegin%
+%% 
+%% Copyright Ericsson AB 2002-2009. 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(snmp_test_lib).
+
+-include_lib("kernel/include/file.hrl").
+
+
+-export([hostname/0, hostname/1, localhost/0, os_type/0, sz/1,
+	 display_suite_info/1]).
+-export([non_pc_tc_maybe_skip/4, os_based_skip/1]).
+-export([replace_config/3, set_config/3, get_config/2, get_config/3]).
+-export([fail/3, skip/3]).
+-export([millis/0, millis_diff/2, hours/1, minutes/1, seconds/1, sleep/1]).
+-export([flush_mqueue/0, trap_exit/0, trap_exit/1]).
+-export([ping/1, local_nodes/0, nodes_on/1]).
+-export([start_node/2]).
+-export([is_app_running/1, 
+	 is_crypto_running/0, is_mnesia_running/0, is_snmp_running/0]).
+-export([crypto_start/0, crypto_support/0]).
+-export([watchdog/3, watchdog_start/1, watchdog_start/2, watchdog_stop/1]).
+-export([del_dir/1]).
+-export([cover/1]).
+-export([p/2, print/5]).
+
+
+%% ----------------------------------------------------------------------
+%% Misc functions
+%%
+
+hostname() ->
+    hostname(node()).
+
+hostname(Node) ->
+    from($@, atom_to_list(Node)).
+
+from(H, [H | T]) -> T;
+from(H, [_ | T]) -> from(H, T);
+from(_H, []) -> [].
+
+localhost() ->
+    {ok, Ip} = snmp_misc:ip(net_adm:localhost()),
+    Ip.
+
+sz(L) when is_list(L) ->
+    length(L);
+sz(B) when is_binary(B) ->
+    size(B);
+sz(O) ->
+    {unknown_size,O}.
+
+
+os_type() ->
+    case (catch test_server:os_type()) of
+	{'EXIT', _} ->
+	    %% Pre-R10 test server does not have this function
+	    os:type();
+	OsType ->
+	    OsType
+    end.
+
+display_suite_info(SUITE) when is_atom(SUITE) ->
+    (catch do_display_suite_info(SUITE)).
+
+do_display_suite_info(SUITE) ->
+    MI = SUITE:module_info(),
+    case (catch display_version(MI)) of
+	ok ->
+	    ok;
+	_ ->
+	    case (catch display_app_version(MI)) of
+		ok ->
+		    ok;
+		_ ->
+		    io:format("No version info available for test suite ~p~n",
+			      [?MODULE])
+	    end
+    end.
+
+display_version(MI) -> 
+    {value, {compile, CI}} = lists:keysearch(compile, 1, MI),
+    {value, {options, CO}} = lists:keysearch(options, 1, CI),
+    Version = version_of_compiler_options(CO),
+    io:format("~p version info: "
+	      "~n   Version: ~p"
+	      "~n", [?MODULE, Version]),
+    ok.
+
+version_of_compiler_options([{d, version, Version} | _]) ->
+    Version;
+version_of_compiler_options([_ | T]) ->
+    version_of_compiler_options(T).
+
+display_app_version(MI) ->
+    {value, {attributes, Attrs}} = lists:keysearch(attributes, 1, MI),
+    {value, {vsn, Vsn}}          = lists:keysearch(vsn, 1, Attrs),
+    {value, {app_vsn, AppVsn}}   = lists:keysearch(app_vsn, 1, Attrs),
+    io:format("~p version info: "
+	      "~n   VSN:     ~p"
+	      "~n   App vsn: ~s"
+	      "~n", [?MODULE, Vsn, AppVsn]),
+    ok.
+
+
+%% ----------------------------------------------------------------
+%% Conditional skip of testcases
+%%
+
+non_pc_tc_maybe_skip(Config, Condition, File, Line)
+  when is_list(Config) andalso is_function(Condition) ->
+    %% Check if we shall skip the skip
+    case os:getenv("TS_OS_BASED_SKIP") of
+        "false" ->
+            ok;
+        _ ->
+	    case lists:keysearch(ts, 1, Config) of
+		{value, {ts, snmp}} ->
+		    %% Always run the testcase if we are using our own
+		    %% test-server...
+		    ok;
+		_ ->
+		    case Condition() of
+			true ->
+			    skip(non_pc_testcase, File, Line);
+			false ->
+			    ok
+		    end
+	    end
+    end.
+
+
+os_based_skip(any) ->
+    io:format("os_based_skip(any) -> entry"
+	      "~n", []), 
+    true;
+os_based_skip(Skippable) when is_list(Skippable) ->
+    io:format("os_based_skip -> entry with"
+	      "~n   Skippable: ~p"
+	      "~n", [Skippable]), 
+    {OsFam, OsName} =
+        case os:type() of
+            {_Fam, _Name} = FamAndName ->
+                FamAndName;
+            Fam ->
+                {Fam, undefined}
+        end,
+    io:format("os_based_skip -> os-type: "
+	      "~n   OsFam: ~p"
+	      "~n   OsName: ~p"
+	      "~n", [OsFam, OsName]), 
+    case lists:member(OsFam, Skippable) of
+        true ->
+            true;
+        false ->
+            case lists:keysearch(OsFam, 1, Skippable) of
+                {value, {OsFam, OsName}} ->
+                    true;
+                {value, {OsFam, OsNames}} when is_list(OsNames) ->
+                    lists:member(OsName, OsNames);
+                _ ->
+                    false
+            end
+    end;
+os_based_skip(_Crap) ->
+    io:format("os_based_skip -> entry with"
+	      "~n   _Crap: ~p"
+	      "~n", [_Crap]), 
+    false.
+
+
+%% ----------------------------------------------------------------
+%% Test suite utility functions
+%% 
+
+replace_config(Key, Config, NewValue) ->
+    lists:keyreplace(Key, 1, Config, {Key, NewValue}).
+
+set_config(Key, Def, Config) ->
+    case get_config(Key, Config) of
+        undefined ->
+            [{Key, Def}|Config];
+        _ ->
+            Config
+    end.
+
+get_config(Key,C) ->
+    get_config(Key,C,undefined).
+
+get_config(Key,C,Default) ->
+    case lists:keysearch(Key,1,C) of
+        {value,{Key,Val}} ->
+            Val;
+        _ ->
+            Default
+    end.
+
+
+fail(Reason, Mod, Line) ->
+    exit({suite_failed, Reason, Mod, Line}).
+    
+skip(Reason, Module, Line) ->
+    String = lists:flatten(io_lib:format("Skipping ~p(~p): ~p~n", 
+					 [Module, Line, Reason])),
+    exit({skipped, String}).
+    
+
+%% ----------------------------------------------------------------
+%% Time related function
+%% 
+
+millis() ->
+    erlang:now().
+
+millis_diff(A,B) ->
+    T1 = (element(1,A)*1000000) + element(2,A) + (element(3,A)/1000000),
+    T2 = (element(1,B)*1000000) + element(2,B) + (element(3,B)/1000000),
+    T1 - T2.
+
+hours(N)   -> trunc(N * 1000 * 60 * 60).
+minutes(N) -> trunc(N * 1000 * 60).
+seconds(N) -> trunc(N * 1000).
+
+
+sleep(infinity) ->
+    receive
+    after infinity ->
+            ok
+    end;
+sleep(MSecs) ->
+    receive
+    after trunc(MSecs) ->
+            ok
+    end,
+    ok.
+
+
+%% ----------------------------------------------------------------
+%% Process utility function
+%% 
+
+flush_mqueue() ->
+    io:format("~p~n", [lists:reverse(flush_mqueue([]))]).
+
+flush_mqueue(MQ) ->
+    receive
+        Any ->
+            flush_mqueue([Any|MQ])
+    after 0 ->
+            MQ
+    end.
+
+    
+trap_exit() -> 
+    {trap_exit,Flag} = process_info(self(),trap_exit),Flag.
+
+trap_exit(Flag) -> 
+    process_flag(trap_exit,Flag).
+
+
+
+%% ----------------------------------------------------------------
+%% Node utility functions
+%% 
+
+ping(N) ->
+    case net_adm:ping(N) of
+ 	pang ->
+ 	    error;
+ 	pong ->
+ 	    ok
+     end.
+
+local_nodes() ->
+    nodes_on(net_adm:localhost()).
+
+nodes_on(Host) when is_list(Host) ->
+    net_adm:world_list([list_to_atom(Host)]).
+
+
+start_node(Name, Args) ->
+    Opts = [{cleanup,false}, {args,Args}],
+    test_server:start_node(Name, slave, Opts).
+
+
+%% ----------------------------------------------------------------
+%% Application and Crypto utility functions
+%% 
+
+is_app_running(App) when is_atom(App) ->
+    Apps = application:which_applications(),
+    lists:keymember(App,1,Apps).
+
+is_crypto_running() ->
+    is_app_running(crypto).
+
+is_mnesia_running() ->
+    is_app_running(mnesia).
+
+is_snmp_running() ->
+    is_app_running(snmp).
+
+crypto_start() ->
+    case (catch crypto:start()) of
+        ok ->
+            ok;
+        {error, {already_started,crypto}} ->
+            ok;
+	{'EXIT', Reason} ->
+	    {error, {exit, Reason}};
+        Else ->
+            Else
+    end.
+ 
+crypto_support() ->
+    crypto_support([md5_mac_96, sha_mac_96], []).
+ 
+crypto_support([], []) ->
+    yes;
+crypto_support([], Acc) ->
+    {no, Acc};
+crypto_support([Func|Funcs], Acc) ->
+    case is_crypto_supported(Func) of
+        true ->
+            crypto_support(Funcs, Acc);
+        false ->
+            crypto_support(Funcs, [Func|Acc])
+    end.
+ 
+is_crypto_supported(Func) ->
+    %% The 'catch' handles the case when 'crypto' is
+    %% not present in the system (or not started).
+    case (catch lists:member(Func, crypto:info())) of
+        true -> true;
+        _ -> false
+    end.
+ 
+ 
+%% ----------------------------------------------------------------
+%% Watchdog functions
+%% 
+
+watchdog_start(Timeout) ->
+    watchdog_start(unknown, Timeout).
+
+watchdog_start(Case, Timeout) ->
+    spawn_link(?MODULE, watchdog, [Case, Timeout, self()]).
+
+watchdog_stop(Pid) ->
+    unlink(Pid),
+    exit(Pid, kill),
+    ok.
+
+watchdog(Case, Timeout0, Pid) ->
+    process_flag(priority, max),
+    Timeout = timeout(Timeout0),
+    receive
+    after Timeout ->
+	    Mon = erlang:monitor(process, Pid),
+	    case erlang:process_info(Pid) of
+		undefined ->
+		    ok;
+		ProcInfo ->
+		    Line = 
+			case lists:keysearch(dictionary, 1, ProcInfo) of
+			    {value, {_, Dict}} when is_list(Dict) ->
+				case lists:keysearch(test_server_loc, 1, Dict) of
+				    {value, {_, {_Mod, L}}} when is_integer(L) ->
+					L;
+				    _ ->
+					0
+				end;
+			    _ -> % This borders on paranoia, but...
+				0
+			end,
+		    Trap = {timetrap_timeout, Timeout, Line},
+		    exit(Pid, Trap),
+		    receive
+			{'DOWN', Mon, process, Pid, _} ->
+			    ok
+		    after 10000 ->
+			    warning_msg("Failed stopping "
+					"test case ~p process ~p "
+					"[~w] after ~w: killing instead", 
+				[Case, Pid, Line, Timeout]),
+			    exit(Pid, kill)
+		    end
+	    end
+    end.
+
+warning_msg(F, A) ->
+    (catch error_logger:warning_msg(F ++ "~n", A)).
+
+timeout(T) ->
+    trunc(timeout(T, os:type())).
+
+timeout(T, vxworks) ->
+    5 * T * timetrap_scale_factor();
+timeout(T, _) ->
+    T * timetrap_scale_factor().
+            
+timetrap_scale_factor() ->
+    case (catch test_server:timetrap_scale_factor()) of
+	{'EXIT', _} ->
+	    1;
+	N ->
+	    N
+    end.
+
+    
+%% ----------------------------------------------------------------------
+%% file & dir functions
+%%
+
+del_dir(Dir) when is_list(Dir) ->
+    (catch do_del_dir(Dir)).
+
+do_del_dir(Dir) ->
+    io:format("delete directory ~s~n", [Dir]),
+    case file:list_dir(Dir) of
+	{ok, Files} -> 
+	    Files2 = [filename:join(Dir, File) || File <- Files],
+	    del_dir2(Files2),
+	    case file:del_dir(Dir) of
+		ok ->
+		    io:format("directory ~s deleted~n", [Dir]),
+		    ok;
+		{error, eexist} = Error1 ->
+		    io:format("directory not empty: ~n", []),
+		    {ok, Files3} = file:list_dir(Dir),
+		    io:format("found additional files: ~n~p~n", 
+			      [Files3]),
+		    throw(Error1);
+		{error, Reason2} = Error2 ->
+		    io:format("failed deleting directory: ~w~n", [Reason2]),
+		    throw(Error2)
+	    end;
+	Else ->
+	    Else
+    end.
+    
+del_dir2([]) ->
+    ok;
+del_dir2([File|Files]) ->
+    del_file_or_dir(File),
+    del_dir2(Files).
+
+del_file_or_dir(FileOrDir) ->
+    case file:read_file_info(FileOrDir) of
+	{ok, #file_info{type = directory}} ->
+	    do_del_dir(FileOrDir);
+	{ok, _} ->
+	    io:format("   delete file ~s~n", [FileOrDir]),
+	    case file:delete(FileOrDir) of
+		ok ->
+		    io:format("   => deleted~n", []),
+		    ok;
+		{error, Reason} = Error ->
+		    io:format("   => failed - ~w~n", [Reason]),
+		    throw(Error)
+	    end;
+		
+	_ ->
+	    ok
+    end.
+	    
+
+%% ----------------------------------------------------------------------
+%% cover functions
+%%
+
+cover([Suite, Case] = Args) when is_atom(Suite) andalso is_atom(Case) ->
+    Mods0 = cover:compile_directory("../src"),
+    Mods1 = [Mod || {ok, Mod} <- Mods0],
+    snmp_test_server:t(Args),
+    Files0 = [cover:analyse_to_file(Mod) || Mod <- Mods1],
+    [io:format("Cover output: ~s~n", [File]) || {ok, File} <- Files0],
+    ok.
+
+
+%% ----------------------------------------------------------------------
+%% (debug) Print functions
+%%
+
+p(Mod, Case) when is_atom(Mod) andalso is_atom(Case) ->
+    case get(test_case) of
+	undefined ->
+	    put(test_case, Case),
+	    p("~n~n************ ~w:~w ************", [Mod, Case]);
+	_ ->
+	    ok
+    end;
+
+p(F, A) when is_list(F) andalso is_list(A) ->
+    io:format(user, F ++ "~n", A).
+
+print(Prefix, Module, Line, Format, Args) ->
+    io:format("*** [~s] ~s ~p ~p ~p:~p *** " ++ Format ++ "~n", 
+	      [format_timestamp(now()), 
+	       Prefix, node(), self(), Module, Line|Args]).
+
+format_timestamp({_N1, _N2, N3} = Now) ->
+    {Date, Time}   = calendar:now_to_datetime(Now),
+    {YYYY,MM,DD}   = Date,
+    {Hour,Min,Sec} = Time,
+    FormatDate =
+        io_lib:format("~.4w:~.2.0w:~.2.0w ~.2.0w:~.2.0w:~.2.0w 4~w",
+                      [YYYY,MM,DD,Hour,Min,Sec,round(N3/1000)]),
+    lists:flatten(FormatDate).
+