1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
12 "git.arvados.org/arvados.git/lib/cloud"
13 "git.arvados.org/arvados.git/lib/dispatchcloud/test"
14 "git.arvados.org/arvados.git/sdk/go/arvados"
15 "git.arvados.org/arvados.git/sdk/go/ctxlog"
16 "github.com/prometheus/client_golang/prometheus"
17 check "gopkg.in/check.v1"
20 const GiB arvados.ByteSize = 1 << 30
22 var _ = check.Suite(&PoolSuite{})
24 type lessChecker struct {
28 func (*lessChecker) Check(params []interface{}, names []string) (result bool, error string) {
29 return params[0].(int) < params[1].(int), ""
32 var less = &lessChecker{&check.CheckerInfo{Name: "less", Params: []string{"obtained", "expected"}}}
34 type PoolSuite struct{}
36 func (suite *PoolSuite) TestResumeAfterRestart(c *check.C) {
37 type1 := test.InstanceType(1)
38 type2 := test.InstanceType(2)
39 type3 := test.InstanceType(3)
40 waitForIdle := func(pool *Pool, notify <-chan struct{}) {
41 timeout := time.NewTimer(time.Second)
43 instances := pool.Instances()
44 sort.Slice(instances, func(i, j int) bool {
45 return strings.Compare(instances[i].ArvadosInstanceType, instances[j].ArvadosInstanceType) < 0
47 if len(instances) == 3 &&
48 instances[0].ArvadosInstanceType == type1.Name &&
49 instances[0].WorkerState == StateIdle.String() &&
50 instances[1].ArvadosInstanceType == type1.Name &&
51 instances[1].WorkerState == StateIdle.String() &&
52 instances[2].ArvadosInstanceType == type2.Name &&
53 instances[2].WorkerState == StateIdle.String() {
58 c.Logf("pool.Instances() == %#v", instances)
66 logger := ctxlog.TestLogger(c)
67 driver := &test.StubDriver{}
68 instanceSetID := cloud.InstanceSetID("test-instance-set-id")
69 is, err := driver.InstanceSet(nil, instanceSetID, nil, logger)
70 c.Assert(err, check.IsNil)
72 newExecutor := func(cloud.Instance) Executor {
74 response: map[string]stubResp{
75 "crunch-run --list": {},
81 cluster := &arvados.Cluster{
82 Containers: arvados.ContainersConfig{
83 CloudVMs: arvados.CloudVMsConfig{
84 BootProbeCommand: "true",
85 MaxProbesPerSecond: 1000,
86 ProbeInterval: arvados.Duration(time.Millisecond * 10),
87 SyncInterval: arvados.Duration(time.Millisecond * 10),
88 TagKeyPrefix: "testprefix:",
91 InstanceTypes: arvados.InstanceTypeMap{
98 pool := NewPool(logger, arvados.NewClientFromEnv(), prometheus.NewRegistry(), instanceSetID, is, newExecutor, nil, cluster)
99 notify := pool.Subscribe()
100 defer pool.Unsubscribe(notify)
104 waitForIdle(pool, notify)
105 var heldInstanceID cloud.InstanceID
106 for _, inst := range pool.Instances() {
107 if inst.ArvadosInstanceType == type2.Name {
108 heldInstanceID = cloud.InstanceID(inst.Instance)
109 pool.SetIdleBehavior(heldInstanceID, IdleBehaviorHold)
112 // Wait for the tags to save to the cloud provider
113 tagKey := cluster.Containers.CloudVMs.TagKeyPrefix + tagKeyIdleBehavior
114 deadline := time.Now().Add(time.Second)
117 defer pool.mtx.RUnlock()
118 for _, wkr := range pool.workers {
119 if wkr.instType == type2 {
120 return wkr.instance.Tags()[tagKey] == string(IdleBehaviorHold)
125 if time.Now().After(deadline) {
128 time.Sleep(time.Millisecond * 10)
132 c.Log("------- starting new pool, waiting to recover state")
134 pool2 := NewPool(logger, arvados.NewClientFromEnv(), prometheus.NewRegistry(), instanceSetID, is, newExecutor, nil, cluster)
135 notify2 := pool2.Subscribe()
136 defer pool2.Unsubscribe(notify2)
137 waitForIdle(pool2, notify2)
138 for _, inst := range pool2.Instances() {
139 if inst.ArvadosInstanceType == type2.Name {
140 c.Check(inst.Instance, check.Equals, heldInstanceID)
141 c.Check(inst.IdleBehavior, check.Equals, IdleBehaviorHold)
143 c.Check(inst.IdleBehavior, check.Equals, IdleBehaviorRun)
149 func (suite *PoolSuite) TestDrain(c *check.C) {
150 logger := ctxlog.TestLogger(c)
151 driver := test.StubDriver{}
152 instanceSet, err := driver.InstanceSet(nil, "test-instance-set-id", nil, logger)
153 c.Assert(err, check.IsNil)
155 ac := arvados.NewClientFromEnv()
157 type1 := test.InstanceType(1)
161 newExecutor: func(cloud.Instance) Executor { return &stubExecutor{} },
162 instanceSet: &throttledInstanceSet{InstanceSet: instanceSet},
163 instanceTypes: arvados.InstanceTypeMap{
167 notify := pool.Subscribe()
168 defer pool.Unsubscribe(notify)
172 // Wait for the instance to either return from its Create
173 // call, or show up in a poll.
174 suite.wait(c, pool, notify, func() bool {
176 defer pool.mtx.RUnlock()
177 return len(pool.workers) == 1
182 idleBehavior IdleBehavior
185 {StateIdle, IdleBehaviorHold, false},
186 {StateIdle, IdleBehaviorDrain, false},
187 {StateIdle, IdleBehaviorRun, true},
190 for _, test := range tests {
191 for _, wkr := range pool.workers {
192 wkr.state = test.state
193 wkr.idleBehavior = test.idleBehavior
196 // Try to start a container
197 started := pool.StartContainer(type1, arvados.Container{UUID: "testcontainer"})
198 c.Check(started, check.Equals, test.result)
202 func (suite *PoolSuite) TestCreateUnallocShutdown(c *check.C) {
203 logger := ctxlog.TestLogger(c)
204 driver := test.StubDriver{HoldCloudOps: true}
205 instanceSet, err := driver.InstanceSet(nil, "test-instance-set-id", nil, logger)
206 c.Assert(err, check.IsNil)
208 type1 := arvados.InstanceType{Name: "a1s", ProviderType: "a1.small", VCPUs: 1, RAM: 1 * GiB, Price: .01}
209 type2 := arvados.InstanceType{Name: "a2m", ProviderType: "a2.medium", VCPUs: 2, RAM: 2 * GiB, Price: .02}
210 type3 := arvados.InstanceType{Name: "a2l", ProviderType: "a2.large", VCPUs: 4, RAM: 4 * GiB, Price: .04}
213 newExecutor: func(cloud.Instance) Executor { return &stubExecutor{} },
214 instanceSet: &throttledInstanceSet{InstanceSet: instanceSet},
215 instanceTypes: arvados.InstanceTypeMap{
221 notify := pool.Subscribe()
222 defer pool.Unsubscribe(notify)
223 notify2 := pool.Subscribe()
224 defer pool.Unsubscribe(notify2)
226 c.Check(pool.Unallocated()[type1], check.Equals, 0)
227 c.Check(pool.Unallocated()[type2], check.Equals, 0)
228 c.Check(pool.Unallocated()[type3], check.Equals, 0)
233 c.Check(pool.Unallocated()[type1], check.Equals, 1)
234 c.Check(pool.Unallocated()[type2], check.Equals, 2)
235 c.Check(pool.Unallocated()[type3], check.Equals, 1)
237 // Unblock the pending Create calls.
238 go driver.ReleaseCloudOps(4)
240 // Wait for each instance to either return from its Create
241 // call, or show up in a poll.
242 suite.wait(c, pool, notify, func() bool {
244 defer pool.mtx.RUnlock()
245 return len(pool.workers) == 4
248 // Place type3 node on admin-hold
249 ivs := suite.instancesByType(pool, type3)
250 c.Assert(ivs, check.HasLen, 1)
251 type3instanceID := ivs[0].Instance
252 err = pool.SetIdleBehavior(type3instanceID, IdleBehaviorHold)
253 c.Check(err, check.IsNil)
255 // Check admin-hold behavior: refuse to shutdown, and don't
256 // report as Unallocated ("available now or soon").
257 c.Check(pool.Shutdown(type3), check.Equals, false)
258 suite.wait(c, pool, notify, func() bool {
259 return pool.Unallocated()[type3] == 0
261 c.Check(suite.instancesByType(pool, type3), check.HasLen, 1)
263 // Shutdown both type2 nodes
264 c.Check(pool.Shutdown(type2), check.Equals, true)
265 suite.wait(c, pool, notify, func() bool {
266 return pool.Unallocated()[type1] == 1 && pool.Unallocated()[type2] == 1
268 c.Check(pool.Shutdown(type2), check.Equals, true)
269 suite.wait(c, pool, notify, func() bool {
270 return pool.Unallocated()[type1] == 1 && pool.Unallocated()[type2] == 0
272 c.Check(pool.Shutdown(type2), check.Equals, false)
274 // Consume any waiting notifications to ensure the
275 // next one we get is from Shutdown.
284 // Shutdown type1 node
285 c.Check(pool.Shutdown(type1), check.Equals, true)
286 suite.wait(c, pool, notify, func() bool {
287 return pool.Unallocated()[type1] == 0 && pool.Unallocated()[type2] == 0 && pool.Unallocated()[type3] == 0
291 case <-time.After(time.Second):
292 c.Error("notify did not receive")
295 // Put type3 node back in service.
296 err = pool.SetIdleBehavior(type3instanceID, IdleBehaviorRun)
297 c.Check(err, check.IsNil)
298 suite.wait(c, pool, notify, func() bool {
299 return pool.Unallocated()[type3] == 1
302 // Check admin-drain behavior: shut down right away, and don't
303 // report as Unallocated.
304 err = pool.SetIdleBehavior(type3instanceID, IdleBehaviorDrain)
305 c.Check(err, check.IsNil)
306 suite.wait(c, pool, notify, func() bool {
307 return pool.Unallocated()[type3] == 0
309 suite.wait(c, pool, notify, func() bool {
310 ivs := suite.instancesByType(pool, type3)
311 return len(ivs) == 1 && ivs[0].WorkerState == StateShutdown.String()
314 // Unblock all pending Destroy calls. Pool calls Destroy again
315 // if a node still appears in the provider list after a
316 // previous attempt, so there might be more than 4 Destroy
318 go driver.ReleaseCloudOps(4444)
320 // Sync until all instances disappear from the provider list.
321 suite.wait(c, pool, notify, func() bool {
322 pool.getInstancesAndSync()
323 return len(pool.Instances()) == 0
327 func (suite *PoolSuite) instancesByType(pool *Pool, it arvados.InstanceType) []InstanceView {
328 var ivs []InstanceView
329 for _, iv := range pool.Instances() {
330 if iv.ArvadosInstanceType == it.Name {
331 ivs = append(ivs, iv)
337 func (suite *PoolSuite) wait(c *check.C, pool *Pool, notify <-chan struct{}, ready func() bool) {
338 timeout := time.NewTimer(time.Second).C
347 c.Check(ready(), check.Equals, true)