Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove leading ./ from S3 object key name -- AWS SDK for Go v1 compatibility #35223

Merged
merged 4 commits into from
Jan 11, 2024
Merged

Remove leading ./ from S3 object key name -- AWS SDK for Go v1 compatibility #35223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
da88aaa
Add 'TestAccS3ObjectDataSource_leadingDotSlash'.
ewbankkit Jan 10, 2024
4f9bfd5
Add 'TestAccS3ObjectDataSource_leadingMultipleSlashes'.
ewbankkit Jan 10, 2024
918a868
Remove leading './' from S3 object key names for AWS SDK for Go v1 co…
ewbankkit Jan 10, 2024
699b04f
Add CHANGELOG entry.
ewbankkit Jan 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .changelog/35223.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
```release-note:bug
resource/aws_s3_object: Remove any leading `./` from `key` to maintain AWS SDK for Go v1 (pre-v5.17.0) compatibility
```

```release-note:bug
data-source/aws_s3_object: Remove any leading `./` from `key` to maintain AWS SDK for Go v1 (pre-v5.17.0) compatibility
```

```release-note:bug
data-source/aws_s3_bucket_object: Remove any leading `./` from `key` to maintain AWS SDK for Go v1 (pre-v5.17.0) compatibility
```

```release-note:bug
resource/aws_s3_object_copy: Remove any leading `./` from `key` to maintain AWS SDK for Go v1 (pre-v5.17.0) compatibility
```

```release-note:bug
resource/aws_s3_bucket_object: Remove any leading `./` from `key` to maintain AWS SDK for Go v1 (pre-v5.17.0) compatibility
```
2 changes: 2 additions & 0 deletions internal/service/s3/object.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -733,6 +733,8 @@ func flattenObjectDate(t *time.Time) string {
// See https://docs.aws.amazon.com/sdk-for-go/api/service/s3/#hdr-Automatic_URI_cleaning.
// See https://github.com/aws/aws-sdk-go/blob/cf903c8c543034654bb8f53b5f9d6454fdb2117f/private/protocol/rest/build.go#L247-L258.
func sdkv1CompatibleCleanKey(key string) string {
// Remove leading './'.
key = strings.TrimPrefix(key, "./")
// We are effectively ignoring all leading '/'s and treating multiple '/'s as a single '/'.
key = strings.TrimLeft(key, "/")
key = regexache.MustCompile(`/+`).ReplaceAllString(key, "/")
Expand Down
148 changes: 147 additions & 1 deletion internal/service/s3/object_data_source_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,89 @@ func TestAccS3ObjectDataSource_singleSlashAsKey(t *testing.T) {
})
}

func TestAccS3ObjectDataSource_leadingDotSlash(t *testing.T) {
ctx := acctest.Context(t)
rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
resourceName := "aws_s3_object.test"
dataSourceName1 := "data.aws_s3_object.test1"
dataSourceName2 := "data.aws_s3_object.test2"

resourceOnlyConf, conf := testAccObjectDataSourceConfig_leadingDotSlash(rName)

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() { acctest.PreCheck(ctx, t) },
ErrorCheck: acctest.ErrorCheck(t, names.S3EndpointID),
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories,
PreventPostDestroyRefresh: true,
Steps: []resource.TestStep{
{ // nosemgrep:ci.test-config-funcs-correct-form
Config: resourceOnlyConf,
},
{ // nosemgrep:ci.test-config-funcs-correct-form
Config: conf,
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(dataSourceName1, "body", "yes"),
resource.TestCheckResourceAttr(dataSourceName1, "content_length", "3"),
resource.TestCheckResourceAttrPair(dataSourceName1, "content_type", resourceName, "content_type"),
resource.TestCheckResourceAttrPair(dataSourceName1, "etag", resourceName, "etag"),
resource.TestMatchResourceAttr(dataSourceName1, "last_modified", regexache.MustCompile(rfc1123RegexPattern)),

resource.TestCheckResourceAttr(dataSourceName2, "body", "yes"),
resource.TestCheckResourceAttr(dataSourceName2, "content_length", "3"),
resource.TestCheckResourceAttrPair(dataSourceName2, "content_type", resourceName, "content_type"),
resource.TestCheckResourceAttrPair(dataSourceName2, "etag", resourceName, "etag"),
resource.TestMatchResourceAttr(dataSourceName2, "last_modified", regexache.MustCompile(rfc1123RegexPattern)),
),
},
},
})
}

func TestAccS3ObjectDataSource_leadingMultipleSlashes(t *testing.T) {
ctx := acctest.Context(t)
rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
resourceName := "aws_s3_object.test"
dataSourceName1 := "data.aws_s3_object.test1"
dataSourceName2 := "data.aws_s3_object.test2"
dataSourceName3 := "data.aws_s3_object.test3"

resourceOnlyConf, conf := testAccObjectDataSourceConfig_leadingMultipleSlashes(rName)

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() { acctest.PreCheck(ctx, t) },
ErrorCheck: acctest.ErrorCheck(t, names.S3EndpointID),
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories,
PreventPostDestroyRefresh: true,
Steps: []resource.TestStep{
{ // nosemgrep:ci.test-config-funcs-correct-form
Config: resourceOnlyConf,
},
{ // nosemgrep:ci.test-config-funcs-correct-form
Config: conf,
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(dataSourceName1, "body", "yes"),
resource.TestCheckResourceAttr(dataSourceName1, "content_length", "3"),
resource.TestCheckResourceAttrPair(dataSourceName1, "content_type", resourceName, "content_type"),
resource.TestCheckResourceAttrPair(dataSourceName1, "etag", resourceName, "etag"),
resource.TestMatchResourceAttr(dataSourceName1, "last_modified", regexache.MustCompile(rfc1123RegexPattern)),

resource.TestCheckResourceAttr(dataSourceName2, "body", "yes"),
resource.TestCheckResourceAttr(dataSourceName2, "content_length", "3"),
resource.TestCheckResourceAttrPair(dataSourceName2, "content_type", resourceName, "content_type"),
resource.TestCheckResourceAttrPair(dataSourceName2, "etag", resourceName, "etag"),
resource.TestMatchResourceAttr(dataSourceName2, "last_modified", regexache.MustCompile(rfc1123RegexPattern)),

resource.TestCheckResourceAttr(dataSourceName3, "body", "yes"),
resource.TestCheckResourceAttr(dataSourceName3, "content_length", "3"),
resource.TestCheckResourceAttrPair(dataSourceName3, "content_type", resourceName, "content_type"),
resource.TestCheckResourceAttrPair(dataSourceName3, "etag", resourceName, "etag"),
resource.TestMatchResourceAttr(dataSourceName3, "last_modified", regexache.MustCompile(rfc1123RegexPattern)),
),
},
},
})
}

func TestAccS3ObjectDataSource_checksumMode(t *testing.T) {
ctx := acctest.Context(t)
rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
Expand Down Expand Up @@ -728,7 +811,7 @@ resource "aws_s3_bucket" "test" {

resource "aws_s3_object" "test" {
bucket = aws_s3_bucket.test.bucket
key = "//%[1]s-key"
key = "/%[1]s-key"
content = "yes"
content_type = "text/plain"
}
Expand Down Expand Up @@ -809,6 +892,69 @@ data "aws_s3_object" "test" {
`, rName)
}

func testAccObjectDataSourceConfig_leadingDotSlash(rName string) (string, string) {
resources := fmt.Sprintf(`
resource "aws_s3_bucket" "test" {
bucket = %[1]q
}

resource "aws_s3_object" "test" {
bucket = aws_s3_bucket.test.bucket
key = "./%[1]s-key"
content = "yes"
content_type = "text/plain"
}
`, rName)

both := acctest.ConfigCompose(resources, fmt.Sprintf(`
data "aws_s3_object" "test1" {
bucket = aws_s3_bucket.test.bucket
key = "%[1]s-key"
}

data "aws_s3_object" "test2" {
bucket = aws_s3_bucket.test.bucket
key = "/%[1]s-key"
}
`, rName))

return resources, both
}

func testAccObjectDataSourceConfig_leadingMultipleSlashes(rName string) (string, string) {
resources := fmt.Sprintf(`
resource "aws_s3_bucket" "test" {
bucket = %[1]q
}

resource "aws_s3_object" "test" {
bucket = aws_s3_bucket.test.bucket
key = "///%[1]s-key"
content = "yes"
content_type = "text/plain"
}
`, rName)

both := acctest.ConfigCompose(resources, fmt.Sprintf(`
data "aws_s3_object" "test1" {
bucket = aws_s3_bucket.test.bucket
key = "%[1]s-key"
}

data "aws_s3_object" "test2" {
bucket = aws_s3_bucket.test.bucket
key = "/%[1]s-key"
}

data "aws_s3_object" "test3" {
bucket = aws_s3_bucket.test.bucket
key = "//%[1]s-key"
}
`, rName))

return resources, both
}

func testAccObjectDataSourceConfig_checksumMode(rName string) string {
return fmt.Sprintf(`
resource "aws_s3_bucket" "test" {
Expand Down
Loading