Refactor service naming variables

Author: Nicholas Thomson

cmd/ack-generate/command/apis.go

@@ -112,7 +112,7 @@ func generateAPIs(cmd *cobra.Command, args []string) error {
 		}
 	}
 	model, err := ackmodel.New(
-		sdkAPI, svcAlias, optGenVersion, optGeneratorConfigPath, ackgenerate.DefaultConfig,
+		sdkAPI, svcAlias, optModelName, optGenVersion, optGeneratorConfigPath, ackgenerate.DefaultConfig,
 	)
 	if err != nil {
 		return err

cmd/ack-generate/command/controller.go

@@ -82,7 +82,7 @@ func generateController(cmd *cobra.Command, args []string) error {
 		return err
 	}
 	m, err := ackmodel.New(
-		sdkAPI, svcAlias, latestAPIVersion, optGeneratorConfigPath, ackgenerate.DefaultConfig,
+		sdkAPI, svcAlias, optModelName, latestAPIVersion, optGeneratorConfigPath, ackgenerate.DefaultConfig,
 	)
 	if err != nil {
 		return err

cmd/ack-generate/command/crossplane.go

@@ -80,7 +80,7 @@ func generateCrossplane(_ *cobra.Command, args []string) error {
 		cfgPath = ""
 	}
 	m, err := ackmodel.New(
-		sdkAPI, svcAlias, optGenVersion, cfgPath, cpgenerate.DefaultConfig,
+		sdkAPI, svcAlias, optModelName, optGenVersion, cfgPath, cpgenerate.DefaultConfig,
 	)
 	if err != nil {
 		return err

cmd/ack-generate/command/olm.go

@@ -107,7 +107,7 @@ func generateOLMAssets(cmd *cobra.Command, args []string) error {
 		return err
 	}
 	m, err := ackmodel.New(
-		sdkAPI, svcAlias, latestAPIVersion, optGeneratorConfigPath, ackgenerate.DefaultConfig,
+		sdkAPI, svcAlias, optModelName, latestAPIVersion, optGeneratorConfigPath, ackgenerate.DefaultConfig,
 	)
 	if err != nil {
 		return err

cmd/ack-generate/command/release.go

@@ -90,7 +90,7 @@ func generateRelease(cmd *cobra.Command, args []string) error {
 		}
 	}
 	m, err := ackmodel.New(
-		sdkAPI, svcAlias, "", optGeneratorConfigPath, ackgenerate.DefaultConfig,
+		sdkAPI, svcAlias, optModelName, "", optGeneratorConfigPath, ackgenerate.DefaultConfig,
 	)
 	if err != nil {
 		return err

pkg/generate/crossplane/crossplane.go

@@ -145,7 +145,7 @@ func Crossplane(
 	for _, path := range apisGenericTemplatesPaths {
 		outPath := filepath.Join(
 			"apis",
-			metaVars.ServiceIDClean,
+			metaVars.ServiceAliasClean,
 			metaVars.APIVersion,
 			"zz_"+strings.TrimSuffix(filepath.Base(path), ".tpl"),
 		)
@@ -155,7 +155,7 @@ func Crossplane(
 	}
 	for _, crd := range crds {
 		crdFileName := filepath.Join(
-			"apis", metaVars.ServiceIDClean, metaVars.APIVersion,
+			"apis", metaVars.ServiceAliasClean, metaVars.APIVersion,
 			"zz_"+strcase.ToSnake(crd.Kind)+".go",
 		)
 		crdVars := &templateCRDVars{
@@ -170,7 +170,7 @@ func Crossplane(
 	// Next add the controller package for each CRD
 	for _, crd := range crds {
 		outPath := filepath.Join(
-			"pkg", "controller", metaVars.ServiceIDClean, crd.Names.Lower,
+			"pkg", "controller", metaVars.ServiceAliasClean, crd.Names.Lower,
 			"zz_controller.go",
 		)
 		crdVars := &templateCRDVars{
@@ -181,7 +181,7 @@ func Crossplane(
 			return nil, err
 		}
 		outPath = filepath.Join(
-			"pkg", "controller", metaVars.ServiceIDClean, crd.Names.Lower,
+			"pkg", "controller", metaVars.ServiceAliasClean, crd.Names.Lower,
 			"zz_conversions.go",
 		)
 		crdVars = &templateCRDVars{

pkg/generate/olm/olm.go

@@ -79,7 +79,7 @@ func BundleAssets(
 
 	csvBaseOutPath := fmt.Sprintf(
 		"config/manifests/bases/ack-%s-controller.clusterserviceversion.yaml",
-		m.MetaVars().ServiceIDClean)
+		m.MetaVars().ServiceAliasClean)
 	if err := ts.Add(csvBaseOutPath, "config/manifests/bases/clusterserviceversion.yaml.tpl", olmVars); err != nil {
 		return nil, err
 	}

pkg/generate/templateset/vars.go

@@ -16,24 +16,28 @@ package templateset
 // MetaVars contains template variables that most templates need access to
 // that describe the service alias, its package name, etc
 type MetaVars struct {
+	// ServiceModelName contains the exact string used to identify the AWS
+	// service API in the aws-sdk-go's models/apis/ directory. Note that some
+	// APIs this name does not match the ServiceID. e.g. The AWS Step Functions
+	// API has a ServiceID of "SFN" and a service model name of "states"...
+	ServiceModelName string
+	// ServiceAliasClean is the ServiceAlias lowercased and stripped of any
+	// non-alphanumeric characters
+	ServiceAliasClean string
 	// ServiceAlias contains the exact string used to identify the AWS service
-	// API in the aws-sdk-go's models/apis/ directory. Note that some APIs this
-	// alias does not match the ServiceID. e.g. The AWS Step Functions API has
-	// a ServiceID of "SFN" and a service alias of "states"...
+	// API in the aws-sdk-go's packages. It is also used as the identifier for
+	// the ACK controller's name and packages.
 	ServiceAlias string
-	// ServiceIDClean is the ServiceID lowercased and stripped of any
-	// non-alphanumeric characters
-	ServiceIDClean string
 	// APIVersion contains the version of the Kubernetes API resources, e.g.
 	// "v1alpha1"
 	APIVersion string
 	// APIGroup contains the normalized name of the Kubernetes APIGroup used
 	// for custom resources, e.g. "sns.services.k8s.aws" or
 	// "sfn.services.k8s.aws"
 	APIGroup string
-	// AWSSDKModelServiceID is the exact string that appears in the AWS service API's
+	// ServiceID is the exact string that appears in the AWS service API's
 	// api-2.json descriptor file under `metadata.serviceId`
-	AWSSDKModelServiceID string
+	ServiceID string
 	// SDKAPIInterfaceTypeName is the name of the interface type used by the
 	// aws-sdk-go services/$SERVICE/api.go file
 	SDKAPIInterfaceTypeName string

pkg/model/model.go

@@ -34,14 +34,14 @@ var (
 // Model contains the ACK model for the generator to process and apply
 // templates against.
 type Model struct {
-	SDKAPI         *SDKAPI
-	servicePackage string
-	serviceAlias   string
-	apiVersion     string
-	crds           []*CRD
-	typeDefs       []*TypeDef
-	typeImports    map[string]string
-	typeRenames    map[string]string
+	SDKAPI           *SDKAPI
+	serviceAlias     string
+	serviceModelName string
+	apiVersion       string
+	crds             []*CRD
+	typeDefs         []*TypeDef
+	typeImports      map[string]string
+	typeRenames      map[string]string
 	// Instructions to the code generator how to handle the API and its
 	// resources
 	cfg *ackgenconfig.Config
@@ -51,11 +51,11 @@ type Model struct {
 // service API
 func (m *Model) MetaVars() templateset.MetaVars {
 	return templateset.MetaVars{
-		ServiceAlias:            m.serviceAlias,
-		ServiceIDClean:          m.ServiceIDClean(),
+		ServiceAliasClean:       m.ServiceAliasClean(),
+		ServiceModelName:        m.serviceModelName,
 		APIGroup:                m.APIGroup(),
 		APIVersion:              m.apiVersion,
-		AWSSDKModelServiceID:    m.SDKAPI.AWSSDKModelServiceID(),
+		ServiceID:               m.SDKAPI.ServiceID(),
 		SDKAPIInterfaceTypeName: m.SDKAPI.SDKAPIInterfaceTypeName(),
 		CRDNames:                m.crdNames(),
 	}
@@ -695,17 +695,17 @@ func (m *Model) GetConfig() *ackgenconfig.Config {
 // APIGroup returns the normalized Kubernetes APIGroup for the AWS service API,
 // e.g. "sns.services.k8s.aws"
 func (m *Model) APIGroup() string {
-	serviceID := m.servicePackage
+	serviceID := m.serviceAlias
 	suffix := "services.k8s.aws"
 	if m.SDKAPI.apiGroupSuffix != "" {
 		suffix = m.SDKAPI.apiGroupSuffix
 	}
 	return fmt.Sprintf("%s.%s", serviceID, suffix)
 }
 
-// ServiceIDClean returns a lowercased, whitespace-stripped ServiceID
-func (m *Model) ServiceIDClean() string {
-	serviceID := strings.ToLower(m.servicePackage)
+// ServiceAliasClean returns a lowercased, whitespace-stripped ServiceID
+func (m *Model) ServiceAliasClean() string {
+	serviceID := strings.ToLower(m.serviceAlias)
 	return strings.Replace(serviceID, " ", "", -1)
 }
 
@@ -714,7 +714,8 @@ func (m *Model) ServiceIDClean() string {
 // instruct the code generator how to handle the API properly
 func New(
 	SDKAPI *SDKAPI,
-	servicePackage string,
+	serviceAlias string,
+	serviceModelName string,
 	apiVersion string,
 	configPath string,
 	defaultConfig ackgenconfig.Config,
@@ -724,11 +725,11 @@ func New(
 		return nil, err
 	}
 	m := &Model{
-		SDKAPI:         SDKAPI,
-		servicePackage: servicePackage,
-		serviceAlias:   SDKAPI.AWSSDKModelServiceID(),
-		apiVersion:     apiVersion,
-		cfg:            &cfg,
+		SDKAPI:           SDKAPI,
+		serviceAlias:     serviceAlias,
+		serviceModelName: serviceModelName,
+		apiVersion:       apiVersion,
+		cfg:              &cfg,
 	}
 	m.ApplyShapeIgnoreRules()
 	return m, nil

pkg/model/multiversion/manager.go

@@ -103,6 +103,7 @@ func NewAPIVersionManager(
 		i, err := ackmodel.New(
 			SDKAPI,
 			serviceAlias,
+			serviceModelName,
 			version.APIVersion,
 			apiInfo.GeneratorConfigPath,
 			defaultConfig,