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

suppress dataplex labels #6518

Merged
merged 6 commits into from
Sep 30, 2022
Merged

suppress dataplex labels #6518

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6d4333a
suppress dataplex labels
prauc Sep 7, 2022
9ad55e9
add test label suppress tests
prauc Sep 12, 2022
5916bbe
fix test
prauc Sep 28, 2022
bfda4b0
fix test
prauc Sep 28, 2022
29b3dbc
remove unnecessary package from import
prauc Sep 28, 2022
d91dc32
adjust testcases
prauc Sep 29, 2022
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
18 changes: 18 additions & 0 deletions mmv1/third_party/terraform/resources/resource_storage_bucket.go.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ func resourceStorageBucket() *schema.Resource {
"labels": {
Type: schema.TypeMap,
Optional: true,
// GCP (Dataplex) automatically adds labels
DiffSuppressFunc: resourceDataplexLabelDiffSuppress,
Elem: &schema.Schema{Type: schema.TypeString},
Description: `A set of key/value label pairs to assign to the bucket.`,
},
Expand Down Expand Up @@ -376,6 +378,22 @@ func resourceStorageBucket() *schema.Resource {
}
}

const resourceDataplexGoogleProvidedLabelPrefix = "labels.goog-dataplex"

func resourceDataplexLabelDiffSuppress(k, old, new string, d *schema.ResourceData) bool {
Copy link
Member

@shuyama1 shuyama1 Sep 9, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The diff suppress function looks good! But are we able to add a unit test on this? It could be something like https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/terraform/tests/resource_cloud_run_domain_mapping_test.go#L9

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, @shuyama1! :)
I've added some tests.

Here is the output of my added test:

=== RUN   TestLabelDiffSuppress
--- PASS: TestLabelDiffSuppress (0.00s)

Let me know if I need to change anything else (naming, .. etc.)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the test!

if strings.HasPrefix(k, resourceDataplexGoogleProvidedLabelPrefix) && new == "" {
return true
}

// Let diff be determined by labels (above)
if strings.HasPrefix(k, "labels.%") {
return true
}

// For other keys, don't suppress diff.
return false
}

// Is the old bucket retention policy locked?
func isPolicyLocked(_ context.Context, old, new, _ interface{}) bool {
if old == nil || new == nil {
Expand Down