/
references.go
322 lines (290 loc) · 10.9 KB
/
references.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package krmtotf
import (
"fmt"
"strings"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/apis/core/v1alpha1"
corekccv1alpha1 "github.com/GoogleCloudPlatform/k8s-config-connector/pkg/apis/core/v1alpha1"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/k8s"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/servicemapping/servicemappingloader"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/text"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/util"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"sigs.k8s.io/controller-runtime/pkg/client"
)
func GetReferencedResource(r *Resource, typeConfig corekccv1alpha1.TypeConfig,
resourceRef *v1alpha1.ResourceReference, kubeClient client.Client, smLoader *servicemappingloader.ServiceMappingLoader) (rsrc *Resource, err error) {
if resourceRef.External != "" {
return nil, fmt.Errorf("reference is external: %v", resourceRef.External)
}
u, err := k8s.GetReferencedResourceAsUnstruct(resourceRef, typeConfig.GVK, r.GetNamespace(), kubeClient)
if err != nil {
return nil, err
}
rsrc = &Resource{}
if err := util.Marshal(u, rsrc); err != nil {
return nil, fmt.Errorf("error parsing %v", u.GetName())
}
if typeConfig.DCLBasedResource {
return rsrc, nil
}
rc, err := smLoader.GetResourceConfig(u)
if err != nil {
return nil, fmt.Errorf("error getting ResourceConfig for referenced resource %v: %w", r.GetName(), err)
}
rsrc.ResourceConfig = *rc
return rsrc, nil
}
func handleResourceReference(config map[string]interface{}, refConfig v1alpha1.ReferenceConfig, r *Resource, c client.Client, smLoader *servicemappingloader.ServiceMappingLoader) error {
path := strings.Split(refConfig.TFField, ".")
return ResolveResourceReference(path, config, refConfig, r, c, smLoader)
}
func ResolveResourceReference(path []string, obj interface{}, refConfig v1alpha1.ReferenceConfig,
r *Resource, kubeClient client.Client, smLoader *servicemappingloader.ServiceMappingLoader) error {
if obj == nil {
return nil
}
// If the object is a list, resolve the reference for each list item
var config map[string]interface{}
switch objAsType := obj.(type) {
case []interface{}:
for _, item := range objAsType {
if err := ResolveResourceReference(path, item, refConfig, r, kubeClient, smLoader); err != nil {
return err
}
}
return nil
case map[string]interface{}:
config = objAsType
default:
return fmt.Errorf("error resolving reference: cannot iterate through type that is not object or list of objects")
}
field := text.SnakeCaseToLowerCamelCase(path[0])
// Iterate down the chain of fields
if len(path) > 1 {
return ResolveResourceReference(path[1:], config[field], refConfig, r, kubeClient, smLoader)
}
// Base case. We have found the object that holds the field that is the reference. Resolve its value.
key := field
if refConfig.Key != "" {
key = refConfig.Key
}
ref := config[key]
if ref == nil {
return nil
}
var resolvedVal interface{}
switch refAsType := ref.(type) {
case map[string]interface{}:
var err error
resolvedVal, err = ResolveReferenceObject(refAsType, refConfig, r, kubeClient, smLoader)
if err != nil {
return err
}
case []interface{}:
resolvedList := make([]interface{}, 0)
for _, item := range refAsType {
itemAsMap, ok := item.(map[string]interface{})
if !ok {
return fmt.Errorf("expected reference %v to be object but was not", key)
}
resolvedVal, err := ResolveReferenceObject(itemAsMap, refConfig, r, kubeClient, smLoader)
if err != nil {
return err
}
resolvedList = append(resolvedList, resolvedVal)
}
resolvedVal = resolvedList
default:
return fmt.Errorf("unexpected type for reference field %v", path[0])
}
config[field] = resolvedVal
if field != key {
delete(config, key)
}
return nil
}
func ResolveReferenceObject(resourceRefValRaw map[string]interface{},
refConfig corekccv1alpha1.ReferenceConfig, r *Resource, kubeClient client.Client, smLoader *servicemappingloader.ServiceMappingLoader) (interface{}, error) {
typeConfig := refConfig.TypeConfig
if len(refConfig.Types) > 0 {
var (
nestedRefValRaw interface{}
err error
ok bool
found bool
)
for _, typeConfig = range refConfig.Types {
nestedRefValRaw, found, err = unstructured.NestedFieldNoCopy(resourceRefValRaw, typeConfig.Key)
if err != nil {
return nil, err
}
if found {
if typeConfig.JSONSchemaType != "" {
// This is not actually a reference, but an explicit value that should be used.
return resolveValueTemplateFromInterface(typeConfig.ValueTemplate, nestedRefValRaw, r, kubeClient, smLoader)
}
resourceRefValRaw, ok = nestedRefValRaw.(map[string]interface{})
if !ok {
return nil, fmt.Errorf("expected reference to be object")
}
break
}
}
if !found {
return nil, nil
}
}
resourceRef := &v1alpha1.ResourceReference{}
if err := util.Marshal(resourceRefValRaw, resourceRef); err != nil {
return nil, fmt.Errorf("field %v is a wrong format", typeConfig.Key)
}
// Resource references usually point to K8s resources except when the
// resource reference is an external resource reference. In the case of an
// external resource reference, the 'external' field is used to specify a
// string identifier for the referenced resource.
if resourceRef.External != "" {
return resourceRef.External, nil
}
// Deletions do some limited config expansion in order to preset immutable fields before the read
// from the underlying API. Do a best-effort setting of these fields, as any unresolvable references
// (due to, say, the reference having been deleted before) will be learned as a result of the read.
deleting := k8s.IsDeleted(&r.ObjectMeta)
refResource, err := GetReferencedResource(r, typeConfig, resourceRef, kubeClient, smLoader)
if err != nil {
if k8s.IsReferenceNotFoundError(err) {
if deleting {
return nil, nil
}
return nil, err
}
return nil, fmt.Errorf("error getting referenced resource from API server: %w", err)
}
if !deleting && !k8s.IsResourceReady(&refResource.Resource) {
return nil, k8s.NewReferenceNotReadyErrorForResource(&refResource.Resource)
}
resolvedVal, err := resolveTargetFieldValue(refResource, typeConfig)
if err != nil {
return nil, fmt.Errorf("error resolving value of target field of "+
"referenced resource %v %v: %v", refResource.GroupVersionKind(),
refResource.GetNamespacedName(), err)
}
if deleting && typeConfig.TargetField == "" && typeConfig.ValueTemplate == "" {
return resolvedVal, nil
}
return resolveValueTemplateFromInterface(typeConfig.ValueTemplate, resolvedVal, refResource, kubeClient, smLoader)
}
func resolveTargetFieldValue(r *Resource, tc corekccv1alpha1.TypeConfig) (interface{}, error) {
key := text.SnakeCaseToLowerCamelCase(tc.TargetField)
switch key {
case "":
return resolveDefaultTargetFieldValue(r, tc)
default:
if val, exists, _ := unstructured.NestedString(r.Spec, strings.Split(key, ".")...); exists {
return val, nil
}
if val, exists, _ := unstructured.NestedString(r.GetStatusOrObservedState(), strings.Split(key, ".")...); exists {
return val, nil
}
// For now, we do not support recursive target field resolution (i.e. targeting a field in
// the referenced resource that itself is a reference to a third resource, which would require
// its own target field resolution).
return nil, fmt.Errorf("referenced resource's target field %v is unsupported", tc.TargetField)
}
}
func resolveDefaultTargetFieldValue(r *Resource, tc corekccv1alpha1.TypeConfig) (interface{}, error) {
if !tc.DCLBasedResource && !SupportsResourceIDField(&r.ResourceConfig) {
return r.GetName(), nil
}
id, err := r.GetResourceID()
if err != nil {
return "", err
}
return id, nil
}
func IsReferenceField(qualifiedName string, rc *corekccv1alpha1.ResourceConfig) (bool, *corekccv1alpha1.ReferenceConfig) {
for _, refConfig := range rc.ResourceReferences {
if qualifiedName == refConfig.TFField {
return true, &refConfig
}
}
return false, nil
}
func containsReferenceField(qualifiedName string, rc *corekccv1alpha1.ResourceConfig) bool {
for _, refConfig := range rc.ResourceReferences {
if strings.HasPrefix(refConfig.TFField, qualifiedName) {
return true
}
}
return false
}
func GetKeyForReferenceField(refConfig *corekccv1alpha1.ReferenceConfig) string {
if refConfig.Key != "" {
return refConfig.Key
}
parts := strings.Split(refConfig.TFField, ".")
containerField := text.SnakeCaseToLowerCamelCase(parts[len(parts)-1])
return containerField
}
func getPathToReferenceKey(refConfig *corekccv1alpha1.ReferenceConfig) []string {
fieldCamelCase := text.SnakeCaseToLowerCamelCase(refConfig.TFField)
path := strings.Split(fieldCamelCase, ".")
if refConfig.Key != "" {
path[len(path)-1] = refConfig.Key
}
return path
}
func IsHierarchicalReference(ref corekccv1alpha1.ReferenceConfig, hierarchicalRefs []corekccv1alpha1.HierarchicalReference) bool {
// Hierarchical references can only be at the root level, but this
// reference is not a root-level field.
if strings.Contains(ref.TFField, ".") {
return false
}
key := GetKeyForReferenceField(&ref)
for _, h := range hierarchicalRefs {
if h.Key == key {
return true
}
}
return false
}
func IsRequiredParentReference(ref corekccv1alpha1.ReferenceConfig, resource *Resource) bool {
if ref.Parent {
return true
}
if !IsHierarchicalReference(ref, resource.ResourceConfig.HierarchicalReferences) {
return false
}
// For projects and folders, we shouldn't treat their hierarchical references as parent references
// because their URLs only contain their own project_id or folder_id, i.e. folders/{folder_id} and projects/{project_id}
if resource.Kind == "Project" || resource.Kind == "Folder" {
return false
}
return true
}
func GetReferenceConfigForHierarchicalReference(hierarchicalRef corekccv1alpha1.HierarchicalReference, rc *corekccv1alpha1.ResourceConfig) (*corekccv1alpha1.ReferenceConfig, error) {
for _, ref := range rc.ResourceReferences {
// Hierarchical references can only be at the root level, but this
// reference is not a root-level field.
if strings.Contains(ref.TFField, ".") {
continue
}
key := GetKeyForReferenceField(&ref)
if key == hierarchicalRef.Key {
return &ref, nil
}
}
return nil, fmt.Errorf("no reference config found for hierarchical reference field %v", hierarchicalRef.Key)
}