-
Notifications
You must be signed in to change notification settings - Fork 30
/
group.go
157 lines (130 loc) · 3.72 KB
/
group.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
package job
import (
"context"
"sync"
"github.com/mongodb/amboy"
"github.com/mongodb/amboy/dependency"
"github.com/mongodb/amboy/registry"
"github.com/mongodb/grip"
"github.com/pkg/errors"
)
// Group is a structure for running collections of Job objects at the
// same time, as a single Job. Use Groups to isolate several Jobs from
// other Jobs in the queue, and ensure that several Jobs run on a
// single system.
type Group struct {
Jobs map[string]*registry.JobInterchange `bson:"jobs" json:"jobs" yaml:"jobs"`
*Base `bson:"metadata" json:"metadata" yaml:"metadata"`
mutex sync.RWMutex
}
// NewGroup creates a new, empty Group object.
func NewGroup(name string) *Group {
g := newGroupInstance()
g.SetID(name)
return g
}
// newGroupInstance is a common constructor for the public NewGroup
// constructior and the registry.JobFactory constructor.
func newGroupInstance() *Group {
g := &Group{
Jobs: make(map[string]*registry.JobInterchange),
Base: &Base{
JobType: amboy.JobType{
Name: "group",
Version: 1,
},
},
}
return g
}
// Add is not part of the Job interface, but allows callers to append
// jobs to the Group. Returns an error if a job with the same ID()
// value already exists in the group.
func (g *Group) Add(j amboy.Job) error {
name := j.ID()
g.mutex.Lock()
defer g.mutex.Unlock()
_, exists := g.Jobs[name]
if exists {
return errors.Errorf("job named '%s' already exists in group '%s'",
name, g.ID())
}
job, err := registry.MakeJobInterchange(j, amboy.JSON)
if err != nil {
return err
}
g.Jobs[name] = job
return nil
}
// Run executes the jobs. Provides "continue on error" semantics for
// Jobs in the Group. Returns an error if: the Group has already
// run, or if any of the constituent Jobs produce an error *or* if
// there are problems with the JobInterchange converters.
func (g *Group) Run(ctx context.Context) {
defer g.MarkComplete()
if g.Status().Completed {
g.AddError(errors.Errorf("group '%s' has already executed", g.ID()))
return
}
wg := &sync.WaitGroup{}
g.mutex.RLock()
for _, job := range g.Jobs {
if err := ctx.Err(); err != nil {
g.AddError(err)
break
}
runnableJob, err := job.Resolve(amboy.JSON)
if err != nil {
g.AddError(err)
continue
}
depState := runnableJob.Dependency().State()
if depState == dependency.Passed {
grip.Infof("skipping job '%s' because of dependency", runnableJob.ID())
continue
} else if depState == dependency.Blocked || depState == dependency.Unresolved {
grip.Warningf("dispatching blocked/unresolved job '%s'", runnableJob.ID())
}
wg.Add(1)
go func(j amboy.Job, group *Group) {
defer wg.Done()
maxTime := j.TimeInfo().MaxTime
if maxTime > 0 {
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(ctx, maxTime)
defer cancel()
}
j.Run(ctx)
// after the job completes, add the issue
// back to Jobs map so that we preserve errors
// idiomatically for Groups.
jobErr := j.Error()
g.AddError(jobErr)
job, err := registry.MakeJobInterchange(j, amboy.JSON)
if err != nil {
g.AddError(err)
return
}
if jobErr != nil {
return
}
group.mutex.Lock()
defer group.mutex.Unlock()
group.Jobs[j.ID()] = job
}(runnableJob, g)
}
g.mutex.RUnlock()
wg.Wait()
g.MarkComplete()
}
// SetDependency allows you to configure the dependency.Manager
// instance for this object. If you want to swap different dependency
// instances you can as long as the new instance is of the "Always"
// type.
func (g *Group) SetDependency(d dependency.Manager) {
if d == nil || d.Type().Name != "always" {
grip.Warningf("group job types must have 'always' dependency types, '%s' is invalid", d.Type().Name)
return
}
g.Base.SetDependency(d)
}