Skip to content

Commit 3935074

Browse files
allencloudallencloud
committed
make secret ls support filters in CLI
Signed-off-by: allencloud <[email protected]>
1 parent 08544b1 commit 3935074

6 files changed

Lines changed: 259 additions & 7 deletions

File tree

‎api/swagger.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7974,6 +7974,9 @@ paths:
79747974
description: |
79757975
A JSON encoded value of the filters (a `map[string][]string`) to process on the secrets list. Available filters:
79767976
7977+
- `id=<secret id>`
7978+
- `label=<key> or label=<key>=value`
7979+
- `name=<secret name>`
79777980
- `names=<secret name>`
79787981
tags: ["Secret"]
79797982
/secrets/create:

‎cli/command/secret/ls.go‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,19 @@ import (
55
"github.com/docker/docker/cli"
66
"github.com/docker/docker/cli/command"
77
"github.com/docker/docker/cli/command/formatter"
8+
"github.com/docker/docker/opts"
89
"github.com/spf13/cobra"
910
"golang.org/x/net/context"
1011
)
1112

1213
type listOptions struct {
1314
quiet bool
1415
format string
16+
filter opts.FilterOpt
1517
}
1618

1719
func newSecretListCommand(dockerCli *command.DockerCli) *cobra.Command {
18-
opts := listOptions{}
20+
opts := listOptions{filter: opts.NewFilterOpt()}
1921

2022
cmd := &cobra.Command{
2123
Use: "ls [OPTIONS]",
@@ -30,6 +32,7 @@ func newSecretListCommand(dockerCli *command.DockerCli) *cobra.Command {
3032
flags := cmd.Flags()
3133
flags.BoolVarP(&opts.quiet, "quiet", "q", false, "Only display IDs")
3234
flags.StringVarP(&opts.format, "format", "", "", "Pretty-print secrets using a Go template")
35+
flags.VarP(&opts.filter, "filter", "f", "Filter output based on conditions provided")
3336

3437
return cmd
3538
}
@@ -38,7 +41,7 @@ func runSecretList(dockerCli *command.DockerCli, opts listOptions) error {
3841
client := dockerCli.Client()
3942
ctx := context.Background()
4043

41-
secrets, err := client.SecretList(ctx, types.SecretListOptions{})
44+
secrets, err := client.SecretList(ctx, types.SecretListOptions{Filters: opts.filter.Value()})
4245
if err != nil {
4346
return err
4447
}

‎cli/command/service/parse.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ func ParseSecrets(client client.SecretAPIClient, requestedSecrets []*swarmtypes.
2727

2828
args := filters.NewArgs()
2929
for _, s := range secretRefs {
30-
args.Add("names", s.SecretName)
30+
args.Add("name", s.SecretName)
3131
}
3232

3333
secrets, err := client.SecretList(ctx, types.SecretListOptions{

‎daemon/cluster/filters_test.go‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
package cluster
2+
3+
import (
4+
"testing"
5+
6+
"github.com/docker/docker/api/types/filters"
7+
)
8+
9+
func TestNewListSecretsFilters(t *testing.T) {
10+
validNameFilter := filters.NewArgs()
11+
validNameFilter.Add("name", "test_name")
12+
13+
validIDFilter := filters.NewArgs()
14+
validIDFilter.Add("id", "7c9009d6720f6de3b492f5")
15+
16+
validLabelFilter := filters.NewArgs()
17+
validLabelFilter.Add("label", "type=test")
18+
validLabelFilter.Add("label", "storage=ssd")
19+
validLabelFilter.Add("label", "memory")
20+
21+
validNamesFilter := filters.NewArgs()
22+
validNamesFilter.Add("names", "test_name")
23+
24+
validAllFilter := filters.NewArgs()
25+
validAllFilter.Add("name", "nodeName")
26+
validAllFilter.Add("id", "7c9009d6720f6de3b492f5")
27+
validAllFilter.Add("label", "type=test")
28+
validAllFilter.Add("label", "memory")
29+
validAllFilter.Add("names", "test_name")
30+
31+
validFilters := []filters.Args{
32+
validNameFilter,
33+
validIDFilter,
34+
validLabelFilter,
35+
validNamesFilter,
36+
validAllFilter,
37+
}
38+
39+
invalidTypeFilter := filters.NewArgs()
40+
invalidTypeFilter.Add("nonexist", "aaaa")
41+
42+
invalidFilters := []filters.Args{
43+
invalidTypeFilter,
44+
}
45+
46+
for _, filter := range validFilters {
47+
if _, err := newListSecretsFilters(filter); err != nil {
48+
t.Fatalf("Should get no error, got %v", err)
49+
}
50+
}
51+
52+
for _, filter := range invalidFilters {
53+
if _, err := newListSecretsFilters(filter); err == nil {
54+
t.Fatalf("Should get an error for filter %s, while got nil", filter)
55+
}
56+
}
57+
}

‎docs/reference/commandline/secret_ls.md‎

Lines changed: 68 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ Aliases:
2424
ls, list
2525

2626
Options:
27-
-q, --quiet Only display IDs
28-
-format string Pretty-print secrets using a Go template
27+
-f, --filter filter Filter output based on conditions provided
28+
--format string Pretty-print secrets using a Go template
29+
--help Print usage
30+
-q, --quiet Only display IDs
2931
```
3032

3133
## Description
@@ -37,8 +39,70 @@ Run this command on a manager node to list the secrets in the swarm.
3739
```bash
3840
$ docker secret ls
3941

40-
ID NAME CREATED UPDATED
41-
eo7jnzguqgtpdah3cm5srfb97 my_secret 11 minutes ago 11 minutes ago
42+
ID NAME CREATED UPDATED
43+
6697bflskwj1998km1gnnjr38 q5s5570vtvnimefos1fyeo2u2 6 weeks ago 6 weeks ago
44+
9u9hk4br2ej0wgngkga6rp4hq my_secret 5 weeks ago 5 weeks ago
45+
mem02h8n73mybpgqjf0kfi1n0 test_secret 3 seconds ago 3 seconds ago
46+
```
47+
48+
### Filtering
49+
50+
The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there is more
51+
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
52+
53+
The currently supported filters are:
54+
55+
* [id](secret_ls.md#id) (secret's ID)
56+
* [label](secret_ls.md#label) (`label=<key>` or `label=<key>=<value>`)
57+
* [name](secret_ls.md#name) (secret's name)
58+
59+
#### id
60+
61+
The `id` filter matches all or prefix of a secret's id.
62+
63+
```bash
64+
$ docker secret ls -f "id=6697bflskwj1998km1gnnjr38"
65+
66+
ID NAME CREATED UPDATED
67+
6697bflskwj1998km1gnnjr38 q5s5570vtvnimefos1fyeo2u2 6 weeks ago 6 weeks ago
68+
```
69+
70+
#### label
71+
72+
The `label` filter matches secrets based on the presence of a `label` alone or
73+
a `label` and a value.
74+
75+
The following filter matches all secrets with a `project` label regardless of
76+
its value:
77+
78+
```bash
79+
$ docker secret ls --filter label=project
80+
81+
ID NAME CREATED UPDATED
82+
mem02h8n73mybpgqjf0kfi1n0 test_secret About an hour ago About an hour ago
83+
```
84+
85+
The following filter matches only services with the `project` label with the
86+
`project-a` value.
87+
88+
```bash
89+
$ docker service ls --filter label=project=test
90+
91+
ID NAME CREATED UPDATED
92+
mem02h8n73mybpgqjf0kfi1n0 test_secret About an hour ago About an hour ago
93+
```
94+
95+
#### name
96+
97+
The `name` filter matches on all or prefix of a secret's name.
98+
99+
The following filter matches secret with a name containing a prefix of `test`.
100+
101+
```bash
102+
$ docker secret ls --filter name=test_secret
103+
104+
ID NAME CREATED UPDATED
105+
mem02h8n73mybpgqjf0kfi1n0 test_secret About an hour ago About an hour ago
42106
```
43107

44108
### Format the output

‎integration-cli/docker_cli_secret_ls_test.go‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
// +build !windows
2+
3+
package main
4+
5+
import (
6+
"strings"
7+
8+
"github.com/docker/docker/api/types/swarm"
9+
"github.com/docker/docker/integration-cli/checker"
10+
"github.com/go-check/check"
11+
)
12+
13+
func (s *DockerSwarmSuite) TestSecretList(c *check.C) {
14+
d := s.AddDaemon(c, true, true)
15+
16+
testName0 := "test0"
17+
testName1 := "test1"
18+
19+
// create secret test0
20+
id0 := d.CreateSecret(c, swarm.SecretSpec{
21+
Annotations: swarm.Annotations{
22+
Name: testName0,
23+
Labels: map[string]string{"type": "test"},
24+
},
25+
Data: []byte("TESTINGDATA0"),
26+
})
27+
c.Assert(id0, checker.Not(checker.Equals), "", check.Commentf("secrets: %s", id0))
28+
29+
secret := d.GetSecret(c, id0)
30+
c.Assert(secret.Spec.Name, checker.Equals, testName0)
31+
32+
// create secret test1
33+
id1 := d.CreateSecret(c, swarm.SecretSpec{
34+
Annotations: swarm.Annotations{
35+
Name: testName1,
36+
Labels: map[string]string{"type": "production"},
37+
},
38+
Data: []byte("TESTINGDATA1"),
39+
})
40+
c.Assert(id1, checker.Not(checker.Equals), "", check.Commentf("secrets: %s", id1))
41+
42+
secret = d.GetSecret(c, id1)
43+
c.Assert(secret.Spec.Name, checker.Equals, testName1)
44+
45+
// test by command `docker secret ls`
46+
out, err := d.Cmd("secret", "ls")
47+
c.Assert(err, checker.IsNil, check.Commentf(out))
48+
c.Assert(strings.TrimSpace(out), checker.Contains, testName0)
49+
c.Assert(strings.TrimSpace(out), checker.Contains, testName1)
50+
51+
// test filter by name `docker secret ls --filter name=xxx`
52+
args := []string{
53+
"secret",
54+
"ls",
55+
"--filter",
56+
"name=test0",
57+
}
58+
out, err = d.Cmd(args...)
59+
c.Assert(err, checker.IsNil, check.Commentf(out))
60+
61+
c.Assert(strings.TrimSpace(out), checker.Contains, testName0)
62+
c.Assert(strings.TrimSpace(out), checker.Not(checker.Contains), testName1)
63+
64+
// test filter by id `docker secret ls --filter id=xxx`
65+
args = []string{
66+
"secret",
67+
"ls",
68+
"--filter",
69+
"id=" + id1,
70+
}
71+
out, err = d.Cmd(args...)
72+
c.Assert(err, checker.IsNil, check.Commentf(out))
73+
74+
c.Assert(strings.TrimSpace(out), checker.Not(checker.Contains), testName0)
75+
c.Assert(strings.TrimSpace(out), checker.Contains, testName1)
76+
77+
// test filter by label `docker secret ls --filter label=xxx`
78+
args = []string{
79+
"secret",
80+
"ls",
81+
"--filter",
82+
"label=type",
83+
}
84+
out, err = d.Cmd(args...)
85+
c.Assert(err, checker.IsNil, check.Commentf(out))
86+
87+
c.Assert(strings.TrimSpace(out), checker.Contains, testName0)
88+
c.Assert(strings.TrimSpace(out), checker.Contains, testName1)
89+
90+
args = []string{
91+
"secret",
92+
"ls",
93+
"--filter",
94+
"label=type=test",
95+
}
96+
out, err = d.Cmd(args...)
97+
c.Assert(err, checker.IsNil, check.Commentf(out))
98+
99+
c.Assert(strings.TrimSpace(out), checker.Contains, testName0)
100+
c.Assert(strings.TrimSpace(out), checker.Not(checker.Contains), testName1)
101+
102+
args = []string{
103+
"secret",
104+
"ls",
105+
"--filter",
106+
"label=type=production",
107+
}
108+
out, err = d.Cmd(args...)
109+
c.Assert(err, checker.IsNil, check.Commentf(out))
110+
111+
c.Assert(strings.TrimSpace(out), checker.Not(checker.Contains), testName0)
112+
c.Assert(strings.TrimSpace(out), checker.Contains, testName1)
113+
114+
// test invalid filter `docker secret ls --filter noexisttype=xxx`
115+
args = []string{
116+
"secret",
117+
"ls",
118+
"--filter",
119+
"noexisttype=test0",
120+
}
121+
out, err = d.Cmd(args...)
122+
c.Assert(err, checker.NotNil, check.Commentf(out))
123+
124+
c.Assert(strings.TrimSpace(out), checker.Contains, "Error response from daemon: Invalid filter 'noexisttype'")
125+
}

0 commit comments

Comments
 (0)