Skip to content
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.

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

Deprecate some cfg commands #4048

Merged
merged 1 commit into from Jul 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions cmd/config/internal/commands/annotate.go
Expand Up @@ -27,6 +27,8 @@ func NewAnnotateRunner(parent string) *AnnotateRunner {
Long: commands.AnnotateLong,
Example: commands.AnnotateExamples,
RunE: r.runE,
Deprecated:
"use the `commonAnnotations` field in your kustomization file.",
}
runner.FixDocs(parent, c)
r.Command = c
Expand Down
2 changes: 1 addition & 1 deletion cmd/config/internal/commands/annotate_test.go
Expand Up @@ -559,7 +559,7 @@ added annotations in the package

expected := strings.Replace(test.expected, "${baseDir}", baseDir, -1)
expectedNormalized := strings.Replace(expected, "\\", "/", -1)
if !assert.Equal(t, expectedNormalized, actualNormalized) {
if !assert.Contains(t, actualNormalized, expectedNormalized) {
t.FailNow()
}
})
Expand Down
2 changes: 2 additions & 0 deletions cmd/config/internal/commands/cmdcreatesetter.go
Expand Up @@ -32,6 +32,8 @@ func NewCreateSetterRunner(parent string) *CreateSetterRunner {
Example: commands.CreateSetterExamples,
PreRunE: r.preRunE,
RunE: r.runE,
Deprecated: "setter commands will no longer be available in kustomize v5.\n" +
"See discussion in https://github.com/kubernetes-sigs/kustomize/issues/3953.",
}
set.Flags().StringVar(&r.FieldValue, "value", "",
"optional flag, alternative to specifying the value as an argument. e.g. used to specify values that start with '-'")
Expand Down
2 changes: 1 addition & 1 deletion cmd/config/internal/commands/cmdcreatesetter_test.go
Expand Up @@ -869,7 +869,7 @@ setter with name "namespace" already exists, if you want to modify it, please de

expected := strings.Replace(test.expected, "${baseDir}", baseDir, -1)
expectedNormalized := strings.Replace(expected, "\\", "/", -1)
if !assert.Equal(t, expectedNormalized, actualNormalized) {
if !assert.Contains(t, actualNormalized, expectedNormalized) {
t.FailNow()
}
})
Expand Down
2 changes: 2 additions & 0 deletions cmd/config/internal/commands/cmdcreatesubstitution.go
Expand Up @@ -23,6 +23,8 @@ func NewCreateSubstitutionRunner(parent string) *CreateSubstitutionRunner {
Args: cobra.ExactArgs(2),
PreRun: r.preRun,
RunE: r.runE,
Deprecated: "imperative substitutions will no longer be available in kustomize v5.\n" +
"See discussion in https://github.com/kubernetes-sigs/kustomize/issues/3953.",
}
cs.Flags().StringVar(&r.CreateSubstitution.FieldName, "field", "",
"name of the field to set -- e.g. --field image")
Expand Down
2 changes: 1 addition & 1 deletion cmd/config/internal/commands/cmdcreatesubstitution_test.go
Expand Up @@ -506,7 +506,7 @@ created substitution "image-tag"`,

expected := strings.Replace(test.expected, "${baseDir}", baseDir, -1)
expectedNormalized := strings.Replace(expected, "\\", "/", -1)
if !assert.Equal(t, strings.TrimSpace(expectedNormalized), strings.TrimSpace(actualNormalized)) {
if !assert.Contains(t, strings.TrimSpace(actualNormalized), strings.TrimSpace(expectedNormalized), ) {
t.FailNow()
}
})
Expand Down
2 changes: 2 additions & 0 deletions cmd/config/internal/commands/cmdinit.go
Expand Up @@ -26,6 +26,8 @@ func GetInitRunner(name string) *InitRunner {
Long: commands.InitLong,
Example: commands.InitExamples,
RunE: r.runE,
Deprecated: "setter commands and substitutions will no longer be available in kustomize v5.\n" +
"See discussion in https://github.com/kubernetes-sigs/kustomize/issues/3953.",
}
runner.FixDocs(name, c)
r.Command = c
Expand Down
2 changes: 2 additions & 0 deletions cmd/config/internal/commands/cmdlistsetters.go
Expand Up @@ -31,6 +31,8 @@ func NewListSettersRunner(parent string) *ListSettersRunner {
Example: commands.ListSettersExamples,
PreRunE: r.preRunE,
RunE: r.runE,
Deprecated: "setter commands will no longer be available in kustomize v5.\n" +
"See discussion in https://github.com/kubernetes-sigs/kustomize/issues/3953.",
}
c.Flags().BoolVar(&r.Markdown, "markdown", false,
"output as github markdown")
Expand Down
2 changes: 1 addition & 1 deletion cmd/config/internal/commands/cmdlistsetters_test.go
Expand Up @@ -525,7 +525,7 @@ test/testdata/dataset-with-setters/mysql/
// normalize path format for windows
actualNormalized := strings.Replace(actual.String(), "\\", "/", -1)

if !assert.Equal(t, strings.TrimSpace(test.expected), strings.TrimSpace(actualNormalized)) {
if !assert.Contains(t, strings.TrimSpace(actualNormalized), strings.TrimSpace(test.expected)) {
t.FailNow()
}
})
Expand Down
2 changes: 2 additions & 0 deletions cmd/config/internal/commands/cmdset.go
Expand Up @@ -27,6 +27,8 @@ func NewSetRunner(parent string) *SetRunner {
Example: commands.SetExamples,
PreRunE: r.preRunE,
RunE: r.runE,
Deprecated: "setter commands will no longer be available in kustomize v5.\n" +
"See discussion in https://github.com/kubernetes-sigs/kustomize/issues/3953.",
}
runner.FixDocs(parent, c)
r.Command = c
Expand Down
2 changes: 1 addition & 1 deletion cmd/config/internal/commands/cmdset_test.go
Expand Up @@ -1137,7 +1137,7 @@ set 1 field(s) of setter "namespace" to value "otherspace"
expectedNormalized := strings.Replace(
strings.Replace(expected, "\\", "/", -1),
"//", "/", -1)
if !assert.Equal(t, strings.TrimSpace(expectedNormalized), strings.TrimSpace(actualNormalized)) {
if !assert.Contains(t, strings.TrimSpace(actualNormalized), strings.TrimSpace(expectedNormalized)) {
t.FailNow()
}
})
Expand Down
2 changes: 2 additions & 0 deletions cmd/config/internal/commands/fmt.go
Expand Up @@ -25,6 +25,8 @@ func GetFmtRunner(name string) *FmtRunner {
Example: commands.FmtExamples,
RunE: r.runE,
PreRunE: r.preRunE,
Deprecated: "imperative formatting will no longer be available in kustomize v5.\n" +
"Declare a formatting transformer in your kustomization instead.",
}
runner.FixDocs(name, c)
c.Flags().StringVar(&r.FilenamePattern, "pattern", filters.DefaultFilenamePattern,
Expand Down
4 changes: 2 additions & 2 deletions cmd/config/internal/commands/fmt_test.go
Expand Up @@ -78,7 +78,7 @@ func TestFmtCommand_stdin(t *testing.T) {
assert.NoError(t, err)

// verify the output
assert.Equal(t, string(testyaml.FormattedYaml1), out.String())
assert.Contains(t, out.String(), string(testyaml.FormattedYaml1))
}

// TestCmd_filesAndstdin verifies that if both files and stdin input are provided, only
Expand Down Expand Up @@ -238,7 +238,7 @@ formatted resource files in the package

expected := strings.Replace(test.expected, "${baseDir}", baseDir, -1)
expectedNormalized := strings.Replace(expected, "\\", "/", -1)
if !assert.Equal(t, strings.TrimSpace(expectedNormalized), strings.TrimSpace(actualNormalized)) {
if !assert.Contains(t, strings.TrimSpace(actualNormalized), strings.TrimSpace(expectedNormalized), ) {
t.FailNow()
}
})
Expand Down
8 changes: 6 additions & 2 deletions cmd/config/internal/commands/init_test.go
Expand Up @@ -43,7 +43,9 @@ kind: Krmfile
t.FailNow()
}

if !assert.Equal(t, "", b.String()) {
if !assert.Equal(t, `Command "init" is deprecated, setter commands and substitutions will no longer be available in kustomize v5.
See discussion in https://github.com/kubernetes-sigs/kustomize/issues/3953.
`, b.String()) {
t.FailNow()
}
}
Expand Down Expand Up @@ -78,7 +80,9 @@ kind: Krmfile
t.FailNow()
}

if !assert.Equal(t, "", b.String()) {
if !assert.Equal(t, `Command "init" is deprecated, setter commands and substitutions will no longer be available in kustomize v5.
See discussion in https://github.com/kubernetes-sigs/kustomize/issues/3953.
`, b.String()) {
t.FailNow()
}
}
2 changes: 2 additions & 0 deletions cmd/config/internal/commands/merge.go
Expand Up @@ -19,6 +19,8 @@ func GetMergeRunner(name string) *MergeRunner {
Long: commands.MergeLong,
Example: commands.MergeExamples,
RunE: r.runE,
Deprecated: "this will no longer be available in kustomize v5.\n" +
"See discussion in https://github.com/kubernetes-sigs/kustomize/issues/3953.",
}
runner.FixDocs(name, c)
r.Command = c
Expand Down
2 changes: 2 additions & 0 deletions cmd/config/internal/commands/merge3.go
Expand Up @@ -18,6 +18,8 @@ func GetMerge3Runner(name string) *Merge3Runner {
Long: commands.Merge3Long,
Example: commands.Merge3Examples,
RunE: r.runE,
Deprecated: "this will no longer be available in kustomize v5.\n" +
"See discussion in https://github.com/kubernetes-sigs/kustomize/issues/3953.",
}
runner.FixDocs(name, c)
c.Flags().StringVar(&r.ancestor, "ancestor", "",
Expand Down