Merge branch '20432-getting-containers' refs #20432
[arvados.git] / lib / dispatchcloud / node_size_test.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4
5 package dispatchcloud
6
7 import (
8         "git.arvados.org/arvados.git/sdk/go/arvados"
9         check "gopkg.in/check.v1"
10 )
11
12 var _ = check.Suite(&NodeSizeSuite{})
13
14 const GiB = arvados.ByteSize(1 << 30)
15
16 type NodeSizeSuite struct{}
17
18 func (*NodeSizeSuite) TestChooseNotConfigured(c *check.C) {
19         _, err := ChooseInstanceType(&arvados.Cluster{}, &arvados.Container{
20                 RuntimeConstraints: arvados.RuntimeConstraints{
21                         RAM:   1234567890,
22                         VCPUs: 2,
23                 },
24         })
25         c.Check(err, check.Equals, ErrInstanceTypesNotConfigured)
26 }
27
28 func (*NodeSizeSuite) TestChooseUnsatisfiable(c *check.C) {
29         checkUnsatisfiable := func(ctr *arvados.Container) {
30                 _, err := ChooseInstanceType(&arvados.Cluster{InstanceTypes: map[string]arvados.InstanceType{
31                         "small1": {Price: 1.1, RAM: 1000000000, VCPUs: 2, Name: "small1"},
32                         "small2": {Price: 2.2, RAM: 2000000000, VCPUs: 4, Name: "small2"},
33                         "small4": {Price: 4.4, RAM: 4000000000, VCPUs: 8, Name: "small4", Scratch: GiB},
34                 }}, ctr)
35                 c.Check(err, check.FitsTypeOf, ConstraintsNotSatisfiableError{})
36         }
37
38         for _, rc := range []arvados.RuntimeConstraints{
39                 {RAM: 9876543210, VCPUs: 2},
40                 {RAM: 1234567890, VCPUs: 20},
41                 {RAM: 1234567890, VCPUs: 2, KeepCacheRAM: 9876543210},
42         } {
43                 checkUnsatisfiable(&arvados.Container{RuntimeConstraints: rc})
44         }
45         checkUnsatisfiable(&arvados.Container{
46                 Mounts:             map[string]arvados.Mount{"/tmp": {Kind: "tmp", Capacity: int64(2 * GiB)}},
47                 RuntimeConstraints: arvados.RuntimeConstraints{RAM: 12345, VCPUs: 1},
48         })
49 }
50
51 func (*NodeSizeSuite) TestChoose(c *check.C) {
52         for _, menu := range []map[string]arvados.InstanceType{
53                 {
54                         "costly": {Price: 4.4, RAM: 4000000000, VCPUs: 8, Scratch: 2 * GiB, Name: "costly"},
55                         "best":   {Price: 2.2, RAM: 2000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "best"},
56                         "small":  {Price: 1.1, RAM: 1000000000, VCPUs: 2, Scratch: 2 * GiB, Name: "small"},
57                 },
58                 {
59                         "costly":     {Price: 4.4, RAM: 4000000000, VCPUs: 8, Scratch: 2 * GiB, Name: "costly"},
60                         "goodenough": {Price: 2.2, RAM: 2000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "goodenough"},
61                         "best":       {Price: 2.2, RAM: 4000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "best"},
62                         "small":      {Price: 1.1, RAM: 1000000000, VCPUs: 2, Scratch: 2 * GiB, Name: "small"},
63                 },
64                 {
65                         "small":      {Price: 1.1, RAM: 1000000000, VCPUs: 2, Scratch: 2 * GiB, Name: "small"},
66                         "goodenough": {Price: 2.2, RAM: 2000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "goodenough"},
67                         "best":       {Price: 2.2, RAM: 4000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "best"},
68                         "costly":     {Price: 4.4, RAM: 4000000000, VCPUs: 8, Scratch: 2 * GiB, Name: "costly"},
69                 },
70                 {
71                         "small":  {Price: 1.1, RAM: 1000000000, VCPUs: 2, Scratch: GiB, Name: "small"},
72                         "nearly": {Price: 2.2, RAM: 2000000000, VCPUs: 4, Scratch: GiB, Name: "nearly"},
73                         "best":   {Price: 3.3, RAM: 4000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "best"},
74                         "costly": {Price: 4.4, RAM: 4000000000, VCPUs: 8, Scratch: 2 * GiB, Name: "costly"},
75                 },
76                 {
77                         "small":  {Price: 1.1, RAM: 1000000000, VCPUs: 2, Scratch: GiB, Name: "small"},
78                         "nearly": {Price: 2.2, RAM: 1200000000, VCPUs: 4, Scratch: 2 * GiB, Name: "nearly"},
79                         "best":   {Price: 3.3, RAM: 4000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "best"},
80                         "costly": {Price: 4.4, RAM: 4000000000, VCPUs: 8, Scratch: 2 * GiB, Name: "costly"},
81                 },
82         } {
83                 best, err := ChooseInstanceType(&arvados.Cluster{InstanceTypes: menu, Containers: arvados.ContainersConfig{
84                         LocalKeepBlobBuffersPerVCPU: 1,
85                         ReserveExtraRAM:             268435456,
86                 }}, &arvados.Container{
87                         Mounts: map[string]arvados.Mount{
88                                 "/tmp": {Kind: "tmp", Capacity: 2 * int64(GiB)},
89                         },
90                         RuntimeConstraints: arvados.RuntimeConstraints{
91                                 VCPUs:        2,
92                                 RAM:          987654321,
93                                 KeepCacheRAM: 123456789,
94                         },
95                 })
96                 c.Check(err, check.IsNil)
97                 c.Check(best.Name, check.Equals, "best")
98                 c.Check(best.RAM >= 1234567890, check.Equals, true)
99                 c.Check(best.VCPUs >= 2, check.Equals, true)
100                 c.Check(best.Scratch >= 2*GiB, check.Equals, true)
101         }
102 }
103
104 func (*NodeSizeSuite) TestChooseWithBlobBuffersOverhead(c *check.C) {
105         menu := map[string]arvados.InstanceType{
106                 "nearly": {Price: 2.2, RAM: 4000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "small"},
107                 "best":   {Price: 3.3, RAM: 8000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "best"},
108                 "costly": {Price: 4.4, RAM: 12000000000, VCPUs: 8, Scratch: 2 * GiB, Name: "costly"},
109         }
110         best, err := ChooseInstanceType(&arvados.Cluster{InstanceTypes: menu, Containers: arvados.ContainersConfig{
111                 LocalKeepBlobBuffersPerVCPU: 16, // 1 GiB per vcpu => 2 GiB
112                 ReserveExtraRAM:             268435456,
113         }}, &arvados.Container{
114                 Mounts: map[string]arvados.Mount{
115                         "/tmp": {Kind: "tmp", Capacity: 2 * int64(GiB)},
116                 },
117                 RuntimeConstraints: arvados.RuntimeConstraints{
118                         VCPUs:        2,
119                         RAM:          987654321,
120                         KeepCacheRAM: 123456789,
121                 },
122         })
123         c.Check(err, check.IsNil)
124         c.Check(best.Name, check.Equals, "best")
125 }
126
127 func (*NodeSizeSuite) TestChoosePreemptible(c *check.C) {
128         menu := map[string]arvados.InstanceType{
129                 "costly":      {Price: 4.4, RAM: 4000000000, VCPUs: 8, Scratch: 2 * GiB, Preemptible: true, Name: "costly"},
130                 "almost best": {Price: 2.2, RAM: 2000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "almost best"},
131                 "best":        {Price: 2.2, RAM: 2000000000, VCPUs: 4, Scratch: 2 * GiB, Preemptible: true, Name: "best"},
132                 "small":       {Price: 1.1, RAM: 1000000000, VCPUs: 2, Scratch: 2 * GiB, Preemptible: true, Name: "small"},
133         }
134         best, err := ChooseInstanceType(&arvados.Cluster{InstanceTypes: menu}, &arvados.Container{
135                 Mounts: map[string]arvados.Mount{
136                         "/tmp": {Kind: "tmp", Capacity: 2 * int64(GiB)},
137                 },
138                 RuntimeConstraints: arvados.RuntimeConstraints{
139                         VCPUs:        2,
140                         RAM:          987654321,
141                         KeepCacheRAM: 123456789,
142                 },
143                 SchedulingParameters: arvados.SchedulingParameters{
144                         Preemptible: true,
145                 },
146         })
147         c.Check(err, check.IsNil)
148         c.Check(best.Name, check.Equals, "best")
149         c.Check(best.RAM >= 1234567890, check.Equals, true)
150         c.Check(best.VCPUs >= 2, check.Equals, true)
151         c.Check(best.Scratch >= 2*GiB, check.Equals, true)
152         c.Check(best.Preemptible, check.Equals, true)
153 }
154
155 func (*NodeSizeSuite) TestScratchForDockerImage(c *check.C) {
156         n := EstimateScratchSpace(&arvados.Container{
157                 ContainerImage: "d5025c0f29f6eef304a7358afa82a822+342",
158         })
159         // Actual image is 371.1 MiB (according to workbench)
160         // Estimated size is 384 MiB (402653184 bytes)
161         // Want to reserve 2x the estimated size, so 805306368 bytes
162         c.Check(n, check.Equals, int64(805306368))
163
164         n = EstimateScratchSpace(&arvados.Container{
165                 ContainerImage: "d5025c0f29f6eef304a7358afa82a822+-342",
166         })
167         // Parse error will return 0
168         c.Check(n, check.Equals, int64(0))
169
170         n = EstimateScratchSpace(&arvados.Container{
171                 ContainerImage: "d5025c0f29f6eef304a7358afa82a822+34",
172         })
173         // Short manifest will return 0
174         c.Check(n, check.Equals, int64(0))
175 }
176
177 func (*NodeSizeSuite) TestChooseGPU(c *check.C) {
178         menu := map[string]arvados.InstanceType{
179                 "costly":         {Price: 4.4, RAM: 4000000000, VCPUs: 8, Scratch: 2 * GiB, Name: "costly", CUDA: arvados.CUDAFeatures{DeviceCount: 2, HardwareCapability: "9.0", DriverVersion: "11.0"}},
180                 "low_capability": {Price: 2.1, RAM: 2000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "low_capability", CUDA: arvados.CUDAFeatures{DeviceCount: 1, HardwareCapability: "8.0", DriverVersion: "11.0"}},
181                 "best":           {Price: 2.2, RAM: 2000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "best", CUDA: arvados.CUDAFeatures{DeviceCount: 1, HardwareCapability: "9.0", DriverVersion: "11.0"}},
182                 "low_driver":     {Price: 2.1, RAM: 2000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "low_driver", CUDA: arvados.CUDAFeatures{DeviceCount: 1, HardwareCapability: "9.0", DriverVersion: "10.0"}},
183                 "cheap_gpu":      {Price: 2.0, RAM: 2000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "cheap_gpu", CUDA: arvados.CUDAFeatures{DeviceCount: 1, HardwareCapability: "8.0", DriverVersion: "10.0"}},
184                 "invalid_gpu":    {Price: 1.9, RAM: 2000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "invalid_gpu", CUDA: arvados.CUDAFeatures{DeviceCount: 1, HardwareCapability: "12.0.12", DriverVersion: "12.0.12"}},
185                 "non_gpu":        {Price: 1.1, RAM: 2000000000, VCPUs: 4, Scratch: 2 * GiB, Name: "non_gpu"},
186         }
187
188         type GPUTestCase struct {
189                 CUDA             arvados.CUDARuntimeConstraints
190                 SelectedInstance string
191         }
192         cases := []GPUTestCase{
193                 GPUTestCase{
194                         CUDA: arvados.CUDARuntimeConstraints{
195                                 DeviceCount:        1,
196                                 HardwareCapability: "9.0",
197                                 DriverVersion:      "11.0",
198                         },
199                         SelectedInstance: "best",
200                 },
201                 GPUTestCase{
202                         CUDA: arvados.CUDARuntimeConstraints{
203                                 DeviceCount:        2,
204                                 HardwareCapability: "9.0",
205                                 DriverVersion:      "11.0",
206                         },
207                         SelectedInstance: "costly",
208                 },
209                 GPUTestCase{
210                         CUDA: arvados.CUDARuntimeConstraints{
211                                 DeviceCount:        1,
212                                 HardwareCapability: "8.0",
213                                 DriverVersion:      "11.0",
214                         },
215                         SelectedInstance: "low_capability",
216                 },
217                 GPUTestCase{
218                         CUDA: arvados.CUDARuntimeConstraints{
219                                 DeviceCount:        1,
220                                 HardwareCapability: "9.0",
221                                 DriverVersion:      "10.0",
222                         },
223                         SelectedInstance: "low_driver",
224                 },
225                 GPUTestCase{
226                         CUDA: arvados.CUDARuntimeConstraints{
227                                 DeviceCount:        1,
228                                 HardwareCapability: "",
229                                 DriverVersion:      "10.0",
230                         },
231                         SelectedInstance: "",
232                 },
233                 GPUTestCase{
234                         CUDA: arvados.CUDARuntimeConstraints{
235                                 DeviceCount:        0,
236                                 HardwareCapability: "9.0",
237                                 DriverVersion:      "11.0",
238                         },
239                         SelectedInstance: "non_gpu",
240                 },
241         }
242
243         for _, tc := range cases {
244                 best, err := ChooseInstanceType(&arvados.Cluster{InstanceTypes: menu}, &arvados.Container{
245                         Mounts: map[string]arvados.Mount{
246                                 "/tmp": {Kind: "tmp", Capacity: 2 * int64(GiB)},
247                         },
248                         RuntimeConstraints: arvados.RuntimeConstraints{
249                                 VCPUs:        2,
250                                 RAM:          987654321,
251                                 KeepCacheRAM: 123456789,
252                                 CUDA:         tc.CUDA,
253                         },
254                 })
255                 if best.Name != "" {
256                         c.Check(err, check.IsNil)
257                         c.Check(best.Name, check.Equals, tc.SelectedInstance)
258                 } else {
259                         c.Check(err, check.Not(check.IsNil))
260                 }
261         }
262 }