Skip to content

Commit

Permalink
Merge pull request #32201 from hashicorp/b-lakeformation-tags
Browse files Browse the repository at this point in the history 
aws_lakeformation_resource_lf_tags: Correctly reads table column tags with inheritance
  • Loading branch information
@gdavison
gdavison authored Jun 26, 2023
2 parents a745b5c + c313b2b commit cec3221
Show file tree
Hide file tree
Showing 4 changed files with 371 additions and 108 deletions.
27 changes: 23 additions & 4 deletions internal/create/errors.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,24 @@ func Error(service, action, resource, id string, gotError error) error {
return errors.New(ProblemStandardMessage(service, action, resource, id, gotError))
}

// AddError returns diag.Diagnostics with an additional diag.Diagnostic containing
// an error using a standardized problem message
func AddError(diags diag.Diagnostics, service, action, resource, id string, gotError error) diag.Diagnostics {
return append(diags, newError(service, action, resource, id, gotError))
}

// DiagError returns a 1-length diag.Diagnostics with a diag.Error-level diag.Diagnostic
// with a standardized error message
func DiagError(service, action, resource, id string, gotError error) diag.Diagnostics {
return diag.Diagnostics{
diag.Diagnostic{
Severity: diag.Error,
Summary: ProblemStandardMessage(service, action, resource, id, gotError),
},
newError(service, action, resource, id, gotError),
}
}

func newError(service, action, resource, id string, gotError error) diag.Diagnostic {
return diag.Diagnostic{
Severity: diag.Error,
Summary: ProblemStandardMessage(service, action, resource, id, gotError),
}
}

Expand Down Expand Up @@ -99,6 +109,15 @@ func AddWarning(diags diag.Diagnostics, service, action, resource, id string, go
)
}

func AddWarningMessage(diags diag.Diagnostics, service, action, resource, id, message string) diag.Diagnostics {
return append(diags,
diag.Diagnostic{
Severity: diag.Warning,
Summary: ProblemStandardMessage(service, action, resource, id, fmt.Errorf(message)),
},
)
}

// AddWarningNotFoundRemoveState returns diag.Diagnostics with an additional diag.Diagnostic containing
// a warning using a standardized problem message
func AddWarningNotFoundRemoveState(service, action, resource, id string) diag.Diagnostics {
Expand Down
12 changes: 7 additions & 5 deletions internal/service/lakeformation/lakeformation_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,13 @@ func TestAccLakeFormation_serial(t *testing.T) {
"valuesOverFifty": testAccLFTag_Values_overFifty,
},
"ResourceLFTags": {
"basic": testAccResourceLFTags_basic,
"database": testAccResourceLFTags_database,
"databaseMultiple": testAccResourceLFTags_databaseMultiple,
"table": testAccResourceLFTags_table,
"tableWithColumns": testAccResourceLFTags_tableWithColumns,
"basic": testAccResourceLFTags_basic,
"database": testAccResourceLFTags_database,
"databaseMultipleTags": testAccResourceLFTags_databaseMultipleTags,
"disappears": testAccResourceLFTags_disappears,
"hierarchy": testAccResourceLFTags_hierarchy,
"table": testAccResourceLFTags_table,
"tableWithColumns": testAccResourceLFTags_tableWithColumns,
},
}

Expand Down
192 changes: 112 additions & 80 deletions internal/service/lakeformation/resource_lf_tags.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"bytes"
"context"
"fmt"
"log"
"reflect"
"time"

Expand All @@ -18,6 +17,7 @@ import (
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
"github.com/hashicorp/terraform-provider-aws/internal/conns"
"github.com/hashicorp/terraform-provider-aws/internal/create"
"github.com/hashicorp/terraform-provider-aws/internal/errs"
"github.com/hashicorp/terraform-provider-aws/internal/tfresource"
"github.com/hashicorp/terraform-provider-aws/internal/verify"
"github.com/hashicorp/terraform-provider-aws/names"
Expand Down Expand Up @@ -223,31 +223,27 @@ func ResourceResourceLFTags() *schema.Resource {
}

func resourceResourceLFTagsCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
var diags diag.Diagnostics

conn := meta.(*conns.AWSClient).LakeFormationConn(ctx)

input := &lakeformation.AddLFTagsToResourceInput{
Resource: &lakeformation.Resource{},
}
input := &lakeformation.AddLFTagsToResourceInput{}

if v, ok := d.GetOk("catalog_id"); ok {
input.CatalogId = aws.String(v.(string))
}

if v, ok := d.GetOk("database"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
input.Resource.Database = ExpandDatabaseResource(v.([]interface{})[0].(map[string]interface{}))
}

if v, ok := d.GetOk("lf_tag"); ok && v.(*schema.Set).Len() > 0 {
input.LFTags = expandLFTagPairs(v.(*schema.Set).List())
}

if v, ok := d.GetOk("table"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
input.Resource.Table = ExpandTableResource(v.([]interface{})[0].(map[string]interface{}))
tagger, ds := lfTagsTagger(d)
diags = append(diags, ds...)
if diags.HasError() {
return diags
}

if v, ok := d.GetOk("table_with_columns"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
input.Resource.TableWithColumns = expandTableColumnsResource(v.([]interface{})[0].(map[string]interface{}))
}
input.Resource = tagger.ExpandResource(d)

var output *lakeformation.AddLFTagsToResourceOutput
err := retry.RetryContext(ctx, IAMPropagationTimeout, func() *retry.RetryError {
Expand All @@ -271,130 +267,93 @@ func resourceResourceLFTagsCreate(ctx context.Context, d *schema.ResourceData, m
}

if err != nil {
return create.DiagError(names.LakeFormation, create.ErrActionCreating, ResNameLFTags, input.String(), err)
return create.AddError(diags, names.LakeFormation, create.ErrActionCreating, ResNameLFTags, input.String(), err)
}

diags := diag.Diagnostics{}

if output != nil && len(output.Failures) > 0 {
for _, v := range output.Failures {
if v.LFTag == nil || v.Error == nil {
continue
}

diags = create.AddWarning(
diags,
diags = create.AddError(diags,
names.LakeFormation,
create.ErrActionCreating,
ResNameLFTags,
fmt.Sprintf("catalog id:%s, tag key:%s, values:%+v", aws.StringValue(v.LFTag.CatalogId), aws.StringValue(v.LFTag.TagKey), aws.StringValueSlice(v.LFTag.TagValues)),
awserr.New(aws.StringValue(v.Error.ErrorCode), aws.StringValue(v.Error.ErrorMessage), nil),
)
}

if len(diags) == len(input.LFTags) {
return append(diags,
diag.Diagnostic{
Severity: diag.Error,
Summary: create.ProblemStandardMessage(names.LakeFormation, create.ErrActionCreating, ResNameLFTags, "", fmt.Errorf("attempted to add %d tags, %d failures", len(input.LFTags), len(diags))),
},
)
}
}
if diags.HasError() {
return diags
}

d.SetId(fmt.Sprintf("%d", create.StringHashcode(input.String())))

return append(resourceResourceLFTagsRead(ctx, d, meta), diags...)
return append(diags, resourceResourceLFTagsRead(ctx, d, meta)...)
}

func resourceResourceLFTagsRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
var diags diag.Diagnostics

conn := meta.(*conns.AWSClient).LakeFormationConn(ctx)

input := &lakeformation.GetResourceLFTagsInput{
Resource: &lakeformation.Resource{},
ShowAssignedLFTags: aws.Bool(true),
}

if v, ok := d.GetOk("catalog_id"); ok {
input.CatalogId = aws.String(v.(string))
}

if v, ok := d.GetOk("database"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
input.Resource.Database = ExpandDatabaseResource(v.([]interface{})[0].(map[string]interface{}))
}

if v, ok := d.GetOk("table"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
input.Resource.Table = ExpandTableResource(v.([]interface{})[0].(map[string]interface{}))
tagger, ds := lfTagsTagger(d)
diags = append(diags, ds...)
if diags.HasError() {
return diags
}

if v, ok := d.GetOk("table_with_columns"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
input.Resource.TableWithColumns = expandTableColumnsResource(v.([]interface{})[0].(map[string]interface{}))
}
input.Resource = tagger.ExpandResource(d)

output, err := conn.GetResourceLFTagsWithContext(ctx, input)

if err != nil {
return create.DiagError(names.LakeFormation, create.ErrActionReading, ResNameLFTags, d.Id(), err)
}

if len(output.LFTagOnDatabase) > 0 {
if err := d.Set("lf_tag", flattenLFTagPairs(output.LFTagOnDatabase)); err != nil {
return create.DiagError(names.LakeFormation, create.ErrActionSetting, ResNameLFTags, d.Id(), err)
}
}

if len(output.LFTagsOnColumns) > 0 {
for _, v := range output.LFTagsOnColumns {
if aws.StringValue(v.Name) != d.Get("table_with_columns.0.name").(string) {
continue
}

if err := d.Set("lf_tag", flattenLFTagPairs(v.LFTags)); err != nil {
return create.DiagError(names.LakeFormation, create.ErrActionSetting, ResNameLFTags, d.Id(), err)
}
}
return create.AddError(diags, names.LakeFormation, create.ErrActionReading, ResNameLFTags, d.Id(), err)
}

if len(output.LFTagsOnTable) > 0 {
if err := d.Set("lf_tag", flattenLFTagPairs(output.LFTagsOnTable)); err != nil {
return create.DiagError(names.LakeFormation, create.ErrActionSetting, ResNameLFTags, d.Id(), err)
}
if err := d.Set("lf_tag", tagger.FlattenTags(output)); err != nil {
return create.AddError(diags, names.LakeFormation, create.ErrActionSetting, ResNameLFTags, d.Id(), err)
}

return nil
return diags
}

func resourceResourceLFTagsDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
var diags diag.Diagnostics

conn := meta.(*conns.AWSClient).LakeFormationConn(ctx)

input := &lakeformation.RemoveLFTagsFromResourceInput{
Resource: &lakeformation.Resource{},
}
input := &lakeformation.RemoveLFTagsFromResourceInput{}

if v, ok := d.GetOk("catalog_id"); ok {
input.CatalogId = aws.String(v.(string))
}

if v, ok := d.GetOk("database"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
input.Resource.Database = ExpandDatabaseResource(v.([]interface{})[0].(map[string]interface{}))
}

if v, ok := d.GetOk("lf_tag"); ok && v.(*schema.Set).Len() > 0 {
input.LFTags = expandLFTagPairs(v.(*schema.Set).List())
}

if v, ok := d.GetOk("table"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
input.Resource.Table = ExpandTableResource(v.([]interface{})[0].(map[string]interface{}))
tagger, ds := lfTagsTagger(d)
diags = append(diags, ds...)
if diags.HasError() {
return diags
}

if v, ok := d.GetOk("table_with_columns"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
input.Resource.TableWithColumns = expandTableColumnsResource(v.([]interface{})[0].(map[string]interface{}))
}
input.Resource = tagger.ExpandResource(d)

if input.Resource == nil || reflect.DeepEqual(input.Resource, &lakeformation.Resource{}) {
if input.Resource == nil || reflect.DeepEqual(input.Resource, &lakeformation.Resource{}) || len(input.LFTags) == 0 {
// if resource is empty, don't delete = it won't delete anything since this is the predicate
log.Printf("[WARN] No Lake Formation Resource LF Tags to remove")
return nil
return create.AddWarningMessage(diags, names.LakeFormation, create.ErrActionSetting, ResNameLFTags, d.Id(), "no LF-Tags to remove")
}

err := retry.RetryContext(ctx, d.Timeout(schema.TimeoutDelete), func() *retry.RetryError {
Expand All @@ -408,7 +367,7 @@ func resourceResourceLFTagsDelete(ctx context.Context, d *schema.ResourceData, m
return retry.RetryableError(err)
}

return retry.NonRetryableError(fmt.Errorf("unable to revoke Lake Formation Permissions: %w", err))
return retry.NonRetryableError(fmt.Errorf("removing Lake Formation LF-Tags: %w", err))
}
return nil
})
Expand All @@ -418,10 +377,83 @@ func resourceResourceLFTagsDelete(ctx context.Context, d *schema.ResourceData, m
}

if err != nil {
return create.DiagError(names.LakeFormation, create.ErrActionDeleting, ResNameLFTags, d.Id(), err)
return create.AddError(diags, names.LakeFormation, create.ErrActionDeleting, ResNameLFTags, d.Id(), err)
}

return diags
}

func lfTagsTagger(d *schema.ResourceData) (tagger, diag.Diagnostics) {
var diags diag.Diagnostics
if v, ok := d.GetOk("database"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
return &databaseTagger{}, diags
} else if v, ok := d.GetOk("table"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
return &tableTagger{}, diags
} else if v, ok := d.GetOk("table_with_columns"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
return &columnTagger{}, diags
} else {
diags = append(diags, errs.NewErrorDiagnostic(
"Invalid Lake Formation Resource Type",
"An unexpected error occurred while resolving the Lake Formation Resource type. "+
"This is always an error in the provider. "+
"Please report the following to the provider developer:\n\n"+
"No Lake Formation Resource defined.",
))
return nil, diags
}
}

type tagger interface {
ExpandResource(*schema.ResourceData) *lakeformation.Resource
FlattenTags(*lakeformation.GetResourceLFTagsOutput) []any
}

type databaseTagger struct{}

func (t *databaseTagger) ExpandResource(d *schema.ResourceData) *lakeformation.Resource {
v := d.Get("database").([]any)[0].(map[string]any)
return &lakeformation.Resource{
Database: ExpandDatabaseResource(v),
}
}

func (t *databaseTagger) FlattenTags(output *lakeformation.GetResourceLFTagsOutput) []any {
return flattenLFTagPairs(output.LFTagOnDatabase)
}

type tableTagger struct{}

func (t *tableTagger) ExpandResource(d *schema.ResourceData) *lakeformation.Resource {
v := d.Get("table").([]any)[0].(map[string]any)
return &lakeformation.Resource{
Table: ExpandTableResource(v),
}
}

func (t *tableTagger) FlattenTags(output *lakeformation.GetResourceLFTagsOutput) []any {
return flattenLFTagPairs(output.LFTagsOnTable)
}

type columnTagger struct{}

func (t *columnTagger) ExpandResource(d *schema.ResourceData) *lakeformation.Resource {
v := d.Get("table_with_columns").([]any)[0].(map[string]any)
return &lakeformation.Resource{
TableWithColumns: expandTableColumnsResource(v),
}
}

func (t *columnTagger) FlattenTags(output *lakeformation.GetResourceLFTagsOutput) []any {
if len(output.LFTagsOnColumns) == 0 {
return []any{}
}

tags := output.LFTagsOnColumns[0]
if tags == nil {
return []any{}
}

return nil
return flattenLFTagPairs(tags.LFTags)
}

func lfTagsHash(v interface{}) int {
Expand Down
Loading

0 comments on commit cec3221

Please sign in to comment.