forked from DonJayamanne/pythonVSCode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcacheUtils.unit.test.ts
More file actions
230 lines (192 loc) · 10.5 KB
/
cacheUtils.unit.test.ts
File metadata and controls
230 lines (192 loc) · 10.5 KB
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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
'use strict';
import { expect } from 'chai';
import { Uri } from 'vscode';
import { clearCache, InMemoryInterpreterSpecificCache } from '../../../client/common/utils/cacheUtils';
type CacheUtilsTestScenario = {
scenarioDesc: string;
// tslint:disable-next-line:no-any
dataToStore: any;
};
const scenariosToTest: CacheUtilsTestScenario[] = [
{
scenarioDesc: 'simple string',
dataToStore: 'hello'
},
{
scenarioDesc: 'undefined',
dataToStore: undefined
},
{
scenarioDesc: 'object',
dataToStore: { date: new Date(), hello: 1234 }
}
];
class TestInMemoryInterpreterSpecificCache extends InMemoryInterpreterSpecificCache<string | undefined | { date: number; hello: number }> {
public elapsed: number = 0;
public set simulatedElapsedMs(value: number) {
this.elapsed = value;
}
protected calculateExpiry(): number {
return this.expiryDurationMs;
}
protected hasExpired(expiry: number): boolean {
return expiry < this.elapsed;
}
}
// tslint:disable:no-any max-func-body-length
suite('Common Utils - CacheUtils', () => {
teardown(() => {
clearCache();
});
function createMockVSC(pythonPath: string): typeof import('vscode') {
return {
workspace: {
getConfiguration: () => {
return {
get: () => {
return pythonPath;
},
inspect: () => {
return { globalValue: pythonPath };
}
};
},
getWorkspaceFolder: () => {
return;
}
},
Uri: Uri
} as any;
}
scenariosToTest.forEach((scenario: CacheUtilsTestScenario) => {
test(`Data is stored in cache (without workspaces): ${scenario.scenarioDesc}`, () => {
const pythonPath = 'Some Python Path';
const vsc = createMockVSC(pythonPath);
const resource = Uri.parse('a');
const cache = new InMemoryInterpreterSpecificCache('Something', 10000, [resource], vsc);
expect(cache.hasData).to.be.equal(false, 'Must not have any data');
cache.data = scenario.dataToStore;
expect(cache.hasData).to.be.equal(true, 'Must have data');
expect(cache.data).to.be.deep.equal(scenario.dataToStore);
});
test(`Data is stored in cache must be cleared when clearing globally: ${scenario.scenarioDesc}`, () => {
const pythonPath = 'Some Python Path';
const vsc = createMockVSC(pythonPath);
const resource = Uri.parse('a');
const cache = new InMemoryInterpreterSpecificCache('Something', 10000, [resource], vsc);
expect(cache.hasData).to.be.equal(false, 'Must not have any data');
cache.data = scenario.dataToStore;
expect(cache.hasData).to.be.equal(true, 'Must have data');
expect(cache.data).to.be.deep.equal(scenario.dataToStore);
clearCache();
expect(cache.hasData).to.be.equal(false, 'Must not have data');
expect(cache.data).to.be.deep.equal(undefined, 'Must not have data');
});
test(`Data is stored in cache must be cleared: ${scenario.scenarioDesc}`, () => {
const pythonPath = 'Some Python Path';
const vsc = createMockVSC(pythonPath);
const resource = Uri.parse('a');
const cache = new InMemoryInterpreterSpecificCache('Something', 10000, [resource], vsc);
expect(cache.hasData).to.be.equal(false, 'Must not have any data');
cache.data = scenario.dataToStore;
expect(cache.hasData).to.be.equal(true, 'Must have data');
expect(cache.data).to.be.deep.equal(scenario.dataToStore);
cache.clear();
expect(cache.hasData).to.be.equal(false, 'Must not have data');
expect(cache.data).to.be.deep.equal(undefined, 'Must not have data');
});
test(`Data is stored in cache and expired data is not returned: ${scenario.scenarioDesc}`, async () => {
const pythonPath = 'Some Python Path';
const vsc = createMockVSC(pythonPath);
const resource = Uri.parse('a');
const cache = new TestInMemoryInterpreterSpecificCache('Something', 100, [resource], vsc);
expect(cache.hasData).to.be.equal(false, 'Must not have any data before caching.');
cache.data = scenario.dataToStore;
expect(cache.hasData).to.be.equal(true, 'Must have data after setting the first time.');
expect(cache.data).to.be.deep.equal(scenario.dataToStore);
cache.simulatedElapsedMs = 10;
expect(cache.hasData).to.be.equal(true, 'Must have data after waiting for 10ms');
expect(cache.data).to.be.deep.equal(scenario.dataToStore, 'Data should be intact and unchanged in cache after 10ms');
cache.simulatedElapsedMs = 50;
expect(cache.hasData).to.be.equal(true, 'Must have data after waiting 50ms');
expect(cache.data).to.be.deep.equal(scenario.dataToStore, 'Data should be intact and unchanged in cache after 50ms');
cache.simulatedElapsedMs = 110;
expect(cache.hasData).to.be.equal(false, 'Must not have data after waiting 110ms');
expect(cache.data).to.be.deep.equal(undefined, 'Must not have data stored after 100ms timeout expires.');
});
test(`Data is stored in cache (with workspaces): ${scenario.scenarioDesc}`, () => {
const pythonPath = 'Some Python Path';
const vsc = createMockVSC(pythonPath);
const resource = Uri.parse('a');
(vsc.workspace as any).workspaceFolders = [{ index: 0, name: '1', uri: Uri.parse('wkfolder') }];
vsc.workspace.getWorkspaceFolder = () => vsc.workspace.workspaceFolders![0];
const cache = new InMemoryInterpreterSpecificCache('Something', 10000, [resource], vsc);
expect(cache.hasData).to.be.equal(false, 'Must not have any data');
cache.data = scenario.dataToStore;
expect(cache.hasData).to.be.equal(true, 'Must have data');
expect(cache.data).to.be.deep.equal(scenario.dataToStore);
});
test(`Data is stored in cache and different resources point to same storage location (without workspaces): ${scenario.scenarioDesc}`, () => {
const pythonPath = 'Some Python Path';
const vsc = createMockVSC(pythonPath);
const resource = Uri.parse('a');
const anotherResource = Uri.parse('b');
const cache = new InMemoryInterpreterSpecificCache('Something', 10000, [resource], vsc);
const cache2 = new InMemoryInterpreterSpecificCache('Something', 10000, [anotherResource], vsc);
expect(cache.hasData).to.be.equal(false, 'Must not have any data');
expect(cache2.hasData).to.be.equal(false, 'Must not have any data');
cache.data = scenario.dataToStore;
expect(cache.hasData).to.be.equal(true, 'Must have data');
expect(cache2.hasData).to.be.equal(true, 'Must have data');
expect(cache.data).to.be.deep.equal(scenario.dataToStore);
expect(cache2.data).to.be.deep.equal(scenario.dataToStore);
});
test(`Data is stored in cache and different resources point to same storage location (with workspaces): ${scenario.scenarioDesc}`, () => {
const pythonPath = 'Some Python Path';
const vsc = createMockVSC(pythonPath);
const resource = Uri.parse('a');
const anotherResource = Uri.parse('b');
(vsc.workspace as any).workspaceFolders = [{ index: 0, name: '1', uri: Uri.parse('wkfolder') }];
vsc.workspace.getWorkspaceFolder = () => vsc.workspace.workspaceFolders![0];
const cache = new InMemoryInterpreterSpecificCache('Something', 10000, [resource], vsc);
const cache2 = new InMemoryInterpreterSpecificCache('Something', 10000, [anotherResource], vsc);
expect(cache.hasData).to.be.equal(false, 'Must not have any data');
expect(cache2.hasData).to.be.equal(false, 'Must not have any data');
cache.data = scenario.dataToStore;
expect(cache.hasData).to.be.equal(true, 'Must have data');
expect(cache2.hasData).to.be.equal(true, 'Must have data');
expect(cache.data).to.be.deep.equal(scenario.dataToStore);
expect(cache2.data).to.be.deep.equal(scenario.dataToStore);
});
test(`Data is stored in cache and different resources do not point to same storage location (with multiple workspaces): ${scenario.scenarioDesc}`, () => {
const pythonPath = 'Some Python Path';
const vsc = createMockVSC(pythonPath);
const resource = Uri.parse('a');
const anotherResource = Uri.parse('b');
(vsc.workspace as any).workspaceFolders = [
{ index: 0, name: '1', uri: Uri.parse('wkfolder1') },
{ index: 1, name: '2', uri: Uri.parse('wkfolder2') }
];
vsc.workspace.getWorkspaceFolder = (res) => {
const index = res.fsPath === resource.fsPath ? 0 : 1;
return vsc.workspace.workspaceFolders![index];
};
const cache = new InMemoryInterpreterSpecificCache('Something', 10000, [resource], vsc);
const cache2 = new InMemoryInterpreterSpecificCache('Something', 10000, [anotherResource], vsc);
expect(cache.hasData).to.be.equal(false, 'Must not have any data');
expect(cache2.hasData).to.be.equal(false, 'Must not have any data');
cache.data = scenario.dataToStore;
expect(cache.hasData).to.be.equal(true, 'Must have data');
expect(cache2.hasData).to.be.equal(false, 'Must not have any data');
expect(cache.data).to.be.deep.equal(scenario.dataToStore);
expect(cache2.data).to.be.deep.equal(undefined, 'Must not have any data');
cache2.data = 'Store some other data';
expect(cache.hasData).to.be.equal(true, 'Must have data');
expect(cache2.hasData).to.be.equal(true, 'Must have');
expect(cache.data).to.be.deep.equal(scenario.dataToStore);
expect(cache2.data).to.be.deep.equal('Store some other data', 'Must have data');
});
});
});