Merge pull request #984 from aws/jasdel/refactor/EC2IMDS

feature/ec2/imds: Move the ec2imds module

.changes/next-release/config-feature-1608146507258154000.json

@@ -0,0 +1,9 @@
+{
+ "ID": "config-feature-1608146507258154000",
+ "SchemaVersion": 1,
+ "Module": "config",
+ "Type": "feature",
+ "Description": "Update to use moved feature/ec2/imds module",
+ "MinVersion": "",
+ "AffectedModules": null
+}

.changes/next-release/credentials-feature-1608146309206308000.json

@@ -0,0 +1,9 @@
+{
+ "ID": "credentials-feature-1608146309206308000",
+ "SchemaVersion": 1,
+ "Module": "credentials",
+ "Type": "feature",
+ "Description": "Update ec2rolecreds to depend on /feature/ec2/imds module",
+ "MinVersion": "",
+ "AffectedModules": null
+}

.changes/next-release/feature.ec2.imds-feature-1608146342526841000.json

@@ -0,0 +1,9 @@
+{
+ "ID": "feature.ec2.imds-feature-1608146342526841000",
+ "SchemaVersion": 1,
+ "Module": "feature/ec2/imds",
+ "Type": "feature",
+ "Description": "Move ec2imds module to feature/ec2/imds",
+ "MinVersion": "",
+ "AffectedModules": null
+}

config/go.mod

@@ -5,7 +5,7 @@ go 1.15
 require (
 	github.com/aws/aws-sdk-go-v2 v0.30.0
 	github.com/aws/aws-sdk-go-v2/credentials v0.1.5
-	github.com/aws/aws-sdk-go-v2/ec2imds v0.1.5
+	github.com/aws/aws-sdk-go-v2/feature/ec2/imds v0.0.0-20201216182737-05d6a8e2a8df
 	github.com/aws/aws-sdk-go-v2/service/sts v0.30.0
 	github.com/awslabs/smithy-go v0.4.1-0.20201208232924-b8cdbaa577ff
 	github.com/google/go-cmp v0.5.4
@@ -14,6 +14,6 @@ require (
 replace (
 	github.com/aws/aws-sdk-go-v2 => ../
 	github.com/aws/aws-sdk-go-v2/credentials => ../credentials/
-	github.com/aws/aws-sdk-go-v2/ec2imds => ../ec2imds/
+	github.com/aws/aws-sdk-go-v2/feature/ec2/imds => ../feature/ec2/imds/
 	github.com/aws/aws-sdk-go-v2/service/sts => ../service/sts/
 )

config/load_options.go

@@ -2,9 +2,10 @@ package config
 
 import (
 	"context"
-	"github.com/aws/aws-sdk-go-v2/ec2imds"
 	"io"
 
+	"github.com/aws/aws-sdk-go-v2/feature/ec2/imds"
+
 	"github.com/aws/aws-sdk-go-v2/aws"
 	"github.com/aws/aws-sdk-go-v2/credentials/ec2rolecreds"
 	"github.com/aws/aws-sdk-go-v2/credentials/endpointcreds"
@@ -211,7 +212,7 @@ func WithCustomCABundle(v io.Reader) LoadOptionsFunc {
 // from the EC2 Metadata service.
 type UseEC2IMDSRegion struct {
 	// If unset will default to generic EC2 IMDS client.
-	Client *ec2imds.Client
+	Client *imds.Client
 }
 
 // getRegion attempts to retrieve the region from EC2 Metadata service.
@@ -222,7 +223,7 @@ func (p *UseEC2IMDSRegion) getRegion(ctx context.Context) (string, bool, error)
 
 	client := p.Client
 	if client == nil {
-		client = ec2imds.New(ec2imds.Options{})
+		client = imds.New(imds.Options{})
 	}
 
 	result, err := p.Client.GetRegion(ctx, nil)
@@ -235,7 +236,7 @@ func (p *UseEC2IMDSRegion) getRegion(ctx context.Context) (string, bool, error)
 	return "", false, nil
 }
 
-// getEC2IMDSRegion returns the value of ec2imds region.
+// getEC2IMDSRegion returns the value of EC2 IMDS region.
 func (o LoadOptions) getEC2IMDSRegion(ctx context.Context) (string, bool, error) {
 	if o.UseEC2IMDSRegion == nil {
 		return "", false, nil

config/resolve_credentials.go

@@ -12,7 +12,7 @@ import (
 	"github.com/aws/aws-sdk-go-v2/credentials/endpointcreds"
 	"github.com/aws/aws-sdk-go-v2/credentials/processcreds"
 	"github.com/aws/aws-sdk-go-v2/credentials/stscreds"
-	"github.com/aws/aws-sdk-go-v2/ec2imds"
+	"github.com/aws/aws-sdk-go-v2/feature/ec2/imds"
 	"github.com/aws/aws-sdk-go-v2/service/sts"
 )
 
@@ -258,7 +258,7 @@ func resolveEC2RoleCredentials(ctx context.Context, cfg *aws.Config, configs con
 	optFns = append(optFns, func(o *ec2rolecreds.Options) {
 		// Only define a client from config if not already defined.
 		if o.Client != nil {
-			o.Client = ec2imds.New(ec2imds.Options{
+			o.Client = imds.New(imds.Options{
 				HTTPClient: cfg.HTTPClient,
 				Retryer:    cfg.Retryer,
 			})

credentials/ec2rolecreds/doc.go

@@ -30,20 +30,20 @@
 // it with the CredentialsCache before assigning the provider to the Amazon S3 API
 // client's Credentials option.
 //
-// 	provider := ec2imds.New(ec2imds.Options{})
+// 	provider := imds.New(imds.Options{})
 //
 //     // Create the service client value configured for credentials.
 //     svc := s3.New(s3.Options{
 // 		Credentials: &aws.CredentialsCache{Provider: provider},
 // 	})
 //
 // If you need more control, you can set the configuration options on the
-// credentials provider using the ec2imds.Options type to configure the EC2 IMDS
+// credentials provider using the imds.Options type to configure the EC2 IMDS
 // API Client and ExpiryWindow of the retrieved credentials.
 //
-// 	provider := ec2imds.New(ec2imds.Options{
-// 		// See ec2imds.Options type's documentation for more options available.
-// 		Client: ec2imds.New(Options{
+// 	provider := imds.New(imds.Options{
+// 		// See imds.Options type's documentation for more options available.
+// 		Client: imds.New(Options{
 // 			HTTPClient: customHTTPClient,
 // 		}),
 //
@@ -53,6 +53,6 @@
 //
 // EC2 IMDS API Client
 //
-// See the github.com/aws/aws-sdk-go-v2/ec2imds module for more details on
+// See the github.com/aws/aws-sdk-go-v2/feature/ec2/imds module for more details on
 // configuring the client, and options available.
 package ec2rolecreds

credentials/ec2rolecreds/provider.go

@@ -10,7 +10,7 @@ import (
 	"time"
 
 	"github.com/aws/aws-sdk-go-v2/aws"
-	"github.com/aws/aws-sdk-go-v2/ec2imds"
+	"github.com/aws/aws-sdk-go-v2/feature/ec2/imds"
 	"github.com/awslabs/smithy-go"
 )
 
@@ -20,7 +20,7 @@ const ProviderName = "EC2RoleProvider"
 // GetMetadataAPIClient provides the interface for an EC2 IMDS API client for the
 // GetMetadata operation.
 type GetMetadataAPIClient interface {
-	GetMetadata(context.Context, *ec2imds.GetMetadataInput, ...func(*ec2imds.Options)) (*ec2imds.GetMetadataOutput, error)
+	GetMetadata(context.Context, *imds.GetMetadataInput, ...func(*imds.Options)) (*imds.GetMetadataOutput, error)
 }
 
 // A Provider retrieves credentials from the EC2 service, and keeps track if
@@ -29,7 +29,7 @@ type GetMetadataAPIClient interface {
 // The New function must be used to create the Provider.
 //
 //     p := &ec2rolecreds.New(ec2rolecreds.Options{
-//          Client: ec2imds.New(ec2imds.Options{}),
+//          Client: imds.New(imds.Options{}),
 //
 //          // Expire the credentials 10 minutes before IAM states they should.
 //          // Proactively refreshing the credentials.
@@ -44,7 +44,7 @@ type Options struct {
 	// The API client that will be used by the provider to make GetMetadata API
 	// calls to EC2 IMDS.
 	//
-	// If nil, the provider will default to the ec2imds client.
+	// If nil, the provider will default to the EC2 IMDS client.
 	Client GetMetadataAPIClient
 }
 
@@ -58,7 +58,7 @@ func New(optFns ...func(*Options)) *Provider {
 	}
 
 	if options.Client == nil {
-		options.Client = ec2imds.New(ec2imds.Options{})
+		options.Client = imds.New(imds.Options{})
 	}
 
 	return &Provider{
@@ -119,7 +119,7 @@ const iamSecurityCredsPath = "/iam/security-credentials/"
 // there are no credentials, or there is an error making or receiving the
 // request
 func requestCredList(ctx context.Context, client GetMetadataAPIClient) ([]string, error) {
-	resp, err := client.GetMetadata(ctx, &ec2imds.GetMetadataInput{
+	resp, err := client.GetMetadata(ctx, &imds.GetMetadataInput{
 		Path: iamSecurityCredsPath,
 	})
 	if err != nil {
@@ -145,7 +145,7 @@ func requestCredList(ctx context.Context, client GetMetadataAPIClient) ([]string
 // If the credentials cannot be found, or there is an error reading the response
 // and error will be returned.
 func requestCred(ctx context.Context, client GetMetadataAPIClient, credsName string) (ec2RoleCredRespBody, error) {
-	resp, err := client.GetMetadata(ctx, &ec2imds.GetMetadataInput{
+	resp, err := client.GetMetadata(ctx, &imds.GetMetadataInput{
 		Path: path.Join(iamSecurityCredsPath, credsName),
 	})
 	if err != nil {

credentials/ec2rolecreds/provider_test.go

@@ -9,7 +9,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/aws/aws-sdk-go-v2/ec2imds"
+	"github.com/aws/aws-sdk-go-v2/feature/ec2/imds"
 	"github.com/aws/aws-sdk-go-v2/internal/sdk"
 	"github.com/awslabs/smithy-go"
 )
@@ -38,13 +38,13 @@ type mockClient struct {
 }
 
 func (c mockClient) GetMetadata(
-	ctx context.Context, params *ec2imds.GetMetadataInput, optFns ...func(*ec2imds.Options),
+	ctx context.Context, params *imds.GetMetadataInput, optFns ...func(*imds.Options),
 ) (
-	*ec2imds.GetMetadataOutput, error,
+	*imds.GetMetadataOutput, error,
 ) {
 	switch params.Path {
 	case iamSecurityCredsPath:
-		return &ec2imds.GetMetadataOutput{
+		return &imds.GetMetadataOutput{
 			Content: ioutil.NopCloser(strings.NewReader(c.roleName)),
 		}, nil
 
@@ -55,7 +55,7 @@ func (c mockClient) GetMetadata(
 		} else {
 			fmt.Fprintf(&w, credsRespTmpl, c.expireOn)
 		}
-		return &ec2imds.GetMetadataOutput{
+		return &imds.GetMetadataOutput{
 			Content: ioutil.NopCloser(strings.NewReader(w.String())),
 		}, nil
 	default:

credentials/go.mod

@@ -4,13 +4,13 @@ go 1.15
 
 require (
 	github.com/aws/aws-sdk-go-v2 v0.30.0
-	github.com/aws/aws-sdk-go-v2/ec2imds v0.1.5
+	github.com/aws/aws-sdk-go-v2/feature/ec2/imds v0.0.0-20201216182737-05d6a8e2a8df
 	github.com/aws/aws-sdk-go-v2/service/sts v0.30.0
 	github.com/awslabs/smithy-go v0.4.1-0.20201208232924-b8cdbaa577ff
 )
 
 replace (
 	github.com/aws/aws-sdk-go-v2 => ../
-	github.com/aws/aws-sdk-go-v2/ec2imds => ../ec2imds/
+	github.com/aws/aws-sdk-go-v2/feature/ec2/imds => ../feature/ec2/imds/
 	github.com/aws/aws-sdk-go-v2/service/sts => ../service/sts/
 )

example/service/s3/listObjects/go.mod

@@ -15,7 +15,7 @@ replace github.com/aws/aws-sdk-go-v2 => ../../../../
 
 replace github.com/aws/aws-sdk-go-v2/credentials => ../../../../credentials/
 
-replace github.com/aws/aws-sdk-go-v2/ec2imds => ../../../../ec2imds/
+replace github.com/aws/aws-sdk-go-v2/feature/ec2/imds => ../../../../feature/ec2/imds/
 
 replace github.com/aws/aws-sdk-go-v2/service/sts => ../../../../service/sts/
 

ec2imds/api_client.go → feature/ec2/imds/api_client.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/api_client_test.go → feature/ec2/imds/api_client_test.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"bytes"

ec2imds/api_op_GetDynamicData.go → feature/ec2/imds/api_op_GetDynamicData.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/api_op_GetDynamicData_test.go → feature/ec2/imds/api_op_GetDynamicData_test.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"bytes"

ec2imds/api_op_GetIAMInfo.go → feature/ec2/imds/api_op_GetIAMInfo.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/api_op_GetIAMInfo_test.go → feature/ec2/imds/api_op_GetIAMInfo_test.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/api_op_GetInstanceIdentityDocument.go → feature/ec2/imds/api_op_GetInstanceIdentityDocument.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/api_op_GetInstanceIdentityDocument_test.go → feature/ec2/imds/api_op_GetInstanceIdentityDocument_test.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/api_op_GetMetadata.go → feature/ec2/imds/api_op_GetMetadata.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/api_op_GetMetadata_test.go → feature/ec2/imds/api_op_GetMetadata_test.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"bytes"

ec2imds/api_op_GetRegion.go → feature/ec2/imds/api_op_GetRegion.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/api_op_GetRegion_test.go → feature/ec2/imds/api_op_GetRegion_test.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/api_op_GetToken.go → feature/ec2/imds/api_op_GetToken.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/api_op_GetToken_test.go → feature/ec2/imds/api_op_GetToken_test.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/api_op_GetUserData.go → feature/ec2/imds/api_op_GetUserData.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/api_op_GetUserData_test.go → feature/ec2/imds/api_op_GetUserData_test.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"bytes"

ec2imds/doc.go → feature/ec2/imds/doc.go

@@ -1,6 +1,6 @@
-// Package ec2imds provides the API client for interacting with the Amazon EC2
+// Package imds provides the API client for interacting with the Amazon EC2
 // Instance Metadata Service.
 //
 // See the EC2 IMDS user guide for more information on using the API.
 // https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
-package ec2imds
+package imds

ec2imds/go.mod → feature/ec2/imds/go.mod

@@ -1,4 +1,4 @@
-module github.com/aws/aws-sdk-go-v2/ec2imds
+module github.com/aws/aws-sdk-go-v2/feature/ec2/imds
 
 go 1.15
 
@@ -8,4 +8,4 @@ require (
 	github.com/google/go-cmp v0.5.4
 )
 
-replace github.com/aws/aws-sdk-go-v2 => ../
+replace github.com/aws/aws-sdk-go-v2 => ../../../

ec2imds/integration_test.go → feature/ec2/imds/integration_test.go

@@ -1,6 +1,6 @@
 // +build integration,ec2env
 
-package ec2imds
+package imds
 
 import (
 	"context"

ec2imds/request_middleware.go → feature/ec2/imds/request_middleware.go

@@ -1,4 +1,4 @@
-package ec2imds
+package imds
 
 import (
 	"context"