GitLabgitlab-org
cli
main
1//go:build !integration
3package list
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/api"
17 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
18)
20func Test_ListSSHKey(t *testing.T) {
21 type testCase struct {
22 Name string
23 ExpectedMsg []string
24 wantErr bool
25 cli string
26 wantStderr string
27 setupMock func(tc *gitlabtesting.TestClient)
28 }
30 testKey := &gitlab.SSHKey{
31 ID: 123,
32 Key: "ssh-ed25519 example",
33 CreatedAt: new(time.Date(2025, 1, 1, 0, 0, 0, 0, time.UTC)),
34 UsageType: "auth_and_signing",
35 Title: "mysshkey",
36 }
38 testCases := []testCase{
39 {
40 Name: "List all ssh keys",
41 ExpectedMsg: []string{"Title\tKey\tUsage type\tCreated At\nmysshkey\tssh-ed25519 example\tauth_and_signing\t2025-01-01 00:00:00 +0000 UTC\n\n"},
42 cli: "",
43 setupMock: func(tc *gitlabtesting.TestClient) {
44 tc.MockUsers.EXPECT().ListSSHKeys(gomock.Any()).Return([]*gitlab.SSHKey{testKey}, nil, nil)
45 },
46 },
47 {
48 Name: "When --show-id is used shows a list of keys with IDs",
49 ExpectedMsg: []string{"ID\tTitle\tKey\tUsage type\tCreated At\n123\tmysshkey\tssh-ed25519 example\tauth_and_signing\t2025-01-01 00:00:00 +0000 UTC\n\n"},
50 cli: "--show-id",
51 setupMock: func(tc *gitlabtesting.TestClient) {
52 tc.MockUsers.EXPECT().ListSSHKeys(gomock.Any()).Return([]*gitlab.SSHKey{testKey}, nil, nil)
53 },
54 },
55 {
56 Name: "When no keys are found returns an empty list",
57 ExpectedMsg: []string{"\n"},
58 cli: "",
59 setupMock: func(tc *gitlabtesting.TestClient) {
60 tc.MockUsers.EXPECT().ListSSHKeys(gomock.Any()).Return([]*gitlab.SSHKey{}, nil, nil)
61 },
62 },
63 }
65 for _, tc := range testCases {
66 t.Run(tc.Name, func(t *testing.T) {
67 // GIVEN
68 testClient := gitlabtesting.NewTestClient(t)
69 tc.setupMock(testClient)
70 exec := cmdtest.SetupCmdForTest(
71 t,
72 NewCmdList,
73 false,
74 cmdtest.WithApiClient(cmdtest.NewTestApiClient(t, nil, "", "", api.WithGitLabClient(testClient.Client))),
75 )
77 // WHEN
78 out, err := exec(tc.cli)
80 // THEN
81 if tc.wantErr {
82 require.Error(t, err)
83 assert.Contains(t, err.Error(), tc.wantStderr)
84 return
85 }
86 require.NoError(t, err)
87 for _, msg := range tc.ExpectedMsg {
88 assert.Equal(t, msg, out.OutBuf.String())
89 }
90 })
91 }
92}
94func TestSshKeyList_JSON(t *testing.T) {
95 t.Parallel()
97 testKey := &gitlab.SSHKey{
98 ID: 123,
99 Key: "ssh-ed25519 example",
100 CreatedAt: new(time.Date(2025, 1, 1, 0, 0, 0, 0, time.UTC)),
101 UsageType: "auth_and_signing",
102 Title: "mysshkey",
103 }
105 testClient := gitlabtesting.NewTestClient(t)
106 testClient.MockUsers.EXPECT().
107 ListSSHKeys(gomock.Any()).
108 Return([]*gitlab.SSHKey{testKey}, nil, nil)
110 exec := cmdtest.SetupCmdForTest(
111 t,
112 NewCmdList,
113 false,
114 cmdtest.WithApiClient(cmdtest.NewTestApiClient(t, nil, "", "", api.WithGitLabClient(testClient.Client))),
115 )
117 out, err := exec("--output json")
118 require.NoError(t, err)
120 assert.Contains(t, out.String(), `"id":123`)
121 assert.Contains(t, out.String(), `"title":"mysshkey"`)
122 assert.Contains(t, out.String(), `"key":"ssh-ed25519 example"`)
123 assert.Contains(t, out.String(), `"usage_type":"auth_and_signing"`)
124 assert.Empty(t, out.Stderr())
125}
Diagnostics8 git calls · 237 ms
CallStatusSizeTime0237 ms
discover200185 B4 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 KiB2 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=UPDATING 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
fetchcombine:blob:none+tree:2 · deepen 12004.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=4273 git.response.cache=HIT git.response.duration_ms=2 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: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=1 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
fetchtree:02001.8 KiB · hit1 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=1857 git.response.cache=HIT git.response.duration_ms=1 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:0200289 B · hit5 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=289 git.response.cache=HIT git.response.duration_ms=5 git.fetch.filter=tree:0 git.fetch.wants=1dd4ebf804b44e69b594244d57246af8b61f1ed3 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=289 git.pkt.payload.max=262 git.sideband.band1.bytes=262 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=262 git.pack.trailer=d2a3ec46393f5a5492eae3096186e74c059a8aafOpen pack map
fetchtree:0200134 B · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=221 git.response.bytes=134 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=tree:0 git.fetch.wants=2e478a5e66b073a3c25b0d5887f2e5f736762674 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=32f419b2ad1d3f14972bb0261b2a67b9ecb35fb1Open pack map
fetch2001.1 KiB221 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1167 git.response.cache=MISS git.response.duration_ms=221 git.fetch.wants=f9f11ac74fe608bed7c28a79bbcf481634dfc142 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=1167 git.pkt.payload.max=1140 git.sideband.band1.bytes=1140 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
- a5e2bb208d40cfc3
- Request
- 097a2a2a…
- 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