GitLabgitlab-org
cli
main
1//go:build !integration
3package get
5import (
6 "testing"
7 "time"
9 "github.com/stretchr/testify/assert"
10 "github.com/stretchr/testify/require"
11 "go.uber.org/mock/gomock"
13 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
14 gitlabtesting "gitlab.com/gitlab-org/api/client-go/v3/testing"
16 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
17)
19func Test_GetDeployKey(t *testing.T) {
20 type testCase struct {
21 name string
22 cli string
23 expectedOut string
24 wantErr bool
25 wantStderr string
26 setupMock func(tc *gitlabtesting.TestClient)
27 }
29 testKey := &gitlab.ProjectDeployKey{
30 ID: 1,
31 Title: "example key",
32 Key: "ssh-ed25519 example",
33 CanPush: false,
34 CreatedAt: new(time.Date(2025, 1, 1, 0, 0, 0, 0, time.UTC)),
35 }
37 emptyKey := &gitlab.ProjectDeployKey{}
39 testCases := []testCase{
40 {
41 name: "when no deploy key is found shows appropriate message",
42 cli: "1",
43 expectedOut: "Deploy key does not exist.\n",
44 setupMock: func(tc *gitlabtesting.TestClient) {
45 tc.MockDeployKeys.EXPECT().
46 GetDeployKey("OWNER/REPO", int64(1), gomock.Any()).
47 Return(emptyKey, nil, nil)
48 },
49 },
50 {
51 name: "when a deploy key is found shows its details",
52 cli: "1",
53 expectedOut: "Title\tKey\tCan Push\tCreated At\nexample key\tssh-ed25519 example\tfalse\t2025-01-01 00:00:00 +0000 UTC\n\n",
54 setupMock: func(tc *gitlabtesting.TestClient) {
55 tc.MockDeployKeys.EXPECT().
56 GetDeployKey("OWNER/REPO", int64(1), gomock.Any()).
57 Return(testKey, nil, nil)
58 },
59 },
60 }
62 for _, tc := range testCases {
63 t.Run(tc.name, func(t *testing.T) {
64 // GIVEN
65 testClient := gitlabtesting.NewTestClient(t)
66 tc.setupMock(testClient)
67 exec := cmdtest.SetupCmdForTest(
68 t,
69 NewCmdGet,
70 false,
71 cmdtest.WithGitLabClient(testClient.Client),
72 )
74 // WHEN
75 out, err := exec(tc.cli)
77 // THEN
78 if tc.wantErr {
79 require.Error(t, err)
80 assert.Contains(t, err.Error(), tc.wantStderr)
81 return
82 }
83 require.NoError(t, err)
84 assert.Equal(t, tc.expectedOut, out.OutBuf.String())
85 assert.Empty(t, out.ErrBuf.String())
86 })
87 }
88}
90func TestDeployKeyGet_JSON(t *testing.T) {
91 t.Parallel()
93 testKey := &gitlab.ProjectDeployKey{
94 ID: 1,
95 Title: "example key",
96 Key: "ssh-ed25519 example",
97 CanPush: false,
98 CreatedAt: new(time.Date(2025, 1, 1, 0, 0, 0, 0, time.UTC)),
99 }
101 testClient := gitlabtesting.NewTestClient(t)
102 testClient.MockDeployKeys.EXPECT().
103 GetDeployKey("OWNER/REPO", int64(1), gomock.Any()).
104 Return(testKey, nil, nil)
106 exec := cmdtest.SetupCmdForTest(
107 t,
108 NewCmdGet,
109 false,
110 cmdtest.WithGitLabClient(testClient.Client),
111 )
113 out, err := exec("1 --output json")
114 require.NoError(t, err)
116 assert.Contains(t, out.String(), `"id":1`)
117 assert.Contains(t, out.String(), `"title":"example key"`)
118 assert.Contains(t, out.String(), `"key":"ssh-ed25519 example"`)
119 assert.Contains(t, out.String(), `"can_push":false`)
120 assert.Empty(t, out.Stderr())
121}
Diagnostics8 git calls · 316 ms
CallStatusSizeTime0316 ms
discover200185 B3 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch 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 · hit2 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=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=44Open 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 · hit4 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=4 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=fb03183b7909876778f740d196d7516811003517Open pack map
fetchtree:0200227 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=227 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=250e56c3e2d782c6373a9538c740837f85243a75 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=227 git.pkt.payload.max=200 git.sideband.band1.bytes=200 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=200 git.pack.trailer=e13cfdecc4907e32538df2da5c8a114f27dcffd1Open 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=299 git.response.bytes=134 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=76828e0369ced726378dd78ace301f89ad943088 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=bbe57183603d6ce71cd7db97f39854a05f47d435Open pack map
fetch2001.1 KiB299 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1099 git.response.cache=MISS git.response.duration_ms=299 git.fetch.wants=92b053acd42aa388898e45c3223d036f290d6017 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=1099 git.pkt.payload.max=1072 git.sideband.band1.bytes=1072 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
- a5e2ae986e9be6b0
- Request
- 348c79dd…
- 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