Merge lp:~javier.collado/utah/bug1160247 into lp:utah

[Javier Collado]

I haven't been able to reproduce the problem, but I've seen that the SIGTERM
handler was raising a UTAHException and that there are lots of places in which
`UTAHException`s might be caught. Hence, the handler has been updated to call
`sys.exit` which raises `SystemExit`.

In addition to this, to make sure that `SystemExit` isn't caught anywhere in
the code, the catch all except clauses like this:
except:

have been replaced with:
except Exception:

this ensures that all exception except `SystemExit` are caught, that is, when
SIGTERM is received the server process exits as soon as possible running any
cleanup code in the `finally` clauses that might be around.

[Andy Doan (doanac)]

review: Approve

[Max Brustkern (nuclearbob)]

Looks good to me.

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2013-04-03 09:45:19 +0000
+++ debian/changelog	2013-04-03 15:00:38 +0000
@@ -5,6 +5,7 @@
   * Stop server on installation failure (LP: #1161855)
   * Check group after command line argument parsing (LP: #1126219)
   * Added INVALID_USER return code (LP: #1160032)
+  * Use sys.exit when SIGTERM is received (LP: #1160247)
 
  -- Javier Collado <[e-mail]>  Wed, 27 Mar 2013 13:00:47 +0100
 

=== modified file 'examples/run_install_test.py'
--- examples/run_install_test.py	2013-04-01 11:56:16 +0000
+++ examples/run_install_test.py	2013-04-03 15:00:38 +0000
@@ -82,7 +82,7 @@
     except UTAHException as error:
         sys.stderr.write('Exception: ' + str(error))
         exitstatus = ReturnCodes.UTAH_EXCEPTION_ERROR
-    except:
+    except Exception:
         logging.exception('Unhandled error in UTAH')
         exitstatus = ReturnCodes.UNHANDLED_ERROR
     finally:

=== modified file 'examples/run_test_bamboo_feeder.py'
--- examples/run_test_bamboo_feeder.py	2013-04-01 11:56:16 +0000
+++ examples/run_test_bamboo_feeder.py	2013-04-03 15:00:38 +0000
@@ -89,7 +89,7 @@
         except (AttributeError, NameError):
             sys.stderr.write(mesg)
         exitstatus = ReturnCodes.UTAH_EXCEPTION_ERROR
-    except:
+    except Exception:
         logging.exception('Unhandled error in UTAH')
         exitstatus = ReturnCodes.UNHANDLED_ERROR
     finally:

=== modified file 'examples/run_test_cobbler.py'
--- examples/run_test_cobbler.py	2013-04-01 11:56:16 +0000
+++ examples/run_test_cobbler.py	2013-04-03 15:00:38 +0000
@@ -94,7 +94,7 @@
         except (AttributeError, NameError):
             sys.stderr.write(mesg)
         exitstatus = ReturnCodes.UTAH_EXCEPTION_ERROR
-    except:
+    except Exception:
         logging.exception('Unhandled error in UTAH')
         exitstatus = ReturnCodes.UNHANDLED_ERROR
     finally:

=== modified file 'examples/run_test_vm.py'
--- examples/run_test_vm.py	2013-04-01 11:56:16 +0000
+++ examples/run_test_vm.py	2013-04-03 15:00:38 +0000
@@ -76,7 +76,7 @@
     except UTAHException as error:
         sys.stderr.write('Exception: ' + str(error))
         exitstatus = ReturnCodes.UTAH_EXCEPTION_ERROR
-    except:
+    except Exception:
         logging.exception('Unhandled error in UTAH')
         exitstatus = ReturnCodes.UNHANDLED_ERROR
     finally:

=== modified file 'examples/run_utah_tests.py'
--- examples/run_utah_tests.py	2013-04-01 11:56:16 +0000
+++ examples/run_utah_tests.py	2013-04-03 15:00:38 +0000
@@ -98,7 +98,7 @@
             except UTAHException as error:
                 sys.stderr.write('Exception: ' + str(error))
                 exitstatus = ReturnCodes.UTAH_EXCEPTION_ERROR
-            except:
+            except Exception:
                 logging.exception('Unhandled error in UTAH')
                 exitstatus = ReturnCodes.UNHANDLED_ERROR
             finally:

=== modified file 'utah/cleanup.py'
--- utah/cleanup.py	2013-03-29 09:01:21 +0000
+++ utah/cleanup.py	2013-04-03 15:00:38 +0000
@@ -88,7 +88,7 @@
         # process is completed as much as possible
         try:
             ProcessRunner(command)
-        except:
+        except Exception:
             self.logger.error('Cleanup error: {}'
                               .format(traceback.format_exc()))
         finally:

=== modified file 'utah/run.py'
--- utah/run.py	2013-03-27 11:55:17 +0000
+++ utah/run.py	2013-04-03 15:00:38 +0000
@@ -18,12 +18,13 @@
 """
 import logging
 import os
-import time
-import urllib
-import traceback
 import shutil
 import signal
 import socket
+import sys
+import time
+import traceback
+import urllib
 
 from utah import config
 from utah.exceptions import UTAHException
@@ -41,6 +42,7 @@
     TIMEOUT_ERROR = 2  # Unable to complete before config.jobtimeout seconds
     GROUP_ERROR = 3  # User isn't in UTAH group
     UNHANDLED_ERROR = 4  # Non UTAH exception caught
+    SIGTERM_RECEIVED = 5  # SIGTERM signal received
 
     @staticmethod
     def client_error(returncode):
@@ -372,7 +374,8 @@
     """
     def handler(signum, frame):
         """Raise exception when signal is received."""
-        raise UTAHException('Signal received: {}'.format(signum))
+        logging.warning('Signal received: %d', signum)
+        sys.exit(ReturnCodes.SIGTERM_RECEIVED)
 
     signal.signal(signal.SIGTERM, handler)