-
-
Notifications
You must be signed in to change notification settings - Fork 10
/
file-client.test.ts
284 lines (223 loc) · 8.65 KB
/
file-client.test.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
import fs from 'fs';
import {
compareResults,
prepareResultsDirectory,
writeComparisonResults,
RESULTS_LOCATION,
RESULTS_COMPARE_DIR,
RESULTS_COMPARISON_CACHE_LOCATION,
CACHE_LOCATION,
} from '@file-client';
import {
Result,
RESULT_PARSER_TO_COMPARE_TEMPLATE,
} from '@file-client/result-templates';
import { removeDirectorySync } from '@file-client/file-utils';
import { mockConfig } from '__mocks__/@config';
import { getComparisonResults } from '../utils';
jest.unmock('@file-client');
const MOCK_RESULT_FILES = ['mock-result-one.md', 'mock-result-two.md'];
const MOCK_COMPARISON_FILES = ['added.md', 'removed.md'];
const createResultsDirectory = () => fs.mkdirSync(RESULTS_LOCATION);
const readResultsDirectory = () => fs.readdirSync(RESULTS_LOCATION);
const resultsDirectoryExists = () => fs.existsSync(RESULTS_LOCATION);
const comparisonCacheExists = () =>
fs.existsSync(RESULTS_COMPARISON_CACHE_LOCATION);
const createComparisonDirectory = () =>
fs.mkdirSync(`${RESULTS_LOCATION}/${RESULTS_COMPARE_DIR}`);
const readComparisonDirectory = () =>
fs.readdirSync(`${RESULTS_LOCATION}/${RESULTS_COMPARE_DIR}`);
const readComparisonCache = () =>
JSON.parse(fs.readFileSync(RESULTS_COMPARISON_CACHE_LOCATION, 'utf8'));
function removeResultsDirectory(): void {
if (resultsDirectoryExists()) {
removeDirectorySync(RESULTS_LOCATION);
}
}
function createResults(): void {
removeResultsDirectory();
createResultsDirectory();
MOCK_RESULT_FILES.forEach(name =>
fs.writeFileSync(`${RESULTS_LOCATION}/${name}`, 'Hello world', 'utf8')
);
}
function createComparisonCache(...results: Result[]): void {
removeComparisonCache();
if (!fs.existsSync(CACHE_LOCATION)) {
fs.mkdirSync(CACHE_LOCATION);
}
fs.writeFileSync(
RESULTS_COMPARISON_CACHE_LOCATION,
JSON.stringify(results),
'utf8'
);
}
function removeComparisonCache(): void {
if (comparisonCacheExists()) {
fs.unlinkSync(RESULTS_COMPARISON_CACHE_LOCATION);
}
}
function generateResult(prefix = '0'): Result {
return {
repository: `${prefix}-repository`,
repositoryOwner: `${prefix}-repositoryOwner`,
rule: `${prefix}-rule`,
message: `${prefix}-message`,
path: `${prefix}-path`,
link: `${prefix}-link`,
extension: `${prefix}-extension`,
source: `${prefix}-source`,
error: `${prefix}-error`,
__internalHash: `${prefix}-__internalHash` as Result['__internalHash'],
};
}
function createComparisonResults(): void {
removeResultsDirectory();
createResultsDirectory();
createComparisonDirectory();
MOCK_COMPARISON_FILES.forEach(name =>
fs.writeFileSync(
`${RESULTS_LOCATION}/${RESULTS_COMPARE_DIR}/${name}`,
'Hello world',
'utf8'
)
);
}
function getCacheLocation() {
let location = '';
jest.isolateModules(() => {
location =
require('../../lib/file-client/file-constants').CACHE_LOCATION;
});
return location;
}
describe('prepareResultsDirectory', () => {
afterEach(() => {
removeResultsDirectory();
});
test('creates results directory when previous does not exist', () => {
removeResultsDirectory();
prepareResultsDirectory();
expect(resultsDirectoryExists()).toBe(true);
});
test('empties results directory when previous exists', () => {
createResults();
const filesBefore = readResultsDirectory();
prepareResultsDirectory();
const filesAfter = readResultsDirectory();
expect(filesAfter).not.toHaveLength(filesBefore.length);
// Only comparison directory should exist
expect(readResultsDirectory()).toHaveLength(1);
});
test('creates empty comparison directory when previous does not exist', () => {
removeResultsDirectory();
prepareResultsDirectory();
expect(readResultsDirectory()).toEqual([RESULTS_COMPARE_DIR]);
});
test('empties comparison directory when previous exists', () => {
createComparisonResults();
prepareResultsDirectory();
expect(readComparisonDirectory()).toHaveLength(0);
});
test.todo('does not remove results if called from worker thread');
});
describe('compareResults', () => {
test('marks new results as "added"', async () => {
const one = generateResult('1');
const two = generateResult('2');
const three = generateResult('3');
createComparisonCache(three);
const results = await compareResults([one, two, three]);
expect(results.added).toEqual([one, two]);
expect(results.removed).toHaveLength(0);
});
test('marks disappeared results as "removed"', async () => {
const one = generateResult('1');
const two = generateResult('2');
const three = generateResult('3');
createComparisonCache(one, two, three);
const results = await compareResults([three]);
expect(results.removed).toEqual([one, two]);
expect(results.added).toHaveLength(0);
});
test('identifies changes in result.__internalHash', async () => {
const result = generateResult();
createComparisonCache({ ...result, __internalHash: '1' as any });
const results = await compareResults([
{ ...result, __internalHash: '2' as any },
]);
expect(results.added).toEqual([{ ...result, __internalHash: '2' }]);
});
test('marks all results as "added" when previous results are not found', async () => {
removeComparisonCache();
const one = generateResult('1');
const two = generateResult('2');
const results = await compareResults([one, two]);
expect(results.added).toEqual([one, two]);
expect(results.removed).toHaveLength(0);
});
});
describe('writeComparisonResults', () => {
test('writes comparison results to file system', async () => {
const template = RESULT_PARSER_TO_COMPARE_TEMPLATE.markdown;
const results = [generateResult('1'), generateResult('2')];
const comparisonResults = {
added: [generateResult('3')],
removed: [generateResult('4')],
};
await writeComparisonResults(comparisonResults, results);
const { added, removed } = getComparisonResults();
expect(added).toBe(
`${template.header('added')}\n${comparisonResults.added
.map(template.results)
.join('\n')}`
);
expect(removed).toBe(
`${template.header('removed')}\n${comparisonResults.removed
.map(template.results)
.join('\n')}`
);
});
test('updates comparison cache on file system when updateComparisonReference is enabled', async () => {
mockConfig.mockReturnValue({ updateComparisonReference: true });
removeComparisonCache();
const results = [generateResult('1'), generateResult('2')];
await writeComparisonResults({ added: [], removed: [] }, results);
expect(comparisonCacheExists()).toBe(true);
expect(readComparisonCache()).toEqual(results);
});
test('does not update comparison cache when updateComparisonReference is disabled', async () => {
mockConfig.mockReturnValue({ updateComparisonReference: false });
removeComparisonCache();
const results = [generateResult('1'), generateResult('2')];
await writeComparisonResults({ added: [], removed: [] }, results);
expect(comparisonCacheExists()).toBe(false);
});
test('does not crash if results compare location is not found', async () => {
removeResultsDirectory();
await writeComparisonResults({ added: [], removed: [] }, [
generateResult(),
]);
});
});
describe('CACHE_LOCATION', () => {
test('is initialized under package in node_modules', () => {
jest.mock('fs', () => ({ existsSync: () => true }));
expect(getCacheLocation()).toBe(
'./node_modules/eslint-remote-tester/.cache-eslint-remote-tester'
);
});
test('is initialized under node_modules when package is not installed', () => {
jest.mock('fs', () => ({
existsSync: (path: string) =>
path !== './node_modules/eslint-remote-tester',
}));
expect(getCacheLocation()).toBe(
'./node_modules/.cache-eslint-remote-tester'
);
});
test('is initialized in root when node_modules is not available', () => {
jest.mock('fs', () => ({ existsSync: () => false }));
expect(getCacheLocation()).toBe('./.cache-eslint-remote-tester');
});
});