Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 3ec10da

Browse filesBrowse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #131608 from omerap12/migrate-ExtractCommentTags-conversion
Migrate ExtractCommentTags to ExtractFunctionStyleCommentTags
2 parents c6311d5 + 2b3f2aa commit 3ec10da
Copy full SHA for 3ec10da

File tree

Expand file treeCollapse file tree

1 file changed

+78
-21
lines changed
Filter options
  • staging/src/k8s.io/code-generator/cmd/conversion-gen/generators
Expand file treeCollapse file tree

1 file changed

+78
-21
lines changed

‎staging/src/k8s.io/code-generator/cmd/conversion-gen/generators/conversion.go

Copy file name to clipboardExpand all lines: staging/src/k8s.io/code-generator/cmd/conversion-gen/generators/conversion.go
+78-21Lines changed: 78 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -48,26 +48,48 @@ const (
4848
externalTypesTagName = "k8s:conversion-gen-external-types"
4949
)
5050

51-
func extractTag(comments []string) []string {
52-
return gengo.ExtractCommentTags("+", comments)[tagName]
51+
func extractTagValues(tagName string, comments []string) ([]string, error) {
52+
tags, err := gengo.ExtractFunctionStyleCommentTags("+", []string{tagName}, comments)
53+
if err != nil {
54+
return nil, err
55+
}
56+
tagList, exists := tags[tagName]
57+
if !exists {
58+
return nil, nil
59+
}
60+
values := make([]string, len(tagList))
61+
for i, v := range tagList {
62+
values[i] = v.Value
63+
}
64+
return values, nil
5365
}
5466

55-
func extractExplicitFromTag(comments []string) []string {
56-
return gengo.ExtractCommentTags("+", comments)[explicitFromTagName]
67+
func extractTag(comments []string) ([]string, error) {
68+
return extractTagValues(tagName, comments)
5769
}
5870

59-
func extractExternalTypesTag(comments []string) []string {
60-
return gengo.ExtractCommentTags("+", comments)[externalTypesTagName]
71+
func extractExplicitFromTag(comments []string) ([]string, error) {
72+
return extractTagValues(explicitFromTagName, comments)
6173
}
6274

63-
func isCopyOnly(comments []string) bool {
64-
values := gengo.ExtractCommentTags("+", comments)["k8s:conversion-fn"]
65-
return len(values) == 1 && values[0] == "copy-only"
75+
func extractExternalTypesTag(comments []string) ([]string, error) {
76+
return extractTagValues(externalTypesTagName, comments)
6677
}
6778

68-
func isDrop(comments []string) bool {
69-
values := gengo.ExtractCommentTags("+", comments)["k8s:conversion-fn"]
70-
return len(values) == 1 && values[0] == "drop"
79+
func isCopyOnly(comments []string) (bool, error) {
80+
values, err := extractTagValues("k8s:conversion-fn", comments)
81+
if err != nil {
82+
return false, err
83+
}
84+
return len(values) == 1 && values[0] == "copy-only", nil
85+
}
86+
87+
func isDrop(comments []string) (bool, error) {
88+
values, err := extractTagValues("k8s:conversion-fn", comments)
89+
if err != nil {
90+
return false, err
91+
}
92+
return len(values) == 1 && values[0] == "drop", nil
7193
}
7294

7395
// TODO: This is created only to reduce number of changes in a single PR.
@@ -229,11 +251,15 @@ func GetTargets(context *generator.Context, args *args.Args) []generator.Target
229251
// Only generate conversions for packages which explicitly request it
230252
// by specifying one or more "+k8s:conversion-gen=<peer-pkg>"
231253
// in their doc.go file.
232-
peerPkgs := extractTag(pkg.Comments)
254+
peerPkgs, err := extractTag(pkg.Comments)
233255
if peerPkgs == nil {
234256
klog.V(3).Infof(" no tag")
235257
continue
236258
}
259+
if err != nil {
260+
klog.Errorf("failed to extract tag %s", err)
261+
continue
262+
}
237263
klog.V(3).Infof(" tags: %q", peerPkgs)
238264
if len(peerPkgs) == 1 && peerPkgs[0] == "false" {
239265
// If a single +k8s:conversion-gen=false tag is defined, we still want
@@ -250,7 +276,10 @@ func GetTargets(context *generator.Context, args *args.Args) []generator.Target
250276

251277
// if the external types are not in the same package where the
252278
// conversion functions to be generated
253-
externalTypesValues := extractExternalTypesTag(pkg.Comments)
279+
externalTypesValues, err := extractExternalTypesTag(pkg.Comments)
280+
if err != nil {
281+
klog.Fatalf("Failed to extract external types tag for package %q: %v", i, err)
282+
}
254283
if externalTypesValues != nil {
255284
if len(externalTypesValues) != 1 {
256285
klog.Fatalf(" expect only one value for %q tag, got: %q", externalTypesTagName, externalTypesValues)
@@ -337,7 +366,10 @@ func GetTargets(context *generator.Context, args *args.Args) []generator.Target
337366
// If there is a manual conversion defined between two types, exclude it
338367
// from being a candidate for unsafe conversion
339368
for k, v := range manualConversions {
340-
if isCopyOnly(v.CommentLines) {
369+
copyOnly, err := isCopyOnly(v.CommentLines)
370+
if err != nil {
371+
klog.Errorf("error extracting tags: %v", err)
372+
} else if copyOnly {
341373
klog.V(4).Infof("Conversion function %s will not block memory copy because it is copy-only", v.Name)
342374
continue
343375
}
@@ -520,7 +552,12 @@ func (g *genConversion) convertibleOnlyWithinPackage(inType, outType *types.Type
520552
return false
521553
}
522554
// If the type has opted out, skip it.
523-
tagvals := extractTag(t.CommentLines)
555+
tagvals, err := extractTag(t.CommentLines)
556+
if err != nil {
557+
klog.Errorf("Type %v: error extracting tags: %v", t, err)
558+
return false
559+
}
560+
524561
if tagvals != nil {
525562
if tagvals[0] != "false" {
526563
klog.Fatalf("Type %v: unsupported %s value: %q", t, tagName, tagvals[0])
@@ -542,8 +579,12 @@ func (g *genConversion) convertibleOnlyWithinPackage(inType, outType *types.Type
542579
func getExplicitFromTypes(t *types.Type) []types.Name {
543580
comments := t.SecondClosestCommentLines
544581
comments = append(comments, t.CommentLines...)
545-
paths := extractExplicitFromTag(comments)
546582
result := []types.Name{}
583+
paths, err := extractExplicitFromTag(comments)
584+
if err != nil {
585+
klog.Errorf("Error extracting explicit-from tag for %v: %v", t.Name, err)
586+
return result
587+
}
547588
for _, path := range paths {
548589
items := strings.Split(path, ".")
549590
if len(items) != 2 {
@@ -869,7 +910,11 @@ func (g *genConversion) doSlice(inType, outType *types.Type, sw *generator.Snipp
869910

870911
func (g *genConversion) doStruct(inType, outType *types.Type, sw *generator.SnippetWriter) {
871912
for _, inMember := range inType.Members {
872-
if tagvals := extractTag(inMember.CommentLines); tagvals != nil && tagvals[0] == "false" {
913+
tagvals, err := extractTag(inMember.CommentLines)
914+
if err != nil {
915+
klog.Errorf("Member %v.%v: error extracting tags: %v", inType, inMember.Name, err)
916+
}
917+
if tagvals != nil && tagvals[0] == "false" {
873918
// This field is excluded from conversion.
874919
sw.Do("// INFO: in."+inMember.Name+" opted out of conversion generation\n", nil)
875920
continue
@@ -918,15 +963,23 @@ func (g *genConversion) doStruct(inType, outType *types.Type, sw *generator.Snip
918963

919964
// check based on the top level name, not the underlying names
920965
if function, ok := g.preexists(inMember.Type, outMember.Type); ok {
921-
if isDrop(function.CommentLines) {
966+
dropFn, err := isDrop(function.CommentLines)
967+
if err != nil {
968+
klog.Errorf("Error extracting drop tag for function %s: %v", function.Name, err)
969+
} else if dropFn {
922970
continue
923971
}
924972
// copy-only functions that are directly assignable can be inlined instead of invoked.
925973
// As an example, conversion functions exist that allow types with private fields to be
926974
// correctly copied between types. These functions are equivalent to a memory assignment,
927975
// and are necessary for the reflection path, but should not block memory conversion.
928976
// Convert_unversioned_Time_to_unversioned_Time is an example of this logic.
929-
if !isCopyOnly(function.CommentLines) || !g.isFastConversion(inMemberType, outMemberType) {
977+
copyOnly, copyErr := isCopyOnly(function.CommentLines)
978+
if copyErr != nil {
979+
klog.Errorf("Error extracting copy-only tag for function %s: %v", function.Name, copyErr)
980+
copyOnly = false
981+
}
982+
if !copyOnly || !g.isFastConversion(inMemberType, outMemberType) {
930983
args["function"] = function
931984
sw.Do("if err := $.function|raw$(&in.$.name$, &out.$.name$, s); err != nil {\n", args)
932985
sw.Do("return err\n", nil)
@@ -1080,7 +1133,11 @@ func (g *genConversion) generateFromURLValues(inType, outType *types.Type, sw *g
10801133
}
10811134
sw.Do("func auto"+nameTmpl+"(in *$.inType|raw$, out *$.outType|raw$, s $.Scope|raw$) error {\n", args)
10821135
for _, outMember := range outType.Members {
1083-
if tagvals := extractTag(outMember.CommentLines); tagvals != nil && tagvals[0] == "false" {
1136+
tagvals, err := extractTag(outMember.CommentLines)
1137+
if err != nil {
1138+
klog.Errorf("Member %v.%v: error extracting tags: %v", outType, outMember.Name, err)
1139+
}
1140+
if tagvals != nil && tagvals[0] == "false" {
10841141
// This field is excluded from conversion.
10851142
sw.Do("// INFO: in."+outMember.Name+" opted out of conversion generation\n", nil)
10861143
continue

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.