GitLabgitlab-org
cli
main
1package cmdutils
3import (
4 "bytes"
5 "testing"
7 "github.com/spf13/cobra"
8 "github.com/stretchr/testify/assert"
9 "github.com/stretchr/testify/require"
11 "gitlab.com/gitlab-org/cli/internal/iostreams"
12)
14// jqCmdHarness builds a minimal cobra.Command with an --output flag, wires
15// AddJQFlag onto it, and returns the command plus the captured IOStreams.
16func jqCmdHarness(t *testing.T) (*cobra.Command, *iostreams.IOStreams, *bool) {
17 t.Helper()
18 io := &iostreams.IOStreams{
19 StdOut: &bytes.Buffer{},
20 StdErr: &bytes.Buffer{},
21 JQ: &iostreams.JQFilter{},
22 }
23 ran := false
24 cmd := &cobra.Command{
25 Use: "test",
26 RunE: func(*cobra.Command, []string) error {
27 ran = true
28 return nil
29 },
30 }
31 var outputFormat string
32 cmd.Flags().VarP(NewEnumValue([]string{"text", "json"}, "text", &outputFormat), "output", "F", "")
33 AddJQFlag(cmd, io)
34 return cmd, io, &ran
35}
37func TestAddJQFlag_NoFlagPassed_FilterUnset(t *testing.T) {
38 cmd, io, ran := jqCmdHarness(t)
39 cmd.SetArgs([]string{})
40 require.NoError(t, cmd.Execute())
41 assert.True(t, *ran)
42 assert.False(t, io.JQ.IsActive())
43}
45func TestAddJQFlag_WithJSONOutput_SetsFilterAndRuns(t *testing.T) {
46 cmd, io, ran := jqCmdHarness(t)
47 cmd.SetArgs([]string{"--output", "json", "--jq", ".foo"})
48 require.NoError(t, cmd.Execute())
49 assert.True(t, *ran)
50 assert.True(t, io.JQ.IsActive())
51 assert.Equal(t, ".foo", io.JQ.String())
52}
54func TestAddJQFlag_WithoutJSONOutput_FailsBeforeRun(t *testing.T) {
55 cmd, _, ran := jqCmdHarness(t)
56 // silence cobra's auto-printed error/usage so the test buffer stays clean
57 cmd.SilenceErrors = true
58 cmd.SilenceUsage = true
59 cmd.SetArgs([]string{"--jq", ".foo"})
61 err := cmd.Execute()
62 require.Error(t, err)
63 assert.Contains(t, err.Error(), "using --jq requires --output=json")
64 assert.False(t, *ran, "command body should not have run")
65}
67func TestAddJQFlag_WithExplicitTextOutput_FailsBeforeRun(t *testing.T) {
68 cmd, _, ran := jqCmdHarness(t)
69 cmd.SilenceErrors = true
70 cmd.SilenceUsage = true
71 cmd.SetArgs([]string{"--output", "text", "--jq", ".foo"})
73 err := cmd.Execute()
74 require.Error(t, err)
75 assert.Contains(t, err.Error(), "got \"text\"")
76 assert.False(t, *ran)
77}
79func TestAddJQFlag_InvalidExpression_FailsAtFlagParse(t *testing.T) {
80 cmd, _, ran := jqCmdHarness(t)
81 cmd.SilenceErrors = true
82 cmd.SilenceUsage = true
83 cmd.SetArgs([]string{"--output", "json", "--jq", ".["})
85 err := cmd.Execute()
86 require.Error(t, err)
87 // Error originates from JQFilter.Set during cobra's flag parsing,
88 // surfaced as a cobra flag-parse error containing our text.
89 assert.Contains(t, err.Error(), "invalid --jq expression")
90 assert.False(t, *ran)
91}
93func TestAddJQFlag_PreservesOriginalPreRunE(t *testing.T) {
94 io := &iostreams.IOStreams{
95 StdOut: &bytes.Buffer{},
96 StdErr: &bytes.Buffer{},
97 JQ: &iostreams.JQFilter{},
98 }
99 preRanCount := 0
100 cmd := &cobra.Command{
101 Use: "test",
102 PreRunE: func(*cobra.Command, []string) error { preRanCount++; return nil },
103 RunE: func(*cobra.Command, []string) error { return nil },
104 }
105 var outputFormat string
106 cmd.Flags().VarP(NewEnumValue([]string{"text", "json"}, "text", &outputFormat), "output", "F", "")
107 AddJQFlag(cmd, io)
109 cmd.SetArgs([]string{"--output", "json", "--jq", ".foo"})
110 require.NoError(t, cmd.Execute())
111 assert.Equal(t, 1, preRanCount, "original PreRunE should run after the jq check")
112}
114func TestAddJQFlag_PreservesOriginalPreRun(t *testing.T) {
115 // Same as the PreRunE case but for the non-E variant. AddJQFlag must
116 // fold an existing PreRun into its wrapper instead of dropping it.
117 io := &iostreams.IOStreams{
118 StdOut: &bytes.Buffer{},
119 StdErr: &bytes.Buffer{},
120 JQ: &iostreams.JQFilter{},
121 }
122 preRanCount := 0
123 cmd := &cobra.Command{
124 Use: "test",
125 PreRun: func(*cobra.Command, []string) { preRanCount++ },
126 RunE: func(*cobra.Command, []string) error { return nil },
127 }
128 var outputFormat string
129 cmd.Flags().VarP(NewEnumValue([]string{"text", "json"}, "text", &outputFormat), "output", "F", "")
130 AddJQFlag(cmd, io)
132 cmd.SetArgs([]string{"--output", "json", "--jq", ".foo"})
133 require.NoError(t, cmd.Execute())
134 assert.Equal(t, 1, preRanCount, "original PreRun should still be invoked")
135}
137func TestAddJQFlag_RegistersNoFileCompletions(t *testing.T) {
138 cmd, _, _ := jqCmdHarness(t)
140 compFn, ok := cmd.GetFlagCompletionFunc("jq")
141 require.True(t, ok, "--jq should have a completion function registered")
143 comps, directive := compFn(cmd, nil, "")
144 assert.Empty(t, comps)
145 assert.Equal(t, cobra.ShellCompDirectiveNoFileComp, directive)
146}
148func TestAddJQFlag_LooksUpOutputFormatFlag(t *testing.T) {
149 io := &iostreams.IOStreams{
150 StdOut: &bytes.Buffer{},
151 StdErr: &bytes.Buffer{},
152 JQ: &iostreams.JQFilter{},
153 }
154 cmd := &cobra.Command{
155 Use: "test",
156 RunE: func(*cobra.Command, []string) error { return nil },
157 }
158 var outputFormat string
159 cmd.Flags().VarP(NewEnumValue([]string{"text", "json"}, "text", &outputFormat), "output-format", "F", "")
160 AddJQFlag(cmd, io)
162 cmd.SilenceErrors = true
163 cmd.SilenceUsage = true
164 cmd.SetArgs([]string{"--jq", ".foo"})
165 err := cmd.Execute()
166 require.Error(t, err)
167 // Error references the fallback flag name when --output isn't present.
168 assert.Contains(t, err.Error(), "--output-format=json")
169}
171func TestAddJQFlag_AlwaysJSONCommand_SkipsOutputFlagCheck(t *testing.T) {
172 // A command without --output / --output-format (e.g. orbit/*) always
173 // emits JSON. AddJQFlag must not error when --jq is supplied without
174 // any output flag in scope.
175 io := &iostreams.IOStreams{
176 StdOut: &bytes.Buffer{},
177 StdErr: &bytes.Buffer{},
178 JQ: &iostreams.JQFilter{},
179 }
180 ran := false
181 cmd := &cobra.Command{
182 Use: "test",
183 RunE: func(*cobra.Command, []string) error { ran = true; return nil },
184 }
185 AddJQFlag(cmd, io)
187 cmd.SetArgs([]string{"--jq", ".foo"})
188 require.NoError(t, cmd.Execute())
189 assert.True(t, ran)
190 assert.True(t, io.JQ.IsActive())
191}
Diagnostics6 git calls · 224 ms
CallStatusSizeTime0224 ms
discover200185 B3 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=3 git.response.bytes=185 git.server.agent=git/2.56.g1891de4-Linux git.server.object_format=sha1 git.server.caps=agent ls-refs fetch server-option object-format git.server.fetch=shallow wait-for-done filter git.protocol.version=2 git.pkt.frames=9 git.pkt.data=7 git.pkt.flush=2 git.pkt.delim=0 git.pkt.bytes=185 git.pkt.payload.max=35
ls-refs20058 KiB · hit3 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=3 git.response.bytes=59849 git.response.cache=HIT git.response.duration_ms=3 git.protocol.version=2 git.pkt.frames=731 git.pkt.data=730 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=59849 git.pkt.payload.max=143 git.ls_refs.count=730 git.ls_refs.head=refs/heads/main
fetchtree:0 · deepen 1020032 KiB · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=32926 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9 git.fetch.haves.count=0 git.fetch.deepen=10 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=22 git.pkt.data=20 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=32926 git.pkt.payload.max=32046 git.sideband.band1.bytes=32046 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=80 git.pack.bytes=32046 git.pack.ofs_delta=36 git.pack.ref_delta=0 git.pack.chain.max=2 git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91 git.pack.full=44Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit5 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=5 git.response.bytes=4273 git.response.cache=HIT git.response.duration_ms=5 git.fetch.filter=combine:blob:none+tree:2 git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9 git.fetch.haves.count=0 git.fetch.deepen=1 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=7 git.pkt.data=5 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=4273 git.pkt.payload.max=4173 git.sideband.band1.bytes=4173 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=11 git.pack.bytes=4173 git.fetch.wide.objects=11 git.fetch.wide.extra_bytes=3930 git.fetch.wide.blobs=0
fetchtree:02001.2 KiB · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=2 git.response.bytes=1238 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=c10f4b8b760c3fec7ed8ca85e428d5bc523f8e17 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1238 git.pkt.payload.max=1211 git.sideband.band1.bytes=1211 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=1211 git.pack.trailer=7373aa350f2a611db7d4116eb1450c92f18a27caOpen pack map
fetch2001.5 KiB214 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=214 git.response.bytes=1547 git.response.cache=MISS git.response.duration_ms=214 git.fetch.wants=28d2094c5a68d845cd7158675359db646fb1dd7f git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1547 git.pkt.payload.max=1520 git.sideband.band1.bytes=1520 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0
Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.
- Remote
- https://gitlab.com/gitlab-org/cli
- Ref
- refs/heads/main
- Commit
- 0dd7574dce9e385c5c30540e6c15657adc6bdce9
- cf-ray
- a5e20747f9ffc69c
- Request
- 0114db0b…
- Protocol
- v2 · sha1
- Agent
- git/2.56.g1891de4-Linux
- Filter
- advertised
- Fetch
- shallow wait-for-done filter
- Capabilities
- agent ls-refs fetch server-option object-format