Skip to content

Add ability to stream command output as a response (fixes conflict #443) #549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions internal/hook/hook.go
Original file line number Diff line number Diff line change
@@ -570,6 +570,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"`
StreamCommandOutput bool `json:"stream-command-output,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"`
50 changes: 42 additions & 8 deletions webhook.go
Original file line number Diff line number Diff line change
@@ -5,6 +5,7 @@ import (
"encoding/json"
"flag"
"fmt"
"io"
"io/ioutil"
"log"
"net"
@@ -63,6 +64,19 @@ var (
pidFile *pidfile.PIDFile
)

type flushWriter struct {
f http.Flusher
w io.Writer
}

func (fw *flushWriter) Write(p []byte) (n int, err error) {
n, err = fw.w.Write(p)
if fw.f != nil {
fw.f.Flush()
}
return
}

func matchLoadedHook(id string) *hook.Hook {
for _, hooks := range loadedHooksFromFiles {
if hook := hooks.Match(id); hook != nil {
@@ -504,8 +518,10 @@ func hookHandler(w http.ResponseWriter, r *http.Request) {
w.Header().Set(responseHeader.Name, responseHeader.Value)
}

if matchedHook.CaptureCommandOutput {
response, err := handleHook(matchedHook, req)
if matchedHook.StreamCommandOutput {
handleHook(matchedHook, req, w)
} else if matchedHook.CaptureCommandOutput {
response, err := handleHook(matchedHook, req, nil)

if err != nil {
w.WriteHeader(http.StatusInternalServerError)
@@ -523,7 +539,7 @@ func hookHandler(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, response)
}
} else {
go handleHook(matchedHook, req)
go handleHook(matchedHook, req, nil)

// Check if a success return code is configured for the hook
if matchedHook.SuccessHttpResponseCode != 0 {
@@ -546,7 +562,7 @@ func hookHandler(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "Hook rules were not satisfied.")
}

func handleHook(h *hook.Hook, r *hook.Request) (string, error) {
func handleHook(h *hook.Hook, r *hook.Request, w http.ResponseWriter) (string, error) {
var errors []error

// check the command exists
@@ -615,12 +631,30 @@ func handleHook(h *hook.Hook, r *hook.Request) (string, error) {

log.Printf("[%s] executing %s (%s) with arguments %q and environment %s using %s as cwd\n", r.ID, h.ExecuteCommand, cmd.Path, cmd.Args, envs, cmd.Dir)

out, err := cmd.CombinedOutput()
var out []byte
if w != nil {
log.Printf("[%s] command output will be streamed to response", r.ID)

log.Printf("[%s] command output: %s\n", r.ID, out)
// Implementation from https://play.golang.org/p/PpbPyXbtEs
// as described in https://stackoverflow.com/questions/19292113/not-buffered-http-responsewritter-in-golang
fw := flushWriter{w: w}
if f, ok := w.(http.Flusher); ok {
fw.f = f
}
cmd.Stderr = &fw
cmd.Stdout = &fw

if err != nil {
log.Printf("[%s] error occurred: %+v\n", r.ID, err)
if err := cmd.Run(); err != nil {
log.Printf("[%s] error occurred: %+v\n", r.ID, err)
}
} else {
out, err = cmd.CombinedOutput()

log.Printf("[%s] command output: %s\n", r.ID, out)

if err != nil {
log.Printf("[%s] error occurred: %+v\n", r.ID, err)
}
}

for i := range files {
2 changes: 1 addition & 1 deletion webhook_test.go
Original file line number Diff line number Diff line change
@@ -58,7 +58,7 @@ func TestStaticParams(t *testing.T) {
ID: "test",
Headers: spHeaders,
}
_, err = handleHook(spHook, r)
_, err = handleHook(spHook, r, nil)
if err != nil {
t.Fatalf("Unexpected error: %v\n", err)
}