GitLabgitlab-org

cli

main
ply8 git calls397 ms99 KiB6 cachedprotocol v2
229 lines6.0 KiBRaw
1//go:build !integration
3package get
5import (
6 "encoding/json"
7 "errors"
8 "testing"
9 "time"
11 "github.com/MakeNowJust/heredoc/v2"
12 "github.com/stretchr/testify/assert"
13 "github.com/stretchr/testify/require"
14 "go.uber.org/mock/gomock"
16 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
17 gitlabtesting "gitlab.com/gitlab-org/api/client-go/v3/testing"
19 "gitlab.com/gitlab-org/cli/internal/api"
20 "gitlab.com/gitlab-org/cli/internal/cmdutils"
21 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
24func setupExec(t *testing.T, tc *gitlabtesting.TestClient, opts ...cmdtest.FactoryOption) cmdtest.CmdExecFunc {
25 t.Helper()
27 opts = append(
28 []cmdtest.FactoryOption{
29 cmdtest.WithApiClient(cmdtest.NewTestApiClient(t, nil, "", "", api.WithGitLabClient(tc.Client))),
30 },
31 opts...,
32 )
34 return cmdtest.SetupCmdForTest(t, NewCmd, false, opts...)
37func TestGet_Project(t *testing.T) {
38 t.Parallel()
40 expiresAt := time.Date(2027, 1, 1, 0, 0, 0, 0, time.UTC)
41 tc := gitlabtesting.NewTestClient(t)
42 tc.MockDeployTokens.EXPECT().
43 GetProjectDeployToken("OWNER/REPO", int64(42), gomock.Any()).
44 Return(&gitlab.DeployToken{
45 ID: 42,
46 Name: "ci-reader",
47 Username: "gitlab+deploy-token-42",
48 ExpiresAt: &expiresAt,
49 Scopes: []string{"read_repository", "read_registry"},
50 }, nil, nil)
52 out, err := setupExec(t, tc)("42")
53 require.NoError(t, err)
55 expected := heredoc.Doc(`
56 ID 42
57 Name ci-reader
58 Username gitlab+deploy-token-42
59 Scopes read_repository, read_registry
60 Expires At 2027-01-01T00:00:00Z
61 Revoked false
62 Expired false
63 `)
64 assert.Equal(t, expected, out.OutBuf.String())
65 assert.Empty(t, out.ErrBuf.String())
68func TestGet_Group(t *testing.T) {
69 t.Parallel()
71 tc := gitlabtesting.NewTestClient(t)
72 tc.MockDeployTokens.EXPECT().
73 GetGroupDeployToken("group/sub-group", int64(7), gomock.Any()).
74 Return(&gitlab.DeployToken{
75 ID: 7,
76 Name: "group-reader",
77 Username: "gitlab+deploy-token-7",
78 Scopes: []string{"read_repository"},
79 }, nil, nil)
81 out, err := setupExec(t, tc)("7 --group group/sub-group")
82 require.NoError(t, err)
84 expected := heredoc.Doc(`
85 ID 7
86 Name group-reader
87 Username gitlab+deploy-token-7
88 Scopes read_repository
89 Expires At -
90 Revoked false
91 Expired false
92 `)
93 assert.Equal(t, expected, out.OutBuf.String())
96func TestGet_JSON(t *testing.T) {
97 t.Parallel()
99 expiresAt := time.Date(2027, 1, 1, 0, 0, 0, 0, time.UTC)
100 tc := gitlabtesting.NewTestClient(t)
101 tc.MockDeployTokens.EXPECT().
102 GetProjectDeployToken("OWNER/REPO", int64(42), gomock.Any()).
103 Return(&gitlab.DeployToken{
104 ID: 42,
105 Name: "ci-reader",
106 Username: "gitlab+deploy-token-42",
107 ExpiresAt: &expiresAt,
108 Revoked: true,
109 Expired: true,
110 Scopes: []string{"read_repository"},
111 }, nil, nil)
113 out, err := setupExec(t, tc)("42 --output json")
114 require.NoError(t, err)
116 var result gitlab.DeployToken
117 require.NoError(t, json.Unmarshal(out.OutBuf.Bytes(), &result))
118 assert.Equal(t, int64(42), result.ID)
119 assert.Equal(t, "ci-reader", result.Name)
120 assert.Equal(t, "gitlab+deploy-token-42", result.Username)
121 assert.Equal(t, expiresAt, *result.ExpiresAt)
122 assert.Equal(t, []string{"read_repository"}, result.Scopes)
123 assert.True(t, result.Revoked)
124 assert.True(t, result.Expired)
127// A token value must never reach the output, in either format.
128func TestGet_OmitsTokenValue(t *testing.T) {
129 t.Parallel()
131 tests := []struct {
132 name string
133 args string
134 }{
135 {name: "text", args: "42"},
136 {name: "json", args: "42 --output json"},
137 }
139 for _, tt := range tests {
140 t.Run(tt.name, func(t *testing.T) {
141 t.Parallel()
143 tc := gitlabtesting.NewTestClient(t)
144 tc.MockDeployTokens.EXPECT().
145 GetProjectDeployToken("OWNER/REPO", int64(42), gomock.Any()).
146 Return(&gitlab.DeployToken{
147 ID: 42,
148 Name: "ci-reader",
149 Username: "gitlab+deploy-token-42",
150 Scopes: []string{"read_repository"},
151 Token: "gldt-secret",
152 }, nil, nil)
154 out, err := setupExec(t, tc)(tt.args)
155 require.NoError(t, err)
157 assert.Contains(t, out.OutBuf.String(), "ci-reader")
158 assert.NotContains(t, out.OutBuf.String(), "gldt-secret")
159 })
160 }
163func TestGet_InvalidID(t *testing.T) {
164 t.Parallel()
166 tc := gitlabtesting.NewTestClient(t)
168 _, err := setupExec(t, tc)("not-a-number")
169 require.Error(t, err)
170 assert.Equal(t, `invalid deploy token ID: "not-a-number"`, err.Error())
173func TestGet_APIError(t *testing.T) {
174 t.Parallel()
176 tc := gitlabtesting.NewTestClient(t)
177 tc.MockDeployTokens.EXPECT().
178 GetProjectDeployToken("OWNER/REPO", int64(42), gomock.Any()).
179 Return(nil, nil, errors.New("404 Not Found"))
181 _, err := setupExec(t, tc)("42")
182 require.Error(t, err)
184 var exitErr *cmdutils.ExitError
185 require.ErrorAs(t, err, &exitErr)
186 assert.Equal(t, "failed to get deploy token", exitErr.Details)
187 assert.Contains(t, err.Error(), "404 Not Found")
190func TestGet_RepoAndGroupAreMutuallyExclusive(t *testing.T) {
191 t.Parallel()
193 tc := gitlabtesting.NewTestClient(t)
195 _, err := setupExec(t, tc)("42 --repo OWNER/REPO --group group/sub-group")
196 require.Error(t, err)
197 assert.Contains(t, err.Error(), "none of the others can be")
200// The project scope needs a base repository, and says so before any client is built.
201func TestGet_OutsideRepositoryWithoutGroup(t *testing.T) {
202 t.Parallel()
204 tc := gitlabtesting.NewTestClient(t)
206 _, err := setupExec(t, tc, cmdtest.WithBaseRepoError(errors.New("not a git repository")))("42")
207 require.Error(t, err)
208 assert.Contains(t, err.Error(), "not a git repository")
211// The group scope does not need a base repository.
212func TestGet_OutsideRepositoryWithGroup(t *testing.T) {
213 t.Parallel()
215 tc := gitlabtesting.NewTestClient(t)
216 tc.MockDeployTokens.EXPECT().
217 GetGroupDeployToken("group/sub-group", int64(7), gomock.Any()).
218 Return(&gitlab.DeployToken{
219 ID: 7,
220 Name: "group-reader",
221 Username: "gitlab+deploy-token-7",
222 Scopes: []string{"read_repository"},
223 }, nil, nil)
225 out, err := setupExec(t, tc, cmdtest.WithBaseRepoError(errors.New("not a git repository")))("7 --group group/sub-group")
226 require.NoError(t, err)
228 assert.Contains(t, out.OutBuf.String(), "group-reader")
Diagnostics8 git calls · 397 ms
CallStatusSizeTime0397 ms
discover200185 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
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 · hit2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=59849
git.response.cache=HIT
git.response.duration_ms=2
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=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.8 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=1857
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=dce174ff8c632a19d17eea99c8a9b7c37fb2b592
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=1857
git.pkt.payload.max=1830
git.sideband.band1.bytes=1830
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1830
git.pack.trailer=fb03183b7909876778f740d196d7516811003517
Open pack map
fetchtree:0200263 B · 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=263
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=aff3dd5052d75f0afe2383713d669f993c82b2f9
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=263
git.pkt.payload.max=236
git.sideband.band1.bytes=236
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=236
git.pack.trailer=4076aed8a003d312c41b730611843784ab33181f
Open pack map
fetchtree:0200134 B · 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=134
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=39d484dcf7951935ac324634c52e6f75cdf36a31
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=134
git.pkt.payload.max=107
git.sideband.band1.bytes=107
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=107
git.pack.trailer=9d747441ee037484d9a04a619fe68ebec4f0273d
Open pack map
fetch2001.6 KiB383 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=383
git.response.bytes=1677
git.response.cache=MISS
git.response.duration_ms=383
git.fetch.wants=b2c82c18260f26a6786e642faa06b01927c9397f
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=1677
git.pkt.payload.max=1650
git.sideband.band1.bytes=1650
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
a5e2be932c3b89da
Request
0618b1fd…
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