forked from elgohr/go-localstack
-
Notifications
You must be signed in to change notification settings - Fork 0
/
localstack.go
434 lines (389 loc) · 12.3 KB
/
localstack.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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
// Copyright 2021 - Lars Gohr
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package localstack
import (
"context"
"fmt"
"github.com/Masterminds/semver/v3"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/config"
"github.com/aws/aws-sdk-go-v2/credentials"
"github.com/aws/aws-sdk-go-v2/service/dynamodb"
dynamo_types "github.com/aws/aws-sdk-go-v2/service/dynamodb/types"
"github.com/docker/docker/api/types"
"github.com/docker/docker/api/types/container"
"github.com/docker/docker/client"
"github.com/docker/go-connections/nat"
"github.com/sirupsen/logrus"
"io"
"log"
"strings"
"sync"
"time"
"github.com/gtmtechltd/go-localstack/internal"
)
// Instance manages the localstack
type Instance struct {
cli internal.DockerClient
log *logrus.Logger
portMapping map[Service]string
containerId string
containerIdMutex sync.RWMutex
version string
fixedPort bool
}
// InstanceOption is an option that controls the behaviour of
// localstack.
type InstanceOption func(i *Instance)
// WithVersion configures the instance to use a specific version of
// localstack. Must be a valid version string or "latest".
func WithVersion(version string) InstanceOption {
return func(i *Instance) {
i.version = version
}
}
// WithLogger configures the instance to use the specified logger.
func WithLogger(logger *logrus.Logger) InstanceOption {
return func(i *Instance) {
i.log = logger
}
}
// Semver constraint that tests it the version is affected by the port change.
var portChangeIntroduced = internal.MustParseConstraint(">= 0.11.5")
// NewInstance creates a new Instance
// Fails when Docker is not reachable
func NewInstance(opts ...InstanceOption) (*Instance, error) {
cli, err := client.NewClientWithOpts()
if err != nil {
return nil, fmt.Errorf("localstack: could not connect to docker: %w", err)
}
i := Instance{
cli: cli,
log: logrus.StandardLogger(),
version: "latest",
portMapping: map[Service]string{},
}
for _, opt := range opts {
opt(&i)
}
if i.version == "latest" {
i.fixedPort = true
} else {
version, err := semver.NewVersion(i.version)
if err != nil {
return nil, fmt.Errorf("localstack: invalid version %q specified: %w", i.version, err)
}
i.version = version.String()
i.fixedPort = portChangeIntroduced.Check(version)
}
log.Printf("fixedPort: %v", i.fixedPort)
log.Printf("version: %v", i.version)
return &i, nil
}
// Start starts the localstack
// Deprecated: Use StartWithContext instead.
func (i *Instance) Start() error {
return i.start(context.Background())
}
// StartWithContext starts the localstack and ends it when the context is done.
// Use it to also start individual services, by default all are started.
func (i *Instance) StartWithContext(ctx context.Context, services ...Service) error {
go func() {
<-ctx.Done()
if err := i.stop(); err != nil {
i.log.Error(err)
}
}()
return i.start(ctx, services...)
}
// Stop stops the localstack
// Deprecated: Use StartWithContext instead.
func (i *Instance) Stop() error {
return i.stop()
}
// Endpoint returns the endpoint for the given service
// Endpoints are allocated dynamically (to avoid blocked ports), but are fix after starting the instance
func (i *Instance) Endpoint(service Service) string {
if i.getContainerId() != "" {
if i.fixedPort {
return i.portMapping[FixedPort]
}
return i.portMapping[service]
}
return ""
}
// EndpointV2 returns the endpoint for the given service when used by aws-sdk-v2
// Endpoints are allocated dynamically (to avoid blocked ports), but are fix after starting the instance
func (i *Instance) EndpointV2(service Service) string {
if i.getContainerId() != "" {
if i.fixedPort {
return "http://" + i.portMapping[FixedPort]
}
return "http://" + i.portMapping[service]
}
return ""
}
// Service represents an AWS service
type Service struct {
Name string
Port string
}
// Supported AWS/localstack services
var (
FixedPort = Service{Name: "all", Port: "4566/tcp"}
CloudFormation = Service{Name: "cloudformation", Port: "4581/tcp"}
CloudWatch = Service{Name: "cloudwatch", Port: "4582/tcp"}
CloudWatchLogs = Service{Name: "cloudwatchlogs", Port: "4586/tcp"}
CloudWatchEvents = Service{Name: "cloudwatchevents", Port: "4587/tcp"}
DynamoDB = Service{Name: "dynamoDB", Port: "4569/tcp"}
DynamoDBStreams = Service{Name: "dynamoDBStreams", Port: "4570/tcp"}
EC2 = Service{Name: "ec2", Port: "4597/tcp"}
ES = Service{Name: "es", Port: "4578/tcp"}
Firehose = Service{Name: "firehose", Port: "4573/tcp"}
IAM = Service{Name: "iam", Port: "4593/tcp"}
Kinesis = Service{Name: "kinesis", Port: "4568/tcp"}
Lambda = Service{Name: "lambda", Port: "4574/tcp"}
Redshift = Service{Name: "redshift", Port: "4577/tcp"}
Route53 = Service{Name: "route53", Port: "4580/tcp"}
S3 = Service{Name: "s3", Port: "4572/tcp"}
SecretsManager = Service{Name: "secretsmanager", Port: "4584/tcp"}
SES = Service{Name: "ses", Port: "4579/tcp"}
SNS = Service{Name: "sns", Port: "4575/tcp"}
SQS = Service{Name: "sqs", Port: "4576/tcp"}
SSM = Service{Name: "ssm", Port: "4583/tcp"}
STS = Service{Name: "sts", Port: "4592/tcp"}
StepFunctions = Service{Name: "stepfunctions", Port: "4585/tcp"}
)
// AvailableServices provides a map of all services for faster searches
var AvailableServices = map[Service]struct{}{
FixedPort: {},
CloudFormation: {},
CloudWatch: {},
CloudWatchLogs: {},
CloudWatchEvents: {},
DynamoDB: {},
DynamoDBStreams: {},
EC2: {},
ES: {},
Firehose: {},
IAM: {},
Kinesis: {},
Lambda: {},
Redshift: {},
Route53: {},
S3: {},
SecretsManager: {},
SES: {},
SNS: {},
SQS: {},
SSM: {},
STS: {},
StepFunctions: {},
}
func (i *Instance) start(ctx context.Context, services ...Service) error {
if i.isAlreadyRunning() {
i.log.Info("stopping an instance that is already running")
if err := i.stop(); err != nil {
return fmt.Errorf("localstack: can't stop an already running instance: %w", err)
}
}
if err := i.startLocalstack(ctx, services...); err != nil {
return err
}
i.log.Info("waiting for localstack to start...")
return i.waitToBeAvailable(ctx)
}
func (i *Instance) startLocalstack(ctx context.Context, services ...Service) error {
imageName := "localstack/localstack:" + i.version
if !i.isDownloaded(ctx) {
reader, err := i.cli.ImagePull(ctx, imageName, types.ImagePullOptions{})
if err != nil {
return fmt.Errorf("localstack: could not load image: %w", err)
}
defer func() {
if err := reader.Close(); err != nil {
i.log.Error(err)
}
}()
// for reading the load output
if _, err = io.Copy(i.log.Out, reader); err != nil {
return fmt.Errorf("localstack: %w", err)
}
}
pm := nat.PortMap{}
for service := range AvailableServices {
log.Printf("Setting mapping %v to 127.0.0.1:%v", service.Port, strings.Split(service.Port, "/")[0])
pm[nat.Port(service.Port)] = []nat.PortBinding{{HostIP: "127.0.0.1", HostPort: strings.Split(service.Port, "/")[0]}}
}
log.Printf("portmapping is %v", pm)
environmentVariables := []string{}
if len(services) > 0 {
startServices := "SERVICES=dynamodb" // for waitToBeAvailable
addedServices := 0
for _, service := range services {
if shouldBeAdded(service) {
startServices += "," + service.Name
addedServices++
}
}
if addedServices > 0 {
environmentVariables = append(environmentVariables, startServices)
}
}
resp, err := i.cli.ContainerCreate(ctx,
&container.Config{
Image: imageName,
Env: environmentVariables,
}, &container.HostConfig{
PortBindings: pm,
AutoRemove: true,
}, nil, nil, "")
if err != nil {
return fmt.Errorf("localstack: could not create container: %w", err)
}
time.Sleep(30)
i.setContainerId(resp.ID)
i.log.Info("starting localstack")
containerId := resp.ID
if err := i.cli.ContainerStart(ctx, containerId, types.ContainerStartOptions{}); err != nil {
return fmt.Errorf("localstack: could not start container: %w", err)
}
startedContainer, err := i.cli.ContainerInspect(ctx, containerId)
if err != nil {
return fmt.Errorf("localstack: could not get port from container: %w", err)
}
ports := startedContainer.NetworkSettings.Ports
if i.fixedPort {
i.portMapping[FixedPort] = "localhost:" + ports[nat.Port(FixedPort.Port)][0].HostPort
} else {
hasFilteredServices := len(services) > 0
for service := range AvailableServices {
if hasFilteredServices && containsService(services, service) {
i.portMapping[service] = "localhost:" + ports[nat.Port(service.Port)][0].HostPort
} else if !hasFilteredServices {
i.portMapping[service] = "localhost:" + ports[nat.Port(service.Port)][0].HostPort
}
}
}
return nil
}
func (i *Instance) stop() error {
containerId := i.getContainerId()
if containerId == "" {
return nil
}
timeout := time.Second
if err := i.cli.ContainerStop(context.Background(), containerId, &timeout); err != nil {
return err
}
i.setContainerId("")
i.portMapping = map[Service]string{}
return nil
}
func (i *Instance) isDownloaded(ctx context.Context) bool {
list, err := i.cli.ImageList(ctx, types.ImageListOptions{All: true})
if err != nil {
i.log.Error(err)
return false
}
for _, image := range list {
for _, tag := range image.RepoTags {
if tag == "localstack/localstack:"+i.version {
return true
}
}
}
return false
}
func (i *Instance) waitToBeAvailable(ctx context.Context) error {
ticker := time.NewTicker(time.Second)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
return ctx.Err()
case <-ticker.C:
if err := i.checkAvailable(ctx); err == nil {
i.log.Info("localstack: finished waiting")
return nil
} else {
i.log.Debug(err)
}
}
}
}
func (i *Instance) checkAvailable(ctx context.Context) error {
cfg, err := config.LoadDefaultConfig(ctx,
config.WithRegion("us-east-1"),
config.WithEndpointResolverWithOptions(aws.EndpointResolverWithOptionsFunc(func(_, _ string, _ ...interface{}) (aws.Endpoint, error) {
return aws.Endpoint{
PartitionID: "aws",
URL: i.EndpointV2(DynamoDB),
SigningRegion: "us-east-1",
HostnameImmutable: true,
}, nil
})),
config.WithCredentialsProvider(credentials.NewStaticCredentialsProvider("dummy", "dummy", "dummy")),
)
if err != nil {
return err
}
s := dynamodb.NewFromConfig(cfg)
testTable := aws.String("bucket")
if _, err = s.CreateTable(ctx, &dynamodb.CreateTableInput{
AttributeDefinitions: []dynamo_types.AttributeDefinition{
{AttributeName: aws.String("PK"), AttributeType: dynamo_types.ScalarAttributeTypeS},
},
KeySchema: []dynamo_types.KeySchemaElement{
{AttributeName: aws.String("PK"), KeyType: dynamo_types.KeyTypeHash},
},
ProvisionedThroughput: &dynamo_types.ProvisionedThroughput{
ReadCapacityUnits: aws.Int64(1), WriteCapacityUnits: aws.Int64(1),
},
TableName: testTable,
}); err != nil {
return err
}
_, err = s.DeleteTable(ctx, &dynamodb.DeleteTableInput{
TableName: testTable,
})
return err
}
func (i *Instance) isAlreadyRunning() bool {
return i.getContainerId() != ""
}
func (i *Instance) getContainerId() string {
i.containerIdMutex.RLock()
defer i.containerIdMutex.RUnlock()
return i.containerId
}
func (i *Instance) setContainerId(v string) {
i.containerIdMutex.Lock()
defer i.containerIdMutex.Unlock()
i.containerId = v
}
func shouldBeAdded(service Service) bool {
return service != DynamoDB && service != FixedPort && service != ES
}
func containsService(services []Service, service Service) bool {
if service == DynamoDB {
return true
}
for _, s := range services {
if s == service {
return true
}
}
return false
}