Skip to content

Commit

Permalink
chore(pkger): finalize adoption of templates naming convention
Browse files Browse the repository at this point in the history 
closes: influxdata#18580
  • Loading branch information
@jsteenb2
jsteenb2 committed Jun 30, 2020
1 parent 5776350 commit b9e6744
Show file tree
Hide file tree
Showing 23 changed files with 1,064 additions and 1,070 deletions.
2 changes: 1 addition & 1 deletion cmd/chronograf-migrator/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ func exec(dbPath, out string) error {
return err
}

pkg := &pkger.Pkg{
pkg := &pkger.Template{
Objects: make([]pkger.Object, 0),
}

Expand Down
20 changes: 10 additions & 10 deletions cmd/influx/template.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ func (b *cmdTemplateBuilder) applyRunEFn(cmd *cobra.Command, args []string) erro
}

opts := []pkger.ApplyOptFn{
pkger.ApplyWithPkg(template),
pkger.ApplyWithTemplate(template),
pkger.ApplyWithEnvRefs(providedEnvRefs),
pkger.ApplyWithStackID(stackID),
}
Expand Down Expand Up @@ -1059,7 +1059,7 @@ func (b *cmdTemplateBuilder) exportTemplate(w io.Writer, templateSVC pkger.SVC,
return b.writeTemplate(w, outPath, template)
}

func (b *cmdTemplateBuilder) writeTemplate(w io.Writer, outPath string, template *pkger.Pkg) error {
func (b *cmdTemplateBuilder) writeTemplate(w io.Writer, outPath string, template *pkger.Template) error {
buf, err := createTemplateBuf(template, outPath)
if err != nil {
return err
Expand All @@ -1073,7 +1073,7 @@ func (b *cmdTemplateBuilder) writeTemplate(w io.Writer, outPath string, template
return ioutil.WriteFile(outPath, buf.Bytes(), os.ModePerm)
}

func (b *cmdTemplateBuilder) readRawTemplatesFromFiles(filePaths []string, recurse bool) ([]*pkger.Pkg, error) {
func (b *cmdTemplateBuilder) readRawTemplatesFromFiles(filePaths []string, recurse bool) ([]*pkger.Template, error) {
mFiles := make(map[string]struct{})
for _, f := range filePaths {
files, err := readFilesFromPath(f, recurse)
Expand All @@ -1085,7 +1085,7 @@ func (b *cmdTemplateBuilder) readRawTemplatesFromFiles(filePaths []string, recur
}
}

var rawTemplates []*pkger.Pkg
var rawTemplates []*pkger.Template
for f := range mFiles {
template, err := pkger.Parse(b.convertFileEncoding(f), pkger.FromFile(f), pkger.ValidSkipParseError())
if err != nil {
Expand All @@ -1097,13 +1097,13 @@ func (b *cmdTemplateBuilder) readRawTemplatesFromFiles(filePaths []string, recur
return rawTemplates, nil
}

func (b *cmdTemplateBuilder) readRawTemplatesFromURLs(urls []string) ([]*pkger.Pkg, error) {
func (b *cmdTemplateBuilder) readRawTemplatesFromURLs(urls []string) ([]*pkger.Template, error) {
mURLs := make(map[string]struct{})
for _, f := range urls {
mURLs[f] = struct{}{}
}

var rawTemplates []*pkger.Pkg
var rawTemplates []*pkger.Template
for u := range mURLs {
template, err := pkger.Parse(b.convertURLEncoding(u), pkger.FromHTTPRequest(u), pkger.ValidSkipParseError())
if err != nil {
Expand All @@ -1114,7 +1114,7 @@ func (b *cmdTemplateBuilder) readRawTemplatesFromURLs(urls []string) ([]*pkger.P
return rawTemplates, nil
}

func (b *cmdTemplateBuilder) readTemplate() (*pkger.Pkg, bool, error) {
func (b *cmdTemplateBuilder) readTemplate() (*pkger.Template, bool, error) {
var remotes, files []string
for _, rawURL := range append(b.files, b.urls...) {
u, err := url.Parse(rawURL)
Expand Down Expand Up @@ -1280,7 +1280,7 @@ func toInfluxIDs(args []string) ([]influxdb.ID, error) {
return ids, nil
}

func createTemplateBuf(template *pkger.Pkg, outPath string) (*bytes.Buffer, error) {
func createTemplateBuf(template *pkger.Template, outPath string) (*bytes.Buffer, error) {
var encoding pkger.Encoding
switch ext := filepath.Ext(outPath); ext {
case ".json":
Expand Down Expand Up @@ -1601,7 +1601,7 @@ func (b *cmdTemplateBuilder) printTemplateDiff(diff pkger.Diff) error {
Title("Label Associations").
SetHeaders(
"Resource Type",
"Resource Package Name", "Resource Name", "Resource ID",
"Resource Meta Name", "Resource Name", "Resource ID",
"Label Package Name", "Label Name", "Label ID",
)

Expand Down Expand Up @@ -1718,7 +1718,7 @@ func (b *cmdTemplateBuilder) printTemplateSummary(stackID influxdb.ID, sum pkger
v.Description,
v.Every,
v.Offset,
v.EndpointPkgName,
v.EndpointMetaName,
v.EndpointID.String(),
v.EndpointType,
}
Expand Down
42 changes: 21 additions & 21 deletions cmd/influx/template_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ func Test_Template_Commands(t *testing.T) {
}

t.Run("export all", func(t *testing.T) {
defaultAssertFn := func(t *testing.T, pkg *pkger.Pkg) {
defaultAssertFn := func(t *testing.T, pkg *pkger.Template) {
t.Helper()
sum := pkg.Summary()

Expand All @@ -47,7 +47,7 @@ func Test_Template_Commands(t *testing.T) {

tests := []struct {
templateFileArgs
assertFn func(t *testing.T, pkg *pkger.Pkg)
assertFn func(t *testing.T, pkg *pkger.Template)
}{
{
templateFileArgs: templateFileArgs{
Expand Down Expand Up @@ -91,7 +91,7 @@ func Test_Template_Commands(t *testing.T) {
"--filter=labelName=foo",
},
},
assertFn: func(t *testing.T, pkg *pkger.Pkg) {
assertFn: func(t *testing.T, pkg *pkger.Template) {
defaultAssertFn(t, pkg)

sum := pkg.Summary()
Expand All @@ -111,7 +111,7 @@ func Test_Template_Commands(t *testing.T) {
"--filter=labelName=bar",
},
},
assertFn: func(t *testing.T, pkg *pkger.Pkg) {
assertFn: func(t *testing.T, pkg *pkger.Template) {
defaultAssertFn(t, pkg)

sum := pkg.Summary()
Expand All @@ -131,7 +131,7 @@ func Test_Template_Commands(t *testing.T) {
"--filter=resourceKind=Dashboard",
},
},
assertFn: func(t *testing.T, pkg *pkger.Pkg) {
assertFn: func(t *testing.T, pkg *pkger.Template) {
sum := pkg.Summary()

require.Len(t, sum.Dashboards, 1)
Expand All @@ -149,7 +149,7 @@ func Test_Template_Commands(t *testing.T) {
"--filter=resourceKind=Bucket",
},
},
assertFn: func(t *testing.T, pkg *pkger.Pkg) {
assertFn: func(t *testing.T, pkg *pkger.Template) {
sum := pkg.Summary()

require.Len(t, sum.Buckets, 1)
Expand All @@ -170,7 +170,7 @@ func Test_Template_Commands(t *testing.T) {
"--filter=resourceKind=Bucket",
},
},
assertFn: func(t *testing.T, pkg *pkger.Pkg) {
assertFn: func(t *testing.T, pkg *pkger.Template) {
sum := pkg.Summary()

require.Len(t, sum.Labels, 1)
Expand All @@ -185,7 +185,7 @@ func Test_Template_Commands(t *testing.T) {

cmdFn := func(f *globalFlags, opt genericCLIOpts) *cobra.Command {
pkgSVC := &fakePkgSVC{
exportFn: func(_ context.Context, opts ...pkger.ExportOptFn) (*pkger.Pkg, error) {
exportFn: func(_ context.Context, opts ...pkger.ExportOptFn) (*pkger.Template, error) {
opt := pkger.ExportOpt{}
for _, o := range opts {
if err := o(&opt); err != nil {
Expand All @@ -198,7 +198,7 @@ func Test_Template_Commands(t *testing.T) {
return nil, errors.New("did not provide expected orgID")
}

var pkg pkger.Pkg
var pkg pkger.Template
for _, labelName := range orgIDOpt.LabelNames {
pkg.Objects = append(pkg.Objects, pkger.Object{
APIVersion: pkger.APIVersion,
Expand Down Expand Up @@ -324,15 +324,15 @@ func Test_Template_Commands(t *testing.T) {

cmdFn := func(f *globalFlags, opt genericCLIOpts) *cobra.Command {
pkgSVC := &fakePkgSVC{
exportFn: func(_ context.Context, opts ...pkger.ExportOptFn) (*pkger.Pkg, error) {
exportFn: func(_ context.Context, opts ...pkger.ExportOptFn) (*pkger.Template, error) {
var opt pkger.ExportOpt
for _, o := range opts {
if err := o(&opt); err != nil {
return nil, err
}
}

var pkg pkger.Pkg
var pkg pkger.Template
for _, rc := range opt.Resources {
if rc.Kind == pkger.KindNotificationEndpoint {
rc.Kind = pkger.KindNotificationEndpointHTTP
Expand Down Expand Up @@ -365,7 +365,7 @@ func Test_Template_Commands(t *testing.T) {
"--variables="+idsStr(tt.varIDs...),
)

testPkgWrites(t, cmdFn, tt.templateFileArgs, func(t *testing.T, pkg *pkger.Pkg) {
testPkgWrites(t, cmdFn, tt.templateFileArgs, func(t *testing.T, pkg *pkger.Template) {
sum := pkg.Summary()

kindToName := func(k pkger.Kind, id influxdb.ID) string {
Expand Down Expand Up @@ -419,7 +419,7 @@ func Test_Template_Commands(t *testing.T) {
t.Run("by stack", func(t *testing.T) {
cmdFn := func(f *globalFlags, opt genericCLIOpts) *cobra.Command {
pkgSVC := &fakePkgSVC{
exportFn: func(_ context.Context, opts ...pkger.ExportOptFn) (*pkger.Pkg, error) {
exportFn: func(_ context.Context, opts ...pkger.ExportOptFn) (*pkger.Template, error) {
var opt pkger.ExportOpt
for _, o := range opts {
if err := o(&opt); err != nil {
Expand All @@ -430,7 +430,7 @@ func Test_Template_Commands(t *testing.T) {
if opt.StackID != 1 {
return nil, errors.New("wrong stack ID, got: " + opt.StackID.String())
}
return &pkger.Pkg{
return &pkger.Template{
Objects: []pkger.Object{
pkger.LabelToObject("", influxdb.Label{
Name: "label-1",
Expand All @@ -451,7 +451,7 @@ func Test_Template_Commands(t *testing.T) {
args: []string{"export", "--stack-id=" + influxdb.ID(1).String()},
}

testPkgWrites(t, cmdFn, tmplFileArgs, func(t *testing.T, pkg *pkger.Pkg) {
testPkgWrites(t, cmdFn, tmplFileArgs, func(t *testing.T, pkg *pkger.Template) {
sum := pkg.Summary()

require.Len(t, sum.Labels, 1)
Expand Down Expand Up @@ -694,7 +694,7 @@ type templateFileArgs struct {
envVars map[string]string
}

func testPkgWrites(t *testing.T, newCmdFn func(*globalFlags, genericCLIOpts) *cobra.Command, args templateFileArgs, assertFn func(t *testing.T, pkg *pkger.Pkg)) {
func testPkgWrites(t *testing.T, newCmdFn func(*globalFlags, genericCLIOpts) *cobra.Command, args templateFileArgs, assertFn func(t *testing.T, pkg *pkger.Template)) {
t.Helper()

defer addEnvVars(t, args.envVars)()
Expand All @@ -713,7 +713,7 @@ func testPkgWrites(t *testing.T, newCmdFn func(*globalFlags, genericCLIOpts) *co
t.Run(path.Join(args.name, "buffer"), testPkgWritesToBuffer(wrappedCmdFn, args, assertFn))
}

func testPkgWritesFile(newCmdFn func(w io.Writer) *cobra.Command, args templateFileArgs, assertFn func(t *testing.T, pkg *pkger.Pkg)) func(t *testing.T) {
func testPkgWritesFile(newCmdFn func(w io.Writer) *cobra.Command, args templateFileArgs, assertFn func(t *testing.T, pkg *pkger.Template)) func(t *testing.T) {
return func(t *testing.T) {
t.Helper()

Expand All @@ -734,7 +734,7 @@ func testPkgWritesFile(newCmdFn func(w io.Writer) *cobra.Command, args templateF
}
}

func testPkgWritesToBuffer(newCmdFn func(w io.Writer) *cobra.Command, args templateFileArgs, assertFn func(t *testing.T, pkg *pkger.Pkg)) func(t *testing.T) {
func testPkgWritesToBuffer(newCmdFn func(w io.Writer) *cobra.Command, args templateFileArgs, assertFn func(t *testing.T, pkg *pkger.Template)) func(t *testing.T) {
return func(t *testing.T) {
t.Helper()

Expand All @@ -753,7 +753,7 @@ func testPkgWritesToBuffer(newCmdFn func(w io.Writer) *cobra.Command, args templ

type fakePkgSVC struct {
initStackFn func(ctx context.Context, userID influxdb.ID, stack pkger.Stack) (pkger.Stack, error)
exportFn func(ctx context.Context, setters ...pkger.ExportOptFn) (*pkger.Pkg, error)
exportFn func(ctx context.Context, setters ...pkger.ExportOptFn) (*pkger.Template, error)
dryRunFn func(ctx context.Context, orgID, userID influxdb.ID, opts ...pkger.ApplyOptFn) (pkger.ImpactSummary, error)
applyFn func(ctx context.Context, orgID, userID influxdb.ID, opts ...pkger.ApplyOptFn) (pkger.ImpactSummary, error)
}
Expand All @@ -775,7 +775,7 @@ func (f *fakePkgSVC) DeleteStack(ctx context.Context, identifiers struct{ OrgID,
panic("not implemented")
}

func (f *fakePkgSVC) ExportStack(ctx context.Context, orgID, stackID influxdb.ID) (*pkger.Pkg, error) {
func (f *fakePkgSVC) ExportStack(ctx context.Context, orgID, stackID influxdb.ID) (*pkger.Template, error) {
panic("not implemented")
}

Expand All @@ -787,7 +787,7 @@ func (f *fakePkgSVC) UpdateStack(ctx context.Context, upd pkger.StackUpdate) (pk
panic("not implemented")
}

func (f *fakePkgSVC) Export(ctx context.Context, setters ...pkger.ExportOptFn) (*pkger.Pkg, error) {
func (f *fakePkgSVC) Export(ctx context.Context, setters ...pkger.ExportOptFn) (*pkger.Template, error) {
if f.exportFn != nil {
return f.exportFn(ctx, setters...)
}
Expand Down
Loading

0 comments on commit b9e6744

Please sign in to comment.