Skip to content

Commit 39fa0f9

Browse files
nieblaranieblara
committed
[feat] adding --fields flag
1 parent 733df0d commit 39fa0f9

12 files changed

Lines changed: 749 additions & 45 deletions

File tree

‎cmd/cliflags/flags.go‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ func GetOutputKind(cmd *cobra.Command) string {
1313
return viper.GetString(OutputFlag)
1414
}
1515

16+
// GetFields returns the list of fields to include in JSON output, or nil if not specified.
17+
func GetFields(cmd *cobra.Command) []string {
18+
fields, err := cmd.Root().PersistentFlags().GetStringSlice(FieldsFlag)
19+
if err != nil {
20+
return nil
21+
}
22+
return fields
23+
}
24+
1625
const (
1726
BaseURIDefault = "https://app.launchdarkly.com"
1827
DevStreamURIDefault = "https://stream.launchdarkly.com"
@@ -27,6 +36,7 @@ const (
2736
DevStreamURIFlag = "dev-stream-uri"
2837
EmailsFlag = "emails"
2938
EnvironmentFlag = "environment"
39+
FieldsFlag = "fields"
3040
FlagFlag = "flag"
3141
JSONFlag = "json"
3242
OutputFlag = "output"
@@ -42,6 +52,7 @@ const (
4252
CorsOriginFlagDescription = "Allowed CORS origin. Use '*' for all origins (default: '*')"
4353
DevStreamURIDescription = "Streaming service endpoint that the dev server uses to obtain authoritative flag data. This may be a LaunchDarkly or Relay Proxy endpoint"
4454
EnvironmentFlagDescription = "Default environment key"
55+
FieldsFlagDescription = "Comma-separated list of top-level fields to include in JSON output (e.g., --fields key,name,kind)"
4556
FlagFlagDescription = "Default feature flag key"
4657
JSONFlagDescription = "Output JSON format (shorthand for --output json)"
4758
OutputFlagDescription = "Output format: json or plaintext (default: plaintext in a terminal, json otherwise)"

‎cmd/config/config.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ func outputSetAction(newFields []string) (string, error) {
287287
Items: newFields,
288288
}
289289
fieldsJSON, _ := json.Marshal(fields)
290-
output, err := output.CmdOutput("update", viper.GetString(cliflags.OutputFlag), fieldsJSON)
290+
output, err := output.CmdOutput("update", viper.GetString(cliflags.OutputFlag), fieldsJSON, nil)
291291
if err != nil {
292292
return "", errs.NewError(err.Error())
293293
}
@@ -302,7 +302,7 @@ func outputUnsetAction(newField string) (string, error) {
302302
Key: newField,
303303
}
304304
fieldJSON, _ := json.Marshal(field)
305-
output, err := output.CmdOutput("delete", viper.GetString(cliflags.OutputFlag), fieldJSON)
305+
output, err := output.CmdOutput("delete", viper.GetString(cliflags.OutputFlag), fieldJSON, nil)
306306
if err != nil {
307307
return "", errs.NewError(err.Error())
308308
}

‎cmd/config/testdata/help.golden‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,6 @@ Global Flags:
2727
--access-token string LaunchDarkly access token with write-level access
2828
--analytics-opt-out Opt out of analytics tracking
2929
--base-uri string LaunchDarkly base URI (default "https://app.launchdarkly.com")
30+
--fields strings Comma-separated list of top-level fields to include in JSON output (e.g., --fields key,name,kind)
3031
--json Output JSON format (shorthand for --output json)
3132
-o, --output string Output format: json or plaintext (default: plaintext in a terminal, json otherwise) (default "plaintext")

‎cmd/flags/archive.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ func makeArchiveRequest(client resources.Client) func(*cobra.Command, []string)
5151
return output.NewCmdOutputError(err, cliflags.GetOutputKind(cmd))
5252
}
5353

54-
output, err := output.CmdOutput("update", cliflags.GetOutputKind(cmd), res)
54+
output, err := output.CmdOutput("update", cliflags.GetOutputKind(cmd), res, cliflags.GetFields(cmd))
5555
if err != nil {
5656
return errors.NewError(err.Error())
5757
}

‎cmd/flags/archive_test.go‎

Lines changed: 113 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,13 @@ func TestArchive(t *testing.T) {
1515
mockClient := &resources.MockClient{
1616
Response: []byte(`{
1717
"key": "test-flag",
18-
"name": "test flag"
18+
"name": "test flag",
19+
"kind": "boolean",
20+
"archived": true
1921
}`),
2022
}
2123

22-
t.Run("succeeds with valid inputs", func(t *testing.T) {
24+
t.Run("succeeds with plaintext output", func(t *testing.T) {
2325
args := []string{
2426
"flags", "archive",
2527
"--access-token", "abcd1234",
@@ -39,6 +41,114 @@ func TestArchive(t *testing.T) {
3941
assert.Equal(t, `[{"op": "replace", "path": "/archived", "value": true}]`, string(mockClient.Input))
4042
assert.Equal(t, "Successfully updated test flag (test-flag)\n", string(output))
4143
})
44+
45+
t.Run("succeeds with JSON output", func(t *testing.T) {
46+
args := []string{
47+
"flags", "archive",
48+
"--access-token", "abcd1234",
49+
"--flag", "test-flag",
50+
"--project", "test-proj",
51+
"--output", "json",
52+
}
53+
output, err := cmd.CallCmd(
54+
t,
55+
cmd.APIClients{
56+
ResourcesClient: mockClient,
57+
},
58+
analytics.NoopClientFn{}.Tracker(),
59+
args,
60+
)
61+
62+
require.NoError(t, err)
63+
assert.JSONEq(t, `{"key":"test-flag","name":"test flag","kind":"boolean","archived":true}`, string(output))
64+
})
65+
66+
t.Run("succeeds with --json shorthand", func(t *testing.T) {
67+
args := []string{
68+
"flags", "archive",
69+
"--access-token", "abcd1234",
70+
"--flag", "test-flag",
71+
"--project", "test-proj",
72+
"--json",
73+
}
74+
output, err := cmd.CallCmd(
75+
t,
76+
cmd.APIClients{
77+
ResourcesClient: mockClient,
78+
},
79+
analytics.NoopClientFn{}.Tracker(),
80+
args,
81+
)
82+
83+
require.NoError(t, err)
84+
assert.JSONEq(t, `{"key":"test-flag","name":"test flag","kind":"boolean","archived":true}`, string(output))
85+
})
86+
87+
t.Run("filters JSON output with --fields", func(t *testing.T) {
88+
args := []string{
89+
"flags", "archive",
90+
"--access-token", "abcd1234",
91+
"--flag", "test-flag",
92+
"--project", "test-proj",
93+
"--output", "json",
94+
"--fields", "key,name",
95+
}
96+
output, err := cmd.CallCmd(
97+
t,
98+
cmd.APIClients{
99+
ResourcesClient: mockClient,
100+
},
101+
analytics.NoopClientFn{}.Tracker(),
102+
args,
103+
)
104+
105+
require.NoError(t, err)
106+
assert.JSONEq(t, `{"key":"test-flag","name":"test flag"}`, string(output))
107+
})
108+
109+
t.Run("filters JSON output with --json and --fields", func(t *testing.T) {
110+
args := []string{
111+
"flags", "archive",
112+
"--access-token", "abcd1234",
113+
"--flag", "test-flag",
114+
"--project", "test-proj",
115+
"--json",
116+
"--fields", "key,name",
117+
}
118+
output, err := cmd.CallCmd(
119+
t,
120+
cmd.APIClients{
121+
ResourcesClient: mockClient,
122+
},
123+
analytics.NoopClientFn{}.Tracker(),
124+
args,
125+
)
126+
127+
require.NoError(t, err)
128+
assert.JSONEq(t, `{"key":"test-flag","name":"test flag"}`, string(output))
129+
})
130+
131+
t.Run("ignores --fields with plaintext output", func(t *testing.T) {
132+
args := []string{
133+
"flags", "archive",
134+
"--access-token", "abcd1234",
135+
"--flag", "test-flag",
136+
"--project", "test-proj",
137+
"--fields", "key",
138+
}
139+
output, err := cmd.CallCmd(
140+
t,
141+
cmd.APIClients{
142+
ResourcesClient: mockClient,
143+
},
144+
analytics.NoopClientFn{}.Tracker(),
145+
args,
146+
)
147+
148+
require.NoError(t, err)
149+
assert.Equal(t, "Successfully updated test flag (test-flag)\n", string(output))
150+
})
151+
42152
t.Run("returns error with missing flags", func(t *testing.T) {
43153
args := []string{
44154
"flags", "archive",
@@ -55,6 +165,6 @@ func TestArchive(t *testing.T) {
55165
)
56166

57167
assert.Error(t, err)
58-
assert.Equal(t, "required flag(s) \"project\" not set. See `ldcli flags archive --help` for supported flags and usage.", err.Error())
168+
assert.Contains(t, err.Error(), `required flag(s) "project" not set`)
59169
})
60170
}

‎cmd/flags/toggle.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ func runE(client resources.Client) func(*cobra.Command, []string) error {
7373
return output.NewCmdOutputError(err, cliflags.GetOutputKind(cmd))
7474
}
7575

76-
output, err := output.CmdOutput("update", cliflags.GetOutputKind(cmd), res)
76+
output, err := output.CmdOutput("update", cliflags.GetOutputKind(cmd), res, cliflags.GetFields(cmd))
7777
if err != nil {
7878
return errors.NewError(err.Error())
7979
}

0 commit comments

Comments
 (0)