Merge pull request #38554 from DanielRieske/f/migrate-storagegateway-…

…sdkv2

 Migrate `Storage Gateway` resources to AWS SDK V2

.changelog/38554.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+resource/aws_storagegateway_file_system_association: Add configurable timeouts
+```

go.mod

@@ -208,6 +208,7 @@ require (
 	github.com/aws/aws-sdk-go-v2/service/ssmsap v1.15.3
 	github.com/aws/aws-sdk-go-v2/service/sso v1.22.4
 	github.com/aws/aws-sdk-go-v2/service/ssoadmin v1.27.4
+	github.com/aws/aws-sdk-go-v2/service/storagegateway v1.31.3
 	github.com/aws/aws-sdk-go-v2/service/sts v1.30.3
 	github.com/aws/aws-sdk-go-v2/service/swf v1.25.3
 	github.com/aws/aws-sdk-go-v2/service/synthetics v1.26.3

go.sum

@@ -448,6 +448,8 @@ github.com/aws/aws-sdk-go-v2/service/ssoadmin v1.27.4 h1:oXiKn9jcx+8yLLuwm8TO6qh
 github.com/aws/aws-sdk-go-v2/service/ssoadmin v1.27.4/go.mod h1:EyoPT+dUT5zqspxSub9KHDWOZyIP30bPgIavBvGGVz0=
 github.com/aws/aws-sdk-go-v2/service/ssooidc v1.26.4 h1:yiwVzJW2ZxZTurVbYWA7QOrAaCYQR72t0wrSBfoesUE=
 github.com/aws/aws-sdk-go-v2/service/ssooidc v1.26.4/go.mod h1:0oxfLkpz3rQ/CHlx5hB7H69YUpFiI1tql6Q6Ne+1bCw=
+github.com/aws/aws-sdk-go-v2/service/storagegateway v1.31.3 h1:0hdxWCS8mM4qsZI3GldBkXeee4X25aC9wZGQhpbt6w8=
+github.com/aws/aws-sdk-go-v2/service/storagegateway v1.31.3/go.mod h1:N2tZQtDCR/Ls4o1pH6neRhhlkhKNE6SoruLn6nTpnzU=
 github.com/aws/aws-sdk-go-v2/service/sts v1.30.3 h1:ZsDKRLXGWHk8WdtyYMoGNO7bTudrvuKpDKgMVRlepGE=
 github.com/aws/aws-sdk-go-v2/service/sts v1.30.3/go.mod h1:zwySh8fpFyXp9yOr/KVzxOl8SRqgf/IDw5aUt9UKFcQ=
 github.com/aws/aws-sdk-go-v2/service/swf v1.25.3 h1:7zYsHA9ORjiCHYzTJf0g+gwo3mPpn2XbMlWQreiXWdM=

internal/service/storagegateway/cache.go

@@ -9,13 +9,16 @@ import (
 	"log"
 	"strings"
 
-	"github.com/aws/aws-sdk-go/aws"
-	"github.com/aws/aws-sdk-go/aws/arn"
-	"github.com/aws/aws-sdk-go/service/storagegateway"
+	"github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/aws/aws-sdk-go-v2/aws/arn"
+	"github.com/aws/aws-sdk-go-v2/service/storagegateway"
+	awstypes "github.com/aws/aws-sdk-go-v2/service/storagegateway/types"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-provider-aws/internal/conns"
 	"github.com/hashicorp/terraform-provider-aws/internal/errs/sdkdiag"
+	tfslices "github.com/hashicorp/terraform-provider-aws/internal/slices"
 	"github.com/hashicorp/terraform-provider-aws/internal/tfresource"
 	"github.com/hashicorp/terraform-provider-aws/internal/verify"
 )
@@ -49,17 +52,17 @@ func resourceCache() *schema.Resource {
 
 func resourceCacheCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	var diags diag.Diagnostics
-	conn := meta.(*conns.AWSClient).StorageGatewayConn(ctx)
+	conn := meta.(*conns.AWSClient).StorageGatewayClient(ctx)
 
 	diskID := d.Get("disk_id").(string)
 	gatewayARN := d.Get("gateway_arn").(string)
 	id := cacheCreateResourceID(gatewayARN, diskID)
 	inputAC := &storagegateway.AddCacheInput{
-		DiskIds:    aws.StringSlice([]string{diskID}),
+		DiskIds:    []string{diskID},
 		GatewayARN: aws.String(gatewayARN),
 	}
 
-	_, err := conn.AddCacheWithContext(ctx, inputAC)
+	_, err := conn.AddCache(ctx, inputAC)
 
 	if err != nil {
 		return sdkdiag.AppendErrorf(diags, "creating Storage Gateway Cache (%s): %s", id, err)
@@ -76,16 +79,16 @@ func resourceCacheCreate(ctx context.Context, d *schema.ResourceData, meta inter
 	inputLLD := &storagegateway.ListLocalDisksInput{
 		GatewayARN: aws.String(gatewayARN),
 	}
-	disk, err := findLocalDisk(ctx, conn, inputLLD, func(v *storagegateway.Disk) bool {
-		return aws.StringValue(v.DiskId) == diskID || aws.StringValue(v.DiskNode) == diskID || aws.StringValue(v.DiskPath) == diskID
+	disk, err := findLocalDisk(ctx, conn, inputLLD, func(v awstypes.Disk) bool {
+		return aws.ToString(v.DiskId) == diskID || aws.ToString(v.DiskNode) == diskID || aws.ToString(v.DiskPath) == diskID
 	})
 
 	switch {
 	case tfresource.NotFound(err):
 	case err != nil:
 		return sdkdiag.AppendErrorf(diags, "reading Storage Gateway local disk: %s", err)
 	default:
-		id = cacheCreateResourceID(gatewayARN, aws.StringValue(disk.DiskId))
+		id = cacheCreateResourceID(gatewayARN, aws.ToString(disk.DiskId))
 		d.SetId(id)
 	}
 
@@ -94,45 +97,23 @@ func resourceCacheCreate(ctx context.Context, d *schema.ResourceData, meta inter
 
 func resourceCacheRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	var diags diag.Diagnostics
-	conn := meta.(*conns.AWSClient).StorageGatewayConn(ctx)
+	conn := meta.(*conns.AWSClient).StorageGatewayClient(ctx)
 
 	gatewayARN, diskID, err := cacheParseResourceID(d.Id())
 	if err != nil {
 		return sdkdiag.AppendFromErr(diags, err)
 	}
 
-	input := &storagegateway.DescribeCacheInput{
-		GatewayARN: aws.String(gatewayARN),
-	}
-
-	output, err := conn.DescribeCacheWithContext(ctx, input)
-	if err != nil {
-		if IsErrGatewayNotFound(err) {
-			log.Printf("[WARN] Storage Gateway Cache (%s) not found, removing from state", d.Id())
-			d.SetId("")
-			return diags
-		}
-		return sdkdiag.AppendErrorf(diags, "reading Storage Gateway Cache (%s): %s", d.Id(), err)
-	}
+	err = findCacheByTwoPartKey(ctx, conn, gatewayARN, diskID)
 
-	if output == nil || len(output.DiskIds) == 0 {
+	if !d.IsNewResource() && tfresource.NotFound(err) {
 		log.Printf("[WARN] Storage Gateway Cache (%s) not found, removing from state", d.Id())
 		d.SetId("")
 		return diags
 	}
 
-	found := false
-	for _, existingDiskID := range output.DiskIds {
-		if aws.StringValue(existingDiskID) == diskID {
-			found = true
-			break
-		}
-	}
-
-	if !found {
-		log.Printf("[WARN] Storage Gateway Cache (%s) not found, removing from state", d.Id())
-		d.SetId("")
-		return diags
+	if err != nil {
+		return sdkdiag.AppendErrorf(diags, "reading Storage Gateway Cache (%s): %s", d.Id(), err)
 	}
 
 	d.Set("disk_id", diskID)
@@ -158,7 +139,7 @@ func cacheParseResourceID(id string) (string, string, error) {
 		return "", "", idFormatErr
 	}
 	// gatewayARNAndDisk.Resource = gateway/sgw-12345678:pci-0000:03:00.0-scsi-0:0:0:0
-	resourceParts := strings.SplitN(gatewayARNAndDisk.Resource, ":", 2)
+	resourceParts := strings.SplitN(gatewayARNAndDisk.Resource, cacheResourceIDSeparator, 2)
 	if len(resourceParts) != 2 {
 		return "", "", idFormatErr
 	}
@@ -172,3 +153,41 @@ func cacheParseResourceID(id string) (string, string, error) {
 	}
 	return gatewayARN.String(), resourceParts[1], nil
 }
+
+func findCacheByTwoPartKey(ctx context.Context, conn *storagegateway.Client, gatewayARN, diskID string) error {
+	input := &storagegateway.DescribeCacheInput{
+		GatewayARN: aws.String(gatewayARN),
+	}
+	output, err := findCache(ctx, conn, input)
+
+	if err != nil {
+		return err
+	}
+
+	_, err = tfresource.AssertSingleValueResult(tfslices.Filter(output.DiskIds, func(v string) bool {
+		return v == diskID
+	}))
+
+	return err
+}
+
+func findCache(ctx context.Context, conn *storagegateway.Client, input *storagegateway.DescribeCacheInput) (*storagegateway.DescribeCacheOutput, error) {
+	output, err := conn.DescribeCache(ctx, input)
+
+	if isGatewayNotFoundErr(err) {
+		return nil, &retry.NotFoundError{
+			LastError:   err,
+			LastRequest: input,
+		}
+	}
+
+	if err != nil {
+		return nil, err
+	}
+
+	if output == nil {
+		return nil, tfresource.NewEmptyResultError(input)
+	}
+
+	return output, err
+}

internal/service/storagegateway/cache_test.go

@@ -8,8 +8,6 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/aws/aws-sdk-go/aws"
-	"github.com/aws/aws-sdk-go/service/storagegateway"
 	sdkacctest "github.com/hashicorp/terraform-plugin-testing/helper/acctest"
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
 	"github.com/hashicorp/terraform-plugin-testing/terraform"
@@ -19,7 +17,7 @@ import (
 	"github.com/hashicorp/terraform-provider-aws/names"
 )
 
-func TestDecodeCacheID(t *testing.T) {
+func TestCacheParseResourceID(t *testing.T) {
 	t.Parallel()
 
 	var testCases = []struct {
@@ -87,9 +85,8 @@ func TestAccStorageGatewayCache_fileGateway(t *testing.T) {
 		PreCheck:                 func() { acctest.PreCheck(ctx, t) },
 		ErrorCheck:               acctest.ErrorCheck(t, names.StorageGatewayServiceID),
 		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories,
-		// Storage Gateway API does not support removing caches,
-		// but we want to ensure other resources are removed.
-		CheckDestroy: testAccCheckGatewayDestroy(ctx),
+		// Storage Gateway API does not support removing caches.
+		CheckDestroy: acctest.CheckDestroyNoop,
 		Steps: []resource.TestStep{
 			{
 				Config: testAccCacheConfig_fileGateway(rName),
@@ -118,9 +115,7 @@ func TestAccStorageGatewayCache_tapeAndVolumeGateway(t *testing.T) {
 		PreCheck:                 func() { acctest.PreCheck(ctx, t) },
 		ErrorCheck:               acctest.ErrorCheck(t, names.StorageGatewayServiceID),
 		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories,
-		// Storage Gateway API does not support removing caches,
-		// but we want to ensure other resources are removed.
-		CheckDestroy: testAccCheckGatewayDestroy(ctx),
+		CheckDestroy:             acctest.CheckDestroyNoop,
 		Steps: []resource.TestStep{
 			{
 				Config: testAccCacheConfig_tapeAndVolumeGateway(rName),
@@ -139,53 +134,33 @@ func TestAccStorageGatewayCache_tapeAndVolumeGateway(t *testing.T) {
 	})
 }
 
-func testAccCheckCacheExists(ctx context.Context, resourceName string) resource.TestCheckFunc {
+func testAccCheckCacheExists(ctx context.Context, n string) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
-		rs, ok := s.RootModule().Resources[resourceName]
+		rs, ok := s.RootModule().Resources[n]
 		if !ok {
-			return fmt.Errorf("Not found: %s", resourceName)
+			return fmt.Errorf("Not found: %s", n)
 		}
 
-		conn := acctest.Provider.Meta().(*conns.AWSClient).StorageGatewayConn(ctx)
+		conn := acctest.Provider.Meta().(*conns.AWSClient).StorageGatewayClient(ctx)
 
 		gatewayARN, diskID, err := tfstoragegateway.CacheParseResourceID(rs.Primary.ID)
 		if err != nil {
 			return err
 		}
 
-		input := &storagegateway.DescribeCacheInput{
-			GatewayARN: aws.String(gatewayARN),
-		}
-
-		output, err := conn.DescribeCacheWithContext(ctx, input)
-
-		if err != nil {
-			return fmt.Errorf("error reading Storage Gateway cache: %s", err)
-		}
-
-		if output == nil || len(output.DiskIds) == 0 {
-			return fmt.Errorf("Storage Gateway cache %q not found", rs.Primary.ID)
-		}
-
-		for _, existingDiskID := range output.DiskIds {
-			if aws.StringValue(existingDiskID) == diskID {
-				return nil
-			}
-		}
-
-		return fmt.Errorf("Storage Gateway cache %q not found", rs.Primary.ID)
+		return tfstoragegateway.FindCacheByTwoPartKey(ctx, conn, gatewayARN, diskID)
 	}
 }
 
 func testAccCacheConfig_fileGateway(rName string) string {
-	return testAccGatewayConfig_typeFileS3(rName) + fmt.Sprintf(`
+	return acctest.ConfigCompose(testAccGatewayConfig_typeFileS3(rName), fmt.Sprintf(`
 resource "aws_ebs_volume" "test" {
   availability_zone = aws_instance.test.availability_zone
   size              = "10"
   type              = "gp2"
 
   tags = {
-    Name = %q
+    Name = %[1]q
   }
 }
 
@@ -215,18 +190,18 @@ resource "aws_storagegateway_cache" "test" {
   disk_id     = data.aws_storagegateway_local_disk.test.id
   gateway_arn = aws_storagegateway_gateway.test.arn
 }
-`, rName)
+`, rName))
 }
 
 func testAccCacheConfig_tapeAndVolumeGateway(rName string) string {
-	return testAccGatewayConfig_typeCached(rName) + fmt.Sprintf(`
+	return acctest.ConfigCompose(testAccGatewayConfig_typeCached(rName), fmt.Sprintf(`
 resource "aws_ebs_volume" "test" {
   availability_zone = aws_instance.test.availability_zone
   size              = "10"
   type              = "gp2"
 
   tags = {
-    Name = %q
+    Name = %[1]q
   }
 }
 
@@ -256,5 +231,5 @@ resource "aws_storagegateway_cache" "test" {
   disk_id     = data.aws_storagegateway_local_disk.test.id
   gateway_arn = aws_storagegateway_gateway.test.arn
 }
-`, rName)
+`, rName))
 }