Merge pull request #297 from DeLaGuardo/main

Collect exceptions caught during shutdown

CHANGELOG.md

@@ -1,3 +1,30 @@
+## 3.2.0-SNAPSHOT
+
+This is a minor feature release
+
+* Backward compatible changes to the signature of `puppetlabs.trapperkeeper.internal/shutdown!` function. Returns collection of exceptions caught during execution of shutdown sequence instead of nil.
+* Extend `stop` method of `puppetlabs.trapperkeeper.app/TrapperkeeperApp` protocol with an argument `throw?` to handle cases where exceptions in shutdown sequence should be rethrown.
+* Change default behavior of `puppetlabs.trapperkeeper.testutils.bootstrap` helper macroses to throw exception when shutdown finished abruptly.
+
+## 3.1.1
+
+This is a maintenance release
+
+* Updates to current clj-parent
+
+## 3.1.0
+
+This is a minor feature release
+
+* [PDB-4636](https://github.com/puppetlabs/trapperkeeper/pull/287) - support custom exit status/messages
+
+## 3.0.0
+
+This is a maintenance release
+
+* Updates to current clj-parent to clean up project.clj and update dependencies
+* Tests changes for readability and compatibility with Java11
+
 ## 2.0.1
 
 This is a maintenance release

project.clj

@@ -1,4 +1,4 @@
-(defproject puppetlabs/trapperkeeper "3.1.2-SNAPSHOT"
+(defproject puppetlabs/trapperkeeper "3.2.0-SNAPSHOT"
   :description "A framework for configuring, composing, and running Clojure services."
 
   :license {:name "Apache License, Version 2.0"

src/puppetlabs/trapperkeeper/app.clj

@@ -38,5 +38,5 @@
                                  "occurred, return the input parameter."))
   (init [this] "Initialize the services")
   (start [this] "Start the services")
-  (stop [this] "Stop the services")
-  (restart [this] "Stop and restart the services"))
+  (stop [this] [this throw?] "Stop the services")
+  (restart [this] "Stop and restart the services"))

src/puppetlabs/trapperkeeper/internal.clj

@@ -448,24 +448,36 @@
     (shutdown-on-error [this svc-id f] (shutdown-on-error* shutdown-reason-promise app-context svc-id f))
     (shutdown-on-error [this svc-id f on-error] (shutdown-on-error* shutdown-reason-promise app-context svc-id f on-error))))
 
-(schema/defn ^:always-validate shutdown!
+(schema/defn ^:always-validate shutdown! :- [Throwable]
   "Perform shutdown calling the `stop` lifecycle function on each service,
-   in reverse order (to account for dependency relationships)."
+   in reverse order (to account for dependency relationships).
+   Returns collection of exceptions thrown during shutdown sequence execution."
   [app-context :- (schema/atom a/TrapperkeeperAppContext)]
   (log/info (i18n/trs "Beginning shutdown sequence"))
   (let [{:keys [ordered-services shutdown-channel lifecycle-worker]} @app-context
-        shutdown-fn (fn [] (doseq [[service-id s] (reverse ordered-services)]
-                             (try
-                               (run-lifecycle-fn! app-context s/stop "stop" service-id s)
-                               (catch Exception e
-                                 (log/error e (i18n/trs "Encountered error during shutdown sequence"))))))]
+        errors-chan (async/promise-chan)
+        shutdown-fn (fn [] (let [results
+                                 (doall
+                                  (keep
+                                   (fn [[service-id s]]
+                                     (try
+                                       (run-lifecycle-fn! app-context s/stop "stop" service-id s)
+                                       nil
+                                       (catch Exception e
+                                         (log/error e (i18n/trs "Encountered error during shutdown sequence"))
+                                         e)))
+                                   (reverse ordered-services)))]
+                             (async/put! errors-chan results)))]
     (log/trace (i18n/trs "Putting shutdown message on shutdown channel."))
     (async/>!! shutdown-channel {:type :shutdown
                                  :task-function shutdown-fn})
     ;; wait for the channel to send us the return value so we know it's done
     (log/trace (i18n/trs "Waiting for response to shutdown message from lifecycle worker."))
     (if (not (nil? (async/<!! lifecycle-worker)))
-      (log/info (i18n/trs "Finished shutdown sequence"))
+      (do
+        (log/info (i18n/trs "Finished shutdown sequence"))
+        ;; deliver errors from stopped services if any
+        (async/<!! errors-chan))
       ;; else, the read from the channel returned a nil because it was closed,
       ;; indicating that there was already a shutdown in progress, and thus the
       ;; redundant shutdown request was ignored
@@ -606,8 +618,14 @@
         (inc-restart-counter! this)
         this)
       (a/stop [this]
-        (shutdown! app-context)
-        this)
+        (a/stop this false))
+      (a/stop [this throw?]
+        (let [errors (shutdown! app-context)]
+          (if (and throw? (seq errors))
+            (let [msg (i18n/trs "Error during app shutdown!")]
+              (log/error msg)
+              (throw (ex-info msg {:errors errors})))
+            this)))
       (a/restart [this]
         (try
           (run-lifecycle-fns app-context s/stop "stop" (reverse ordered-services))

test/puppetlabs/trapperkeeper/shutdown_test.clj

@@ -62,7 +62,8 @@
           app               (bootstrap-services-with-empty-config [test-service broken-service])]
       (is (false? @shutdown-called?))
       (logging/with-test-logging
-        (internal/shutdown! (app-context app))
+        (let [errors (internal/shutdown! (app-context app))]
+          (is (= '("dangit") (map #(.getMessage ^Throwable %) errors))))
         (is (logged? #"Encountered error during shutdown sequence" :error)))
       (is (true? @shutdown-called?)))))
 

test/puppetlabs/trapperkeeper/testutils/bootstrap.clj

@@ -22,7 +22,7 @@
        (try
          ~@body
          (finally
-           (tk-app/stop ~app))))))
+           (tk-app/stop ~app true))))))
 
 (defn bootstrap-services-with-cli-data
   [services cli-data]
@@ -37,7 +37,7 @@
        (try
          ~@body
          (finally
-           (tk-app/stop ~app))))))
+           (tk-app/stop ~app true))))))
 
 (defn bootstrap-services-with-cli-args
   [services cli-args]
@@ -51,7 +51,7 @@
        (try
          ~@body
          (finally
-           (tk-app/stop ~app))))))
+           (tk-app/stop ~app true))))))
 
 (defn bootstrap-services-with-empty-config
   [services]
@@ -64,7 +64,7 @@
        (try
          ~@body
          (finally
-           (tk-app/stop ~app))))))
+           (tk-app/stop ~app true))))))
 
 (defn bootstrap-with-empty-config
   ([]