Merge pull request #1265 from Adirio/scaffold-enhancement/split-fields-validation

Split injecting fields and validating files

Author: k8s-ci-robot

pkg/scaffold/input/input.go

@@ -158,8 +158,9 @@ type File interface {
 	GetInput() (Input, error)
 }
 
-// Validate validates input
-type Validate interface {
+// RequiresValidation is a file that requires validation
+type RequiresValidation interface {
+	File
 	// Validate returns true if the template has valid values
 	Validate() error
 }

pkg/scaffold/scaffold.go

@@ -75,7 +75,7 @@ type Plugin interface {
 	Pipe(u *model.Universe) error
 }
 
-func (s *Scaffold) setFieldsAndValidate(t input.File) error {
+func (s *Scaffold) setFields(t input.File) {
 	// Set boilerplate on templates
 	if b, ok := t.(input.BoilerplatePath); ok {
 		b.SetBoilerplatePath(s.BoilerplatePath)
@@ -98,12 +98,13 @@ func (s *Scaffold) setFieldsAndValidate(t input.File) error {
 	if b, ok := t.(input.MultiGroup); ok {
 		b.SetMultiGroup(s.Project.MultiGroup)
 	}
-	// Validate the template is ok
-	if v, ok := t.(input.Validate); ok {
-		if err := v.Validate(); err != nil {
-			return err
-		}
+}
+
+func (_ *Scaffold) validate(file input.File) error {
+	if reqValFile, ok := file.(input.RequiresValidation); ok {
+		return reqValFile.Validate()
 	}
+
 	return nil
 }
 
@@ -234,8 +235,10 @@ func isAlreadyExistsError(e error) bool {
 // doFile scaffolds a single file
 func (s *Scaffold) buildFileModel(e input.File) (*model.File, error) {
 	// Set common fields
-	err := s.setFieldsAndValidate(e)
-	if err != nil {
+	s.setFields(e)
+
+	// Validate the file scaffold
+	if err := s.validate(e); err != nil {
 		return nil, err
 	}
 

pkg/scaffold/v2/controller/controller_suitetest.go

@@ -23,7 +23,7 @@ import (
 	"sigs.k8s.io/kubebuilder/pkg/scaffold/input"
 	"sigs.k8s.io/kubebuilder/pkg/scaffold/resource"
 	"sigs.k8s.io/kubebuilder/pkg/scaffold/util"
-	"sigs.k8s.io/kubebuilder/pkg/scaffold/v2"
+	scaffoldv2 "sigs.k8s.io/kubebuilder/pkg/scaffold/v2"
 	"sigs.k8s.io/kubebuilder/pkg/scaffold/v2/internal"
 )
 
@@ -140,8 +140,8 @@ Expect(err).NotTo(HaveOccurred())
 
 	err := internal.InsertStringsInFile(a.Path,
 		map[string][]string{
-			v2.ApiPkgImportScaffoldMarker: []string{ctrlImportCodeFragment, apiImportCodeFragment},
-			v2.ApiSchemeScaffoldMarker:    []string{addschemeCodeFragment},
+			scaffoldv2.ApiPkgImportScaffoldMarker: []string{ctrlImportCodeFragment, apiImportCodeFragment},
+			scaffoldv2.ApiSchemeScaffoldMarker:    []string{addschemeCodeFragment},
 		})
 	if err != nil {
 		return err