Skip to content

Commit

Permalink
Helpers-gen calls the conversion-gen
Browse files Browse the repository at this point in the history
  • Loading branch information
cardil committed Jan 19, 2024
1 parent 323501a commit 2831fdd
Show file tree
Hide file tree
Showing 8 changed files with 159 additions and 54 deletions.
55 changes: 55 additions & 0 deletions staging/src/k8s.io/code-generator/cmd/conversion-gen/embed/fn.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
/*
Copyright 2023 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 embed

import (
"github.com/spf13/pflag"
generatorargs "k8s.io/code-generator/cmd/conversion-gen/args"
"k8s.io/code-generator/cmd/conversion-gen/generators"
)

// Conversion runs the conversion-gen with given flagset and args.
func Conversion(fs *pflag.FlagSet, args []string) error {
genericArgs, customArgs := generatorargs.NewDefaults()

genericArgs.AddFlags(fs)
customArgs.AddFlags(fs)

if err := fs.Parse(args); err != nil {
return err
}

// k8s.io/apimachinery/pkg/runtime contains a number of manual conversions,
// that we need to generate conversions.
// Packages being dependencies of explicitly requested packages are only
// partially scanned - only types explicitly used are being traversed.
// Not used functions or types are omitted.
// Adding this explicitly to InputDirs ensures that the package is fully
// scanned and all functions are parsed and processed.
genericArgs.InputDirs = append(genericArgs.InputDirs, "k8s.io/apimachinery/pkg/runtime")

if err := generatorargs.Validate(genericArgs); err != nil {
return err
}

// Run it.
return genericArgs.Execute(
generators.NameSystems(),
generators.DefaultNameSystem(),
generators.Packages,
)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
Copyright 2023 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 embed_test

import (
"bytes"
"errors"
"github.com/spf13/pflag"
"k8s.io/code-generator/cmd/conversion-gen/embed"
"testing"
)

func TestConversion(t *testing.T) {
t.Parallel()
var out bytes.Buffer
fs := pflag.NewFlagSet("test", pflag.ContinueOnError)
fs.SetOutput(&out)
args := []string{"--help"}

err := embed.Conversion(fs, args)
if !errors.Is(err, pflag.ErrHelp) {
t.Errorf("unexpected error: %v", err)
}
if out.Len() == 0 {
t.Errorf("expected output, got none")
}
}
30 changes: 3 additions & 27 deletions staging/src/k8s.io/code-generator/cmd/conversion-gen/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,43 +96,19 @@ package main

import (
"flag"
"k8s.io/code-generator/cmd/conversion-gen/embed"
"os"

"github.com/spf13/pflag"
"k8s.io/klog/v2"

generatorargs "k8s.io/code-generator/cmd/conversion-gen/args"
"k8s.io/code-generator/cmd/conversion-gen/generators"
)

func main() {
klog.InitFlags(nil)
genericArgs, customArgs := generatorargs.NewDefaults()

genericArgs.AddFlags(pflag.CommandLine)
customArgs.AddFlags(pflag.CommandLine)
flag.Set("logtostderr", "true")
pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
pflag.Parse()

// k8s.io/apimachinery/pkg/runtime contains a number of manual conversions,
// that we need to generate conversions.
// Packages being dependencies of explicitly requested packages are only
// partially scanned - only types explicitly used are being traversed.
// Not used functions or types are omitted.
// Adding this explicitly to InputDirs ensures that the package is fully
// scanned and all functions are parsed and processed.
genericArgs.InputDirs = append(genericArgs.InputDirs, "k8s.io/apimachinery/pkg/runtime")

if err := generatorargs.Validate(genericArgs); err != nil {
klog.Fatalf("Error: %v", err)
}

// Run it.
if err := genericArgs.Execute(
generators.NameSystems(),
generators.DefaultNameSystem(),
generators.Packages,
); err != nil {
if err := embed.Conversion(pflag.CommandLine, os.Args[1:]); err != nil {
klog.Fatalf("Error: %v", err)
}
klog.V(2).Info("Completed successfully.")
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
Copyright 2023 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 helpers

import "k8s.io/code-generator/cmd/conversion-gen/embed"

func (g *Generator) generateConversion(args *Args) error {
return g.generateGen(args, genConf{
name: "conversion",
genFn: embed.Conversion,
useExtraPeerDirs: true,
searchPattern: "+k8s:conversion-gen=",
})
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,8 @@ import (

func (g *Generator) generateDeepCopy(args *Args) error {
return g.generateGen(args, genConf{
name: "deepcopy",
fileSuffix: "deepcopy",
genFn: embed.DeepCopy,
search: searchConf{
pattern: "+k8s:deepcopy-gen=",
pathspecFn: golangPathspec,
},
name: "deepcopy",
genFn: embed.DeepCopy,
searchPattern: "+k8s:deepcopy-gen=",
})
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,9 @@ import "k8s.io/code-generator/cmd/defaulter-gen/embed"

func (g *Generator) generateDefaulter(args *Args) error {
return g.generateGen(args, genConf{
name: "defaulter",
fileSuffix: "defaults",
genFn: embed.Defaulter,
search: searchConf{
pattern: "+k8s:defaulter-gen=",
pathspecFn: golangPathspec,
},
name: "defaulter",
fileSuffix: "defaults",
genFn: embed.Defaulter,
searchPattern: "+k8s:defaulter-gen=",
})
}
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ func (g *Generator) Generate(args *Args) error {
return err
}

if err := g.generateConversion(args); err != nil {
return err
}

klog.V(1).Infof("Successfully generated helpers for %v",
args.InputPkgRoot)
return nil
Expand Down
34 changes: 21 additions & 13 deletions staging/src/k8s.io/code-generator/pkg/codegen/helpers/generic.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,18 @@ import (
type genFn func(fs *pflag.FlagSet, args []string) error

type genConf struct {
name string
fileSuffix string
name string
fileSuffix string
searchPattern string
useExtraPeerDirs bool
genFn
search searchConf
}

func (gc genConf) suffix() string {
if gc.fileSuffix == "" {
return gc.name
}
return gc.fileSuffix
}

type pathspecFn func(*Args) string
Expand All @@ -55,11 +63,6 @@ func zzGeneratedPathspec(name string) pathspecFn {
)
}

type searchConf struct {
pattern string
pathspecFn
}

func (g *Generator) generateGen(args *Args, gc genConf) error {
return fs.WithinDirectory(args.root, func() error {
pkgs, err := collectPackages(args, gc)
Expand All @@ -86,8 +89,8 @@ func (g *Generator) generateGen(args *Args, gc genConf) error {
func collectPackages(args *Args, conf genConf) ([]string, error) {
var inputPkgs = make(map[string]bool, 1)
if files, err := git.Grep(
conf.search.pattern,
conf.search.pathspecFn(args),
conf.searchPattern,
golangPathspec(args),
git.WithList,
); err != nil {
return nil, err
Expand Down Expand Up @@ -116,7 +119,7 @@ func collectPackages(args *Args, conf genConf) ([]string, error) {
}

func deleteGenerated(args *Args, gc genConf) error {
pathspec := zzGeneratedPathspec(gc.fileSuffix)(args)
pathspec := zzGeneratedPathspec(gc.suffix())(args)
if genFiles, err := git.Find(pathspec); err != nil {
return err
} else {
Expand All @@ -139,17 +142,22 @@ func (g *Generator) generatePackages(args *Args, gc genConf, pkgs []string) erro
if len(pkgs) == 0 {
return nil
}
klog.V(2).Infof("Generating %s code for %d packages",
klog.Infof("Generating %s code for %d targets",
gc.name, len(pkgs))

dcargs := []string{
"-O", fmt.Sprintf("zz_generated.%s", gc.fileSuffix),
"-O", fmt.Sprintf("zz_generated.%s", gc.suffix()),
"--output-base", args.OutputBase,
"--go-header-file", args.Boilerplate,
}
for _, pkg := range pkgs {
dcargs = append(dcargs, "--input-dirs", pkg)
}
if gc.useExtraPeerDirs {
for _, pkg := range args.ExtraPeerDirs {
dcargs = append(dcargs, "--extra-peer-dirs", pkg)
}
}
genName := gc.name + "-gen"
fl := pflag.NewFlagSet(genName, pflag.ContinueOnError)
fl.AddGoFlagSet(g.flags()) // make sure we get the klog flags
Expand Down

0 comments on commit 2831fdd

Please sign in to comment.