Skip to content

chore(object): refactor object resource and testing #655

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

Merged
merged 1 commit into from
Oct 22, 2020
Merged

chore(object): refactor object resource and testing #655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
72 changes: 39 additions & 33 deletions scaleway/resource_object_bucket.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
package scaleway

import (
"context"
"fmt"

"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awserr"
"github.com/aws/aws-sdk-go/service/s3"
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
)

func resourceScalewayObjectBucket() *schema.Resource {
return &schema.Resource{
Create: resourceScalewayObjectBucketCreate,
Read: resourceScalewayObjectBucketRead,
Update: resourceScalewayObjectBucketUpdate,
Delete: resourceScalewayObjectBucketDelete,
CreateContext: resourceScalewayObjectBucketCreate,
ReadContext: resourceScalewayObjectBucketRead,
UpdateContext: resourceScalewayObjectBucketUpdate,
DeleteContext: resourceScalewayObjectBucketDelete,
Importer: &schema.ResourceImporter{
State: schema.ImportStatePassthrough,
StateContext: schema.ImportStatePassthroughContext,
},
Schema: map[string]*schema.Schema{
"name": {
Expand Down Expand Up @@ -56,46 +58,46 @@ func resourceScalewayObjectBucket() *schema.Resource {
}
}

func resourceScalewayObjectBucketCreate(d *schema.ResourceData, m interface{}) error {
func resourceScalewayObjectBucketCreate(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
bucketName := d.Get("name").(string)
acl := d.Get("acl").(string)

s3Client, region, err := s3ClientWithRegion(d, m)
if err != nil {
return err
return diag.FromErr(err)
}

_, err = s3Client.CreateBucket(&s3.CreateBucketInput{
_, err = s3Client.CreateBucketWithContext(ctx, &s3.CreateBucketInput{
Bucket: aws.String(bucketName),
ACL: aws.String(acl),
})
if err != nil {
return err
return diag.FromErr(err)
}

tagsSet := expandObjectBucketTags(d.Get("tags"))

if len(tagsSet) > 0 {
_, err = s3Client.PutBucketTagging(&s3.PutBucketTaggingInput{
_, err = s3Client.PutBucketTaggingWithContext(ctx, &s3.PutBucketTaggingInput{
Bucket: aws.String(bucketName),
Tagging: &s3.Tagging{
TagSet: tagsSet,
},
})
if err != nil {
return err
return diag.FromErr(err)
}
}

d.SetId(newRegionalIDString(region, bucketName))

return resourceScalewayObjectBucketRead(d, m)
return resourceScalewayObjectBucketRead(ctx, d, m)
}

func resourceScalewayObjectBucketRead(d *schema.ResourceData, m interface{}) error {
func resourceScalewayObjectBucketRead(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
s3Client, region, bucketName, err := s3ClientWithRegionAndName(m, d.Id())
if err != nil {
return err
return diag.FromErr(err)
}

_ = d.Set("name", bucketName)
Expand All @@ -109,26 +111,26 @@ func resourceScalewayObjectBucketRead(d *schema.ResourceData, m interface{}) err
// we do not read it and it has a "private" default value.
// AWS has the same issue: https://github.com/terraform-providers/terraform-provider-aws/issues/6193

_, err = s3Client.ListObjects(&s3.ListObjectsInput{
_, err = s3Client.ListObjectsWithContext(ctx, &s3.ListObjectsInput{
Bucket: aws.String(bucketName),
})
if err != nil {
if serr, ok := err.(awserr.Error); ok && serr.Code() == s3.ErrCodeNoSuchBucket {
if s3err, ok := err.(awserr.Error); ok && s3err.Code() == s3.ErrCodeNoSuchBucket {
l.Errorf("Bucket %q was not found - removing from state!", bucketName)
d.SetId("")
return nil
}
return fmt.Errorf("couldn't read bucket: %s", err)
return diag.FromErr(fmt.Errorf("couldn't read bucket: %s", err))
}

var tagsSet []*s3.Tag

tagsResponse, err := s3Client.GetBucketTagging(&s3.GetBucketTaggingInput{
tagsResponse, err := s3Client.GetBucketTaggingWithContext(ctx, &s3.GetBucketTaggingInput{
Bucket: aws.String(bucketName),
})
if err != nil {
if serr, ok := err.(awserr.Error); !ok || serr.Code() != "NoSuchTagSet" {
return fmt.Errorf("couldn't read tags from bucket: %s", err)
if s3err, ok := err.(awserr.Error); !ok || s3err.Code() != "NoSuchTagSet" {
return diag.FromErr(fmt.Errorf("couldn't read tags from bucket: %s", err))
}
} else {
tagsSet = tagsResponse.TagSet
Expand All @@ -141,50 +143,54 @@ func resourceScalewayObjectBucketRead(d *schema.ResourceData, m interface{}) err
return nil
}

func resourceScalewayObjectBucketUpdate(d *schema.ResourceData, m interface{}) error {
s3Client, _, bucketName, err := s3ClientWithRegionAndName(m, d.Id())
func resourceScalewayObjectBucketUpdate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
s3Client, _, bucketName, err := s3ClientWithRegionAndName(meta, d.Id())
if err != nil {
return err
return diag.FromErr(err)
}

if d.HasChange("acl") {
acl := d.Get("acl").(string)

_, err := s3Client.PutBucketAcl(&s3.PutBucketAclInput{
_, err := s3Client.PutBucketAclWithContext(ctx, &s3.PutBucketAclInput{
Bucket: aws.String(bucketName),
ACL: aws.String(acl),
})
if err != nil {
l.Errorf("Couldn't update bucket ACL: %s", err)
return fmt.Errorf("couldn't update bucket ACL: %s", err)
return diag.FromErr(fmt.Errorf("couldn't update bucket ACL: %s", err))
}
}

if d.HasChange("tags") {
tagsSet := expandObjectBucketTags(d.Get("tags"))

_, err = s3Client.PutBucketTagging(&s3.PutBucketTaggingInput{
_, err = s3Client.PutBucketTaggingWithContext(ctx, &s3.PutBucketTaggingInput{
Bucket: aws.String(bucketName),
Tagging: &s3.Tagging{
TagSet: tagsSet,
},
})
if err != nil {
return err
return diag.FromErr(err)
}
}

return resourceScalewayObjectBucketRead(d, m)
return resourceScalewayObjectBucketRead(ctx, d, meta)
}

func resourceScalewayObjectBucketDelete(d *schema.ResourceData, m interface{}) error {
s3Client, _, bucketName, err := s3ClientWithRegionAndName(m, d.Id())
func resourceScalewayObjectBucketDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
s3Client, _, bucketName, err := s3ClientWithRegionAndName(meta, d.Id())
if err != nil {
return err
return diag.FromErr(err)
}

_, err = s3Client.DeleteBucket(&s3.DeleteBucketInput{
_, err = s3Client.DeleteBucketWithContext(ctx, &s3.DeleteBucketInput{
Bucket: aws.String(bucketName),
})
return err
if err != nil {
return diag.FromErr(err)
}

return nil
}
125 changes: 60 additions & 65 deletions scaleway/resource_object_bucket_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,50 +20,39 @@ func init() {
})
}

// Test data
var (
testBucketName = fmt.Sprintf("terraform-test-%d", time.Now().Unix())
testBucketNameAms = testBucketName + "ams"
testBucketNamePar = testBucketName + "par"
testBucketACL = "private"
testBucketUpdatedACL = "public-read"
)

// Test configs
var testAccCheckScalewayObjectBucket = fmt.Sprintf(`
resource "scaleway_object_bucket" "base" {
name = "%s"
tags = {
foo = "bar"
}
}

resource "scaleway_object_bucket" "ams-bucket" {
name = "%s"
region = "nl-ams"
}

resource "scaleway_object_bucket" "par-bucket" {
name = "%s"
region = "fr-par"
}
`, testBucketName, testBucketNameAms, testBucketNamePar)

var testAccCheckScalewayObjectBucketUpdate = fmt.Sprintf(`
resource "scaleway_object_bucket" "base" {
name = "%s"
acl = "%s"
}
`, testBucketName, testBucketUpdatedACL)

func TestAccScalewayObjectBucket(t *testing.T) {
func TestAccScalewayObjectBucket_Basic(t *testing.T) {
tt := NewTestTools(t)
defer tt.Cleanup()

testBucketName := fmt.Sprintf("terraform-test-%d", time.Now().Unix())
testBucketNameAms := testBucketName + "ams"
testBucketNamePar := testBucketName + "par"
testBucketACL := "private"
testBucketUpdatedACL := "public-read"
resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
Providers: testAccProviders,
CheckDestroy: testAccCheckScalewayObjectBucketDestroy,
PreCheck: func() { testAccPreCheck(t) },
ProviderFactories: tt.ProviderFactories,
CheckDestroy: testAccCheckScalewayObjectBucketDestroy(tt),
Steps: []resource.TestStep{
{
Config: testAccCheckScalewayObjectBucket,
Config: fmt.Sprintf(`
resource "scaleway_object_bucket" "base" {
name = "%s"
tags = {
foo = "bar"
}
}

resource "scaleway_object_bucket" "ams-bucket" {
name = "%s"
region = "nl-ams"
}

resource "scaleway_object_bucket" "par-bucket" {
name = "%s"
region = "fr-par"
}
`, testBucketName, testBucketNameAms, testBucketNamePar),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("scaleway_object_bucket.base", "name", testBucketName),
resource.TestCheckResourceAttr("scaleway_object_bucket.base", "acl", testBucketACL),
Expand All @@ -79,7 +68,12 @@ func TestAccScalewayObjectBucket(t *testing.T) {
),
},
{
Config: testAccCheckScalewayObjectBucketUpdate,
Config: fmt.Sprintf(`
resource "scaleway_object_bucket" "base" {
name = "%s"
acl = "%s"
}
`, testBucketName, testBucketUpdatedACL),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("scaleway_object_bucket.base", "name", testBucketName),
resource.TestCheckResourceAttr("scaleway_object_bucket.base", "acl", testBucketUpdatedACL),
Expand All @@ -90,34 +84,35 @@ func TestAccScalewayObjectBucket(t *testing.T) {
})
}

func testAccCheckScalewayObjectBucketDestroy(s *terraform.State) error {
s3Client, err := newS3ClientFromMeta(testAccProvider.Meta().(*Meta))
if err != nil {
return err
}

for _, rs := range s.RootModule().Resources {
if rs.Type != "scaleway" {
continue
func testAccCheckScalewayObjectBucketDestroy(tt *TestTools) resource.TestCheckFunc {
return func(state *terraform.State) error {
s3Client, err := newS3ClientFromMeta(tt.Meta)
if err != nil {
return err
}

bucketName := rs.Primary.ID

_, err := s3Client.ListObjects(&s3.ListObjectsInput{
Bucket: &bucketName,
})
if err != nil {
if serr, ok := err.(awserr.Error); ok && serr.Code() == s3.ErrCodeNoSuchBucket {
// bucket doesn't exist
for _, rs := range state.RootModule().Resources {
if rs.Type != "scaleway" {
continue
}
return fmt.Errorf("couldn't get bucket to verify if it stil exists: %s", err)
}

return fmt.Errorf("bucket should be deleted")
}
bucketName := rs.Primary.ID

return nil
_, err := s3Client.ListObjects(&s3.ListObjectsInput{
Bucket: &bucketName,
})
if err != nil {
if s3err, ok := err.(awserr.Error); ok && s3err.Code() == s3.ErrCodeNoSuchBucket {
// bucket doesn't exist
continue
}
return fmt.Errorf("couldn't get bucket to verify if it stil exists: %s", err)
}

return fmt.Errorf("bucket should be deleted")
}
return nil
}
}

func testSweepStorageObjectBucket(region string) error {
Expand All @@ -138,7 +133,7 @@ func testSweepStorageObjectBucket(region string) error {
Bucket: bucket.Name,
})
if err != nil {
return fmt.Errorf("Error deleting bucket in Sweeper: %s", err)
return fmt.Errorf("error deleting bucket in Sweeper: %s", err)
}
}
}
Expand Down