GitLabgitlab-org
cli
main
1//go:build !integration
3package create
5import (
6 "encoding/json"
7 "errors"
8 "testing"
10 "github.com/MakeNowJust/heredoc/v2"
11 "github.com/stretchr/testify/assert"
12 "github.com/stretchr/testify/require"
13 "go.uber.org/mock/gomock"
15 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
16 gitlabtesting "gitlab.com/gitlab-org/api/client-go/v3/testing"
18 "gitlab.com/gitlab-org/cli/internal/api"
19 "gitlab.com/gitlab-org/cli/internal/cmdutils"
20 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
21)
23func setupExec(t *testing.T, tc *gitlabtesting.TestClient, opts ...cmdtest.FactoryOption) cmdtest.CmdExecFunc {
24 t.Helper()
26 opts = append(
27 []cmdtest.FactoryOption{
28 cmdtest.WithApiClient(cmdtest.NewTestApiClient(t, nil, "", "", api.WithGitLabClient(tc.Client))),
29 },
30 opts...,
31 )
33 return cmdtest.SetupCmdForTest(t, NewCmd, false, opts...)
34}
36// expectProjectCreate returns an accessor for the options the command sent, so
37// the tests can assert on the request and not only on what is printed.
38func expectProjectCreate(tc *gitlabtesting.TestClient, account *gitlab.ProjectServiceAccount) func() *gitlab.CreateProjectServiceAccountOptions {
39 var sent *gitlab.CreateProjectServiceAccountOptions
40 tc.MockProjects.EXPECT().
41 CreateProjectServiceAccount("OWNER/REPO", gomock.Any(), gomock.Any()).
42 DoAndReturn(func(_ any, opt *gitlab.CreateProjectServiceAccountOptions, _ ...gitlab.RequestOptionFunc) (*gitlab.ProjectServiceAccount, *gitlab.Response, error) {
43 sent = opt
44 return account, nil, nil
45 })
47 return func() *gitlab.CreateProjectServiceAccountOptions { return sent }
48}
50func TestCreate_ProjectWithDefaults(t *testing.T) {
51 t.Parallel()
53 tc := gitlabtesting.NewTestClient(t)
54 sent := expectProjectCreate(tc, &gitlab.ProjectServiceAccount{
55 ID: 61,
56 Username: "service_account_project_2_ccc",
57 Name: "Service account user",
58 Email: "service_account_project_2_ccc@noreply.gitlab.example.com",
59 })
61 out, err := setupExec(t, tc)("")
62 require.NoError(t, err)
64 assert.Nil(t, sent().Name)
65 assert.Nil(t, sent().Username)
66 assert.Nil(t, sent().Email)
68 expected := heredoc.Doc(`
69 ID 61
70 Username service_account_project_2_ccc
71 Name Service account user
72 Email service_account_project_2_ccc@noreply.gitlab.example.com
73 `)
74 assert.Equal(t, expected, out.OutBuf.String())
75 assert.Equal(t, "✓ Created service account 61 in project OWNER/REPO.\n", out.ErrBuf.String())
76}
78func TestCreate_SendsOnlyGivenFlags(t *testing.T) {
79 t.Parallel()
81 tc := gitlabtesting.NewTestClient(t)
82 sent := expectProjectCreate(tc, &gitlab.ProjectServiceAccount{ID: 61, Username: "service_account_project_2_ccc", Name: "Release bot"})
84 _, err := setupExec(t, tc)(`--name "Release bot"`)
85 require.NoError(t, err)
87 require.NotNil(t, sent().Name)
88 assert.Equal(t, "Release bot", *sent().Name)
89 assert.Nil(t, sent().Username)
90 assert.Nil(t, sent().Email)
91}
93func TestCreate_AllFlags(t *testing.T) {
94 t.Parallel()
96 tc := gitlabtesting.NewTestClient(t)
97 sent := expectProjectCreate(tc, &gitlab.ProjectServiceAccount{
98 ID: 61,
99 Username: "release-bot",
100 Name: "Release bot",
101 Email: "service_account_project_2_ccc@noreply.gitlab.example.com",
102 UnconfirmedEmail: "release-bot@example.com",
103 })
105 out, err := setupExec(t, tc)(`--name "Release bot" --username release-bot --email release-bot@example.com`)
106 require.NoError(t, err)
108 assert.Equal(t, "Release bot", *sent().Name)
109 assert.Equal(t, "release-bot", *sent().Username)
110 assert.Equal(t, "release-bot@example.com", *sent().Email)
112 expected := heredoc.Doc(`
113 ID 61
114 Username release-bot
115 Name Release bot
116 Email service_account_project_2_ccc@noreply.gitlab.example.com
117 Unconfirmed Email release-bot@example.com
118 `)
119 assert.Equal(t, expected, out.OutBuf.String())
120}
122func TestCreate_Group(t *testing.T) {
123 t.Parallel()
125 var sent *gitlab.CreateServiceAccountOptions
126 tc := gitlabtesting.NewTestClient(t)
127 tc.MockGroups.EXPECT().
128 CreateServiceAccount("group/sub-group", gomock.Any(), gomock.Any()).
129 DoAndReturn(func(_ any, opt *gitlab.CreateServiceAccountOptions, _ ...gitlab.RequestOptionFunc) (*gitlab.GroupServiceAccount, *gitlab.Response, error) {
130 sent = opt
131 return &gitlab.GroupServiceAccount{ID: 71, UserName: "release-bot", Name: "Release bot"}, nil, nil
132 })
134 out, err := setupExec(t, tc)(`--name "Release bot" --username release-bot --group group/sub-group`)
135 require.NoError(t, err)
137 assert.Equal(t, "Release bot", *sent.Name)
138 assert.Equal(t, "release-bot", *sent.Username)
139 assert.Nil(t, sent.Email)
141 expected := heredoc.Doc(`
142 ID 71
143 Username release-bot
144 Name Release bot
145 Email -
146 `)
147 assert.Equal(t, expected, out.OutBuf.String())
148 assert.Equal(t, "✓ Created service account 71 in group group/sub-group.\n", out.ErrBuf.String())
149}
151func TestCreate_JSON(t *testing.T) {
152 t.Parallel()
154 tc := gitlabtesting.NewTestClient(t)
155 expectProjectCreate(tc, &gitlab.ProjectServiceAccount{
156 ID: 61,
157 Username: "release-bot",
158 Name: "Release bot",
159 UnconfirmedEmail: "release-bot@example.com",
160 })
162 out, err := setupExec(t, tc)(`--name "Release bot" --output json`)
163 require.NoError(t, err)
165 var result gitlab.ProjectServiceAccount
166 require.NoError(t, json.Unmarshal(out.OutBuf.Bytes(), &result))
167 assert.Equal(t, int64(61), result.ID)
168 assert.Equal(t, "release-bot", result.Username)
169 assert.Equal(t, "release-bot@example.com", result.UnconfirmedEmail)
170 assert.Empty(t, out.ErrBuf.String())
171}
173func TestCreate_APIError(t *testing.T) {
174 t.Parallel()
176 tc := gitlabtesting.NewTestClient(t)
177 tc.MockProjects.EXPECT().
178 CreateProjectServiceAccount("OWNER/REPO", gomock.Any(), gomock.Any()).
179 Return(nil, nil, errors.New("400 Bad Request"))
181 _, err := setupExec(t, tc)("--email taken@example.com")
182 require.Error(t, err)
184 var exitErr *cmdutils.ExitError
185 require.ErrorAs(t, err, &exitErr)
186 assert.Equal(t, "failed to create service account", exitErr.Details)
187 assert.Contains(t, err.Error(), "400 Bad Request")
188}
190func TestCreate_RejectsArguments(t *testing.T) {
191 t.Parallel()
193 tc := gitlabtesting.NewTestClient(t)
195 _, err := setupExec(t, tc)("release-bot")
196 require.Error(t, err)
197 assert.Contains(t, err.Error(), `unknown command "release-bot"`)
198}
200func TestCreate_RepoAndGroupAreMutuallyExclusive(t *testing.T) {
201 t.Parallel()
203 tc := gitlabtesting.NewTestClient(t)
205 _, err := setupExec(t, tc)("--repo OWNER/REPO --group my-group")
206 require.Error(t, err)
207 assert.Contains(t, err.Error(), "none of the others can be")
208}
210func TestCreate_OutsideRepositoryWithoutGroup(t *testing.T) {
211 t.Parallel()
213 tc := gitlabtesting.NewTestClient(t)
215 _, err := setupExec(t, tc, cmdtest.WithBaseRepoError(errors.New("not a git repository")))("")
216 require.Error(t, err)
217 assert.Contains(t, err.Error(), "not a git repository")
218}
220func TestCreate_OutsideRepositoryWithGroup(t *testing.T) {
221 t.Parallel()
223 tc := gitlabtesting.NewTestClient(t)
224 tc.MockGroups.EXPECT().
225 CreateServiceAccount("my-group", gomock.Any(), gomock.Any()).
226 Return(&gitlab.GroupServiceAccount{ID: 71, UserName: "service_account_group_1_ccc"}, nil, nil)
228 out, err := setupExec(t, tc, cmdtest.WithBaseRepoError(errors.New("not a git repository")))("--group my-group")
229 require.NoError(t, err)
231 assert.Contains(t, out.OutBuf.String(), "service_account_group_1_ccc")
232}
234// GITLAB_GROUP redirects the command with no flag passed. t.Setenv rules out
235// t.Parallel.
236func TestCreate_GroupFromEnvironment(t *testing.T) {
237 t.Setenv("GITLAB_GROUP", "env-group")
239 tc := gitlabtesting.NewTestClient(t)
240 tc.MockGroups.EXPECT().
241 CreateServiceAccount("env-group", gomock.Any(), gomock.Any()).
242 Return(&gitlab.GroupServiceAccount{ID: 71, UserName: "service_account_group_1_ccc"}, nil, nil)
244 out, err := setupExec(t, tc)("")
245 require.NoError(t, err)
247 assert.Equal(t, "✓ Created service account 71 in group env-group.\n", out.ErrBuf.String())
248}
Diagnostics8 git calls · 357 ms
CallStatusSizeTime0357 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 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
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:0200322 B · 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=322 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=ba2caccf6c55211c6b29b98f40c2358479d91b1f 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=322 git.pkt.payload.max=295 git.sideband.band1.bytes=295 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=295 git.pack.trailer=3488e558d4708096e879feba968e084c249dbe22Open pack map
fetchtree:0200139 B · 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=139 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=c6c2b5498b6622028a7dc0718dab12d4378b30c6 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=59d1f9699d7da3b3468a2f353552de793e65509bOpen pack map
fetch2001.8 KiB344 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=344 git.response.bytes=1834 git.response.cache=MISS git.response.duration_ms=344 git.fetch.wants=869ebae4d54b419fba8ecfe51dc750422fee51f4 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=1834 git.pkt.payload.max=1807 git.sideband.band1.bytes=1807 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
- a5e2e4effe152947
- Request
- 1dbc123c…
- 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