Start building out AWS utility functions for CLIs, with aws-sdk-go-v2 (#43)

* Start building out AWS utility functions for CLIs, with aws-sdk-go-v2

* Rename aws to awscommons

* Add awscommons to README

Author: yorinasub17

README.md

@@ -19,6 +19,7 @@ This repo contains the following packages:
 * shell
 * ssh
 * retry
+* awscommons
 
 Each of these packages is described below.
 
@@ -138,6 +139,12 @@ This package contains helper methods for initiating SSH connections and running
 
 This package contains helper methods for retrying an action up to a limit.
 
+### awscommons
+
+This package contains routines for interacting with AWS. Meant to provide high level interfaces used throughout various Gruntwork CLIs.
+
+Note that the routines in this package are adapted for `aws-sdk-go-v2`, not v1 (`aws-sdk-go`).
+
 
 ## Running tests
 

awscommons/v2/auth.go

@@ -0,0 +1,35 @@
+package awscommons
+
+import (
+	"context"
+
+	"github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/aws/aws-sdk-go-v2/config"
+	"github.com/gruntwork-io/go-commons/errors"
+)
+
+const (
+	DefaultRegion = "us-east-1"
+)
+
+// Options represents all the parameters necessary for setting up authentication credentials with AWS.
+type Options struct {
+	Region string
+
+	Context context.Context
+}
+
+// NewOptions will create a new aws.Options struct that provides reasonable defaults for unspecified values.
+func NewOptions(region string) *Options {
+	return &Options{
+		Region:  region,
+		Context: context.TODO(),
+	}
+}
+
+// NewDefaultConfig will retrieve a new authenticated AWS config using SDK default credentials. This config can be used
+// to setup new AWS service clients.
+func NewDefaultConfig(opts *Options) (aws.Config, error) {
+	cfg, err := config.LoadDefaultConfig(opts.Context, config.WithRegion(opts.Region))
+	return cfg, errors.WithStackTrace(err)
+}

awscommons/v2/doc.go

@@ -0,0 +1,4 @@
+// Package awscommons contains routines for interacting with AWS. Meant to provide high level interfaces used throughout
+// various Gruntwork CLIs.
+// NOTE: The routines in this package are adapted for aws-sdk-go-v2, not V1.
+package awscommons

awscommons/v2/secretsmanager.go

@@ -0,0 +1,62 @@
+package awscommons
+
+import (
+	goerrors "errors"
+
+	"github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/aws/aws-sdk-go-v2/service/secretsmanager"
+	"github.com/aws/aws-sdk-go-v2/service/secretsmanager/types"
+
+	"github.com/gruntwork-io/go-commons/errors"
+)
+
+// GetSecretsManagerMetadata returns the metadata of the Secrets Manager entry with the given ID.
+func GetSecretsManagerMetadata(opts *Options, secretID string) (*secretsmanager.DescribeSecretOutput, error) {
+	client, err := NewSecretsManagerClient(opts)
+	if err != nil {
+		return nil, err
+	}
+
+	secret, err := client.DescribeSecret(opts.Context, &secretsmanager.DescribeSecretInput{SecretId: aws.String(secretID)})
+	return secret, errors.WithStackTrace(err)
+}
+
+// SecretsManagerEntryExists returns whether or not the SecretsManager Entry with the given ARN exists. This will return
+// an error if it exists, but is not accessible due to permission issues, or if there is an authentication issue.
+func SecretsManagerEntryExists(opts *Options, arn string) (bool, error) {
+	_, err := GetSecretsManagerMetadata(opts, arn)
+	if err != nil {
+		// If the err is 404, then return that it doesn't exist without error. Otherwise, return the error.
+		rawErr := errors.Unwrap(err)
+		var resourceNotFoundErr *types.ResourceNotFoundException
+		if goerrors.As(rawErr, &resourceNotFoundErr) {
+			return false, nil
+		}
+		return false, errors.WithStackTrace(err)
+	}
+	// At this point, we know the secret exists so return that.
+	return true, nil
+}
+
+// GetSecretsManagerSecretString will return the secret value stored at the given Secrets Manager ARN.
+func GetSecretsManagerSecretString(opts *Options, arn string) (string, error) {
+	client, err := NewSecretsManagerClient(opts)
+	if err != nil {
+		return "", err
+	}
+
+	secretVal, err := client.GetSecretValue(opts.Context, &secretsmanager.GetSecretValueInput{SecretId: aws.String(arn)})
+	if err != nil {
+		return "", errors.WithStackTrace(err)
+	}
+	return aws.ToString(secretVal.SecretString), nil
+}
+
+// NewSecretsManagerClient will return a new AWS SDK client for interacting with AWS Secrets Manager.
+func NewSecretsManagerClient(opts *Options) (*secretsmanager.Client, error) {
+	cfg, err := NewDefaultConfig(opts)
+	if err != nil {
+		return nil, errors.WithStackTrace(err)
+	}
+	return secretsmanager.NewFromConfig(cfg), nil
+}

awscommons/v2/secretsmanager_test.go

@@ -0,0 +1,76 @@
+package awscommons
+
+import (
+	"testing"
+
+	goaws "github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/gruntwork-io/terratest/modules/aws"
+	"github.com/gruntwork-io/terratest/modules/random"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+// Test GetSecretsManagerSecret by creating the secret in terratest and using the function to read the value to make
+// sure it reads the correct secret value.
+func TestGetSecretString(t *testing.T) {
+	t.Parallel()
+
+	name := "refarch-deployer-test-secret-" + random.UniqueId()
+	secretVal := random.UniqueId()
+	region := aws.GetRandomStableRegion(t, nil, nil)
+	opts := NewOptions(region)
+
+	secretARN := aws.CreateSecretStringWithDefaultKey(t, region, "Test Secret for refarch-deployer", name, secretVal)
+	defer aws.DeleteSecret(t, region, secretARN, true)
+
+	actualSecret, err := GetSecretsManagerSecretString(opts, secretARN)
+	require.NoError(t, err)
+	assert.Equal(t, secretVal, actualSecret)
+}
+
+// Test SecretsManagerEntryExists returns false when calling it on a secrets manager entry that doesn't exist.
+func TestSecretsManagerEntryExistsFalse(t *testing.T) {
+	t.Parallel()
+
+	opts := NewOptions("us-east-1")
+	exists, err := SecretsManagerEntryExists(opts, "secret-that-doesnt-exist")
+	require.NoError(t, err)
+	assert.False(t, exists)
+}
+
+// Test SecretsManagerEntryExists returns true when calling it on a secrets manager entry that exists.
+func TestSecretsManagerEntryExistsTrueWithARN(t *testing.T) {
+	t.Parallel()
+
+	name := "refarch-deployer-test-secret-" + random.UniqueId()
+	secretVal := random.UniqueId()
+	region := aws.GetRandomStableRegion(t, nil, nil)
+	opts := NewOptions(region)
+
+	secretARN := aws.CreateSecretStringWithDefaultKey(t, region, "Test Secret for refarch-deployer", name, secretVal)
+	defer aws.DeleteSecret(t, region, secretARN, true)
+
+	exists, err := SecretsManagerEntryExists(opts, secretARN)
+	require.NoError(t, err)
+	assert.True(t, exists)
+}
+
+// Test SecretsManagerEntryExists returns true when calling it on a secrets manager entry that exists with name.
+func TestSecretsManagerEntryExistsTrueWithName(t *testing.T) {
+	t.Parallel()
+
+	name := "refarch-deployer-test-secret-" + random.UniqueId()
+	secretVal := random.UniqueId()
+	region := aws.GetRandomStableRegion(t, nil, nil)
+	opts := NewOptions(region)
+
+	secretARN := aws.CreateSecretStringWithDefaultKey(t, region, "Test Secret for refarch-deployer", name, secretVal)
+	defer aws.DeleteSecret(t, region, secretARN, true)
+
+	secret, err := GetSecretsManagerMetadata(opts, secretARN)
+	require.NoError(t, err)
+
+	exists, err := SecretsManagerEntryExists(opts, goaws.ToString(secret.Name))
+	require.NoError(t, err)
+	assert.True(t, exists)
+}

go.mod

@@ -3,15 +3,24 @@ module github.com/gruntwork-io/go-commons
 go 1.13
 
 require (
+	github.com/aws/aws-sdk-go v1.38.0 // indirect
+	github.com/aws/aws-sdk-go-v2 v1.3.3
+	github.com/aws/aws-sdk-go-v2/config v1.1.6
+	github.com/aws/aws-sdk-go-v2/service/secretsmanager v1.2.2
 	github.com/bgentry/speakeasy v0.1.0
 	github.com/fatih/color v1.9.0
 	github.com/go-errors/errors v1.0.2-0.20180813162953-d98b870cc4e0
-	github.com/gruntwork-io/kubergrunt v0.6.10
+	github.com/go-sql-driver/mysql v1.5.0 // indirect
 	github.com/gruntwork-io/terratest v0.32.9
 	github.com/hashicorp/go-multierror v1.1.0
+	github.com/kr/text v0.2.0 // indirect
 	github.com/mattn/go-zglob v0.0.2-0.20190814121620-e3c945676326
+	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
 	github.com/sirupsen/logrus v1.6.0
 	github.com/stretchr/testify v1.6.1
 	github.com/urfave/cli v1.22.4
-	golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83
+	golang.org/x/crypto v0.0.0-20210317152858-513c2a44f670
+	golang.org/x/sys v0.0.0-20210319071255-635bc2c9138d // indirect
+	golang.org/x/term v0.0.0-20210317153231-de623e64d2a6 // indirect
+	gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b // indirect
 )