-
Notifications
You must be signed in to change notification settings - Fork 216
Extend --name-pattern: Support per-resource placeholders
#664
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.
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
Merged
+351
−38
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| package meta | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
| "unicode" | ||
|
|
||
| "github.com/Azure/aztfexport/internal/resourceset" | ||
| "github.com/magodo/armid" | ||
| ) | ||
|
|
||
| const ( | ||
| phType = "{type}" // last Azure resource type segment, e.g. "virtual_machines" | ||
| phRP = "{rp}" // Azure resource provider namespace, e.g. "microsoft_compute" | ||
| phName = "{name}" // last name segment of the Azure resource id | ||
| phRootScope = "{root_scope}" // last name of the root scope (e.g. resource group name) | ||
| ) | ||
|
|
||
| // nameExpander turns a resource name pattern (with placeholders and `*`) into | ||
| // concrete resource names. It is stateful: it tracks per-prefix counts so the | ||
| // indices produced via `*` are unique per expanded prefix/suffix pair. | ||
| type nameExpander struct { | ||
| pattern string | ||
| counts map[string]int | ||
| } | ||
|
|
||
| func newNameExpander(pattern string) *nameExpander { | ||
| return &nameExpander{pattern: pattern, counts: map[string]int{}} | ||
| } | ||
|
|
||
| // Expand returns the resource name produced by applying the pattern to the | ||
| // given TF resource. | ||
| func (e *nameExpander) Expand(res resourceset.TFResource) string { | ||
| expanded := expandPlaceholders(e.pattern, res) | ||
|
|
||
| var name string | ||
| if pos := strings.LastIndex(expanded, "*"); pos != -1 { | ||
| prefix, suffix := expanded[:pos], expanded[pos+1:] | ||
| key := prefix + "\x00" + suffix | ||
| idx := e.counts[key] | ||
| e.counts[key] = idx + 1 | ||
| name = fmt.Sprintf("%s%d%s", prefix, idx, suffix) | ||
| } else { | ||
| idx := e.counts[expanded] | ||
| e.counts[expanded] = idx + 1 | ||
| name = fmt.Sprintf("%s%d", expanded, idx) | ||
| } | ||
| return ensureValidTFName(name) | ||
| } | ||
|
|
||
| func expandPlaceholders(pattern string, res resourceset.TFResource) string { | ||
| id := res.AzureId | ||
|
|
||
| out := pattern | ||
| if strings.Contains(out, phType) { | ||
| out = strings.ReplaceAll(out, phType, snakeCase(lastSegment(id.Types()))) | ||
| } | ||
| if strings.Contains(out, phRP) { | ||
| out = strings.ReplaceAll(out, phRP, snakeCase(id.Provider())) | ||
| } | ||
| if strings.Contains(out, phName) { | ||
| out = strings.ReplaceAll(out, phName, snakeCase(lastSegment(id.Names()))) | ||
| } | ||
| if strings.Contains(out, phRootScope) { | ||
| out = strings.ReplaceAll(out, phRootScope, snakeCase(rootScopeName(id))) | ||
| } | ||
| return out | ||
| } | ||
|
|
||
| func lastSegment(segs []string) string { | ||
| if len(segs) == 0 { | ||
| return "" | ||
| } | ||
| return segs[len(segs)-1] | ||
| } | ||
|
|
||
| // rootScopeName returns a short, identifier-friendly representation of the | ||
| // root scope of the resource id (e.g. the resource group name, the | ||
| // subscription id, or the management group name). | ||
| func rootScopeName(id armid.ResourceId) string { | ||
| if id == nil { | ||
| return "" | ||
| } | ||
| root := id.RootScope() | ||
| if root == nil { | ||
| return "" | ||
| } | ||
| names := root.Names() | ||
| if len(names) == 0 { | ||
| return "" | ||
| } | ||
| return names[len(names)-1] | ||
| } | ||
|
|
||
| // snakeCase converts a string (potentially CamelCase / dotted / mixed) to a | ||
| // lowercase, underscore-separated identifier. Non-alphanumeric characters | ||
| // become underscores; runs of underscores are collapsed; leading/trailing | ||
| // underscores are trimmed. | ||
| func snakeCase(s string) string { | ||
| if s == "" { | ||
| return "" | ||
| } | ||
| var b strings.Builder | ||
| b.Grow(len(s) + 4) | ||
| runes := []rune(s) | ||
| for i, r := range runes { | ||
| switch { | ||
| case unicode.IsUpper(r): | ||
| // Insert `_` before an uppercase letter when: | ||
| // - it follows a lowercase / digit, or | ||
| // - it is followed by a lowercase letter and preceded by another uppercase | ||
| // (so that "HTTPServer" -> "http_server") | ||
| if i > 0 { | ||
| prev := runes[i-1] | ||
| switch { | ||
| case unicode.IsLower(prev) || unicode.IsDigit(prev): | ||
| b.WriteByte('_') | ||
| case unicode.IsUpper(prev) && i+1 < len(runes) && unicode.IsLower(runes[i+1]): | ||
| b.WriteByte('_') | ||
| } | ||
| } | ||
| b.WriteRune(unicode.ToLower(r)) | ||
| case unicode.IsLower(r) || unicode.IsDigit(r): | ||
| b.WriteRune(r) | ||
| default: | ||
| b.WriteByte('_') | ||
| } | ||
| } | ||
| // Collapse runs of underscores and trim. | ||
| out := b.String() | ||
| for strings.Contains(out, "__") { | ||
| out = strings.ReplaceAll(out, "__", "_") | ||
| } | ||
| return strings.Trim(out, "_") | ||
| } | ||
|
|
||
| // ensureValidTFName makes sure the final name is a valid Terraform identifier. | ||
| // Terraform identifiers must start with a letter or underscore and may then | ||
| // contain letters, digits, underscores and dashes. We restrict ourselves to | ||
| // the conservative subset [A-Za-z0-9_]. | ||
| func ensureValidTFName(s string) string { | ||
| if s == "" { | ||
| return "res" | ||
| } | ||
| var b strings.Builder | ||
| for _, r := range s { | ||
| switch { | ||
| case r >= 'a' && r <= 'z', | ||
| r >= 'A' && r <= 'Z', | ||
| r >= '0' && r <= '9', | ||
| r == '_', r == '-': | ||
| b.WriteRune(r) | ||
| default: | ||
| b.WriteByte('_') | ||
| } | ||
| } | ||
| out := b.String() | ||
| if out == "" { | ||
| return "res" | ||
| } | ||
| if c := out[0]; c >= '0' && c <= '9' { | ||
| out = "_" + out | ||
| } | ||
| return out | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.