[change] More meaningful message on CommandTimeoutException

Author: Alexandre Vincent

openwisp_controller/connection/connectors/ssh.py

@@ -149,7 +149,7 @@ def _connect(self, address):
                     auth_timeout=app_settings.SSH_AUTH_TIMEOUT,
                     banner_timeout=app_settings.SSH_BANNER_TIMEOUT,
                     timeout=app_settings.SSH_CONNECTION_TIMEOUT,
-                    **params
+                    **params,
                 )
             except paramiko.ssh_exception.AuthenticationException as e:
                 # the authentication failure may be caused by the issue
@@ -207,7 +207,7 @@ def exec_command(
         if not stdout.channel.status_event.wait(
             timeout=timeout - (time.perf_counter() - start_cmd)
         ):
-            log_message = "Command timeout exceeded."
+            log_message = f"Command timed out after {timeout} seconds."
             logger.info(log_message)
             raise CommandTimeoutException(log_message)
 

openwisp_controller/connection/tasks.py

@@ -79,7 +79,7 @@ def launch_command(command_id):
         command.save()
     except CommandTimeoutException as e:
         command.status = "failed"
-        command._add_output(_(f"{e}"))
+        command._add_output(_(f"The command took longer than expected: {e}"))
         command.save()
     except Exception as e:
         logger.exception(

openwisp_controller/connection/tests/test_ssh.py

@@ -79,7 +79,7 @@ def test_connection_command_timeout(self, mocked_debug, mocked_info):
         with self.assertRaises(Exception) as ctx:
             # timeout of 0.0 is a special case in paramiko -> we check for 0.01 instead
             dc.connector_instance.exec_command("sleep 1", timeout=0.01)
-        log_message = "Command timeout exceeded."
+        log_message = "Command timed out after 0.01 seconds."
         mocked_info.assert_has_calls([mock.call(log_message)])
         self.assertEqual(str(ctx.exception), log_message)