forked from gruntwork-io/terratest
-
Notifications
You must be signed in to change notification settings - Fork 0
/
region.go
123 lines (101 loc) · 4.24 KB
/
region.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
package aws
import (
"os"
"testing"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/service/ec2"
"github.com/gruntwork-io/terratest/modules/collections"
"github.com/gruntwork-io/terratest/modules/logger"
"github.com/gruntwork-io/terratest/modules/random"
)
// You can set this environment variable to force Terratest to use a specific region rather than a random one. This is
// convenient when iterating locally.
const regionOverrideEnvVarName = "TERRATEST_REGION"
// AWS API calls typically require an AWS region. We typically require the user to set one explicitly, but in some
// cases, this doesn't make sense (e.g., for fetching the lsit of regions in an account), so for those cases, we use
// this region as a default.
const defaultRegion = "us-east-1"
// GetRandomRegion gets a randomly chosen AWS region. If approvedRegions is not empty, this will be a region from the approvedRegions
// list; otherwise, this method will fetch the latest list of regions from the AWS APIs and pick one of those. If
// forbiddenRegions is not empty, this method will make sure the returned region is not in the forbiddenRegions list.
func GetRandomRegion(t *testing.T, approvedRegions []string, forbiddenRegions []string) string {
region, err := GetRandomRegionE(t, approvedRegions, forbiddenRegions)
if err != nil {
t.Fatal(err)
}
return region
}
// GetRandomRegionE gets a randomly chosen AWS region. If approvedRegions is not empty, this will be a region from the approvedRegions
// list; otherwise, this method will fetch the latest list of regions from the AWS APIs and pick one of those. If
// forbiddenRegions is not empty, this method will make sure the returned region is not in the forbiddenRegions list.
func GetRandomRegionE(t *testing.T, approvedRegions []string, forbiddenRegions []string) (string, error) {
regionFromEnvVar := os.Getenv(regionOverrideEnvVarName)
if regionFromEnvVar != "" {
logger.Logf(t, "Using AWS region %s from environment variable %s", regionFromEnvVar, regionOverrideEnvVarName)
return regionFromEnvVar, nil
}
regionsToPickFrom := approvedRegions
if len(regionsToPickFrom) == 0 {
allRegions, err := GetAllAwsRegionsE(t)
if err != nil {
return "", err
}
regionsToPickFrom = allRegions
}
regionsToPickFrom = collections.ListSubtract(regionsToPickFrom, forbiddenRegions)
region := random.RandomString(regionsToPickFrom)
logger.Logf(t, "Using region %s", region)
return region, nil
}
// GetAllAwsRegions gets the list of AWS regions available in this account.
func GetAllAwsRegions(t *testing.T) []string {
out, err := GetAllAwsRegionsE(t)
if err != nil {
t.Fatal(err)
}
return out
}
// GetAllAwsRegionsE gets the list of AWS regions available in this account.
func GetAllAwsRegionsE(t *testing.T) ([]string, error) {
logger.Log(t, "Looking up all AWS regions available in this account")
ec2Client, err := NewEc2ClientE(t, defaultRegion)
if err != nil {
return nil, err
}
out, err := ec2Client.DescribeRegions(&ec2.DescribeRegionsInput{})
if err != nil {
return nil, err
}
regions := []string{}
for _, region := range out.Regions {
regions = append(regions, aws.StringValue(region.RegionName))
}
return regions, nil
}
// GetAvailabilityZones gets the Availability Zones for a given AWS region. Note that for certain regions (e.g. us-east-1), different AWS
// accounts have access to different availability zones.
func GetAvailabilityZones(t *testing.T, region string) []string {
out, err := GetAvailabilityZonesE(t, region)
if err != nil {
t.Fatal(err)
}
return out
}
// GetAvailabilityZonesE gets the Availability Zones for a given AWS region. Note that for certain regions (e.g. us-east-1), different AWS
// accounts have access to different availability zones.
func GetAvailabilityZonesE(t *testing.T, region string) ([]string, error) {
logger.Logf(t, "Looking up all availability zones available in this account for region %s", region)
ec2Client, err := NewEc2ClientE(t, region)
if err != nil {
return nil, err
}
resp, err := ec2Client.DescribeAvailabilityZones(&ec2.DescribeAvailabilityZonesInput{})
if err != nil {
return nil, err
}
var out []string
for _, availabilityZone := range resp.AvailabilityZones {
out = append(out, aws.StringValue(availabilityZone.ZoneName))
}
return out, nil
}