Skip to content

Commit d501fc3

Browse files
AdirioAdirio
committed
Remove spaces from machine-readable comments (v3 only)
Signed-off-by: Adrian Orive <[email protected]>
1 parent bba9577 commit d501fc3

File tree

144 files changed

+388
-383
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

144 files changed

+388
-383
lines changed

‎pkg/model/file/marker.go

+9-4
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,14 @@ package file
1919
import (
2020
"fmt"
2121
"path/filepath"
22+
"strings"
2223
)
2324

2425
const prefix = "+kubebuilder:scaffold:"
2526

2627
var commentsByExt = map[string]string{
27-
// TODO(v3): machine-readable comments should not have spaces by Go convention. However,
28-
// this is a backwards incompatible change, and thus should be done for next project version.
29-
".go": "// ",
30-
".yaml": "# ",
28+
".go": "//",
29+
".yaml": "#",
3130
".yml": "#",
3231
// When adding additional file extensions, update also the NewMarkerFor documentation and error
3332
}
@@ -54,6 +53,12 @@ func (m Marker) String() string {
5453
return m.comment + prefix + m.value
5554
}
5655

56+
// EqualsLine compares a marker with a string representation to check if they are the same marker
57+
func (m Marker) EqualsLine(line string) bool {
58+
line = strings.TrimSpace(strings.TrimPrefix(line, m.comment))
59+
return line == prefix+m.value
60+
}
61+
5762
// CodeFragments represents a set of code fragments
5863
// A code fragment is a piece of code provided as a Go string, it may have multiple lines
5964
type CodeFragments []string

‎pkg/plugins/golang/v2/scaffolds/internal/templates/api/group.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ func (f *Group) SetTemplateDefaults() error {
5252
const groupTemplate = `{{ .Boilerplate }}
5353
5454
// Package {{ .Resource.Version }} contains API Schema definitions for the {{ .Resource.Group }} {{ .Resource.Version }} API group
55-
// +kubebuilder:object:generate=true
56-
// +groupName={{ .Resource.Domain }}
55+
//+kubebuilder:object:generate=true
56+
//+groupName={{ .Resource.Domain }}
5757
package {{ .Resource.Version }}
5858
5959
import (

‎pkg/plugins/golang/v2/scaffolds/internal/templates/api/types.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ type {{ .Resource.Kind }}Status struct {
7878
// Important: Run "make" to regenerate code after modifying this file
7979
}
8080
81-
// +kubebuilder:object:root=true
82-
// +kubebuilder:subresource:status
83-
{{ if not .Resource.Namespaced }} // +kubebuilder:resource:scope=Cluster {{ end }}
81+
//+kubebuilder:object:root=true
82+
//+kubebuilder:subresource:status
83+
{{ if not .Resource.Namespaced }} //+kubebuilder:resource:scope=Cluster {{ end }}
8484
8585
// {{ .Resource.Kind }} is the Schema for the {{ .Resource.Plural }} API
8686
type {{ .Resource.Kind }} struct {
@@ -91,7 +91,7 @@ type {{ .Resource.Kind }} struct {
9191
Status {{ .Resource.Kind }}Status ` + "`" + `json:"status,omitempty"` + "`" + `
9292
}
9393
94-
// +kubebuilder:object:root=true
94+
//+kubebuilder:object:root=true
9595
9696
// {{ .Resource.Kind }}List contains a list of {{ .Resource.Kind }}
9797
type {{ .Resource.Kind }}List struct {

‎pkg/plugins/golang/v2/scaffolds/internal/templates/api/webhook.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ func (r *{{ .Resource.Kind }}) SetupWebhookWithManager(mgr ctrl.Manager) error {
100100

101101
//nolint:lll
102102
defaultingWebhookTemplate = `
103-
// +kubebuilder:webhook:path=/mutate-{{ .GroupDomainWithDash }}-{{ .Resource.Version }}-{{ lower .Resource.Kind }},mutating=true,failurePolicy=fail,groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},verbs=create;update,versions={{ .Resource.Version }},name=m{{ lower .Resource.Kind }}.kb.io
103+
//+kubebuilder:webhook:path=/mutate-{{ .GroupDomainWithDash }}-{{ .Resource.Version }}-{{ lower .Resource.Kind }},mutating=true,failurePolicy=fail,groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},verbs=create;update,versions={{ .Resource.Version }},name=m{{ lower .Resource.Kind }}.kb.io
104104
105105
var _ webhook.Defaulter = &{{ .Resource.Kind }}{}
106106
@@ -114,7 +114,7 @@ func (r *{{ .Resource.Kind }}) Default() {
114114
//nolint:lll
115115
validatingWebhookTemplate = `
116116
// TODO(user): change verbs to "verbs=create;update;delete" if you want to enable deletion validation.
117-
// +kubebuilder:webhook:verbs=create;update,path=/validate-{{ .GroupDomainWithDash }}-{{ .Resource.Version }}-{{ lower .Resource.Kind }},mutating=false,failurePolicy=fail,groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},versions={{ .Resource.Version }},name=v{{ lower .Resource.Kind }}.kb.io
117+
//+kubebuilder:webhook:verbs=create;update,path=/validate-{{ .GroupDomainWithDash }}-{{ .Resource.Version }}-{{ lower .Resource.Kind }},mutating=false,failurePolicy=fail,groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},versions={{ .Resource.Version }},name=v{{ lower .Resource.Kind }}.kb.io
118118
119119
var _ webhook.Validator = &{{ .Resource.Kind }}{}
120120

‎pkg/plugins/golang/v2/scaffolds/internal/templates/controllers/controller.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ type {{ .Resource.Kind }}Reconciler struct {
7979
Scheme *runtime.Scheme
8080
}
8181
82-
// +kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},verbs=get;list;watch;create;update;patch;delete
83-
// +kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }}/status,verbs=get;update;patch
82+
//+kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},verbs=get;list;watch;create;update;patch;delete
83+
//+kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }}/status,verbs=get;update;patch
8484
8585
func (r *{{ .Resource.Kind }}Reconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
8686
_ = context.Background()

‎pkg/plugins/golang/v3/scaffolds/internal/templates/api/group.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ func (f *Group) SetTemplateDefaults() error {
5656
const groupTemplate = `{{ .Boilerplate }}
5757
5858
// Package {{ .Resource.Version }} contains API Schema definitions for the {{ .Resource.Group }} {{ .Resource.Version }} API group
59-
// +kubebuilder:object:generate=true
60-
// +groupName={{ .Resource.Domain }}
59+
//+kubebuilder:object:generate=true
60+
//+groupName={{ .Resource.Domain }}
6161
package {{ .Resource.Version }}
6262
6363
import (

‎pkg/plugins/golang/v3/scaffolds/internal/templates/api/types.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ type {{ .Resource.Kind }}Status struct {
8282
// Important: Run "make" to regenerate code after modifying this file
8383
}
8484
85-
// +kubebuilder:object:root=true
86-
// +kubebuilder:subresource:status
87-
{{ if not .Resource.Namespaced }} // +kubebuilder:resource:scope=Cluster {{ end }}
85+
//+kubebuilder:object:root=true
86+
//+kubebuilder:subresource:status
87+
{{ if not .Resource.Namespaced }} //+kubebuilder:resource:scope=Cluster {{ end }}
8888
8989
// {{ .Resource.Kind }} is the Schema for the {{ .Resource.Plural }} API
9090
type {{ .Resource.Kind }} struct {
@@ -95,7 +95,7 @@ type {{ .Resource.Kind }} struct {
9595
Status {{ .Resource.Kind }}Status ` + "`" + `json:"status,omitempty"` + "`" + `
9696
}
9797
98-
// +kubebuilder:object:root=true
98+
//+kubebuilder:object:root=true
9999
100100
// {{ .Resource.Kind }}List contains a list of {{ .Resource.Kind }}
101101
type {{ .Resource.Kind }}List struct {

‎pkg/plugins/golang/v3/scaffolds/internal/templates/api/webhook.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ func (r *{{ .Resource.Kind }}) SetupWebhookWithManager(mgr ctrl.Manager) error {
117117
// TODO(estroz): update admissionReviewVersions to include v1 when controller-runtime supports that version.
118118
//nolint:lll
119119
defaultingWebhookTemplate = `
120-
// +kubebuilder:webhook:{{ if ne .WebhookVersion "v1" }}webhookVersions={{"{"}}{{ .WebhookVersion }}{{"}"}},{{ end }}path=/mutate-{{ .GroupDomainWithDash }}-{{ .Resource.Version }}-{{ lower .Resource.Kind }},mutating=true,failurePolicy=fail,sideEffects=None,groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},verbs=create;update,versions={{ .Resource.Version }},name=m{{ lower .Resource.Kind }}.kb.io,admissionReviewVersions={v1,v1beta1}
120+
//+kubebuilder:webhook:{{ if ne .WebhookVersion "v1" }}webhookVersions={{"{"}}{{ .WebhookVersion }}{{"}"}},{{ end }}path=/mutate-{{ .GroupDomainWithDash }}-{{ .Resource.Version }}-{{ lower .Resource.Kind }},mutating=true,failurePolicy=fail,sideEffects=None,groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},verbs=create;update,versions={{ .Resource.Version }},name=m{{ lower .Resource.Kind }}.kb.io,admissionReviewVersions={v1,v1beta1}
121121
122122
var _ webhook.Defaulter = &{{ .Resource.Kind }}{}
123123
@@ -133,7 +133,7 @@ func (r *{{ .Resource.Kind }}) Default() {
133133
//nolint:lll
134134
validatingWebhookTemplate = `
135135
// TODO(user): change verbs to "verbs=create;update;delete" if you want to enable deletion validation.
136-
// +kubebuilder:webhook:{{ if ne .WebhookVersion "v1" }}webhookVersions={{"{"}}{{ .WebhookVersion }}{{"}"}},{{ end }}path=/validate-{{ .GroupDomainWithDash }}-{{ .Resource.Version }}-{{ lower .Resource.Kind }},mutating=false,failurePolicy=fail,sideEffects=None,groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},verbs=create;update,versions={{ .Resource.Version }},name=v{{ lower .Resource.Kind }}.kb.io,admissionReviewVersions={v1,v1beta1}
136+
//+kubebuilder:webhook:{{ if ne .WebhookVersion "v1" }}webhookVersions={{"{"}}{{ .WebhookVersion }}{{"}"}},{{ end }}path=/validate-{{ .GroupDomainWithDash }}-{{ .Resource.Version }}-{{ lower .Resource.Kind }},mutating=false,failurePolicy=fail,sideEffects=None,groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},verbs=create;update,versions={{ .Resource.Version }},name=v{{ lower .Resource.Kind }}.kb.io,admissionReviewVersions={v1,v1beta1}
137137
138138
var _ webhook.Validator = &{{ .Resource.Kind }}{}
139139

‎pkg/plugins/golang/v3/scaffolds/internal/templates/controllers/controller.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ type {{ .Resource.Kind }}Reconciler struct {
8585
Scheme *runtime.Scheme
8686
}
8787
88-
// +kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},verbs=get;list;watch;create;update;patch;delete
89-
// +kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }}/status,verbs=get;update;patch
90-
// +kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }}/finalizers,verbs=update
88+
//+kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},verbs=get;list;watch;create;update;patch;delete
89+
//+kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }}/status,verbs=get;update;patch
90+
//+kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }}/finalizers,verbs=update
9191
9292
// Reconcile is part of the main kubernetes reconciliation loop which aims to
9393
// move the current state of the cluster closer to the desired state.

‎pkg/plugins/internal/machinery/scaffold.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ func insertStrings(content string, codeFragmentsMap file.CodeFragmentsMap) ([]by
343343
line := scanner.Text()
344344

345345
for marker, codeFragments := range codeFragmentsMap {
346-
if strings.TrimSpace(line) == strings.TrimSpace(marker.String()) {
346+
if marker.EqualsLine(line) {
347347
for _, codeFragment := range codeFragments {
348348
_, _ = out.WriteString(codeFragment) // bytes.Buffer.WriteString always returns nil errors
349349
}

‎pkg/plugins/internal/machinery/scaffold_test.go

+20-20
Original file line numberDiff line numberDiff line change
@@ -206,25 +206,25 @@ var _ = Describe("Scaffold", func() {
206206
},
207207
Entry("should insert lines for go files",
208208
`
209-
// +kubebuilder:scaffold:-
209+
//+kubebuilder:scaffold:-
210210
`,
211211
`
212212
1
213213
2
214-
// +kubebuilder:scaffold:-
214+
//+kubebuilder:scaffold:-
215215
`,
216216
fakeInserter{codeFragments: file.CodeFragmentsMap{
217217
file.NewMarkerFor("file.go", "-"): {"1\n", "2\n"}},
218218
},
219219
),
220220
Entry("should insert lines for yaml files",
221221
`
222-
# +kubebuilder:scaffold:-
222+
#+kubebuilder:scaffold:-
223223
`,
224224
`
225225
1
226226
2
227-
# +kubebuilder:scaffold:-
227+
#+kubebuilder:scaffold:-
228228
`,
229229
fakeInserter{codeFragments: file.CodeFragmentsMap{
230230
file.NewMarkerFor("file.yaml", "-"): {"1\n", "2\n"}},
@@ -235,10 +235,10 @@ var _ = Describe("Scaffold", func() {
235235
`
236236
1
237237
2
238-
// +kubebuilder:scaffold:-
238+
//+kubebuilder:scaffold:-
239239
`,
240240
fakeTemplate{fakeBuilder: fakeBuilder{ifExistsAction: file.Overwrite}, body: `
241-
// +kubebuilder:scaffold:-
241+
//+kubebuilder:scaffold:-
242242
`},
243243
fakeInserter{codeFragments: file.CodeFragmentsMap{
244244
file.NewMarkerFor("file.go", "-"): {"1\n", "2\n"}},
@@ -249,23 +249,23 @@ var _ = Describe("Scaffold", func() {
249249
`
250250
1
251251
2
252-
// +kubebuilder:scaffold:-
252+
//+kubebuilder:scaffold:-
253253
`,
254254
fakeTemplate{fakeBuilder: fakeBuilder{ifExistsAction: file.Overwrite}, body: `
255-
// +kubebuilder:scaffold:-
255+
//+kubebuilder:scaffold:-
256256
`},
257257
fakeInserter{codeFragments: file.CodeFragmentsMap{
258258
file.NewMarkerFor("file.go", "-"): {"1\n", "2\n"}},
259259
},
260260
),
261261
Entry("should use files over optional models",
262262
`
263-
// +kubebuilder:scaffold:-
263+
//+kubebuilder:scaffold:-
264264
`,
265265
`
266266
1
267267
2
268-
// +kubebuilder:scaffold:-
268+
//+kubebuilder:scaffold:-
269269
`,
270270
fakeTemplate{body: fileContent},
271271
fakeInserter{
@@ -276,14 +276,14 @@ var _ = Describe("Scaffold", func() {
276276
),
277277
Entry("should filter invalid markers",
278278
`
279-
// +kubebuilder:scaffold:-
280-
// +kubebuilder:scaffold:*
279+
//+kubebuilder:scaffold:-
280+
//+kubebuilder:scaffold:*
281281
`,
282282
`
283283
1
284284
2
285-
// +kubebuilder:scaffold:-
286-
// +kubebuilder:scaffold:*
285+
//+kubebuilder:scaffold:-
286+
//+kubebuilder:scaffold:*
287287
`,
288288
fakeInserter{
289289
markers: []file.Marker{file.NewMarkerFor("file.go", "-")},
@@ -296,18 +296,18 @@ var _ = Describe("Scaffold", func() {
296296
Entry("should filter already existing one-line code fragments",
297297
`
298298
1
299-
// +kubebuilder:scaffold:-
299+
//+kubebuilder:scaffold:-
300300
3
301301
4
302-
// +kubebuilder:scaffold:*
302+
//+kubebuilder:scaffold:*
303303
`,
304304
`
305305
1
306306
2
307-
// +kubebuilder:scaffold:-
307+
//+kubebuilder:scaffold:-
308308
3
309309
4
310-
// +kubebuilder:scaffold:*
310+
//+kubebuilder:scaffold:*
311311
`,
312312
fakeInserter{
313313
codeFragments: file.CodeFragmentsMap{
@@ -319,10 +319,10 @@ var _ = Describe("Scaffold", func() {
319319
Entry("should not insert anything if no code fragment",
320320
"", // input is provided through a template as mock fs doesn't copy it to the output buffer if no-op
321321
`
322-
// +kubebuilder:scaffold:-
322+
//+kubebuilder:scaffold:-
323323
`,
324324
fakeTemplate{body: `
325-
// +kubebuilder:scaffold:-
325+
//+kubebuilder:scaffold:-
326326
`},
327327
fakeInserter{
328328
codeFragments: file.CodeFragmentsMap{

‎plugins/addon/controller.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ type {{ .Resource.Kind }}Reconciler struct {
6262
declarative.Reconciler
6363
}
6464
65-
// +kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},verbs=get;list;watch;create;update;patch;delete
66-
// +kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }}/status,verbs=get;update;patch
65+
//+kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }},verbs=get;list;watch;create;update;patch;delete
66+
//+kubebuilder:rbac:groups={{ .Resource.Domain }},resources={{ .Resource.Plural }}/status,verbs=get;update;patch
6767
6868
func (r *{{ .Resource.Kind }}Reconciler) SetupWithManager(mgr ctrl.Manager) error {
6969
addon.Init()

‎plugins/addon/type.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ type {{.Resource.Kind}}Status struct {
7474
// Important: Run "make" to regenerate code after modifying this file
7575
}
7676
77-
// +kubebuilder:object:root=true
78-
// +kubebuilder:subresource:status
79-
{{ if not .Resource.Namespaced }} // +kubebuilder:resource:scope=Cluster {{ end }}
77+
//+kubebuilder:object:root=true
78+
//+kubebuilder:subresource:status
79+
{{ if not .Resource.Namespaced }} //+kubebuilder:resource:scope=Cluster {{ end }}
8080
8181
// {{.Resource.Kind}} is the Schema for the {{ .Resource.Plural }} API
8282
type {{.Resource.Kind}} struct {
@@ -109,8 +109,8 @@ func (o *{{.Resource.Kind}}) SetCommonStatus(s addonv1alpha1.CommonStatus) {
109109
o.Status.CommonStatus = s
110110
}
111111
112-
// +kubebuilder:object:root=true
113-
{{ if not .Resource.Namespaced }} // +kubebuilder:resource:scope=Cluster {{ end }}
112+
//+kubebuilder:object:root=true
113+
{{ if not .Resource.Namespaced }} //+kubebuilder:resource:scope=Cluster {{ end }}
114114
115115
// {{.Resource.Kind}}List contains a list of {{.Resource.Kind}}
116116
type {{.Resource.Kind}}List struct {

‎testdata/project-v2-addon/api/v1/admiral_types.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ type AdmiralStatus struct {
4141
// Important: Run "make" to regenerate code after modifying this file
4242
}
4343

44-
// +kubebuilder:object:root=true
45-
// +kubebuilder:subresource:status
46-
// +kubebuilder:resource:scope=Cluster
44+
//+kubebuilder:object:root=true
45+
//+kubebuilder:subresource:status
46+
//+kubebuilder:resource:scope=Cluster
4747

4848
// Admiral is the Schema for the admirals API
4949
type Admiral struct {
@@ -76,8 +76,8 @@ func (o *Admiral) SetCommonStatus(s addonv1alpha1.CommonStatus) {
7676
o.Status.CommonStatus = s
7777
}
7878

79-
// +kubebuilder:object:root=true
80-
// +kubebuilder:resource:scope=Cluster
79+
//+kubebuilder:object:root=true
80+
//+kubebuilder:resource:scope=Cluster
8181

8282
// AdmiralList contains a list of Admiral
8383
type AdmiralList struct {

‎testdata/project-v2-addon/api/v1/captain_types.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ type CaptainStatus struct {
4141
// Important: Run "make" to regenerate code after modifying this file
4242
}
4343

44-
// +kubebuilder:object:root=true
45-
// +kubebuilder:subresource:status
44+
//+kubebuilder:object:root=true
45+
//+kubebuilder:subresource:status
4646

4747
// Captain is the Schema for the captains API
4848
type Captain struct {
@@ -75,7 +75,7 @@ func (o *Captain) SetCommonStatus(s addonv1alpha1.CommonStatus) {
7575
o.Status.CommonStatus = s
7676
}
7777

78-
// +kubebuilder:object:root=true
78+
//+kubebuilder:object:root=true
7979

8080
// CaptainList contains a list of Captain
8181
type CaptainList struct {

‎testdata/project-v2-addon/api/v1/firstmate_types.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ type FirstMateStatus struct {
4141
// Important: Run "make" to regenerate code after modifying this file
4242
}
4343

44-
// +kubebuilder:object:root=true
45-
// +kubebuilder:subresource:status
44+
//+kubebuilder:object:root=true
45+
//+kubebuilder:subresource:status
4646

4747
// FirstMate is the Schema for the firstmates API
4848
type FirstMate struct {
@@ -75,7 +75,7 @@ func (o *FirstMate) SetCommonStatus(s addonv1alpha1.CommonStatus) {
7575
o.Status.CommonStatus = s
7676
}
7777

78-
// +kubebuilder:object:root=true
78+
//+kubebuilder:object:root=true
7979

8080
// FirstMateList contains a list of FirstMate
8181
type FirstMateList struct {

0 commit comments

Comments
 (0)