[Fix] Fix issue with case sensitive group names in databricks_group resource
#3597
Conversation
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
- Updated ReadByDisplayName function to ensure exact case-sensitive matching of group display names. - This addresses the issue where groups with similar names but different cases were not correctly distinguished.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3597 +/- ##
=======================================
Coverage 82.34% 82.34%
=======================================
Files 190 190
Lines 19323 19330 +7
=======================================
+ Hits 15911 15918 +7
- Misses 2480 2481 +1
+ Partials 932 931 -1
|
|
@tanmay-db Is there anything else needed to get this approved? Thank you |
|
Hi @Joe-Koch, thanks for the PR. I will take a look and reach back to you. |
alexott
changed the title
databricks_group resourcedatabricks_group resource
alexott
reviewed
Aug 9, 2024
| @@ -59,7 +59,18 @@ func (a GroupsAPI) ReadByDisplayName(displayName, attributes string) (group Grou | |||
| err = fmt.Errorf("cannot find group: %s", displayName) | |||
| return | |||
| } | |||
| group = groupList.Resources[0] | |||
| if len(groupList.Resources) == 1 { | |||
| group = groupList.Resources[0] | |||
There was a problem hiding this comment.
Should we enforce case-sensitive names here as well?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
databricks_groupresource #3596, issue with case sensitive group names in databricks_group resourceChanges
Databricks enforces uniqueness of group names with case sensitivity, so groups like "Admins" and "admins" can exist in the same workspace. When you filter for Databricks groups matching a name with the SCIM API, the name match is not case-sensitive, and it might return multiple groups. The current code just grabs the first group from the results when multiple groups are returned. With this code change, if the length of the returned group list is greater than 1, it loops through the returned groups and searches for a match on DisplayName.
Tests
Added a test in
groups_test.goto check that when there's a lower-case "name" group and an upper-case "Name" group,ReadByDisplayNamewill return the right one.make testrun locallydocs/folderinternal/acceptance