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

fix(entity_tags): fixed improper error handling in newrelic_entity_tags resource #2710

Merged
merged 4 commits into from
Jul 17, 2024
Merged

fix(entity_tags): fixed improper error handling in newrelic_entity_tags resource #2710

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5cf2e81
fix: fixed improper err handling in newrelic_entity_tags resource
shashank-reddy-nr Jul 8, 2024
3dc5b1b
fix(entity_tags): Changed an error handler func name in entity_tags r…
shashank-reddy-nr Jul 12, 2024
f361485
tests(entity): added test cases to mutate reserved entity_tags
shashank-reddy-nr Jul 17, 2024
1fa45d1
docs: tiny update
pranav-new-relic Jul 17, 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
33 changes: 23 additions & 10 deletions newrelic/resource_newrelic_entity_tags.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,13 @@ func resourceNewRelicEntityTagsCreate(ctx context.Context, d *schema.ResourceDat
guid := common.EntityGUID(d.Get("guid").(string))
tags := expandEntityTags(d.Get("tag").(*schema.Set).List())

_, err := client.Entities.TaggingAddTagsToEntityWithContext(ctx, guid, tags)
res, err := client.Entities.TaggingAddTagsToEntityWithContext(ctx, guid, tags)
if err != nil {
return diag.FromErr(err)
}

if res != nil && len(res.Errors) > 0 {
return handleEntityTagsMutationEmbeddedErrors(res)
}
d.SetId(string(guid))

retryErr := resource.RetryContext(ctx, d.Timeout(schema.TimeoutCreate), func() *resource.RetryError {
Expand Down Expand Up @@ -147,11 +149,13 @@ func resourceNewRelicEntityTagsUpdate(ctx context.Context, d *schema.ResourceDat
log.Printf("[INFO] Updating New Relic entity tags for entity guid %s", d.Id())

tags := expandEntityTags(d.Get("tag").(*schema.Set).List())

_, err := client.Entities.TaggingReplaceTagsOnEntityWithContext(ctx, common.EntityGUID(d.Id()), tags)
res, err := client.Entities.TaggingReplaceTagsOnEntityWithContext(ctx, common.EntityGUID(d.Id()), tags)
if err != nil {
return diag.FromErr(err)
}
if res != nil && len(res.Errors) > 0 {
return handleEntityTagsMutationEmbeddedErrors(res)
}

retryErr := resource.RetryContext(ctx, d.Timeout(schema.TimeoutCreate), func() *resource.RetryError {
t, err := client.Entities.GetTagsForEntityMutable(common.EntityGUID(d.Id()))
Expand All @@ -161,10 +165,6 @@ func resourceNewRelicEntityTagsUpdate(ctx context.Context, d *schema.ResourceDat

currentTags := convertTagTypes(t)

if err != nil {
return resource.NonRetryableError(fmt.Errorf("error retrieving entity tags for guid %s: %s", d.Id(), err))
}

pranav-new-relic marked this conversation as resolved.
Show resolved Hide resolved
for _, t := range tags {
var tag *entities.TaggingTagInput
if tag = getTag(currentTags, t.Key); tag == nil {
Expand Down Expand Up @@ -214,11 +214,13 @@ func resourceNewRelicEntityTagsDelete(ctx context.Context, d *schema.ResourceDat
tags := expandEntityTags(d.Get("tag").(*schema.Set).List())
tagKeys := getTagKeys(tags)

_, err := client.Entities.TaggingDeleteTagFromEntityWithContext(ctx, common.EntityGUID(d.Id()), tagKeys)
res, err := client.Entities.TaggingDeleteTagFromEntityWithContext(ctx, common.EntityGUID(d.Id()), tagKeys)
if err != nil {
return diag.FromErr(err)
}

if res != nil && len(res.Errors) > 0 {
return handleEntityTagsMutationEmbeddedErrors(res)
}
return nil
}

Expand Down Expand Up @@ -303,3 +305,14 @@ func getTag(tags []*entities.TaggingTagInput, key string) *entities.TaggingTagIn

return nil
}

func handleEntityTagsMutationEmbeddedErrors(res *entities.TaggingMutationResult) diag.Diagnostics {
var diags diag.Diagnostics
for _, Error := range res.Errors {
diags = append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: Error.Message + ": " + string(Error.Type),
})
}
return diags
}
54 changes: 26 additions & 28 deletions newrelic/resource_newrelic_entity_tags_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ package newrelic
import (
"context"
"fmt"
"testing"
"time"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
"github.com/newrelic/newrelic-client-go/v2/pkg/common"
"regexp"
"testing"
"time"
)

func TestAccNewRelicEntityTags_Basic(t *testing.T) {
Expand All @@ -24,19 +24,36 @@ func TestAccNewRelicEntityTags_Basic(t *testing.T) {
Steps: []resource.TestStep{
// Test: Create
{
Config: testAccNewRelicEntityTagsConfig(testAccExpectedApplicationName),
Config: testAccNewRelicEntityTagsConfig(testAccExpectedApplicationName, "account", "test-account"),
ExpectError: regexp.MustCompile("reserved"), // Error: Tag Key 'account' is a reserved key
PreConfig: func() {
time.Sleep(10 * time.Second)
},
},
{
Config: testAccNewRelicEntityTagsConfig(testAccExpectedApplicationName, "test_key", "test_value"),
Check: resource.ComposeTestCheckFunc(
testAccCheckNewRelicEntityTagsExist(resourceName, []string{"test_key"}),
testAccCheckNewRelicEntityUnmutableExists(resourceName, []string{"account", "guid", "language"}),
),
PreConfig: func() {
time.Sleep(10 * time.Second)
},
},
// Test: Update
{
Config: testAccNewRelicEntityTagsConfigUpdated(testAccExpectedApplicationName),
Config: testAccNewRelicEntityTagsConfig(testAccExpectedApplicationName, "test_key_2", "test_value_2"),
Check: resource.ComposeTestCheckFunc(
testAccCheckNewRelicEntityTagsExist(resourceName, []string{"test_key_2"}),
testAccCheckNewRelicEntityUnmutableExists(resourceName, []string{"account", "guid", "language"}),
),
PreConfig: func() {
time.Sleep(10 * time.Second)
},
},
{
Config: testAccNewRelicEntityTagsConfig(testAccExpectedApplicationName, "account", "test-account-2"),
ExpectError: regexp.MustCompile("reserved"), // Error: Tag Key 'account' is a reserved key
},
// Test: Import
//{
Expand Down Expand Up @@ -140,26 +157,7 @@ func testAccCheckNewRelicEntityUnmutableExists(n string, keysToCheck []string) r
}
}

func testAccNewRelicEntityTagsConfig(appName string) string {
return fmt.Sprintf(`
data "newrelic_entity" "foo" {
name = "%s"
type = "APPLICATION"
domain = "APM"
}

resource "newrelic_entity_tags" "foo" {
guid = data.newrelic_entity.foo.guid

tag {
key = "test_key"
values = ["test_value"]
}
}
`, appName)
}

func testAccNewRelicEntityTagsConfigUpdated(appName string) string {
func testAccNewRelicEntityTagsConfig(appName string, tagKey string, tagValue string) string {
return fmt.Sprintf(`
data "newrelic_entity" "foo" {
name = "%s"
Expand All @@ -171,9 +169,9 @@ resource "newrelic_entity_tags" "foo" {
guid = data.newrelic_entity.foo.guid

tag {
key = "test_key_2"
values = ["test_value_2"]
key = "%s"
values = ["%s"]
}
}
`, appName)
`, appName, tagKey, tagValue)
}
2 changes: 1 addition & 1 deletion website/docs/r/entity_tags.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ The following arguments are supported:

All nested `tag` blocks support the following common arguments:

* `key` - (Required) The tag key.
* `key` - (Required) The tag key should not use reserved keys (also known as immutable keys), such as account or accountId. It's recommended to choose a unique and descriptive key that does not conflict with existing reserved keys.
* `values` - (Required) The tag values.
pranav-new-relic marked this conversation as resolved.
Show resolved Hide resolved

## Import
Expand Down
Loading