[snmp/agent] Merging test case specific and common config env

There is a set of default agent config environment values used
when starting an agent. For specififc group of test cases, other
values is used. These two groups of environment is now merged
in a more controlled way.
Also test case grouping make use of more test cases functions
(in order to make the groups() function more readable).

2 files changed, 314 insertions, 135 deletions

diff --git a/lib/snmp/test/snmp_agent_test.erl b/lib/snmp/test/snmp_agent_test.erl
index 5216b82cf8..01f0e58bc2 100644
--- a/lib/snmp/test/snmp_agent_test.erl
+++ b/lib/snmp/test/snmp_agent_test.erl
@@ -94,19 +94,8 @@ all() ->
 
 groups() -> 
     [
-     {all_tcs, [], cases()},
-     {mib_storage, [],
-      [
-       {group, mib_storage_ets}, 
-       {group, mib_storage_dets},
-       {group, mib_storage_mnesia},
-       {group, mib_storage_size_check_ets},
-       {group, mib_storage_size_check_dets},
-       {group, mib_storage_size_check_mnesia},
-       {group, mib_storage_varm_dets},
-       {group, mib_storage_varm_mnesia}
-      ]
-     },
+     {all_tcs,                       [], cases()},
+     {mib_storage,                   [], mib_storage_cases()}, 
      {mib_storage_ets,               [], mib_storage_ets_cases()},
      {mib_storage_dets,              [], mib_storage_dets_cases()},
      {mib_storage_mnesia,            [], mib_storage_mnesia_cases()},
@@ -123,109 +112,18 @@ groups() ->
      {test_multi_threaded,           [], mt_cases()},
      {multiple_reqs,                 [], mul_cases()},
      {multiple_reqs_2,               [], mul_cases_2()},
-     {v2_inform, [], 
-      [
-       v2_inform_i
-      ]
-     },
-     {v3_security, [],
-      [
-       v3_crypto_basic, 
-       v3_md5_auth, 
-       v3_sha_auth,
-       v3_des_priv
-      ]
-     },
-     {standard_mibs, [],
-      [
-       snmp_standard_mib, 
-       snmp_community_mib,
-       snmp_framework_mib, 
-       snmp_target_mib,
-       snmp_notification_mib, 
-       snmp_view_based_acm_mib
-      ]
-     },
-     {standard_mibs_2, [],
-      [
-       snmpv2_mib_2, 
-       snmp_community_mib_2,
-       snmp_framework_mib_2, 
-       snmp_target_mib_2,
-       snmp_notification_mib_2, 
-       snmp_view_based_acm_mib_2
-      ]
-     },
-     {standard_mibs_3, [],
-      [
-       snmpv2_mib_3, 
-       snmp_framework_mib_3, 
-       snmp_mpd_mib_3,
-       snmp_target_mib_3, 
-       snmp_notification_mib_3,
-       snmp_view_based_acm_mib_3, 
-       snmp_user_based_sm_mib_3
-      ]
-     },
-     {reported_bugs, [],
-      [
-       otp_1128, 
-       otp_1129, 
-       otp_1131, 
-       otp_1162, 
-       otp_1222,
-       otp_1298, 
-       otp_1331, 
-       otp_1338, 
-       otp_1342, 
-       otp_2776,
-       otp_2979, 
-       otp_3187, 
-       otp_3725
-      ]
-     },
-     {reported_bugs_2, [],
-      [
-       otp_1128_2, 
-       otp_1129_2, 
-       otp_1131_2, 
-       otp_1162_2,
-       otp_1222_2, 
-       otp_1298_2, 
-       otp_1331_2, 
-       otp_1338_2,
-       otp_1342_2, 
-       otp_2776_2, 
-       otp_2979_2, 
-       otp_3187_2
-      ]
-     },
-     {reported_bugs_3, [],
-      [
-       otp_1128_3, 
-       otp_1129_3, 
-       otp_1131_3, 
-       otp_1162_3,
-       otp_1222_3, 
-       otp_1298_3, 
-       otp_1331_3, 
-       otp_1338_3,
-       otp_1342_3, 
-       otp_2776_3, 
-       otp_2979_3, 
-       otp_3187_3,
-       otp_3542
-      ]
-     },
-     {tickets1, [], 
-      [
-       {group, otp_4394}, 
-       {group, otp_7157}
-      ]
-     },
-     {tickets2, [], [otp8395, otp9884]},
-     {otp_4394, [], [otp_4394_test]},
-     {otp_7157, [], [otp_7157_test]}
+     {v2_inform,                     [], v2_inform_cases()}, 
+     {v3_security,                   [], v3_security_cases()}, 
+     {standard_mibs,                 [], standard_mibs_cases()}, 
+     {standard_mibs_2,               [], standard_mibs2_cases()}, 
+     {standard_mibs_3,               [], standard_mibs3_cases()}, 
+     {reported_bugs,                 [], reported_bugs_cases()}, 
+     {reported_bugs_2,               [], reported_bugs2_cases()}, 
+     {reported_bugs_3,               [], reported_bugs3_cases()}, 
+     {tickets1,                      [], tickets1_cases()}, 
+     {tickets2,                      [], tickets2_cases()}, 
+     {otp_4394,                      [], [otp_4394_test]},
+     {otp_7157,                      [], [otp_7157_test]}
     ].
 
 
@@ -572,6 +470,18 @@ delete_mib_storage_mnesia_tables() ->
 %% versions as well, <base>_N.
 %%-----------------------------------------------------------------
 
+mib_storage_cases() ->
+    [
+     {group, mib_storage_ets}, 
+     {group, mib_storage_dets},
+     {group, mib_storage_mnesia},
+     {group, mib_storage_size_check_ets},
+     {group, mib_storage_size_check_dets},
+     {group, mib_storage_size_check_mnesia},
+     {group, mib_storage_varm_dets},
+     {group, mib_storage_varm_mnesia}
+    ].
+    
 mib_storage_ets_cases() -> 
     [
      mse_simple, 
@@ -2144,6 +2054,10 @@ finish_v3_inform(X) ->
     finish_v2_inform(X).
 
 
+v2_inform_cases() ->
+    [
+     v2_inform_i
+    ].
 
 v2_inform_i(suite) -> [];
 v2_inform_i(Config) when is_list(Config) ->
@@ -2382,6 +2296,15 @@ v3_processing(Config) when is_list(Config) ->
 %% report, which makes it in sync.  The notification-generating
 %% application times out, and send again.  This time it'll work.
 
+v3_security_cases() ->
+    [
+     v3_crypto_basic, 
+     v3_md5_auth, 
+     v3_sha_auth,
+     v3_des_priv
+    ].
+
+
 v3_crypto_basic(suite) -> [];
 v3_crypto_basic(_Config) ->
     ?P(v3_crypto_basic), 
@@ -4262,7 +4185,16 @@ bad_return() ->
 %%% already tested by the normal tests.
 %%%-----------------------------------------------------------------
 
-
+standard_mibs_cases() ->
+    [
+     snmp_standard_mib, 
+     snmp_community_mib,
+     snmp_framework_mib, 
+     snmp_target_mib,
+     snmp_notification_mib, 
+     snmp_view_based_acm_mib
+    ].
+    
 
 %%-----------------------------------------------------------------
 %% For this test, the agent is configured for v1.
@@ -4346,6 +4278,18 @@ std_mib_write() ->
 std_mib_asn_err() ->
     snmp_test_mgr:send_bytes([48,99,67,12,0,0,0,0,0,0,5]).
 
+
+standard_mibs2_cases() ->
+    [
+     snmpv2_mib_2, 
+     snmp_community_mib_2,
+     snmp_framework_mib_2, 
+     snmp_target_mib_2,
+     snmp_notification_mib_2, 
+     snmp_view_based_acm_mib_2
+    ].
+    
+
 %%-----------------------------------------------------------------
 %% For this test, the agent is configured for v2 and v3.
 %% o  Test the counters and control objects in SNMPv2-MIB
@@ -4394,6 +4338,19 @@ snmpv2_mib_2(Config) when is_list(Config) ->
     
     ?LOG("snmpv2_mib_2 -> done",[]).
     
+
+standard_mibs3_cases() ->
+    [
+     snmpv2_mib_3, 
+     snmp_framework_mib_3, 
+     snmp_mpd_mib_3,
+     snmp_target_mib_3, 
+     snmp_notification_mib_3,
+     snmp_view_based_acm_mib_3, 
+     snmp_user_based_sm_mib_3
+    ].
+
+    
 %% Req. SNMPv2-MIB
 snmpv2_mib_3(suite) -> [];
 snmpv2_mib_3(Config) when is_list(Config) ->
@@ -5306,7 +5263,57 @@ loop_it_2(Oid, N) ->
 %%% Testing of reported bugs and other tickets.
 %%%-----------------------------------------------------------------
 
+reported_bugs_cases() ->
+    [
+     otp_1128, 
+     otp_1129, 
+     otp_1131, 
+     otp_1162, 
+     otp_1222,
+     otp_1298, 
+     otp_1331, 
+     otp_1338, 
+     otp_1342, 
+     otp_2776,
+     otp_2979, 
+     otp_3187, 
+     otp_3725
+    ].
+
+reported_bugs2_cases() ->
+    [
+     otp_1128_2, 
+     otp_1129_2, 
+     otp_1131_2, 
+     otp_1162_2,
+     otp_1222_2, 
+     otp_1298_2, 
+     otp_1331_2, 
+     otp_1338_2,
+     otp_1342_2, 
+     otp_2776_2, 
+     otp_2979_2, 
+     otp_3187_2
+    ].
 
+reported_bugs3_cases() ->
+    [
+     otp_1128_3, 
+     otp_1129_3, 
+     otp_1131_3, 
+     otp_1162_3,
+     otp_1222_3, 
+     otp_1298_3, 
+     otp_1331_3, 
+     otp_1338_3,
+     otp_1342_3, 
+     otp_2776_3, 
+     otp_2979_3, 
+     otp_3187_3,
+     otp_3542
+    ].
+   
+    
 %%-----------------------------------------------------------------
 %% Ticket: OTP-1128
 %% Slogan: Bug in handling of createAndWait set-requests.
@@ -5783,7 +5790,12 @@ otp_3725_test(MaNode) ->
 %% Slogan: Target mib tag list check invalid
 %%-----------------------------------------------------------------
 
-
+tickets1_cases() ->
+    [
+     {group, otp_4394}, 
+     {group, otp_7157}
+    ].
+    
 
 init_otp_4394(Config) when is_list(Config) ->
     ?DBG("init_otp_4394 -> entry with"
@@ -5945,6 +5957,13 @@ otp_7157_test1(MA) ->
 %% These cases are started in the new way
 %%-----------------------------------------------------------------
 
+tickets2_cases() ->
+    [
+     otp8395, 
+     otp9884
+    ].
+
+
 otp8395({init, Config}) when is_list(Config) ->
     ?DBG("otp8395(init) -> entry with"
 	 "~n   Config: ~p", [Config]),
diff --git a/lib/snmp/test/snmp_agent_test_lib.erl b/lib/snmp/test/snmp_agent_test_lib.erl
index 5261a9c40e..2c24dd3712 100644
--- a/lib/snmp/test/snmp_agent_test_lib.erl
+++ b/lib/snmp/test/snmp_agent_test_lib.erl
@@ -441,13 +441,13 @@ start_agent(Config, Vsns, Opts) ->
 	    [{versions,         Vsns}, 
 	     {agent_type,       master},
 	     {agent_verbosity,  trace},
+	     {db_dir,           AgentDbDir},
 	     {audit_trail_log,  [{type, read_write},
 				 {dir,  AgentLogDir},
 				 {size, {10240, 10}}]},
 	     {config,           [{dir, AgentConfDir},
 				 {force_load, false}, 
 				 {verbosity,  trace}]}, 
-	     {db_dir,           AgentDbDir},
 	     {local_db,         [{repair,    true},
 				 {verbosity, log}]}, 
 	     {mib_server,       [{verbosity, log}]},
@@ -478,30 +478,190 @@ start_agent(Config, Vsns, Opts) ->
 app_agent_env_init(Env0, Opts) ->
     ?DBG("app_agent_env_init -> unload snmp",[]),
     ?line application:unload(snmp),
+
     ?DBG("app_agent_env_init -> load snmp",[]),
     ?line application:load(snmp),
-    ?DBG("app_agent_env_init -> initiate (snmp agent) application env",[]),
-    F1 = fun({Key, Val} = New, Acc0) -> 
-                 ?DBG("app_agent_env_init -> "
-		      "updating setting ~p to ~p", [Key, Val]),
-                 case lists:keyreplace(Key, 1, Acc0, New) of
-		     Acc0 ->
-			 [New|Acc0];
-		     Acc ->
-			 Acc
-		 end
-         end, 
-    Env = lists:foldr(F1, Env0, Opts),
-    ?DBG("app_agent_env_init -> Env: ~p", [Env]),
+
+    ?DBG("app_agent_env_init -> "
+	 "merge or maybe replace (snmp agent) app env",[]),
+    Env = add_or_maybe_merge_agent_env(Opts, Env0),
+    ?DBG("app_agent_env_init -> merged env: "
+	 "~n   ~p", [Env]),
+
     %% We put it into the app environment just as 
     %% a precaution, since when starting normally, 
-    %% there is where the environment is taken from.
-    app_set_agent_env(Env),
+    %% this is where the environment is extracted from.
+    app_agent_set_env(Env),
     Env.
 
-app_set_agent_env(Value) ->
+app_agent_set_env(Value) ->
     application_controller:set_env(snmp, agent, Value).
 
+add_or_maybe_merge_agent_env([], Env) ->
+    ?DBG("merging agent env -> merged", []),
+    lists:keysort(1, Env);
+add_or_maybe_merge_agent_env([{Key, Value1}|Opts], Env) ->
+    ?DBG("merging agent env -> add, replace or merge ~p", [Key]),
+    case lists:keysearch(Key, 1, Env) of
+	{value, {Key, Value1}} ->
+	    %% Identical, move on
+	    ?DBG("merging agent env -> "
+		 "no need to merge ~p - identical - keep: "
+		 "~n   ~p", [Key, Value1]),
+	    add_or_maybe_merge_agent_env(Opts, Env);
+	{value, {Key, Value2}} ->
+	    %% Another value, merge or replace
+	    NewValue = merge_or_replace_agent_env(Key, Value1, Value2),
+	    Env2 = lists:keyreplace(Key, 1, Env, {Key, NewValue}), 
+	    add_or_maybe_merge_agent_env(Opts, Env2);
+	false ->
+	    ?DBG("merging agent env -> no old ~p to merge with - add: "
+		 "~n   ~p", [Key, Value1]),
+	    add_or_maybe_merge_agent_env(Opts, [{Key, Value1}|Env])
+    end.
+
+merge_or_replace_agent_env(versions, NewVersions, _OldVersions) ->
+    ?DBG("merging agent env -> versions replaced: ~p -> ~p", 
+	 [NewVersions, _OldVersions]),
+    NewVersions;
+merge_or_replace_agent_env(agent_type, NewType, _OldType) ->
+    ?DBG("merging agent env -> agent type replaced: ~p -> ~p", 
+	 [NewType, _OldType]),
+    NewType;
+merge_or_replace_agent_env(agent_verbosity, NewVerbosity, _OldVerbosity) ->
+    ?DBG("merging agent env -> agent verbosity replaced: ~p -> ~p", 
+	 [NewVerbosity, _OldVerbosity]),
+    NewVerbosity;
+merge_or_replace_agent_env(db_dir, NewDbDir, _OldDbDir) ->
+    ?DBG("merging agent env -> db-dir replaced: ~p -> ~p", 
+	 [NewDbDir, _OldDbDir]),
+    NewDbDir;
+merge_or_replace_agent_env(audit_trail_log, NewATL, OldATL) ->
+    merge_or_replace_agent_env_atl(NewATL, OldATL);
+merge_or_replace_agent_env(config, NewConfig, OldConfig) ->
+    merge_or_replace_agent_env_config(NewConfig, OldConfig);
+merge_or_replace_agent_env(local_db, NewLdb, OldLdb) ->
+    merge_or_replace_agent_env_ldb(NewLdb, OldLdb);
+merge_or_replace_agent_env(mib_storage, NewMst, OldMst) ->
+    merge_or_replace_agent_env_mib_storage(NewMst, OldMst);
+merge_or_replace_agent_env(mib_server, NewMibs, OldMibs) ->
+    merge_or_replace_agent_env_mib_server(NewMibs, OldMibs);
+merge_or_replace_agent_env(symbolic_store, NewSymStore, OldSymStore) ->
+    merge_or_replace_agent_env_symbolic_store(NewSymStore, OldSymStore);
+merge_or_replace_agent_env(note_store, NewNoteStore, OldNoteStore) ->
+    merge_or_replace_agent_env_note_store(NewNoteStore, OldNoteStore);
+merge_or_replace_agent_env(net_if, NewNetIf, OldNetIf) ->
+    merge_or_replace_agent_env_net_if(NewNetIf, OldNetIf);
+merge_or_replace_agent_env(Key, NewValue, OldValue) ->
+    ?FAIL({not_implemented_merge_or_replace, 
+	   Key, NewValue, OldValue}).
+
+merge_or_replace_agent_env_atl(New, Old) ->
+    ATL = merge_agent_options(New, Old),
+    ?DBG("merging agent env -> audit-trail-log merged: "
+	 "~n   ~p | ~p -> ~p", [New, Old, ATL]),
+    ATL.
+
+merge_or_replace_agent_env_config(New, Old) ->
+    Config = merge_agent_options(New, Old),
+    case lists:keymember(dir, 1, Config) of
+	true ->
+	    ?DBG("merging agent env -> config merged: "
+		 "~n   ~p | ~p -> ~p", [New, Old, Config]),
+	    Config;
+	false ->
+	    ?FAIL({missing_mandatory_option, {config, dir}})
+    end.
+
+merge_or_replace_agent_env_ldb(New, Old) ->
+    LDB = merge_agent_options(New, Old),
+    ?DBG("merging agent env -> local-db merged: "
+	 "~n   ~p | ~p -> ~p", [New, Old, LDB]),
+    LDB.
+
+merge_or_replace_agent_env_mib_storage(NewMibStorage, OldMibStorage) ->
+    %% Shall we merge or replace?
+    %% module is mandatory. We will only merge if NewModule is
+    %% equal to OldModule. 
+    NewModule = 
+	case lists:keysearch(module, 1, NewMibStorage) of
+	    {value, {module, M}} ->
+		M;
+	    false ->
+		?FAIL({missing_mandatory_option, {mib_storage, module}})
+	end,
+    case lists:keysearch(module, 1, OldMibStorage) of
+	{value, {module, NewModule}} ->
+	    %% Same module => merge
+	    %% Non-ex new options => remove
+	    %% Ex new options and non-ex old options => replace
+	    %% Otherwise merge
+	    case lists:keysearch(options, 1, NewMibStorage) of
+		false ->
+		    ?DBG("merging agent env -> "
+			 "no mib-storage ~p merge needed - "
+			 "no new options (= remove old options)", [NewModule]),
+		    NewMibStorage;
+		{value, {options, NewOptions}} ->
+		    case lists:keysearch(options, 1, OldMibStorage) of
+			false ->
+			    ?DBG("merging agent env -> "
+				 "no mib-storage ~p merge needed - "
+				 "no old options", [NewModule]),
+			    NewMibStorage;
+			{value, {options, OldOptions}} ->
+			    MergedOptions = 
+				merge_agent_options(NewOptions, OldOptions), 
+			    ?DBG("merging agent env -> mib-storage ~p merged: "
+				 "~n   Options: ~p | ~p -> ~p", 
+				 [NewModule, 
+				  NewOptions, OldOptions, MergedOptions]),
+			    [{module,  NewModule}, 
+			     {options, MergedOptions}]
+		    end
+	    end;
+	_ ->
+	    %% Diff module => replace
+	    ?DBG("merging agent env -> "
+		 "no mib-storage ~p merge needed - "
+		 "new module", [NewModule]),
+	    NewMibStorage
+    end.
+
+merge_or_replace_agent_env_mib_server(New, Old) ->
+    MibServer = merge_agent_options(New, Old),
+    ?DBG("merging agent env -> mib-server merged: "
+	 "~n   ~p | ~p -> ~p", [New, Old, MibServer]),
+    MibServer.
+
+merge_or_replace_agent_env_symbolic_store(New, Old) ->
+    SymbolicStore = merge_agent_options(New, Old),
+    ?DBG("merging agent env -> symbolic-store merged: "
+	 "~n   ~p | ~p -> ~p", [New, Old, SymbolicStore]),
+    SymbolicStore.
+
+merge_or_replace_agent_env_note_store(New, Old) ->
+    NoteStore = merge_agent_options(New, Old),
+    ?DBG("merging agent env -> note-store merged: "
+	 "~n   ~p | ~p -> ~p", [New, Old, NoteStore]),
+    NoteStore.
+
+merge_or_replace_agent_env_net_if(New, Old) ->
+    NetIf = merge_agent_options(New, Old),
+    ?DBG("merging agent env -> net-if merged: "
+	 "~n   ~p | ~p -> ~p", [New, Old, NetIf]),
+    NetIf.
+
+merge_agent_options([], Options) ->
+    lists:keysort(1, Options);
+merge_agent_options([{Key, _Value} = Opt|Opts], Options) ->
+    case lists:keysearch(Key, 1, Options) of
+	{value, _} ->
+	    NewOptions = lists:keyreplace(Key, 1, Options, Opt), 
+	    merge_agent_options(Opts, NewOptions);
+	false ->
+	    merge_agent_options(Opts, [Opt|Options])
+    end.
 
 
 stop_agent(Config) when is_list(Config) ->