/
worker.go
463 lines (397 loc) · 13.2 KB
/
worker.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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
package worker
import (
"crypto/rand"
"database/sql"
"encoding/hex"
"fmt"
"math"
"time"
"github.com/go-gorp/gorp"
"github.com/ovh/cds/engine/api/group"
"github.com/ovh/cds/engine/api/pipeline"
"github.com/ovh/cds/engine/api/token"
"github.com/ovh/cds/engine/api/workflow"
"github.com/ovh/cds/sdk"
"github.com/ovh/cds/sdk/log"
)
// PipelineBuildJobInfo is returned to worker in answer to takePipelineBuildJobHandler
type PipelineBuildJobInfo struct {
PipelineBuildJob sdk.PipelineBuildJob
Secrets []sdk.Variable
PipelineID int64
BuildNumber int64
}
// WorkflowNodeJobRunInfo is returned to worker in answer to postTakeWorkflowJobHandler
type WorkflowNodeJobRunInfo struct {
NodeJobRun sdk.WorkflowNodeJobRun
Secrets []sdk.Variable
Number int64
SubNumber int64
}
// ErrNoWorker means the given worker ID is not found
var ErrNoWorker = fmt.Errorf("cds: no worker found")
// DeleteWorker remove worker from database
func DeleteWorker(db *gorp.DbMap, id string) error {
tx, errb := db.Begin()
if errb != nil {
return fmt.Errorf("DeleteWorker> Cannot start tx: %s", errb)
}
defer tx.Rollback()
query := `DELETE FROM worker WHERE id = $1`
if _, err := tx.Exec(query, id); err != nil {
return sdk.WrapError(err, "DeleteWorker")
}
if err := tx.Commit(); err != nil {
return sdk.WrapError(err, "DeleteWorker> unable to commit tx")
}
return nil
}
// DisableWorker disable a worker
func DisableWorker(db *gorp.DbMap, id string) error {
tx, errb := db.Begin()
if errb != nil {
return fmt.Errorf("DisableWorker> Cannot start tx: %s", errb)
}
defer tx.Rollback() // nolint
query := `SELECT name, status, action_build_id, job_type FROM worker WHERE id = $1 FOR UPDATE`
var st, name string
var jobID sql.NullInt64
var jobType sql.NullString
if err := tx.QueryRow(query, id).Scan(&name, &st, &jobID, &jobType); err != nil {
log.Debug("DisableWorker[%d]> Cannot lock worker: %s", id, err)
return nil
}
if st == sdk.StatusBuilding.String() && jobID.Valid && jobType.Valid {
// Worker is awol while building !
// We need to restart this action
switch jobType.String {
case sdk.JobTypePipeline:
if err := pipeline.RestartPipelineBuildJob(tx, jobID.Int64); err != nil {
log.Error("DisableWorker[%s]> Cannot restart pipeline build job: %s", name, err)
} else {
log.Info("DisableWorker[%s]> PipelineBuildJob %d restarted after crash", name, jobID.Int64)
}
case sdk.JobTypeWorkflowNode:
wNodeJob, errL := workflow.LoadNodeJobRun(tx, nil, jobID.Int64)
if errL == nil && wNodeJob.Retry < 3 {
if err := workflow.RestartWorkflowNodeJob(nil, db, *wNodeJob); err != nil {
log.Warning("DisableWorker[%s]> Cannot restart workflow node run : %s", name, err)
} else {
log.Info("DisableWorker[%s]> WorkflowNodeRun %d restarted after crash", name, jobID.Int64)
}
}
}
log.Info("DisableWorker> Worker %s crashed while building %d !", name, jobID.Int64)
}
if err := SetStatus(tx, id, sdk.StatusDisabled); err != nil {
if err == ErrNoWorker || err == sql.ErrNoRows {
return sdk.WrapError(sdk.ErrWrongRequest, "DisableWorker> worker %s does not exists", id)
}
return sdk.WrapError(err, "DisableWorker> cannot update worker status")
}
if err := tx.Commit(); err != nil {
return err
}
return nil
}
// InsertWorker inserts worker representation into database
func InsertWorker(db gorp.SqlExecutor, w *sdk.Worker, groupID int64) error {
query := `INSERT INTO worker (id, name, last_beat, model, status, hatchery_id, hatchery_name, group_id) VALUES ($1, $2, $3, $4, $5, $6, $7, $8)`
_, err := db.Exec(query, w.ID, w.Name, time.Now(), w.ModelID, w.Status.String(), w.HatcheryID, w.HatcheryName, groupID)
return err
}
// LoadWorker retrieves worker in database
func LoadWorker(db gorp.SqlExecutor, id string) (*sdk.Worker, error) {
w := &sdk.Worker{}
var statusS string
var pbJobID sql.NullInt64
var jobType sql.NullString
query := `SELECT id, action_build_id, job_type, name, last_beat, group_id, model, status, hatchery_id, hatchery_name, group_id FROM worker WHERE worker.id = $1 FOR UPDATE`
if err := db.QueryRow(query, id).Scan(&w.ID, &pbJobID, &jobType, &w.Name, &w.LastBeat, &w.GroupID, &w.ModelID, &statusS, &w.HatcheryID, &w.HatcheryName, &w.GroupID); err != nil {
return nil, err
}
w.Status = sdk.StatusFromString(statusS)
if jobType.Valid {
w.JobType = jobType.String
}
if pbJobID.Valid {
w.ActionBuildID = pbJobID.Int64
}
return w, nil
}
// LoadWorkers load all workers in db
func LoadWorkers(db gorp.SqlExecutor, hatcheryName string) ([]sdk.Worker, error) {
w := []sdk.Worker{}
var statusS string
query := `SELECT id, name, last_beat, group_id, model, status, hatchery_id, hatchery_name FROM worker ORDER BY name ASC`
args := []interface{}{}
if hatcheryName != "" {
// TODO: remove the hatchery name from worker worker table !
query = `SELECT id, name, last_beat, group_id, model, status, hatchery_id, hatchery_name FROM worker WHERE hatchery_name = $1 ORDER BY name ASC`
args = []interface{}{hatcheryName}
}
rows, err := db.Query(query, args...)
if err != nil {
return nil, err
}
defer rows.Close()
for rows.Next() {
var worker sdk.Worker
err = rows.Scan(&worker.ID, &worker.Name, &worker.LastBeat, &worker.GroupID, &worker.ModelID, &statusS, &worker.HatcheryID, &worker.HatcheryName)
if err != nil {
return nil, err
}
worker.Status = sdk.StatusFromString(statusS)
w = append(w, worker)
}
return w, nil
}
// LoadDeadWorkers load worker with refresh last beat > timeout
func LoadDeadWorkers(db gorp.SqlExecutor, timeout float64) ([]sdk.Worker, error) {
var w []sdk.Worker
var statusS string
query := `SELECT id, action_build_id, job_type, name, last_beat, group_id, model, status, hatchery_id, hatchery_name
FROM worker
WHERE 1 = 1
AND now() - last_beat > $1 * INTERVAL '1' SECOND
ORDER BY name ASC
LIMIT 10000`
rows, err := db.Query(query, int64(math.Floor(timeout)))
if err != nil {
log.Warning("LoadDeadWorkers> Error querying workers")
return nil, err
}
defer rows.Close()
for rows.Next() {
var worker sdk.Worker
var pbJobID sql.NullInt64
var jobType sql.NullString
err = rows.Scan(&worker.ID, &pbJobID, &jobType, &worker.Name, &worker.LastBeat, &worker.GroupID, &worker.ModelID, &statusS, &worker.HatcheryID, &worker.HatcheryName)
if err != nil {
log.Warning("LoadDeadWorkers> Error scanning workers")
return nil, err
}
if jobType.Valid {
worker.JobType = jobType.String
}
if pbJobID.Valid {
worker.ActionBuildID = pbJobID.Int64
}
worker.Status = sdk.StatusFromString(statusS)
w = append(w, worker)
}
return w, nil
}
// RefreshWorker Update worker last_beat
func RefreshWorker(db gorp.SqlExecutor, w *sdk.Worker) error {
if w == nil {
return sdk.WrapError(sdk.ErrUnknownError, "RefreshWorker> Invalid worker")
}
query := `UPDATE worker SET last_beat = now() WHERE id = $1`
res, err := db.Exec(query, w.ID)
if err != nil {
return sdk.WrapError(err, "RefreshWorker> Unable to update worker: %s", w.ID)
}
n, err := res.RowsAffected()
if err != nil {
return sdk.WrapError(err, "RefreshWorker> Unable to refresh worker: %s", w.ID)
}
var mname string
if w.Model != nil {
mname = w.Model.Name
}
if n != 1 {
return sdk.NewError(sdk.ErrForbidden, fmt.Errorf("unknown worker '%s' Name:%s GroupID:%d ModelID:%d Model:%s HatcheryID:%d HatcheryName:%s",
w.ID, w.Name, w.GroupID, w.ModelID, mname, w.HatcheryID, w.HatcheryName))
}
return nil
}
func generateID() (string, error) {
size := 64
bs := make([]byte, size)
if _, err := rand.Read(bs); err != nil {
log.Error("generateID: rand.Read failed: %s", err)
return "", err
}
str := hex.EncodeToString(bs)
token := []byte(str)[0:size]
log.Debug("generateID: new generated id: %s", token)
return string(token), nil
}
// RegistrationForm represents the arguments needed to register a worker
type RegistrationForm struct {
Name string
Token string
ModelID int64
Hatchery int64
HatcheryName string
BinaryCapabilities []string
Version string
OS string
Arch string
}
// TakeForm contains booked JobID if exists
type TakeForm struct {
BookedJobID int64
Time time.Time
}
// RegisterWorker Register new worker
func RegisterWorker(db *gorp.DbMap, name string, key string, modelID int64, h *sdk.Hatchery, binaryCapabilities []string, OS, arch string) (*sdk.Worker, error) {
if name == "" {
return nil, fmt.Errorf("cannot register worker with empty name")
}
if key == "" {
return nil, fmt.Errorf("cannot register worker with empty worker key")
}
// Load token
t, errL := token.LoadToken(db, key)
if errL != nil {
log.Warning("RegisterWorker> Cannot register worker. Caused by: %s", errL)
return nil, errL
}
if h != nil {
if h.GroupID != t.GroupID {
return nil, sdk.ErrForbidden
}
}
//Load Model
var m *sdk.Model
if modelID != 0 {
var errM error
m, errM = LoadWorkerModelByID(db, modelID)
if errM != nil {
log.Warning("RegisterWorker> Cannot load model: %s", errM)
return nil, errM
}
}
//If worker model is public (sharedInfraGroup) it can be ran by every one
//If worker is public it can run every model
//Private worker for a group cannot run a private model for another group
if m != nil {
if t.GroupID != group.SharedInfraGroup.ID && t.GroupID != m.GroupID && m.GroupID != group.SharedInfraGroup.ID {
log.Warning("RegisterWorker> worker %s (%d) cannot be spawned as %s (%d)", name, t.GroupID, m.Name, m.GroupID)
return nil, sdk.ErrForbidden
}
}
//generate an ID
id, errG := generateID()
if errG != nil {
log.Warning("registerWorker: Cannot generate ID: %s", errG)
return nil, errG
}
//Instanciate a new worker
w := &sdk.Worker{
ID: id,
Name: name,
ModelID: modelID,
Model: m,
Status: sdk.StatusWaiting,
GroupID: t.GroupID,
}
if h != nil {
w.HatcheryID = h.ID
w.HatcheryName = h.Name
}
tx, errTx := db.Begin()
if errTx != nil {
return nil, errTx
}
defer tx.Rollback()
if err := InsertWorker(tx, w, t.GroupID); err != nil {
log.Warning("registerWorker: Cannot insert worker in database: %s", err)
return nil, err
}
//If the worker is registered for a model and it gave us BinaryCapabilities...
if len(binaryCapabilities) > 0 && modelID != 0 {
go func() {
//Start a new tx for this goroutine
ntx, err := db.Begin()
if err != nil {
log.Warning("RegisterWorker> Unable to start a transaction: %s", err)
return
}
defer ntx.Rollback()
existingCapas, err := LoadWorkerModelCapabilities(ntx, modelID)
if err != nil {
log.Warning("RegisterWorker> Unable to load worker model capabilities: %s", err)
return
}
var newCapas []string
for _, b := range binaryCapabilities {
var found bool
for _, c := range existingCapas {
if b == c.Value {
found = true
break
}
}
if !found {
newCapas = append(newCapas, b)
}
}
if len(newCapas) > 0 {
log.Debug("Updating model %d binary capabilities with %d capabilities", modelID, len(newCapas))
for _, b := range newCapas {
query := `insert into worker_capability (worker_model_id, name, argument, type) values ($1, $2, $3, $4)`
if _, err := ntx.Exec(query, modelID, b, b, string(sdk.BinaryRequirement)); err != nil {
//Ignore errors because we let the database to check constraints...
log.Debug("registerWorker> Cannot insert into worker_capability: %s", err)
return
}
}
}
if OS != "" && arch != "" {
if err := updateOSAndArch(ntx, modelID, OS, arch); err != nil {
log.Warning("registerWorker> Cannot update os and arch for worker model %d : %s", modelID, err)
return
}
}
if err := ntx.Commit(); err != nil {
log.Warning("RegisterWorker> Unable to commit transaction: %s", err)
}
}()
if err := updateRegistration(db, modelID); err != nil {
log.Warning("registerWorker> Unable updateRegistration: %s", err)
}
}
return w, tx.Commit()
}
// SetStatus sets action_build_id and status to building on given worker
func SetStatus(db gorp.SqlExecutor, workerID string, status sdk.Status) error {
query := `UPDATE worker SET status = $1 WHERE id = $2`
res, errE := db.Exec(query, status.String(), workerID)
if errE != nil {
return errE
}
_, err := res.RowsAffected()
return err
}
// SetToBuilding sets action_build_id and status to building on given worker
func SetToBuilding(db gorp.SqlExecutor, workerID string, actionBuildID int64, jobType string) error {
query := `UPDATE worker SET status = $1, action_build_id = $2, job_type = $3 WHERE id = $4`
res, errE := db.Exec(query, sdk.StatusBuilding.String(), actionBuildID, jobType, workerID)
if errE != nil {
return errE
}
_, err := res.RowsAffected()
return err
}
// UpdateWorkerStatus changes worker status to Disabled
func UpdateWorkerStatus(db gorp.SqlExecutor, workerID string, status sdk.Status) error {
query := `UPDATE worker SET status = $1, action_build_id = NULL WHERE id = $2`
res, err := db.Exec(query, status.String(), workerID)
if err != nil {
return err
}
rowsAffected, err := res.RowsAffected()
if err != nil {
return err
}
if rowsAffected > 1 {
log.Error("UpdateWorkerStatus: Multiple (%d) rows affected ! (id=%s)", rowsAffected, workerID)
}
if rowsAffected == 0 {
return ErrNoWorker
}
return nil
}