From 80b2451e43972ef7a1a177b8632f3bf952f3a8c7 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Juraj=20Linke=C5=A1?= <juraj.linkes@pantheon.tech>
Date: Tue, 23 Mar 2021 08:46:16 +0100
Subject: [PATCH] FrameworkSetup: catch all exceptions in threads
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

Any uncaught exception in a thread running setup_node or cleanup_node
will prevent the result of that thread's execution from being passed
to the main thread. Since the main thread assumes there will be a result
for each thread, this leads to false positives. Catch all exceptions
in those background threads to fix this.

Change-Id: I64013dfc671e576290c8376a58c754ed21b9ba3e
Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>
---
 resources/libraries/python/SetupFramework.py | 47 +++++++++++++++++++---------
 1 file changed, 32 insertions(+), 15 deletions(-)

diff --git a/resources/libraries/python/SetupFramework.py b/resources/libraries/python/SetupFramework.py
index 7e3b36cc77..c27dbe08c2 100644
--- a/resources/libraries/python/SetupFramework.py
+++ b/resources/libraries/python/SetupFramework.py
@@ -17,9 +17,9 @@ supposed to end up here.
 """
 
 from os import environ, remove
-import socket  # For catching socket.timeout.
 from tempfile import NamedTemporaryFile
 import threading
+import traceback
 
 from robot.api import logger
 
@@ -140,17 +140,19 @@ def create_env_directory_at_node(node):
     )
 
 
-def setup_node(node, tarball, remote_tarball, results=None):
+def setup_node(node, tarball, remote_tarball, results=None, logs=None):
     """Copy a tarball to a node and extract it.
 
     :param node: A node where the tarball will be copied and extracted.
     :param tarball: Local path of tarball to be copied.
     :param remote_tarball: Remote path of the tarball.
     :param results: A list where to store the result of node setup, optional.
+    :param logs: A list where to store anything that should be logged.
     :type node: dict
     :type tarball: str
     :type remote_tarball: str
     :type results: list
+    :type logs: list
     :returns: True - success, False - error
     :rtype: bool
     """
@@ -159,11 +161,14 @@ def setup_node(node, tarball, remote_tarball, results=None):
         extract_tarball_at_node(remote_tarball, node)
         if node[u"type"] == NodeType.TG:
             create_env_directory_at_node(node)
-    except (RuntimeError, socket.timeout) as exc:
-        logger.console(
-            f"Node {node[u'type']} host {node[u'host']}, port {node[u'port']} "
-            f"setup failed, error: {exc!r}"
-        )
+    except Exception:
+        # any exception must result in result = False
+        # since this runs in a thread and can't be caught anywhere else
+        err_msg = f"Node {node[u'type']} host {node[u'host']}, " \
+                  f"port {node[u'port']} setup failed."
+        logger.console(err_msg)
+        if isinstance(logs, list):
+            logs.append(f"{err_msg} Exception: {traceback.format_exc()}")
         result = False
     else:
         logger.console(
@@ -209,23 +214,26 @@ def delete_framework_dir(node):
     )
 
 
-def cleanup_node(node, results=None):
+def cleanup_node(node, results=None, logs=None):
     """Delete a tarball from a node.
 
     :param node: A node where the tarball will be delete.
     :param results: A list where to store the result of node cleanup, optional.
+    :param logs: A list where to store anything that should be logged.
     :type node: dict
     :type results: list
+    :type logs: list
     :returns: True - success, False - error
     :rtype: bool
     """
     try:
         delete_framework_dir(node)
-    except RuntimeError:
-        logger.error(
-            f"Cleanup of node {node[u'type']} host {node[u'host']}, "
-            f"port {node[u'port']} failed."
-        )
+    except Exception:
+        err_msg = f"Cleanup of node {node[u'type']} host {node[u'host']}, " \
+                  f"port {node[u'port']} failed."
+        logger.console(err_msg)
+        if isinstance(logs, list):
+            logs.append(f"{err_msg} Exception: {traceback.format_exc()}")
         result = False
     else:
         logger.console(
@@ -263,10 +271,11 @@ class SetupFramework:
         remote_tarball = f"{tarball}"
 
         results = list()
+        logs = list()
         threads = list()
 
         for node in nodes.values():
-            args = node, tarball, remote_tarball, results
+            args = node, tarball, remote_tarball, results, logs
             thread = threading.Thread(target=setup_node, args=args)
             thread.start()
             threads.append(thread)
@@ -280,6 +289,9 @@ class SetupFramework:
 
         logger.info(f"Results: {results}")
 
+        for log in logs:
+            logger.trace(log)
+
         delete_local_tarball(tarball)
         if all(results):
             logger.console(u"All nodes are ready.")
@@ -305,10 +317,12 @@ class CleanupFramework:
         """
 
         results = list()
+        logs = list()
         threads = list()
 
         for node in nodes.values():
-            thread = threading.Thread(target=cleanup_node, args=(node, results))
+            thread = threading.Thread(target=cleanup_node,
+                                      args=(node, results, logs))
             thread.start()
             threads.append(thread)
 
@@ -321,6 +335,9 @@ class CleanupFramework:
 
         logger.info(f"Results: {results}")
 
+        for log in logs:
+            logger.trace(log)
+
         if all(results):
             logger.console(u"All nodes cleaned up.")
         else:
-- 
2.16.6