GitLabgitlab-org

cli

main
ply8 git calls70 ms99 KiB6 cachedprotocol v2
254 lines7.6 KiBRaw
1//go:build !integration
3package remote
5import (
6 "encoding/json"
7 "net/http"
8 "net/http/httptest"
9 "strings"
10 "testing"
12 "github.com/stretchr/testify/assert"
13 "github.com/stretchr/testify/require"
15 "gitlab.com/gitlab-org/cli/internal/commands/skills/skill"
18func TestAll_LoadsShippedRegistry(t *testing.T) {
19 t.Parallel()
21 skills, err := All()
22 require.NoError(t, err)
23 for _, s := range skills {
24 assert.NotEmpty(t, s.Name)
25 assert.NotEmpty(t, s.Description)
26 assert.Equal(t, skill.SourceRemote, s.Source)
27 assert.Empty(t, s.Files, "All() returns metadata-only Skills; files come from Get()")
28 }
31func TestGet_UnknownReturnsErrNotFound(t *testing.T) {
32 t.Parallel()
34 _, err := Get("does-not-exist")
35 require.Error(t, err)
36 assert.ErrorIs(t, err, ErrNotFound, "error must wrap ErrNotFound")
39func TestValidateEntries(t *testing.T) {
40 t.Parallel()
42 t.Run("valid", func(t *testing.T) {
43 t.Parallel()
44 require.NoError(t, validateEntries([]Entry{{
45 Name: "ok", Description: "d", Project: "g/p", Ref: "latest", Path: "x",
46 }}))
47 })
49 t.Run("missing fields", func(t *testing.T) {
50 t.Parallel()
51 err := validateEntries([]Entry{{Name: "broken"}})
52 require.Error(t, err)
53 msg := err.Error()
54 assert.Contains(t, msg, "missing 'description'")
55 assert.Contains(t, msg, "missing 'project'")
56 assert.Contains(t, msg, "missing 'ref'")
57 assert.Contains(t, msg, "missing 'path'")
58 })
60 t.Run("duplicate name", func(t *testing.T) {
61 t.Parallel()
62 err := validateEntries([]Entry{
63 {Name: "dup", Description: "d", Project: "g/p", Ref: "latest", Path: "x"},
64 {Name: "dup", Description: "d", Project: "g/p", Ref: "latest", Path: "y"},
65 })
66 require.Error(t, err)
67 assert.Contains(t, err.Error(), "listed more than once")
68 })
71// fakeGitLab spins up an httptest server that emulates the subset of
72// gitlab.com endpoints the fetcher uses.
73type fakeGitLab struct {
74 server *httptest.Server
75 defaultBranch string
76 files map[string]string // path -> contents
79func newFakeGitLab(t *testing.T, defaultBranch string, files map[string]string) *fakeGitLab {
80 t.Helper()
81 g := &fakeGitLab{defaultBranch: defaultBranch, files: files}
83 mux := http.NewServeMux()
84 mux.HandleFunc("/api/v4/projects/", func(w http.ResponseWriter, r *http.Request) {
85 // Project metadata: /api/v4/projects/<encoded>
86 // Tree: /api/v4/projects/<encoded>/repository/tree
87 switch {
88 case strings.HasSuffix(r.URL.Path, "/repository/tree"):
89 g.serveTree(w, r)
90 default:
91 g.serveProject(w)
92 }
93 })
94 mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
95 // Raw: /<project>/-/raw/<ref>/<filepath>
96 idx := strings.Index(r.URL.Path, "/-/raw/")
97 if idx == -1 {
98 http.NotFound(w, r)
99 return
100 }
101 // strip the prefix and the ref segment after /-/raw/
102 rest := r.URL.Path[idx+len("/-/raw/"):]
103 // rest is "<ref>/<filepath>"; drop the first path segment
104 _, after, ok0 := strings.Cut(rest, "/")
105 if !ok0 {
106 http.NotFound(w, r)
107 return
108 }
109 filePath := after
110 body, ok := g.files[filePath]
111 if !ok {
112 http.NotFound(w, r)
113 return
114 }
115 _, _ = w.Write([]byte(body))
116 })
117 g.server = httptest.NewServer(mux)
118 t.Cleanup(g.server.Close)
119 return g
122func (g *fakeGitLab) serveProject(w http.ResponseWriter) {
123 w.Header().Set("Content-Type", "application/json")
124 _ = json.NewEncoder(w).Encode(map[string]string{"default_branch": g.defaultBranch})
127func (g *fakeGitLab) serveTree(w http.ResponseWriter, r *http.Request) {
128 path := r.URL.Query().Get("path")
129 var entries []map[string]string
130 for fp := range g.files {
131 if !strings.HasPrefix(fp, path+"/") && fp != path {
132 continue
133 }
134 entries = append(entries, map[string]string{"path": fp, "type": "blob"})
135 }
136 w.Header().Set("Content-Type", "application/json")
137 w.Header().Set("X-Next-Page", "")
138 _ = json.NewEncoder(w).Encode(entries)
141func TestFetcher_FetchesAllFiles(t *testing.T) {
142 t.Parallel()
144 g := newFakeGitLab(t, "main", map[string]string{
145 "skills/demo/SKILL.md": "---\nname: demo\ndescription: a demo\n---\nbody\n",
146 "skills/demo/scripts/run.sh": "#!/bin/sh\necho hi\n",
147 "skills/demo/references/REF.md": "# Reference\n",
148 })
150 f := &fetcher{client: http.DefaultClient, api: g.server.URL + "/api/v4", host: g.server.URL}
151 s, err := f.fetch(Entry{
152 Name: "demo", Description: "a demo",
153 Project: "group/proj", Ref: "v1.0.0", Path: "skills/demo",
154 })
155 require.NoError(t, err)
156 assert.Equal(t, "demo", s.Name)
157 assert.Equal(t, skill.SourceRemote, s.Source)
158 assert.Equal(t, "---\nname: demo\ndescription: a demo\n---\nbody\n", string(s.Files[skill.FileName]))
159 assert.Equal(t, "#!/bin/sh\necho hi\n", string(s.Files["scripts/run.sh"]))
160 assert.Equal(t, "# Reference\n", string(s.Files["references/REF.md"]))
163func TestFetcher_ResolvesLatestToDefaultBranch(t *testing.T) {
164 t.Parallel()
166 g := newFakeGitLab(t, "main", map[string]string{
167 "skills/demo/SKILL.md": "---\nname: demo\ndescription: d\n---\n",
168 })
170 f := &fetcher{client: http.DefaultClient, api: g.server.URL + "/api/v4", host: g.server.URL}
171 ref, err := f.resolveRef("group/proj", "latest")
172 require.NoError(t, err)
173 assert.Equal(t, "main", ref)
176func TestFetcher_MissingSkillMD(t *testing.T) {
177 t.Parallel()
179 g := newFakeGitLab(t, "main", map[string]string{
180 "skills/demo/README.md": "wrong file\n",
181 })
183 f := &fetcher{client: http.DefaultClient, api: g.server.URL + "/api/v4", host: g.server.URL}
184 _, err := f.fetch(Entry{
185 Name: "demo", Description: "d",
186 Project: "g/p", Ref: "v1", Path: "skills/demo",
187 })
188 require.Error(t, err)
189 assert.Contains(t, err.Error(), "has no "+skill.FileName)
192func TestFetcher_RewritesFrontmatterNameToEntryName(t *testing.T) {
193 t.Parallel()
195 g := newFakeGitLab(t, "trunk", map[string]string{
196 "skills/demo-wrapper/SKILL.md": "---\nname: demo-wrapper\ndescription: a demo\nmetadata:\n name: keep\n---\n\nname: body line\n",
197 })
199 f := &fetcher{client: http.DefaultClient, api: g.server.URL + "/api/v4", host: g.server.URL}
200 s, err := f.fetch(Entry{
201 Name: "demo", Description: "a demo",
202 Project: "g/p", Ref: "latest", Path: "skills/demo-wrapper",
203 })
204 require.NoError(t, err)
205 assert.Equal(t, "demo", s.Name)
206 assert.Equal(t, "---\nname: demo\ndescription: a demo\nmetadata:\n name: keep\n---\n\nname: body line\n", string(s.Files[skill.FileName]))
209func TestFetcher_RejectsSkillMDWithoutFrontmatterName(t *testing.T) {
210 t.Parallel()
212 g := newFakeGitLab(t, "main", map[string]string{
213 "skills/demo/SKILL.md": "---\ndescription: a demo\n---\nbody\n",
214 })
216 f := &fetcher{client: http.DefaultClient, api: g.server.URL + "/api/v4", host: g.server.URL}
217 _, err := f.fetch(Entry{
218 Name: "demo", Description: "d",
219 Project: "g/p", Ref: "v1", Path: "skills/demo",
220 })
221 require.Error(t, err)
222 assert.Contains(t, err.Error(), "missing 'name'")
225func TestFetcher_RewritesFrontmatterNamePreservingCRLF(t *testing.T) {
226 t.Parallel()
228 g := newFakeGitLab(t, "main", map[string]string{
229 "skills/demo-wrapper/SKILL.md": "---\r\nname: demo-wrapper\r\ndescription: a demo\r\n---\r\nbody\r\n",
230 })
232 f := &fetcher{client: http.DefaultClient, api: g.server.URL + "/api/v4", host: g.server.URL}
233 s, err := f.fetch(Entry{
234 Name: "demo", Description: "a demo",
235 Project: "g/p", Ref: "v1", Path: "skills/demo-wrapper",
236 })
237 require.NoError(t, err)
238 assert.Equal(t, "---\r\nname: demo\r\ndescription: a demo\r\n---\r\nbody\r\n", string(s.Files[skill.FileName]))
241func TestValidateEntries_RejectsInvalidNames(t *testing.T) {
242 t.Parallel()
244 valid := Entry{Description: "d", Project: "g/p", Ref: "latest", Path: "skills/x"}
245 for _, name := range []string{"Orbit", "my_skill", "-orbit", "orbit-", "or--bit", "../x"} {
246 e := valid
247 e.Name = name
248 require.Error(t, validateEntries([]Entry{e}), name)
249 }
251 e := valid
252 e.Name = "orbit-2"
253 require.NoError(t, validateEntries([]Entry{e}))
Diagnostics8 git calls · 70 ms
CallStatusSizeTime070 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 KiB9 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=UPDATING
git.response.duration_ms=9
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=4
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 · 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=32926
git.response.cache=HIT
git.response.duration_ms=4
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 · 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=1857
git.response.cache=HIT
git.response.duration_ms=2
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:0200370 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=370
git.response.cache=HIT
git.response.duration_ms=4
git.fetch.filter=tree:0
git.fetch.wants=290ae7a62f76e23cbbd60697570f19b90ddcece6
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=370
git.pkt.payload.max=343
git.sideband.band1.bytes=343
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=343
git.pack.trailer=0795a26d2b25022c69da2ef2e68cfb92a77ef4bb
Open pack map
fetchtree:0200205 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=205
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=81dc066a953916d0f0a002cd7235dfc47cfbe9ea
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=205
git.pkt.payload.max=178
git.sideband.band1.bytes=178
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=178
git.pack.trailer=a6b69d21421b8ef5347f95fc10c7bb5be79155a9
Open pack map
fetch2002.1 KiB · hit49 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=49
git.response.bytes=2183
git.response.cache=HIT
git.response.duration_ms=49
git.fetch.wants=46db04a17616346949bd63b5b258384cdd739587
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=2183
git.pkt.payload.max=2156
git.sideband.band1.bytes=2156
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
a5e2da610a2c14c2
Request
1a63f207…
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