Merge branch 'hans/ssh/supervisor_timeout/OTP-14907' into maint-20

* hans/ssh/supervisor_timeout/OTP-14907:
  ssh: Dont repeat supervisor defaults in map fields
  ssh: Move starting of channel child to ssh_channel_sup
  ssh: Test case for sup tree when shell server proc times out

11 files changed, 132 insertions, 58 deletions

diff --git a/lib/ssh/src/ssh_acceptor_sup.erl b/lib/ssh/src/ssh_acceptor_sup.erl
index a24664793b..fc564a359b 100644
--- a/lib/ssh/src/ssh_acceptor_sup.erl
+++ b/lib/ssh/src/ssh_acceptor_sup.erl
@@ -86,10 +86,7 @@ child_spec(Address, Port, Profile, Options) ->
     Timeout = ?GET_INTERNAL_OPT(timeout, Options, ?DEFAULT_TIMEOUT),
     #{id       => id(Address, Port, Profile),
       start    => {ssh_acceptor, start_link, [Port, Address, Options, Timeout]},
-      restart  => transient,
-      shutdown => 5500, %brutal_kill,
-      type     => worker,
-      modules  => [ssh_acceptor]
+      restart  => transient % because a crashed listener could be replaced by a new one
      }.
 
 id(Address, Port, Profile) ->
diff --git a/lib/ssh/src/ssh_channel_sup.erl b/lib/ssh/src/ssh_channel_sup.erl
index 6b01dc334d..8444533fd1 100644
--- a/lib/ssh/src/ssh_channel_sup.erl
+++ b/lib/ssh/src/ssh_channel_sup.erl
@@ -26,7 +26,7 @@
 
 -behaviour(supervisor).
 
--export([start_link/1, start_child/2]).
+-export([start_link/1, start_child/5]).
 
 %% Supervisor callback
 -export([init/1]).
@@ -37,7 +37,14 @@
 start_link(Args) ->
     supervisor:start_link(?MODULE, [Args]).
 
-start_child(Sup, ChildSpec) ->
+start_child(Sup, Callback, Id, Args, Exec) ->
+    ChildSpec =
+        #{id       => make_ref(),
+          start    => {ssh_channel, start_link, [self(), Id, Callback, Args, Exec]},
+          restart  => temporary,
+          type     => worker,
+          modules  => [ssh_channel]
+         },
     supervisor:start_child(Sup, ChildSpec).
 
 %%%=========================================================================
diff --git a/lib/ssh/src/ssh_connection.erl b/lib/ssh/src/ssh_connection.erl
index 7e9ee78fd2..946ae2967b 100644
--- a/lib/ssh/src/ssh_connection.erl
+++ b/lib/ssh/src/ssh_connection.erl
@@ -812,22 +812,20 @@ start_channel(Cb, Id, Args, SubSysSup, Opts) ->
     start_channel(Cb, Id, Args, SubSysSup, undefined, Opts).
 
 start_channel(Cb, Id, Args, SubSysSup, Exec, Opts) ->
-    ChildSpec = child_spec(Cb, Id, Args, Exec),
     ChannelSup = ssh_subsystem_sup:channel_supervisor(SubSysSup),
-    assert_limit_num_channels_not_exceeded(ChannelSup, Opts),
-    ssh_channel_sup:start_child(ChannelSup, ChildSpec).
+    case max_num_channels_not_exceeded(ChannelSup, Opts) of
+        true ->
+            ssh_channel_sup:start_child(ChannelSup, Cb, Id, Args, Exec);
+        false ->
+	    throw(max_num_channels_exceeded)
+    end.
     
-assert_limit_num_channels_not_exceeded(ChannelSup, Opts) ->
+max_num_channels_not_exceeded(ChannelSup, Opts) ->
     MaxNumChannels = ?GET_OPT(max_channels, Opts),
     NumChannels = length([x || {_,_,worker,[ssh_channel]} <- 
 				   supervisor:which_children(ChannelSup)]),
-    if 
-	%% Note that NumChannels is BEFORE starting a new one
-	NumChannels < MaxNumChannels ->
-	    ok;
-	true ->
-	    throw(max_num_channels_exceeded)
-    end.
+    %% Note that NumChannels is BEFORE starting a new one
+    NumChannels < MaxNumChannels.
 
 %%--------------------------------------------------------------------
 %%% Internal functions
@@ -874,14 +872,6 @@ check_subsystem(SsName, Options) ->
 	    Value
     end.
 
-child_spec(Callback, Id, Args, Exec) ->
-    Name = make_ref(),
-    StartFunc = {ssh_channel, start_link, [self(), Id, Callback, Args, Exec]},
-    Restart = temporary, 
-    Shutdown = 3600,
-    Type = worker,
-    {Name, StartFunc, Restart, Shutdown, Type, [ssh_channel]}.
-
 start_cli(#connection{cli_spec = no_cli}, _) ->
     {error, cli_disabled};
 start_cli(#connection{options = Options,
diff --git a/lib/ssh/src/ssh_connection_sup.erl b/lib/ssh/src/ssh_connection_sup.erl
index 60ee8b7c73..2e8450090a 100644
--- a/lib/ssh/src/ssh_connection_sup.erl
+++ b/lib/ssh/src/ssh_connection_sup.erl
@@ -52,10 +52,7 @@ init(_) ->
                 },
     ChildSpecs = [#{id       => undefined, % As simple_one_for_one is used.
                     start    => {ssh_connection_handler, start_link, []},
-                    restart  => temporary,
-                    shutdown => 4000,
-                    type     => worker,
-                    modules  => [ssh_connection_handler]
+                    restart  => temporary % because there is no way to restart a crashed connection
                    }
                  ],
     {ok, {SupFlags,ChildSpecs}}.
diff --git a/lib/ssh/src/ssh_subsystem_sup.erl b/lib/ssh/src/ssh_subsystem_sup.erl
index 8db051095c..77da240a66 100644
--- a/lib/ssh/src/ssh_subsystem_sup.erl
+++ b/lib/ssh/src/ssh_subsystem_sup.erl
@@ -74,18 +74,14 @@ ssh_connection_child_spec(Role, Address, Port, _Profile, Options) ->
     #{id       => id(Role, ssh_connection_sup, Address, Port),
       start    => {ssh_connection_sup, start_link, [Options]},
       restart  => temporary,
-      shutdown => 5000,
-      type     => supervisor,
-      modules  => [ssh_connection_sup]
+      type     => supervisor
      }.
 
 ssh_channel_child_spec(Role, Address, Port, _Profile, Options) ->
     #{id       => id(Role, ssh_channel_sup, Address, Port),
       start    => {ssh_channel_sup, start_link, [Options]},
       restart  => temporary,
-      shutdown => infinity,
-      type     => supervisor,
-      modules  => [ssh_channel_sup]
+      type     => supervisor
      }.
 
 id(Role, Sup, Address, Port) ->
diff --git a/lib/ssh/src/ssh_sup.erl b/lib/ssh/src/ssh_sup.erl
index eaec7a54e4..8183016ba5 100644
--- a/lib/ssh/src/ssh_sup.erl
+++ b/lib/ssh/src/ssh_sup.erl
@@ -36,15 +36,14 @@ init(_) ->
                  intensity =>   10,
                  period    => 3600
                 },
-    ChildSpecs = [#{id       => Module,
-                    start    => {Module, start_link, []},
-                    restart  => permanent,
-                    shutdown => 4000, %brutal_kill,
-                    type     => supervisor,
-                    modules  => [Module]
+    ChildSpecs = [#{id       => sshd_sup,
+                    start    => {sshd_sup, start_link, []},
+                    type     => supervisor
+                   },
+                  #{id       => sshc_sup,
+                    start    => {sshc_sup, start_link, []},
+                    type     => supervisor
                    }
-                  || Module <- [sshd_sup,
-                                sshc_sup]
                  ],
     {ok, {SupFlags,ChildSpecs}}.
 
diff --git a/lib/ssh/src/ssh_system_sup.erl b/lib/ssh/src/ssh_system_sup.erl
index e70abf59c2..17f990c5d8 100644
--- a/lib/ssh/src/ssh_system_sup.erl
+++ b/lib/ssh/src/ssh_system_sup.erl
@@ -63,9 +63,7 @@ init([Address, Port, Profile, Options]) ->
                 [#{id       => id(ssh_acceptor_sup, Address, Port, Profile),
                    start    => {ssh_acceptor_sup, start_link, [Address, Port, Profile, Options]},
                    restart  => transient,
-                   shutdown => infinity,
-                   type     => supervisor,
-                   modules  => [ssh_acceptor_sup]
+                   type     => supervisor
                   }];
             _ ->
                 []
@@ -124,9 +122,8 @@ start_subsystem(SystemSup, Role, Address, Port, Profile, Options) ->
         #{id       => make_ref(),
           start    => {ssh_subsystem_sup, start_link, [Role, Address, Port, Profile, Options]},
           restart  => temporary,
-          shutdown => infinity,
-          type     => supervisor,
-          modules  => [ssh_subsystem_sup]},
+          type     => supervisor
+         },
     supervisor:start_child(SystemSup, SubsystemSpec).
 
 stop_subsystem(SystemSup, SubSys) ->
diff --git a/lib/ssh/src/sshc_sup.erl b/lib/ssh/src/sshc_sup.erl
index 133b2c6450..fd4d8a3c07 100644
--- a/lib/ssh/src/sshc_sup.erl
+++ b/lib/ssh/src/sshc_sup.erl
@@ -60,10 +60,7 @@ init(_) ->
                 },
     ChildSpecs = [#{id       => undefined, % As simple_one_for_one is used.
                     start    => {ssh_connection_handler, start_link, []},
-                    restart  => temporary,
-                    shutdown => 4000,
-                    type     => worker,
-                    modules  => [ssh_connection_handler]
+                    restart  => temporary % because there is no way to restart a crashed connection
                    }
                  ],
     {ok, {SupFlags,ChildSpecs}}.
diff --git a/lib/ssh/src/sshd_sup.erl b/lib/ssh/src/sshd_sup.erl
index c23e65d955..779a861a54 100644
--- a/lib/ssh/src/sshd_sup.erl
+++ b/lib/ssh/src/sshd_sup.erl
@@ -90,10 +90,8 @@ init(_) ->
 child_spec(Address, Port, Profile, Options) ->
     #{id       => id(Address, Port, Profile),
       start    => {ssh_system_sup, start_link, [Address, Port, Profile, Options]},
-      restart  => temporary,
-      shutdown => infinity,
-      type     => supervisor,
-      modules  => [ssh_system_sup]
+      restart  => temporary, 
+      type     => supervisor
      }.
 
 id(Address, Port, Profile) ->
diff --git a/lib/ssh/test/ssh_options_SUITE.erl b/lib/ssh/test/ssh_options_SUITE.erl
index 144ec7f8fd..e1357c3a18 100644
--- a/lib/ssh/test/ssh_options_SUITE.erl
+++ b/lib/ssh/test/ssh_options_SUITE.erl
@@ -219,7 +219,9 @@ end_per_testcase(_TestCase, Config) ->
     end_per_testcase(Config).
 
 end_per_testcase(_Config) ->    
+    ct:log("~p: Before ssh:stop()",[?FUNCTION_NAME]),
     ssh:stop(),
+    ct:log("~p: After ssh:stop()",[?FUNCTION_NAME]),
     ok.
 
 %%--------------------------------------------------------------------
diff --git a/lib/ssh/test/ssh_sup_SUITE.erl b/lib/ssh/test/ssh_sup_SUITE.erl
index 3920a1c592..d453a2e143 100644
--- a/lib/ssh/test/ssh_sup_SUITE.erl
+++ b/lib/ssh/test/ssh_sup_SUITE.erl
@@ -42,7 +42,9 @@ suite() ->
 
 all() -> 
     [default_tree, sshc_subtree, sshd_subtree, sshd_subtree_profile,
-     killed_acceptor_restarts].
+     killed_acceptor_restarts,
+     shell_channel_tree
+    ].
 
 groups() -> 
     [].
@@ -246,6 +248,98 @@ killed_acceptor_restarts(Config) ->
     {error,closed} = ssh:connection_info(C2,[client_version]).
     
 %%-------------------------------------------------------------------------
+shell_channel_tree(Config) ->
+    PrivDir = proplists:get_value(priv_dir, Config),
+    UserDir = filename:join(PrivDir, nopubkey), % to make sure we don't use public-key-auth
+    file:make_dir(UserDir),
+    SysDir = proplists:get_value(data_dir, Config),
+    TimeoutShell =
+        fun() ->
+                io:format("TimeoutShell started!~n",[]),
+                timer:sleep(5000),
+                ct:pal("~p TIMEOUT!",[self()])
+        end,
+    {Daemon, Host, Port} = ssh_test_lib:daemon([{system_dir, SysDir},
+                                                {user_dir, UserDir},
+                                                {password, "morot"},
+                                                {shell, fun(_User) ->
+                                                                spawn(TimeoutShell)
+                                                        end
+                                                }
+                                            ]),
+    ConnectionRef = ssh_test_lib:connect(Host, Port, [{silently_accept_hosts, true},
+						      {user, "foo"},
+						      {password, "morot"},
+						      {user_interaction, true},
+						      {user_dir, UserDir}]),
+
+    [ChannelSup|_] = Sups0 = chk_empty_con_daemon(Daemon),
+    
+    {ok, ChannelId0} = ssh_connection:session_channel(ConnectionRef, infinity),
+    ok = ssh_connection:shell(ConnectionRef,ChannelId0),
+
+    ?wait_match([{_, GroupPid,worker,[ssh_channel]}],
+		supervisor:which_children(ChannelSup),
+               [GroupPid]),
+    {links,GroupLinks} = erlang:process_info(GroupPid, links),
+    [ShellPid] = GroupLinks--[ChannelSup],
+    ct:pal("GroupPid = ~p, ShellPid = ~p",[GroupPid,ShellPid]),
+
+    receive
+        {ssh_cm,ConnectionRef, {data, ChannelId0, 0, <<"TimeoutShell started!\r\n">>}} ->
+            receive
+                %%---- wait for the subsystem to terminate
+                {ssh_cm,ConnectionRef,{closed,ChannelId0}} ->
+                    ct:pal("Subsystem terminated",[]),
+                    case {chk_empty_con_daemon(Daemon),
+                          process_info(GroupPid),
+                          process_info(ShellPid)} of
+                        {Sups0, undefined, undefined} ->
+                            %% SUCCESS
+                            ssh:stop_daemon(Daemon);
+                        {Sups0, _, undefined}  ->
+                            ssh:stop_daemon(Daemon),
+                            ct:fail("Group proc lives!");
+                        {Sups0, undefined, _}  ->
+                            ssh:stop_daemon(Daemon),
+                            ct:fail("Shell proc lives!");
+                        _ ->
+                            ssh:stop_daemon(Daemon),
+                            ct:fail("Sup tree changed!")
+                    end
+            after 10000 ->
+                    ssh:close(ConnectionRef),
+                    ssh:stop_daemon(Daemon),
+                    ct:fail("CLI Timeout")
+            end
+    after 10000 ->
+            ssh:close(ConnectionRef),
+            ssh:stop_daemon(Daemon),
+            ct:fail("CLI Timeout")
+    end.
+
+
+chk_empty_con_daemon(Daemon) ->
+    ?wait_match([{_,SubSysSup, supervisor,[ssh_subsystem_sup]},
+		 {{ssh_acceptor_sup,_,_,_}, AccSup, supervisor,[ssh_acceptor_sup]}],
+		supervisor:which_children(Daemon),
+                [SubSysSup,AccSup]),
+    ?wait_match([{{server,ssh_connection_sup, _,_},
+		  ConnectionSup, supervisor,
+		  [ssh_connection_sup]},
+		 {{server,ssh_channel_sup,_ ,_},
+		  ChannelSup,supervisor,
+		  [ssh_channel_sup]}],
+		supervisor:which_children(SubSysSup),
+		[ConnectionSup,ChannelSup]),
+    ?wait_match([{{ssh_acceptor_sup,_,_,_},_,worker,[ssh_acceptor]}],
+		supervisor:which_children(AccSup)),
+    ?wait_match([{_, _, worker,[ssh_connection_handler]}],
+		supervisor:which_children(ConnectionSup)),
+    ?wait_match([], supervisor:which_children(ChannelSup)),
+    [ChannelSup, ConnectionSup, SubSysSup, AccSup].
+
+%%-------------------------------------------------------------------------
 %% Help functions
 %%-------------------------------------------------------------------------
 check_sshd_system_tree(Daemon, Config) ->