/
commit.spec.js
394 lines (344 loc) 路 12.8 KB
/
commit.spec.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
import inquirer from 'inquirer'
import { execa } from 'execa'
import fs from 'fs'
import chalk from 'chalk'
import { mockProcessExit } from 'jest-mock-process'
import configurationVault from '@utils/configurationVault'
import getDefaultCommitContent from '@utils/getDefaultCommitContent'
import getEmojis from '@utils/getEmojis'
import isHookCreated from '@utils/isHookCreated'
import commit from '@commands/commit'
import guard from '@commands/commit/guard'
import prompts from '@commands/commit/prompts'
import * as stubs from './stubs'
import { COMMIT_MESSAGE_SOURCE } from '@commands/commit/withHook/index'
jest.mock('@utils/getDefaultCommitContent')
jest.mock('@utils/getEmojis')
jest.mock('@utils/isHookCreated')
jest.mock('@utils/configurationVault')
describe('commit command', () => {
describe('withClient', () => {
describe('with no autoAdd and no signed commits and no scope', () => {
beforeAll(() => {
execa.mockReturnValue({ stdout: stubs.commitResult })
inquirer.prompt.mockReturnValue(
Promise.resolve(stubs.clientCommitAnswers)
)
getEmojis.mockResolvedValue(stubs.gitmojis)
isHookCreated.mockResolvedValue(false)
getDefaultCommitContent.mockReturnValueOnce(
stubs.emptyDefaultCommitContent
)
commit({ mode: 'client' })
})
it('should call inquirer with prompts', () => {
expect(inquirer.prompt.mock.calls).toMatchSnapshot()
})
it('should call execa with the commit command based on answers', () => {
expect(execa).toHaveBeenCalledWith(
'git',
[
'commit',
'-m',
`${stubs.clientCommitAnswers.gitmoji} ${stubs.clientCommitAnswers.title}`,
'-m',
stubs.clientCommitAnswers.message
],
{
buffer: false,
stdio: 'inherit'
}
)
})
})
describe('with autoAdd, signed commits and scope', () => {
beforeAll(() => {
execa.mockReturnValue({ stdout: stubs.commitResult })
inquirer.prompt.mockReturnValue(
Promise.resolve(stubs.clientCommitAnswersWithScope)
)
getEmojis.mockResolvedValue(stubs.gitmojis)
isHookCreated.mockResolvedValue(false)
configurationVault.getAutoAdd.mockReturnValue(true)
getDefaultCommitContent.mockReturnValueOnce(
stubs.emptyDefaultCommitContent
)
commit({ mode: 'client' })
})
it('should call inquirer with prompts', () => {
expect(inquirer.prompt.mock.calls).toMatchSnapshot()
})
it('should call execa with the add command', () => {
expect(execa).toHaveBeenCalledWith('git', ['add', '.'])
})
it('should call execa with the commit command based on answers', () => {
expect(execa).toHaveBeenLastCalledWith(
'git',
[
'commit',
'-m',
`${stubs.clientCommitAnswersWithScope.gitmoji} (${stubs.clientCommitAnswersWithScope.scope}): ${stubs.clientCommitAnswersWithScope.title}`,
'-m',
stubs.clientCommitAnswersWithScope.message
],
{
buffer: false,
stdio: 'inherit'
}
)
})
})
describe('with the commit hook created', () => {
beforeAll(() => {
inquirer.prompt.mockReturnValue(
Promise.resolve(stubs.clientCommitAnswers)
)
getEmojis.mockResolvedValue(stubs.gitmojis)
isHookCreated.mockResolvedValue(true)
getDefaultCommitContent.mockReturnValueOnce(
stubs.emptyDefaultCommitContent
)
commit({ mode: 'client' })
})
it('should call inquirer with prompts', () => {
expect(inquirer.prompt.mock.calls).toMatchSnapshot()
})
it('should stop the commit because the hook is created and log the explanation to the user', () => {
expect(execa).not.toHaveBeenCalledWith()
})
})
describe('when an error happens', () => {
const consoleError = jest.spyOn(console, 'error')
beforeAll(() => {
consoleError.mockImplementation((msg) => msg)
inquirer.prompt.mockReturnValue(
Promise.resolve(stubs.clientCommitAnswersWithScope)
)
getEmojis.mockResolvedValue(stubs.gitmojis)
isHookCreated.mockResolvedValue(false)
configurationVault.getAutoAdd.mockReturnValue(true)
getDefaultCommitContent.mockReturnValueOnce(
stubs.emptyDefaultCommitContent
)
execa.mockImplementation(() => {
throw new Error({ stdout: 'Hey' })
})
commit({ mode: 'client' })
})
it('should print the error to the console', () => {
expect(consoleError).toHaveBeenCalledWith(
chalk.red(
'\n',
'Oops! An error occurred. There is likely additional logging output above.\n',
'You can run the same commit with this command:\n'
),
'\t',
undefined
)
})
})
})
describe('withHook', () => {
describe('without scope', () => {
beforeAll(() => {
console.log = jest.fn()
inquirer.prompt.mockReturnValue(
Promise.resolve(stubs.clientCommitAnswers)
)
getEmojis.mockResolvedValue(stubs.gitmojis)
mockProcessExit()
process.argv[3] = stubs.argv
process.argv[COMMIT_MESSAGE_SOURCE] = undefined
getDefaultCommitContent.mockReturnValueOnce(
stubs.emptyDefaultCommitContent
)
execa.mockReturnValueOnce(Promise.resolve(stubs.gitAbsoluteDir))
fs.existsSync.mockReturnValueOnce(false).mockReturnValueOnce(false)
commit({ mode: 'hook' })
})
it('should commit using the hook', () => {
expect(fs.writeFileSync).toHaveBeenCalledWith(
stubs.argv,
`${stubs.clientCommitAnswers.gitmoji} ${stubs.clientCommitAnswers.title}\n\n${stubs.clientCommitAnswers.message}`
)
})
it('should call process.exit', () => {
expect(process.exit).toHaveBeenCalledWith(0)
})
})
describe('with scope', () => {
beforeAll(() => {
console.log = jest.fn()
inquirer.prompt.mockReturnValue(
Promise.resolve(stubs.clientCommitAnswersWithScope)
)
getEmojis.mockResolvedValue(stubs.gitmojis)
mockProcessExit()
process.argv[3] = stubs.argv
process.argv[COMMIT_MESSAGE_SOURCE] = stubs.commitSource
getDefaultCommitContent.mockReturnValueOnce(
stubs.emptyDefaultCommitContent
)
execa.mockReturnValueOnce(Promise.resolve(stubs.gitAbsoluteDir))
fs.existsSync.mockReturnValueOnce(false).mockReturnValueOnce(false)
commit({ mode: 'hook' })
})
it('should commit using the hook', () => {
expect(fs.writeFileSync).toHaveBeenCalledWith(
stubs.argv,
`${stubs.clientCommitAnswersWithScope.gitmoji} (${stubs.clientCommitAnswersWithScope.scope}): ${stubs.clientCommitAnswersWithScope.title}\n\n${stubs.clientCommitAnswersWithScope.message}`
)
})
it('should call process.exit', () => {
expect(process.exit).toHaveBeenCalledWith(0)
})
})
describe('when rebasing', () => {
it('should cancel the hook', async () => {
/*
Use an exception to suspend code execution to simulate the process.exit triggered
when the hook mode detect that the user is rebasing. (Simulated to not kill the tests)
Simulation needed because if we just mock process exit, then the code execution resume in the test.
*/
process.argv[COMMIT_MESSAGE_SOURCE] = stubs.commitSource
mockProcessExit(new Error('ProcessExit0'))
execa.mockReturnValueOnce(Promise.resolve(stubs.gitAbsoluteDir))
// mock that we found one of the rebase trigger (file existence in .git)
fs.existsSync.mockReturnValueOnce(true)
try {
await commit({ mode: 'hook' })
} catch (e) {
expect(e.message).toMatch('ProcessExit0')
}
expect(process.exit).toHaveBeenCalledWith(0)
})
})
describe('when amending', () => {
it('should cancel the hook', async () => {
/*
Use an exception to suspend code execution to simulate the process.exit triggered
when the hook mode detect that the user is rebasing. (Simulated to not kill the tests)
Simulation needed because if we just mock process exit, then the code execution resume in the test.
*/
mockProcessExit(new Error('ProcessExit0'))
execa.mockReturnValueOnce(Promise.resolve(stubs.gitAbsoluteDir))
// mock that we are amending
process.argv[COMMIT_MESSAGE_SOURCE] = 'commit sha123'
try {
await commit({ mode: 'hook' })
} catch (e) {
expect(e.message).toMatch('ProcessExit0')
}
expect(process.exit).toHaveBeenCalledWith(0)
})
})
describe('when receiving a signal interrupt', () => {
it('should call process.exit(0)', async () => {
console.warn = jest.fn()
// mock process.on and process.kill to test registerHookInterruptionHandler
const processEvents = {}
jest.spyOn(process, 'on').mockImplementation((signal, cb) => {
processEvents[signal] = cb
})
jest.spyOn(process, 'kill').mockImplementation((pid, signal) => {
processEvents[signal]()
})
execa.mockReturnValueOnce(Promise.resolve(stubs.gitAbsoluteDir))
fs.existsSync.mockReturnValueOnce(false).mockReturnValueOnce(false)
inquirer.prompt.mockImplementation(() => {
process.kill(process.pid, 'SIGINT')
})
getEmojis.mockResolvedValue(stubs.gitmojis)
// Use an exception to suspend code execution to simulate process.exit
mockProcessExit(new Error('SIGINT'))
process.argv[3] = stubs.argv
process.argv[COMMIT_MESSAGE_SOURCE] = stubs.commitSource
getDefaultCommitContent.mockReturnValueOnce(
stubs.emptyDefaultCommitContent
)
try {
await commit({ mode: 'hook' })
} catch (e) {
expect(e.message).toMatch('SIGINT')
}
expect(console.warn).toHaveBeenCalledWith('gitmoji-cli was interrupted')
expect(process.exit).toHaveBeenCalledWith(0)
})
})
describe('with git auto merge trigger by git pull', () => {
it('should cancel the hook', async () => {
mockProcessExit(new Error('ProcessExit0'))
execa.mockReturnValueOnce(Promise.resolve(stubs.gitAbsoluteDir))
// mock that we are merging
process.argv[3] = '.git/MERGE_MSG'
process.argv[COMMIT_MESSAGE_SOURCE] = 'merge'
try {
await commit({ mode: 'hook' })
} catch (e) {
expect(e.message).toMatch('ProcessExit0')
}
expect(process.exit).toHaveBeenCalledWith(0)
})
})
})
describe('guard', () => {
it('should match guard', () => {
expect(guard).toMatchSnapshot()
})
describe('title', () => {
it('should return true when valid', () => {
expect(guard.title(stubs.commitTitle)).toBe(true)
})
it('should return error message when empty', () => {
expect(guard.title('')).toEqual(expect.any(String))
})
})
})
describe('prompts', () => {
it('should register the autoComplete inquirer prompt', () => {
expect(inquirer.registerPrompt).toHaveBeenCalledWith(
'autocomplete',
expect.any(Function)
)
})
describe('without scope prompt', () => {
beforeAll(() => {
getDefaultCommitContent.mockReturnValueOnce(
stubs.emptyDefaultCommitContent
)
})
it('should match the array of questions', () => {
expect(prompts(stubs.gitmojis, 'client')).toMatchSnapshot()
})
})
describe('with scope prompt', () => {
beforeAll(() => {
getDefaultCommitContent.mockReturnValueOnce(
stubs.emptyDefaultCommitContent
)
configurationVault.getScopePrompt.mockReturnValue(true)
})
it('should match the array of questions', () => {
expect(prompts(stubs.gitmojis, 'client')).toMatchSnapshot()
})
})
describe('with default commit content in hook mode', () => {
beforeAll(() => {
getDefaultCommitContent.mockReturnValueOnce(stubs.defaultCommitContent)
})
it('should match the default title and message', () => {
expect(prompts(stubs.gitmojis, 'hook')).toMatchSnapshot()
})
})
describe('with default commit content in commit mode', () => {
beforeAll(() => {
getDefaultCommitContent.mockReturnValueOnce(
stubs.emptyDefaultCommitContent
)
})
it('should not fill default title and message', () => {
expect(prompts(stubs.gitmojis, 'commit')).toMatchSnapshot()
})
})
})
})