1
0
mirror of https://github.com/rancher/norman.git synced 2025-04-28 11:24:47 +00:00
norman/generator/controller_template.go

340 lines
13 KiB
Go
Raw Normal View History

2017-11-11 04:44:02 +00:00
package generator
var controllerTemplate = `package {{.schema.Version.Version}}
import (
"context"
2020-02-06 04:15:26 +00:00
"time"
2017-11-11 04:44:02 +00:00
2017-11-28 21:28:25 +00:00
{{.importPackage}}
2018-04-03 19:49:20 +00:00
"github.com/rancher/norman/objectclient"
2017-11-11 04:44:02 +00:00
"github.com/rancher/norman/controller"
"github.com/rancher/norman/resource"
2017-11-28 22:08:31 +00:00
"k8s.io/apimachinery/pkg/api/errors"
2017-11-11 04:44:02 +00:00
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
2017-11-28 22:08:31 +00:00
"k8s.io/apimachinery/pkg/labels"
2017-11-11 04:44:02 +00:00
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
2018-12-17 22:41:12 +00:00
"k8s.io/apimachinery/pkg/types"
2017-11-11 04:44:02 +00:00
"k8s.io/apimachinery/pkg/watch"
"k8s.io/client-go/tools/cache"
)
var (
{{.schema.CodeName}}GroupVersionKind = schema.GroupVersionKind{
2017-12-16 08:22:59 +00:00
Version: Version,
Group: GroupName,
2017-11-11 04:44:02 +00:00
Kind: "{{.schema.CodeName}}",
}
{{.schema.CodeName}}Resource = metav1.APIResource{
Name: "{{.schema.PluralName | toLower}}",
SingularName: "{{.schema.ID | toLower}}",
2017-11-28 21:28:25 +00:00
{{- if eq .schema.Scope "namespace" }}
Namespaced: true,
{{ else }}
2017-11-11 04:44:02 +00:00
Namespaced: false,
2017-11-28 21:28:25 +00:00
{{- end }}
2017-11-11 04:44:02 +00:00
Kind: {{.schema.CodeName}}GroupVersionKind.Kind,
}
{{.schema.CodeName}}GroupVersionResource = schema.GroupVersionResource{
Group: GroupName,
Version: Version,
Resource: "{{.schema.PluralName | toLower}}",
}
2017-11-11 04:44:02 +00:00
)
func init() {
resource.Put({{.schema.CodeName}}GroupVersionResource)
}
func New{{.schema.CodeName}}(namespace, name string, obj {{.prefix}}{{.schema.CodeName}}) *{{.prefix}}{{.schema.CodeName}} {
obj.APIVersion, obj.Kind = {{.schema.CodeName}}GroupVersionKind.ToAPIVersionAndKind()
obj.Name = name
obj.Namespace = namespace
return &obj
}
2017-11-12 00:07:09 +00:00
type {{.schema.CodeName}}List struct {
metav1.TypeMeta %BACK%json:",inline"%BACK%
2017-11-13 21:27:53 +00:00
metav1.ListMeta %BACK%json:"metadata,omitempty"%BACK%
Items []{{.prefix}}{{.schema.CodeName}} %BACK%json:"items"%BACK%
2017-11-12 00:07:09 +00:00
}
type {{.schema.CodeName}}HandlerFunc func(key string, obj *{{.prefix}}{{.schema.CodeName}}) (runtime.Object, error)
2017-11-28 21:28:25 +00:00
2018-11-19 23:30:00 +00:00
type {{.schema.CodeName}}ChangeHandlerFunc func(obj *{{.prefix}}{{.schema.CodeName}}) (runtime.Object, error)
2017-11-28 21:28:25 +00:00
type {{.schema.CodeName}}Lister interface {
List(namespace string, selector labels.Selector) (ret []*{{.prefix}}{{.schema.CodeName}}, err error)
Get(namespace, name string) (*{{.prefix}}{{.schema.CodeName}}, error)
}
2017-11-11 04:44:02 +00:00
type {{.schema.CodeName}}Controller interface {
Generic() controller.GenericController
2017-11-11 04:44:02 +00:00
Informer() cache.SharedIndexInformer
2017-11-28 21:28:25 +00:00
Lister() {{.schema.CodeName}}Lister
2018-10-30 16:54:49 +00:00
AddHandler(ctx context.Context, name string, handler {{.schema.CodeName}}HandlerFunc)
AddFeatureHandler(ctx context.Context, enabled func() bool, name string, sync {{.schema.CodeName}}HandlerFunc)
2018-10-30 16:54:49 +00:00
AddClusterScopedHandler(ctx context.Context, name, clusterName string, handler {{.schema.CodeName}}HandlerFunc)
AddClusterScopedFeatureHandler(ctx context.Context, enabled func() bool, name, clusterName string, handler {{.schema.CodeName}}HandlerFunc)
2017-11-11 04:44:02 +00:00
Enqueue(namespace, name string)
2020-02-06 04:15:26 +00:00
EnqueueAfter(namespace, name string, after time.Duration)
2017-11-28 21:28:25 +00:00
Sync(ctx context.Context) error
2017-11-21 23:16:45 +00:00
Start(ctx context.Context, threadiness int) error
2017-11-11 04:44:02 +00:00
}
type {{.schema.CodeName}}Interface interface {
2018-04-03 19:49:20 +00:00
ObjectClient() *objectclient.ObjectClient
2017-11-28 21:28:25 +00:00
Create(*{{.prefix}}{{.schema.CodeName}}) (*{{.prefix}}{{.schema.CodeName}}, error)
2018-01-18 23:22:36 +00:00
GetNamespaced(namespace, name string, opts metav1.GetOptions) (*{{.prefix}}{{.schema.CodeName}}, error)
2017-11-28 21:28:25 +00:00
Get(name string, opts metav1.GetOptions) (*{{.prefix}}{{.schema.CodeName}}, error)
Update(*{{.prefix}}{{.schema.CodeName}}) (*{{.prefix}}{{.schema.CodeName}}, error)
2017-11-11 04:44:02 +00:00
Delete(name string, options *metav1.DeleteOptions) error
2018-01-18 23:22:36 +00:00
DeleteNamespaced(namespace, name string, options *metav1.DeleteOptions) error
2017-11-29 21:27:02 +00:00
List(opts metav1.ListOptions) (*{{.schema.CodeName}}List, error)
ListNamespaced(namespace string, opts metav1.ListOptions) (*{{.schema.CodeName}}List, error)
2017-11-11 04:44:02 +00:00
Watch(opts metav1.ListOptions) (watch.Interface, error)
DeleteCollection(deleteOpts *metav1.DeleteOptions, listOpts metav1.ListOptions) error
2017-11-13 19:50:25 +00:00
Controller() {{.schema.CodeName}}Controller
2018-10-30 16:54:49 +00:00
AddHandler(ctx context.Context, name string, sync {{.schema.CodeName}}HandlerFunc)
AddFeatureHandler(ctx context.Context, enabled func() bool, name string, sync {{.schema.CodeName}}HandlerFunc)
2018-10-30 16:54:49 +00:00
AddLifecycle(ctx context.Context, name string, lifecycle {{.schema.CodeName}}Lifecycle)
AddFeatureLifecycle(ctx context.Context, enabled func() bool, name string, lifecycle {{.schema.CodeName}}Lifecycle)
2018-10-30 16:54:49 +00:00
AddClusterScopedHandler(ctx context.Context, name, clusterName string, sync {{.schema.CodeName}}HandlerFunc)
AddClusterScopedFeatureHandler(ctx context.Context, enabled func() bool, name, clusterName string, sync {{.schema.CodeName}}HandlerFunc)
2018-10-30 16:54:49 +00:00
AddClusterScopedLifecycle(ctx context.Context, name, clusterName string, lifecycle {{.schema.CodeName}}Lifecycle)
AddClusterScopedFeatureLifecycle(ctx context.Context, enabled func() bool, name, clusterName string, lifecycle {{.schema.CodeName}}Lifecycle)
2017-11-11 04:44:02 +00:00
}
2017-11-28 21:28:25 +00:00
type {{.schema.ID}}Lister struct {
controller *{{.schema.ID}}Controller
}
func (l *{{.schema.ID}}Lister) List(namespace string, selector labels.Selector) (ret []*{{.prefix}}{{.schema.CodeName}}, err error) {
err = cache.ListAllByNamespace(l.controller.Informer().GetIndexer(), namespace, selector, func(obj interface{}) {
ret = append(ret, obj.(*{{.prefix}}{{.schema.CodeName}}))
})
return
}
func (l *{{.schema.ID}}Lister) Get(namespace, name string) (*{{.prefix}}{{.schema.CodeName}}, error) {
2017-12-12 03:25:05 +00:00
var key string
if namespace != "" {
key = namespace + "/" + name
} else {
key = name
}
obj, exists, err := l.controller.Informer().GetIndexer().GetByKey(key)
2017-11-28 21:28:25 +00:00
if err != nil {
return nil, err
}
if !exists {
2017-11-28 22:08:31 +00:00
return nil, errors.NewNotFound(schema.GroupResource{
Group: {{.schema.CodeName}}GroupVersionKind.Group,
Resource: "{{.schema.ID}}",
2018-06-21 23:06:20 +00:00
}, key)
2017-11-28 21:28:25 +00:00
}
return obj.(*{{.prefix}}{{.schema.CodeName}}), nil
}
2017-11-11 04:44:02 +00:00
type {{.schema.ID}}Controller struct {
controller.GenericController
}
func (c *{{.schema.ID}}Controller) Generic() controller.GenericController {
return c.GenericController
}
2017-11-28 21:28:25 +00:00
func (c *{{.schema.ID}}Controller) Lister() {{.schema.CodeName}}Lister {
return &{{.schema.ID}}Lister{
controller: c,
}
}
2018-10-30 16:54:49 +00:00
func (c *{{.schema.ID}}Controller) AddHandler(ctx context.Context, name string, handler {{.schema.CodeName}}HandlerFunc) {
c.GenericController.AddHandler(ctx, name, func(key string, obj interface{}) (interface{}, error) {
if obj == nil {
2017-11-11 04:44:02 +00:00
return handler(key, nil)
2018-10-30 16:54:49 +00:00
} else if v, ok := obj.(*{{.prefix}}{{.schema.CodeName}}); ok {
return handler(key, v)
} else {
return nil, nil
2017-11-11 04:44:02 +00:00
}
})
}
func (c *{{.schema.ID}}Controller) AddFeatureHandler(ctx context.Context, enabled func() bool, name string, handler {{.schema.CodeName}}HandlerFunc) {
c.GenericController.AddHandler(ctx, name, func(key string, obj interface{}) (interface{}, error) {
if !enabled() {
return nil, nil
} else if obj == nil {
return handler(key, nil)
} else if v, ok := obj.(*{{.prefix}}{{.schema.CodeName}}); ok {
return handler(key, v)
} else {
return nil, nil
}
})
}
2018-10-30 16:54:49 +00:00
func (c *{{.schema.ID}}Controller) AddClusterScopedHandler(ctx context.Context, name, cluster string, handler {{.schema.CodeName}}HandlerFunc) {
c.GenericController.AddHandler(ctx, name, func(key string, obj interface{}) (interface{}, error) {
if obj == nil {
return handler(key, nil)
2018-10-30 16:54:49 +00:00
} else if v, ok := obj.(*{{.prefix}}{{.schema.CodeName}}); ok && controller.ObjectInCluster(cluster, obj) {
return handler(key, v)
} else {
return nil, nil
}
})
}
func (c *{{.schema.ID}}Controller) AddClusterScopedFeatureHandler(ctx context.Context, enabled func() bool, name, cluster string, handler {{.schema.CodeName}}HandlerFunc) {
c.GenericController.AddHandler(ctx, name, func(key string, obj interface{}) (interface{}, error) {
if !enabled() {
return nil, nil
} else if obj == nil {
return handler(key, nil)
} else if v, ok := obj.(*{{.prefix}}{{.schema.CodeName}}); ok && controller.ObjectInCluster(cluster, obj) {
return handler(key, v)
} else {
return nil, nil
}
})
}
2017-11-11 04:44:02 +00:00
type {{.schema.ID}}Factory struct {
}
func (c {{.schema.ID}}Factory) Object() runtime.Object {
2017-11-28 21:28:25 +00:00
return &{{.prefix}}{{.schema.CodeName}}{}
2017-11-11 04:44:02 +00:00
}
func (c {{.schema.ID}}Factory) List() runtime.Object {
return &{{.schema.CodeName}}List{}
}
2017-11-13 19:50:25 +00:00
func (s *{{.schema.ID}}Client) Controller() {{.schema.CodeName}}Controller {
s.client.Lock()
defer s.client.Unlock()
2017-11-11 04:44:02 +00:00
2017-11-13 19:50:25 +00:00
c, ok := s.client.{{.schema.ID}}Controllers[s.ns]
if ok {
return c
2017-11-11 04:44:02 +00:00
}
2017-11-13 19:50:25 +00:00
genericController := controller.NewGenericController({{.schema.CodeName}}GroupVersionKind.Kind+"Controller",
2017-11-11 04:44:02 +00:00
s.objectClient)
2017-11-13 19:50:25 +00:00
c = &{{.schema.ID}}Controller{
GenericController: genericController,
2017-11-11 04:44:02 +00:00
}
2017-11-13 19:50:25 +00:00
s.client.{{.schema.ID}}Controllers[s.ns] = c
2017-11-28 21:28:25 +00:00
s.client.starters = append(s.client.starters, c)
2017-11-13 19:50:25 +00:00
return c
2017-11-11 04:44:02 +00:00
}
type {{.schema.ID}}Client struct {
2017-11-13 19:50:25 +00:00
client *Client
ns string
2018-04-03 19:49:20 +00:00
objectClient *objectclient.ObjectClient
2017-11-11 04:44:02 +00:00
controller {{.schema.CodeName}}Controller
}
2018-04-03 19:49:20 +00:00
func (s *{{.schema.ID}}Client) ObjectClient() *objectclient.ObjectClient {
2017-11-28 21:28:25 +00:00
return s.objectClient
}
func (s *{{.schema.ID}}Client) Create(o *{{.prefix}}{{.schema.CodeName}}) (*{{.prefix}}{{.schema.CodeName}}, error) {
2017-11-11 04:44:02 +00:00
obj, err := s.objectClient.Create(o)
2017-11-28 21:28:25 +00:00
return obj.(*{{.prefix}}{{.schema.CodeName}}), err
2017-11-11 04:44:02 +00:00
}
2017-11-28 21:28:25 +00:00
func (s *{{.schema.ID}}Client) Get(name string, opts metav1.GetOptions) (*{{.prefix}}{{.schema.CodeName}}, error) {
2017-11-11 04:44:02 +00:00
obj, err := s.objectClient.Get(name, opts)
2017-11-28 21:28:25 +00:00
return obj.(*{{.prefix}}{{.schema.CodeName}}), err
2017-11-11 04:44:02 +00:00
}
2018-01-18 23:22:36 +00:00
func (s *{{.schema.ID}}Client) GetNamespaced(namespace, name string, opts metav1.GetOptions) (*{{.prefix}}{{.schema.CodeName}}, error) {
obj, err := s.objectClient.GetNamespaced(namespace, name, opts)
return obj.(*{{.prefix}}{{.schema.CodeName}}), err
}
2017-11-28 21:28:25 +00:00
func (s *{{.schema.ID}}Client) Update(o *{{.prefix}}{{.schema.CodeName}}) (*{{.prefix}}{{.schema.CodeName}}, error) {
2017-11-11 04:44:02 +00:00
obj, err := s.objectClient.Update(o.Name, o)
2017-11-28 21:28:25 +00:00
return obj.(*{{.prefix}}{{.schema.CodeName}}), err
2017-11-11 04:44:02 +00:00
}
func (s *{{.schema.ID}}Client) Delete(name string, options *metav1.DeleteOptions) error {
return s.objectClient.Delete(name, options)
}
2018-01-18 23:22:36 +00:00
func (s *{{.schema.ID}}Client) DeleteNamespaced(namespace, name string, options *metav1.DeleteOptions) error {
return s.objectClient.DeleteNamespaced(namespace, name, options)
}
2017-11-29 21:27:02 +00:00
func (s *{{.schema.ID}}Client) List(opts metav1.ListOptions) (*{{.schema.CodeName}}List, error) {
2017-11-11 04:44:02 +00:00
obj, err := s.objectClient.List(opts)
2017-11-29 21:27:02 +00:00
return obj.(*{{.schema.CodeName}}List), err
2017-11-11 04:44:02 +00:00
}
func (s *{{.schema.ID}}Client) ListNamespaced(namespace string, opts metav1.ListOptions) (*{{.schema.CodeName}}List, error) {
obj, err := s.objectClient.ListNamespaced(namespace, opts)
return obj.(*{{.schema.CodeName}}List), err
}
2017-11-11 04:44:02 +00:00
func (s *{{.schema.ID}}Client) Watch(opts metav1.ListOptions) (watch.Interface, error) {
return s.objectClient.Watch(opts)
}
2017-12-23 06:09:40 +00:00
// Patch applies the patch and returns the patched deployment.
func (s *{{.schema.ID}}Client) Patch(o *{{.prefix}}{{.schema.CodeName}}, patchType types.PatchType, data []byte, subresources ...string) (*{{.prefix}}{{.schema.CodeName}}, error) {
obj, err := s.objectClient.Patch(o.Name, o, patchType, data, subresources...)
2017-12-23 06:09:40 +00:00
return obj.(*{{.prefix}}{{.schema.CodeName}}), err
}
2017-11-11 04:44:02 +00:00
func (s *{{.schema.ID}}Client) DeleteCollection(deleteOpts *metav1.DeleteOptions, listOpts metav1.ListOptions) error {
return s.objectClient.DeleteCollection(deleteOpts, listOpts)
}
2017-12-16 08:22:59 +00:00
2018-10-30 16:54:49 +00:00
func (s *{{.schema.ID}}Client) AddHandler(ctx context.Context, name string, sync {{.schema.CodeName}}HandlerFunc) {
s.Controller().AddHandler(ctx, name, sync)
2017-12-16 08:22:59 +00:00
}
func (s *{{.schema.ID}}Client) AddFeatureHandler(ctx context.Context, enabled func() bool, name string, sync {{.schema.CodeName}}HandlerFunc) {
s.Controller().AddFeatureHandler(ctx, enabled, name, sync)
}
2018-10-30 16:54:49 +00:00
func (s *{{.schema.ID}}Client) AddLifecycle(ctx context.Context, name string, lifecycle {{.schema.CodeName}}Lifecycle) {
sync := New{{.schema.CodeName}}LifecycleAdapter(name, false, s, lifecycle)
2018-10-30 16:54:49 +00:00
s.Controller().AddHandler(ctx, name, sync)
2017-12-16 08:22:59 +00:00
}
func (s *{{.schema.ID}}Client) AddFeatureLifecycle(ctx context.Context, enabled func() bool, name string, lifecycle {{.schema.CodeName}}Lifecycle) {
sync := New{{.schema.CodeName}}LifecycleAdapter(name, false, s, lifecycle)
s.Controller().AddFeatureHandler(ctx, enabled, name, sync)
}
2018-10-30 16:54:49 +00:00
func (s *{{.schema.ID}}Client) AddClusterScopedHandler(ctx context.Context, name, clusterName string, sync {{.schema.CodeName}}HandlerFunc) {
s.Controller().AddClusterScopedHandler(ctx, name, clusterName, sync)
}
func (s *{{.schema.ID}}Client) AddClusterScopedFeatureHandler(ctx context.Context, enabled func() bool, name, clusterName string, sync {{.schema.CodeName}}HandlerFunc) {
s.Controller().AddClusterScopedFeatureHandler(ctx, enabled, name, clusterName, sync)
}
2018-10-30 16:54:49 +00:00
func (s *{{.schema.ID}}Client) AddClusterScopedLifecycle(ctx context.Context, name, clusterName string, lifecycle {{.schema.CodeName}}Lifecycle) {
sync := New{{.schema.CodeName}}LifecycleAdapter(name+"_"+clusterName, true, s, lifecycle)
2018-10-30 16:54:49 +00:00
s.Controller().AddClusterScopedHandler(ctx, name, clusterName, sync)
}
2018-11-19 23:30:00 +00:00
func (s *{{.schema.ID}}Client) AddClusterScopedFeatureLifecycle(ctx context.Context, enabled func() bool, name, clusterName string, lifecycle {{.schema.CodeName}}Lifecycle) {
sync := New{{.schema.CodeName}}LifecycleAdapter(name+"_"+clusterName, true, s, lifecycle)
s.Controller().AddClusterScopedFeatureHandler(ctx, enabled, name, clusterName, sync)
}
2017-11-11 04:44:02 +00:00
`