[common_test] Add new option 'no_prompt_check' to ct_telnet:expect/3.

If this option is used, ct_telnet will not search for a prompt before
attempting to match the given pattern. This is useful if, for
instance, the Pattern itself matches the prompt or if the telnet
session starts interactive programs which do not display the normal
prompt.

3 files changed, 159 insertions, 9 deletions

diff --git a/lib/common_test/test/ct_telnet_SUITE.erl b/lib/common_test/test/ct_telnet_SUITE.erl
index c75f0f5843..a378c531f0 100644
--- a/lib/common_test/test/ct_telnet_SUITE.erl
+++ b/lib/common_test/test/ct_telnet_SUITE.erl
@@ -53,8 +53,9 @@ end_per_suite(Config) ->
     ct_test_support:end_per_suite(Config).
 
 init_per_testcase(own_server=TestCase, Config) ->
-    TS = telnet_server:start([{port,1234},{users,[{?erl_telnet_server_user,
-						   ?erl_telnet_server_pwd}]}]),
+    TS = telnet_server:start([{port,?erl_telnet_server_port},
+			      {users,[{?erl_telnet_server_user,
+				       ?erl_telnet_server_pwd}]}]),
     ct_test_support:init_per_testcase(TestCase, [{telnet_server,TS}|Config]);
 init_per_testcase(TestCase, Config) ->
     ct_test_support:init_per_testcase(TestCase, Config).
@@ -92,7 +93,7 @@ own_server(Config) ->
     DataDir = ?config(data_dir, Config),
     Suite = filename:join(DataDir, "ct_telnet_own_server_SUITE"),
     Cfg = {unix,[{telnet,"localhost"},
-		 {port, 1234},
+		 {port, ?erl_telnet_server_port},
 		 {username,?erl_telnet_server_user},
 		 {password,?erl_telnet_server_pwd},
 		 {wait_for_linebreak, false},
diff --git a/lib/common_test/test/ct_telnet_SUITE_data/ct_telnet_own_server_SUITE.erl b/lib/common_test/test/ct_telnet_SUITE_data/ct_telnet_own_server_SUITE.erl
index 2173c68c11..3f7c0d68bf 100644
--- a/lib/common_test/test/ct_telnet_SUITE_data/ct_telnet_own_server_SUITE.erl
+++ b/lib/common_test/test/ct_telnet_SUITE_data/ct_telnet_own_server_SUITE.erl
@@ -19,7 +19,18 @@ suite() -> [{require,erl_telnet_server,{unix,[telnet]}}].
 
 all() ->
     [expect,
-     expect_repeat].
+     expect_repeat,
+     expect_sequence,
+     expect_error_prompt,
+     expect_error_timeout,
+     no_prompt_check,
+     no_prompt_check_repeat,
+     no_prompt_check_sequence,
+     no_prompt_check_timeout,
+     ignore_prompt,
+     ignore_prompt_repeat,
+     ignore_prompt_sequence,
+     ignore_prompt_timeout].
 
 groups() ->
     [].
@@ -30,6 +41,7 @@ init_per_group(_GroupName, Config) ->
 end_per_group(_GroupName, Config) ->
     Config.
 
+%% Simple expect
 expect(_) ->
     {ok, Handle} = ct_telnet:open(erl_telnet_server),
     ok = ct_telnet:send(Handle, "echo ayt"),
@@ -37,10 +49,136 @@ expect(_) ->
     ok = ct_telnet:close(Handle),
     ok.
 
+%% Expect with repeat option
 expect_repeat(_) ->
     {ok, Handle} = ct_telnet:open(erl_telnet_server),
-    ok = ct_telnet:send(Handle, "repeat xy"),
-    {ok,[["xy"],["xy"]],done} = ct_telnet:expect(Handle, ["xy"],
-						 [{repeat,2}]),
+    ok = ct_telnet:send(Handle, "echo_ml xy xy"),
+    {ok,[["xy"],["xy"]],done} = ct_telnet:expect(Handle, ["xy"],[{repeat,2}]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% Expect with sequence option
+expect_sequence(_) ->
+    {ok, Handle} = ct_telnet:open(erl_telnet_server),
+    ok = ct_telnet:send(Handle, "echo_ml ab cd ef"),
+    {ok,[["ab"],["cd"],["ef"]]} = ct_telnet:expect(Handle,
+						   [["ab"],["cd"],["ef"]],
+						   [sequence]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% Check that expect returns when a prompt is found, even if pattern
+%% is not matched.
+expect_error_prompt(_) ->
+    {ok, Handle} = ct_telnet:open(erl_telnet_server),
+    ok = ct_telnet:send(Handle, "echo xxx> yyy"),
+    {error,{prompt,"> "}} = ct_telnet:expect(Handle, ["yyy"]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% Check that expect returns after idle timeout, and even if the
+%% expected pattern is received - as long as not newline or prompt is
+%% received it will not match.
+expect_error_timeout(_) ->
+    {ok, Handle} = ct_telnet:open(erl_telnet_server),
+    ok = ct_telnet:send(Handle, "echo_no_prompt xxx"),
+    {error,timeout} = ct_telnet:expect(Handle, ["xxx"], [{timeout,1000}]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% expect with ignore_prompt option should not return even if a prompt
+%% is found. The pattern after the prompt (here "> ") can be matched.
+ignore_prompt(_) ->
+    {ok, Handle} = ct_telnet:open(erl_telnet_server),
+    ok = ct_telnet:send(Handle, "echo xxx> yyy"),
+    {ok,["yyy"]} = ct_telnet:expect(Handle, ["yyy"], [ignore_prompt]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% expect with ignore_prompt and repeat options.
+ignore_prompt_repeat(_) ->
+    {ok, Handle} = ct_telnet:open(erl_telnet_server),
+    ok = ct_telnet:send(Handle, "echo_ml yyy> yyy>"),
+    {ok,[["yyy"],["yyy"]],done} = ct_telnet:expect(Handle, ["yyy"],
+						   [{repeat,2},
+						    ignore_prompt]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% expect with ignore_prompt and sequence options.
+ignore_prompt_sequence(_) ->
+    {ok, Handle} = ct_telnet:open(erl_telnet_server),
+    ok = ct_telnet:send(Handle, "echo_ml xxx> yyy> zzz> "),
+    {ok,[["xxx"],["yyy"],["zzz"]]} = ct_telnet:expect(Handle,
+						      [["xxx"],["yyy"],["zzz"]],
+						      [sequence,
+						       ignore_prompt]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% Check that expect returns after idle timeout when ignore_prompt
+%% option is used.
+%% As for expect without the ignore_prompt option, it a newline or a
+%% prompt is required in order for the pattern to match.
+ignore_prompt_timeout(_) ->
+    {ok, Handle} = ct_telnet:open(erl_telnet_server),
+    ok = ct_telnet:send(Handle, "echo xxx"),
+    {error,timeout} = ct_telnet:expect(Handle, ["yyy"], [ignore_prompt,
+							 {timeout,1000}]),
+    ok = ct_telnet:send(Handle, "echo xxx"), % sends prompt and newline
+    {ok,["xxx"]} = ct_telnet:expect(Handle, ["xxx"], [ignore_prompt,
+						      {timeout,1000}]),
+    ok = ct_telnet:send(Handle, "echo_no_prompt xxx\n"), % no prompt, but newline
+    {ok,["xxx"]} = ct_telnet:expect(Handle, ["xxx"], [ignore_prompt,
+						      {timeout,1000}]),
+    ok = ct_telnet:send(Handle, "echo_no_prompt xxx"), % no prompt, no newline
+    {error,timeout} = ct_telnet:expect(Handle, ["xxx"], [ignore_prompt,
+							 {timeout,1000}]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% no_prompt_check option shall match pattern both when prompt is sent
+%% and when it is not.
+no_prompt_check(_) ->
+    {ok, Handle} = ct_telnet:open(erl_telnet_server),
+    ok = ct_telnet:send(Handle, "echo xxx"),
+    {ok,["xxx"]} = ct_telnet:expect(Handle, ["xxx"], [no_prompt_check]),
+    ok = ct_telnet:send(Handle, "echo_no_prompt yyy"),
+    {ok,["yyy"]} = ct_telnet:expect(Handle, ["yyy"], [no_prompt_check]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% no_prompt_check and repeat options
+no_prompt_check_repeat(_) ->
+    {ok, Handle} = ct_telnet:open(erl_telnet_server),
+    ok = ct_telnet:send(Handle, "echo_ml xxx xxx"),
+    {ok,[["xxx"],["xxx"]],done} = ct_telnet:expect(Handle,["xxx"],
+						   [{repeat,2},
+						    no_prompt_check]),
+    ok = ct_telnet:send(Handle, "echo_ml_no_prompt yyy yyy"),
+    {ok,[["yyy"],["yyy"]],done} = ct_telnet:expect(Handle,["yyy"],
+						   [{repeat,2},
+						    no_prompt_check]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% no_prompt_check and sequence options
+no_prompt_check_sequence(_) ->
+    {ok, Handle} = ct_telnet:open(erl_telnet_server),
+    ok = ct_telnet:send(Handle, "echo_ml_no_prompt ab cd ef"),
+    {ok,[["ab"],["cd"],["ef"]]} = ct_telnet:expect(Handle,
+						   [["ab"],["cd"],["ef"]],
+						   [sequence,
+						    no_prompt_check]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% Check that expect returns after idle timeout when no_prompt_check
+%% option is used.
+no_prompt_check_timeout(_) ->
+    {ok, Handle} = ct_telnet:open(erl_telnet_server),
+    ok = ct_telnet:send(Handle, "echo xxx"),
+    {error,timeout} = ct_telnet:expect(Handle, ["yyy"], [no_prompt_check,
+							 {timeout,1000}]),
     ok = ct_telnet:close(Handle),
     ok.
diff --git a/lib/common_test/test/telnet_server.erl b/lib/common_test/test/telnet_server.erl
index 5843155eee..31884aa182 100644
--- a/lib/common_test/test/telnet_server.erl
+++ b/lib/common_test/test/telnet_server.erl
@@ -93,6 +93,7 @@ do_accept(LSock,Server) ->
     end.
 
 init_client(#state{client=Sock}=State) ->
+    dbg("Server sending: ~p~n",["login: "]),
     R = case gen_tcp:send(Sock,"login: ") of
 	    ok ->
 		loop(State);
@@ -164,8 +165,18 @@ do_handle_data(Data,#state{authorized={user,_}}=State) ->
 do_handle_data("echo "++ Data,State) ->
     send(Data++"\r\n> ",State),
     {ok,State};
-do_handle_data("repeat "++ Data,State) ->
-    send(Data++"\r\n"++Data++"\r\n> ",State),
+do_handle_data("echo_no_prompt "++ Data,State) ->
+    send(Data,State),
+    {ok,State};
+do_handle_data("echo_ml "++ Data,State) ->
+    Lines = string:tokens(Data," "),
+    ReturnData = string:join(Lines,"\n"),
+    send(ReturnData++"\r\n> ",State),
+    {ok,State};
+do_handle_data("echo_ml_no_prompt "++ Data,State) ->
+    Lines = string:tokens(Data," "),
+    ReturnData = string:join(Lines,"\n"),
+    send(ReturnData,State),
     {ok,State};
 do_handle_data([],State) ->
     send("> ",State),