/
cli.spec.ts
485 lines (457 loc) · 12.4 KB
/
cli.spec.ts
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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
import { testing } from 'bs-logger'
import * as _fs from 'fs'
import { normalize, resolve } from 'path'
import { mockObject, mockWriteStream, mocked } from '../__helpers__/mocks'
import { rootLogger as _rootLogger } from '../util/logger'
import { processArgv } from '.'
// === helpers ================================================================
jest.mock('fs')
const fs = mocked(_fs)
const rootLogger = _rootLogger as testing.LoggerMock
let lastExitCode: number | undefined
const runCli = async (
...args: any[]
): Promise<{ stdout: string; stderr: string; exitCode: number | undefined; log: string }> => {
mockedProcess.stderr.clear()
mockedProcess.stdout.clear()
rootLogger.target.clear()
mockedProcess.argv.splice(2, mockedProcess.argv.length - 2, ...args)
lastExitCode = undefined
await processArgv()
return {
exitCode: lastExitCode,
stdout: mockedProcess.stdout.written.join('\n'),
stderr: mockedProcess.stderr.written.join('\n'),
log: rootLogger.target.lines.join('\n'),
}
}
let mockedProcess: any
const FAKE_CWD = normalize('/foo/bar')
const FAKE_PKG = normalize(`${FAKE_CWD}/package.json`)
fs.existsSync.mockImplementation(f => f === FAKE_PKG)
fs.readFileSync.mockImplementation(f => {
if (f === FAKE_PKG) return JSON.stringify({ name: 'mock', version: '0.0.0-mock.0' })
throw new Error('ENOENT')
})
// === test ===================================================================
beforeEach(() => {
lastExitCode = undefined
mockedProcess = mockObject(process, {
cwd: jest.fn(() => FAKE_CWD),
argv: ['node', resolve(__dirname, '..', '..', 'cli.js')],
stderr: mockWriteStream(),
stdout: mockWriteStream(),
exit: (exitCode = 0) => {
lastExitCode = exitCode
},
})
fs.writeFileSync.mockClear()
fs.existsSync.mockClear()
fs.readFileSync.mockClear()
rootLogger.target.clear()
})
afterEach(() => {
mockedProcess.mockRestore()
mockedProcess = undefined
})
describe('cli', async () => {
it('should output usage', async () => {
expect.assertions(2)
await expect(runCli()).resolves.toMatchInlineSnapshot(`
Object {
"exitCode": 0,
"log": "",
"stderr": "",
"stdout": "
Usage:
ts-jest command [options] [...args]
Commands:
config:init Creates initial Jest configuration
config:migrate Migrates a given Jest configuration
help [command] Show this help, or help about a command
Example:
ts-jest help config:migrate
",
}
`)
await expect(runCli('hello:motto')).resolves.toMatchInlineSnapshot(`
Object {
"exitCode": 0,
"log": "",
"stderr": "",
"stdout": "
Usage:
ts-jest command [options] [...args]
Commands:
config:init Creates initial Jest configuration
config:migrate Migrates a given Jest configuration
help [command] Show this help, or help about a command
Example:
ts-jest help config:migrate
",
}
`)
})
})
describe('config', async () => {
// briefly tested, see header comment in `config/init.ts`
describe('init', async () => {
const noOption = ['config:init']
const fullOptions = [
...noOption,
'--babel',
'--tsconfig',
'tsconfig.test.json',
'--jsdom',
'--no-jest-preset',
'--allow-js',
]
it('should create a jest.config.json (without options)', async () => {
expect.assertions(2)
const res = await runCli(...noOption)
expect(res).toEqual({
exitCode: 0,
log: '',
stderr: `
Jest configuration written to "${normalize('/foo/bar/jest.config.js')}".
`,
stdout: '',
})
expect(fs.writeFileSync.mock.calls).toEqual([
[
normalize('/foo/bar/jest.config.js'),
`module.exports = {
preset: 'ts-jest',
testEnvironment: 'node',
};`,
],
])
})
it('should create a jest.config.foo.json (with all options set)', async () => {
expect.assertions(2)
const res = await runCli(...fullOptions, 'jest.config.foo.js')
expect(res).toEqual({
exitCode: 0,
log: '',
stderr: `
Jest configuration written to "${normalize('/foo/bar/jest.config.foo.js')}".
`,
stdout: '',
})
expect(fs.writeFileSync.mock.calls).toEqual([
[
normalize('/foo/bar/jest.config.foo.js'),
`const tsJest = require('ts-jest').createJestPreset({ allowJs: true });
module.exports = {
...tsJest,
globals: {
'ts-jest': {
tsconfig: 'tsconfig.test.json',
babelConfig: true,
},
},
};`,
],
])
})
it('should update package.json (without options)', async () => {
expect.assertions(2)
const res = await runCli(...noOption, 'package.json')
expect(res).toEqual({
exitCode: 0,
log: '',
stderr: `
Jest configuration written to "${normalize('/foo/bar/package.json')}".
`,
stdout: '',
})
expect(fs.writeFileSync.mock.calls).toEqual([
[
normalize('/foo/bar/package.json'),
`{
"name": "mock",
"version": "0.0.0-mock.0",
"jest": {
"preset": "ts-jest",
"testEnvironment": "node"
}
}`,
],
])
})
it('should update package.json (with all options set)', async () => {
expect.assertions(2)
const res = await runCli(...fullOptions, 'package.json')
expect(res).toEqual({
exitCode: 0,
log: `[level:20] creating jest presets handling JavaScript files
`,
stderr: `
Jest configuration written to "${normalize('/foo/bar/package.json')}".
`,
stdout: '',
})
expect(fs.writeFileSync.mock.calls).toEqual([
[
normalize('/foo/bar/package.json'),
`{
"name": "mock",
"version": "0.0.0-mock.0",
"jest": {
"transform": {
"^.+\\\\.[tj]sx?$": "ts-jest"
},
"testMatch": [
"**/__tests__/**/*.js?(x)",
"**/?(*.)+(spec|test).js?(x)",
"**/__tests__/**/*.ts?(x)",
"**/?(*.)+(spec|test).ts?(x)"
],
"moduleFileExtensions": [
"js",
"json",
"jsx",
"node",
"ts",
"tsx"
],
"globals": {
"ts-jest": {
"tsconfig": "tsconfig.test.json",
"babelConfig": true
}
}
}
}`,
],
])
})
it('should output help', async () => {
const res = await runCli('help', noOption[0])
expect(res).toMatchInlineSnapshot(`
Object {
"exitCode": 0,
"log": "",
"stderr": "",
"stdout": "
Usage:
ts-jest config:init [options] [<config-file>]
Arguments:
<config-file> Can be a js or json Jest config file. If it is a
package.json file, the configuration will be read from
the \\"jest\\" property.
Default: jest.config.js
Options:
--force Discard any existing Jest config
--allow-js ts-jest will be used to process JS files as well
--no-jest-preset Disable the use of Jest presets
--tsconfig <file> Path to the tsconfig.json file
--babel Call BabelJest after ts-jest
--jsdom Use jsdom as test environment instead of node
",
}
`)
})
}) // init
describe('migrate', async () => {
const pkgPaths = {
_id: 0,
get next() {
return `./foo/${++pkgPaths._id}/package.json`
},
get current() {
return `./foo/${pkgPaths._id}/package.json`
},
}
const noOption = ['config:migrate']
const fullOptions = [...noOption, '--no-jest-preset', '--allow-js']
beforeEach(() => {
mockedProcess.cwd.mockImplementation(() => __dirname)
})
it('should fail if the config file does not exist', async () => {
expect.assertions(1)
fs.existsSync.mockImplementation(() => false)
const res = await runCli(...noOption, pkgPaths.next)
expect(res.log).toMatch(/does not exists/)
})
it('should fail if the config file is not of good type', async () => {
expect.assertions(1)
fs.existsSync.mockImplementation(() => true)
const res = await runCli(...noOption, `${pkgPaths.next}.foo`)
expect(res.log).toMatch(/must be a JavaScript or JSON file/)
})
it('should migrate from package.json (without options)', async () => {
expect.assertions(2)
fs.existsSync.mockImplementation(() => true)
jest.mock(
pkgPaths.next,
() => ({
jest: { globals: { __TS_CONFIG__: { target: 'es6' } } },
}),
{ virtual: true },
)
const res = await runCli(...noOption, pkgPaths.current)
expect(res).toMatchInlineSnapshot(`
Object {
"exitCode": 0,
"log": "[level:20] creating jest presets not handling JavaScript files
",
"stderr": "
Migrated Jest configuration:
",
"stdout": "{
\\"globals\\": {
\\"ts-jest\\": {
\\"tsConfig\\": {
\\"target\\": \\"es6\\"
}
}
},
\\"preset\\": \\"ts-jest\\"
}
",
}
`)
expect(fs.writeFileSync).not.toHaveBeenCalled()
})
it('should migrate from package.json (with options)', async () => {
expect.assertions(2)
fs.existsSync.mockImplementation(() => true)
jest.mock(
pkgPaths.next,
() => ({
jest: { globals: { __TS_CONFIG__: { target: 'es6' } } },
}),
{ virtual: true },
)
const res = await runCli(...fullOptions, pkgPaths.current)
expect(res).toMatchInlineSnapshot(`
Object {
"exitCode": 0,
"log": "[level:20] creating jest presets handling JavaScript files
",
"stderr": "
Migrated Jest configuration:
",
"stdout": "{
\\"globals\\": {
\\"ts-jest\\": {
\\"tsConfig\\": {
\\"target\\": \\"es6\\"
}
}
}
}
",
}
`)
expect(fs.writeFileSync).not.toHaveBeenCalled()
})
it('should detect same option values', async () => {
expect.assertions(1)
fs.existsSync.mockImplementation(() => true)
jest.mock(
pkgPaths.next,
() => ({
jest: {
globals: { __TS_CONFIG__: { target: 'es6' } },
moduleFileExtensions: ['js', 'json', 'tsx', 'jsx', 'node', 'ts'],
testMatch: [
'**/__tests__/**/*.js?(x)',
'**/?(*.)+(spec|test).js?(x)',
'**/__tests__/**/*.ts?(x)',
'**/?(*.)+(spec|test).ts?(x)',
],
},
}),
{ virtual: true },
)
const res = await runCli(...noOption, pkgPaths.current)
expect(res.stdout).toMatchInlineSnapshot(`
"{
\\"globals\\": {
\\"ts-jest\\": {
\\"tsConfig\\": {
\\"target\\": \\"es6\\"
}
}
},
\\"preset\\": \\"ts-jest\\"
}
"
`)
})
it('should reset testMatch if testRegex is used', async () => {
expect.assertions(1)
fs.existsSync.mockImplementation(() => true)
jest.mock(
pkgPaths.next,
() => ({
jest: {
testRegex: 'foo-pattern',
},
}),
{ virtual: true },
)
const res = await runCli(...noOption, pkgPaths.current)
expect(res.stdout).toMatchInlineSnapshot(`
"{
\\"testRegex\\": \\"foo-pattern\\",
\\"preset\\": \\"ts-jest\\",
\\"testMatch\\": null
}
"
`)
})
it('should normalize transform values', async () => {
expect.assertions(1)
fs.existsSync.mockImplementation(() => true)
jest.mock(
pkgPaths.next,
() => ({
jest: {
transform: {
'<rootDir>/src/.+\\.[jt]s$': 'node_modules/ts-jest/preprocessor.js',
'foo\\.ts': '<rootDir>/node_modules/ts-jest/preprocessor.js',
'bar\\.ts': '<rootDir>/node_modules/ts-jest',
},
},
}),
{ virtual: true },
)
const res = await runCli(...noOption, pkgPaths.current)
expect(res.stdout).toMatchInlineSnapshot(`
"{
\\"transform\\": {
\\"<rootDir>/src/.+\\\\\\\\.[jt]s$\\": \\"ts-jest\\",
\\"foo\\\\\\\\.ts\\": \\"ts-jest\\",
\\"bar\\\\\\\\.ts\\": \\"ts-jest\\"
},
\\"preset\\": \\"ts-jest\\"
}
"
`)
})
it('should output help', async () => {
const res = await runCli('help', noOption[0])
expect(res).toMatchInlineSnapshot(`
Object {
"exitCode": 0,
"log": "",
"stderr": "",
"stdout": "
Usage:
ts-jest config:migrate [options] <config-file>
Arguments:
<config-file> Can be a js or json Jest config file. If it is a
package.json file, the configuration will be read from
the \\"jest\\" property.
Options:
--allow-js ts-jest will be used to process JS files as well
--no-jest-preset Disable the use of Jest presets
",
}
`)
})
}) // migrate
}) // config