GitLabgitlab-org
cli
main
1//go:build !integration
3package update
5import (
6 "os"
7 "path/filepath"
8 "testing"
10 "github.com/stretchr/testify/assert"
11 "github.com/stretchr/testify/require"
13 "gitlab.com/gitlab-org/cli/internal/commands/skills/bundled"
14 "gitlab.com/gitlab-org/cli/internal/commands/skills/installed"
15 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
16)
18// installedSkill seeds a single bundled-skill directory with the given
19// SKILL.md contents and returns the directory path.
20func installedSkill(t *testing.T, parent, name, body string) string {
21 t.Helper()
22 dir := filepath.Join(parent, name)
23 require.NoError(t, os.MkdirAll(dir, 0o755))
24 require.NoError(t, os.WriteFile(filepath.Join(dir, "SKILL.md"), []byte(body), 0o644))
25 return dir
26}
28func pointDiscoveryAt(t *testing.T, scratch string) {
29 t.Helper()
30 installed.StubCandidateLocations(t, scratch)
31}
33func TestUpdate_missingNameAndAllErrors(t *testing.T) {
34 t.Parallel()
35 exec := cmdtest.SetupCmdForTest(t, NewCmd, false)
36 _, err := exec("")
37 require.Error(t, err)
38}
40func TestUpdate_nameAndAllConflictErrors(t *testing.T) {
41 t.Parallel()
42 exec := cmdtest.SetupCmdForTest(t, NewCmd, false)
43 _, err := exec("glab --all")
44 require.Error(t, err)
45}
47func TestUpdate_unknownNameErrors(t *testing.T) {
48 scratch := t.TempDir()
49 pointDiscoveryAt(t, scratch)
51 exec := cmdtest.SetupCmdForTest(t, NewCmd, false)
52 _, err := exec("not-a-real-skill")
53 require.Error(t, err)
54 assert.Contains(t, err.Error(), "not installed")
55}
57func TestUpdate_overwritesDivergedFiles(t *testing.T) {
58 // Use a known bundled skill name so installed.Discover() classifies
59 // the on-disk copy as a bundled skill and registry.Get can resolve it.
60 bs, err := bundled.All()
61 require.NoError(t, err)
62 require.NotEmpty(t, bs, "this test relies on at least one bundled skill being available")
63 name := bs[0].Name
65 scratch := t.TempDir()
66 skillDir := installedSkill(t, scratch, name, "old content that doesn't match the embedded version")
67 pointDiscoveryAt(t, scratch)
69 exec := cmdtest.SetupCmdForTest(t, NewCmd, false)
70 _, err = exec(name)
71 require.NoError(t, err)
73 got, err := os.ReadFile(filepath.Join(skillDir, "SKILL.md"))
74 require.NoError(t, err)
75 assert.Equal(t, string(bs[0].Files["SKILL.md"]), string(got))
76}
78func TestUpdate_skipsAlreadyUpToDate(t *testing.T) {
79 bs, err := bundled.All()
80 require.NoError(t, err)
81 require.NotEmpty(t, bs)
82 name := bs[0].Name
84 scratch := t.TempDir()
85 skillDir := filepath.Join(scratch, name)
86 require.NoError(t, os.MkdirAll(skillDir, 0o755))
87 for rel, content := range bs[0].Files {
88 p := filepath.Join(skillDir, filepath.FromSlash(rel))
89 require.NoError(t, os.MkdirAll(filepath.Dir(p), 0o755))
90 require.NoError(t, os.WriteFile(p, content, 0o644))
91 }
92 pointDiscoveryAt(t, scratch)
94 exec := cmdtest.SetupCmdForTest(t, NewCmd, false)
95 out, err := exec(name)
96 require.NoError(t, err)
97 assert.Contains(t, out.String(), "already up to date")
98}
100// Regression: writeSkill replaces the directory atomically so files
101// that exist on disk but no longer in the source are dropped. Without
102// the fix the on-disk hash would perpetually differ from the source
103// and the skill would show as outdated even after a successful update.
104func TestUpdate_removesStaleFiles(t *testing.T) {
105 bs, err := bundled.All()
106 require.NoError(t, err)
107 require.NotEmpty(t, bs)
108 name := bs[0].Name
110 scratch := t.TempDir()
111 skillDir := installedSkill(t, scratch, name, "stale SKILL.md")
112 stalePath := filepath.Join(skillDir, "removed-upstream.txt")
113 require.NoError(t, os.WriteFile(stalePath, []byte("ghost"), 0o644))
114 pointDiscoveryAt(t, scratch)
116 exec := cmdtest.SetupCmdForTest(t, NewCmd, false)
117 _, err = exec(name)
118 require.NoError(t, err)
120 _, err = os.Stat(stalePath)
121 assert.True(t, os.IsNotExist(err), "file removed upstream should not persist on disk after update")
122}
124func TestUpdate_allUpdatesEveryInstalledSkill(t *testing.T) {
125 bs, err := bundled.All()
126 require.NoError(t, err)
127 if len(bs) < 2 {
128 t.Skipf("need at least 2 bundled skills to exercise --all, have %d", len(bs))
129 }
131 scratch := t.TempDir()
132 for _, b := range bs {
133 installedSkill(t, scratch, b.Name, "stale")
134 }
135 pointDiscoveryAt(t, scratch)
137 exec := cmdtest.SetupCmdForTest(t, NewCmd, false)
138 out, err := exec("--all")
139 require.NoError(t, err)
140 for _, b := range bs {
141 assert.Contains(t, out.String(), "Updated "+b.Name)
142 }
143}
Diagnostics8 git calls · 219 ms
CallStatusSizeTime0219 ms
discover200185 B1 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=1 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 · hit2 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=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 · 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: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=3 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:02001.8 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=1857 git.response.cache=HIT git.response.duration_ms=1 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=fb03183b7909876778f740d196d7516811003517Open 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=0795a26d2b25022c69da2ef2e68cfb92a77ef4bbOpen pack map
fetchtree:0200139 B · 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=139 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=tree:0 git.fetch.wants=978ceb6b3de5a5372a77abc2675f9842fed5bf02 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=139 git.pkt.payload.max=112 git.sideband.band1.bytes=112 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=112 git.pack.trailer=d33112e7112d8990c2505d67aa9eb537f8f4c75eOpen pack map
fetch2001.4 KiB205 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=205 git.response.bytes=1419 git.response.cache=MISS git.response.duration_ms=205 git.fetch.wants=bcf352dc7309fda4baa2994d52c418e3efc13320 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=1419 git.pkt.payload.max=1392 git.sideband.band1.bytes=1392 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
- a5e2e2b1fce84af4
- Request
- c92514c3…
- 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