Add ability to provide an authentication session to lock (#58)

* Add ability to provide an authentication session to lock

* Don't run git tests in parallel

Author: yorinasub17

git/test/auth_test.go

@@ -26,10 +26,9 @@ var (
 
 // NOTE: All these tests should be run in the provided docker environment to avoid polluting the local git configuration
 // settings. The tests will assert that it is running in the docker environment, and will fail if it is not.
+// All these tests are also run in serial to avoid race conditions on the git config file.
 
 func TestHTTPSAuth(t *testing.T) {
-	t.Parallel()
-
 	currentDir, err := os.Getwd()
 	require.NoError(t, err)
 	require.Equal(t, "/workspace/go-commons/git/test", currentDir)
@@ -45,8 +44,6 @@ func TestHTTPSAuth(t *testing.T) {
 }
 
 func TestForceHTTPS(t *testing.T) {
-	t.Parallel()
-
 	currentDir, err := os.Getwd()
 	require.NoError(t, err)
 	require.Equal(t, "/workspace/go-commons/git/test", currentDir)

lock/lock.go

@@ -2,14 +2,15 @@ package lock
 
 import (
 	"fmt"
+	"time"
+
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/aws/aws-sdk-go/aws/awserr"
 	"github.com/aws/aws-sdk-go/aws/session"
 	"github.com/aws/aws-sdk-go/service/dynamodb"
 	"github.com/gruntwork-io/go-commons/errors"
 	"github.com/gruntwork-io/go-commons/retry"
 	"github.com/sirupsen/logrus"
-	"time"
 )
 
 const (
@@ -40,6 +41,10 @@ type Options struct {
 	SleepBetweenRetries time.Duration
 	// The logger to use for the lock
 	Logger *logrus.Logger
+
+	// Custom session to use to authenticate to AWS in the SDK. If nil, constructs the session based on the default
+	// authentication chain in the SDK.
+	AwsSession *session.Session
 }
 
 type TimeoutExceeded struct {
@@ -79,23 +84,13 @@ func NewAuthenticatedSession(awsRegion string) (*session.Session, error) {
 	return sess, nil
 }
 
-// NewDynamoDb returns an authenticated client object for accessing DynamoDb
-func NewDynamoDb(awsRegion string) (*dynamodb.DynamoDB, error) {
-	sess, err := NewAuthenticatedSession(awsRegion)
-	if err != nil {
-		return nil, err
-	}
-	dynamodbSvc := dynamodb.New(sess)
-	return dynamodbSvc, nil
-}
-
 // AcquireLock will attempt to acquire a lock in DynamoDB table while taking the configuration options into account.
 // We are using DynamoDB to create a table to help us track the lock status of different resources.
 // The acquiring of a lock attempts to create a table. The intention is that we have 1 table per resource in a single region.
 // This would allow the locking mechanism to flexibly decide if a resource is locked or not. For test cases where the AWS resource
 // is multi-region, or global, the configuration of which regions to use should reflect that.
 func AcquireLock(options *Options) error {
-	client, err := NewDynamoDb(options.AwsRegion)
+	client, err := getDynamoDBClient(options)
 	if err != nil {
 		options.Logger.Errorf("Error authenticating to AWS: %s\n", err)
 		return err
@@ -156,7 +151,7 @@ func acquireLock(options *Options, client *dynamodb.DynamoDB) error {
 // ReleaseLock will attempt to release the lock defined by the provided lock string in the configured lock table for the
 // configured region
 func ReleaseLock(options *Options) error {
-	client, err := NewDynamoDb(options.AwsRegion)
+	client, err := getDynamoDBClient(options)
 	if err != nil {
 		options.Logger.Errorf("Error authenticating to AWS: %s\n", err)
 		return err
@@ -297,7 +292,7 @@ func lockTableExistsAndIsActive(tableName string, client *dynamodb.DynamoDB) (bo
 // GetLockStatus attempts to acquire the lock and check if the expected item is there
 // If there's the expected Item with the correct `LockString` value - then the status is `locked`, if the item is not there - then the status is `not locked`
 func GetLockStatus(options *Options) (*dynamodb.GetItemOutput, error) {
-	client, err := NewDynamoDb(options.AwsRegion)
+	client, err := getDynamoDBClient(options)
 	if err != nil {
 		options.Logger.Errorf("Error authenticating to AWS: %s\n", err)
 		return nil, err
@@ -318,3 +313,20 @@ func GetLockStatus(options *Options) (*dynamodb.GetItemOutput, error) {
 
 	return item, nil
 }
+
+func getDynamoDBClient(options *Options) (*dynamodb.DynamoDB, error) {
+	if options.AwsSession == nil {
+		return NewDynamoDb(options.AwsRegion)
+	}
+	return dynamodb.New(options.AwsSession), nil
+}
+
+// NewDynamoDb returns an authenticated client object for accessing DynamoDb
+func NewDynamoDb(awsRegion string) (*dynamodb.DynamoDB, error) {
+	sess, err := NewAuthenticatedSession(awsRegion)
+	if err != nil {
+		return nil, err
+	}
+	dynamodbSvc := dynamodb.New(sess)
+	return dynamodbSvc, nil
+}