GitLabgitlab-org

cli

main
ply8 git calls202 ms98 KiB6 cachedprotocol v2
175 lines5.4 KiBRaw
1//go:build !integration
3package list
5import (
6 "encoding/json"
7 "fmt"
8 "testing"
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"
20func captureListOptions(tc *gitlabtesting.TestClient, gotOpts **gitlab.ListProjectPackagesOptions) {
21 tc.MockPackages.EXPECT().
22 ListProjectPackages("OWNER/REPO", gomock.Any(), gomock.Any()).
23 DoAndReturn(func(_ any, opt *gitlab.ListProjectPackagesOptions, _ ...gitlab.RequestOptionFunc) ([]*gitlab.Package, *gitlab.Response, error) {
24 *gotOpts = opt
25 return []*gitlab.Package{}, nil, nil
26 })
29func TestPackagesList(t *testing.T) {
30 t.Parallel()
32 t.Run("lists packages as JSON", func(t *testing.T) {
33 t.Parallel()
35 tc := gitlabtesting.NewTestClient(t)
36 tc.MockPackages.EXPECT().
37 ListProjectPackages("OWNER/REPO", gomock.Any(), gomock.Any()).
38 Return([]*gitlab.Package{
39 {ID: 1, Name: "my-package", Version: "1.0.0", PackageType: "generic"},
40 {ID: 2, Name: "other-package", Version: "2.0.0", PackageType: "generic"},
41 }, nil, nil)
43 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
45 out, err := exec("")
46 require.NoError(t, err)
48 var packages []*gitlab.Package
49 require.NoError(t, json.Unmarshal([]byte(out.String()), &packages))
50 require.Len(t, packages, 2)
51 assert.Equal(t, int64(1), packages[0].ID)
52 assert.Equal(t, "my-package", packages[0].Name)
53 assert.Equal(t, "1.0.0", packages[0].Version)
54 assert.Equal(t, int64(2), packages[1].ID)
55 assert.Equal(t, "other-package", packages[1].Name)
56 })
58 t.Run("filters output with --jq", func(t *testing.T) {
59 t.Parallel()
61 tc := gitlabtesting.NewTestClient(t)
62 tc.MockPackages.EXPECT().
63 ListProjectPackages("OWNER/REPO", gomock.Any(), gomock.Any()).
64 Return([]*gitlab.Package{
65 {ID: 1, Name: "my-package", Version: "1.0.0", PackageType: "generic"},
66 }, nil, nil)
68 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
70 out, err := exec(`--jq '.[].name'`)
71 require.NoError(t, err)
72 assert.Contains(t, out.String(), "my-package")
73 })
75 t.Run("forwards --name to the API", func(t *testing.T) {
76 t.Parallel()
78 tc := gitlabtesting.NewTestClient(t)
79 var gotOpts *gitlab.ListProjectPackagesOptions
80 captureListOptions(tc, &gotOpts)
82 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
84 _, err := exec("--name my-package")
85 require.NoError(t, err)
86 require.NotNil(t, gotOpts.PackageName)
87 assert.Equal(t, "my-package", *gotOpts.PackageName)
88 })
90 t.Run("forwards --package-type to the API", func(t *testing.T) {
91 t.Parallel()
93 tc := gitlabtesting.NewTestClient(t)
94 var gotOpts *gitlab.ListProjectPackagesOptions
95 captureListOptions(tc, &gotOpts)
97 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
99 _, err := exec("--package-type npm")
100 require.NoError(t, err)
101 require.NotNil(t, gotOpts.PackageType)
102 assert.Equal(t, "npm", *gotOpts.PackageType)
103 })
105 t.Run("rejects an unknown --package-type without calling the API", func(t *testing.T) {
106 t.Parallel()
108 tc := gitlabtesting.NewTestClient(t)
109 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
111 _, err := exec("--package-type bogus")
112 require.Error(t, err)
113 assert.Contains(t, err.Error(), `invalid argument "bogus" for "--package-type" flag: must be one of`)
114 })
116 t.Run("leaves package type unset when --package-type is absent", func(t *testing.T) {
117 t.Parallel()
119 tc := gitlabtesting.NewTestClient(t)
120 var gotOpts *gitlab.ListProjectPackagesOptions
121 captureListOptions(tc, &gotOpts)
123 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
125 _, err := exec("")
126 require.NoError(t, err)
127 assert.Nil(t, gotOpts.PackageType)
128 })
130 t.Run("forwards --page and --per-page to the API", func(t *testing.T) {
131 t.Parallel()
133 tc := gitlabtesting.NewTestClient(t)
134 var gotOpts *gitlab.ListProjectPackagesOptions
135 captureListOptions(tc, &gotOpts)
137 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
139 _, err := exec("--page 2 --per-page 10")
140 require.NoError(t, err)
141 assert.Equal(t, int64(2), gotOpts.Page)
142 assert.Equal(t, int64(10), gotOpts.PerPage)
143 })
145 t.Run("defaults page and per-page when flags are absent", func(t *testing.T) {
146 t.Parallel()
148 tc := gitlabtesting.NewTestClient(t)
149 var gotOpts *gitlab.ListProjectPackagesOptions
150 captureListOptions(tc, &gotOpts)
152 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
154 _, err := exec("")
155 require.NoError(t, err)
156 assert.Equal(t, int64(1), gotOpts.Page)
157 assert.Equal(t, int64(30), gotOpts.PerPage)
158 assert.Nil(t, gotOpts.PackageName)
159 })
161 t.Run("surfaces API errors", func(t *testing.T) {
162 t.Parallel()
164 tc := gitlabtesting.NewTestClient(t)
165 tc.MockPackages.EXPECT().
166 ListProjectPackages("OWNER/REPO", gomock.Any(), gomock.Any()).
167 Return(nil, nil, fmt.Errorf("GET https://gitlab.com/api/v4/projects/OWNER%%2FREPO/packages: 403"))
169 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
171 _, err := exec("")
172 require.Error(t, err)
173 assert.Equal(t, "failed to list packages: GET https://gitlab.com/api/v4/projects/OWNER%2FREPO/packages: 403", err.Error())
174 })
Diagnostics8 git calls · 202 ms
CallStatusSizeTime0202 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=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 · hit3 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=3
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 · 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=4273
git.response.cache=HIT
git.response.duration_ms=3
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 · hit3 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=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
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=4
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=fb03183b7909876778f740d196d7516811003517
Open pack map
fetchtree:0200263 B · 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=263
git.response.cache=HIT
git.response.duration_ms=4
git.fetch.filter=tree:0
git.fetch.wants=4445ce4c6a6710742ed094287b245091ae79204f
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=4126ef8ff4c560b52ccdd91c9d0a185a77d21c2d
Open pack map
fetchtree:0200133 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=188
git.response.bytes=133
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=b4375f454e137754558871ed6798d9aeaa29abf7
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=133
git.pkt.payload.max=106
git.sideband.band1.bytes=106
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=106
git.pack.trailer=e8a8faa6dc0a0f41e3220fe7927dc7dbaff886a9
Open pack map
fetch2001.2 KiB188 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1250
git.response.cache=MISS
git.response.duration_ms=188
git.fetch.wants=5523c171524d76a6a5bdbe26dc15889715723ca4
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=1250
git.pkt.payload.max=1223
git.sideband.band1.bytes=1223
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
a5e2d0a3de1fefad
Request
64109d3a…
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