GitLabgitlab-org
cli
main
1//go:build !integration
3package contributors
5import (
6 "strings"
7 "testing"
9 "github.com/MakeNowJust/heredoc/v2"
10 "github.com/stretchr/testify/assert"
11 "github.com/stretchr/testify/require"
12 "go.uber.org/mock/gomock"
14 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
15 gitlabtesting "gitlab.com/gitlab-org/api/client-go/v3/testing"
17 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
18)
20func Test_ProjectContributors(t *testing.T) {
21 type testCase struct {
22 name string
23 cli string
24 expectedOutput string
25 wantErr bool
26 wantStderr string
27 setupMock func(tc *gitlabtesting.TestClient)
28 }
30 testContributors := []*gitlab.Contributor{
31 {
32 Name: "Test User",
33 Email: "tu@gitlab.com",
34 Commits: 41,
35 },
36 {
37 Name: "Test User2",
38 Email: "tu2@gitlab.com",
39 Commits: 12,
40 },
41 }
43 testCases := []testCase{
44 {
45 name: "view project contributors",
46 cli: "",
47 expectedOutput: heredoc.Doc(`Showing 2 contributors on OWNER/REPO. (Page 1)
49 Test User tu@gitlab.com 41 commits
50 Test User2 tu2@gitlab.com 12 commits
52 `),
53 setupMock: func(tc *gitlabtesting.TestClient) {
54 tc.MockRepositories.EXPECT().
55 Contributors("OWNER/REPO", gomock.Any()).
56 Return(testContributors, nil, nil)
57 },
58 },
59 {
60 name: "view project contributors for a different project",
61 cli: "-R foo/bar",
62 expectedOutput: heredoc.Doc(`Showing 2 contributors on foo/bar. (Page 1)
64 Test User tu@gitlab.com 41 commits
65 Test User2 tu2@gitlab.com 12 commits
67 `),
68 setupMock: func(tc *gitlabtesting.TestClient) {
69 tc.MockRepositories.EXPECT().
70 Contributors("foo/bar", gomock.Any()).
71 Return(testContributors, nil, nil)
72 },
73 },
74 {
75 name: "view project contributors ordered by name sorted in ascending order",
76 cli: "--order name --sort asc",
77 expectedOutput: heredoc.Doc(`Showing 2 contributors on OWNER/REPO. (Page 1)
79 Test User tu@gitlab.com 41 commits
80 Test User2 tu2@gitlab.com 12 commits
82 `),
83 setupMock: func(tc *gitlabtesting.TestClient) {
84 tc.MockRepositories.EXPECT().
85 Contributors("OWNER/REPO", gomock.Any()).
86 Return(testContributors, nil, nil)
87 },
88 },
89 }
91 for _, tc := range testCases {
92 t.Run(tc.name, func(t *testing.T) {
93 // GIVEN
94 testClient := gitlabtesting.NewTestClient(t)
95 tc.setupMock(testClient)
96 exec := cmdtest.SetupCmdForTest(
97 t,
98 NewCmdContributors,
99 false,
100 cmdtest.WithGitLabClient(testClient.Client),
101 )
103 // WHEN
104 out, err := exec(tc.cli)
106 // THEN
107 if tc.wantErr {
108 require.Error(t, err)
109 assert.Equal(t, tc.wantStderr, err.Error())
110 return
111 }
112 require.NoError(t, err)
113 assert.Equal(t, tc.expectedOutput, out.String())
114 assert.Empty(t, out.Stderr())
115 })
116 }
117}
119func TestProjectContributors_HeaderTotal(t *testing.T) {
120 testContributors := []*gitlab.Contributor{
121 {Name: "Test User", Email: "tu@gitlab.com", Commits: 41},
122 {Name: "Test User2", Email: "tu2@gitlab.com", Commits: 12},
123 }
125 tests := []struct {
126 name string
127 cli string
128 resp *gitlab.Response
129 wantHeader string
130 }{
131 {
132 name: "shows the total from the API",
133 cli: "--page 3 --per-page 5",
134 resp: &gitlab.Response{CurrentPage: 3, TotalPages: 3, TotalItems: 14},
135 wantHeader: "Showing 2 of 14 contributors on OWNER/REPO. (Page 3)\n",
136 },
137 {
138 name: "without a total from the API",
139 resp: &gitlab.Response{CurrentPage: 1, NextPage: 2},
140 wantHeader: "Showing 2 contributors on OWNER/REPO. (Page 1)\n",
141 },
142 }
144 for _, tt := range tests {
145 t.Run(tt.name, func(t *testing.T) {
146 testClient := gitlabtesting.NewTestClient(t)
147 testClient.MockRepositories.EXPECT().
148 Contributors("OWNER/REPO", gomock.Any()).
149 Return(testContributors, tt.resp, nil)
151 exec := cmdtest.SetupCmdForTest(
152 t,
153 NewCmdContributors,
154 false,
155 cmdtest.WithGitLabClient(testClient.Client),
156 )
158 out, err := exec(tt.cli)
159 require.NoError(t, err)
160 assert.True(t, strings.HasPrefix(out.String(), tt.wantHeader), "got %q", out.String())
161 assert.Empty(t, out.Stderr())
162 })
163 }
164}
166func TestRepoContributors_JSON(t *testing.T) {
167 t.Parallel()
169 testContributors := []*gitlab.Contributor{
170 {
171 Name: "Test User",
172 Email: "tu@gitlab.com",
173 Commits: 41,
174 },
175 {
176 Name: "Test User2",
177 Email: "tu2@gitlab.com",
178 Commits: 12,
179 },
180 }
182 testClient := gitlabtesting.NewTestClient(t)
183 testClient.MockRepositories.EXPECT().
184 Contributors("OWNER/REPO", gomock.Any()).
185 Return(testContributors, nil, nil)
187 exec := cmdtest.SetupCmdForTest(
188 t,
189 NewCmdContributors,
190 false,
191 cmdtest.WithGitLabClient(testClient.Client),
192 )
194 out, err := exec("--output json")
195 require.NoError(t, err)
197 assert.Contains(t, out.String(), `"name":"Test User"`)
198 assert.Contains(t, out.String(), `"email":"tu@gitlab.com"`)
199 assert.Contains(t, out.String(), `"commits":41`)
200 assert.Empty(t, out.Stderr())
201}
Diagnostics8 git calls · 299 ms
CallStatusSizeTime0299 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 · hit9 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=9 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 · hit1 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=1 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=1 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:0200614 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=614 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=3a89d0cfc8e81880c982180388e42e561a0b7eee 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=614 git.pkt.payload.max=587 git.sideband.band1.bytes=587 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=587 git.pack.trailer=eb8250f8e8340ff2fafc22c5aba90db34fd906a9Open pack map
fetchtree:0200181 B · hit1 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=181 git.response.cache=HIT git.response.duration_ms=1 git.fetch.filter=tree:0 git.fetch.wants=7d236f774db2ac22426ffebf5d3fa5d8bb51a194 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=181 git.pkt.payload.max=154 git.sideband.band1.bytes=154 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=154 git.pack.trailer=b725d8caa8c248b36e45a3f71d9b47301c14bcfcOpen pack map
fetch2001.3 KiB284 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=284 git.response.bytes=1340 git.response.cache=MISS git.response.duration_ms=284 git.fetch.wants=fc6955ab1a0db248b949063c0d5ea55d942906bf 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=1340 git.pkt.payload.max=1313 git.sideband.band1.bytes=1313 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
- a5ea56b36bbf7089
- Request
- 3410b4a0…
- 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