Merge branch '14807-dispatch-cloud-fixes'
[arvados.git] / lib / cloud / azure / azure_test.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4 //
5 //
6 // How to manually run individual tests against the real cloud:
7 //
8 // $ go test -v git.curoverse.com/arvados.git/lib/cloud/azure -live-azure-cfg azconfig.yml -check.f=TestCreate
9 //
10 // Tests should be run individually and in the order they are listed in the file:
11 //
12 // Example azconfig.yml:
13 //
14 // ImageIDForTestSuite: "https://example.blob.core.windows.net/system/Microsoft.Compute/Images/images/zzzzz-compute-osDisk.XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.vhd"
15 // DriverParameters:
16 //       SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
17 //       ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
18 //       Location: centralus
19 //       CloudEnvironment: AzurePublicCloud
20 //       ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
21 //       TenantId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
22 //       ResourceGroup: zzzzz
23 //       Network: zzzzz
24 //       Subnet: zzzzz-subnet-private
25 //       StorageAccount: example
26 //       BlobContainer: vhds
27 //       DeleteDanglingResourcesAfter: 20s
28 //       AdminUsername: crunch
29
30 package azure
31
32 import (
33         "context"
34         "encoding/json"
35         "errors"
36         "flag"
37         "io/ioutil"
38         "log"
39         "net"
40         "net/http"
41         "os"
42         "testing"
43         "time"
44
45         "git.curoverse.com/arvados.git/lib/cloud"
46         "git.curoverse.com/arvados.git/sdk/go/arvados"
47         "git.curoverse.com/arvados.git/sdk/go/config"
48         "github.com/Azure/azure-sdk-for-go/services/compute/mgmt/2018-06-01/compute"
49         "github.com/Azure/azure-sdk-for-go/services/network/mgmt/2018-06-01/network"
50         "github.com/Azure/azure-sdk-for-go/storage"
51         "github.com/Azure/go-autorest/autorest"
52         "github.com/Azure/go-autorest/autorest/azure"
53         "github.com/Azure/go-autorest/autorest/to"
54         "github.com/sirupsen/logrus"
55         "golang.org/x/crypto/ssh"
56         check "gopkg.in/check.v1"
57 )
58
59 // Gocheck boilerplate
60 func Test(t *testing.T) {
61         check.TestingT(t)
62 }
63
64 type AzureInstanceSetSuite struct{}
65
66 var _ = check.Suite(&AzureInstanceSetSuite{})
67
68 type VirtualMachinesClientStub struct{}
69
70 var testKey = []byte(`ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDLQS1ExT2+WjA0d/hntEAyAtgeN1W2ik2QX8c2zO6HjlPHWXL92r07W0WMuDib40Pcevpi1BXeBWXA9ZB5KKMJB+ukaAu22KklnQuUmNvk6ZXnPKSkGxuCYvPQb08WhHf3p1VxiKfP3iauedBDM4x9/bkJohlBBQiFXzNUcQ+a6rKiMzmJN2gbL8ncyUzc+XQ5q4JndTwTGtOlzDiGOc9O4z5Dd76wtAVJneOuuNpwfFRVHThpJM6VThpCZOnl8APaceWXKeuwOuCae3COZMz++xQfxOfZ9Z8aIwo+TlQhsRaNfZ4Vjrop6ej8dtfZtgUFKfbXEOYaHrGrWGotFDTD example@example`)
71
72 func (*VirtualMachinesClientStub) createOrUpdate(ctx context.Context,
73         resourceGroupName string,
74         VMName string,
75         parameters compute.VirtualMachine) (result compute.VirtualMachine, err error) {
76         parameters.ID = &VMName
77         parameters.Name = &VMName
78         return parameters, nil
79 }
80
81 func (*VirtualMachinesClientStub) delete(ctx context.Context, resourceGroupName string, VMName string) (result *http.Response, err error) {
82         return nil, nil
83 }
84
85 func (*VirtualMachinesClientStub) listComplete(ctx context.Context, resourceGroupName string) (result compute.VirtualMachineListResultIterator, err error) {
86         return compute.VirtualMachineListResultIterator{}, nil
87 }
88
89 type InterfacesClientStub struct{}
90
91 func (*InterfacesClientStub) createOrUpdate(ctx context.Context,
92         resourceGroupName string,
93         nicName string,
94         parameters network.Interface) (result network.Interface, err error) {
95         parameters.ID = to.StringPtr(nicName)
96         (*parameters.IPConfigurations)[0].PrivateIPAddress = to.StringPtr("192.168.5.5")
97         return parameters, nil
98 }
99
100 func (*InterfacesClientStub) delete(ctx context.Context, resourceGroupName string, VMName string) (result *http.Response, err error) {
101         return nil, nil
102 }
103
104 func (*InterfacesClientStub) listComplete(ctx context.Context, resourceGroupName string) (result network.InterfaceListResultIterator, err error) {
105         return network.InterfaceListResultIterator{}, nil
106 }
107
108 type testConfig struct {
109         ImageIDForTestSuite string
110         DriverParameters    json.RawMessage
111 }
112
113 var live = flag.String("live-azure-cfg", "", "Test with real azure API, provide config file")
114
115 func GetInstanceSet() (cloud.InstanceSet, cloud.ImageID, arvados.Cluster, error) {
116         cluster := arvados.Cluster{
117                 InstanceTypes: arvados.InstanceTypeMap(map[string]arvados.InstanceType{
118                         "tiny": arvados.InstanceType{
119                                 Name:         "tiny",
120                                 ProviderType: "Standard_D1_v2",
121                                 VCPUs:        1,
122                                 RAM:          4000000000,
123                                 Scratch:      10000000000,
124                                 Price:        .02,
125                                 Preemptible:  false,
126                         },
127                 })}
128         if *live != "" {
129                 var exampleCfg testConfig
130                 err := config.LoadFile(&exampleCfg, *live)
131                 if err != nil {
132                         return nil, cloud.ImageID(""), cluster, err
133                 }
134
135                 ap, err := newAzureInstanceSet(exampleCfg.DriverParameters, "test123", logrus.StandardLogger())
136                 return ap, cloud.ImageID(exampleCfg.ImageIDForTestSuite), cluster, err
137         }
138         ap := azureInstanceSet{
139                 azconfig: azureInstanceSetConfig{
140                         BlobContainer: "vhds",
141                 },
142                 dispatcherID: "test123",
143                 namePrefix:   "compute-test123-",
144                 logger:       logrus.StandardLogger(),
145                 deleteNIC:    make(chan string),
146                 deleteBlob:   make(chan storage.Blob),
147         }
148         ap.ctx, ap.stopFunc = context.WithCancel(context.Background())
149         ap.vmClient = &VirtualMachinesClientStub{}
150         ap.netClient = &InterfacesClientStub{}
151         return &ap, cloud.ImageID("blob"), cluster, nil
152 }
153
154 func (*AzureInstanceSetSuite) TestCreate(c *check.C) {
155         ap, img, cluster, err := GetInstanceSet()
156         if err != nil {
157                 c.Fatal("Error making provider", err)
158         }
159
160         pk, _, _, _, err := ssh.ParseAuthorizedKey(testKey)
161         c.Assert(err, check.IsNil)
162
163         inst, err := ap.Create(cluster.InstanceTypes["tiny"],
164                 img, map[string]string{
165                         "TestTagName": "test tag value",
166                 }, "umask 0600; echo -n test-file-data >/var/run/test-file", pk)
167
168         c.Assert(err, check.IsNil)
169
170         tags := inst.Tags()
171         c.Check(tags["TestTagName"], check.Equals, "test tag value")
172         c.Logf("inst.String()=%v Address()=%v Tags()=%v", inst.String(), inst.Address(), tags)
173
174 }
175
176 func (*AzureInstanceSetSuite) TestListInstances(c *check.C) {
177         ap, _, _, err := GetInstanceSet()
178         if err != nil {
179                 c.Fatal("Error making provider", err)
180         }
181
182         l, err := ap.Instances(nil)
183
184         c.Assert(err, check.IsNil)
185
186         for _, i := range l {
187                 tg := i.Tags()
188                 log.Printf("%v %v %v", i.String(), i.Address(), tg)
189         }
190 }
191
192 func (*AzureInstanceSetSuite) TestManageNics(c *check.C) {
193         ap, _, _, err := GetInstanceSet()
194         if err != nil {
195                 c.Fatal("Error making provider", err)
196         }
197
198         ap.(*azureInstanceSet).manageNics()
199         ap.Stop()
200 }
201
202 func (*AzureInstanceSetSuite) TestManageBlobs(c *check.C) {
203         ap, _, _, err := GetInstanceSet()
204         if err != nil {
205                 c.Fatal("Error making provider", err)
206         }
207
208         ap.(*azureInstanceSet).manageBlobs()
209         ap.Stop()
210 }
211
212 func (*AzureInstanceSetSuite) TestDestroyInstances(c *check.C) {
213         ap, _, _, err := GetInstanceSet()
214         if err != nil {
215                 c.Fatal("Error making provider", err)
216         }
217
218         l, err := ap.Instances(nil)
219         c.Assert(err, check.IsNil)
220
221         for _, i := range l {
222                 c.Check(i.Destroy(), check.IsNil)
223         }
224 }
225
226 func (*AzureInstanceSetSuite) TestDeleteFake(c *check.C) {
227         ap, _, _, err := GetInstanceSet()
228         if err != nil {
229                 c.Fatal("Error making provider", err)
230         }
231
232         _, err = ap.(*azureInstanceSet).netClient.delete(context.Background(), "fakefakefake", "fakefakefake")
233
234         de, ok := err.(autorest.DetailedError)
235         if ok {
236                 rq := de.Original.(*azure.RequestError)
237
238                 log.Printf("%v %q %q", rq.Response.StatusCode, rq.ServiceError.Code, rq.ServiceError.Message)
239         }
240 }
241
242 func (*AzureInstanceSetSuite) TestWrapError(c *check.C) {
243         retryError := autorest.DetailedError{
244                 Original: &azure.RequestError{
245                         DetailedError: autorest.DetailedError{
246                                 Response: &http.Response{
247                                         StatusCode: 429,
248                                         Header:     map[string][]string{"Retry-After": []string{"123"}},
249                                 },
250                         },
251                         ServiceError: &azure.ServiceError{},
252                 },
253         }
254         wrapped := wrapAzureError(retryError)
255         _, ok := wrapped.(cloud.RateLimitError)
256         c.Check(ok, check.Equals, true)
257
258         quotaError := autorest.DetailedError{
259                 Original: &azure.RequestError{
260                         DetailedError: autorest.DetailedError{
261                                 Response: &http.Response{
262                                         StatusCode: 503,
263                                 },
264                         },
265                         ServiceError: &azure.ServiceError{
266                                 Message: "No more quota",
267                         },
268                 },
269         }
270         wrapped = wrapAzureError(quotaError)
271         _, ok = wrapped.(cloud.QuotaError)
272         c.Check(ok, check.Equals, true)
273 }
274
275 func (*AzureInstanceSetSuite) TestSetTags(c *check.C) {
276         ap, _, _, err := GetInstanceSet()
277         if err != nil {
278                 c.Fatal("Error making provider", err)
279         }
280         l, err := ap.Instances(nil)
281         c.Assert(err, check.IsNil)
282
283         if len(l) > 0 {
284                 err = l[0].SetTags(map[string]string{"foo": "bar"})
285                 if err != nil {
286                         c.Fatal("Error setting tags", err)
287                 }
288         }
289         l, err = ap.Instances(nil)
290         c.Assert(err, check.IsNil)
291
292         if len(l) > 0 {
293                 tg := l[0].Tags()
294                 log.Printf("tags are %v", tg)
295         }
296 }
297
298 func (*AzureInstanceSetSuite) TestSSH(c *check.C) {
299         ap, _, _, err := GetInstanceSet()
300         if err != nil {
301                 c.Fatal("Error making provider", err)
302         }
303         l, err := ap.Instances(nil)
304         c.Assert(err, check.IsNil)
305
306         if len(l) > 0 {
307                 sshclient, err := SetupSSHClient(c, l[0])
308                 c.Assert(err, check.IsNil)
309                 defer sshclient.Conn.Close()
310
311                 sess, err := sshclient.NewSession()
312                 c.Assert(err, check.IsNil)
313                 defer sess.Close()
314                 _, err = sess.Output("find /var/run/test-file -maxdepth 0 -user root -perm 0600")
315                 c.Assert(err, check.IsNil)
316
317                 sess, err = sshclient.NewSession()
318                 c.Assert(err, check.IsNil)
319                 defer sess.Close()
320                 out, err := sess.Output("sudo cat /var/run/test-file")
321                 c.Assert(err, check.IsNil)
322                 c.Check(string(out), check.Equals, "test-file-data")
323         }
324 }
325
326 func SetupSSHClient(c *check.C, inst cloud.Instance) (*ssh.Client, error) {
327         addr := inst.Address() + ":2222"
328         if addr == "" {
329                 return nil, errors.New("instance has no address")
330         }
331
332         f, err := os.Open("azconfig_sshkey")
333         c.Assert(err, check.IsNil)
334
335         keybytes, err := ioutil.ReadAll(f)
336         c.Assert(err, check.IsNil)
337
338         priv, err := ssh.ParsePrivateKey(keybytes)
339         c.Assert(err, check.IsNil)
340
341         var receivedKey ssh.PublicKey
342         client, err := ssh.Dial("tcp", addr, &ssh.ClientConfig{
343                 User: "crunch",
344                 Auth: []ssh.AuthMethod{
345                         ssh.PublicKeys(priv),
346                 },
347                 HostKeyCallback: func(hostname string, remote net.Addr, key ssh.PublicKey) error {
348                         receivedKey = key
349                         return nil
350                 },
351                 Timeout: time.Minute,
352         })
353
354         if err != nil {
355                 return nil, err
356         } else if receivedKey == nil {
357                 return nil, errors.New("BUG: key was never provided to HostKeyCallback")
358         }
359
360         err = inst.VerifyHostKey(receivedKey, client)
361         c.Assert(err, check.IsNil)
362
363         return client, nil
364 }