From a40fba5e293001636fbd7751fa805d9f9c933ee4 Mon Sep 17 00:00:00 2001 From: Greg Dubicki Date: Sun, 27 Aug 2017 10:23:59 +0200 Subject: [PATCH] Add CaptureCommandOutputOnError to include stdout & stderror in failed executions, with docs. --- docs/Hook-Definition.md | 1 + hook/hook.go | 1 + webhook.go | 8 ++++++-- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/Hook-Definition.md b/docs/Hook-Definition.md index a15baa2..929e922 100644 --- a/docs/Hook-Definition.md +++ b/docs/Hook-Definition.md @@ -9,6 +9,7 @@ Hooks are defined as JSON objects. Please note that in order to be considered va * `response-message` - specifies the string that will be returned to the hook initiator * `response-headers` - specifies the list of headers in format `{"name": "X-Example-Header", "value": "it works"}` that will be returned in HTTP response for the hook * `include-command-output-in-response` - boolean whether webhook should wait for the command to finish and return the raw output as a response to the hook initiator. If the command fails to execute or encounters any errors while executing the response will result in 500 Internal Server Error HTTP status code, otherwise the 200 OK status code will be returned. + * `include-command-output-in-response-on-error` - boolean whether webhook should include command stdout & stderror as a response in failed executions. It only works if `include-command-output-in-response` is set to `true`. * `parse-parameters-as-json` - specifies the list of arguments that contain JSON strings. These parameters will be decoded by webhook and you can access them like regular objects in rules and `pass-arguments-to-command`. * `pass-arguments-to-command` - specifies the list of arguments that will be passed to the command. Check [Referencing request values page](Referencing-Request-Values) to see how to reference the values from the request. If you want to pass a static string value to your command you can specify it as `{ "source": "string", "name": "argumentvalue" }` diff --git a/hook/hook.go b/hook/hook.go index b4eae95..7fd8c1f 100644 --- a/hook/hook.go +++ b/hook/hook.go @@ -384,6 +384,7 @@ type Hook struct { ResponseMessage string `json:"response-message,omitempty"` ResponseHeaders ResponseHeaders `json:"response-headers,omitempty"` CaptureCommandOutput bool `json:"include-command-output-in-response,omitempty"` + CaptureCommandOutputOnError bool `json:"include-command-output-in-response-on-error,omitempty"` PassEnvironmentToCommand []Argument `json:"pass-environment-to-command,omitempty"` PassArgumentsToCommand []Argument `json:"pass-arguments-to-command,omitempty"` PassFileToCommand []Argument `json:"pass-file-to-command,omitempty"` diff --git a/webhook.go b/webhook.go index 4df45f8..8a318ee 100644 --- a/webhook.go +++ b/webhook.go @@ -282,9 +282,13 @@ func hookHandler(w http.ResponseWriter, r *http.Request) { response, err := handleHook(matchedHook, rid, &headers, &query, &payload, &body) if err != nil { - w.Header().Set("Content-Type", "text/plain; charset=utf-8") w.WriteHeader(http.StatusInternalServerError) - fmt.Fprintf(w, "Error occurred while executing the hook's command. Please check your logs for more details.") + if matchedHook.CaptureCommandOutputOnError { + fmt.Fprintf(w, response) + } else { + w.Header().Set("Content-Type", "text/plain; charset=utf-8") + fmt.Fprintf(w, "Error occurred while executing the hook's command. Please check your logs for more details.") + } } else { fmt.Fprintf(w, response) }