Template mixins

pkg/model/file/template.go

@@ -16,6 +16,10 @@ limitations under the License.
 
 package file
 
+import (
+	"sigs.k8s.io/kubebuilder/pkg/model/resource"
+)
+
 // Input is the input for scaffolding a file
 type Input struct {
 	// Path is the file to write
@@ -26,68 +30,98 @@ type Input struct {
 
 	// TemplateBody is the template body to execute
 	TemplateBody string
+}
 
-	// Boilerplate is the contents of a Boilerplate go header file
-	Boilerplate string
+// HasDomain allows the domain to be used on a template
+type HasDomain interface {
+	// InjectDomain sets the template domain
+	InjectDomain(string)
+}
 
+// DomainMixin provides templates with a injectable domain field
+type DomainMixin struct {
 	// Domain is the domain for the APIs
 	Domain string
+}
 
-	// Repo is the go project package
-	Repo string
+// InjectDomain implements HasDomain
+func (m *DomainMixin) InjectDomain(domain string) {
+	if m.Domain == "" {
+		m.Domain = domain
+	}
+}
 
-	// MultiGroup is the multi-group boolean from the PROJECT file
-	MultiGroup bool
+// HasRepository allows the repository to be used on a template
+type HasRepository interface {
+	// InjectRepository sets the template repository
+	InjectRepository(string)
 }
 
-// Domain allows a domain to be set on an object
-type Domain interface {
-	// SetDomain sets the domain
-	SetDomain(string)
+// RepositoryMixin provides templates with a injectable repository field
+type RepositoryMixin struct {
+	// Repo is the go project package path
+	Repo string
 }
 
-// SetDomain sets the domain
-func (i *Input) SetDomain(d string) {
-	if i.Domain == "" {
-		i.Domain = d
+// InjectRepository implements HasRepository
+func (m *RepositoryMixin) InjectRepository(repository string) {
+	if m.Repo == "" {
+		m.Repo = repository
 	}
 }
 
-// Repo allows a repo to be set on an object
-type Repo interface {
-	// SetRepo sets the repo
-	SetRepo(string)
+// HasMultiGroup allows the multi-group flag to be used on a template
+type HasMultiGroup interface {
+	// InjectMultiGroup sets the template multi-group flag
+	InjectMultiGroup(bool)
 }
 
-// SetRepo sets the repo
-func (i *Input) SetRepo(r string) {
-	if i.Repo == "" {
-		i.Repo = r
-	}
+// MultiGroupMixin provides templates with a injectable multi-group flag field
+type MultiGroupMixin struct {
+	// MultiGroup is the multi-group flag
+	MultiGroup bool
+}
+
+// InjectMultiGroup implements HasMultiGroup
+func (m *MultiGroupMixin) InjectMultiGroup(flag bool) {
+	m.MultiGroup = flag
 }
 
-// Boilerplate allows boilerplate text to be set on an object
-type Boilerplate interface {
-	// SetBoilerplate sets the boilerplate text
-	SetBoilerplate(string)
+// HasBoilerplate allows a boilerplate to be used on a template
+type HasBoilerplate interface {
+	// InjectBoilerplate sets the template boilerplate
+	InjectBoilerplate(string)
 }
 
-// SetBoilerplate sets the boilerplate text
-func (i *Input) SetBoilerplate(b string) {
-	if i.Boilerplate == "" {
-		i.Boilerplate = b
+// BoilerplateMixin provides templates with a injectable boilerplate field
+type BoilerplateMixin struct {
+	// Boilerplate is the contents of a Boilerplate go header file
+	Boilerplate string
+}
+
+// InjectBoilerplate implements HasBoilerplate
+func (m *BoilerplateMixin) InjectBoilerplate(boilerplate string) {
+	if m.Boilerplate == "" {
+		m.Boilerplate = boilerplate
 	}
 }
 
-// MultiGroup allows the project version to be set on an object
-type MultiGroup interface {
-	// SetVersion sets the project version
-	SetMultiGroup(value bool)
+// HasResource allows a resource to be used on a template
+type HasResource interface {
+	// InjectResource sets the template resource
+	InjectResource(*resource.Resource)
 }
 
-// SetVersion sets the MultiGroup value
-func (i *Input) SetMultiGroup(v bool) {
-	i.MultiGroup = v
+// ResourceMixin provides templates with a injectable resource field
+type ResourceMixin struct {
+	Resource *resource.Resource
+}
+
+// InjectResource implements HasResource
+func (m *ResourceMixin) InjectResource(res *resource.Resource) {
+	if m.Resource == nil {
+		m.Resource = res
+	}
 }
 
 // Template is a scaffoldable file template

pkg/model/universe.go

@@ -81,18 +81,24 @@ func WithResource(resource *resource.Resource) UniverseOption {
 func (u Universe) InjectInto(t file.Template) {
 	// Inject project configuration
 	if u.Config != nil {
-		if templateWithDomain, ok := t.(file.Domain); ok {
-			templateWithDomain.SetDomain(u.Config.Domain)
+		if templateWithDomain, hasDomain := t.(file.HasDomain); hasDomain {
+			templateWithDomain.InjectDomain(u.Config.Domain)
 		}
-		if templateWithRepository, ok := t.(file.Repo); ok {
-			templateWithRepository.SetRepo(u.Config.Repo)
+		if templateWithRepository, hasRepository := t.(file.HasRepository); hasRepository {
+			templateWithRepository.InjectRepository(u.Config.Repo)
 		}
-		if templateWithMultiGroup, ok := t.(file.MultiGroup); ok {
-			templateWithMultiGroup.SetMultiGroup(u.Config.MultiGroup)
+		if templateWithMultiGroup, hasMultiGroup := t.(file.HasMultiGroup); hasMultiGroup {
+			templateWithMultiGroup.InjectMultiGroup(u.Config.MultiGroup)
 		}
 	}
 	// Inject boilerplate
-	if templateWithBoilerplate, ok := t.(file.Boilerplate); ok {
-		templateWithBoilerplate.SetBoilerplate(u.Boilerplate)
+	if templateWithBoilerplate, hasBoilerplate := t.(file.HasBoilerplate); hasBoilerplate {
+		templateWithBoilerplate.InjectBoilerplate(u.Boilerplate)
+	}
+	// Inject resource
+	if u.Resource != nil {
+		if templateWithResource, hasResource := t.(file.HasResource); hasResource {
+			templateWithResource.InjectResource(u.Resource)
+		}
 	}
 }

pkg/scaffold/api.go

@@ -93,14 +93,14 @@ func (s *apiScaffolder) scaffoldV1() error {
 
 		if err := machinery.NewScaffold().Execute(
 			s.newUniverse(),
-			&crdv1.Register{Resource: s.resource},
-			&crdv1.Types{Resource: s.resource},
-			&crdv1.VersionSuiteTest{Resource: s.resource},
-			&crdv1.TypesTest{Resource: s.resource},
-			&crdv1.Doc{Resource: s.resource},
-			&crdv1.Group{Resource: s.resource},
-			&crdv1.AddToScheme{Resource: s.resource},
-			&crdv1.CRDSample{Resource: s.resource},
+			&crdv1.Register{},
+			&crdv1.Types{},
+			&crdv1.VersionSuiteTest{},
+			&crdv1.TypesTest{},
+			&crdv1.Doc{},
+			&crdv1.Group{},
+			&crdv1.AddToScheme{},
+			&crdv1.CRDSample{},
 		); err != nil {
 			return fmt.Errorf("error scaffolding APIs: %v", err)
 		}
@@ -120,10 +120,10 @@ func (s *apiScaffolder) scaffoldV1() error {
 
 		if err := machinery.NewScaffold().Execute(
 			s.newUniverse(),
-			&controllerv1.Controller{Resource: s.resource},
-			&controllerv1.AddController{Resource: s.resource},
-			&controllerv1.Test{Resource: s.resource},
-			&controllerv1.SuiteTest{Resource: s.resource},
+			&controllerv1.Controller{},
+			&controllerv1.AddController{},
+			&controllerv1.Test{},
+			&controllerv1.SuiteTest{},
 		); err != nil {
 			return fmt.Errorf("error scaffolding controller: %v", err)
 		}
@@ -151,18 +151,18 @@ func (s *apiScaffolder) scaffoldV2() error {
 
 		if err := machinery.NewScaffold(s.plugins...).Execute(
 			s.newUniverse(),
-			&templatesv2.Types{Resource: s.resource},
-			&templatesv2.Group{Resource: s.resource},
-			&templatesv2.CRDSample{Resource: s.resource},
-			&templatesv2.CRDEditorRole{Resource: s.resource},
-			&templatesv2.CRDViewerRole{Resource: s.resource},
-			&crdv2.EnableWebhookPatch{Resource: s.resource},
-			&crdv2.EnableCAInjectionPatch{Resource: s.resource},
+			&templatesv2.Types{},
+			&templatesv2.Group{},
+			&templatesv2.CRDSample{},
+			&templatesv2.CRDEditorRole{},
+			&templatesv2.CRDViewerRole{},
+			&crdv2.EnableWebhookPatch{},
+			&crdv2.EnableCAInjectionPatch{},
 		); err != nil {
 			return fmt.Errorf("error scaffolding APIs: %v", err)
 		}
 
-		kustomizationFile := &crdv2.Kustomization{Resource: s.resource}
+		kustomizationFile := &crdv2.Kustomization{}
 		if err := machinery.NewScaffold().Execute(
 			s.newUniverse(),
 			kustomizationFile,
@@ -192,11 +192,11 @@ func (s *apiScaffolder) scaffoldV2() error {
 				fmt.Sprintf("%s_controller.go", strings.ToLower(s.resource.Kind))))
 		}
 
-		suiteTestFile := &controllerv2.SuiteTest{Resource: s.resource}
+		suiteTestFile := &controllerv2.SuiteTest{}
 		if err := machinery.NewScaffold(s.plugins...).Execute(
 			s.newUniverse(),
 			suiteTestFile,
-			&controllerv2.Controller{Resource: s.resource},
+			&controllerv2.Controller{},
 		); err != nil {
 			return fmt.Errorf("error scaffolding controller: %v", err)
 		}

pkg/scaffold/internal/templates/v1/boilerplate.go

@@ -29,6 +29,7 @@ var _ file.Template = &Boilerplate{}
 // Boilerplate scaffolds a boilerplate header file.
 type Boilerplate struct {
 	file.Input
+	file.BoilerplateMixin
 
 	// License is the License type to write
 	License string

pkg/scaffold/internal/templates/v1/controller/add.go

@@ -22,17 +22,16 @@ import (
 	"strings"
 
 	"sigs.k8s.io/kubebuilder/pkg/model/file"
-	"sigs.k8s.io/kubebuilder/pkg/model/resource"
 )
 
 var _ file.Template = &AddController{}
 
 // AddController scaffolds adds a new Controller.
 type AddController struct {
 	file.Input
-
-	// Resource is a resource in the API group
-	Resource *resource.Resource
+	file.RepositoryMixin
+	file.BoilerplateMixin
+	file.ResourceMixin
 }
 
 // GetInput implements input.Template

pkg/scaffold/internal/templates/v1/controller/controller.go

@@ -21,17 +21,15 @@ import (
 	"strings"
 
 	"sigs.k8s.io/kubebuilder/pkg/model/file"
-	"sigs.k8s.io/kubebuilder/pkg/model/resource"
 )
 
 var _ file.Template = &Controller{}
 
 // Controller scaffolds a Controller for a Resource
 type Controller struct {
 	file.Input
-
-	// Resource is the Resource to make the Controller for
-	Resource *resource.Resource
+	file.BoilerplateMixin
+	file.ResourceMixin
 }
 
 // GetInput implements input.Template

pkg/scaffold/internal/templates/v1/controller/controllersuitetest.go

@@ -21,17 +21,16 @@ import (
 	"strings"
 
 	"sigs.k8s.io/kubebuilder/pkg/model/file"
-	"sigs.k8s.io/kubebuilder/pkg/model/resource"
 )
 
 var _ file.Template = &SuiteTest{}
 
 // SuiteTest scaffolds a SuiteTest
 type SuiteTest struct {
 	file.Input
-
-	// Resource is the Resource to make the Controller for
-	Resource *resource.Resource
+	file.RepositoryMixin
+	file.BoilerplateMixin
+	file.ResourceMixin
 }
 
 // GetInput implements input.Template

pkg/scaffold/internal/templates/v1/controller/controllertest.go

@@ -21,17 +21,15 @@ import (
 	"strings"
 
 	"sigs.k8s.io/kubebuilder/pkg/model/file"
-	"sigs.k8s.io/kubebuilder/pkg/model/resource"
 )
 
 var _ file.Template = &Test{}
 
 // Test scaffolds a Controller Test
 type Test struct {
 	file.Input
-
-	// Resource is the Resource to make the Controller for
-	Resource *resource.Resource
+	file.BoilerplateMixin
+	file.ResourceMixin
 }
 
 // GetInput implements input.Template

pkg/scaffold/internal/templates/v1/crd/addtoscheme.go

@@ -21,17 +21,15 @@ import (
 	"path/filepath"
 
 	"sigs.k8s.io/kubebuilder/pkg/model/file"
-	"sigs.k8s.io/kubebuilder/pkg/model/resource"
 )
 
 var _ file.Template = &AddToScheme{}
 
 // AddToScheme scaffolds the code to add the resource to a SchemeBuilder.
 type AddToScheme struct {
 	file.Input
-
-	// Resource is a resource in the API group
-	Resource *resource.Resource
+	file.BoilerplateMixin
+	file.ResourceMixin
 }
 
 // GetInput implements input.Template

pkg/scaffold/internal/templates/v1/crd/crd_sample.go

@@ -22,7 +22,6 @@ import (
 	"strings"
 
 	"sigs.k8s.io/kubebuilder/pkg/model/file"
-	"sigs.k8s.io/kubebuilder/pkg/model/resource"
 )
 
 var _ file.Template = &CRDSample{}
@@ -31,9 +30,7 @@ var _ file.Template = &CRDSample{}
 // nolint:golint
 type CRDSample struct {
 	file.Input
-
-	// Resource is a resource in the API group
-	Resource *resource.Resource
+	file.ResourceMixin
 }
 
 // GetInput implements input.Template