GitLabgitlab-org
cli
main
1//go:build !integration
3package update
5import (
6 "fmt"
7 "testing"
8 "time"
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/testing/cmdtest"
18)
20const (
21 repoName = "OWNER/REPO"
22 fileContentsChecksum = "185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969"
23)
25func Test_SecurefileUpdate(t *testing.T) {
26 type testCase struct {
27 name string
28 cli string
29 expectedMsg []string
30 wantErr bool
31 wantStderr string
32 setupMock func(tc *gitlabtesting.TestClient)
33 }
35 createdAt, _ := time.Parse(time.RFC3339, "2022-02-22T22:22:22Z")
37 testCases := []testCase{
38 {
39 name: "Update securefile",
40 cli: "existing.txt testdata/localfile.txt -y",
41 expectedMsg: []string{
42 "• Updating secure file repo=OWNER/REPO fileName=existing.txt",
43 "✓ Secure file existing.txt updated.",
44 "The secure file ID changed to 2. Any scripts using `securefile download --id` must be updated, or switch to `securefile download --name existing.txt`.",
45 },
46 setupMock: func(tc *gitlabtesting.TestClient) {
47 tc.MockSecureFiles.EXPECT().
48 ListProjectSecureFiles(repoName, &gitlab.ListProjectSecureFilesOptions{
49 ListOptions: gitlab.ListOptions{
50 Page: 1,
51 PerPage: 100,
52 },
53 }, nil).
54 Return([]*gitlab.SecureFile{
55 {ID: 1, Name: "existing.txt", Checksum: fileContentsChecksum},
56 }, nil, nil)
57 tc.MockSecureFiles.EXPECT().
58 RemoveSecureFile(repoName, int64(1)).
59 Return(nil, nil)
60 tc.MockSecureFiles.EXPECT().
61 CreateSecureFile(repoName, gomock.Any(), gomock.Any()).
62 Return(&gitlab.SecureFile{
63 ID: 2,
64 Name: "existing.txt",
65 Checksum: fileContentsChecksum,
66 ChecksumAlgorithm: "sha256",
67 CreatedAt: &createdAt,
68 ExpiresAt: nil,
69 Metadata: nil,
70 }, nil, nil)
71 },
72 },
73 {
74 name: "Skip update when checksum matches",
75 cli: "existing.txt testdata/localfile.txt -y",
76 expectedMsg: []string{"✓ Secure file existing.txt is already up to date."},
77 setupMock: func(tc *gitlabtesting.TestClient) {
78 tc.MockSecureFiles.EXPECT().
79 ListProjectSecureFiles(repoName, &gitlab.ListProjectSecureFilesOptions{
80 ListOptions: gitlab.ListOptions{
81 Page: 1,
82 PerPage: 100,
83 },
84 }, nil).
85 Return([]*gitlab.SecureFile{
86 {ID: 1, Name: "existing.txt", Checksum: fileContentsChecksum, ChecksumAlgorithm: "sha256"},
87 }, nil, nil)
88 },
89 },
90 {
91 name: "Update a securefile with invalid file path",
92 cli: "newfile.txt testdata/missingfile.txt -y",
93 setupMock: func(tc *gitlabtesting.TestClient) {},
94 wantErr: true,
95 wantStderr: "unable to read file at testdata/missingfile.txt: open testdata/missingfile.txt: no such file or directory",
96 },
97 {
98 name: "Attempt to update non-existent file",
99 cli: "newfile.txt testdata/localfile.txt -y",
100 wantErr: true,
101 wantStderr: "couldn't locate secure file with name newfile.txt",
102 setupMock: func(tc *gitlabtesting.TestClient) {
103 tc.MockSecureFiles.EXPECT().
104 ListProjectSecureFiles(repoName, &gitlab.ListProjectSecureFilesOptions{
105 ListOptions: gitlab.ListOptions{
106 Page: 1,
107 PerPage: 100,
108 },
109 }, nil).
110 Return([]*gitlab.SecureFile{
111 {ID: 1, Name: "otherfile.txt", Checksum: fileContentsChecksum},
112 }, &gitlab.Response{}, nil)
113 },
114 },
115 {
116 name: "Error when removing existing securefile",
117 cli: "existing.txt testdata/localfile.txt -y",
118 wantErr: true,
119 wantStderr: "error removing secure file: DELETE https://gitlab.com/api/v4/projects/OWNER%2FREPO/secure_files/1: 400",
120 setupMock: func(tc *gitlabtesting.TestClient) {
121 tc.MockSecureFiles.EXPECT().
122 ListProjectSecureFiles(repoName, &gitlab.ListProjectSecureFilesOptions{
123 ListOptions: gitlab.ListOptions{
124 Page: 1,
125 PerPage: 100,
126 },
127 }, nil).
128 Return([]*gitlab.SecureFile{
129 {ID: 1, Name: "existing.txt", Checksum: fileContentsChecksum},
130 }, nil, nil)
131 tc.MockSecureFiles.EXPECT().
132 RemoveSecureFile(repoName, int64(1)).
133 Return(nil, fmt.Errorf("DELETE https://gitlab.com/api/v4/projects/OWNER%%2FREPO/secure_files/1: 400"))
134 },
135 },
136 {
137 name: "Error when creating securefile",
138 cli: "existing.txt testdata/localfile.txt -y",
139 wantErr: true,
140 wantStderr: `the existing secure file "existing.txt" was removed but the new version could not be uploaded, so it must be re-created manually: POST https://gitlab.com/api/v4/projects/OWNER%2FREPO/secure_files: 400`,
141 setupMock: func(tc *gitlabtesting.TestClient) {
142 tc.MockSecureFiles.EXPECT().
143 ListProjectSecureFiles(repoName, &gitlab.ListProjectSecureFilesOptions{
144 ListOptions: gitlab.ListOptions{
145 Page: 1,
146 PerPage: 100,
147 },
148 }, nil).
149 Return([]*gitlab.SecureFile{
150 {ID: 1, Name: "existing.txt", Checksum: fileContentsChecksum},
151 }, nil, nil)
152 tc.MockSecureFiles.EXPECT().
153 RemoveSecureFile(repoName, int64(1)).
154 Return(nil, nil)
155 tc.MockSecureFiles.EXPECT().
156 CreateSecureFile(repoName, gomock.Any(), gomock.Any()).
157 Return(nil, nil, fmt.Errorf("POST https://gitlab.com/api/v4/projects/OWNER%%2FREPO/secure_files: 400"))
158 },
159 },
160 {
161 name: "Update a secure file without force update when not running interactively",
162 cli: "file.txt testdata/localfile.txt",
163 setupMock: func(tc *gitlabtesting.TestClient) {},
164 wantErr: true,
165 wantStderr: "--yes or -y flag is required when not running interactively",
166 },
167 }
169 for _, tc := range testCases {
170 t.Run(tc.name, func(t *testing.T) {
171 // GIVEN
172 testClient := gitlabtesting.NewTestClient(t)
173 tc.setupMock(testClient)
174 exec := cmdtest.SetupCmdForTest(
175 t,
176 NewCmdUpdate,
177 false,
178 cmdtest.WithGitLabClient(testClient.Client),
179 )
181 // WHEN
182 out, err := exec(tc.cli)
184 // THEN
185 if tc.wantErr {
186 require.Error(t, err)
187 assert.Equal(t, tc.wantStderr, err.Error())
188 return
189 }
190 require.NoError(t, err)
191 for _, msg := range tc.expectedMsg {
192 assert.Contains(t, out.String(), msg)
193 }
194 })
195 }
196}
Diagnostics8 git calls · 252 ms
CallStatusSizeTime0252 ms
discover200185 B3 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs 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
fetchtree:0 · deepen 1020032 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=32926 git.response.cache=HIT git.response.duration_ms=2 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
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.8 KiB · 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=1857 git.response.cache=HIT git.response.duration_ms=4 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:0200353 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=353 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=d9f8b91b7f75f6920fea2e149ed3fba5f61766da 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=353 git.pkt.payload.max=326 git.sideband.band1.bytes=326 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=326 git.pack.trailer=353875a8d3dc1310585685b9eadd95754bcf8d98Open pack map
fetchtree:0200168 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=168 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=949005f4c1ca04bd3bf906de0361634d5c007b13 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=168 git.pkt.payload.max=141 git.sideband.band1.bytes=141 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=141 git.pack.trailer=04b3a92a8b1b8e1a408688519159674239efbfa2Open pack map
fetch2001.7 KiB236 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=236 git.response.bytes=1705 git.response.cache=MISS git.response.duration_ms=236 git.fetch.wants=7c40e6096c3785f7676cd228b47eb9d8c37da2cd 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=1705 git.pkt.payload.max=1678 git.sideband.band1.bytes=1678 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
- a5e2588728201ae0
- Request
- 33f70742…
- 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