Merge pull request #1309 from dongjiang1989/update-importas

🌱chore: update importas in golangci config

Author: k8s-ci-robot

.golangci.yml

@@ -64,6 +64,19 @@ linters:
         - shadow
       enable-all: true
     importas:
+      alias:
+        - pkg: k8s.io/api/core/v1
+          alias: corev1
+        - pkg: k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1
+          alias: apiextensionsv1
+        - pkg: k8s.io/apimachinery/pkg/apis/meta/v1
+          alias: metav1
+        - pkg: k8s.io/apimachinery/pkg/api/errors
+          alias: apierrors
+        - pkg: k8s.io/apimachinery/pkg/util/errors
+          alias: kerrors
+        - pkg: sigs.k8s.io/controller-runtime
+          alias: ctrl
       no-unaliased: true
     revive:
       # By default, revive will enable only the linting rules that are named in the configuration file.

pkg/crd/conv.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 
 	apiextinternal "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
-	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	apiextv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -18,13 +18,13 @@ func init() {
 	if err := apiextinternal.AddToScheme(conversionScheme); err != nil {
 		panic("must be able to add internal apiextensions to the CRD conversion Scheme")
 	}
-	if err := apiext.AddToScheme(conversionScheme); err != nil {
+	if err := apiextensionsv1.AddToScheme(conversionScheme); err != nil {
 		panic("must be able to add apiextensions/v1 to the CRD conversion Scheme")
 	}
 }
 
 // AsVersion converts a CRD from the canonical internal form (currently v1) to some external form.
-func AsVersion(original apiext.CustomResourceDefinition, gv schema.GroupVersion) (runtime.Object, error) {
+func AsVersion(original apiextensionsv1.CustomResourceDefinition, gv schema.GroupVersion) (runtime.Object, error) {
 	// TODO: Do we need to keep maintaining this conversion function
 	//       post 1.22 when only CRDv1 is served by the apiserver?
 	if gv == apiextv1beta1.SchemeGroupVersion {

pkg/crd/desc_visitor.go

@@ -20,13 +20,13 @@ import (
 	"strings"
 	"unicode"
 
-	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 )
 
 // TruncateDescription truncates the description of fields in given schema if it
 // exceeds maxLen.
 // It tries to chop off the description at the closest sentence boundary.
-func TruncateDescription(schema *apiext.JSONSchemaProps, maxLen int) {
+func TruncateDescription(schema *apiextensionsv1.JSONSchemaProps, maxLen int) {
 	EditSchema(schema, descVisitor{maxLen: maxLen})
 }
 
@@ -37,7 +37,7 @@ type descVisitor struct {
 	maxLen int
 }
 
-func (v descVisitor) Visit(schema *apiext.JSONSchemaProps) SchemaVisitor {
+func (v descVisitor) Visit(schema *apiextensionsv1.JSONSchemaProps) SchemaVisitor {
 	if schema == nil {
 		return v
 	}

pkg/crd/desc_visitor_test.go

@@ -19,34 +19,34 @@ package crd_test
 import (
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
-	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"sigs.k8s.io/controller-tools/pkg/crd"
 )
 
 var _ = Describe("TruncateDescription", func() {
 
 	It("should drop the description for all fields for zero value of maxLen", func() {
-		schema := &apiext.JSONSchemaProps{
+		schema := &apiextensionsv1.JSONSchemaProps{
 			Description: "top level description",
-			Properties: map[string]apiext.JSONSchemaProps{
+			Properties: map[string]apiextensionsv1.JSONSchemaProps{
 				"Spec": {
 					Description: "specification for the API type",
 				},
 			},
 		}
 		crd.TruncateDescription(schema, 0)
-		Expect(schema).To(Equal(&apiext.JSONSchemaProps{
-			Properties: map[string]apiext.JSONSchemaProps{
+		Expect(schema).To(Equal(&apiextensionsv1.JSONSchemaProps{
+			Properties: map[string]apiextensionsv1.JSONSchemaProps{
 				"Spec": {},
 			},
 		}))
 
 	})
 
 	It("should truncate the description only in cases where description exceeds maxLen", func() {
-		schema := &apiext.JSONSchemaProps{
+		schema := &apiextensionsv1.JSONSchemaProps{
 			Description: "top level description of the root object.",
-			Properties: map[string]apiext.JSONSchemaProps{
+			Properties: map[string]apiextensionsv1.JSONSchemaProps{
 				"Spec": {
 					Description: "specification of a field",
 				},
@@ -58,21 +58,21 @@ var _ = Describe("TruncateDescription", func() {
 	})
 
 	It("should truncate the description at closest sentence boundary", func() {
-		schema := &apiext.JSONSchemaProps{
+		schema := &apiextensionsv1.JSONSchemaProps{
 			Description: `This is top level description. There is an empty schema. More to come`,
 		}
 		crd.TruncateDescription(schema, len(schema.Description)-5)
-		Expect(schema).To(Equal(&apiext.JSONSchemaProps{
+		Expect(schema).To(Equal(&apiextensionsv1.JSONSchemaProps{
 			Description: `This is top level description. There is an empty schema.`,
 		}))
 	})
 
 	It("should truncate the description at maxLen in absence of sentence boundary", func() {
-		schema := &apiext.JSONSchemaProps{
+		schema := &apiextensionsv1.JSONSchemaProps{
 			Description: `This is top level description of the root object`,
 		}
 		crd.TruncateDescription(schema, len(schema.Description)-2)
-		Expect(schema).To(Equal(&apiext.JSONSchemaProps{
+		Expect(schema).To(Equal(&apiextensionsv1.JSONSchemaProps{
 			Description: `This is top level description of the root...`,
 		}))
 	})

pkg/crd/flatten.go

@@ -23,7 +23,7 @@ import (
 	"strings"
 	"sync"
 
-	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"sigs.k8s.io/controller-tools/pkg/loader"
 )
 
@@ -49,7 +49,7 @@ func isOrNil(val reflect.Value, valInt any, zeroInt any) bool {
 
 // flattenAllOfInto copies properties from src to dst, then copies the properties
 // of each item in src's allOf to dst's properties as well.
-func flattenAllOfInto(dst *apiext.JSONSchemaProps, src apiext.JSONSchemaProps, errRec ErrorRecorder) {
+func flattenAllOfInto(dst *apiextensionsv1.JSONSchemaProps, src apiextensionsv1.JSONSchemaProps, errRec ErrorRecorder) {
 	if len(src.AllOf) > 0 {
 		for _, embedded := range src.AllOf {
 			flattenAllOfInto(dst, embedded, errRec)
@@ -60,9 +60,9 @@ func flattenAllOfInto(dst *apiext.JSONSchemaProps, src apiext.JSONSchemaProps, e
 	srcVal := reflect.ValueOf(src)
 	typ := dstVal.Type()
 
-	srcRemainder := apiext.JSONSchemaProps{}
+	srcRemainder := apiextensionsv1.JSONSchemaProps{}
 	srcRemVal := reflect.Indirect(reflect.ValueOf(&srcRemainder))
-	dstRemainder := apiext.JSONSchemaProps{}
+	dstRemainder := apiextensionsv1.JSONSchemaProps{}
 	dstRemVal := reflect.Indirect(reflect.ValueOf(&dstRemainder))
 	hoisted := false
 
@@ -104,8 +104,8 @@ func flattenAllOfInto(dst *apiext.JSONSchemaProps, src apiext.JSONSchemaProps, e
 		switch fieldName {
 		case "Properties":
 			// merge if possible, use all of otherwise
-			srcMap := srcInt.(map[string]apiext.JSONSchemaProps)
-			dstMap := dstInt.(map[string]apiext.JSONSchemaProps)
+			srcMap := srcInt.(map[string]apiextensionsv1.JSONSchemaProps)
+			dstMap := dstInt.(map[string]apiextensionsv1.JSONSchemaProps)
 
 			for k, v := range srcMap {
 				dstProp, exists := dstMap[k]
@@ -132,14 +132,14 @@ func flattenAllOfInto(dst *apiext.JSONSchemaProps, src apiext.JSONSchemaProps, e
 		// - Definitions: common named validation sets that can be references (merge, bail if duplicate)
 		case "AdditionalProperties":
 			// as of the time of writing, `allows: false` is not allowed, so we don't have to handle it
-			srcProps := srcInt.(*apiext.JSONSchemaPropsOrBool)
+			srcProps := srcInt.(*apiextensionsv1.JSONSchemaPropsOrBool)
 			if srcProps.Schema == nil {
 				// nothing to merge
 				continue
 			}
-			dstProps := dstInt.(*apiext.JSONSchemaPropsOrBool)
+			dstProps := dstInt.(*apiextensionsv1.JSONSchemaPropsOrBool)
 			if dstProps.Schema == nil {
-				dstProps.Schema = &apiext.JSONSchemaProps{}
+				dstProps.Schema = &apiextensionsv1.JSONSchemaProps{}
 			}
 			flattenAllOfInto(dstProps.Schema, *srcProps.Schema, errRec)
 		case "XPreserveUnknownFields":
@@ -188,7 +188,7 @@ type allOfVisitor struct {
 	errRec ErrorRecorder
 }
 
-func (v *allOfVisitor) Visit(schema *apiext.JSONSchemaProps) SchemaVisitor {
+func (v *allOfVisitor) Visit(schema *apiextensionsv1.JSONSchemaProps) SchemaVisitor {
 	if schema == nil {
 		return v
 	}
@@ -210,7 +210,7 @@ func (v *allOfVisitor) Visit(schema *apiext.JSONSchemaProps) SchemaVisitor {
 // FlattenEmbedded flattens embedded fields (represented via AllOf) which have
 // already had their references resolved into simple properties in the containing
 // schema.
-func FlattenEmbedded(schema *apiext.JSONSchemaProps, errRec ErrorRecorder) *apiext.JSONSchemaProps {
+func FlattenEmbedded(schema *apiextensionsv1.JSONSchemaProps, errRec ErrorRecorder) *apiextensionsv1.JSONSchemaProps {
 	outSchema := schema.DeepCopy()
 	EditSchema(outSchema, &allOfVisitor{errRec: errRec})
 	return outSchema
@@ -226,27 +226,27 @@ type Flattener struct {
 	LookupReference func(ref string, contextPkg *loader.Package) (TypeIdent, error)
 
 	// flattenedTypes hold the flattened version of each seen type for later reuse.
-	flattenedTypes map[TypeIdent]apiext.JSONSchemaProps
+	flattenedTypes map[TypeIdent]apiextensionsv1.JSONSchemaProps
 	initOnce       sync.Once
 }
 
 func (f *Flattener) init() {
 	f.initOnce.Do(func() {
-		f.flattenedTypes = make(map[TypeIdent]apiext.JSONSchemaProps)
+		f.flattenedTypes = make(map[TypeIdent]apiextensionsv1.JSONSchemaProps)
 		if f.LookupReference == nil {
 			f.LookupReference = identFromRef
 		}
 	})
 }
 
 // cacheType saves the flattened version of the given type for later reuse
-func (f *Flattener) cacheType(typ TypeIdent, schema apiext.JSONSchemaProps) {
+func (f *Flattener) cacheType(typ TypeIdent, schema apiextensionsv1.JSONSchemaProps) {
 	f.init()
 	f.flattenedTypes[typ] = schema
 }
 
 // loadUnflattenedSchema fetches a fresh, unflattened schema from the parser.
-func (f *Flattener) loadUnflattenedSchema(typ TypeIdent) (*apiext.JSONSchemaProps, error) {
+func (f *Flattener) loadUnflattenedSchema(typ TypeIdent) (*apiextensionsv1.JSONSchemaProps, error) {
 	f.Parser.NeedSchemaFor(typ)
 
 	baseSchema, found := f.Parser.Schemata[typ]
@@ -258,7 +258,7 @@ func (f *Flattener) loadUnflattenedSchema(typ TypeIdent) (*apiext.JSONSchemaProp
 
 // FlattenType flattens the given pre-loaded type, removing any references from it.
 // It deep-copies the schema first, so it won't affect the parser's version of the schema.
-func (f *Flattener) FlattenType(typ TypeIdent) *apiext.JSONSchemaProps {
+func (f *Flattener) FlattenType(typ TypeIdent) *apiextensionsv1.JSONSchemaProps {
 	f.init()
 	if cachedSchema, isCached := f.flattenedTypes[typ]; isCached {
 		return &cachedSchema
@@ -275,7 +275,7 @@ func (f *Flattener) FlattenType(typ TypeIdent) *apiext.JSONSchemaProps {
 
 // FlattenSchema flattens the given schema, removing any references.
 // It deep-copies the schema first, so the input schema won't be affected.
-func (f *Flattener) FlattenSchema(baseSchema apiext.JSONSchemaProps, currentPackage *loader.Package) *apiext.JSONSchemaProps {
+func (f *Flattener) FlattenSchema(baseSchema apiextensionsv1.JSONSchemaProps, currentPackage *loader.Package) *apiextensionsv1.JSONSchemaProps {
 	resSchema := baseSchema.DeepCopy()
 	EditSchema(resSchema, &flattenVisitor{
 		Flattener:      f,
@@ -332,7 +332,7 @@ func identFromRef(ref string, contextPkg *loader.Package) (TypeIdent, error) {
 // preserveFields copies documentation fields from src into dst, preserving
 // field-level documentation when flattening, and preserving field-level validation
 // as allOf entries.
-func preserveFields(dst *apiext.JSONSchemaProps, src apiext.JSONSchemaProps) {
+func preserveFields(dst *apiextensionsv1.JSONSchemaProps, src apiextensionsv1.JSONSchemaProps) {
 	srcDesc := src.Description
 	srcTitle := src.Title
 	srcExDoc := src.ExternalDocs
@@ -341,8 +341,8 @@ func preserveFields(dst *apiext.JSONSchemaProps, src apiext.JSONSchemaProps) {
 	src.Description, src.Title, src.ExternalDocs, src.Example = "", "", nil, nil
 
 	src.Ref = nil
-	*dst = apiext.JSONSchemaProps{
-		AllOf: []apiext.JSONSchemaProps{*dst, src},
+	*dst = apiextensionsv1.JSONSchemaProps{
+		AllOf: []apiextensionsv1.JSONSchemaProps{*dst, src},
 
 		// keep these, in case the source field doesn't specify anything useful
 		Description:  dst.Description,
@@ -371,11 +371,11 @@ type flattenVisitor struct {
 
 	currentPackage *loader.Package
 	currentType    *TypeIdent
-	currentSchema  *apiext.JSONSchemaProps
-	originalField  apiext.JSONSchemaProps
+	currentSchema  *apiextensionsv1.JSONSchemaProps
+	originalField  apiextensionsv1.JSONSchemaProps
 }
 
-func (f *flattenVisitor) Visit(baseSchema *apiext.JSONSchemaProps) SchemaVisitor {
+func (f *flattenVisitor) Visit(baseSchema *apiextensionsv1.JSONSchemaProps) SchemaVisitor {
 	if baseSchema == nil {
 		// end-of-node marker, cache the results
 		if f.currentType != nil {
@@ -421,7 +421,7 @@ func (f *flattenVisitor) Visit(baseSchema *apiext.JSONSchemaProps) SchemaVisitor
 
 		// avoid loops (which shouldn't exist, but just in case)
 		// by marking a nil cached pointer before we start recursing
-		f.cacheType(refIdent, apiext.JSONSchemaProps{})
+		f.cacheType(refIdent, apiextensionsv1.JSONSchemaProps{})
 
 		return &flattenVisitor{
 			Flattener: f.Flattener,