[ct] Add 'newline' option to send functions in ct_telnet

ct_telnet by default adds a newline to all command strings before
sending to the telnet server. In some situations this is not desired,
for example when sending telnet command sequences (prefixed with the
Interprete As Command, IAC, character). In such cases, the new option
can be used. Example - send an Are Your There (AYT) sequence:

ct_telnet:send(Connection, [255,246], [{newline,false}]).

3 files changed, 78 insertions, 11 deletions

diff --git a/lib/common_test/test/ct_telnet_SUITE_data/ct_telnet_basic_SUITE.erl b/lib/common_test/test/ct_telnet_SUITE_data/ct_telnet_basic_SUITE.erl
index 80616af064..3885c1991d 100644
--- a/lib/common_test/test/ct_telnet_SUITE_data/ct_telnet_basic_SUITE.erl
+++ b/lib/common_test/test/ct_telnet_SUITE_data/ct_telnet_basic_SUITE.erl
@@ -20,7 +20,7 @@ suite() -> [
 
 operations() -> 
     [start_stop, send_and_get, expect, already_closed, 
-     cmd, sendf, close_wrong_type].
+     cmd, sendf, no_newline, close_wrong_type].
 
 mult_case(_Case, 0) ->
     [];
@@ -129,6 +129,16 @@ sendf(Config) ->
     ok = ct_telnet:close(Handle),
     ok.
 
+no_newline(Config) ->
+    {ok, Handle} = ct_telnet:open(?conn_name(?get_n(Config))),
+    IAC = 255, % interprete as command
+    AYT = 246, % are you there
+    ok = ct_telnet:send(Handle, [IAC,AYT], [{newline,false}]),
+    {ok,_} = ct_telnet:expect(Handle,"yes",[no_prompt_check]),
+    {ok,_} = ct_telnet:cmd(Handle, ""), % send newline only to get back prompt
+    ok = ct_telnet:close(Handle),
+    ok.
+
 close_wrong_type(_) ->
     {error, _} = ct_telnet:close(whatever),
     ok.
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 c0f79d0f10..9afe545b26 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
@@ -4,6 +4,24 @@
 
 -include_lib("common_test/include/ct.hrl").
 
+%% telnet control characters
+-define(SE,	240).
+-define(NOP,	241).
+-define(DM,	242).
+-define(BRK,	243).
+-define(IP,	244).
+-define(AO,	245).
+-define(AYT,	246).
+-define(EC,	247).
+-define(EL,	248).
+-define(GA,	249).
+-define(SB,	250).
+-define(WILL,	251).
+-define(WONT,	252).
+-define(DO,	253).
+-define(DONT,	254).
+-define(IAC,	255).
+
 %%--------------------------------------------------------------------
 %% TEST SERVER CALLBACK FUNCTIONS
 %%--------------------------------------------------------------------
@@ -34,7 +52,9 @@ all() ->
      ignore_prompt_timeout,
      large_string,
      server_speaks,
-     server_disconnects
+     server_disconnects,
+     newline_ayt,
+     newline_break
     ].
 
 groups() ->
@@ -285,3 +305,22 @@ server_disconnects(_) ->
     timer:sleep(3000),
     _ = ct_telnet:close(Handle),
     ok.
+
+%% Test option {newline,false} to send telnet command sequence.
+newline_ayt(_) ->
+    {ok, Handle} = ct_telnet:open(telnet_server_conn1),
+    ok = ct_telnet:send(Handle, [?IAC,?AYT], [{newline,false}]),
+    {ok,["yes"]} = ct_telnet:expect(Handle, ["yes"]),
+    ok = ct_telnet:close(Handle),
+    ok.
+
+%% Test option {newline,false} to send telnet command sequence.
+newline_break(_) ->
+    {ok, Handle} = ct_telnet:open(telnet_server_conn1),
+    ok = ct_telnet:send(Handle, [?IAC,?BRK], [{newline,false}]),
+    %% '#' is the prompt in break mode
+    {ok,["# "]} = ct_telnet:expect(Handle, ["# "], [no_prompt_check]),
+    {ok,R} = ct_telnet:cmd(Handle, "q", [{newline,false}]),
+    "> " = lists:flatten(R),
+    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 1d341d6106..0a23a66324 100644
--- a/lib/common_test/test/telnet_server.erl
+++ b/lib/common_test/test/telnet_server.erl
@@ -31,7 +31,8 @@
 	 users,
 	 authorized=false,
 	 suppress_go_ahead=false,
-	 buffer=[]}).
+	 buffer=[],
+	 break=false}).
 
 -type options() :: [{port,pos_integer()} | {users,users()}].
 -type users() :: [{user(),password()}].
@@ -148,6 +149,9 @@ loop(State, N) ->
 	    stopped
     end.
 
+handle_data(Cmd,#state{break=true}=State) ->
+    dbg("Server got data when in break mode: ~p~n",[Cmd]),
+    handle_break_cmd(Cmd,State);
 handle_data([?IAC|Cmd],State) ->
     dbg("Server got cmd: ~p~n",[Cmd]),
     handle_cmd(Cmd,State);
@@ -171,24 +175,38 @@ handle_data(Data,State) ->
 	    {ok,State#state{buffer=[Data|State#state.buffer]}}
     end.
 
-%% Add function clause below to handle new telnet commands (sent with
-%% ?IAC from client - this is not possible to do from ct_telnet API,
-%% but ct_telnet sends DONT SUPPRESS_GO_AHEAD)
+%% Add function clause below to handle new telnet commands sent with
+%% ?IAC from client. This can be done from ct_telnet:send or
+%% ct_telnet:cmd if using the option {newline,false}. Also, ct_telnet
+%% sends DONT SUPPRESS_GO_AHEAD.
 handle_cmd([?DO,?SUPPRESS_GO_AHEAD|T],State) ->
     send([?IAC,?WILL,?SUPPRESS_GO_AHEAD],State),
-    handle_cmd(T,State#state{suppress_go_ahead=true});
+    handle_data(T,State#state{suppress_go_ahead=true});
 handle_cmd([?DONT,?SUPPRESS_GO_AHEAD|T],State) ->
     send([?IAC,?WONT,?SUPPRESS_GO_AHEAD],State),
-    handle_cmd(T,State#state{suppress_go_ahead=false});
-handle_cmd([?IAC|T],State) ->
-    %% Multiple commands in one packet
-    handle_cmd(T,State);
+    handle_data(T,State#state{suppress_go_ahead=false});
+handle_cmd([?BRK|T],State) ->
+    %% Used when testing 'newline' option in ct_telnet:send and ct_telnet:cmd.
+    send("# ",State),
+    handle_data(T,State#state{break=true});
+handle_cmd([?AYT|T],State) ->
+    %% Used when testing 'newline' option in ct_telnet:send and ct_telnet:cmd.
+    send("yes\r\n> ",State),
+    handle_data(T,State);
 handle_cmd([_H|T],State) ->
     %% Not responding to this command
     handle_cmd(T,State);
 handle_cmd([],State) ->
     {ok,State}.
 
+handle_break_cmd([$q|T],State) ->
+    %% Dummy cmd allowed in break mode - quit break mode
+    send("\r\n> ",State),
+    handle_data(T,State#state{break=false});
+handle_break_cmd([],State) ->
+    {ok,State}.
+
+
 %% Add function clause below to handle new text command (text entered
 %% from the telnet prompt)
 do_handle_data(Data,#state{authorized=false}=State) ->