/
gen.go
300 lines (250 loc) · 8.84 KB
/
gen.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
/*
Copyright 2019 The Kubernetes Authors.
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 deepcopy
import (
"bytes"
"fmt"
"go/ast"
"go/format"
"io"
"sort"
"strings"
"sigs.k8s.io/controller-tools/pkg/genall"
"sigs.k8s.io/controller-tools/pkg/loader"
"sigs.k8s.io/controller-tools/pkg/markers"
)
// NB(directxman12): markers.LoadRoots ignores autogenerated code via a build tag
// so any time we check for existing deepcopy functions, we only seen manually written ones.
const (
runtimeObjPath = "k8s.io/apimachinery/pkg/runtime.Object"
)
var (
enablePkgMarker = markers.Must(markers.MakeDefinition("kubebuilder:object:generate", markers.DescribesPackage, false))
enableTypeMarker = markers.Must(markers.MakeDefinition("kubebuilder:object:generate", markers.DescribesType, false))
isObjectMarker = markers.Must(markers.MakeDefinition("kubebuilder:object:root", markers.DescribesType, false))
legacyEnablePkgMarker = markers.Must(markers.MakeDefinition("k8s:deepcopy-gen", markers.DescribesPackage, markers.RawArguments(nil)))
legacyEnableTypeMarker = markers.Must(markers.MakeDefinition("k8s:deepcopy-gen", markers.DescribesType, markers.RawArguments(nil)))
legacyIsObjectMarker = markers.Must(markers.MakeDefinition("k8s:deepcopy-gen:interfaces", markers.DescribesType, ""))
)
// +controllertools:marker:generateHelp
// Generator generates code containing DeepCopy, DeepCopyInto, and
// DeepCopyObject method implementations.
type Generator struct {
// HeaderFile specifies the header text (e.g. license) to prepend to generated files.
HeaderFile string `marker:",optional"`
// Year specifies the year to substitute for " YEAR" in the header file.
Year string `marker:",optional"`
}
func (Generator) RegisterMarkers(into *markers.Registry) error {
if err := markers.RegisterAll(into,
enablePkgMarker, legacyEnablePkgMarker, enableTypeMarker,
legacyEnableTypeMarker, isObjectMarker, legacyIsObjectMarker); err != nil {
return err
}
into.AddHelp(enablePkgMarker,
markers.SimpleHelp("object", "enables or disables object interface & deepcopy implementation generation for this package"))
into.AddHelp(
enableTypeMarker, markers.SimpleHelp("object", "overrides enabling or disabling deepcopy generation for this type"))
into.AddHelp(isObjectMarker,
markers.SimpleHelp("object", "enables object interface implementation generation for this type"))
into.AddHelp(legacyEnablePkgMarker,
markers.DeprecatedHelp(enablePkgMarker.Name, "object", "enables or disables object interface & deepcopy implementation generation for this package"))
into.AddHelp(legacyEnableTypeMarker,
markers.DeprecatedHelp(enableTypeMarker.Name, "object", "overrides enabling or disabling deepcopy generation for this type"))
into.AddHelp(legacyIsObjectMarker,
markers.DeprecatedHelp(isObjectMarker.Name, "object", "enables object interface implementation generation for this type"))
return nil
}
func enabledOnPackage(col *markers.Collector, pkg *loader.Package) (bool, error) {
pkgMarkers, err := markers.PackageMarkers(col, pkg)
if err != nil {
return false, err
}
pkgMarker := pkgMarkers.Get(enablePkgMarker.Name)
if pkgMarker != nil {
return pkgMarker.(bool), nil
}
legacyMarker := pkgMarkers.Get(legacyEnablePkgMarker.Name)
if legacyMarker != nil {
legacyMarkerVal := string(legacyMarker.(markers.RawArguments))
firstArg := strings.Split(legacyMarkerVal, ",")[0]
return firstArg == "package", nil
}
return false, nil
}
func enabledOnType(allTypes bool, info *markers.TypeInfo) bool {
if typeMarker := info.Markers.Get(enableTypeMarker.Name); typeMarker != nil {
return typeMarker.(bool)
}
legacyMarker := info.Markers.Get(legacyEnableTypeMarker.Name)
if legacyMarker != nil {
legacyMarkerVal := string(legacyMarker.(markers.RawArguments))
return legacyMarkerVal == "true"
}
return allTypes || genObjectInterface(info)
}
func genObjectInterface(info *markers.TypeInfo) bool {
objectEnabled := info.Markers.Get(isObjectMarker.Name)
if objectEnabled != nil {
return objectEnabled.(bool)
}
for _, legacyEnabled := range info.Markers[legacyIsObjectMarker.Name] {
if legacyEnabled == runtimeObjPath {
return true
}
}
return false
}
func (d Generator) Generate(ctx *genall.GenerationContext) error {
var headerText string
if d.HeaderFile != "" {
headerBytes, err := ctx.ReadFile(d.HeaderFile)
if err != nil {
return err
}
headerText = string(headerBytes)
}
headerText = strings.ReplaceAll(headerText, " YEAR", " "+d.Year)
objGenCtx := ObjectGenCtx{
Collector: ctx.Collector,
Checker: ctx.Checker,
HeaderText: headerText,
}
for _, root := range ctx.Roots {
outContents := objGenCtx.GenerateForPackage(root)
if outContents == nil {
continue
}
writeOut(ctx, root, outContents)
}
return nil
}
// ObjectGenCtx contains the common info for generating deepcopy implementations.
// It mostly exists so that generating for a package can be easily tested without
// requiring a full set of output rules, etc.
type ObjectGenCtx struct {
Collector *markers.Collector
Checker *loader.TypeChecker
HeaderText string
}
// writeHeader writes out the build tag, package declaration, and imports
func writeHeader(pkg *loader.Package, out io.Writer, packageName string, imports *importsList, headerText string) {
// NB(directxman12): blank line after build tags to distinguish them from comments
_, err := fmt.Fprintf(out, `// +build !ignore_autogenerated
%[3]s
// Code generated by controller-gen. DO NOT EDIT.
package %[1]s
import (
%[2]s
)
`, packageName, strings.Join(imports.ImportSpecs(), "\n"), headerText)
if err != nil {
pkg.AddError(err)
}
}
// GenerateForPackage generates DeepCopy and runtime.Object implementations for
// types in the given package, writing the formatted result to given writer.
// May return nil if source could not be generated.
func (ctx *ObjectGenCtx) GenerateForPackage(root *loader.Package) []byte {
allTypes, err := enabledOnPackage(ctx.Collector, root)
if err != nil {
root.AddError(err)
return nil
}
ctx.Checker.Check(root, func(node ast.Node) bool {
// ignore interfaces
_, isIface := node.(*ast.InterfaceType)
return !isIface
})
root.NeedTypesInfo()
byType := make(map[string][]byte)
imports := &importsList{
byPath: make(map[string]string),
byAlias: make(map[string]string),
pkg: root,
}
// avoid confusing aliases by "reserving" the root package's name as an alias
imports.byAlias[root.Name] = ""
if err := markers.EachType(ctx.Collector, root, func(info *markers.TypeInfo) {
outContent := new(bytes.Buffer)
// copy when nabled for all types and not disabled, or enabled
// specifically on this type
if !enabledOnType(allTypes, info) {
return
}
// avoid copying non-exported types, etc
if !shouldBeCopied(root, info) {
return
}
copyCtx := ©MethodMaker{
pkg: root,
importsList: imports,
codeWriter: &codeWriter{out: outContent},
}
copyCtx.GenerateMethodsFor(root, info)
outBytes := outContent.Bytes()
if len(outBytes) > 0 {
byType[info.Name] = outBytes
}
}); err != nil {
root.AddError(err)
return nil
}
if len(byType) == 0 {
return nil
}
outContent := new(bytes.Buffer)
writeHeader(root, outContent, root.Name, imports, ctx.HeaderText)
writeMethods(root, outContent, byType)
outBytes := outContent.Bytes()
formattedBytes, err := format.Source(outBytes)
if err != nil {
root.AddError(err)
// we still write the invalid source to disk to figure out what went wrong
} else {
outBytes = formattedBytes
}
return outBytes
}
// writeMethods writes each method to the file, sorted by type name.
func writeMethods(pkg *loader.Package, out io.Writer, byType map[string][]byte) {
sortedNames := make([]string, 0, len(byType))
for name := range byType {
sortedNames = append(sortedNames, name)
}
sort.Strings(sortedNames)
for _, name := range sortedNames {
_, err := out.Write(byType[name])
if err != nil {
pkg.AddError(err)
}
}
}
// writeFormatted outputs the given code, after gofmt-ing it. If we couldn't gofmt,
// we write the unformatted code for debugging purposes.
func writeOut(ctx *genall.GenerationContext, root *loader.Package, outBytes []byte) {
outputFile, err := ctx.Open(root, "zz_generated.deepcopy.go")
if err != nil {
root.AddError(err)
return
}
defer outputFile.Close()
n, err := outputFile.Write(outBytes)
if err != nil {
root.AddError(err)
return
}
if n < len(outBytes) {
root.AddError(io.ErrShortWrite)
}
}