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 parsing nested path ids #3375

Merged
merged 4 commits into from
Jun 24, 2024
Merged

Fix parsing nested path ids #3375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d6ce7e6
Add new failing test case
danielrbradley Jun 21, 2024
5a3915c
Fix parsing ids with odd path parts
danielrbradley Jun 21, 2024
e1553f3
Fail on conflicting regex names
danielrbradley Jun 24, 2024
674dc7c
Merge branch 'master' into fix-parsing-nested-id
danielrbradley Jun 24, 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
17 changes: 13 additions & 4 deletions provider/pkg/resources/parseResourceId.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,18 @@ import (
func ParseResourceID(id, path string) (map[string]string, error) {
pathParts := strings.Split(path, "/")
regexParts := make([]string, len(pathParts))
// Track the names of the regex matches so we can map them back to the original names.
regexNames := make(map[string]string, len(pathParts))
regexMatchGroupNameReplacer := regexp.MustCompile(`[^a-zA-Z0-9]`)
for i, s := range pathParts {
if strings.HasPrefix(s, "{") && strings.HasSuffix(s, "}") {
name := s[1 : len(s)-1]
regexParts[i] = fmt.Sprintf("(?P<%s>.*?)", name)
regexName := regexMatchGroupNameReplacer.ReplaceAllString(name, "")
if clashingPathName, ok := regexNames[regexName]; ok {
return nil, errors.Errorf("clashing path names: '%s' and '%s' while parsing resource ID for path '%s", clashingPathName, name, path)
}
regexNames[regexName] = name
danielrbradley marked this conversation as resolved.
Show resolved Hide resolved
regexParts[i] = fmt.Sprintf("(?P<%s>.*?)", regexName)
} else {
regexParts[i] = pathParts[i]
}
Expand All @@ -35,9 +43,10 @@ func ParseResourceID(id, path string) (map[string]string, error) {
}

result := map[string]string{}
for i, name := range pattern.SubexpNames() {
if i > 0 && name != "" {
result[name] = match[i]
for i, regexpGroupName := range pattern.SubexpNames() {
if i > 0 && regexpGroupName != "" {
originalName := regexNames[regexpGroupName]
result[originalName] = match[i]
}
}
return result, nil
Expand Down
90 changes: 53 additions & 37 deletions provider/pkg/resources/parseResourceId_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,43 +11,59 @@ type resourceIDCase struct {
path string
}

func TestParseInvalidResourceID(t *testing.T) {
cases := []resourceIDCase{
// ID shorter than Path
{"/resourceGroup/myrg", "/resourceGroup/{resourceGroup}/subResource"},
// ID longer than Path
{"/resourceGroup/myrg/cdn/mycdn", "/resourceGroup/{resourceGroup}/cdn"},
// Segment names don't match
{"/resourceGroup/myrg/foo/mycdn", "/resourceGroup/{resourceGroup}/bar/{cdn}"},
}
for _, testCase := range cases {
_, err := ParseResourceID(testCase.id, testCase.path)
assert.Error(t, err)
}
}
func TestParseResourceID(t *testing.T) {
t.Run("invalid", func(t *testing.T) {
cases := []resourceIDCase{
// ID shorter than Path
{"/resourceGroup/myrg", "/resourceGroup/{resourceGroup}/subResource"},
// ID longer than Path
{"/resourceGroup/myrg/cdn/mycdn", "/resourceGroup/{resourceGroup}/cdn"},
// Segment names don't match
{"/resourceGroup/myrg/foo/mycdn", "/resourceGroup/{resourceGroup}/bar/{cdn}"},
}
for _, testCase := range cases {
_, err := ParseResourceID(testCase.id, testCase.path)
assert.Error(t, err)
}
})

func TestParseFullResourceID(t *testing.T) {
id := "/subscriptions/0282681f-7a9e-123b-40b2-96babd57a8a1/resourcegroups/pulumi-name/providers/Microsoft.Network/networkInterfaces/pulumi-nic/ipConfigurations/ipconfig1"
path := "/subscriptions/{subscriptionID}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}"
actual, err := ParseResourceID(id, path)
assert.NoError(t, err)
expected := map[string]string{
"subscriptionID": "0282681f-7a9e-123b-40b2-96babd57a8a1",
"resourceGroupName": "pulumi-name",
"networkInterfaceName": "pulumi-nic",
"ipConfigurationName": "ipconfig1",
}
assert.Equal(t, expected, actual)
}
t.Run("full", func(t *testing.T) {
id := "/subscriptions/0282681f-7a9e-123b-40b2-96babd57a8a1/resourcegroups/pulumi-name/providers/Microsoft.Network/networkInterfaces/pulumi-nic/ipConfigurations/ipconfig1"
path := "/subscriptions/{subscriptionID}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}"
actual, err := ParseResourceID(id, path)
assert.NoError(t, err)
expected := map[string]string{
"subscriptionID": "0282681f-7a9e-123b-40b2-96babd57a8a1",
"resourceGroupName": "pulumi-name",
"networkInterfaceName": "pulumi-nic",
"ipConfigurationName": "ipconfig1",
}
assert.Equal(t, expected, actual)
})

t.Run("scoped", func(t *testing.T) {
id := "/subscriptions/1200b1c8-3c58-42db-b33a-304a75913333/resourceGroups/devops-dev/providers/Microsoft.Authorization/roleAssignments/2a88abc7-f599-0eba-a21f-a1817e597115"
path := "/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}"
actual, err := ParseResourceID(id, path)
assert.NoError(t, err)
expected := map[string]string{
"scope": "subscriptions/1200b1c8-3c58-42db-b33a-304a75913333/resourceGroups/devops-dev",
"roleAssignmentName": "2a88abc7-f599-0eba-a21f-a1817e597115",
}
assert.Equal(t, expected, actual)
})

func TestParseScopedResourceID(t *testing.T) {
id := "/subscriptions/1200b1c8-3c58-42db-b33a-304a75913333/resourceGroups/devops-dev/providers/Microsoft.Authorization/roleAssignments/2a88abc7-f599-0eba-a21f-a1817e597115"
path := "/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}"
actual, err := ParseResourceID(id, path)
assert.NoError(t, err)
expected := map[string]string{
"scope": "subscriptions/1200b1c8-3c58-42db-b33a-304a75913333/resourceGroups/devops-dev",
"roleAssignmentName": "2a88abc7-f599-0eba-a21f-a1817e597115",
}
assert.Equal(t, expected, actual)
t.Run("nested identifier", func(t *testing.T) {
id := "/subscriptions/1200b1c8-3c58-42db-b33a-304a75913333/resourceGroups/resource-group/providers/Microsoft.KeyVault/vaults/vault-name/accessPolicy/policy-object-id"
path := "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/accessPolicy/{policy.objectId}"
actual, err := ParseResourceID(id, path)
assert.NoError(t, err)
expected := map[string]string{
"subscriptionId": "1200b1c8-3c58-42db-b33a-304a75913333",
"resourceGroupName": "resource-group",
"vaultName": "vault-name",
"policy.objectId": "policy-object-id",
}
assert.Equal(t, expected, actual)
})
}
Loading