-
Notifications
You must be signed in to change notification settings - Fork 3.2k
/
GitDataSource.spec.ts
298 lines (229 loc) · 8.32 KB
/
GitDataSource.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
import { expect } from 'chai'
import path from 'path'
import os from 'os'
import simpleGit from 'simple-git'
import fs from 'fs-extra'
import sinon from 'sinon'
import pDefer from 'p-defer'
import chokidar from 'chokidar'
import { scaffoldMigrationProject } from '../helper'
import { GitDataSource, GitInfo } from '../../../src/sources/GitDataSource'
import { toPosix } from '../../../src/util/file'
describe('GitDataSource', () => {
let git: ReturnType<typeof simpleGit>
let gitInfo: GitDataSource
let projectPath: string
let e2eFolder: string
beforeEach(async () => {
projectPath = await scaffoldMigrationProject('e2e')
git = simpleGit({ baseDir: projectPath })
e2eFolder = path.join(projectPath, 'cypress', 'e2e')
const allSpecs = fs.readdirSync(e2eFolder)
if (process.env.CI) {
// need to set a user on CI
await Promise.all([
git.addConfig('user.name', 'Test User', true, 'global'),
git.addConfig('user.email', 'test-user@example.com', true, 'global'),
])
}
await git.init()
await git.add(allSpecs.map((spec) => path.join(e2eFolder, spec)))
await git.commit('add all specs')
})
afterEach(() => {
if (gitInfo) {
gitInfo.destroy()
}
gitInfo = undefined
sinon.restore()
})
it(`gets correct status for files on ${os.platform()}`, async function () {
// TODO: fix flaky test https://github.com/cypress-io/cypress/issues/23317
this.retries(15)
const onBranchChange = sinon.stub()
const onGitInfoChange = sinon.stub()
const onError = sinon.stub()
// create a file and modify a file to express all
// git states we are interested in (created, unmodified, modified)
const fooSpec = toPosix(path.join(e2eFolder, 'foo.cy.js'))
const aRecordSpec = toPosix(path.join(e2eFolder, 'a_record.cy.js'))
const xhrSpec = toPosix(path.join(e2eFolder, 'xhr.cy.js'))
gitInfo = new GitDataSource({
isRunMode: false,
projectRoot: projectPath,
onBranchChange,
onGitInfoChange,
onError,
})
fs.createFileSync(fooSpec)
fs.writeFileSync(xhrSpec, 'it(\'modifies the file\', () => {})')
gitInfo.setSpecs([fooSpec, aRecordSpec, xhrSpec])
let result: any[] = []
do {
result = await Promise.all([
gitInfo.gitInfoFor(fooSpec),
gitInfo.gitInfoFor(aRecordSpec),
gitInfo.gitInfoFor(xhrSpec),
])
await new Promise((resolve) => setTimeout(resolve, 100))
} while (result.some((r) => r == null))
const [created, unmodified, modified] = result
expect(created.lastModifiedHumanReadable).to.match(/(a few|[0-9]) seconds? ago/)
expect(created.statusType).to.eql('created')
// do not want to set this explicitly in the test, since it can mess up your local git instance
expect(created.author).not.to.be.undefined
expect(created.lastModifiedTimestamp).not.to.be.undefined
expect(unmodified.lastModifiedHumanReadable).to.match(/(a few|[0-9]) seconds? ago/)
expect(unmodified.statusType).to.eql('unmodified')
// do not want to set this explicitly in the test, since it can mess up your local git instance
expect(unmodified.author).not.to.be.undefined
expect(unmodified.lastModifiedTimestamp).not.to.be.undefined
expect(modified.lastModifiedHumanReadable).to.match(/(a few|[0-9]) seconds? ago/)
expect(modified.statusType).to.eql('modified')
// do not want to set this explicitly in the test, since it can mess up your local git instance
expect(modified.author).not.to.be.undefined
expect(modified.lastModifiedTimestamp).not.to.be.undefined
})
it(`handles files with special characters on ${os.platform()}`, async () => {
// Validates handling of edge cases from https://github.com/cypress-io/cypress/issues/22454
let filepaths = [
'file withSpace.cy.js',
'file~WithTilde.cy.js',
'file-withHyphen.cy.js',
'file_withUnderscore.cy.js',
'file;WithSemicolon.cy.js',
'file,withComma.cy.js',
'file@withAtSymbol.cy.js',
'file^withCarat.cy.js',
'file=withEqual.cy.js',
'file+withPlus.cy.js',
'file\'withOneSingleQuote.cy.js',
]
if (os.platform() !== 'win32') {
// Double quote not a legal character on NTFS
filepaths.push('file"withOneDoubleQuote.cy.js')
}
filepaths = filepaths
.map((filename) => path.join(e2eFolder, filename))
.map((filepath) => toPosix(filepath))
gitInfo = new GitDataSource({
isRunMode: false,
projectRoot: projectPath,
onBranchChange: sinon.stub(),
onGitInfoChange: sinon.stub(),
onError: sinon.stub(),
})
for (let filepath of filepaths) {
fs.createFileSync(filepath)
}
gitInfo.setSpecs(filepaths)
let results: (GitInfo | null)[] = []
do {
results = await Promise.all(filepaths.map(function (filepath) {
return gitInfo.gitInfoFor(filepath)
}))
await new Promise((resolve) => setTimeout(resolve, 100))
} while (results.some((r) => r == null))
expect(results).to.have.lengthOf(filepaths.length)
filepaths.forEach((filepath, index) => {
const result = results[index]
expect(result?.lastModifiedHumanReadable).to.match(/(a few|[0-9]) seconds? ago/)
expect(result?.statusType).to.eql('created')
})
})
it(`watches switching branches on ${os.platform()}`, async () => {
const stub = sinon.stub()
const dfd = pDefer()
stub.onFirstCall().callsFake(dfd.resolve)
gitInfo = new GitDataSource({
isRunMode: false,
projectRoot: projectPath,
onBranchChange: stub,
onGitInfoChange: sinon.stub(),
onError: sinon.stub(),
})
const result = await dfd.promise
expect(result).to.eq((await git.branch()).current)
const switchBranch = pDefer()
stub.onSecondCall().callsFake(switchBranch.resolve)
git.checkoutLocalBranch('testing123')
expect(await switchBranch.promise).to.eq('testing123')
})
it(`handles error while watching .git on ${os.platform()}`, async () => {
sinon.stub(chokidar, 'watch').callsFake(() => {
const mockWatcher = {
on: (event, fn) => {
if (event === 'error') {
fn(new Error('Unexpected error'))
}
},
close: () => ({ catch: () => {} }),
} as unknown
return mockWatcher as chokidar.FSWatcher
})
const errorStub = sinon.stub()
const stub = sinon.stub()
const dfd = pDefer()
stub.onFirstCall().callsFake(dfd.resolve)
gitInfo = new GitDataSource({
isRunMode: false,
projectRoot: projectPath,
onBranchChange: stub,
onGitInfoChange: sinon.stub(),
onError: errorStub,
})
await dfd.promise
const result = await dfd.promise
expect(result).to.eq((await git.branch()).current)
expect(errorStub).to.be.callCount(1)
})
context('Git hashes', () => {
let clock
beforeEach(() => {
clock = sinon.useFakeTimers()
})
afterEach(() => {
clock.restore()
})
it('loads git hashes when first loaded', async () => {
const dfd = pDefer()
const logCallback = () => {
dfd.resolve()
}
gitInfo = new GitDataSource({
isRunMode: false,
projectRoot: projectPath,
onBranchChange: sinon.stub(),
onGitInfoChange: sinon.stub(),
onError: sinon.stub(),
onGitLogChange: logCallback,
})
await dfd.promise
expect(gitInfo.currentHashes).to.have.length(1)
})
it('detects change in hashes after a commit', async () => {
const dfd = pDefer()
const afterCommit = pDefer()
const logCallback = sinon.stub()
logCallback.onFirstCall().callsFake(dfd.resolve)
logCallback.onSecondCall().callsFake(afterCommit.resolve)
gitInfo = new GitDataSource({
isRunMode: false,
projectRoot: projectPath,
onBranchChange: sinon.stub(),
onGitInfoChange: sinon.stub(),
onError: sinon.stub(),
onGitLogChange: logCallback,
})
await dfd.promise
expect(gitInfo.currentHashes).to.have.length(1)
const afterCommitSpec = toPosix(path.join(e2eFolder, 'afterCommit.cy.js'))
fs.createFileSync(afterCommitSpec)
git.add(afterCommitSpec)
git.commit('add afterCommit spec')
await clock.tickAsync(60010)
await afterCommit.promise
expect(gitInfo.currentHashes).to.have.length(2)
})
})
})