Skip to content

Commit 0cfafdd

Browse files
yufeimindsstormqueen1990
authored andcommitted
feat: add remove secret command
(cherry picked from commit 63d44f5) chore: fix for lint (cherry picked from commit 21edcd0) fix: correct lint issues (cherry picked from commit 0c87856) fix: Resolve conversations (cherry picked from commit 9ee5ab3)
1 parent e3b9afc commit 0cfafdd

File tree

3 files changed

+180
-0
lines changed

3 files changed

+180
-0
lines changed

kustomize/commands/edit/remove/all.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ func NewCmdRemove(
2525
# Removes one or more configmap from the kustomization file
2626
kustomize edit remove configmap {name1},{name2}
2727
28+
# Removes one or more secret from the kustomization file
29+
kustomize edit remove secret {name1},{name2}
30+
2831
# Removes one or more patches from the kustomization file
2932
kustomize edit remove patch --path {filepath} --group {target group name} --version {target version}
3033
@@ -41,6 +44,7 @@ func NewCmdRemove(
4144
}
4245
c.AddCommand(
4346
newCmdRemoveConfigMap(fSys),
47+
newCmdRemoveSecret(fSys),
4448
newCmdRemoveResource(fSys),
4549
newCmdRemoveLabel(fSys, v.MakeLabelNameValidator()),
4650
newCmdRemoveAnnotation(fSys, v.MakeAnnotationNameValidator()),
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
// Copyright 2019 The Kubernetes Authors.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
package remove
5+
6+
import (
7+
"errors"
8+
"fmt"
9+
"log"
10+
"strings"
11+
12+
"github.com/spf13/cobra"
13+
"sigs.k8s.io/kustomize/api/konfig"
14+
"sigs.k8s.io/kustomize/api/types"
15+
"sigs.k8s.io/kustomize/kustomize/v4/commands/internal/kustfile"
16+
"sigs.k8s.io/kustomize/kyaml/filesys"
17+
)
18+
19+
type removeSecretOptions struct {
20+
secretNamesToRemove []string
21+
}
22+
23+
// newCmdRemoveSecret remove the name of a file containing a secret to the kustomization file.
24+
func newCmdRemoveSecret(fSys filesys.FileSystem) *cobra.Command {
25+
var o removeSecretOptions
26+
27+
cmd := &cobra.Command{
28+
Use: "secret",
29+
Short: "Removes specified secret" +
30+
konfig.DefaultKustomizationFileName(),
31+
Example: `
32+
remove secret my-secret
33+
`,
34+
RunE: func(cmd *cobra.Command, args []string) error {
35+
err := o.Validate(args)
36+
if err != nil {
37+
return err
38+
}
39+
return o.RunRemoveSecret(fSys)
40+
},
41+
}
42+
return cmd
43+
}
44+
45+
// Validate validates removeSecret command.
46+
func (o *removeSecretOptions) Validate(args []string) error {
47+
if len(args) == 0 {
48+
return errors.New("must specify a Secret name")
49+
}
50+
if len(args) > 1 {
51+
return fmt.Errorf("too many arguments: %s; to provide multiple Secrets to remove, please separate Secret names by commas", args)
52+
}
53+
o.secretNamesToRemove = strings.Split(args[0], ",")
54+
return nil
55+
}
56+
57+
// RunRemoveSecret runs Secret command (do real work).
58+
func (o *removeSecretOptions) RunRemoveSecret(fSys filesys.FileSystem) error {
59+
mf, err := kustfile.NewKustomizationFile(fSys)
60+
if err != nil {
61+
return fmt.Errorf("could not read kustomization file: %w", err)
62+
}
63+
64+
m, err := mf.Read()
65+
if err != nil {
66+
return fmt.Errorf("could not read kustomization file: %w", err)
67+
}
68+
69+
foundSecrets := make(map[string]struct{})
70+
71+
newSecrets := make([]types.SecretArgs, 0, len(m.SecretGenerator))
72+
for _, currentSecret := range m.SecretGenerator {
73+
if kustfile.StringInSlice(currentSecret.Name, o.secretNamesToRemove) {
74+
foundSecrets[currentSecret.Name] = struct{}{}
75+
continue
76+
}
77+
newSecrets = append(newSecrets, currentSecret)
78+
}
79+
80+
for _, name := range o.secretNamesToRemove {
81+
if _, found := foundSecrets[name]; !found {
82+
log.Printf("secret %s doesn't exist in kustomization file", name)
83+
}
84+
}
85+
m.SecretGenerator = newSecrets
86+
87+
err = mf.Write(m)
88+
if err != nil {
89+
return fmt.Errorf("secret cannot write back to file, got %w", err)
90+
}
91+
return nil
92+
}
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
// Copyright 2019 The Kubernetes Authors.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
package remove //nolint:testpackage
5+
6+
import (
7+
"fmt"
8+
"strings"
9+
"testing"
10+
11+
"github.com/stretchr/testify/assert"
12+
testutils_test "sigs.k8s.io/kustomize/kustomize/v4/commands/internal/testutils"
13+
"sigs.k8s.io/kustomize/kyaml/filesys"
14+
)
15+
16+
func TestRemoveSecret(t *testing.T) {
17+
const secretName01 = "example-secret-01"
18+
const secretName02 = "example-secret-02"
19+
20+
tests := map[string]struct {
21+
input string
22+
args []string
23+
expectedErr string
24+
}{
25+
"happy path": {
26+
input: fmt.Sprintf(`
27+
apiVersion: kustomize.config.k8s.io/v1beta1
28+
kind: Kustomization
29+
secretGenerator:
30+
- name: %s
31+
files:
32+
- longsecret.txt
33+
`, secretName01),
34+
args: []string{secretName01},
35+
},
36+
"multiple": {
37+
input: fmt.Sprintf(`
38+
apiVersion: kustomize.config.k8s.io/v1beta1
39+
kind: Kustomization
40+
secretGenerator:
41+
- name: %s
42+
files:
43+
- longsecret.txt
44+
- name: %s
45+
files:
46+
- longsecret.txt
47+
`, secretName01, secretName02),
48+
args: []string{
49+
fmt.Sprintf("%s,%s", secretName01, secretName02),
50+
},
51+
},
52+
"miss": {
53+
input: fmt.Sprintf(`
54+
apiVersion: kustomize.config.k8s.io/v1beta1
55+
kind: Kustomization
56+
secretGenerator:
57+
- name: %s
58+
files:
59+
- longsecret.txt
60+
`, secretName01),
61+
args: []string{"foo"},
62+
},
63+
}
64+
65+
for name, tc := range tests {
66+
t.Run(name, func(t *testing.T) {
67+
fSys := filesys.MakeFsInMemory()
68+
testutils_test.WriteTestKustomizationWith(fSys, []byte(tc.input))
69+
cmd := newCmdRemoveSecret(fSys)
70+
err := cmd.RunE(cmd, tc.args)
71+
if tc.expectedErr != "" {
72+
assert.Error(t, err)
73+
assert.Contains(t, err.Error(), tc.expectedErr)
74+
} else {
75+
assert.NoError(t, err)
76+
content, err := testutils_test.ReadTestKustomization(fSys)
77+
assert.NoError(t, err)
78+
for _, opt := range strings.Split(tc.args[0], ",") {
79+
assert.NotContains(t, string(content), opt)
80+
}
81+
}
82+
})
83+
}
84+
}

0 commit comments

Comments
 (0)