@@ -5,32 +5,58 @@ import (
55 "log"
66 "os"
77 "path/filepath"
8+ "reflect"
9+ "strconv"
810 "strings"
911)
1012
13+ type ResourceIDFieldType string
14+
1115var (
12- defaultSeparator = ":"
13- allIDs = []* ResourceID {}
16+ defaultSeparator = ":"
17+ ResourceIDFieldTypeInt = ResourceIDFieldType ("int" )
18+ ResourceIDFieldTypeString = ResourceIDFieldType ("string" )
19+ allIDs = []* ResourceID {}
1420)
1521
22+ type ResourceIDField struct {
23+ Name string
24+ Type ResourceIDFieldType
25+ // Optional bool // Unimplemented. Will be used for org ID
26+ }
27+
28+ func StringIDField (name string ) ResourceIDField {
29+ return ResourceIDField {
30+ Name : name ,
31+ Type : ResourceIDFieldTypeString ,
32+ }
33+ }
34+
35+ func IntIDField (name string ) ResourceIDField {
36+ return ResourceIDField {
37+ Name : name ,
38+ Type : ResourceIDFieldTypeInt ,
39+ }
40+ }
41+
1642type ResourceID struct {
1743 resourceName string
1844 separators []string
19- expectedFields []string
45+ expectedFields []ResourceIDField
2046}
2147
22- func NewResourceID (resourceName string , expectedFields ... string ) * ResourceID {
48+ func NewResourceID (resourceName string , expectedFields ... ResourceIDField ) * ResourceID {
2349 return newResourceIDWithSeparators (resourceName , []string {defaultSeparator }, expectedFields ... )
2450}
2551
2652// Deprecated: Use NewResourceID instead
2753// We should standardize on a single separator, so that function should only be used for old resources
2854// On major versions, switch to NewResourceID and remove uses of this function
29- func NewResourceIDWithLegacySeparator (resourceName , legacySeparator string , expectedFields ... string ) * ResourceID {
55+ func NewResourceIDWithLegacySeparator (resourceName , legacySeparator string , expectedFields ... ResourceIDField ) * ResourceID {
3056 return newResourceIDWithSeparators (resourceName , []string {defaultSeparator , legacySeparator }, expectedFields ... )
3157}
3258
33- func newResourceIDWithSeparators (resourceName string , separators []string , expectedFields ... string ) * ResourceID {
59+ func newResourceIDWithSeparators (resourceName string , separators []string , expectedFields ... ResourceIDField ) * ResourceID {
3460 tfID := & ResourceID {
3561 resourceName : resourceName ,
3662 separators : separators ,
@@ -43,31 +69,83 @@ func newResourceIDWithSeparators(resourceName string, separators []string, expec
4369func (id * ResourceID ) Example () string {
4470 fields := make ([]string , len (id .expectedFields ))
4571 for i := range fields {
46- fields [i ] = fmt .Sprintf ("{{ %s }}" , id .expectedFields [i ])
72+ fields [i ] = fmt .Sprintf ("{{ %s }}" , id .expectedFields [i ]. Name )
4773 }
4874 return fmt .Sprintf (`terraform import %s.name %q
4975` , id .resourceName , strings .Join (fields , defaultSeparator ))
5076}
5177
78+ // Make creates a resource ID from the given parts
79+ // The parts must have the correct number of fields and types
5280func (id * ResourceID ) Make (parts ... any ) string {
5381 if len (parts ) != len (id .expectedFields ) {
5482 panic (fmt .Sprintf ("expected %d fields, got %d" , len (id .expectedFields ), len (parts ))) // This is a coding error, so panic is appropriate
5583 }
5684 stringParts := make ([]string , len (parts ))
5785 for i , part := range parts {
58- stringParts [i ] = fmt .Sprintf ("%v" , part )
86+ // Unwrap pointers
87+ if reflect .ValueOf (part ).Kind () == reflect .Ptr {
88+ part = reflect .ValueOf (part ).Elem ().Interface ()
89+ }
90+ expectedField := id .expectedFields [i ]
91+ switch expectedField .Type {
92+ case ResourceIDFieldTypeInt :
93+ asInt , ok := part .(int64 )
94+ if ! ok {
95+ panic (fmt .Sprintf ("expected int64 for field %q, got %T" , expectedField .Name , part )) // This is a coding error, so panic is appropriate
96+ }
97+ stringParts [i ] = strconv .FormatInt (asInt , 10 )
98+ case ResourceIDFieldTypeString :
99+ asString , ok := part .(string )
100+ if ! ok {
101+ panic (fmt .Sprintf ("expected string for field %q, got %T" , expectedField .Name , part )) // This is a coding error, so panic is appropriate
102+ }
103+ stringParts [i ] = asString
104+ }
59105 }
106+
60107 return strings .Join (stringParts , defaultSeparator )
61108}
62109
63- func (id * ResourceID ) Split (resourceID string ) ([]string , error ) {
110+ // Single parses a resource ID into a single value
111+ func (id * ResourceID ) Single (resourceID string ) (any , error ) {
112+ parts , err := id .Split (resourceID )
113+ if err != nil {
114+ return nil , err
115+ }
116+ return parts [0 ], nil
117+ }
118+
119+ // Split parses a resource ID into its parts
120+ // The parts will be cast to the expected types
121+ func (id * ResourceID ) Split (resourceID string ) ([]any , error ) {
64122 for _ , sep := range id .separators {
65123 parts := strings .Split (resourceID , sep )
66124 if len (parts ) == len (id .expectedFields ) {
67- return parts , nil
125+ partsAsAny := make ([]any , len (parts ))
126+ for i , part := range parts {
127+ expectedField := id .expectedFields [i ]
128+ switch expectedField .Type {
129+ case ResourceIDFieldTypeInt :
130+ asInt , err := strconv .ParseInt (part , 10 , 64 )
131+ if err != nil {
132+ return nil , fmt .Errorf ("expected int for field %q, got %q" , expectedField .Name , part )
133+ }
134+ partsAsAny [i ] = asInt
135+ case ResourceIDFieldTypeString :
136+ partsAsAny [i ] = part
137+ }
138+ }
139+
140+ return partsAsAny , nil
68141 }
69142 }
70- return nil , fmt .Errorf ("id %q does not match expected format. Should be in the format: %s" , resourceID , strings .Join (id .expectedFields , defaultSeparator ))
143+
144+ expectedFieldNames := make ([]string , len (id .expectedFields ))
145+ for i , f := range id .expectedFields {
146+ expectedFieldNames [i ] = f .Name
147+ }
148+ return nil , fmt .Errorf ("id %q does not match expected format. Should be in the format: %s" , resourceID , strings .Join (expectedFieldNames , defaultSeparator ))
71149}
72150
73151// GenerateImportFiles generates import files for all resources that use a helper defined in this package
0 commit comments