remove import tracking from TypeDef collection

This commit replaces the tracking of unique imported packages from the
processing of TypeDef structs by the code generator. Instead, we now
use the same technique to avoid import errors that we do in the `sdk.go`
code:

```go
import (
	ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1"
	"github.com/aws/aws-sdk-go/aws"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// Hack to avoid import errors during build...
var (
	_ = &metav1.Time{}
	_ = &aws.JSONValue{}
	_ = ackv1alpha1.AWSAccountID("")
)
```

The above is all the packages that are referenced by any type
definition's attribute fields that is collected by the code generator
during API inference.

Author: jaypipes

pkg/generate/ack/apis.go

@@ -52,7 +52,7 @@ func APIs(
 	if err != nil {
 		return nil, err
 	}
-	typeDefs, typeImports, err := g.GetTypeDefs()
+	typeDefs, err := g.GetTypeDefs()
 	if err != nil {
 		return nil, err
 	}
@@ -73,7 +73,6 @@ func APIs(
 		metaVars,
 		enumDefs,
 		typeDefs,
-		typeImports,
 	}
 	for _, path := range apisTemplatePaths {
 		outPath := strings.TrimSuffix(filepath.Base(path), ".tpl")
@@ -101,7 +100,6 @@ type templateAPIVars struct {
 	templateset.MetaVars
 	EnumDefs []*ackmodel.EnumDef
 	TypeDefs []*ackmodel.TypeDef
-	Imports  map[string]string
 }
 
 // templateCRDVars contains template variables for the template that outputs Go

pkg/generate/apigwv2_test.go

@@ -28,21 +28,12 @@ func TestAPIGatewayV2_GetTypeDefs(t *testing.T) {
 
 	g := testutil.NewGeneratorForService(t, "apigatewayv2")
 
-	tdefs, timports, err := g.GetTypeDefs()
-	require.Nil(err)
-
-	// APIGatewayV2 shapes have time.Time ("timestamp") types and so
-	// GetTypeDefs() should return the special-cased with apimachinery/metav1
-	// import, aliased as "metav1"
-	expImports := map[string]string{"k8s.io/apimachinery/pkg/apis/meta/v1": "metav1"}
-	assert.Equal(expImports, timports)
-
 	// There is an "Api" Shape that is a struct that is an element of the
 	// GetApis Operation. Its name conflicts with the CRD called API and thus
 	// we need to check that its cleaned name is set to API_SDK (the _SDK
 	// suffix is appended to the type name to avoid the conflict with
 	// CRD-specific structs.
-	tdef := getTypeDefByName("Api", tdefs)
+	tdef := testutil.GetTypeDefByName(t, g, "Api")
 	require.NotNil(tdef)
 
 	assert.Equal("API_SDK", tdef.Names.Camel)

pkg/generate/crossplane/crossplane.go

@@ -32,10 +32,10 @@ var (
 		"crossplane/apis/groupversion_info.go.tpl",
 		"crossplane/apis/types.go.tpl",
 	}
-	crdTemplatePath = "crossplane/apis/crd.go.tpl"
-	controllerTmplPath = "crossplane/pkg/controller.go.tpl"
+	crdTemplatePath     = "crossplane/apis/crd.go.tpl"
+	controllerTmplPath  = "crossplane/pkg/controller.go.tpl"
 	conversionsTmplPath = "crossplane/pkg/conversions.go.tpl"
-	includePaths = []string{
+	includePaths        = []string{
 		"crossplane/boilerplate.go.tpl",
 		"crossplane/apis/enum_def.go.tpl",
 		"crossplane/apis/type_def.go.tpl",
@@ -100,7 +100,6 @@ type templateAPIVars struct {
 	templateset.MetaVars
 	EnumDefs []*ackmodel.EnumDef
 	TypeDefs []*ackmodel.TypeDef
-	Imports  map[string]string
 }
 
 // templateCRDVars contains template variables for the template that outputs Go
@@ -120,7 +119,7 @@ func Crossplane(
 	if err != nil {
 		return nil, err
 	}
-	typeDefs, typeImports, err := g.GetTypeDefs()
+	typeDefs, err := g.GetTypeDefs()
 	if err != nil {
 		return nil, err
 	}
@@ -143,7 +142,6 @@ func Crossplane(
 		metaVars,
 		enumDefs,
 		typeDefs,
-		typeImports,
 	}
 	for _, path := range apisGenericTemplatesPaths {
 		outPath := filepath.Join(

pkg/generate/generator.go

@@ -273,17 +273,13 @@ func (g *Generator) IsShapeUsedInCRDs(shapeName string) bool {
 	return false
 }
 
-// GetTypeDefs returns a slice of `ackmodel.TypeDef` pointers and a map of
-// package import information
-func (g *Generator) GetTypeDefs() ([]*ackmodel.TypeDef, map[string]string, error) {
+// GetTypeDefs returns a slice of `ackmodel.TypeDef` pointers
+func (g *Generator) GetTypeDefs() ([]*ackmodel.TypeDef, error) {
 	if g.typeDefs != nil {
-		return g.typeDefs, g.typeImports, nil
+		return g.typeDefs, nil
 	}
 
 	tdefs := []*ackmodel.TypeDef{}
-	// Map, keyed by package import path, with the values being an alias to use
-	// for the package
-	timports := map[string]string{}
 	// Map, keyed by original Shape GoTypeElem(), with the values being a
 	// renamed type name (due to conflicting names)
 	trenames := map[string]string{}
@@ -315,38 +311,6 @@ func (g *Generator) GetTypeDefs() ([]*ackmodel.TypeDef, map[string]string, error
 			if !g.IsShapeUsedInCRDs(memberShape.ShapeName) {
 				continue
 			}
-			goPkgType := memberRef.Shape.GoTypeWithPkgNameElem()
-			if strings.Contains(goPkgType, ".") {
-				if strings.HasPrefix(goPkgType, "[]") {
-					// For slice types, we just want the element type...
-					goPkgType = strings.TrimLeft(goPkgType, "[]")
-				}
-				if strings.HasPrefix(goPkgType, "map[") {
-					// Assuming the map keys are always of type string.
-					goPkgType = strings.TrimLeft(goPkgType, "map[string]")
-				}
-				if strings.HasPrefix(goPkgType, "*") {
-					// For slice and map types, the element type might be a
-					// pointer to a struct...
-					goPkgType = goPkgType[1:]
-				}
-				pkg := strings.Split(goPkgType, ".")[0]
-				if pkg != g.SDKAPI.API.PackageName() {
-					// time.Time needs to be converted to apimachinery/metav1.Time otherwise there is no DeepCopy support
-					if pkg == "time" {
-						timports["k8s.io/apimachinery/pkg/apis/meta/v1"] = "metav1"
-					} else if pkg == "aws" {
-						// The "aws.JSONValue" type needs to be handled
-						// specially.
-						timports["github.com/aws/aws-sdk-go/aws"] = ""
-					} else {
-						// Shape.GoPTypeWithPkgNameElem() always returns the type
-						// as a full package dot-notation name. We only want to add
-						// imports for "normal" packages
-						timports[pkg] = ""
-					}
-				}
-			}
 			// There are shapes that are called things like DBProxyStatus that are
 			// fields in a DBProxy CRD... we need to ensure the type names don't
 			// conflict. Also, the name of the Go type in the generated code is
@@ -401,9 +365,8 @@ func (g *Generator) GetTypeDefs() ([]*ackmodel.TypeDef, map[string]string, error
 	})
 	g.processNestedFieldTypeDefs(tdefs)
 	g.typeDefs = tdefs
-	g.typeImports = timports
 	g.typeRenames = trenames
-	return tdefs, timports, nil
+	return tdefs, nil
 }
 
 // processNestedFieldTypeDefs updates the supplied TypeDef structs' if a nested

pkg/testutil/get.go

@@ -49,7 +49,7 @@ func GetTypeDefByName(
 ) *model.TypeDef {
 	require := require.New(t)
 
-	tdefs, _, err := g.GetTypeDefs()
+	tdefs, err := g.GetTypeDefs()
 	require.Nil(err)
 
 	for _, tdef := range tdefs {

templates/apis/types.go.tpl

@@ -1,15 +1,19 @@
 {{- template "boilerplate" }}
 
 package {{ .APIVersion }}
-{{- if .Imports }}
+
 import (
-{{- end -}}
-{{- range $packagePath, $alias := .Imports }}
-	{{ if $alias -}}{{ $alias }} {{ end -}}"{{ $packagePath }}"
-{{ end -}}
-{{- if .Imports }}
+	ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1"
+	"github.com/aws/aws-sdk-go/aws"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// Hack to avoid import errors during build...
+var (
+	_ = &metav1.Time{}
+	_ = &aws.JSONValue{}
+	_ = ackv1alpha1.AWSAccountID("")
 )
-{{- end -}}
 {{- range $typeDef := .TypeDefs }}
 
 {{ template "type_def" $typeDef }}

templates/crossplane/apis/types.go.tpl

@@ -3,15 +3,19 @@
 // Code generated by ack-generate. DO NOT EDIT.
 
 package {{ .APIVersion }}
-{{- if .Imports }}
+
 import (
-{{- end -}}
-{{- range $packagePath, $alias := .Imports }}
-	{{ if $alias -}}{{ $alias }} {{ end -}}"{{ $packagePath }}"
-{{ end -}}
-{{- if .Imports }}
+	ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1"
+	"github.com/aws/aws-sdk-go/aws"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// Hack to avoid import errors during build...
+var (
+	_ = &metav1.Time{}
+	_ = &aws.JSONValue{}
+	_ = ackv1alpha1.AWSAccountID("")
 )
-{{- end -}}
 {{- range $typeDef := .TypeDefs }}
 
 {{ template "type_def" $typeDef }}