-
Notifications
You must be signed in to change notification settings - Fork 81
/
job.go
275 lines (244 loc) · 6.11 KB
/
job.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
package hook
import (
"bufio"
"bytes"
"fmt"
"io"
"log/slog"
"os"
"os/exec"
"path"
"strconv"
"strings"
"sync"
"sync/atomic"
"syscall"
"time"
"github.com/ncarlier/webhookd/pkg/helper"
"github.com/ncarlier/webhookd/pkg/logger"
)
var hookID uint64
// Job a hook job
type Job struct {
id uint64
name string
script string
method string
payload string
args []string
MessageChan chan []byte
timeout int
start time.Time
status Status
logFilename string
err error
mutex sync.Mutex
}
// NewHookJob creates new hook job
func NewHookJob(request *Request) (*Job, error) {
job := &Job{
id: atomic.AddUint64(&hookID, 1),
name: request.Name,
script: request.Script,
method: request.Method,
payload: request.Payload,
args: request.Args,
timeout: request.Timeout,
MessageChan: make(chan []byte),
status: Idle,
}
job.logFilename = path.Join(request.OutputDir, fmt.Sprintf("%s_%d_%s.txt", helper.ToSnake(job.name), job.id, time.Now().Format("20060102_1504")))
return job, nil
}
// ID returns job ID
func (job *Job) ID() uint64 {
return job.id
}
// Name returns job name
func (job *Job) Name() string {
return job.name
}
// Err returns job error
func (job *Job) Err() error {
return job.err
}
// Meta returns job meta
func (job *Job) Meta() []string {
return []string{
"hook_id=" + strconv.FormatUint(job.id, 10),
"hook_name=" + job.name,
"hook_method=" + job.method,
}
}
// Terminate set job as terminated
func (job *Job) Terminate(err error) error {
job.mutex.Lock()
defer job.mutex.Unlock()
job.status = Success
if err != nil {
job.status = Error
job.err = err
slog.Error(
"hook executed",
"hook", job.Name(),
"id", job.ID(),
"status", "error",
"err", err,
"took", time.Since(job.start).Milliseconds(),
)
return err
}
slog.Info(
"hook executed",
"hook", job.Name(),
"id", job.ID(),
"status", "success",
"took", time.Since(job.start).Milliseconds(),
)
return nil
}
// IsTerminated ask if the job is terminated
func (job *Job) IsTerminated() bool {
job.mutex.Lock()
defer job.mutex.Unlock()
return job.status == Success || job.status == Error
}
// Status get job status
func (job *Job) Status() Status {
return job.status
}
// StatusLabel return job status as string
func (job *Job) StatusLabel() string {
switch job.status {
case Error:
return "error"
case Success:
return "success"
case Running:
return "running"
default:
return "idle"
}
}
// SendMessage send message to the message channel
func (job *Job) SendMessage(message string) {
job.MessageChan <- []byte(message)
}
// Logs returns job logs filtered with the prefix
func (job *Job) Logs(prefixFilter string) string {
file, err := os.Open(job.logFilename)
if err != nil {
return err.Error()
}
defer file.Close()
var result bytes.Buffer
scanner := bufio.NewScanner(file)
for scanner.Scan() {
line := scanner.Text()
if strings.HasPrefix(line, prefixFilter) {
line = strings.TrimPrefix(line, prefixFilter)
line = strings.TrimLeft(line, " ")
result.WriteString(line + "\n")
}
}
if err := scanner.Err(); err != nil {
return err.Error()
}
return result.String()
}
// Close job message chan
func (job *Job) Close() {
close(job.MessageChan)
}
// Run hook job
func (job *Job) Run() error {
if job.status != Idle {
return fmt.Errorf("unable to run job: status=%s", job.StatusLabel())
}
job.status = Running
job.start = time.Now()
slog.Info("executing hook...", "hook", job.name, "id", job.id)
binary, err := exec.LookPath(job.script)
if err != nil {
return job.Terminate(err)
}
// Exec script with parameter...
cmd := exec.Command(binary, job.payload)
// with env variables and hook arguments...
cmd.Env = append(os.Environ(), job.args...)
// and hook meta...
cmd.Env = append(cmd.Env, job.Meta()...)
// using a process group...
cmd.SysProcAttr = &syscall.SysProcAttr{Setpgid: true}
// Open the log file for writing
logFile, err := os.Create(job.logFilename)
if err != nil {
return job.Terminate(err)
}
defer logFile.Close()
slog.Debug("hook details", "hook", job.name, "id", job.id, "script", job.script, "args", job.args, "output", logFile.Name())
wLogFile := bufio.NewWriter(logFile)
defer wLogFile.Flush()
// Combine cmd stdout and stderr
outReader, err := cmd.StdoutPipe()
if err != nil {
return job.Terminate(err)
}
errReader, err := cmd.StderrPipe()
if err != nil {
return job.Terminate(err)
}
cmdReader := io.MultiReader(outReader, errReader)
// Start the script...
err = cmd.Start()
if err != nil {
return job.Terminate(err)
}
// Create wait group to wait for command output completion
var wg sync.WaitGroup
wg.Add(1)
// Write script output to log file and the work message channel
go func(reader io.Reader) {
scanner := bufio.NewScanner(reader)
for scanner.Scan() {
line := scanner.Text()
// writing to the work channel
if !job.IsTerminated() {
job.MessageChan <- []byte(line)
} else {
slog.Error("hook execution done ; unable to write more data into the channel", "hook", job.name, "id", job.id, "line", line)
break
}
// write to stdout if configured
logger.LogIf(
logger.HookOutputEnabled,
slog.LevelInfo+1,
line,
"hook", job.name,
"id", job.id,
)
// writing to outfile
if _, err := wLogFile.WriteString(line + "\n"); err != nil {
slog.Error("error while writing into the log file", "filename", logFile.Name(), "err", err)
break
}
}
if err := scanner.Err(); err != nil {
slog.Error("hook is unable to read script stdout", "hook", job.name, "id", job.id, "err", err)
}
wg.Done()
}(cmdReader)
// Start timeout timer
timer := time.AfterFunc(time.Duration(job.timeout)*time.Second, func() {
slog.Warn("hook has timed out: killing process...", "hook", job.name, "id", job.id, "timeout", job.timeout, "pid", cmd.Process.Pid)
syscall.Kill(-cmd.Process.Pid, syscall.SIGKILL)
})
// Wait for command output completion
wg.Wait()
// Wait for command completion
err = cmd.Wait()
// Stop timeout timer
timer.Stop()
// Mark work as terminated
return job.Terminate(err)
}