GitLabgitlab-org

cli

main
ply6 git calls402 ms98 KiB3 cachedprotocol v2
131 lines4.3 KiBRaw
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"
14// outputCmdHarness builds a minimal cobra.Command wired with EnableJSONOutput
15// and returns the command, the IOStreams it records onto, and the command-local
16// field the flag is bound to.
17func outputCmdHarness(t *testing.T) (*cobra.Command, *iostreams.IOStreams, *string) {
18 t.Helper()
19 ios := &iostreams.IOStreams{
20 StdOut: &bytes.Buffer{},
21 StdErr: &bytes.Buffer{},
22 JQ: &iostreams.JQFilter{},
23 }
24 cmd := &cobra.Command{
25 Use: "test <key>",
26 Args: cobra.ExactArgs(1),
27 SilenceUsage: true,
28 RunE: func(*cobra.Command, []string) error { return nil },
29 }
30 var outputFormat string
31 EnableJSONOutput(cmd, ios, &outputFormat)
32 return cmd, ios, &outputFormat
35func TestEnableJSONOutput_NoFlagPassed_FormatNotRecorded(t *testing.T) {
36 cmd, ios, outputFormat := outputCmdHarness(t)
37 cmd.SetArgs([]string{"KEY"})
39 require.NoError(t, cmd.Execute())
40 assert.Equal(t, "text", *outputFormat)
41 assert.False(t, ios.IsJSONOutput())
44func TestEnableJSONOutput_JSONFlagPassed_RecordsFormatOnIOStreams(t *testing.T) {
45 cmd, ios, outputFormat := outputCmdHarness(t)
46 cmd.SetArgs([]string{"KEY", "--output", "json"})
48 require.NoError(t, cmd.Execute())
49 assert.Equal(t, "json", *outputFormat)
50 assert.True(t, ios.IsJSONOutput())
53func TestEnableJSONOutput_TextFlagPassed_RecordsFormatOnIOStreams(t *testing.T) {
54 cmd, ios, outputFormat := outputCmdHarness(t)
55 cmd.SetArgs([]string{"KEY", "-F", "text"})
57 require.NoError(t, cmd.Execute())
58 assert.Equal(t, "text", *outputFormat)
59 assert.False(t, ios.IsJSONOutput())
62func TestEnableJSONOutput_ArgValidationFails_FormatStillRecorded(t *testing.T) {
63 // Flags are parsed before Args validation, so a command that never
64 // reaches RunE has still recorded the format the user asked for. This is
65 // what lets NewGitLabErrorHandler report such failures as JSON.
66 cmd, ios, _ := outputCmdHarness(t)
67 cmd.SilenceErrors = true
68 cmd.SetArgs([]string{"-F", "json"})
70 require.Error(t, cmd.Execute())
71 assert.True(t, ios.IsJSONOutput())
74func TestEnableJSONOutput_InvalidFormat_RejectedAndNotRecorded(t *testing.T) {
75 cmd, ios, _ := outputCmdHarness(t)
76 cmd.SilenceErrors = true
77 cmd.SetArgs([]string{"KEY", "-F", "yaml"})
79 err := cmd.Execute()
80 require.Error(t, err)
81 assert.Contains(t, err.Error(), "must be one of")
82 assert.False(t, ios.IsJSONOutput())
85func TestEnableJSONOutput_CustomDescription(t *testing.T) {
86 // The enum only ever accepts "text"/"json" regardless of this string —
87 // it's passthrough flag help text, not a third format. Deliberately
88 // avoid a plausible-looking format name here so the test data can't be
89 // misread as implying broader support.
90 cmd, ios, _ := outputCmdHarness(t)
91 assert.Equal(t, "Format output as: text, json.", cmd.Flag("output").Usage)
93 var outputFormat string
94 other := &cobra.Command{Use: "other", RunE: func(*cobra.Command, []string) error { return nil }}
95 EnableJSONOutput(other, ios, &outputFormat, "Custom help text for this command's --output flag.")
96 assert.Equal(t, "Custom help text for this command's --output flag.", other.Flag("output").Usage)
99func TestEnableJSONOutput_RegistersJQFlag(t *testing.T) {
100 cmd, _, _ := outputCmdHarness(t)
101 assert.NotNil(t, cmd.Flag("jq"), "EnableJSONOutput must also register --jq")
104func TestEnableJSONOutput_RegistersFlagCompletions(t *testing.T) {
105 cmd, _, _ := outputCmdHarness(t)
107 compFn, ok := cmd.GetFlagCompletionFunc("output")
108 require.True(t, ok, "--output should have a completion function registered")
110 comps, directive := compFn(cmd, nil, "")
111 assert.Equal(t, []cobra.Completion{"text", "json"}, comps)
112 assert.Equal(t, cobra.ShellCompDirectiveNoFileComp, directive)
115func TestEnableJSONOutputP_CustomShorthand(t *testing.T) {
116 ios := &iostreams.IOStreams{
117 StdOut: &bytes.Buffer{},
118 StdErr: &bytes.Buffer{},
119 JQ: &iostreams.JQFilter{},
120 }
121 cmd := &cobra.Command{Use: "test", RunE: func(*cobra.Command, []string) error { return nil }}
122 var outputFormat string
123 EnableJSONOutputP(cmd, ios, &outputFormat, "O")
124 cmd.SetArgs([]string{"-O", "json"})
126 require.NoError(t, cmd.Execute())
127 assert.Equal(t, "O", cmd.Flag("output").Shorthand)
128 assert.Equal(t, "json", outputFormat)
129 assert.True(t, ios.IsJSONOutput())
130 assert.NotNil(t, cmd.Flag("jq"))
Diagnostics6 git calls · 402 ms
CallStatusSizeTime0402 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 KiB156 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=156
git.response.bytes=59849
git.response.cache=EXPIRED
git.response.duration_ms=156
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 · 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=32926
git.response.cache=HIT
git.response.duration_ms=2
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=44
Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit4 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=4
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=4
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=7373aa350f2a611db7d4116eb1450c92f18a27ca
Open pack map
fetch2001.4 KiB240 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=240
git.response.bytes=1414
git.response.cache=MISS
git.response.duration_ms=240
git.fetch.wants=43e7bed2429949836d7ae19ff83a06ad7649b4e1
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=1414
git.pkt.payload.max=1387
git.sideband.band1.bytes=1387
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
a5e199be1806b86e
Request
2cd88d8b…
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