From 0d0d8091ac06e91d2409bcd4d7ecfc90ac13e45a Mon Sep 17 00:00:00 2001
From: "Owen W. Taylor" <otaylor@fishsoup.net>
Date: Fri, 22 Jan 2021 15:12:10 -0500
Subject: [PATCH] test_build: leave Control-C working

Two problems occurred with the moksha/twisted handling of SIGINT:

 * While KeyboardInterrupt caused the moksha loop to exit, it just
   left the test in a confused state, instead of triggering standard
   pytest behavior and aborting the entire test run.
 * The handler was left-over for remaining tests that prevent Control-C
   from working at all.

Fix that by using mock.patch to override moksha's signal handler with
our own signal handler that stores the KeyboardInterrupt in the
current EventTrap, and restores the default signal handler after
the loop ends.

Note that since the KeyboardInterrupt is always handled in the main thread,
we don't get a useful backtrace from the child thread.
---
 tests/test_build/test_build.py | 54 ++++++++++++++++++++++------------
 1 file changed, 36 insertions(+), 18 deletions(-)

diff --git a/tests/test_build/test_build.py b/tests/test_build/test_build.py
index a7e3a3f2..df5fb56a 100644
--- a/tests/test_build/test_build.py
+++ b/tests/test_build/test_build.py
@@ -10,6 +10,7 @@ from os import path, mkdir
 from os.path import dirname
 import re
 import sched
+import signal
 from random import randint
 from shutil import copyfile
 
@@ -118,25 +119,42 @@ def main(initial_messages, stop_condition):
 
     consumers = [module_build_service.scheduler.consumer.MBSConsumer]
 
-    # The events.EventTrap context handler allows us to detect exceptions
-    # in event handlers and re-raise them here so that tests fail usefully
-    # rather than just hang.
-    with events.EventTrap() as trap:
-        # Note that the hub we kick off here cannot send any message.  You
-        # should use fedmsg.publish(...) still for that.
-        moksha.hub.main(
-            # Pass in our config dict
-            options=config,
-            # Only run the specified consumers if any are so specified.
-            consumers=consumers,
-            # Do not run default producers.
-            producers=[],
-            # Tell moksha to quiet its logging.
-            framework=False,
-        )
+    old_run = moksha.hub.reactor.reactor.run
+    old_sigint_handler = signal.getsignal(signal.SIGINT)
 
-        if trap.exception:
-            raise trap.exception
+    def trap_sigint(self, *args):
+        try:
+            raise KeyboardInterrupt()
+        except KeyboardInterrupt as e:
+            events.EventTrap.set_exception(e)
+
+    def set_signals_and_run(*args, **kwargs):
+        signal.signal(signal.SIGINT, trap_sigint)
+        try:
+            old_run(*args, **kwargs)
+        finally:
+            signal.signal(signal.SIGINT, old_sigint_handler)
+
+    with patch('moksha.hub.reactor.reactor.run', set_signals_and_run):
+        # The events.EventTrap context handler allows us to detect exceptions
+        # in event handlers and re-raise them here so that tests fail usefully
+        # rather than just hang.
+        with events.EventTrap() as trap:
+            # Note that the hub we kick off here cannot send any message.  You
+            # should use fedmsg.publish(...) still for that.
+            moksha.hub.main(
+                # Pass in our config dict
+                options=config,
+                # Only run the specified consumers if any are so specified.
+                consumers=consumers,
+                # Do not run default producers.
+                producers=[],
+                # Tell moksha to quiet its logging.
+                framework=False,
+            )
+
+            if trap.exception:
+                raise trap.exception
 
 
 class FakeSCM(object):