Merge branch 'lukas/common_test/deep_get_config/OTP-9626' into maint

* lukas/common_test/deep_get_config/OTP-9626:
  Add more cross reference links to ct docs
  Remove config option from common_test args
  Update user config to use nested tuple keys

5 files changed, 154 insertions, 64 deletions

diff --git a/lib/common_test/test/ct_config_SUITE.erl b/lib/common_test/test/ct_config_SUITE.erl
index 18218bee47..83b8c00458 100644
--- a/lib/common_test/test/ct_config_SUITE.erl
+++ b/lib/common_test/test/ct_config_SUITE.erl
@@ -88,7 +88,8 @@ require(Config) when is_list(Config) ->
     DataDir = ?config(data_dir, Config),
     run_test(config_static_SUITE,
 	     Config,
-	     {config, filename:join(DataDir, "config/config.txt")},
+	     [{config, filename:join(DataDir, "config/shadow.txt")},
+	      {config, filename:join(DataDir, "config/config.txt")}],
              ["config_static_SUITE"]).
 
 install_config(Config) when is_list(Config) ->
@@ -106,7 +107,8 @@ userconfig_static(Config) when is_list(Config) ->
     DataDir = ?config(data_dir, Config),
     run_test(config_static_SUITE,
 	     Config,
-	     {userconfig, {ct_config_xml, filename:join(DataDir, "config/config.xml")}},
+	     [{userconfig, {ct_config_xml, filename:join(DataDir, "config/config.xml")}},
+	      {config, filename:join(DataDir, "config/shadow.txt")}],
              ["config_static_SUITE"]).
 
 userconfig_dynamic(Config) when is_list(Config) ->
@@ -121,7 +123,8 @@ testspec_legacy(Config) when is_list(Config) ->
     make_spec(DataDir, ConfigDir,
 	      "spec_legacy.spec",
 	      [config_static_SUITE],
-	      [{config, filename:join(DataDir, "config/config.txt")}]),
+	      [{config, filename:join(DataDir, "config/shadow.txt")},
+	       {config, filename:join(DataDir, "config/config.txt")}]),
     run_test(config_static_SUITE,
 	     Config,
 	     {spec, filename:join(ConfigDir, "spec_legacy.spec")},
@@ -134,7 +137,8 @@ testspec_static(Config) when is_list(Config) ->
     make_spec(DataDir, ConfigDir,
 	      "spec_static.spec",
 	      [config_static_SUITE],
-	      [{userconfig, {ct_config_xml, filename:join(DataDir, "config/config.xml")}}]),
+	      [{userconfig, {ct_config_xml, filename:join(DataDir, "config/config.xml")}},
+	       {config, filename:join(DataDir, "config/shadow.txt")}]),
     run_test(config_static_SUITE,
 	     Config,
 	     {spec, filename:join(ConfigDir, "spec_static.spec")},
@@ -179,13 +183,15 @@ run_test(Name, Config, CTConfig, SuiteNames)->
     ExpEvents = events_to_check(Name),
     ok = ct_test_support:verify_events(ExpEvents, TestEvents, Config).
 
-setup_env(Test, Config, CTConfig) ->
+setup_env(Test, Config, CTConfig) when is_list(CTConfig) ->
     Opts0 = ct_test_support:get_opts(Config),
     Level = ?config(trace_level, Config),
     EvHArgs = [{cbm,ct_test_support},{trace_level,Level}],
-    Opts = Opts0 ++ [Test,{event_handler,{?eh,EvHArgs}}, CTConfig],
+    Opts = Opts0 ++ [Test,{event_handler,{?eh,EvHArgs}} | CTConfig],
     ERPid = ct_test_support:start_event_receiver(Config),
-    {Opts,ERPid}.
+    {Opts,ERPid};
+setup_env(Test, Config, CTConfig) ->
+    setup_env(Test, Config, [CTConfig]).
 
 reformat_events(Events, EH) ->
     ct_test_support:reformat(Events, EH).
@@ -202,40 +208,49 @@ events_to_check(_, 0) ->
 events_to_check(Test, N) ->
     expected_events(Test) ++ events_to_check(Test, N-1).
 
+-define(ok(Name,Suite,Stat),{?eh,tc_start,{Suite,Name}},
+	{?eh,tc_done,{Suite,Name,ok}},
+	{?eh,test_stats,Stat}).
+-define(nok(Name,Suite,Reason,Stat),{?eh,tc_start,{Suite,Name}},
+     {?eh,tc_done,{Suite,Name,Reason}},
+     {?eh,test_stats,Stat}).
+
+-define(sok(Name,Stat),?ok(Name,config_static_SUITE,Stat)).
+-define(snok(Name,Reason,Stat),?nok(Name,config_static_SUITE,Reason,Stat)).
+
+-define(dok(Name,Stat),?ok(Name,config_dynamic_SUITE,Stat)).
+-define(dnok(Name,Reason,Stat),?nok(Name,config_dynamic_SUITE,Reason,Stat)).
+
 expected_events(config_static_SUITE)->
     [
      {?eh,start_logging,{'DEF','RUNDIR'}},
      {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
-     {?eh,start_info,{1,1,8}},
+     {?eh,start_info,{1,1,'_'}},
      {?eh,tc_start,{config_static_SUITE,init_per_suite}},
      {?eh,tc_done,{config_static_SUITE,init_per_suite,ok}},
-     {?eh,tc_start,{config_static_SUITE,test_get_config_simple}},
-     {?eh,tc_done,{config_static_SUITE,test_get_config_simple,ok}},
-     {?eh,test_stats,{1,0,{0,0}}},
-     {?eh,tc_start,{config_static_SUITE,test_get_config_nested}},
-     {?eh,tc_done,{config_static_SUITE,test_get_config_nested,ok}},
-     {?eh,test_stats,{2,0,{0,0}}},
-     {?eh,tc_start,{config_static_SUITE,test_default_suitewide}},
-     {?eh,tc_done,{config_static_SUITE,test_default_suitewide,ok}},
-     {?eh,test_stats,{3,0,{0,0}}},
-     {?eh,tc_start,{config_static_SUITE,test_config_name_already_in_use1}},
-     {?eh,tc_done,
-      {config_static_SUITE,test_config_name_already_in_use1,{skipped,{config_name_already_in_use,[x1]}}}},
-     {?eh,test_stats,{3,0,{1,0}}},
-     {?eh,tc_start,{config_static_SUITE,test_default_tclocal}},
-     {?eh,tc_done,{config_static_SUITE,test_default_tclocal,ok}},
-     {?eh,test_stats,{4,0,{1,0}}},
-     {?eh,tc_start,{config_static_SUITE,test_config_name_already_in_use2}},
-     {?eh,tc_done,
-      {config_static_SUITE,test_config_name_already_in_use2,
-       {skipped,{config_name_already_in_use,[alias,x1]}}}},
-     {?eh,test_stats,{4,0,{2,0}}},
-     {?eh,tc_start,{config_static_SUITE,test_alias_tclocal}},
-     {?eh,tc_done,{config_static_SUITE,test_alias_tclocal,ok}},
-     {?eh,test_stats,{5,0,{2,0}}},
-     {?eh,tc_start,{config_static_SUITE,test_get_config_undefined}},
-     {?eh,tc_done,{config_static_SUITE,test_get_config_undefined,ok}},
-     {?eh,test_stats,{6,0,{2,0}}},
+     ?sok(test_get_config_simple,{1,0,{0,0}}),
+     ?sok(test_get_config_nested,{2,0,{0,0}}),
+     ?sok(test_get_config_deep_nested,{3,0,{0,0}}),
+     ?sok(test_default_suitewide,{4,0,{0,0}}),
+     ?snok(test_config_name_already_in_use1,
+	  {skipped,{config_name_already_in_use,[x1]}},{4,0,{1,0}}),
+     ?sok(test_default_tclocal,{5,0,{1,0}}),
+     ?snok(test_config_name_already_in_use2,
+	  {skipped,{config_name_already_in_use,[alias,x1]}},{5,0,{2,0}}),
+     ?sok(test_alias_tclocal,{6,0,{2,0}}),
+     ?sok(test_get_config_undefined,{7,0,{2,0}}),
+     ?sok(test_require_subvals,{8,0,{2,0}}),
+     ?snok(test_require_subvals2,
+	  {skipped,{require_failed,
+		    {not_available,{gen_cfg,[a,b,c,d]}}}},{8,0,{2,1}}),
+     ?sok(test_require_deep_config,{9,0,{2,1}}),
+     ?sok(test_shadow_all,{10,0,{2,1}}),
+     ?sok(test_element,{11,0,{2,1}}),
+     ?sok(test_shadow_all_element,{12,0,{2,1}}),
+     ?sok(test_internal_deep,{13,0,{2,1}}),
+     ?sok(test_alias_tclocal_nested,{14,0,{2,1}}),
+     ?sok(test_alias_tclocal_nested_backward_compat,{15,0,{2,1}}),
+     ?sok(test_alias_tclocal_nested_backward_compat_subvals,{16,0,{2,1}}),
      {?eh,tc_start,{config_static_SUITE,end_per_suite}},
      {?eh,tc_done,{config_static_SUITE,end_per_suite,ok}},
      {?eh,test_done,{'DEF','STOP_TIME'}},
@@ -246,29 +261,14 @@ expected_events(config_dynamic_SUITE)->
     [
      {?eh,start_logging,{'DEF','RUNDIR'}},
      {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
-     {?eh,start_info,{1,1,5}},
+     {?eh,start_info,{1,1,'_'}},
      {?eh,tc_start,{config_dynamic_SUITE,init_per_suite}},
      {?eh,tc_done,{config_dynamic_SUITE,init_per_suite,ok}},
-     {?eh,tc_start,{config_dynamic_SUITE,test_get_known_variable}},
-     {?eh,tc_done,
-      {config_dynamic_SUITE,test_get_known_variable,ok}},
-     {?eh,test_stats,{1,0,{0,0}}},
-     {?eh,tc_start,{config_dynamic_SUITE,test_localtime_update}},
-     {?eh,tc_done,{config_dynamic_SUITE,test_localtime_update,ok}},
-     {?eh,test_stats,{2,0,{0,0}}},
-     {?eh,tc_start,{config_dynamic_SUITE,test_server_pid}},
-     {?eh,tc_done,{config_dynamic_SUITE,test_server_pid,ok}},
-     {?eh,test_stats,{3,0,{0,0}}},
-     {?eh,tc_start,
-      {config_dynamic_SUITE,test_disappearable_variable}},
-     {?eh,tc_done,
-      {config_dynamic_SUITE,test_disappearable_variable,ok}},
-     {?eh,test_stats,{4,0,{0,0}}},
-     {?eh,tc_start,
-      {config_dynamic_SUITE,test_disappearable_variable_alias}},
-     {?eh,tc_done,
-      {config_dynamic_SUITE,test_disappearable_variable_alias,ok}},
-     {?eh,test_stats,{5,0,{0,0}}},
+     ?dok(test_get_known_variable,{1,0,{0,0}}),
+     ?dok(test_localtime_update,{2,0,{0,0}}),
+     ?dok(test_server_pid,{3,0,{0,0}}),
+     ?dok(test_disappearable_variable,{4,0,{0,0}}),
+     ?dok(test_disappearable_variable_alias,{5,0,{0,0}}),
      {?eh,tc_start,{config_dynamic_SUITE,end_per_suite}},
      {?eh,tc_done,{config_dynamic_SUITE,end_per_suite,ok}},
      {?eh,test_done,{'DEF','STOP_TIME'}},
diff --git a/lib/common_test/test/ct_config_SUITE_data/config/config.txt b/lib/common_test/test/ct_config_SUITE_data/config/config.txt
index fcbffcd7f3..e4bcc5ba6b 100644
--- a/lib/common_test/test/ct_config_SUITE_data/config/config.txt
+++ b/lib/common_test/test/ct_config_SUITE_data/config/config.txt
@@ -2,7 +2,8 @@
 {gen_cfg,
 	[
 		{a,a_value},
-		{b,b_value}
+		{b,b_value},
+		{c,[{d,d_value}]}
 	]}.
 {gen_cfg2,
 	[
diff --git a/lib/common_test/test/ct_config_SUITE_data/config/config.xml b/lib/common_test/test/ct_config_SUITE_data/config/config.xml
index 0a3e5f2e31..8eeff1482f 100644
--- a/lib/common_test/test/ct_config_SUITE_data/config/config.xml
+++ b/lib/common_test/test/ct_config_SUITE_data/config/config.xml
@@ -3,6 +3,7 @@
 	<gen_cfg>
 		<a>a_value</a>
 		<b>b_value</b>
+		<c><d>d_value</d></c>
 	</gen_cfg>
 	<gen_cfg2>
 		<c>"Hello, world!"</c>
diff --git a/lib/common_test/test/ct_config_SUITE_data/config/shadow.txt b/lib/common_test/test/ct_config_SUITE_data/config/shadow.txt
new file mode 100644
index 0000000000..865bf9255a
--- /dev/null
+++ b/lib/common_test/test/ct_config_SUITE_data/config/shadow.txt
@@ -0,0 +1,12 @@
+{x, suite}.
+{gen_cfg3,
+	[
+		{l,
+		[
+			{m,
+			[
+				{n, "n"},
+				{o, 'o'}
+			]}
+		]}
+	]}.
diff --git a/lib/common_test/test/ct_config_SUITE_data/config/test/config_static_SUITE.erl b/lib/common_test/test/ct_config_SUITE_data/config/test/config_static_SUITE.erl
index 8751a2e8f3..d7119d7fde 100644
--- a/lib/common_test/test/ct_config_SUITE_data/config/test/config_static_SUITE.erl
+++ b/lib/common_test/test/ct_config_SUITE_data/config/test/config_static_SUITE.erl
@@ -46,7 +46,7 @@ suite() ->
      {require, gen_cfg3},
      {require, alias, gen_cfg},
      %% x1 default value
-     {x1, {x,suite}}
+     {default_config, x1, {x,suite}}
     ].
 
 init_per_suite(Config) ->
@@ -55,14 +55,24 @@ init_per_suite(Config) ->
 end_per_suite(_) ->
     ok.
 
-all() -> [test_get_config_simple, test_get_config_nested, test_default_suitewide,
+all() -> [test_get_config_simple, test_get_config_nested,
+	  test_get_config_deep_nested, test_default_suitewide,
 	  test_config_name_already_in_use1, test_default_tclocal,
 	  test_config_name_already_in_use2, test_alias_tclocal,
-	  test_get_config_undefined].
-
-init_per_testcase(_, Config) ->
+	  test_get_config_undefined,
+	  test_require_subvals,test_require_subvals2,test_require_deep_config,
+	  test_shadow_all,test_element,test_shadow_all_element,
+	  test_internal_deep, test_alias_tclocal_nested,
+	  test_alias_tclocal_nested_backward_compat,
+	  test_alias_tclocal_nested_backward_compat_subvals
+].
+
+init_per_testcase(_,Config) ->
     Config.
 
+end_per_testcase(test_alias_tclocal_nested_backward_compat, _) ->
+    os:putenv("COMMON_TEST_ALIAS_TOP",""),
+    ok;
 end_per_testcase(_, _) ->
     ok.
 
@@ -76,6 +86,11 @@ test_get_config_nested(_)->
     a_value = ct:get_config({gen_cfg, a}),
     ok.
 
+%% test getting a deep nested value
+test_get_config_deep_nested(_)->
+    d_value = ct:get_config({gen_cfg, c, d}),
+    ok.
+
 %% test suite-wide default value
 test_default_suitewide(_)->
     suite = ct:get_config(x1),
@@ -112,12 +127,73 @@ test_config_name_already_in_use2(_) ->
 %% test aliases
 test_alias_tclocal() ->
     [{require,newalias,gen_cfg}].
-test_alias_tclocal(_) ->
-    A = [{a,a_value},{b,b_value}] = ct:get_config(newalias),
+test_alias_tclocal(C) when is_list(C) ->
+    test_alias_tclocal(newalias);
+test_alias_tclocal(Alias) when is_atom(Alias) ->
+    A = [{a,a_value},{b,b_value},{c,[{d,d_value}]}] = ct:get_config(Alias),
     A = ct:get_config(gen_cfg),
+    B = b_value = ct:get_config({Alias,b}),
+    B = ct:get_config({gen_cfg,b}),
+    ok.
+
+%% test nested aliases
+test_alias_tclocal_nested() ->
+    [{require,newalias2,{gen_cfg,c}}].
+test_alias_tclocal_nested(_) ->
+    A = [{d,d_value}] = ct:get_config(newalias2),
+    A = ct:get_config({gen_cfg,c}),
+    B = d_value = ct:get_config({newalias2,d}),
+    B = ct:get_config({gen_cfg,c,d}),
     ok.
 
+%% test nested aliases backward compat option
+test_alias_tclocal_nested_backward_compat() ->
+    os:putenv("COMMON_TEST_ALIAS_TOP","true"),
+    [{require,newalias3,{gen_cfg,c}}].
+test_alias_tclocal_nested_backward_compat(_) ->
+    test_alias_tclocal(newalias3).
+
+%% test nested aliases backward compat option
+test_alias_tclocal_nested_backward_compat_subvals() ->
+    [{require,newalias4,{gen_cfg,[c]}}].
+test_alias_tclocal_nested_backward_compat_subvals(_) ->
+    test_alias_tclocal(newalias4).
+
 %% test for getting undefined variables
 test_get_config_undefined(_) ->
     undefined = ct:get_config(y1),
     ok.
+
+test_require_subvals() ->
+    [{require, {gen_cfg,[a,b,c]}}].
+test_require_subvals(_) ->
+    ok.
+
+test_require_subvals2() ->
+    [{require, {gen_cfg,[a,b,c,d]}}].
+test_require_subvals2(_) ->
+    ct:fail("Test should've been skipped, you shouldn't see this!"),
+    ok.
+
+test_require_deep_config() ->
+    [{require, {gen_cfg3, m, n}}].
+test_require_deep_config(_) ->
+    ok.
+
+
+test_shadow_all(_) ->
+    ["n","N"] = ct:get_config({gen_cfg3,l, m, n}, [], [all]).
+
+test_element(_) ->
+    {{gen_cfg3,l, m, n},"n"} = ct:get_config({gen_cfg3,l, m, n}, [], [element]).
+
+test_shadow_all_element(_) ->
+    [{{gen_cfg3,l, m, n},"n"},{{gen_cfg3,l, m, n},"N"}] =
+	ct:get_config({gen_cfg3,l, m, n}, [], [all,element]).
+
+%% The tests below are needed to verify that things like ct:telnet can use
+%% nested configs
+test_internal_deep(_) ->
+    "n" = ct:get_config({{gen_cfg3,l,m},n}),
+    a_value = ct:get_config({{gen_cfg},a}),
+    undefined = ct:get_config({{gen_cfg3,l,m},p}).