Merge branch 'siri/common_test/undefined-snmp-funcs/OTP-10088'

* siri/common_test/undefined-snmp-funcs/OTP-10088:
  [common_test] Moved ct_snmp_SUITE into data dir and run as other ct tests
  [common_test] Updated (minimized) config for ct_snmp test after fixing bugs
  [common_test] Use ct_snmp 'agent_vsns' config value in snmp app config
  [common_test] Change NotifType to atom instead of string
  [common_test] Remove calls to undefined functions from ct_snmp
  [common_test] Add minor test suite for ct_snmp

Conflicts:
	lib/common_test/test/Makefile

5 files changed, 351 insertions, 30 deletions

diff --git a/lib/common_test/src/ct_snmp.erl b/lib/common_test/src/ct_snmp.erl
index 8fe63e8ed1..02f849201d 100644
--- a/lib/common_test/src/ct_snmp.erl
+++ b/lib/common_test/src/ct_snmp.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2004-2010. All Rights Reserved.
+%% Copyright Ericsson AB 2004-2012. 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
@@ -250,10 +250,8 @@ stop(Config) ->
 %%%
 %%% @doc Issues a synchronous snmp get request. 
 get_values(Agent, Oids, MgrAgentConfName) ->
-    [Uid, AgentIp, AgentUdpPort | _] = 
-	agent_conf(Agent, MgrAgentConfName),
-    {ok, SnmpReply, _} =
-	snmpm:g(Uid, AgentIp, AgentUdpPort, Oids),
+    [Uid | _] = agent_conf(Agent, MgrAgentConfName),
+    {ok, SnmpReply, _} = snmpm:sync_get2(Uid, target_name(Agent), Oids),
     SnmpReply.
 
 %%% @spec get_next_values(Agent, Oids, MgrAgentConfName) -> SnmpReply 
@@ -265,10 +263,8 @@ get_values(Agent, Oids, MgrAgentConfName) ->
 %%%
 %%% @doc Issues a synchronous snmp get next request. 
 get_next_values(Agent, Oids, MgrAgentConfName) ->
-    [Uid, AgentIp, AgentUdpPort | _] = 
-	agent_conf(Agent, MgrAgentConfName),
-    {ok, SnmpReply, _} =
-	snmpm:gn(Uid, AgentIp, AgentUdpPort, Oids),
+    [Uid | _] = agent_conf(Agent, MgrAgentConfName),
+    {ok, SnmpReply, _} = snmpm:sync_get_next2(Uid, target_name(Agent), Oids),
     SnmpReply.
 
 %%% @spec set_values(Agent, VarsAndVals, MgrAgentConfName, Config) -> SnmpReply
@@ -282,13 +278,11 @@ get_next_values(Agent, Oids, MgrAgentConfName) ->
 %%% @doc Issues a synchronous snmp set request. 
 set_values(Agent, VarsAndVals, MgrAgentConfName, Config) ->
     PrivDir = ?config(priv_dir, Config),
-    [Uid, AgentIp, AgentUdpPort | _] = 
-	agent_conf(Agent, MgrAgentConfName),
+    [Uid | _] = agent_conf(Agent, MgrAgentConfName),
     Oids = lists:map(fun({Oid, _, _}) -> Oid end, VarsAndVals),
-    {ok, SnmpGetReply, _} =
-	snmpm:g(Uid, AgentIp, AgentUdpPort, Oids),
-    {ok, SnmpSetReply, _} =
-	snmpm:s(Uid, AgentIp, AgentUdpPort, VarsAndVals),
+    TargetName = target_name(Agent),
+    {ok, SnmpGetReply, _} = snmpm:sync_get2(Uid, TargetName, Oids),
+    {ok, SnmpSetReply, _} = snmpm:sync_set2(Uid, TargetName, VarsAndVals),
     case SnmpSetReply of
 	{noError, 0, _} when PrivDir /= false ->
 	    log(PrivDir, Agent, SnmpGetReply, VarsAndVals);
@@ -348,7 +342,7 @@ register_agents(MgrAgentConfName, ManagedAgents) ->
     NewSnmpVals = lists:keyreplace(managed_agents, 1, SnmpVals,
 				   {managed_agents, ManagedAgents}),
     ct_config:update_config(MgrAgentConfName, {snmp, NewSnmpVals}),
-    setup_managed_agents(ManagedAgents).
+    setup_managed_agents(MgrAgentConfName,ManagedAgents).
 
 %%% @spec register_usm_users(MgrAgentConfName, UsmUsers) ->  ok | {error, Reason}
 %%%
@@ -486,9 +480,8 @@ setup_agent(true, AgentConfName, SnmpConfName,
     file:make_dir(DbDir),    
     snmp_config:write_agent_snmp_files(ConfDir, Vsns, ManagerIP, TrapUdp, 
 				       AgentIP, AgentUdp, SysName, 
-				       atom_to_list(NotifType), 
-				       SecType, Passwd, AgentEngineID, 
-				       AgentMaxMsgSize),
+				       NotifType, SecType, Passwd,
+				       AgentEngineID, AgentMaxMsgSize),
 
     override_default_configuration(Config, AgentConfName),
     
@@ -497,7 +490,8 @@ setup_agent(true, AgentConfName, SnmpConfName,
 					 {verbosity, trace}]},
 			       {agent_type, master},
 			       {agent_verbosity, trace},
-			       {net_if, [{verbosity, trace}]}],
+			       {net_if, [{verbosity, trace}]},
+			       {versions, Vsns}],
 			      ct:get_config({SnmpConfName,agent})),
     application:set_env(snmp, agent, SnmpEnv).
 %%%---------------------------------------------------------------------------
@@ -535,7 +529,7 @@ manager_register(true, MgrAgentConfName) ->
 
     setup_usm_users(UsmUsers, EngineID),
     setup_users(Users),
-    setup_managed_agents(Agents).
+    setup_managed_agents(MgrAgentConfName,Agents).
 
 %%%---------------------------------------------------------------------------
 setup_users(Users) ->
@@ -543,10 +537,11 @@ setup_users(Users) ->
 			  snmpm:register_user(Id, Module, Data)
 		  end, Users).
 %%%---------------------------------------------------------------------------   
-setup_managed_agents([]) ->
+setup_managed_agents(_,[]) ->
     ok;
 
-setup_managed_agents([{_, [Uid, AgentIp, AgentUdpPort, AgentConf]} |
+setup_managed_agents(AgentConfName,
+		     [{AgentName, [Uid, AgentIp, AgentUdpPort, AgentConf0]} |
 		      Rest]) ->
     NewAgentIp = case AgentIp of
 		     IpTuple when is_tuple(IpTuple) ->
@@ -556,12 +551,19 @@ setup_managed_agents([{_, [Uid, AgentIp, AgentUdpPort, AgentConf]} |
 			 [IpTuple|_] = Hostent#hostent.h_addr_list,
 			 IpTuple
 		 end,
-    ok = snmpm:register_agent(Uid, NewAgentIp, AgentUdpPort),   
-    lists:foreach(fun({Item, Val}) ->
-			  snmpm:update_agent_info(Uid, NewAgentIp, 
-						  AgentUdpPort, Item, Val)
-		  end, AgentConf),
-    setup_managed_agents(Rest).
+    AgentConf =
+	case lists:keymember(engine_id,1,AgentConf0) of
+	    true ->
+		AgentConf0;
+	    false ->
+		DefaultEngineID = ct:get_config({AgentConfName,agent_engine_id},
+						?AGENT_ENGINE_ID),
+		[{engine_id,DefaultEngineID}|AgentConf0]
+	end,
+    ok = snmpm:register_agent(Uid, target_name(AgentName),
+			      [{address,NewAgentIp},{port,AgentUdpPort} |
+			       AgentConf]),
+    setup_managed_agents(AgentConfName,Rest).
 %%%---------------------------------------------------------------------------
 setup_usm_users(UsmUsers, EngineID)->
     lists:foreach(fun({UsmUser, Conf}) ->
@@ -769,3 +771,8 @@ override_vacm(Config, VacmConf) ->
        File = filename:join(Dir,"vacm.conf"),
     file:delete(File),
     snmp_config:write_agent_vacm_config(Dir, "", VacmConf).
+
+%%%---------------------------------------------------------------------------
+
+target_name(Agent) ->
+    atom_to_list(Agent).
diff --git a/lib/common_test/test/Makefile b/lib/common_test/test/Makefile
index 3526ef4421..7691920993 100644
--- a/lib/common_test/test/Makefile
+++ b/lib/common_test/test/Makefile
@@ -52,7 +52,8 @@ MODULES= \
 	ct_auto_compile_SUITE \
 	ct_verbosity_SUITE \
 	ct_shell_SUITE \
-	ct_system_error_SUITE
+	ct_system_error_SUITE \
+	ct_snmp_SUITE
 
 ERL_FILES= $(MODULES:%=%.erl)
 
diff --git a/lib/common_test/test/ct_snmp_SUITE.erl b/lib/common_test/test/ct_snmp_SUITE.erl
new file mode 100644
index 0000000000..848752b816
--- /dev/null
+++ b/lib/common_test/test/ct_snmp_SUITE.erl
@@ -0,0 +1,141 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2012. 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%
+%%
+
+%%%-------------------------------------------------------------------
+%%% File: ct_snmp_SUITE
+%%%
+%%% Description:
+%%% Test ct_snmp module
+%%%
+%%%-------------------------------------------------------------------
+-module(ct_snmp_SUITE).
+
+-compile(export_all).
+
+-include_lib("common_test/include/ct.hrl").
+-include_lib("common_test/include/ct_event.hrl").
+
+-define(eh, ct_test_support_eh).
+
+%%--------------------------------------------------------------------
+%% TEST SERVER CALLBACK FUNCTIONS
+%%--------------------------------------------------------------------
+
+%%--------------------------------------------------------------------
+%% Description: Since Common Test starts another Test Server
+%% instance, the tests need to be performed on a separate node (or
+%% there will be clashes with logging processes etc).
+%%--------------------------------------------------------------------
+init_per_suite(Config) ->
+    Config1 = ct_test_support:init_per_suite(Config),
+    Config1.
+
+end_per_suite(Config) ->
+    ct_test_support:end_per_suite(Config).
+
+init_per_testcase(TestCase, Config) ->
+    ct_test_support:init_per_testcase(TestCase, Config).
+
+end_per_testcase(TestCase, Config) ->
+    ct_test_support:end_per_testcase(TestCase, Config).
+
+suite() -> [{ct_hooks,[ts_install_cth]}].
+
+all() ->
+    [
+     default
+    ].
+
+%%--------------------------------------------------------------------
+%% TEST CASES
+%%--------------------------------------------------------------------
+
+%%%-----------------------------------------------------------------
+%%%
+default(Config) when is_list(Config) ->
+    DataDir = ?config(data_dir, Config),
+    Suite = filename:join(DataDir, "snmp1_SUITE"),
+    CfgFile = filename:join(DataDir, "snmp.cfg"),
+    {Opts,ERPid} = setup([{suite,Suite},{config,CfgFile},
+			  {label,default}], Config),
+
+    ok = execute(default, Opts, ERPid, Config).
+
+
+%%%-----------------------------------------------------------------
+%%% HELP FUNCTIONS
+%%%-----------------------------------------------------------------
+
+setup(Test, Config) ->
+    Opts0 = ct_test_support:get_opts(Config),
+    Level = ?config(trace_level, Config),
+    EvHArgs = [{cbm,ct_test_support},{trace_level,Level}],
+    Opts = Opts0 ++ [{event_handler,{?eh,EvHArgs}}|Test],
+    ERPid = ct_test_support:start_event_receiver(Config),
+    {Opts,ERPid}.
+
+execute(Name, Opts, ERPid, Config) ->
+    ok = ct_test_support:run(Opts, Config),
+    Events = ct_test_support:get_events(ERPid, Config),
+
+    ct_test_support:log_events(Name,
+			       reformat(Events, ?eh),
+			       ?config(priv_dir, Config),
+			       Opts),
+
+    TestEvents = events_to_check(Name,Config),
+    ct_test_support:verify_events(TestEvents, Events, Config).
+
+reformat(Events, EH) ->
+    ct_test_support:reformat(Events, EH).
+
+%%%-----------------------------------------------------------------
+%%% TEST EVENTS
+%%%-----------------------------------------------------------------
+events_to_check(_TestName,Config) ->
+    {module,_} = code:load_abs(filename:join(?config(data_dir,Config),
+					     snmp1_SUITE)),
+    TCs = get_tcs(),
+    code:purge(snmp1_SUITE),
+    code:delete(snmp1_SUITE),
+
+    OneTest =
+	[{?eh,start_logging,{'DEF','RUNDIR'}}] ++
+	[{?eh,tc_done,{snmp1_SUITE,TC,ok}} || TC <- TCs] ++
+	[{?eh,stop_logging,[]}],
+
+    %% 2 tests (ct:run_test + script_start) is default
+    OneTest ++ OneTest.
+
+
+get_tcs() ->
+    All = snmp1_SUITE:all(),
+    Groups =
+	try snmp1_SUITE:groups()
+	catch error:undef -> []
+	end,
+    flatten_tcs(All,Groups).
+
+flatten_tcs([H|T],Groups) when is_atom(H) ->
+    [H|flatten_tcs(T,Groups)];
+flatten_tcs([{group,Group}|T],Groups) ->
+    TCs = proplists:get_value(Group,Groups),
+    flatten_tcs(TCs ++ T,Groups);
+flatten_tcs([],_) ->
+    [].
diff --git a/lib/common_test/test/ct_snmp_SUITE_data/snmp.cfg b/lib/common_test/test/ct_snmp_SUITE_data/snmp.cfg
new file mode 100644
index 0000000000..b0ac0e6a96
--- /dev/null
+++ b/lib/common_test/test/ct_snmp_SUITE_data/snmp.cfg
@@ -0,0 +1,20 @@
+%% -*- erlang -*-
+{snmp, [{start_agent,true},
+	{users,[{user_name,[snmp1_SUITE,[]]}]},
+	{managed_agents,[{agent_name, [user_name, {127,0,0,1}, 4000,
+				       [{engine_id,"ct_snmp-test-engine"},
+					{version,v2}]]}]},
+	{engine_id,"ct_snmp-test-engine"},
+	{agent_vsns,[v2]}
+       ]}.
+{snmp_app,[{manager, [{config, [{verbosity, silence}]},
+		      {server,[{verbosity,silence}]},
+		      {net_if,[{verbosity,silence}]},
+		      {versions,[v2]}
+		     ]},
+	   {agent, [{config, [{verbosity, silence}]},
+		    {net_if,[{verbosity,silence}]},
+		    {mib_server,[{verbosity,silence}]},
+		    {local_db,[{verbosity,silence}]},
+		    {agent_verbosity,silence}
+		   ]}]}.
diff --git a/lib/common_test/test/ct_snmp_SUITE_data/snmp1_SUITE.erl b/lib/common_test/test/ct_snmp_SUITE_data/snmp1_SUITE.erl
new file mode 100644
index 0000000000..dcc5c5378b
--- /dev/null
+++ b/lib/common_test/test/ct_snmp_SUITE_data/snmp1_SUITE.erl
@@ -0,0 +1,152 @@
+%%--------------------------------------------------------------------
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2012. 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%
+%%
+%%----------------------------------------------------------------------
+%% File: ct_snmp_SUITE.erl
+%%
+%% Description:
+%%    This file contains the test cases for the ct_snmp API.
+%%
+%% @author Support
+%% @doc Test  of SNMP support in common_test
+%% @end
+%%----------------------------------------------------------------------
+%%----------------------------------------------------------------------
+-module(snmp1_SUITE).
+-include_lib("common_test/include/ct.hrl").
+-include_lib("snmp/include/STANDARD-MIB.hrl").
+-include_lib("snmp/include/snmp_types.hrl").
+
+-compile(export_all).
+
+%% Default timetrap timeout (set in init_per_testcase).
+-define(default_timeout, ?t:minutes(1)).
+
+%% SNMP user stuff
+-behaviour(snmpm_user).
+-export([handle_error/3,
+	 handle_agent/5,
+	 handle_pdu/4,
+	 handle_trap/3,
+	 handle_inform/3,
+	 handle_report/3]).
+
+
+suite() ->
+    [{require, snmp_mgr_agent, snmp},
+     {require, snmp_app_cfg, snmp_app}].
+
+all() ->
+    [start_stop,
+    {group,get_set}].
+
+
+groups() ->
+    [{get_set,[get_values,get_next_values,set_values]}].
+
+init_per_group(get_set, Config) ->
+    ok = ct_snmp:start(Config,snmp_mgr_agent,snmp_app_cfg),
+    Config.
+
+end_per_group(get_set, Config) ->
+    ok = ct_snmp:stop(Config),
+    Config.
+
+init_per_testcase(_Case, Config) ->
+    Dog = test_server:timetrap(?default_timeout),
+    [{watchdog, Dog}|Config].
+
+end_per_testcase(_Case, Config) ->
+    Dog=?config(watchdog, Config),
+    test_server:timetrap_cancel(Dog),
+    ok.
+
+init_per_suite(Config) ->
+    Config.
+
+end_per_suite(Config) ->
+    Config.
+
+break(_Config) ->
+    test_server:break(""),
+    ok.
+
+start_stop(Config) ->
+    ok = ct_snmp:start(Config,snmp_mgr_agent,snmp_app_cfg),
+    timer:sleep(1000),
+    {snmp,_,_} = lists:keyfind(snmp,1,application:which_applications()),
+    [_|_] = filelib:wildcard("*/*.conf",?config(priv_dir,Config)),
+
+    ok = ct_snmp:stop(Config),
+    timer:sleep(1000),
+    false = lists:keyfind(snmp,1,application:which_applications()),
+    [] = filelib:wildcard("*/*.conf",?config(priv_dir,Config)),
+    ok.
+
+get_values(_Config) ->
+    Oids1 = [?sysDescr_instance, ?sysName_instance],
+    {noError,_,V1} = ct_snmp:get_values(agent_name,Oids1,snmp_mgr_agent),
+    [#varbind{oid=?sysDescr_instance,value="Erlang SNMP agent"},
+     #varbind{oid=?sysName_instance,value="ct_test"}] = V1,
+    ok.
+
+get_next_values(_Config) ->
+    Oids2 = [?system],
+    {noError,_,V2} = ct_snmp:get_next_values(agent_name,Oids2,snmp_mgr_agent),
+    [#varbind{oid=?sysDescr_instance,value="Erlang SNMP agent"}] = V2,
+    ok.
+
+set_values(Config) ->
+    Oid3 = ?sysName_instance,
+    NewName = "ct_test changed by " ++ atom_to_list(?MODULE),
+    VarsAndVals = [{Oid3,s,NewName}],
+    {noError,_,_} =
+	ct_snmp:set_values(agent_name,VarsAndVals,snmp_mgr_agent,Config),
+
+    Oids4 = [?sysName_instance],
+    {noError,_,V4} = ct_snmp:get_values(agent_name,Oids4,snmp_mgr_agent),
+    [#varbind{oid=?sysName_instance,value=NewName}] = V4,
+
+    ok.
+
+
+%%%-----------------------------------------------------------------
+%%% SNMP Manager User callback
+handle_error(ReqId, Reason, UserData) ->
+    erlang:display({handle_error,ReqId, Reason, UserData}),
+    ignore.
+
+handle_agent(Addr, Port, Type, SnmpInfo, UserData) ->
+    erlang:display({handle_agent,Addr, Port, Type, SnmpInfo, UserData}),
+    ignore.
+
+handle_pdu(TargetName, ReqId, SnmpPduInfo, UserData) ->
+    erlang:display({handle_pdu,TargetName, ReqId, SnmpPduInfo, UserData}),
+    ignore.
+
+handle_trap(TargetName, SnmpTrapInfo, UserData) ->
+    erlang:display({handle_trap,TargetName, SnmpTrapInfo, UserData}),
+    ignore.
+
+handle_inform(TargetName, SnmpInformInfo, UserData) ->
+    erlang:display({handle_inform,TargetName, SnmpInformInfo, UserData}),
+    ignore.
+
+handle_report(TargetName, SnmpReportInfo, UserData) ->
+    erlang:display({handle_report,TargetName, SnmpReportInfo, UserData}),
+    ignore.