Add dynamodb

aws/dynamodb.go

@@ -0,0 +1,69 @@
+package aws
+
+import (
+	"context"
+	"fmt"
+	"log"
+
+	awssdk "github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/aws/aws-sdk-go-v2/service/dynamodb"
+	"github.com/noclickops/common"
+)
+
+type DynamodbClient interface {
+	ListTables(ctx context.Context, params *dynamodb.ListTablesInput, optFns ...func(*dynamodb.Options)) (*dynamodb.ListTablesOutput, error)
+}
+
+type NoclickopsDynamodbClient struct {
+	Client DynamodbClient
+	ClientMeta
+}
+
+type NoclickopsDynamodbService struct {
+	Clients []NoclickopsDynamodbClient
+	common.ServiceMeta
+}
+
+func NewDynamodbServiceFromConfigs(cfg []awssdk.Config, meta common.ServiceMeta) NoclickopsDynamodbService {
+	service := NoclickopsDynamodbService{ServiceMeta: meta}
+	for _, c := range cfg {
+		service.Clients = append(service.Clients, NoclickopsDynamodbClient{
+			Client:     dynamodb.NewFromConfig(c),
+			ClientMeta: ClientMeta{Region: c.Region},
+		})
+	}
+	return service
+}
+
+func (s *NoclickopsDynamodbService) GetAllResources() []common.Resource {
+	return s.GetTables()
+}
+
+func (s *NoclickopsDynamodbService) GetTables() []common.Resource {
+	var resources []common.Resource
+	for _, rc := range s.Clients {
+		var exclusiveStartTableName *string = nil
+		for {
+			res, err := rc.Client.ListTables(context.TODO(), &dynamodb.ListTablesInput{
+				ExclusiveStartTableName: exclusiveStartTableName,
+			})
+			if err != nil {
+				log.Printf("warning: %v", err)
+				break
+			}
+
+			for _, table := range res.TableNames {
+				// dynamodb table ARN format:
+				//  arn:${Partition}:dynamodb:${Region}:${Account}:table/${TableName}
+				arn := fmt.Sprintf("arn:aws:dynamodb:%v:%v:table/%v", rc.Region, s.AccountId, table)
+				resources = append(resources, common.Resource{Arn: arn, TerraformID: table, ResourceType: common.Dynamodb_table, Region: rc.Region})
+			}
+
+			if res.LastEvaluatedTableName == nil {
+				break
+			}
+			exclusiveStartTableName = res.LastEvaluatedTableName
+		}
+	}
+	return resources
+}

aws/dynamodb_test.go

@@ -0,0 +1,102 @@
+package aws_test
+
+import (
+	"context"
+	"fmt"
+	"testing"
+
+	"github.com/aws/aws-sdk-go-v2/service/dynamodb"
+	"github.com/google/go-cmp/cmp"
+	"github.com/noclickops/aws"
+	"github.com/noclickops/common"
+)
+
+func getMockedDynamodbService(mock *mockDynamodbClient) aws.NoclickopsDynamodbService {
+	return aws.NoclickopsDynamodbService{
+		Clients: []aws.NoclickopsDynamodbClient{
+			{
+				Client:     mock,
+				ClientMeta: aws.ClientMeta{Region: "eu-west-1"},
+			},
+		},
+		ServiceMeta: common.ServiceMeta{Global: false, ServiceName: "dynamodb", AccountId: "123456789012"},
+	}
+}
+
+func TestGetDynamodbTables_BasicCase(t *testing.T) {
+	mock := &mockDynamodbClient{
+		listTablesFn: func(_ context.Context, _ *dynamodb.ListTablesInput, _ ...func(*dynamodb.Options)) (*dynamodb.ListTablesOutput, error) {
+			return &dynamodb.ListTablesOutput{
+				TableNames: []string{"table-1", "table-2"},
+			}, nil
+		},
+	}
+	svc := getMockedDynamodbService(mock)
+	got := svc.GetTables()
+	expected := []common.Resource{
+		{Arn: "arn:aws:dynamodb:eu-west-1:123456789012:table/table-1", TerraformID: "table-1", ResourceType: common.Dynamodb_table, Region: "eu-west-1"},
+		{Arn: "arn:aws:dynamodb:eu-west-1:123456789012:table/table-2", TerraformID: "table-2", ResourceType: common.Dynamodb_table, Region: "eu-west-1"},
+	}
+	if diff := cmp.Diff(got, expected); diff != "" {
+		t.Errorf("mismatch (-got +want):\n%s", diff)
+	}
+}
+
+func TestGetDynamodbTables_NoTables(t *testing.T) {
+	mock := &mockDynamodbClient{
+		listTablesFn: func(_ context.Context, _ *dynamodb.ListTablesInput, _ ...func(*dynamodb.Options)) (*dynamodb.ListTablesOutput, error) {
+			return &dynamodb.ListTablesOutput{}, nil
+		},
+	}
+	svc := getMockedDynamodbService(mock)
+	got := svc.GetTables()
+	if len(got) != 0 {
+		t.Errorf("expected empty result, got %v", got)
+	}
+}
+
+func TestGetDynamodbTables_PaginationFollowed(t *testing.T) {
+	callCount := 0
+	mock := &mockDynamodbClient{
+		listTablesFn: func(_ context.Context, params *dynamodb.ListTablesInput, _ ...func(*dynamodb.Options)) (*dynamodb.ListTablesOutput, error) {
+			callCount++
+			if callCount == 1 {
+				return &dynamodb.ListTablesOutput{
+					TableNames:            []string{"table-1"},
+					LastEvaluatedTableName: ptr("table-1"),
+				}, nil
+			}
+			if params.ExclusiveStartTableName == nil || *params.ExclusiveStartTableName != "table-1" {
+				return nil, fmt.Errorf("wrong ExclusiveStartTableName: expected 'table-1', got %v", params.ExclusiveStartTableName)
+			}
+			return &dynamodb.ListTablesOutput{
+				TableNames: []string{"table-2"},
+			}, nil
+		},
+	}
+	svc := getMockedDynamodbService(mock)
+	got := svc.GetTables()
+	expected := []common.Resource{
+		{Arn: "arn:aws:dynamodb:eu-west-1:123456789012:table/table-1", TerraformID: "table-1", ResourceType: common.Dynamodb_table, Region: "eu-west-1"},
+		{Arn: "arn:aws:dynamodb:eu-west-1:123456789012:table/table-2", TerraformID: "table-2", ResourceType: common.Dynamodb_table, Region: "eu-west-1"},
+	}
+	if diff := cmp.Diff(got, expected); diff != "" {
+		t.Errorf("mismatch (-got +want):\n%s", diff)
+	}
+	if callCount != 2 {
+		t.Errorf("expected 2 calls to ListTables, got %d", callCount)
+	}
+}
+
+func TestGetDynamodbTables_ErrorIsSkipped(t *testing.T) {
+	mock := &mockDynamodbClient{
+		listTablesFn: func(_ context.Context, _ *dynamodb.ListTablesInput, _ ...func(*dynamodb.Options)) (*dynamodb.ListTablesOutput, error) {
+			return nil, fmt.Errorf("access denied")
+		},
+	}
+	svc := getMockedDynamodbService(mock)
+	got := svc.GetTables()
+	if len(got) != 0 {
+		t.Errorf("expected empty result on error, got %v", got)
+	}
+}

aws/helpers_test.go

@@ -6,6 +6,7 @@ import (
 	"github.com/aws/aws-sdk-go-v2/service/autoscaling"
 	"github.com/aws/aws-sdk-go-v2/service/cloudfront"
 	"github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs"
+	"github.com/aws/aws-sdk-go-v2/service/dynamodb"
 	"github.com/aws/aws-sdk-go-v2/service/ec2"
 	"github.com/aws/aws-sdk-go-v2/service/elasticloadbalancing"
 	"github.com/aws/aws-sdk-go-v2/service/elasticloadbalancingv2"
@@ -205,3 +206,11 @@ type mockCloudwatchLogsClient struct {
 func (m *mockCloudwatchLogsClient) ListLogGroups(ctx context.Context, params *cloudwatchlogs.ListLogGroupsInput, optFns ...func(*cloudwatchlogs.Options)) (*cloudwatchlogs.ListLogGroupsOutput, error) {
 	return m.listLogGroupsFn(ctx, params, optFns...)
 }
+
+type mockDynamodbClient struct {
+	listTablesFn func(ctx context.Context, params *dynamodb.ListTablesInput, optFns ...func(*dynamodb.Options)) (*dynamodb.ListTablesOutput, error)
+}
+
+func (m *mockDynamodbClient) ListTables(ctx context.Context, params *dynamodb.ListTablesInput, optFns ...func(*dynamodb.Options)) (*dynamodb.ListTablesOutput, error) {
+	return m.listTablesFn(ctx, params, optFns...)
+}

aws/types.go

@@ -27,6 +27,7 @@ var SERVICES = map[common.AWSServiceName]common.ServiceMeta{
 	common.ASG:            {Global: false, ServiceName: "autoscaling"},
 	common.Lambda:         {Global: false, ServiceName: "lambda"},
 	common.CloudwatchLogs: {Global: false, ServiceName: "cloudwatchlogs"},
+	common.Dynamodb:       {Global: false, ServiceName: "dynamodb"},
 
 	// not included in the switch/case in `NewclickopsServiceFromConfigs`
 	// because it doesn't follow the same invocation pattern.
@@ -92,6 +93,9 @@ func NewNoclickopsServiceFromConfigs(service common.AWSServiceName, configs []aw
 	case common.CloudwatchLogs:
 		c := NewCloudwatchLogsServiceFromConfigs(configs, meta)
 		return &c
+	case common.Dynamodb:
+		c := NewDynamodbServiceFromConfigs(configs, meta)
+		return &c
 	case common.Lambda:
 		c := NewLambdaServiceFromConfigs(configs, meta)
 		return &c

common/types.go

@@ -37,6 +37,7 @@ const (
 	Lambda_function
 	Autoscaling_group
 	Cloudwatchlogs_log_group
+	Dynamodb_table
 )
 
 func (r ResourceType) MarshalJSON() ([]byte, error) {
@@ -64,6 +65,7 @@ const (
 	Lambda
 	ResourceGroupsTaggingAPI
 	CloudwatchLogs
+	Dynamodb
 )
 
 type Resource struct {

go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/aws/aws-sdk-go-v2/service/autoscaling v1.66.1
 	github.com/aws/aws-sdk-go-v2/service/cloudfront v1.61.1
 	github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs v1.74.0
+	github.com/aws/aws-sdk-go-v2/service/dynamodb v1.57.4
 	github.com/aws/aws-sdk-go-v2/service/ec2 v1.299.0
 	github.com/aws/aws-sdk-go-v2/service/eks v1.82.1
 	github.com/aws/aws-sdk-go-v2/service/elasticloadbalancing v1.33.24
@@ -35,8 +36,9 @@ require (
 	github.com/aws/aws-sdk-go-v2/internal/configsources v1.4.23 // indirect
 	github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.7.23 // indirect
 	github.com/aws/aws-sdk-go-v2/internal/v4a v1.4.23 // indirect
-	github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.8 // indirect
+	github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.9 // indirect
 	github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.9.14 // indirect
+	github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery v1.12.0 // indirect
 	github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.13.22 // indirect
 	github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.19.22 // indirect
 	github.com/aws/aws-sdk-go-v2/service/signin v1.0.10 // indirect

go.sum

@@ -22,6 +22,8 @@ github.com/aws/aws-sdk-go-v2/service/cloudfront v1.61.1 h1:LSv6jOIn/yEsGLeL4TLgg
 github.com/aws/aws-sdk-go-v2/service/cloudfront v1.61.1/go.mod h1:XUduecWr236DyG8nZwJMewFbS4QcL8NZHxohdYDoPhM=
 github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs v1.74.0 h1:6TqDeYdvJJEIJGg5ICy7nzC7/UuHk2Eg3wrpb5bWKPM=
 github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs v1.74.0/go.mod h1:MLJu3PUd8fp5Qvj4CiLvyY5H8y7kxHKlTp060Wsd+Vc=
+github.com/aws/aws-sdk-go-v2/service/dynamodb v1.57.4 h1:0E3bfw1Va3vfCrmtATvKRnGojY4oIlLl0u0xRDDUgfY=
+github.com/aws/aws-sdk-go-v2/service/dynamodb v1.57.4/go.mod h1:dFPU89qDDGgQbXyzQ5ZY6zcjjKPVW+1M63axOw887JE=
 github.com/aws/aws-sdk-go-v2/service/ec2 v1.299.0 h1:qTozRFl2YFFU2HJGl7ZAywlRQvBnAN591gbAFT5bE0s=
 github.com/aws/aws-sdk-go-v2/service/ec2 v1.299.0/go.mod h1:E1pnYwWFZ8N3REmeN9Fe/Zipbpps4HJj8DQGNnLUMYc=
 github.com/aws/aws-sdk-go-v2/service/eks v1.82.1 h1:xTzXiQ8Q6U4ACdMNSCm72zd4Ds7QxhgVLqt5x8GXLBM=
@@ -34,10 +36,12 @@ github.com/aws/aws-sdk-go-v2/service/iam v1.53.8 h1:p0oB4eZfBfBAOasnKvHJOlNcuHVE
 github.com/aws/aws-sdk-go-v2/service/iam v1.53.8/go.mod h1:epCaPnGVdiX5ra1lHPfRkVuiQGxrdY8bRI2FBJU+6ok=
 github.com/aws/aws-sdk-go-v2/service/identitystore v1.36.6 h1:BZuH7nZjB+3HghoE9dLMhGkBuB0iZC/oz7GoO9nhxT4=
 github.com/aws/aws-sdk-go-v2/service/identitystore v1.36.6/go.mod h1:d1oJcGnJe++u//4bp58J5gwQyE10wPObgWAvlfGjy/4=
-github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.8 h1:HtOTYcbVcGABLOVuPYaIihj6IlkqubBwFj10K5fxRek=
-github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.8/go.mod h1:VsK9abqQeGlzPgUr+isNWzPlK2vKe9INMLWnY65f5Xs=
+github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.9 h1:FLudkZLt5ci0ozzgkVo8BJGwvqNaZbTWb3UcucAateA=
+github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.9/go.mod h1:w7wZ/s9qK7c8g4al+UyoF1Sp/Z45UwMGcqIzLWVQHWk=
 github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.9.14 h1:xnvDEnw+pnj5mctWiYuFbigrEzSm35x7k4KS/ZkCANg=
 github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.9.14/go.mod h1:yS5rNogD8e0Wu9+l3MUwr6eENBzEeGejvINpN5PAYfY=
+github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery v1.12.0 h1:iNQlIMVathbcvo6USGjFFO8SgANIBg5hsoIv/QAiYK4=
+github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery v1.12.0/go.mod h1:3oh+5xGSd1iuxonVb3Qbm+WJYlbhczT9kbzr6doJLzY=
 github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.13.22 h1:PUmZeJU6Y1Lbvt9WFuJ0ugUK2xn6hIWUBBbKuOWF30s=
 github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.13.22/go.mod h1:nO6egFBoAaoXze24a2C0NjQCvdpk8OueRoYimvEB9jo=
 github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.19.22 h1:SE+aQ4DEqG53RRCAIHlCf//B2ycxGH7jFkpnAh/kKPM=