GitLabgitlab-org

cli

main
ply6 git calls228 ms97 KiB4 cachedprotocol v2
239 lines5.8 KiBRaw
1//go:build !integration
3package binarymgr
5import (
6 "archive/tar"
7 "archive/zip"
8 "bytes"
9 "compress/gzip"
10 "os"
11 "path/filepath"
12 "runtime"
13 "testing"
15 "github.com/stretchr/testify/assert"
16 "github.com/stretchr/testify/require"
19func writeTarGz(t *testing.T, entries []tarEntry) string {
20 t.Helper()
21 var buf bytes.Buffer
22 gz := gzip.NewWriter(&buf)
23 tw := tar.NewWriter(gz)
24 for _, e := range entries {
25 require.NoError(t, tw.WriteHeader(&tar.Header{
26 Name: e.name,
27 Mode: e.mode,
28 Size: int64(len(e.body)),
29 Typeflag: e.typeflag,
30 }))
31 _, err := tw.Write(e.body)
32 require.NoError(t, err)
33 }
34 require.NoError(t, tw.Close())
35 require.NoError(t, gz.Close())
37 path := filepath.Join(t.TempDir(), "archive.tar.gz")
38 require.NoError(t, os.WriteFile(path, buf.Bytes(), 0o644))
39 return path
42type tarEntry struct {
43 name string
44 mode int64
45 body []byte
46 typeflag byte
49func TestTarGzExtractor_extractsBinary(t *testing.T) {
50 t.Parallel()
52 src := writeTarGz(t, []tarEntry{
53 {name: "README", mode: 0o644, body: []byte("readme"), typeflag: tar.TypeReg},
54 {name: "orbit", mode: 0o755, body: []byte("orbit-binary-bytes"), typeflag: tar.TypeReg},
55 })
57 dest := t.TempDir()
58 got, err := TarGzExtractor("orbit")(src, dest)
59 require.NoError(t, err)
60 assert.Equal(t, filepath.Join(dest, "orbit"), got)
62 data, err := os.ReadFile(got)
63 require.NoError(t, err)
64 assert.Equal(t, []byte("orbit-binary-bytes"), data)
66 if runtime.GOOS != "windows" {
67 info, err := os.Stat(got)
68 require.NoError(t, err)
69 assert.NotZero(t, info.Mode().Perm()&0o111, "extracted file should be executable")
70 }
73func TestTarGzExtractor_findsBinaryInSubdir(t *testing.T) {
74 t.Parallel()
76 src := writeTarGz(t, []tarEntry{
77 {name: "release/orbit", mode: 0o755, body: []byte("nested"), typeflag: tar.TypeReg},
78 })
80 dest := t.TempDir()
81 got, err := TarGzExtractor("orbit")(src, dest)
82 require.NoError(t, err)
83 assert.Equal(t, filepath.Join(dest, "orbit"), got)
86func TestTarGzExtractor_missingBinary(t *testing.T) {
87 t.Parallel()
89 src := writeTarGz(t, []tarEntry{
90 {name: "README", mode: 0o644, body: []byte("readme"), typeflag: tar.TypeReg},
91 })
93 _, err := TarGzExtractor("orbit")(src, t.TempDir())
94 require.Error(t, err)
95 assert.Contains(t, err.Error(), `does not contain "orbit"`)
98func TestTarGzExtractor_rejectsZipSlip(t *testing.T) {
99 t.Parallel()
101 src := writeTarGz(t, []tarEntry{
102 {name: "../escape/orbit", mode: 0o755, body: []byte("evil"), typeflag: tar.TypeReg},
103 })
105 _, err := TarGzExtractor("orbit")(src, t.TempDir())
106 require.Error(t, err)
107 assert.Contains(t, err.Error(), "escapes")
110func TestTarGzExtractor_rejectsAbsolutePath(t *testing.T) {
111 t.Parallel()
113 src := writeTarGz(t, []tarEntry{
114 {name: "/etc/orbit", mode: 0o755, body: []byte("evil"), typeflag: tar.TypeReg},
115 })
117 _, err := TarGzExtractor("orbit")(src, t.TempDir())
118 require.Error(t, err)
119 assert.Contains(t, err.Error(), "escapes")
122func TestTarGzExtractor_skipsSymlinks(t *testing.T) {
123 t.Parallel()
125 src := writeTarGz(t, []tarEntry{
126 {name: "orbit", mode: 0o777, typeflag: tar.TypeSymlink},
127 {name: "release/orbit", mode: 0o755, body: []byte("real"), typeflag: tar.TypeReg},
128 })
130 dest := t.TempDir()
131 got, err := TarGzExtractor("orbit")(src, dest)
132 require.NoError(t, err)
134 data, err := os.ReadFile(got)
135 require.NoError(t, err)
136 assert.Equal(t, []byte("real"), data)
139type zipEntry struct {
140 name string
141 mode os.FileMode
142 body []byte
145func writeZip(t *testing.T, entries []zipEntry) string {
146 t.Helper()
147 var buf bytes.Buffer
148 zw := zip.NewWriter(&buf)
149 for _, e := range entries {
150 hdr := &zip.FileHeader{Name: e.name, Method: zip.Deflate}
151 mode := e.mode
152 if mode == 0 {
153 mode = 0o644
154 }
155 hdr.SetMode(mode)
156 w, err := zw.CreateHeader(hdr)
157 require.NoError(t, err)
158 _, err = w.Write(e.body)
159 require.NoError(t, err)
160 }
161 require.NoError(t, zw.Close())
163 path := filepath.Join(t.TempDir(), "archive.zip")
164 require.NoError(t, os.WriteFile(path, buf.Bytes(), 0o644))
165 return path
168func TestZipExtractor_extractsBinary(t *testing.T) {
169 t.Parallel()
171 src := writeZip(t, []zipEntry{
172 {name: "README", mode: 0o644, body: []byte("readme")},
173 {name: "orbit.exe", mode: 0o755, body: []byte("orbit-binary-bytes")},
174 })
176 dest := t.TempDir()
177 got, err := ZipExtractor("orbit.exe")(src, dest)
178 require.NoError(t, err)
179 assert.Equal(t, filepath.Join(dest, "orbit.exe"), got)
181 data, err := os.ReadFile(got)
182 require.NoError(t, err)
183 assert.Equal(t, []byte("orbit-binary-bytes"), data)
185 if runtime.GOOS != "windows" {
186 info, err := os.Stat(got)
187 require.NoError(t, err)
188 assert.NotZero(t, info.Mode().Perm()&0o111, "extracted file should be executable")
189 }
192func TestZipExtractor_findsBinaryInSubdir(t *testing.T) {
193 t.Parallel()
195 src := writeZip(t, []zipEntry{
196 {name: "release/orbit.exe", mode: 0o755, body: []byte("nested")},
197 })
199 dest := t.TempDir()
200 got, err := ZipExtractor("orbit.exe")(src, dest)
201 require.NoError(t, err)
202 assert.Equal(t, filepath.Join(dest, "orbit.exe"), got)
205func TestZipExtractor_missingBinary(t *testing.T) {
206 t.Parallel()
208 src := writeZip(t, []zipEntry{
209 {name: "README", mode: 0o644, body: []byte("readme")},
210 })
212 _, err := ZipExtractor("orbit.exe")(src, t.TempDir())
213 require.Error(t, err)
214 assert.Contains(t, err.Error(), `does not contain "orbit.exe"`)
217func TestZipExtractor_rejectsZipSlip(t *testing.T) {
218 t.Parallel()
220 src := writeZip(t, []zipEntry{
221 {name: "../escape/orbit.exe", mode: 0o755, body: []byte("evil")},
222 })
224 _, err := ZipExtractor("orbit.exe")(src, t.TempDir())
225 require.Error(t, err)
226 assert.Contains(t, err.Error(), "escapes")
229func TestZipExtractor_rejectsAbsolutePath(t *testing.T) {
230 t.Parallel()
232 src := writeZip(t, []zipEntry{
233 {name: "/etc/orbit.exe", mode: 0o755, body: []byte("evil")},
234 })
236 _, err := ZipExtractor("orbit.exe")(src, t.TempDir())
237 require.Error(t, err)
238 assert.Contains(t, err.Error(), "escapes")
Diagnostics6 git calls · 228 ms
CallStatusSizeTime0228 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 KiB · hit8 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=8
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=3
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 · hit3 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=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:0200528 B · 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=528
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=6f25b436c20690dd9e61e310cecb2c93d3671017
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=528
git.pkt.payload.max=501
git.sideband.band1.bytes=501
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=501
git.pack.trailer=3f78362ab585c40c9cff18b66b4df6f87bfba2d8
Open pack map
fetch2001.2 KiB216 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=216
git.response.bytes=1279
git.response.cache=MISS
git.response.duration_ms=216
git.fetch.wants=2b44d155853ab3bccc8138c89b0994810ce3f4c1
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=1279
git.pkt.payload.max=1252
git.sideband.band1.bytes=1252
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
a5e189f65dac5e37
Request
5d721945…
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