Skip to content

Refactor pkg/generate package #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 8, 2021
Merged

Refactor pkg/generate package #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d3e4df
Move `pkg/generate.Generator` to `pkg/model.Model`
a-hilaly Jul 7, 2021
ec04916
Move `pkg/generate` unit tests to `pkg/model`
a-hilaly Jul 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions cmd/ack-generate/command/apis.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,8 @@ import (

"github.com/spf13/cobra"

generate "github.com/aws-controllers-k8s/code-generator/pkg/generate"
ackgenerate "github.com/aws-controllers-k8s/code-generator/pkg/generate/ack"
"github.com/aws-controllers-k8s/code-generator/pkg/model"
ackmodel "github.com/aws-controllers-k8s/code-generator/pkg/model"
"github.com/aws-controllers-k8s/code-generator/pkg/util"
)

Expand Down Expand Up @@ -94,7 +93,7 @@ func generateAPIs(cmd *cobra.Command, args []string) error {
if err := ensureSDKRepo(optCacheDir, optRefreshCache); err != nil {
return err
}
sdkHelper := model.NewSDKHelper(sdkDir)
sdkHelper := ackmodel.NewSDKHelper(sdkDir)
sdkAPI, err := sdkHelper.API(svcAlias)
if err != nil {
newSvcAlias, err := FallBackFindServiceID(sdkDir, svcAlias)
Expand All @@ -106,13 +105,13 @@ func generateAPIs(cmd *cobra.Command, args []string) error {
return fmt.Errorf("service %s not found", svcAlias)
}
}
g, err := generate.New(
model, err := ackmodel.New(
sdkAPI, optGenVersion, optGeneratorConfigPath, ackgenerate.DefaultConfig,
)
if err != nil {
return err
}
ts, err := ackgenerate.APIs(g, optTemplateDirs)
ts, err := ackgenerate.APIs(model, optTemplateDirs)
if err != nil {
return err
}
Expand Down
5 changes: 2 additions & 3 deletions cmd/ack-generate/command/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ import (
"github.com/spf13/cobra"
k8sversion "k8s.io/apimachinery/pkg/version"

"github.com/aws-controllers-k8s/code-generator/pkg/generate"
ackgenerate "github.com/aws-controllers-k8s/code-generator/pkg/generate/ack"
ackmodel "github.com/aws-controllers-k8s/code-generator/pkg/model"
)
Expand Down Expand Up @@ -76,13 +75,13 @@ func generateController(cmd *cobra.Command, args []string) error {
if err != nil {
return err
}
g, err := generate.New(
m, err := ackmodel.New(
sdkAPI, latestAPIVersion, optGeneratorConfigPath, ackgenerate.DefaultConfig,
)
if err != nil {
return err
}
ts, err := ackgenerate.Controller(g, optTemplateDirs)
ts, err := ackgenerate.Controller(m, optTemplateDirs)
if err != nil {
return err
}
Expand Down
6 changes: 3 additions & 3 deletions cmd/ack-generate/command/crossplane.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ import (
"github.com/pkg/errors"
"github.com/spf13/cobra"

"github.com/aws-controllers-k8s/code-generator/pkg/generate"
cpgenerate "github.com/aws-controllers-k8s/code-generator/pkg/generate/crossplane"
"github.com/aws-controllers-k8s/code-generator/pkg/model"
ackmodel "github.com/aws-controllers-k8s/code-generator/pkg/model"
)

// crossplaneCmd is the command that generates Crossplane API types
Expand Down Expand Up @@ -74,14 +74,14 @@ func generateCrossplane(_ *cobra.Command, args []string) error {
if os.IsNotExist(err) {
cfgPath = ""
}
g, err := generate.New(
m, err := ackmodel.New(
sdkAPI, optGenVersion, cfgPath, cpgenerate.DefaultConfig,
)
if err != nil {
return err
}

ts, err := cpgenerate.Crossplane(g, optTemplateDirs)
ts, err := cpgenerate.Crossplane(m, optTemplateDirs)
if err != nil {
return err
}
Expand Down
5 changes: 2 additions & 3 deletions cmd/ack-generate/command/olm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import (
"github.com/ghodss/yaml"
"github.com/spf13/cobra"

generate "github.com/aws-controllers-k8s/code-generator/pkg/generate"
ackgenerate "github.com/aws-controllers-k8s/code-generator/pkg/generate/ack"
olmgenerate "github.com/aws-controllers-k8s/code-generator/pkg/generate/olm"
ackmodel "github.com/aws-controllers-k8s/code-generator/pkg/model"
Expand Down Expand Up @@ -101,7 +100,7 @@ func generateOLMAssets(cmd *cobra.Command, args []string) error {
if err != nil {
return err
}
g, err := generate.New(
m, err := ackmodel.New(
sdkAPI, latestAPIVersion, optGeneratorConfigPath, ackgenerate.DefaultConfig,
)
if err != nil {
Expand Down Expand Up @@ -138,7 +137,7 @@ func generateOLMAssets(cmd *cobra.Command, args []string) error {
}

// generate templates
ts, err := olmgenerate.BundleAssets(g, commonMeta, svcConf, version, optTemplateDirs)
ts, err := olmgenerate.BundleAssets(m, commonMeta, svcConf, version, optTemplateDirs)
if err != nil {
return err
}
Expand Down
5 changes: 2 additions & 3 deletions cmd/ack-generate/command/release.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import (

"github.com/spf13/cobra"

"github.com/aws-controllers-k8s/code-generator/pkg/generate"
ackgenerate "github.com/aws-controllers-k8s/code-generator/pkg/generate/ack"
ackmodel "github.com/aws-controllers-k8s/code-generator/pkg/model"
)
Expand Down Expand Up @@ -80,14 +79,14 @@ func generateRelease(cmd *cobra.Command, args []string) error {
return fmt.Errorf("service %s not found", svcAlias)
}
}
g, err := generate.New(
m, err := ackmodel.New(
sdkAPI, "", optGeneratorConfigPath, ackgenerate.DefaultConfig,
)
if err != nil {
return err
}
ts, err := ackgenerate.Release(
g, optTemplateDirs,
m, optTemplateDirs,
releaseVersion, optImageRepository, optServiceAccountName,
)
if err != nil {
Expand Down
11 changes: 5 additions & 6 deletions pkg/generate/ack/apis.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import (
"strings"
ttpl "text/template"

"github.com/aws-controllers-k8s/code-generator/pkg/generate"
"github.com/aws-controllers-k8s/code-generator/pkg/generate/templateset"
ackmodel "github.com/aws-controllers-k8s/code-generator/pkg/model"
"github.com/iancoleman/strcase"
Expand All @@ -45,18 +44,18 @@ var (
// APIs returns a pointer to a TemplateSet containing all the templates for
// generating ACK service controller's apis/ contents
func APIs(
g *generate.Generator,
m *ackmodel.Model,
templateBasePaths []string,
) (*templateset.TemplateSet, error) {
enumDefs, err := g.GetEnumDefs()
enumDefs, err := m.GetEnumDefs()
if err != nil {
return nil, err
}
typeDefs, err := g.GetTypeDefs()
typeDefs, err := m.GetTypeDefs()
if err != nil {
return nil, err
}
crds, err := g.GetCRDs()
crds, err := m.GetCRDs()
if err != nil {
return nil, err
}
Expand All @@ -68,7 +67,7 @@ func APIs(
apisFuncMap,
)

metaVars := g.MetaVars()
metaVars := m.MetaVars()
apiVars := &templateAPIVars{
metaVars,
enumDefs,
Expand Down
9 changes: 4 additions & 5 deletions pkg/generate/ack/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import (
"strings"
ttpl "text/template"

"github.com/aws-controllers-k8s/code-generator/pkg/generate"
"github.com/aws-controllers-k8s/code-generator/pkg/generate/code"
ackgenconfig "github.com/aws-controllers-k8s/code-generator/pkg/generate/config"
"github.com/aws-controllers-k8s/code-generator/pkg/generate/templateset"
Expand Down Expand Up @@ -118,15 +117,15 @@ var (
// Controller returns a pointer to a TemplateSet containing all the templates
// for generating ACK service controller implementations
func Controller(
g *generate.Generator,
m *ackmodel.Model,
templateBasePaths []string,
) (*templateset.TemplateSet, error) {
crds, err := g.GetCRDs()
crds, err := m.GetCRDs()
if err != nil {
return nil, err
}

metaVars := g.MetaVars()
metaVars := m.MetaVars()

// Hook code can reference a template path, and we can look up the template
// in any of our base paths...
Expand Down Expand Up @@ -176,7 +175,7 @@ func Controller(

configVars := &templateConfigVars{
metaVars,
g.GetConfig(),
m.GetConfig(),
}
if err = ts.Add("pkg/resource/registry.go", "pkg/resource/registry.go.tpl", configVars); err != nil {
return nil, err
Expand Down
4 changes: 2 additions & 2 deletions pkg/generate/ack/hook_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func TestResourceHookCodeInline(t *testing.T) {
basePaths := []string{}
hookID := "sdk_update_pre_build_request"

g := testutil.NewGeneratorForService(t, "mq")
g := testutil.NewModelForService(t, "mq")

crd := testutil.GetCRDByName(t, g, "Broker")
require.NotNil(crd)
Expand All @@ -52,7 +52,7 @@ func TestResourceHookCodeTemplatePath(t *testing.T) {
}
hookID := "sdk_delete_pre_build_request"

g := testutil.NewGeneratorForService(t, "mq")
g := testutil.NewModelForService(t, "mq")

crd := testutil.GetCRDByName(t, g, "Broker")
require.NotNil(crd)
Expand Down
6 changes: 3 additions & 3 deletions pkg/generate/ack/release.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import (
"strings"
ttpl "text/template"

"github.com/aws-controllers-k8s/code-generator/pkg/generate"
"github.com/aws-controllers-k8s/code-generator/pkg/generate/templateset"
ackmodel "github.com/aws-controllers-k8s/code-generator/pkg/model"
)

var (
Expand Down Expand Up @@ -47,7 +47,7 @@ var (
// Release returns a pointer to a TemplateSet containing all the templates for
// generating an ACK service controller release (Helm artifacts, etc)
func Release(
g *generate.Generator,
m *ackmodel.Model,
templateBasePaths []string,
// releaseVersion is the SemVer string describing the release that the Helm
// chart will install
Expand All @@ -66,7 +66,7 @@ func Release(
releaseFuncMap,
)

metaVars := g.MetaVars()
metaVars := m.MetaVars()
releaseVars := &templateReleaseVars{
metaVars,
releaseVersion,
Expand Down
8 changes: 4 additions & 4 deletions pkg/generate/code/check_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ func TestCheckRequiredFields_Attributes_ARNField(t *testing.T) {
assert := assert.New(t)
require := require.New(t)

g := testutil.NewGeneratorForService(t, "sns")
g := testutil.NewModelForService(t, "sns")

crd := testutil.GetCRDByName(t, g, "Topic")
require.NotNil(crd)
Expand Down Expand Up @@ -57,7 +57,7 @@ func TestCheckRequiredFields_Attributes_StatusField(t *testing.T) {
assert := assert.New(t)
require := require.New(t)

g := testutil.NewGeneratorForService(t, "sqs")
g := testutil.NewModelForService(t, "sqs")

crd := testutil.GetCRDByName(t, g, "Queue")
require.NotNil(crd)
Expand All @@ -78,7 +78,7 @@ func TestCheckRequiredFields_Attributes_StatusAndSpecField(t *testing.T) {
assert := assert.New(t)
require := require.New(t)

g := testutil.NewGeneratorForService(t, "apigatewayv2")
g := testutil.NewModelForService(t, "apigatewayv2")

crd := testutil.GetCRDByName(t, g, "Route")
require.NotNil(crd)
Expand All @@ -99,7 +99,7 @@ func TestCheckRequiredFields_RenamedSpecField(t *testing.T) {
assert := assert.New(t)
require := require.New(t)

g := testutil.NewGeneratorForService(t, "eks")
g := testutil.NewModelForService(t, "eks")

crd := testutil.GetCRDByName(t, g, "FargateProfile")
require.NotNil(crd)
Expand Down
4 changes: 2 additions & 2 deletions pkg/generate/code/compare_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ func TestCompareResource_S3_Bucket(t *testing.T) {
assert := assert.New(t)
require := require.New(t)

g := testutil.NewGeneratorForService(t, "s3")
g := testutil.NewModelForService(t, "s3")

crd := testutil.GetCRDByName(t, g, "Bucket")
require.NotNil(crd)
Expand Down Expand Up @@ -108,7 +108,7 @@ func TestCompareResource_Lambda_CodeSigningConfig(t *testing.T) {
assert := assert.New(t)
require := require.New(t)

g := testutil.NewGeneratorForService(t, "lambda")
g := testutil.NewModelForService(t, "lambda")

crd := testutil.GetCRDByName(t, g, "CodeSigningConfig")
require.NotNil(crd)
Expand Down
Loading