[reltool] Add more GUI tests

OTP-9794

This commit adds a test suite for manual testing of the reltool
GUI. By use of test_server:break/1 function, it guides the user
through a set of tests in the GUI.

Some minor checks are also added to the automatic GUI test,
reltool_wx_SUITE.

1 files changed, 247 insertions, 0 deletions

diff --git a/lib/reltool/test/reltool_manual_gui_SUITE.erl b/lib/reltool/test/reltool_manual_gui_SUITE.erl
new file mode 100644
index 0000000000..c6b1d56988
--- /dev/null
+++ b/lib/reltool/test/reltool_manual_gui_SUITE.erl
@@ -0,0 +1,247 @@
+%%
+%% %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%
+
+-module(reltool_manual_gui_SUITE).
+
+-export([all/0, suite/0,groups/0,init_per_group/2,end_per_group/2,
+	 init_per_suite/1, end_per_suite/1,
+	 init_per_testcase/2, end_per_testcase/2]).
+
+-compile(export_all).
+
+-include_lib("common_test/include/ct.hrl").
+-include("reltool_test_lib.hrl").
+
+%% Initialization functions.
+init_per_suite(Config) ->
+    reltool_test_lib:wx_init_per_suite(Config).
+
+end_per_suite(Config) ->
+    reltool_test_lib:wx_end_per_suite(Config).
+
+init_per_testcase(Func,Config) ->
+    reltool_test_lib:init_per_testcase(Func,Config).
+end_per_testcase(Func,Config) ->
+    reltool_test_lib:end_per_testcase(Func,Config).
+
+%% SUITE specification
+suite() -> [{ct_hooks,[ts_install_cth]}].
+
+all() ->
+    [config, depgraphs].
+
+groups() ->
+    [].
+
+init_per_group(_GroupName, Config) ->
+    Config.
+
+end_per_group(_GroupName, Config) ->
+    Config.
+
+
+%% The test cases
+
+%% Semi-automatic walkthrough of the GUI
+config(Config) ->
+    DataDir = ?config(data_dir,Config),
+    PrivDir = ?config(priv_dir,Config),
+    {ok, SysPid} = ?msym({ok, _}, reltool:start([])),
+    link(SysPid),
+
+    SimpleConfigFile = create_simple_config(PrivDir),
+    WarningConfigFile = create_warning_config(PrivDir,DataDir),
+
+    break("there are no modules in the 'Included' and 'Excluded' columns",
+	  {"load configuration ~p",[SimpleConfigFile]}),
+    break("kernel, stdlib and sasl are included and all other are excluded",
+	  "undo"),
+    break("we are back to default - no included and no excluded applications",
+	  "undo again"),
+    break("kernel, stdlib and sasl are included and all other are excluded",
+	  {"load configuration ~p, but click 'cancel' in the warning dialog",
+	   [WarningConfigFile]}),
+    break("no change is done",
+	  "load same configuration again and this time click 'ok' in the dialog"),
+    break("application a is added in the 'Included' column",
+	  "reset configuration"),
+    break("we are back to default - no included and no excluded applications",
+	  "undo"),
+    break("a warning dialog is displayed, with only an ok button",
+	  "click ok"),
+    break("a, kernel, stdlib and sasl are included and all other are excluded",
+	  "select application a from 'Included' column and click red cross to "
+	  "exclude it"),
+    break("application a is moved to 'Excluded' column",
+	  "select application tools from 'Excluded' column and click green V to "
+	  "include it"),
+    break("application tools is moved to 'Included' column",
+	  "select application runtime-tools from 'Excluded' column and click "
+	  "green V to include it"),
+    break("application runtime-tools is moved to 'Included' column",
+	  "undo"),
+
+    ExplicitConfig = filename:join(PrivDir,"explicit.config"),
+    break("application runtime-tools is moved back to 'Excluded' column",
+	  {"save configuration as 'explicit' to ~p",[ExplicitConfig]}),
+    ExpectedExplicitConfig =
+	{sys,[{lib_dirs,[filename:join(DataDir,"faulty_app_file")]},
+	      {incl_cond,exclude},
+	      {app,a,[{incl_cond,exclude}]},
+	      {app,kernel,[{incl_cond,include}]},
+	      {app,sasl,[{incl_cond,include}]},
+	      {app,stdlib,[{incl_cond,include}]},
+	      {app,tools,[{incl_cond,include}]}]},
+    check_config(ExpectedExplicitConfig,ExplicitConfig),
+
+    break("The saved configuration file is checked and is ok.\n"
+	  "Now go to the 'Libraries' tab and change the root directory to "
+	  "some invalid directory."),
+    break("an error dialog occurs saying that there is no lib dir",
+	  {"add library directory ~p, and click 'ok' in warning dialog",
+	   [filename:join(DataDir,"dependencies")]}),
+    break("applications x, y and z are added to the 'Excluded' column in "
+	  "'Applications' tab",
+	  "go to the 'System settings' tab and set application inclusion policy "
+	  "to 'derived'"),
+    break("a is excluded, kernel, stdlib, sasl and tools are included and "
+	  "x, y and z are available in the 'Applications' tab",
+	  "undo, and click ok in the warning dialog"),
+    break("all non included application are moved to the 'Excluded' column "
+	  "and that 'Application inclusion policy' under 'System settings' "
+	  "tab is set back to 'exclude'",
+	  "undo again"),
+    break("applications x, y and z are in the 'Available' column",
+	  "open application x, go to the 'Application settings' tab and set "
+	  "'Application inclusion policy' to 'Use application specific config' "
+	  "and 'include'. Close the window"),
+    break("application x is moved to the 'Included' column and z and y are moved "
+	  "to the 'Derived' column in the system window",
+	  "open application y"),
+    break("modules y1, y2 and y3 are in the 'Derived' column",
+	  "go to 'Application dependencies' tab"),
+    break("application y is used by x, requires kernel and stdlib, and uses z",
+	  "go to 'Module dependencies' tab"),
+    break("y is used by x2 and x3, and uses z1",
+	  "got to 'Application settings' tab and select "
+	  "'Source selection policy' 'Use selected version'"),
+    break("'Directories' frame becomes enabled (clickable)",
+	  "select 'Module inclusion policy' 'Use application specific config' "
+	  "and select 'app file + derived'"),
+    break("module y3 is moved to the 'Available' column in the 'Modules' tab",
+	  "open module y1"),
+    break("module y1 is used by x2 and uses z1",
+	  "go to the 'Code' tab and double click the line with call to z1:f()"),
+    break("new tab is opened with module z1",
+	  "find something"),
+    break("it is found",
+	  "goto some line"),
+    break("the cursor is moved to that line",
+	  "click the 'Back' button"),
+    break("the cursor is moved back to the line of your previous 'find'",
+	  "terminate the application window (but keep the module window)."),
+
+    {ok,ServerPid} = reltool:get_server(SysPid),
+    unlink(SysPid),
+    break("the system window is still alive",
+	  "terminate reltool by hitting 'Ctrl-q' when system window is active"),
+    false = erlang:is_process_alive(SysPid),
+    false = erlang:is_process_alive(ServerPid),
+
+    break("Check that both module window and system window are terminated"),
+
+    ok.
+
+
+depgraphs(Config) ->
+    PrivDir = ?config(priv_dir,Config),
+    SimpleConfigFile = create_simple_config(PrivDir),
+    {ok, SysPid} = ?msym({ok, _}, reltool:start([{config,SimpleConfigFile}])),
+    link(SysPid),
+
+    break("Open the application dependency graph and \n\n"
+	  "*move the complete graph by left clicking somewhere over it and drag\n"
+	  "*move one node left clicking the node and drag\n"
+	  "*lock node to position by holding down shift while releasing\n"
+	  "*select several nodes with ctrl and left mouse button\n"
+	  "*lock/unlock selected nodes with suitable buttons\n"
+	  "*freeze\n"
+	  "*reset\n"
+	  "*left slider: push nodes apart\n"
+	  "*right slider: pull nodes together\n"
+	  "*middle slider: adjust length of links\n"
+	  "*select node and delete\n"),
+    break("Open the module dependency graph and meditate over it... "),
+
+    unlink(SysPid),
+    break("Terminate reltool from the file menu in the system window"),
+    false = erlang:is_process_alive(SysPid),
+
+    break("Check that system window and graphs are terminated"),
+
+    ok.
+
+
+
+
+%%%-----------------------------------------------------------------
+%%% Internal functions
+break(CheckStr,DoStr) when is_list(CheckStr), is_list(DoStr) ->
+    Str = io_lib:format("Check that ~s.~n~nThen ~s.",[CheckStr,DoStr]),
+    break(Str);
+break(Check,Do) ->
+    CheckStr =
+	case Check of
+	    {CheckFormat,CheckArgs} -> io_lib:format(CheckFormat,CheckArgs);
+	    _ -> Check
+	end,
+    DoStr =
+	case Do of
+	    {DoFormat,DoArgs} -> io_lib:format(DoFormat,DoArgs);
+	    _ -> Do
+	end,
+    break(CheckStr,DoStr).
+
+break(Str) ->
+    test_server:break(Str).
+
+check_config(Expected,File) ->
+    {ok,[Config]} = file:consult(File),
+    ?m(Expected,Config).
+
+create_simple_config(PrivDir) ->
+    SimpleConfigFile = filename:join(PrivDir,"simple.config"),
+    SimpleConfig = {sys,[{incl_cond,exclude},
+			 {app,kernel,[{incl_cond,include}]},
+			 {app,stdlib,[{incl_cond,include}]},
+			 {app,sasl,[{incl_cond,include}]}]},
+    ok=file:write_file(SimpleConfigFile,io_lib:format("~p.~n",[SimpleConfig])),
+    SimpleConfigFile.
+
+create_warning_config(PrivDir,DataDir) ->
+    WarningConfigFile = filename:join(PrivDir,"warning.config"),
+    FaultyAppFileDir = filename:join(DataDir,"faulty_app_file"),
+    WarningConfig = {sys,[{lib_dirs,[FaultyAppFileDir]},
+			  {incl_cond,exclude},
+			  {app,kernel,[{incl_cond,include}]},
+			  {app,sasl,[{incl_cond,include}]},
+			  {app,stdlib,[{incl_cond,include}]},
+			  {app,a,[{incl_cond,include}]}
+			 ]},
+    ok=file:write_file(WarningConfigFile,io_lib:format("~p.~n",[WarningConfig])),
+    WarningConfigFile.