Merge branch 'peppe/common_test/telnet_expect_timeout'

* peppe/common_test/telnet_expect_timeout:
  Add test cases
  Introduce total timeout value in ct_telnet:expect/3 options

OTP-11689

3 files changed, 96 insertions, 24 deletions

diff --git a/lib/common_test/src/ct_telnet.erl b/lib/common_test/src/ct_telnet.erl
index 8c3ce03732..0a067b3a08 100644
--- a/lib/common_test/src/ct_telnet.erl
+++ b/lib/common_test/src/ct_telnet.erl
@@ -413,9 +413,11 @@ expect(Connection,Patterns) ->
 %%%      Prompt = string()
 %%%      Tag = term()
 %%%      Opts = [Opt]
-%%%      Opt = {timeout,Timeout} | repeat | {repeat,N} | sequence |
-%%%            {halt,HaltPatterns} | ignore_prompt | no_prompt_check
-%%%      Timeout = integer()
+%%%      Opt = {idle_timeout,IdleTimeout} | {total_timeout,TotalTimeout} |
+%%%            repeat | {repeat,N} | sequence | {halt,HaltPatterns} |
+%%%            ignore_prompt | no_prompt_check
+%%%      IdleTimeout = infinity | integer()
+%%%      TotalTimeout = infinity | integer()
 %%%      N = integer()
 %%%      HaltPatterns = Patterns
 %%%      MatchList = [Match]
@@ -441,11 +443,16 @@ expect(Connection,Patterns) ->
 %%% will also include the matched <code>Tag</code>. Else, only
 %%% <code>RxMatch</code> is returned.</p>
 %%%
-%%% <p>The <code>timeout</code> option indicates that the function
+%%% <p>The <code>idle_timeout</code> option indicates that the function
 %%% shall return if the telnet client is idle (i.e. if no data is
-%%% received) for more than <code>Timeout</code> milliseconds. Default
+%%% received) for more than <code>IdleTimeout</code> milliseconds. Default
 %%% timeout is 10 seconds.</p>
 %%%
+%%% <p>The <code>total_timeout</code> option sets a time limit for
+%%% the complete expect operation. After <code>TotalTimeout</code>
+%%% milliseconds, <code>{error,timeout}</code> is returned. The default
+%%% value is <code>infinity</code> (i.e. no time limit).</p>
+%%%
 %%% <p>The function will always return when a prompt is found, unless
 %%% any of the <code>ignore_prompt</code> or
 %%% <code>no_prompt_check</code> options are used, in which case it
@@ -578,14 +585,14 @@ handle_msg({cmd,Cmd,Timeout},State) ->
 			       State#state.buffer,
 			       prompt,
 			       State#state.prx,
-			       [{timeout,2000}]);
+			       [{idle_timeout,2000}]);
 	{ip,false} -> 
 	    silent_teln_expect(State#state.name,
 			       State#state.teln_pid,
 			       State#state.buffer,
 			       prompt,
 			       State#state.prx,
-			       [{timeout,200}]);
+			       [{idle_timeout,200}]);
 	{ip,true} ->
 	    ok
     end,
@@ -619,14 +626,14 @@ handle_msg({send,Cmd},State) ->
 			       State#state.buffer,
 			       prompt,
 			       State#state.prx,
-			       [{timeout,2000}]);
+			       [{idle_timeout,2000}]);
 	{ip,false} -> 
 	    silent_teln_expect(State#state.name,
 			       State#state.teln_pid,
 			       State#state.buffer,
 			       prompt,
 			       State#state.prx,
-			       [{timeout,200}]);
+			       [{idle_timeout,200}]);
 	{ip,true} ->
 	    ok
     end,
@@ -880,7 +887,8 @@ teln_get_all_data(Pid,Prx,Data,Acc,LastLine) ->
 %% Expect options record
 -record(eo,{teln_pid,
 	    prx,
-	    timeout,
+	    idle_timeout,
+	    total_timeout,
 	    haltpatterns=[],
 	    seq=false,
 	    repeat=false,
@@ -922,11 +930,12 @@ teln_expect(Name,Pid,Data,Pattern0,Prx,Opts) ->
     Seq = get_seq(Opts),
     Pattern = convert_pattern(Pattern0,Seq),
 
-    Timeout = get_timeout(Opts),
+    {IdleTimeout,TotalTimeout} = get_timeouts(Opts),
 
     EO = #eo{teln_pid=Pid,
 	     prx=Prx,
-	     timeout=Timeout,
+	     idle_timeout=IdleTimeout,
+	     total_timeout=TotalTimeout,
 	     seq=Seq,
 	     haltpatterns=HaltPatterns,
 	     prompt_check=PromptCheck},
@@ -965,11 +974,22 @@ rm_dupl([P|Ps],Acc) ->
 rm_dupl([],Acc) ->
     lists:reverse(Acc).
 
-get_timeout(Opts) ->
-    case lists:keysearch(timeout,1,Opts) of
-	{value,{timeout,T}} -> T;
-	false -> ?DEFAULT_TIMEOUT
-    end.
+get_timeouts(Opts) ->
+    {case lists:keysearch(idle_timeout,1,Opts) of
+	 {value,{_,T}} ->
+	     T;
+	 false ->
+	     %% this check is for backwards compatibility (pre CT v1.8)
+	     case lists:keysearch(timeout,1,Opts) of
+		 {value,{_,T}} -> T;
+		 false -> ?DEFAULT_TIMEOUT
+	     end
+     end,
+     case lists:keysearch(total_timeout,1,Opts) of
+	 {value,{_,T}} -> T;
+	 false -> infinity
+     end}.
+
 get_repeat(Opts) ->
     case lists:keysearch(repeat,1,Opts) of
 	{value,{repeat,N}} when is_integer(N) ->
@@ -1011,7 +1031,8 @@ repeat_expect(Name,Pid,Data,Pattern,Acc,EO) ->
 	    {error,Reason}
     end.
 
-teln_expect1(Name,Pid,Data,Pattern,Acc,EO) ->
+teln_expect1(Name,Pid,Data,Pattern,Acc,EO=#eo{idle_timeout=IdleTO,
+					      total_timeout=TotalTO}) ->
     ExpectFun = case EO#eo.seq of
 		    true -> fun() ->
 				    seq_expect(Name,Pid,Data,Pattern,Acc,EO)
@@ -1028,17 +1049,26 @@ teln_expect1(Name,Pid,Data,Pattern,Acc,EO) ->
 	NotFinished ->
 	    %% Get more data
 	    Fun = fun() -> get_data1(EO#eo.teln_pid) end,
-	    case timer:tc(ct_gen_conn, do_within_time, [Fun, EO#eo.timeout]) of
+	    case timer:tc(ct_gen_conn, do_within_time, [Fun, IdleTO]) of
 		{_,{error,Reason}} -> 
 		    %% A timeout will occur when the telnet connection
-		    %% is idle for EO#eo.timeout milliseconds.
+		    %% is idle for EO#eo.idle_timeout milliseconds.
 		    {error,Reason};
+		{_,{ok,Data1}} when TotalTO == infinity ->
+		    case NotFinished of
+			{nomatch,Rest} ->
+			    %% One expect
+			    teln_expect1(Name,Pid,Rest++Data1,Pattern,[],EO);
+			{continue,Patterns1,Acc1,Rest} ->
+			    %% Sequence
+			    teln_expect1(Name,Pid,Rest++Data1,Patterns1,Acc1,EO)
+		    end;
 		{Elapsed,{ok,Data1}} ->
-		    TVal = trunc(EO#eo.timeout - (Elapsed/1000)),
+		    TVal = trunc(TotalTO - (Elapsed/1000)),
 		    if TVal =< 0 ->
 			    {error,timeout};
 		       true ->
-			    EO1 = EO#eo{timeout = TVal},
+			    EO1 = EO#eo{total_timeout = TVal},
 			    case NotFinished of
 				{nomatch,Rest} ->
 				    %% One expect
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 394d64c2ed..0ee0525216 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
@@ -20,7 +20,9 @@ all() ->
      expect_repeat,
      expect_sequence,
      expect_error_prompt,
-     expect_error_timeout,
+     expect_error_timeout1,
+     expect_error_timeout2,
+     expect_error_timeout3,
      no_prompt_check,
      no_prompt_check_repeat,
      no_prompt_check_sequence,
@@ -87,13 +89,34 @@ expect_error_prompt(_) ->
 %% 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(_) ->
+expect_error_timeout1(_) ->
     {ok, Handle} = ct_telnet:open(telnet_server_conn1),
     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_error_timeout2(_) ->
+    {ok, Handle} = ct_telnet:open(telnet_server_conn1),
+    ok = ct_telnet:send(Handle, "echo_no_prompt xxx"),
+    {error,timeout} = ct_telnet:expect(Handle, ["xxx"], [{idle_timeout,1000},
+							 {total_timeout,infinity}]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% Check that if server loops and pattern not matching, the operation
+%% can be aborted
+expect_error_timeout3(_) ->
+    {ok, Handle} = ct_telnet:open(telnet_server_conn1),
+    ok = ct_telnet:send(Handle, "echo_loop 5000 xxx"),
+    {error,timeout} = ct_telnet:expect(Handle, ["yyy"],
+				       [{idle_timeout,infinity},
+					{total_timeout,3000}]),
+    ok = ct_telnet:send(Handle, "echo ayt"),
+    {ok,["ayt"]} = ct_telnet:expect(Handle, ["ayt"]),
+    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(_) ->
diff --git a/lib/common_test/test/telnet_server.erl b/lib/common_test/test/telnet_server.erl
index 3b0c3cbcb5..ae56787819 100644
--- a/lib/common_test/test/telnet_server.erl
+++ b/lib/common_test/test/telnet_server.erl
@@ -211,6 +211,11 @@ do_handle_data("echo_ml_no_prompt " ++ Data,State) ->
     ReturnData = string:join(Lines,"\n"),
     send(ReturnData,State),
     {ok,State};
+do_handle_data("echo_loop " ++ Data,State) ->
+    [TStr|Lines] = string:tokens(Data," "),
+    ReturnData = string:join(Lines,"\n"),
+    send_loop(list_to_integer(TStr),ReturnData,State),
+    {ok,State};
 do_handle_data("disconnect_after " ++WaitStr,State) ->
     Wait = list_to_integer(string:strip(WaitStr,right,$\n)),
     dbg("Server will close connection in ~w ms...", [Wait]),
@@ -251,6 +256,20 @@ send(Data,State) ->
 	    throw({error,send,Error})
     end.
     
+send_loop(T,Data,State) ->
+    dbg("Server sending ~p in loop for ~w ms...~n",[Data,T]),
+    send_loop(now(),T,Data,State).
+
+send_loop(T0,T,Data,State) ->
+    ElapsedMS = trunc(timer:now_diff(now(),T0)/1000),
+    if ElapsedMS >= T ->
+	    ok;
+       true ->
+	    send(Data,State),
+	    timer:sleep(500),
+	    send_loop(T0,T,Data,State)
+    end.
+
 get_line([$\r,$\n|Rest],Acc) ->
     {lists:reverse(Acc),Rest};
 get_line([$\r,0|Rest],Acc) ->