GitLabgitlab-org

cli

main
ply6 git calls239 ms98 KiB4 cachedprotocol v2
185 lines5.7 KiBRaw
1//go:build !integration
3package api
5import (
6 "crypto/tls"
7 "io"
8 "net"
9 "net/http"
10 "net/http/httptest"
11 "path/filepath"
12 "testing"
14 "github.com/stretchr/testify/assert"
15 "github.com/stretchr/testify/require"
17 "gitlab.com/gitlab-org/cli/internal/config"
20func TestNewClientFromConfigProxy(t *testing.T) {
21 t.Run("configured proxy", func(t *testing.T) {
22 cfg := config.NewBlankConfig()
23 require.NoError(t, cfg.Set("gitlab.example.com", "token", "glpat-test"))
24 require.NoError(t, cfg.Set("gitlab.example.com", "proxy", "https://proxy.local:8443"))
26 client, err := NewClientFromConfig("gitlab.example.com", cfg, false, "glab-test")
27 require.NoError(t, err)
28 transport, ok := client.HTTPClient().Transport.(*http.Transport)
29 require.True(t, ok)
30 req, err := http.NewRequestWithContext(t.Context(), http.MethodGet, "https://gitlab.example.com/api/v4", http.NoBody)
31 require.NoError(t, err)
33 proxyURL, err := transport.Proxy(req)
34 require.NoError(t, err)
35 require.NotNil(t, proxyURL)
36 assert.Equal(t, "https://proxy.local:8443", proxyURL.String())
37 })
39 t.Run("missing host uses the environment", func(t *testing.T) {
40 cfg := config.NewBlankConfig()
41 require.NoError(t, cfg.Set("missing.example.com", "token", "glpat-test"))
43 client, err := NewClientFromConfig("missing.example.com", cfg, false, "glab-test")
44 require.NoError(t, err)
45 assert.Nil(t, client.proxyURL)
46 })
48 t.Run("GLAB_PROXY environment variable", func(t *testing.T) {
49 t.Setenv("GLAB_PROXY", "http://env-proxy.local:3128")
50 cfg := config.NewBlankConfig()
51 require.NoError(t, cfg.Set("gitlab.example.com", "token", "glpat-test"))
53 client, err := NewClientFromConfig("gitlab.example.com", cfg, false, "glab-test")
54 require.NoError(t, err)
55 require.NotNil(t, client.proxyURL)
56 assert.Equal(t, "http://env-proxy.local:3128", client.proxyURL.String())
57 })
59 t.Run("invalid configured proxy", func(t *testing.T) {
60 cfg := config.NewBlankConfig()
61 require.NoError(t, cfg.Set("bad.example.com", "token", "glpat-test"))
62 require.NoError(t, cfg.Set("bad.example.com", "proxy", "://bad-url"))
64 _, err := NewClientFromConfig("bad.example.com", cfg, false, "glab-test")
65 require.ErrorContains(t, err, "failed to resolve proxy")
66 })
69// newHTTP2ConnectProxy starts an HTTPS CONNECT proxy whose TLS listener offers
70// h2 in ALPN, as some corporate proxies do. It reports the protocol of each
71// CONNECT request it tunnels.
72func newHTTP2ConnectProxy(t *testing.T) (*httptest.Server, <-chan string) {
73 t.Helper()
75 connects := make(chan string, 1)
76 proxy := httptest.NewUnstartedServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
77 if r.Method != http.MethodConnect {
78 http.Error(w, "CONNECT only", http.StatusMethodNotAllowed)
79 return
80 }
81 connects <- r.Proto
83 upstream, err := net.Dial("tcp", r.Host)
84 if err != nil {
85 http.Error(w, err.Error(), http.StatusBadGateway)
86 return
87 }
88 defer upstream.Close()
90 downstream, brw, err := http.NewResponseController(w).Hijack()
91 if err != nil {
92 return
93 }
94 defer downstream.Close()
96 if _, err := downstream.Write([]byte("HTTP/1.1 200 Connection established\r\n\r\n")); err != nil {
97 return
98 }
99 done := make(chan struct{})
100 go func() {
101 defer close(done)
102 _, _ = io.Copy(upstream, brw)
103 }()
104 _, _ = io.Copy(downstream, upstream)
105 downstream.Close()
106 <-done
107 }))
108 proxy.EnableHTTP2 = true
109 proxy.TLS = &tls.Config{NextProtos: []string{"h2", "http/1.1"}}
110 proxy.StartTLS()
111 t.Cleanup(proxy.Close)
112 return proxy, connects
115func newHTTP2Server(t *testing.T) (*httptest.Server, <-chan string) {
116 t.Helper()
118 protos := make(chan string, 1)
119 srv := httptest.NewUnstartedServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
120 protos <- r.Proto
121 w.WriteHeader(http.StatusOK)
122 }))
123 srv.EnableHTTP2 = true
124 srv.StartTLS()
125 t.Cleanup(srv.Close)
126 return srv, protos
129func TestNewClientFromConfig_HTTPSProxyOfferingHTTP2(t *testing.T) {
130 t.Parallel()
132 t.Run("tunnels through the proxy over HTTP/1.1", func(t *testing.T) {
133 t.Parallel()
135 target, protos := newHTTP2Server(t)
136 proxy, connects := newHTTP2ConnectProxy(t)
137 // httptest servers share one certificate, so this CA trusts the proxy too.
138 caPath := filepath.Join(t.TempDir(), "ca.pem")
139 writeServerCA(t, target, caPath)
140 cfg := newServerConfig(t, target, map[string]string{"ca_cert": caPath, "proxy": proxy.URL})
142 client, err := NewClientFromConfig(serverHost(target), cfg, false, "glab-test")
143 require.NoError(t, err)
144 mustGet(t, client, target.URL)
146 assert.Equal(t, "HTTP/1.1", <-connects)
147 assert.Equal(t, "HTTP/2.0", <-protos)
148 })
150 t.Run("direct connections keep HTTP/2", func(t *testing.T) {
151 t.Parallel()
153 target, protos := newHTTP2Server(t)
154 caPath := filepath.Join(t.TempDir(), "ca.pem")
155 writeServerCA(t, target, caPath)
156 cfg := newServerConfig(t, target, map[string]string{"ca_cert": caPath})
158 client, err := NewClientFromConfig(serverHost(target), cfg, false, "glab-test")
159 require.NoError(t, err)
160 mustGet(t, client, target.URL)
162 assert.Equal(t, "HTTP/2.0", <-protos)
163 })
165 t.Run("websocket upgrades without a proxy use HTTP/1.1", func(t *testing.T) {
166 t.Parallel()
168 target, protos := newHTTP2Server(t)
169 caPath := filepath.Join(t.TempDir(), "ca.pem")
170 writeServerCA(t, target, caPath)
171 cfg := newServerConfig(t, target, map[string]string{"ca_cert": caPath})
173 client, err := NewClientFromConfig(serverHost(target), cfg, false, "glab-test", WithTransportCache(NewTransportCache()))
174 require.NoError(t, err)
175 req, err := http.NewRequestWithContext(t.Context(), http.MethodGet, target.URL, http.NoBody)
176 require.NoError(t, err)
177 req.Header.Set("Connection", "Upgrade")
178 req.Header.Set("Upgrade", "websocket")
179 resp, err := client.HTTPClient().Do(req)
180 require.NoError(t, err)
181 require.NoError(t, resp.Body.Close())
183 assert.Equal(t, "HTTP/1.1", <-protos)
184 })
Diagnostics6 git calls · 239 ms
CallStatusSizeTime0239 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 · 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=2
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
fetchtree:0 · deepen 1020032 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=32926
git.response.cache=HIT
git.response.duration_ms=1
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
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:02001.1 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=1165
git.response.cache=HIT
git.response.duration_ms=1
git.fetch.filter=tree:0
git.fetch.wants=71c8407e0ff0e0af10f6a041ae330f754b68e7eb
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=1165
git.pkt.payload.max=1138
git.sideband.band1.bytes=1138
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1138
git.pack.trailer=61886367c69619d8db2b2cf2d7d24dca2016141c
Open pack map
fetch2001.7 KiB232 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=232
git.response.bytes=1765
git.response.cache=MISS
git.response.duration_ms=232
git.fetch.wants=f82d8c8fef274c6e97d3c8e2a8b2287de12bd62f
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=1765
git.pkt.payload.max=1738
git.sideband.band1.bytes=1738
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
a5e130077cb2a9fe
Request
7d93ecf5…
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