Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Client-gen] Make client for group (e.g., ExtensionsClient) #17699

Merged
merged 1 commit into from Nov 28, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 29 additions & 0 deletions cmd/libs/go2idl/client-gen/generators/client-generator.go
Expand Up @@ -19,6 +19,7 @@ package generators

import (
"os"
"path/filepath"
"strings"

"k8s.io/kubernetes/cmd/libs/go2idl/args"
Expand Down Expand Up @@ -50,6 +51,22 @@ func Packages(context *generator.Context, arguments *args.GeneratorArgs) generat
if err != nil {
glog.Fatalf("Failed loading boilerplate: %v", err)
}

groupToTypes := map[string][]*types.Type{}
for _, inputDir := range arguments.InputDirs {
p := context.Universe.Package(inputDir)
for _, t := range p.Types {
if types.ExtractCommentTags("+", t.CommentLines)["genclient"] != "true" {
continue
}
group := filepath.Base(t.Name.Package)
if _, found := groupToTypes[group]; !found {
groupToTypes[group] = []*types.Type{}
}
groupToTypes[group] = append(groupToTypes[group], t)
}
}

return generator.Packages{&generator.DefaultPackage{
PackageName: "unversioned",
PackagePath: arguments.OutputPackagePath,
Expand Down Expand Up @@ -88,6 +105,18 @@ func Packages(context *generator.Context, arguments *args.GeneratorArgs) generat
imports: generator.NewImportTracker(),
})
}

for group, types := range groupToTypes {
generators = append(generators, &genGroup{
DefaultGen: generator.DefaultGen{
OptionalName: group,
},
outputPackage: arguments.OutputPackagePath,
group: group,
types: types,
imports: generator.NewImportTracker(),
})
}
return generators
},
FilterFunc: func(c *generator.Context, t *types.Type) bool {
Expand Down
161 changes: 161 additions & 0 deletions cmd/libs/go2idl/client-gen/generators/generator-for-group.go
@@ -0,0 +1,161 @@
/*
Copyright 2015 The Kubernetes Authors All rights reserved.

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 generators

import (
"io"

"k8s.io/kubernetes/cmd/libs/go2idl/generator"
"k8s.io/kubernetes/cmd/libs/go2idl/namer"
"k8s.io/kubernetes/cmd/libs/go2idl/types"
)

// genGroup produces a file for a group client, e.g. ExtensionsClient for the extension group.
type genGroup struct {
generator.DefaultGen
outputPackage string
group string
// types in this group
types []*types.Type
imports *generator.ImportTracker
}

// We only want to call GenerateType() once per group.
func (g *genGroup) Filter(c *generator.Context, t *types.Type) bool {
return t == g.types[0]
}

func (g *genGroup) Namers(c *generator.Context) namer.NameSystems {
return namer.NameSystems{
"raw": namer.NewRawNamer(g.outputPackage, g.imports),
}
}

func (g *genGroup) Imports(c *generator.Context) (imports []string) {
return append(g.imports.ImportLines(), "fmt", "strings")
}

func (g *genGroup) GenerateType(c *generator.Context, t *types.Type, w io.Writer) error {
sw := generator.NewSnippetWriter(w, c, "$", "$")
const pkgUnversioned = "k8s.io/kubernetes/pkg/client/unversioned"
const pkgLatest = "k8s.io/kubernetes/pkg/api/latest"
m := map[string]interface{}{
"group": g.group,
"Group": namer.IC(g.group),
"types": g.types,
"Config": c.Universe.Get(types.Name{pkgUnversioned, "Config"}),
"DefaultKubernetesUserAgent": c.Universe.Get(types.Name{pkgUnversioned, "DefaultKubernetesUserAgent"}),
"RESTClient": c.Universe.Get(types.Name{pkgUnversioned, "RESTClient"}),
"RESTClientFor": c.Universe.Get(types.Name{pkgUnversioned, "RESTClientFor"}),
"latestGroup": c.Universe.Get(types.Name{pkgLatest, "Group"}),
"GroupOrDie": c.Universe.Get(types.Name{pkgLatest, "GroupOrDie"}),
}
sw.Do(groupInterfaceTemplate, m)
sw.Do(groupClientTemplate, m)
for _, t := range g.types {
wrapper := map[string]interface{}{
"type": t,
"Group": namer.IC(g.group),
}
sw.Do(namespacerImplTemplate, wrapper)
}
sw.Do(newClientTemplate, m)
sw.Do(newClientOrDieTemplate, m)
sw.Do(setClientDefaultsTemplate, m)

return sw.Error()
}

var groupInterfaceTemplate = `
type $.Group$Interface interface {
$range .types$
$.Name.Name$Namespacer
$end$
}
`

var groupClientTemplate = `
// $.Group$Client is used to interact with features provided by the $.Group$ group.
type $.Group$Client struct {
*$.RESTClient|raw$
}
`

var namespacerImplTemplate = `
func (c *$.Group$Client) $.type.Name.Name$s(namespace string) $.type.Name.Name$Interface {
return new$.type.Name.Name$s(c, namespace)
}
`

var newClientTemplate = `
// New$.Group$ creates a new $.Group$Client for the given config.
func New$.Group$(c *$.Config|raw$) (*$.Group$Client, error) {
config := *c
if err := set$.Group$Defaults(&config); err != nil {
return nil, err
}
client, err := $.RESTClientFor|raw$(&config)
if err != nil {
return nil, err
}
return &$.Group$Client{client}, nil
}
`

var newClientOrDieTemplate = `
// New$.Group$OrDie creates a new $.Group$Client for the given config and
// panics if there is an error in the config.
func New$.Group$OrDie(c *$.Config|raw$) *$.Group$Client {
client, err := New$.Group$(c)
if err != nil {
panic(err)
}
return client
}
`

var setClientDefaultsTemplate = `
func set$.Group$Defaults(config *$.Config|raw$) error {
// if $.group$ group is not registered, return an error
g, err := $.latestGroup|raw$("$.group$")
if err != nil {
return err
}
config.Prefix = "apis/"
if config.UserAgent == "" {
config.UserAgent = $.DefaultKubernetesUserAgent|raw$()
}
// TODO: Unconditionally set the config.Version, until we fix the config.
//if config.Version == "" {
config.Version = g.GroupVersion
//}

versionInterfaces, err := g.InterfacesFor(config.Version)
if err != nil {
return fmt.Errorf("$.Group$ API version '%s' is not recognized (valid values: %s)",
config.Version, strings.Join($.GroupOrDie|raw$("$.group$").Versions, ", "))
}
config.Codec = versionInterfaces.Codec
if config.QPS == 0 {
config.QPS = 5
}
if config.Burst == 0 {
config.Burst = 10
}
return nil
}
`
2 changes: 2 additions & 0 deletions cmd/libs/go2idl/client-gen/main.go
Expand Up @@ -35,6 +35,8 @@ func main() {
"k8s.io/kubernetes/pkg/fields",
"k8s.io/kubernetes/pkg/labels",
"k8s.io/kubernetes/pkg/watch",
"k8s.io/kubernetes/pkg/client/unversioned",
"k8s.io/kubernetes/pkg/api/latest",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you need latest?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because I want the framework to automatically import the latest package as necessary. See here: #17699 (comment).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is the missing question you referred to?

}
// We may change the output path later.
arguments.OutputPackagePath = "k8s.io/kubernetes/pkg/client/clientset/unversioned"
Expand Down