GitLabgitlab-org

cli

main
ply8 git calls196 ms99 KiB5 cachedprotocol v2
170 lines3.8 KiBRaw
1//go:build !integration
3package artifact
5import (
6 "archive/zip"
7 "bytes"
8 "io"
9 "os"
10 "path/filepath"
11 "testing"
13 "github.com/stretchr/testify/assert"
14 "github.com/stretchr/testify/require"
15 "go.uber.org/mock/gomock"
17 gitlabtesting "gitlab.com/gitlab-org/api/client-go/v3/testing"
19 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
22func doesFileExist(fileName string) bool {
23 _, err := os.Stat(fileName)
24 return err == nil
27func createZipBuffer(t *testing.T, filename string) *bytes.Reader {
28 t.Helper()
30 buf := new(bytes.Buffer)
31 zipWriter := zip.NewWriter(buf)
33 f1, err := os.Open("./testdata/file.txt")
34 require.NoError(t, err)
35 defer f1.Close()
37 w1, err := zipWriter.Create(filename)
38 require.NoError(t, err)
40 _, err = io.Copy(w1, f1)
41 require.NoError(t, err)
43 err = zipWriter.Close()
44 require.NoError(t, err)
46 return bytes.NewReader(buf.Bytes())
49func createSymlinkZipBuffer(t *testing.T, tempPath string) *bytes.Reader {
50 t.Helper()
52 buf := new(bytes.Buffer)
54 immutableFile, err := os.CreateTemp(tempPath, "immutable_file*.txt")
55 require.NoError(t, err)
57 immutableText := "Immutable text! GitLab is cool"
58 _, err = immutableFile.WriteString(immutableText)
59 require.NoError(t, err)
60 immutableFile.Close()
62 err = os.Symlink(immutableFile.Name(), filepath.Join(tempPath, "symlink_file.txt"))
63 require.NoError(t, err)
65 zipWriter := zip.NewWriter(buf)
67 fixtureFile, err := os.Open("./testdata/file.txt")
68 require.NoError(t, err)
69 defer fixtureFile.Close()
71 zipFile, err := zipWriter.Create("symlink_file.txt")
72 require.NoError(t, err)
74 _, err = io.Copy(zipFile, fixtureFile)
75 require.NoError(t, err)
77 err = zipWriter.Close()
78 require.NoError(t, err)
80 return bytes.NewReader(buf.Bytes())
83func Test_NewCmdRun(t *testing.T) {
84 tests := []struct {
85 name string
86 filename string
87 want string
88 wantErr bool
89 }{
90 {
91 name: "A regular filename",
92 filename: "cli-v1.22.0.json",
93 want: "cli-v1.22.0.json",
94 },
95 {
96 name: "A regular filename in a directory",
97 filename: "cli/cli-v1.22.0.json",
98 want: "cli/cli-v1.22.0.json",
99 },
100 {
101 name: "A filename with directory traversal",
102 filename: "cli-v1.../../22.0.zip",
103 wantErr: true,
104 },
105 {
106 name: "A particularly nasty filename",
107 filename: "..././..././..././etc/password_file",
108 wantErr: true,
109 },
110 }
111 for _, tt := range tests {
112 t.Run(tt.name, func(t *testing.T) {
113 // GIVEN
114 testClient := gitlabtesting.NewTestClient(t)
115 tempPath := t.TempDir()
117 zipBuffer := createZipBuffer(t, tt.filename)
119 testClient.MockJobs.EXPECT().
120 DownloadArtifactsFile("OWNER/REPO", "main", gomock.Any(), gomock.Any()).
121 Return(zipBuffer, nil, nil)
123 exec := cmdtest.SetupCmdForTest(
124 t,
125 NewCmdRun,
126 false,
127 cmdtest.WithGitLabClient(testClient.Client),
128 )
130 // WHEN
131 _, err := exec("main secret_detection --path=" + filepath.ToSlash(tempPath))
133 // THEN
134 filePathWanted := filepath.Join(tempPath, tt.want)
136 if tt.wantErr {
137 assert.Error(t, err, "Should error out if a path doesn't exist")
138 return
139 }
141 require.NoError(t, err, "Should not have errors")
142 assert.True(t, doesFileExist(filePathWanted), "File should exist")
143 })
144 }
146 t.Run("symlink can't overwrite", func(t *testing.T) {
147 // GIVEN
148 testClient := gitlabtesting.NewTestClient(t)
149 tempPath := t.TempDir()
151 zipBuffer := createSymlinkZipBuffer(t, tempPath)
153 testClient.MockJobs.EXPECT().
154 DownloadArtifactsFile("OWNER/REPO", "main", gomock.Any(), gomock.Any()).
155 Return(zipBuffer, nil, nil)
157 exec := cmdtest.SetupCmdForTest(
158 t,
159 NewCmdRun,
160 false,
161 cmdtest.WithGitLabClient(testClient.Client),
162 )
164 // WHEN
165 _, err := exec("main secret_detection --path=" + filepath.ToSlash(tempPath))
167 // THEN
168 assert.Error(t, err, "file in artifact would overwrite a symbolic link- cannot extract")
169 })
Diagnostics8 git calls · 196 ms
CallStatusSizeTime0196 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 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=2
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=44
Open pack map
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:0200635 B · 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=635
git.response.cache=HIT
git.response.duration_ms=4
git.fetch.filter=tree:0
git.fetch.wants=517b073a0d5c32bc4e93f86de74b31d60ff8cf03
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=635
git.pkt.payload.max=608
git.sideband.band1.bytes=608
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=608
git.pack.trailer=178abb9456d874b7fd38fa21ad5cf9ca3ebcccaa
Open pack map
fetchtree:0200171 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=171
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=9347307f42d9c31d2cd60513d7c8891d7f3d902f
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=171
git.pkt.payload.max=144
git.sideband.band1.bytes=144
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=144
git.pack.trailer=aeb30af3ea38486de269e173e0520cc7947ee833
Open pack map
fetch2001.3 KiB182 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=182
git.response.bytes=1354
git.response.cache=MISS
git.response.duration_ms=182
git.fetch.wants=153e0de25d343118cb306161b53b89c0dace6bf3
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=1354
git.pkt.payload.max=1327
git.sideband.band1.bytes=1327
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
a5e2f0fbebc5fda9
Request
21d8f433…
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