GitLabgitlab-org
cli
main
1// Package tokenexchangetest provides shared test helpers for
2// internal/api/tokenexchange and the packages built on top of it, so their
3// tests don't each redefine the same fake token_exchange server and fake JWT.
4package tokenexchangetest
6import (
7 "encoding/json"
8 "net/http"
9 "net/http/httptest"
10 "slices"
11 "sync/atomic"
12 "testing"
14 "github.com/golang-jwt/jwt/v5"
15 "github.com/stretchr/testify/assert"
16 "github.com/stretchr/testify/require"
18 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
20 "gitlab.com/gitlab-org/cli/internal/api"
21 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
22)
24// WireRequest mirrors the JSON body tokenexchange.Exchange sends to
25// POST /api/v4/token_exchange.
26type WireRequest struct {
27 Audience string `json:"audience"`
28 ExpiresIn int `json:"expires_in"`
29}
31// NewTestServer starts a fake token_exchange endpoint and returns it along
32// with a counter of how many requests it received, so tests can assert that
33// invalid input never reaches the network.
34func NewTestServer(t *testing.T, handler http.HandlerFunc) (*httptest.Server, *atomic.Int32) {
35 t.Helper()
37 var count atomic.Int32
38 srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
39 count.Add(1)
40 handler(w, r)
41 }))
42 t.Cleanup(srv.Close)
44 return srv, &count
45}
47// NewTokenExchangeServer starts a fake token_exchange endpoint that asserts
48// the request is a well-formed POST to the expected path, decodes its body
49// into gotBody, and always responds with wantToken.
50func NewTokenExchangeServer(t *testing.T, wantToken string, gotBody *WireRequest) (*httptest.Server, *atomic.Int32) {
51 t.Helper()
53 return NewTestServer(t, func(w http.ResponseWriter, r *http.Request) {
54 assert.Equal(t, http.MethodPost, r.Method)
55 assert.Equal(t, "/api/v4/token_exchange", r.URL.Path)
56 assert.NoError(t, json.NewDecoder(r.Body).Decode(gotBody))
58 body, err := json.Marshal(struct { //nolint:forbidigo // building the fake server's response body, not stdout output
59 Token string `json:"token"`
60 }{Token: wantToken})
61 if !assert.NoError(t, err) {
62 return
63 }
65 w.Header().Set("Content-Type", "application/json")
66 w.WriteHeader(http.StatusOK)
67 _, _ = w.Write(body)
68 })
69}
71// NewTestClient builds a *gitlab.Client pointed at baseURL (typically an
72// httptest.Server's URL).
73func NewTestClient(t *testing.T, baseURL string) *gitlab.Client {
74 t.Helper()
76 gl, err := gitlab.NewClient("test-token", gitlab.WithBaseURL(baseURL+"/api/v4"))
77 require.NoError(t, err)
79 return gl
80}
82// NewTestExec wires cmdFunc to an api.Client pointed at srv, mirroring how
83// f.ApiClient(hostname).Lab() resolves in production.
84func NewTestExec(t *testing.T, srv *httptest.Server, cmdFunc cmdtest.CmdFunc, opts ...cmdtest.FactoryOption) cmdtest.CmdExecFunc {
85 t.Helper()
87 apiClient := cmdtest.NewTestApiClient(t, nil, "", "", api.WithGitLabClient(NewTestClient(t, srv.URL)))
88 return cmdtest.SetupCmdForTest(t, cmdFunc, false, append(slices.Clip(opts), cmdtest.WithApiClient(apiClient))...)
89}
91// MakeJWT mints a JWT carrying claims. Code under test never verifies token
92// signatures, so any signing key works here.
93func MakeJWT(t *testing.T, claims jwt.RegisteredClaims) string {
94 t.Helper()
96 token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
97 signed, err := token.SignedString([]byte("test-signing-key"))
98 require.NoError(t, err)
100 return signed
101}
Diagnostics7 git calls · 31 ms
CallStatusSizeTime031 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 · 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 · 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=44Open pack map
fetchtree:0200233 B · 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=233 git.response.cache=HIT git.response.duration_ms=1 git.fetch.filter=tree:0 git.fetch.wants=be3b2f46264fd78e3aeec243c47ee7f44f4b940d 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=233 git.pkt.payload.max=206 git.sideband.band1.bytes=206 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=206 git.pack.trailer=60d385382f0daa4bf5b182241b9c3f6f6404da58Open pack map
fetchtree:0200118 B · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=21 git.response.bytes=118 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=tree:0 git.fetch.wants=37ed08f18c2dd98154dcd4f5b11a4e611ad57fc2 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=118 git.pkt.payload.max=91 git.sideband.band1.bytes=91 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=91 git.pack.trailer=df93cfa03734092e98a7547d509d8af829da8dfcOpen pack map
fetch2001.5 KiB · hit21 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1518 git.response.cache=HIT git.response.duration_ms=21 git.fetch.wants=80bea36167b370596fcf84d32198ca976b936fdb 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=1518 git.pkt.payload.max=1491 git.sideband.band1.bytes=1491 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
- a5e2cc094e657929
- Request
- b4141fe7…
- 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