deprecate fn wrap, xargs, sink, source commands

kubernetes-sigs · Jul 30, 2021 · d721487 · d721487
1 parent 3ebdb3f
commit d721487
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 15 deletions.
diff --git a/cmd/config/internal/commands/cmdwrap.go b/cmd/config/internal/commands/cmdwrap.go
@@ -50,6 +50,8 @@ Environment Variables:
 		SilenceUsage:       true,
 		FParseErrWhitelist: cobra.FParseErrWhitelist{UnknownFlags: true},
 		Args:               cobra.MinimumNArgs(1),
+		Deprecated: "this will no longer be available in kustomize v5.\n" +
+			"See discussion in https://github.com/kubernetes-sigs/kustomize/issues/3953.",
 	}
 	r.Command = c
 	r.XArgs = GetXArgsRunner()

diff --git a/cmd/config/internal/commands/cmdwrap_test.go b/cmd/config/internal/commands/cmdwrap_test.go
@@ -297,7 +297,7 @@ func TestCmd_wrap(t *testing.T) {
 		t.FailNow()
 	}
 
-	assert.Equal(t, output, out.String())
+	assert.Contains(t, out.String(), output)
 }
 
 func TestCmd_wrapNoMerge(t *testing.T) {
@@ -326,7 +326,7 @@ func TestCmd_wrapNoMerge(t *testing.T) {
 		t.FailNow()
 	}
 
-	assert.Equal(t, outputNoMerge, out.String())
+	assert.Contains(t, out.String(), outputNoMerge)
 }
 
 func TestCmd_wrapOverride(t *testing.T) {
@@ -355,5 +355,5 @@ func TestCmd_wrapOverride(t *testing.T) {
 		t.FailNow()
 	}
 
-	assert.Equal(t, outputOverride, out.String())
+	assert.Contains(t, out.String(), outputOverride)
 }
diff --git a/cmd/config/internal/commands/cmdxargs.go b/cmd/config/internal/commands/cmdxargs.go
@@ -63,6 +63,8 @@ $ kyaml cat pkg/ --function-config config.yaml --wrap-kind ResourceList | kyaml
 		SilenceUsage:       true,
 		FParseErrWhitelist: cobra.FParseErrWhitelist{UnknownFlags: true},
 		Args:               cobra.MinimumNArgs(1),
+		Deprecated: "this will no longer be available in kustomize v5.\n" +
+			"See discussion in https://github.com/kubernetes-sigs/kustomize/issues/3953.",
 	}
 	r.Command = c
 	r.Command.Flags().BoolVar(&r.EnvOnly, "env-only", false, "only add env vars, not flags")

diff --git a/cmd/config/internal/commands/cmdxargs_test.go b/cmd/config/internal/commands/cmdxargs_test.go
@@ -85,7 +85,7 @@ func TestXArgs_flags(t *testing.T) {
 	if !assert.NoError(t, c.Command.Execute()) {
 		t.FailNow()
 	}
-	assert.Equal(t, strings.TrimSpace(`--a=b --c=d --e=f 1 3 2 4`), strings.TrimSpace(out.String()))
+	assert.Contains(t, strings.TrimSpace(out.String()), strings.TrimSpace(`--a=b --c=d --e=f 1 3 2 4`))
 }
 
 func TestXArgs_input(t *testing.T) {
@@ -99,7 +99,7 @@ func TestXArgs_input(t *testing.T) {
 	if !assert.NoError(t, c.Command.Execute()) {
 		t.FailNow()
 	}
-	assert.Equal(t, resourceOutput, out.String())
+	assert.Contains(t, out.String(), resourceOutput)
 }
 
 func TestCmd_env(t *testing.T) {

diff --git a/cmd/config/internal/commands/sink.go b/cmd/config/internal/commands/sink.go
@@ -21,6 +21,8 @@ func GetSinkRunner(name string) *SinkRunner {
 		Example: commands.SinkExamples,
 		RunE:    r.runE,
 		Args:    cobra.MaximumNArgs(1),
+		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

diff --git a/cmd/config/internal/commands/sink_test.go b/cmd/config/internal/commands/sink_test.go
@@ -290,7 +290,7 @@ metadata:
 spec:
   replicas: 3
 `
-	if !assert.Equal(t, expected, out.String()) {
+	if !assert.Contains(t, out.String(), expected) {
 		t.FailNow()
 	}
 }
@@ -335,7 +335,7 @@ items:
   }
 }
 `
-	if !assert.Equal(t, expected, out.String()) {
+	if !assert.Contains(t, out.String(), expected) {
 		println(out.String())
 		t.FailNow()
 	}

diff --git a/cmd/config/internal/commands/source.go b/cmd/config/internal/commands/source.go
@@ -22,6 +22,8 @@ func GetSourceRunner(name string) *SourceRunner {
 		Long:    commands.SourceLong,
 		Example: commands.SourceExamples,
 		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.WrapKind, "wrap-kind", kio.ResourceListKind,

diff --git a/cmd/config/internal/commands/source_test.go b/cmd/config/internal/commands/source_test.go
@@ -81,7 +81,7 @@ spec:
 		return
 	}
 
-	if !assert.Equal(t, `apiVersion: config.kubernetes.io/v1alpha1
+	if !assert.Contains(t, b.String(), `apiVersion: config.kubernetes.io/v1alpha1
 kind: ResourceList
 items:
 - kind: Deployment
@@ -130,7 +130,7 @@ items:
       config.kubernetes.io/path: 'f2.yaml'
   spec:
     replicas: 3
-`, b.String()) {
+`) {
 		return
 	}
 }
@@ -191,12 +191,12 @@ func TestSourceCommandJSON(t *testing.T) {
 		return
 	}
 
-	if !assert.Equal(t, `apiVersion: config.kubernetes.io/v1alpha1
+	if !assert.Contains(t, b.String(), `apiVersion: config.kubernetes.io/v1alpha1
 kind: ResourceList
 items:
 - {"kind": "Deployment", "metadata": {"labels": {"app": "nginx2"}, "name": "foo", "annotations": {"app": "nginx2", config.kubernetes.io/index: '0', config.kubernetes.io/path: 'f1.json'}}, "spec": {"replicas": 1}}
 - {"apiVersion": "v1", "kind": "Abstraction", "metadata": {"name": "foo", "annotations": {"config.kubernetes.io/function": "container:\n  image: gcr.io/example/reconciler:v1\n", "config.kubernetes.io/local-config": "true", config.kubernetes.io/index: '0', config.kubernetes.io/path: 'f2.json'}}, "spec": {"replicas": 3}}
-`, b.String()) {
+`) {
 		return
 	}
 }
@@ -238,7 +238,7 @@ spec:
 		return
 	}
 
-	if !assert.Equal(t, `apiVersion: config.kubernetes.io/v1alpha1
+	if !assert.Contains(t, out.String(), `apiVersion: config.kubernetes.io/v1alpha1
 kind: ResourceList
 items:
 - kind: Deployment
@@ -260,7 +260,7 @@ items:
   spec:
     selector:
       app: nginx
-`, out.String()) {
+`) {
 		return
 	}
 }
@@ -299,11 +299,11 @@ func TestSourceCommandJSON_Stdin(t *testing.T) {
 		return
 	}
 
-	if !assert.Equal(t, `apiVersion: config.kubernetes.io/v1alpha1
+	if !assert.Contains(t, out.String(), `apiVersion: config.kubernetes.io/v1alpha1
 kind: ResourceList
 items:
 - {"kind": "Deployment", "metadata": {"labels": {"app": "nginx2"}, "name": "foo", "annotations": {"app": "nginx2", config.kubernetes.io/index: '0'}}, "spec": {"replicas": 1}}
-`, out.String()) {
+`) {
 		return
 	}
 }