lib/cloud/ec2/ec2_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.arvados.org/arvados.git/lib/cloud/ec2 -live-ec2-cfg ec2config.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: ami-xxxxxxxxxxxxxxxxx
  15 // DriverParameters:
  16 //       AccessKeyID: XXXXXXXXXXXXXX
  17 //       SecretAccessKey: xxxxxxxxxxxxxxxxxxxx
  18 //       Region: us-east-1
  19 //       SecurityGroupIDs: [sg-xxxxxxxx]
  20 //       SubnetID: subnet-xxxxxxxx
  21 //       AdminUsername: crunch
  22
  23 package ec2
  24
  25 import (
  26         "encoding/json"
  27         "flag"
  28         "testing"
  29
  30         "git.arvados.org/arvados.git/lib/cloud"
  31         "git.arvados.org/arvados.git/lib/dispatchcloud/test"
  32         "git.arvados.org/arvados.git/sdk/go/arvados"
  33         "git.arvados.org/arvados.git/sdk/go/config"
  34         "github.com/aws/aws-sdk-go/aws"
  35         "github.com/aws/aws-sdk-go/service/ec2"
  36         "github.com/sirupsen/logrus"
  37         check "gopkg.in/check.v1"
  38 )
  39
  40 var live = flag.String("live-ec2-cfg", "", "Test with real EC2 API, provide config file")
  41
  42 // Gocheck boilerplate
  43 func Test(t *testing.T) {
  44         check.TestingT(t)
  45 }
  46
  47 type EC2InstanceSetSuite struct{}
  48
  49 var _ = check.Suite(&EC2InstanceSetSuite{})
  50
  51 type testConfig struct {
  52         ImageIDForTestSuite string
  53         DriverParameters    json.RawMessage
  54 }
  55
  56 type ec2stub struct {
  57 }
  58
  59 func (e *ec2stub) ImportKeyPair(input *ec2.ImportKeyPairInput) (*ec2.ImportKeyPairOutput, error) {
  60         return nil, nil
  61 }
  62
  63 func (e *ec2stub) DescribeKeyPairs(input *ec2.DescribeKeyPairsInput) (*ec2.DescribeKeyPairsOutput, error) {
  64         return &ec2.DescribeKeyPairsOutput{}, nil
  65 }
  66
  67 func (e *ec2stub) RunInstances(input *ec2.RunInstancesInput) (*ec2.Reservation, error) {
  68         return &ec2.Reservation{Instances: []*ec2.Instance{{
  69                 InstanceId: aws.String("i-123"),
  70                 Tags:       input.TagSpecifications[0].Tags,
  71         }}}, nil
  72 }
  73
  74 func (e *ec2stub) DescribeInstances(input *ec2.DescribeInstancesInput) (*ec2.DescribeInstancesOutput, error) {
  75         return &ec2.DescribeInstancesOutput{}, nil
  76 }
  77
  78 func (e *ec2stub) CreateTags(input *ec2.CreateTagsInput) (*ec2.CreateTagsOutput, error) {
  79         return nil, nil
  80 }
  81
  82 func (e *ec2stub) TerminateInstances(input *ec2.TerminateInstancesInput) (*ec2.TerminateInstancesOutput, error) {
  83         return nil, nil
  84 }
  85
  86 func GetInstanceSet() (cloud.InstanceSet, cloud.ImageID, arvados.Cluster, error) {
  87         cluster := arvados.Cluster{
  88                 InstanceTypes: arvados.InstanceTypeMap(map[string]arvados.InstanceType{
  89                         "tiny": {
  90                                 Name:         "tiny",
  91                                 ProviderType: "t2.micro",
  92                                 VCPUs:        1,
  93                                 RAM:          4000000000,
  94                                 Scratch:      10000000000,
  95                                 Price:        .02,
  96                                 Preemptible:  false,
  97                         },
  98                         "tiny-with-extra-scratch": {
  99                                 Name:         "tiny",
 100                                 ProviderType: "t2.micro",
 101                                 VCPUs:        1,
 102                                 RAM:          4000000000,
 103                                 Price:        .02,
 104                                 Preemptible:  false,
 105                                 AddedScratch: 20000000000,
 106                         },
 107                         "tiny-preemptible": {
 108                                 Name:         "tiny",
 109                                 ProviderType: "t2.micro",
 110                                 VCPUs:        1,
 111                                 RAM:          4000000000,
 112                                 Scratch:      10000000000,
 113                                 Price:        .02,
 114                                 Preemptible:  true,
 115                         },
 116                 })}
 117         if *live != "" {
 118                 var exampleCfg testConfig
 119                 err := config.LoadFile(&exampleCfg, *live)
 120                 if err != nil {
 121                         return nil, cloud.ImageID(""), cluster, err
 122                 }
 123
 124                 ap, err := newEC2InstanceSet(exampleCfg.DriverParameters, "test123", nil, logrus.StandardLogger())
 125                 return ap, cloud.ImageID(exampleCfg.ImageIDForTestSuite), cluster, err
 126         }
 127         ap := ec2InstanceSet{
 128                 ec2config:     ec2InstanceSetConfig{},
 129                 instanceSetID: "test123",
 130                 logger:        logrus.StandardLogger(),
 131                 client:        &ec2stub{},
 132                 keys:          make(map[string]string),
 133         }
 134         return &ap, cloud.ImageID("blob"), cluster, nil
 135 }
 136
 137 func (*EC2InstanceSetSuite) TestCreate(c *check.C) {
 138         ap, img, cluster, err := GetInstanceSet()
 139         if err != nil {
 140                 c.Fatal("Error making provider", err)
 141         }
 142
 143         pk, _ := test.LoadTestKey(c, "../../dispatchcloud/test/sshkey_dispatch")
 144         c.Assert(err, check.IsNil)
 145
 146         inst, err := ap.Create(cluster.InstanceTypes["tiny"],
 147                 img, map[string]string{
 148                         "TestTagName": "test tag value",
 149                 }, "umask 0600; echo -n test-file-data >/var/run/test-file", pk)
 150
 151         c.Assert(err, check.IsNil)
 152
 153         tags := inst.Tags()
 154         c.Check(tags["TestTagName"], check.Equals, "test tag value")
 155         c.Logf("inst.String()=%v Address()=%v Tags()=%v", inst.String(), inst.Address(), tags)
 156
 157 }
 158
 159 func (*EC2InstanceSetSuite) TestCreateWithExtraScratch(c *check.C) {
 160         ap, img, cluster, err := GetInstanceSet()
 161         if err != nil {
 162                 c.Fatal("Error making provider", err)
 163         }
 164
 165         pk, _ := test.LoadTestKey(c, "../../dispatchcloud/test/sshkey_dispatch")
 166         c.Assert(err, check.IsNil)
 167
 168         inst, err := ap.Create(cluster.InstanceTypes["tiny-with-extra-scratch"],
 169                 img, map[string]string{
 170                         "TestTagName": "test tag value",
 171                 }, "umask 0600; echo -n test-file-data >/var/run/test-file", pk)
 172
 173         c.Assert(err, check.IsNil)
 174
 175         tags := inst.Tags()
 176         c.Check(tags["TestTagName"], check.Equals, "test tag value")
 177         c.Logf("inst.String()=%v Address()=%v Tags()=%v", inst.String(), inst.Address(), tags)
 178
 179 }
 180
 181 func (*EC2InstanceSetSuite) TestCreatePreemptible(c *check.C) {
 182         ap, img, cluster, err := GetInstanceSet()
 183         if err != nil {
 184                 c.Fatal("Error making provider", err)
 185         }
 186
 187         pk, _ := test.LoadTestKey(c, "../../dispatchcloud/test/sshkey_dispatch")
 188         c.Assert(err, check.IsNil)
 189
 190         inst, err := ap.Create(cluster.InstanceTypes["tiny-preemptible"],
 191                 img, map[string]string{
 192                         "TestTagName": "test tag value",
 193                 }, "umask 0600; echo -n test-file-data >/var/run/test-file", pk)
 194
 195         c.Assert(err, check.IsNil)
 196
 197         tags := inst.Tags()
 198         c.Check(tags["TestTagName"], check.Equals, "test tag value")
 199         c.Logf("inst.String()=%v Address()=%v Tags()=%v", inst.String(), inst.Address(), tags)
 200
 201 }
 202
 203 func (*EC2InstanceSetSuite) TestTagInstances(c *check.C) {
 204         ap, _, _, err := GetInstanceSet()
 205         if err != nil {
 206                 c.Fatal("Error making provider", err)
 207         }
 208
 209         l, err := ap.Instances(nil)
 210         c.Assert(err, check.IsNil)
 211
 212         for _, i := range l {
 213                 tg := i.Tags()
 214                 tg["TestTag2"] = "123 test tag 2"
 215                 c.Check(i.SetTags(tg), check.IsNil)
 216         }
 217 }
 218
 219 func (*EC2InstanceSetSuite) TestListInstances(c *check.C) {
 220         ap, _, _, err := GetInstanceSet()
 221         if err != nil {
 222                 c.Fatal("Error making provider: ", err)
 223         }
 224
 225         l, err := ap.Instances(nil)
 226
 227         c.Assert(err, check.IsNil)
 228
 229         for _, i := range l {
 230                 tg := i.Tags()
 231                 c.Logf("%v %v %v", i.String(), i.Address(), tg)
 232         }
 233 }
 234
 235 func (*EC2InstanceSetSuite) TestDestroyInstances(c *check.C) {
 236         ap, _, _, err := GetInstanceSet()
 237         if err != nil {
 238                 c.Fatal("Error making provider", err)
 239         }
 240
 241         l, err := ap.Instances(nil)
 242         c.Assert(err, check.IsNil)
 243
 244         for _, i := range l {
 245                 c.Check(i.Destroy(), check.IsNil)
 246         }
 247 }
 248
 249 var TestRateLimitErrorInterface cloud.RateLimitError = rateLimitError{}