knative.dev/pkg@v0.0.0-20260602142205-ac97e43f6622/codegen/cmd/injection-gen/generators/reconciler/reconciler_controller_stub.go

/*
Copyright 2020 The Knative 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 reconciler

import (
	"io"

	"k8s.io/gengo/v2/generator"
	"k8s.io/gengo/v2/namer"
	"k8s.io/gengo/v2/types"
	"k8s.io/klog/v2"
)

// reconcilerControllerStubGenerator produces a file of the stub of the
// controller for a custom impl with injection.
type reconcilerControllerStubGenerator struct {
	generator.GoGenerator
	outputPackage  string
	imports        namer.ImportTracker
	typeToGenerate *types.Type

	reconcilerPkg       string
	informerPackagePath string
	reconcilerClasses   []string
	hasReconcilerClass  bool
}

var _ generator.Generator = (*reconcilerControllerStubGenerator)(nil)

func (g *reconcilerControllerStubGenerator) Filter(c *generator.Context, t *types.Type) bool {
	// Only process the type for this generator.
	return t == g.typeToGenerate
}

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

func (g *reconcilerControllerStubGenerator) Imports(c *generator.Context) (imports []string) {
	imports = append(imports, g.imports.ImportLines()...)
	return imports
}

func (g *reconcilerControllerStubGenerator) GenerateType(c *generator.Context, t *types.Type, w io.Writer) error {
	sw := generator.NewSnippetWriter(w, c, "{{", "}}")

	klog.V(5).Info("processing type ", t)

	m := map[string]interface{}{
		"type":     t,
		"classes":  g.reconcilerClasses,
		"hasClass": g.hasReconcilerClass,
		"informerGet": c.Universe.Function(types.Name{
			Package: g.informerPackagePath,
			Name:    "Get",
		}),
		"controllerImpl": c.Universe.Type(types.Name{Package: "knative.dev/pkg/controller", Name: "Impl"}),
		"reconcilerNewImpl": c.Universe.Type(types.Name{
			Package: g.reconcilerPkg,
			Name:    "NewImpl",
		}),
		"loggingFromContext": c.Universe.Function(types.Name{
			Package: "knative.dev/pkg/logging",
			Name:    "FromContext",
		}),
		"contextContext": c.Universe.Type(types.Name{
			Package: "context",
			Name:    "Context",
		}),
		"configmapWatcher": c.Universe.Type(types.Name{
			Package: "knative.dev/pkg/configmap",
			Name:    "Watcher",
		}),
		"classAnnotationKey": c.Universe.Variable(types.Name{
			Package: g.reconcilerPkg,
			Name:    "ClassAnnotationKey",
		}),
		"classAnnotationKeys": c.Universe.Variable(types.Name{
			Package: g.reconcilerPkg,
			Name:    "ClassAnnotationKeys",
		}),
		"annotationFilterFunc": c.Universe.Function(types.Name{
			Package: "knative.dev/pkg/reconciler",
			Name:    "AnnotationFilterFunc",
		}),
		"orFilterFunc": c.Universe.Function(types.Name{
			Package: "knative.dev/pkg/reconciler",
			Name:    "Or",
		}),
		"filterHandler": c.Universe.Type(types.Name{
			Package: "k8s.io/client-go/tools/cache",
			Name:    "FilteringResourceEventHandler",
		}),
	}

	sw.Do(reconcilerControllerStub, m)

	return sw.Error()
}

var reconcilerControllerStub = `
// TODO: PLEASE COPY AND MODIFY THIS FILE AS A STARTING POINT

// NewController creates a Reconciler for {{.type|public}} and returns the result of NewImpl.
func NewController(
	ctx {{.contextContext|raw}},
	cmw {{.configmapWatcher|raw}},
) *{{.controllerImpl|raw}} {
	logger := {{.loggingFromContext|raw}}(ctx)

	{{.type|lowercaseSingular}}Informer := {{.informerGet|raw}}(ctx)

	{{if .hasClass}}
	classValue := "default" // TODO: update this to the appropriate value.
	{{if len .classes | eq 1 }}
	classFilter := {{.annotationFilterFunc|raw}}({{.classAnnotationKey|raw}}, classValue, false /*allowUnset*/)
	{{else if gt (len .classes) 1 }}
	filterFuncs := make([]func(interface{}) bool, 0, len({{.classAnnotationKeys|raw}}))

	for _, key := range {{.classAnnotationKeys|raw}} {
		filterFuncs = append(filterFuncs, {{.annotationFilterFunc|raw}}(key, classValue, false /*allowUnset*/))
	}

	classFilter := {{.orFilterFunc|raw}}(filterFuncs...)
	{{end}}
	{{end}}

	// TODO: setup additional informers here.
	{{if .hasClass}}// TODO: remember to use the classFilter from above to filter appropriately.{{end}}

	r := &Reconciler{}
	impl := {{.reconcilerNewImpl|raw}}(ctx, r{{if .hasClass}}, classValue{{end}})

	logger.Info("Setting up event handlers.")

	{{if .hasClass}}
	{{.type|lowercaseSingular}}Informer.Informer().AddEventHandler({{.filterHandler|raw}}{
		FilterFunc: classFilter,
		Handler:    controller.HandleAll(impl.Enqueue),
	})
	{{else}}
	{{.type|lowercaseSingular}}Informer.Informer().AddEventHandler(controller.HandleAll(impl.Enqueue))
	{{end}}

	// TODO: add additional informer event handlers here.

	return impl
}
`