-
Notifications
You must be signed in to change notification settings - Fork 464
/
registry.go
181 lines (154 loc) · 5.8 KB
/
registry.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
// SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Gardener contributors
//
// SPDX-License-Identifier: Apache-2.0
package managedresources
import (
"cmp"
"encoding/json"
"fmt"
"reflect"
"slices"
"strings"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/runtime/serializer"
jsonserializer "k8s.io/apimachinery/pkg/runtime/serializer/json"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/sets"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
forkedyaml "github.com/gardener/gardener/third_party/gopkg.in/yaml.v2"
)
// Registry stores objects and their serialized form. It allows to compute a map of all registered objects that can be
// used as part of a Secret's data which is referenced by a ManagedResource.
type Registry struct {
scheme *runtime.Scheme
codec runtime.Codec
nameToObject map[string]*object
isYAMLSerializer bool
}
type object struct {
obj client.Object
serialization []byte
}
// NewRegistry returns a new registry for resources. The given scheme, codec, and serializer must know all the resource
// types that will later be added to the registry.
func NewRegistry(scheme *runtime.Scheme, codec serializer.CodecFactory, serializer *jsonserializer.Serializer) *Registry {
var groupVersions schema.GroupVersions
for k := range scheme.AllKnownTypes() {
groupVersions = append(groupVersions, k.GroupVersion())
}
// Use set to remove duplicates
groupVersions = sets.New(groupVersions...).UnsortedList()
// Sort groupVersions to ensure groupVersions.Identifier() is stable key
// for the map in https://github.com/kubernetes/apimachinery/blob/v0.26.1/pkg/runtime/serializer/versioning/versioning.go#L94
slices.SortStableFunc(groupVersions, func(a, b schema.GroupVersion) int {
if a.Group == b.Group {
return cmp.Compare(a.Version, b.Version)
}
return cmp.Compare(a.Group, b.Group)
})
// A workaround to incosistent/unstable ordering in yaml.v2 when encoding maps
// Can be removed once k8s.io/apimachinery/pkg/runtime/serializer/json migrates to yaml.v3
// or the issue is resolved upstream in yaml.v2
// Please see https://github.com/go-yaml/yaml/pull/736
serializerIdentifier := struct {
YAML string `json:"yaml"`
}{}
utilruntime.Must(json.Unmarshal([]byte(serializer.Identifier()), &serializerIdentifier))
return &Registry{
scheme: scheme,
codec: codec.CodecForVersions(serializer, serializer, groupVersions, groupVersions),
nameToObject: make(map[string]*object),
isYAMLSerializer: serializerIdentifier.YAML == "true",
}
}
// Add adds the given object to the registry. It computes a filename based on its type, namespace, and name. It serializes
// the object to YAML and stores both representations (object and serialization) in the registry.
func (r *Registry) Add(objs ...client.Object) error {
for _, obj := range objs {
if obj == nil || reflect.ValueOf(obj) == reflect.Zero(reflect.TypeOf(obj)) {
continue
}
objectName, err := r.objectName(obj)
if err != nil {
return err
}
filename := objectName + ".yaml"
if _, ok := r.nameToObject[filename]; ok {
return fmt.Errorf("duplicate filename in registry: %q", filename)
}
serializationYAML, err := runtime.Encode(r.codec, obj)
if err != nil {
return err
}
// We use a copy of the upstream package as a workaround
// to incosistent/unstable ordering in yaml.v2 when encoding maps
// Can be removed once k8s.io/apimachinery/pkg/runtime/serializer/json migrates to yaml.v3
// or the issue is resolved upstream in yaml.v2
// Please see https://github.com/go-yaml/yaml/pull/736
if r.isYAMLSerializer {
var anyObj interface{}
if err := forkedyaml.Unmarshal(serializationYAML, &anyObj); err != nil {
return err
}
serBytes, err := forkedyaml.Marshal(anyObj)
if err != nil {
return err
}
serializationYAML = serBytes
}
r.nameToObject[filename] = &object{
obj: obj,
serialization: serializationYAML,
}
}
return nil
}
// AddSerialized adds the provided serialized YAML for the registry. The provided filename will be used as key.
func (r *Registry) AddSerialized(filename string, serializationYAML []byte) {
r.nameToObject[filename] = &object{serialization: serializationYAML}
}
// SerializedObjects returns a map whose keys are filenames and whose values are serialized objects.
func (r *Registry) SerializedObjects() map[string][]byte {
out := make(map[string][]byte, len(r.nameToObject))
for name, object := range r.nameToObject {
out[name] = object.serialization
}
return out
}
// AddAllAndSerialize calls Add() for all the given objects before calling SerializedObjects().
func (r *Registry) AddAllAndSerialize(objects ...client.Object) (map[string][]byte, error) {
if err := r.Add(objects...); err != nil {
return nil, err
}
return r.SerializedObjects(), nil
}
// RegisteredObjects returns a map whose keys are filenames and whose values are objects.
func (r *Registry) RegisteredObjects() map[string]client.Object {
out := make(map[string]client.Object, len(r.nameToObject))
for name, object := range r.nameToObject {
out[name] = object.obj
}
return out
}
// String returns the string representation of the registry.
func (r *Registry) String() string {
out := make([]string, 0, len(r.nameToObject))
for name, object := range r.nameToObject {
out = append(out, fmt.Sprintf("* %s:\n%s", name, object.serialization))
}
return strings.Join(out, "\n\n")
}
func (r *Registry) objectName(obj client.Object) (string, error) {
gvk, err := apiutil.GVKForObject(obj, r.scheme)
if err != nil {
return "", err
}
return fmt.Sprintf(
"%s__%s__%s",
strings.ToLower(gvk.Kind),
obj.GetNamespace(),
strings.Replace(obj.GetName(), ":", "_", -1),
), nil
}