add support for tag-on-create for dynamodb tables #8469
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| package aws | ||
|
|
||
| import ( | ||
| "log" | ||
| "regexp" | ||
| "time" | ||
|
|
||
| "github.com/aws/aws-sdk-go/aws" | ||
| "github.com/aws/aws-sdk-go/service/dynamodb" | ||
| "github.com/hashicorp/terraform/helper/resource" | ||
| "github.com/hashicorp/terraform/helper/schema" | ||
| ) | ||
|
|
||
| // setTags is a helper to set the tags for a resource. It expects the | ||
| // tags field to be named "tags" and the ARN field to be named "arn". | ||
| func setTagsDynamoDb(conn *dynamodb.DynamoDB, d *schema.ResourceData) error { | ||
| arn := d.Get("arn").(string) | ||
| oraw, nraw := d.GetChange("tags") | ||
| o := oraw.(map[string]interface{}) | ||
| n := nraw.(map[string]interface{}) | ||
| create, remove := diffTagsDynamoDb(tagsFromMapDynamoDb(o), tagsFromMapDynamoDb(n)) | ||
|
|
||
| // Set tags | ||
| if len(remove) > 0 { | ||
| err := resource.Retry(2*time.Minute, func() *resource.RetryError { | ||
| log.Printf("[DEBUG] Removing tags: %#v from %s", remove, d.Id()) | ||
| _, err := conn.UntagResource(&dynamodb.UntagResourceInput{ | ||
| ResourceArn: aws.String(arn), | ||
| TagKeys: remove, | ||
| }) | ||
| if err != nil { | ||
| if isAWSErr(err, dynamodb.ErrCodeResourceNotFoundException, "") { | ||
| return resource.RetryableError(err) | ||
| } | ||
| return resource.NonRetryableError(err) | ||
| } | ||
| return nil | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| if len(create) > 0 { | ||
| err := resource.Retry(2*time.Minute, func() *resource.RetryError { | ||
| log.Printf("[DEBUG] Creating tags: %s for %s", create, d.Id()) | ||
| _, err := conn.TagResource(&dynamodb.TagResourceInput{ | ||
| ResourceArn: aws.String(arn), | ||
| Tags: create, | ||
| }) | ||
| if err != nil { | ||
| if isAWSErr(err, dynamodb.ErrCodeResourceNotFoundException, "") { | ||
| return resource.RetryableError(err) | ||
| } | ||
| return resource.NonRetryableError(err) | ||
| } | ||
| return nil | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // diffTags takes our tags locally and the ones remotely and returns | ||
| // the set of tags that must be created, and the set of tags that must | ||
| // be destroyed. | ||
| func diffTagsDynamoDb(oldTags, newTags []*dynamodb.Tag) ([]*dynamodb.Tag, []*string) { | ||
| // First, we're creating everything we have | ||
| create := make(map[string]interface{}) | ||
| for _, t := range newTags { | ||
| create[aws.StringValue(t.Key)] = aws.StringValue(t.Value) | ||
| } | ||
|
|
||
| // Build the list of what to remove | ||
| var remove []*string | ||
| for _, t := range oldTags { | ||
| old, ok := create[aws.StringValue(t.Key)] | ||
| if !ok || old != aws.StringValue(t.Value) { | ||
| remove = append(remove, t.Key) | ||
| } else if ok { | ||
| // already present so remove from new | ||
| delete(create, aws.StringValue(t.Key)) | ||
| } | ||
| } | ||
|
|
||
| return tagsFromMapDynamoDb(create), remove | ||
| } | ||
|
|
||
| // tagsFromMapDynamoDb returns the tags for the given map of data. | ||
| func tagsFromMapDynamoDb(m map[string]interface{}) []*dynamodb.Tag { | ||
| result := make([]*dynamodb.Tag, 0, len(m)) | ||
| for k, v := range m { | ||
| t := &dynamodb.Tag{ | ||
| Key: aws.String(k), | ||
| Value: aws.String(v.(string)), | ||
| } | ||
| if !tagIgnoredDynamoDb(t) { | ||
| result = append(result, t) | ||
| } | ||
| } | ||
|
|
||
| return result | ||
| } | ||
|
|
||
| // tagsToMap turns the list of tags into a map. | ||
| func tagsToMapDynamoDb(ts []*dynamodb.Tag) map[string]string { | ||
| result := make(map[string]string) | ||
| for _, t := range ts { | ||
| if !tagIgnoredDynamoDb(t) { | ||
| result[aws.StringValue(t.Key)] = aws.StringValue(t.Value) | ||
| } | ||
| } | ||
| return result | ||
| } | ||
|
|
||
| // compare a tag against a list of strings and checks if it should | ||
| // be ignored or not | ||
| func tagIgnoredDynamoDb(t *dynamodb.Tag) bool { | ||
| filter := []string{"^aws:"} | ||
| for _, v := range filter { | ||
| log.Printf("[DEBUG] Matching %v with %v\n", v, *t.Key) | ||
| r, _ := regexp.MatchString(v, *t.Key) | ||
| if r { | ||
| log.Printf("[DEBUG] Found AWS specific tag %s (val: %s), ignoring.\n", *t.Key, *t.Value) | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| package aws | ||
|
|
||
| import ( | ||
| "reflect" | ||
| "testing" | ||
|
|
||
| "github.com/aws/aws-sdk-go/aws" | ||
| "github.com/aws/aws-sdk-go/service/dynamodb" | ||
| ) | ||
|
|
||
| func TestDiffDynamoDbTags(t *testing.T) { | ||
| cases := []struct { | ||
| Old, New map[string]interface{} | ||
| Create, Remove map[string]string | ||
| }{ | ||
| // Add | ||
| { | ||
| Old: map[string]interface{}{ | ||
| "foo": "bar", | ||
| }, | ||
| New: map[string]interface{}{ | ||
| "foo": "bar", | ||
| "bar": "baz", | ||
| }, | ||
| Create: map[string]string{ | ||
| "bar": "baz", | ||
| }, | ||
| Remove: map[string]string{}, | ||
| }, | ||
|
|
||
| // Modify | ||
| { | ||
| Old: map[string]interface{}{ | ||
| "foo": "bar", | ||
| }, | ||
| New: map[string]interface{}{ | ||
| "foo": "baz", | ||
| }, | ||
| Create: map[string]string{ | ||
| "foo": "baz", | ||
| }, | ||
| Remove: map[string]string{ | ||
| "foo": "bar", | ||
| }, | ||
| }, | ||
|
|
||
| // Overlap | ||
| { | ||
| Old: map[string]interface{}{ | ||
| "foo": "bar", | ||
| "hello": "world", | ||
| }, | ||
| New: map[string]interface{}{ | ||
| "foo": "baz", | ||
| "hello": "world", | ||
| }, | ||
| Create: map[string]string{ | ||
| "foo": "baz", | ||
| }, | ||
| Remove: map[string]string{ | ||
| "foo": "bar", | ||
| }, | ||
| }, | ||
|
|
||
| // Remove | ||
| { | ||
| Old: map[string]interface{}{ | ||
| "foo": "bar", | ||
| "bar": "baz", | ||
| }, | ||
| New: map[string]interface{}{ | ||
| "foo": "bar", | ||
| }, | ||
| Create: map[string]string{}, | ||
| Remove: map[string]string{ | ||
| "bar": "baz", | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for i, tc := range cases { | ||
| c, r := diffTagsDynamoDb(tagsFromMapDynamoDb(tc.Old), tagsFromMapDynamoDb(tc.New)) | ||
| cm := tagsToMapDynamoDb(c) | ||
| if !reflect.DeepEqual(cm, tc.Create) { | ||
| t.Fatalf("%d: bad create: %#v", i, cm) | ||
| } | ||
| for _, key := range r { | ||
| if _, ok := tc.Remove[aws.StringValue(key)]; !ok { | ||
| t.Fatalf("%d: bad remove: %#v", i, key) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func TestIgnoringTagsDynamoDb(t *testing.T) { | ||
| ignoredTags := []*dynamodb.Tag{ | ||
| { | ||
| Key: aws.String("aws:cloudformation:logical-id"), | ||
| Value: aws.String("foo"), | ||
| }, | ||
| { | ||
| Key: aws.String("aws:foo:bar"), | ||
| Value: aws.String("baz"), | ||
| }, | ||
| } | ||
| for _, tag := range ignoredTags { | ||
| if !tagIgnoredDynamoDb(tag) { | ||
| t.Fatalf("Tag %v with value %v not ignored, but should be!", *tag.Key, *tag.Value) | ||
| } | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It appears that AWS GovCloud (US) has unfortunately not been updated for tag-on-create support yet, returning the following error:
To workaround this error while automatically supporting tag-on-create without code change in the future, we can catch this specific error during our
resource.Retry()logic, set the parameter tonil, and perform a similar tagging API call after creation as it did previously. e.g.