GitLabgitlab-org
cli
main
1//go:build !integration
3package whatsnew
5import (
6 "net/http"
7 "testing"
9 "github.com/acarl005/stripansi"
10 "github.com/stretchr/testify/assert"
11 "github.com/stretchr/testify/require"
12 "go.uber.org/mock/gomock"
14 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
15 gitlabtesting "gitlab.com/gitlab-org/api/client-go/v3/testing"
17 "gitlab.com/gitlab-org/cli/internal/api"
18 "gitlab.com/gitlab-org/cli/internal/commands/update"
19 "gitlab.com/gitlab-org/cli/internal/config"
20 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
21)
23func newTestConfig(t *testing.T, kvs map[string]string) config.Config {
24 t.Helper()
25 cfg := config.NewBlankConfig()
26 for k, v := range kvs {
27 require.NoError(t, cfg.Set("", k, v))
28 }
29 return cfg
30}
32// Tests that exercise the API client install per-test mocks via this
33// helper; they can't run with t.Parallel() because the package-level
34// clientCreator var is mutated for the duration of each test (same
35// pattern as internal/commands/update/check_update_test.go).
36func stubClientCreator(t *testing.T, testClient *gitlabtesting.TestClient) {
37 t.Helper()
38 old := clientCreator
39 clientCreator = func(userAgent string, options ...api.ClientOption) (*api.Client, error) {
40 return api.NewClient(
41 func(*http.Client) (gitlab.AuthSource, error) {
42 return gitlab.AccessTokenAuthSource{Token: ""}, nil
43 },
44 api.WithGitLabClient(testClient.Client),
45 )
46 }
47 t.Cleanup(func() { clientCreator = old })
48}
50func release(tag, description string) *gitlab.Release {
51 return &gitlab.Release{TagName: tag, Name: tag, Description: description}
52}
54func TestWhatsnew_specificVersion(t *testing.T) {
55 tc := gitlabtesting.NewTestClient(t)
56 tc.MockReleases.EXPECT().
57 GetRelease("gitlab-org/cli", "v1.85.0", gomock.Any()).
58 Return(release("v1.85.0", "## Highlights\n\n- thing one"), nil, nil)
59 stubClientCreator(t, tc)
61 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
62 cmdtest.WithBuildInfo(api.BuildInfo{Version: "1.85.0"}),
63 )
64 out, err := exec("v1.85.0")
65 require.NoError(t, err)
66 stripped := stripansi.Strip(out.String())
67 assert.Contains(t, stripped, "## v1.85.0")
68 assert.Contains(t, stripped, "thing one")
69}
71func TestWhatsnew_versionArgWithoutVPrefix(t *testing.T) {
72 tc := gitlabtesting.NewTestClient(t)
73 tc.MockReleases.EXPECT().
74 GetRelease("gitlab-org/cli", "v1.85.0", gomock.Any()).
75 Return(release("v1.85.0", "notes"), nil, nil)
76 stubClientCreator(t, tc)
78 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
79 cmdtest.WithBuildInfo(api.BuildInfo{Version: "1.85.0"}),
80 )
81 _, err := exec("1.85.0")
82 require.NoError(t, err)
83}
85func TestWhatsnew_latestFlag(t *testing.T) {
86 tc := gitlabtesting.NewTestClient(t)
87 tc.MockReleases.EXPECT().
88 ListReleases("gitlab-org/cli", gomock.Any(), gomock.Any()).
89 DoAndReturn(func(_ any, opts *gitlab.ListReleasesOptions, _ ...gitlab.RequestOptionFunc) ([]*gitlab.Release, *gitlab.Response, error) {
90 assert.Equal(t, int64(1), opts.PerPage)
91 return []*gitlab.Release{release("v1.85.0", "latest notes")}, nil, nil
92 })
93 stubClientCreator(t, tc)
95 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
96 cmdtest.WithBuildInfo(api.BuildInfo{Version: "1.80.0"}),
97 )
98 out, err := exec("--latest")
99 require.NoError(t, err)
100 stripped := stripansi.Strip(out.String())
101 assert.Contains(t, stripped, "v1.85.0")
102 assert.Contains(t, stripped, "latest notes")
103}
105func TestWhatsnew_sinceFlagFiltersReleases(t *testing.T) {
106 tc := gitlabtesting.NewTestClient(t)
107 tc.MockReleases.EXPECT().
108 ListReleases("gitlab-org/cli", gomock.Any(), gomock.Any()).
109 Return([]*gitlab.Release{
110 release("v1.85.0", "newest"),
111 release("v1.84.0", "middle"),
112 release("v1.83.0", "skipped"),
113 release("v1.82.0", "also skipped"),
114 }, nil, nil)
115 stubClientCreator(t, tc)
117 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
118 cmdtest.WithBuildInfo(api.BuildInfo{Version: "1.85.0"}),
119 )
120 out, err := exec("--since v1.83.0")
121 require.NoError(t, err)
122 stripped := stripansi.Strip(out.String())
123 assert.Contains(t, stripped, "v1.85.0")
124 assert.Contains(t, stripped, "v1.84.0")
125 assert.NotContains(t, stripped, "v1.83.0")
126 assert.NotContains(t, stripped, "v1.82.0")
127}
129func TestWhatsnew_defaultInvocationUsesLastWhatsnewAndAdvancesMarker(t *testing.T) {
130 tc := gitlabtesting.NewTestClient(t)
131 tc.MockReleases.EXPECT().
132 ListReleases("gitlab-org/cli", gomock.Any(), gomock.Any()).
133 Return([]*gitlab.Release{
134 release("v1.85.0", "newest"),
135 release("v1.84.0", "skipped"),
136 }, nil, nil)
137 stubClientCreator(t, tc)
139 cfg := newTestConfig(t, map[string]string{LastWhatsnewVersionKey: "v1.84.0"})
141 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
142 cmdtest.WithBuildInfo(api.BuildInfo{Version: "1.85.0"}),
143 cmdtest.WithConfig(cfg),
144 )
145 out, err := exec("")
146 require.NoError(t, err)
147 stripped := stripansi.Strip(out.String())
148 assert.Contains(t, stripped, "v1.85.0")
149 assert.NotContains(t, stripped, "v1.84.0")
151 got, _ := cfg.Get("", LastWhatsnewVersionKey)
152 assert.Equal(t, "1.85.0", got)
153}
155func TestWhatsnew_explicitInvocationDoesNotAdvanceMarker(t *testing.T) {
156 tc := gitlabtesting.NewTestClient(t)
157 tc.MockReleases.EXPECT().
158 ListReleases("gitlab-org/cli", gomock.Any(), gomock.Any()).
159 Return([]*gitlab.Release{release("v1.85.0", "latest")}, nil, nil)
160 stubClientCreator(t, tc)
162 cfg := newTestConfig(t, map[string]string{LastWhatsnewVersionKey: "v1.80.0"})
164 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
165 cmdtest.WithBuildInfo(api.BuildInfo{Version: "1.85.0"}),
166 cmdtest.WithConfig(cfg),
167 )
168 _, err := exec("--latest")
169 require.NoError(t, err)
171 got, _ := cfg.Get("", LastWhatsnewVersionKey)
172 assert.Equal(t, "v1.80.0", got)
173}
175func TestWhatsnew_noNewReleases(t *testing.T) {
176 tc := gitlabtesting.NewTestClient(t)
177 tc.MockReleases.EXPECT().
178 ListReleases("gitlab-org/cli", gomock.Any(), gomock.Any()).
179 Return([]*gitlab.Release{release("v1.85.0", "")}, nil, nil)
180 stubClientCreator(t, tc)
182 cfg := newTestConfig(t, map[string]string{LastWhatsnewVersionKey: "v1.85.0"})
184 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
185 cmdtest.WithBuildInfo(api.BuildInfo{Version: "1.85.0"}),
186 cmdtest.WithConfig(cfg),
187 )
188 out, err := exec("")
189 require.NoError(t, err)
190 assert.Contains(t, out.Stderr(), "No new releases")
191}
193func TestWhatsnew_emptyReleaseDescription(t *testing.T) {
194 tc := gitlabtesting.NewTestClient(t)
195 tc.MockReleases.EXPECT().
196 GetRelease("gitlab-org/cli", "v1.85.0", gomock.Any()).
197 Return(release("v1.85.0", ""), nil, nil)
198 stubClientCreator(t, tc)
200 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
201 cmdtest.WithBuildInfo(api.BuildInfo{Version: "1.85.0"}),
202 )
203 out, err := exec("v1.85.0")
204 require.NoError(t, err)
205 assert.Contains(t, out.String(), "(no release notes)")
206}
208func TestWhatsnew_flagConflicts(t *testing.T) {
209 t.Parallel()
211 tests := []struct {
212 name string
213 args string
214 }{
215 {name: "positional with --latest", args: "v1.85.0 --latest"},
216 {name: "positional with --since", args: "v1.85.0 --since v1.80.0"},
217 {name: "--since with --latest", args: "--since v1.80.0 --latest"},
218 }
219 for _, tt := range tests {
220 t.Run(tt.name, func(t *testing.T) {
221 t.Parallel()
222 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
223 cmdtest.WithBuildInfo(api.BuildInfo{Version: "1.85.0"}),
224 )
225 _, err := exec(tt.args)
226 require.Error(t, err)
227 })
228 }
229}
231// Regression: the post-upgrade banner and the default `whatsnew` view used
232// to share last_seen_version. The banner advanced the marker to the current
233// version, then `whatsnew` filtered releases strictly greater than that
234// marker — so following the banner's nudge produced "No new releases."
235// The fix is the separate LastWhatsnewVersionKey marker.
236func TestWhatsnew_bannerNudgeThenWhatsnew(t *testing.T) {
237 const currentVersion = "1.101.0"
239 t.Setenv("CI", "")
240 t.Setenv("GITLAB_CI", "")
241 cfg := newTestConfig(t, nil)
243 bannerIO, _, _, bannerErr := cmdtest.TestIOStreams(cmdtest.WithTestIOStreamsAsTTY(true))
244 bannerBuild := api.BuildInfo{Version: currentVersion}
245 update.MaybeShowPostUpgradeBanner(bannerIO, cfg, bannerBuild)
246 require.Contains(t, bannerErr.String(), "glab whatsnew",
247 "precondition: the banner must nudge the user to run whatsnew")
249 tc := gitlabtesting.NewTestClient(t)
250 tc.MockReleases.EXPECT().
251 ListReleases("gitlab-org/cli", gomock.Any(), gomock.Any()).
252 Return([]*gitlab.Release{release("v1.101.0", "## Highlights\n\n- the feature")}, nil, nil)
253 stubClientCreator(t, tc)
255 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
256 cmdtest.WithBuildInfo(api.BuildInfo{Version: currentVersion}),
257 cmdtest.WithConfig(cfg),
258 )
259 out, err := exec("")
260 require.NoError(t, err)
262 stripped := stripansi.Strip(out.String())
263 assert.Contains(t, stripped, "v1.101.0",
264 "following the banner's nudge should show the release it advertised")
265 assert.NotContains(t, out.Stderr(), "No new releases",
266 "the banner nudged the user here; reporting nothing new defeats the feature")
267}
Diagnostics7 git calls · 58 ms
CallStatusSizeTime058 ms
discover200185 B2 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 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 KiB2 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=UPDATING 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 · hit4 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=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=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=3 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:0200140 B · hit3 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=140 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=6223101ab66ee56ea7d3bc317e170fac70525d6e 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=140 git.pkt.payload.max=113 git.sideband.band1.bytes=113 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=113 git.pack.trailer=f7b59eebea99044ec3c93984706fcd64a57f940aOpen pack map
fetch2002.1 KiB · hit49 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=2139 git.response.cache=HIT git.response.duration_ms=49 git.fetch.wants=c1db0c52bb5f25877c9bb4b71a145de293fd305f 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=2139 git.pkt.payload.max=2112 git.sideband.band1.bytes=2112 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
- a5e32429ee4a98f1
- Request
- 7a6ed624…
- 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