-
Notifications
You must be signed in to change notification settings - Fork 260
/
documentSymbols.test.ts
321 lines (271 loc) · 14.7 KB
/
documentSymbols.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
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
/*---------------------------------------------------------------------------------------------
* Copyright (c) Red Hat. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { setupLanguageService, setupTextDocument, TEST_URI } from './utils/testHelper';
import {
createExpectedSymbolInformation,
createExpectedDocumentSymbol,
createExpectedDocumentSymbolNoDetail,
} from './utils/verifyError';
import { DocumentSymbol, SymbolKind } from 'vscode-languageserver-types';
import assert = require('assert');
import { ServiceSetup } from './utils/serviceSetup';
import { SymbolInformation } from 'vscode-languageserver';
import { SettingsState, TextDocumentTestManager } from '../src/yamlSettings';
import { LanguageHandlers } from '../src/languageserver/handlers/languageHandlers';
describe('Document Symbols Tests', () => {
let languageHandler: LanguageHandlers;
let yamlSettings: SettingsState;
const limitContent = `
a: [1, 2, 3]
b: [4, 5, 6]
`;
before(() => {
const languageSettingsSetup = new ServiceSetup();
const { languageHandler: langHandler, yamlSettings: settings } = setupLanguageService(languageSettingsSetup.languageSettings);
languageHandler = langHandler;
yamlSettings = settings;
});
afterEach(() => {
yamlSettings.maxItemsComputed = 5000;
});
function assertLimitWarning(): void {
const warnings = languageHandler.pendingLimitExceededWarnings;
assert.deepEqual(Object.keys(warnings), [TEST_URI]);
assert.deepEqual(warnings[TEST_URI].features, { 'document symbols': 'document symbols' });
assert(warnings[TEST_URI].timeout);
}
describe('Document Symbols Tests (Non Hierarchical)', function () {
function parseNonHierarchicalSetup(content: string): SymbolInformation[] | DocumentSymbol[] {
const testTextDocument = setupTextDocument(content);
yamlSettings.documents = new TextDocumentTestManager();
(yamlSettings.documents as TextDocumentTestManager).set(testTextDocument);
return languageHandler.documentSymbolHandler({
textDocument: testTextDocument,
});
}
it('Document is empty', (done) => {
const content = '';
const symbols = parseNonHierarchicalSetup(content);
assert.equal(symbols, null);
done();
});
it('Simple document symbols', () => {
const content = 'cwd: test';
const symbols = parseNonHierarchicalSetup(content);
assert.equal(symbols.length, 1);
assert.deepEqual(symbols[0], createExpectedSymbolInformation('cwd', 15, '', TEST_URI, 0, 0, 0, 9));
});
it('Document Symbols with number', () => {
const content = 'node1: 10000';
const symbols = parseNonHierarchicalSetup(content);
assert.equal(symbols.length, 1);
assert.deepEqual(symbols[0], createExpectedSymbolInformation('node1', 16, '', TEST_URI, 0, 0, 0, 12));
});
it('Document Symbols with boolean', () => {
const content = 'node1: False';
const symbols = parseNonHierarchicalSetup(content);
assert.equal(symbols.length, 1);
assert.deepEqual(symbols[0], createExpectedSymbolInformation('node1', 17, '', TEST_URI, 0, 0, 0, 12));
});
it('Document Symbols with object', () => {
const content = 'scripts:\n node1: test\n node2: test';
const symbols = parseNonHierarchicalSetup(content);
assert.equal(symbols.length, 3);
assert.deepEqual(symbols[0], createExpectedSymbolInformation('scripts', 2, '', TEST_URI, 0, 0, 2, 13));
assert.deepEqual(symbols[1], createExpectedSymbolInformation('node1', 15, 'scripts', TEST_URI, 1, 2, 1, 13));
assert.deepEqual(symbols[2], createExpectedSymbolInformation('node2', 15, 'scripts', TEST_URI, 2, 2, 2, 13));
});
it('Document Symbols with null', () => {
const content = 'apiVersion: null';
const symbols = parseNonHierarchicalSetup(content);
assert.equal(symbols.length, 1);
assert.deepEqual(symbols[0], createExpectedSymbolInformation('apiVersion', SymbolKind.Variable, '', TEST_URI, 0, 0, 0, 16));
});
it('Document Symbols with array of strings', () => {
const content = 'items:\n - test\n - test';
const symbols = parseNonHierarchicalSetup(content);
assert.equal(symbols.length, 1);
assert.deepEqual(symbols[0], createExpectedSymbolInformation('items', SymbolKind.Array, '', TEST_URI, 0, 0, 2, 8));
});
it('Document Symbols with array', () => {
const content = 'authors:\n - name: Josh\n - email: jp';
const symbols = parseNonHierarchicalSetup(content);
assert.equal(symbols.length, 3);
assert.deepEqual(symbols[0], createExpectedSymbolInformation('authors', 18, '', TEST_URI, 0, 0, 2, 13));
assert.deepEqual(symbols[1], createExpectedSymbolInformation('name', 15, 'authors', TEST_URI, 1, 4, 1, 14));
assert.deepEqual(symbols[2], createExpectedSymbolInformation('email', 15, 'authors', TEST_URI, 2, 4, 2, 13));
});
it('Document Symbols with object and array', () => {
const content = 'scripts:\n node1: test\n node2: test\nauthors:\n - name: Josh\n - email: jp';
const symbols = parseNonHierarchicalSetup(content);
assert.equal(symbols.length, 6);
// Sort the items first so they have predictable order in the array
symbols.sort((a, b) => {
return a.name.localeCompare(b.name);
});
assert.deepEqual(symbols[0], createExpectedSymbolInformation('authors', 18, '', TEST_URI, 3, 0, 5, 13));
assert.deepEqual(symbols[1], createExpectedSymbolInformation('email', 15, 'authors', TEST_URI, 5, 4, 5, 13));
assert.deepEqual(symbols[2], createExpectedSymbolInformation('name', 15, 'authors', TEST_URI, 4, 4, 4, 14));
assert.deepEqual(symbols[3], createExpectedSymbolInformation('node1', 15, 'scripts', TEST_URI, 1, 2, 1, 13));
assert.deepEqual(symbols[4], createExpectedSymbolInformation('node2', 15, 'scripts', TEST_URI, 2, 2, 2, 13));
assert.deepEqual(symbols[5], createExpectedSymbolInformation('scripts', 2, '', TEST_URI, 0, 0, 2, 13));
});
it('Document Symbols with multi documents', () => {
const content = '---\nanalytics: true\n...\n---\njson: test\n...';
const symbols = parseNonHierarchicalSetup(content);
assert.equal(symbols.length, 2);
assert.deepEqual(symbols[0], createExpectedSymbolInformation('analytics', 17, '', TEST_URI, 1, 0, 1, 15));
assert.deepEqual(symbols[1], createExpectedSymbolInformation('json', 15, '', TEST_URI, 4, 0, 4, 10));
});
it('Document symbols with a limit', () => {
yamlSettings.maxItemsComputed = 1;
const symbols = parseNonHierarchicalSetup(limitContent);
assert.equal(symbols.length, 1);
assert.deepEqual(symbols[0], createExpectedSymbolInformation('a', SymbolKind.Array, '', TEST_URI, 1, 4, 1, 16));
assertLimitWarning();
});
});
describe('Document Symbols Tests (Hierarchical)', function () {
function parseHierarchicalSetup(content: string): DocumentSymbol[] | SymbolInformation[] {
const testTextDocument = setupTextDocument(content);
yamlSettings.hierarchicalDocumentSymbolSupport = true;
yamlSettings.documents = new TextDocumentTestManager();
(yamlSettings.documents as TextDocumentTestManager).set(testTextDocument);
return languageHandler.documentSymbolHandler({
textDocument: testTextDocument,
});
}
it('Document is empty', (done) => {
const content = '';
const symbols = parseHierarchicalSetup(content);
assert.equal(symbols, null);
done();
});
it('Simple document symbols', () => {
const content = 'cwd: test';
const symbols = parseHierarchicalSetup(content);
assert.equal(symbols.length, 1);
assert.deepEqual(symbols[0], createExpectedDocumentSymbol('cwd', 15, 0, 0, 0, 9, 0, 0, 0, 3, [], 'test'));
});
it('Document Symbols with number', () => {
const content = 'node1: 10000';
const symbols = parseHierarchicalSetup(content);
assert.equal(symbols.length, 1);
assert.deepEqual(symbols[0], createExpectedDocumentSymbol('node1', 16, 0, 0, 0, 12, 0, 0, 0, 5, [], '10000'));
});
it('Document Symbols with boolean', () => {
const content = 'node1: False';
const symbols = parseHierarchicalSetup(content);
assert.equal(symbols.length, 1);
assert.deepEqual(symbols[0], createExpectedDocumentSymbol('node1', 17, 0, 0, 0, 12, 0, 0, 0, 5, [], 'false'));
});
it('Document Symbols with object', () => {
const content = 'scripts:\n node1: test\n node2: test';
const symbols = parseHierarchicalSetup(content);
assert.equal(symbols.length, 1);
const child1 = createExpectedDocumentSymbol('node1', SymbolKind.String, 1, 2, 1, 13, 1, 2, 1, 7, [], 'test');
const child2 = createExpectedDocumentSymbol('node2', SymbolKind.String, 2, 2, 2, 13, 2, 2, 2, 7, [], 'test');
const children = [child1, child2];
assert.deepEqual(symbols[0], createExpectedDocumentSymbol('scripts', SymbolKind.Module, 0, 0, 2, 13, 0, 0, 0, 7, children));
});
it('Document Symbols with null', () => {
const content = 'apiVersion: null';
const symbols = parseHierarchicalSetup(content);
assert.equal(symbols.length, 1);
assert.deepEqual(
symbols[0],
createExpectedDocumentSymbol('apiVersion', SymbolKind.Variable, 0, 0, 0, 16, 0, 0, 0, 10, [], 'null')
);
});
it('Document Symbols with array of strings', () => {
const content = 'items:\n - test\n - test';
const symbols = parseHierarchicalSetup(content);
assert.equal(symbols.length, 1);
const child1 = createExpectedDocumentSymbolNoDetail('0', SymbolKind.String, 1, 4, 1, 8, 1, 4, 1, 8);
const child2 = createExpectedDocumentSymbolNoDetail('1', SymbolKind.String, 2, 4, 2, 8, 2, 4, 2, 8);
const children = [child1, child2];
assert.deepEqual(symbols[0], createExpectedDocumentSymbol('items', SymbolKind.Array, 0, 0, 2, 8, 0, 0, 0, 5, children));
});
it('Document Symbols with array', () => {
const content = 'authors:\n - name: Josh\n - email: jp';
const symbols = parseHierarchicalSetup(content);
const object1 = createExpectedDocumentSymbol('name', SymbolKind.String, 1, 4, 1, 14, 1, 4, 1, 8, [], 'Josh');
const arrayChild1 = createExpectedDocumentSymbolNoDetail('0', SymbolKind.Module, 1, 4, 1, 14, 1, 4, 1, 14, [object1]);
const object2 = createExpectedDocumentSymbol('email', SymbolKind.String, 2, 4, 2, 13, 2, 4, 2, 9, [], 'jp');
const arrayChild2 = createExpectedDocumentSymbolNoDetail('1', SymbolKind.Module, 2, 4, 2, 13, 2, 4, 2, 13, [object2]);
const children = [arrayChild1, arrayChild2];
assert.deepEqual(symbols[0], createExpectedDocumentSymbol('authors', SymbolKind.Array, 0, 0, 2, 13, 0, 0, 0, 7, children));
});
it('Document Symbols with object and array', () => {
const content = 'scripts:\n node1: test\n node2: test\nauthors:\n - name: Josh\n - email: jp';
const symbols = parseHierarchicalSetup(content);
assert.equal(symbols.length, 2);
const child1 = createExpectedDocumentSymbol('node1', SymbolKind.String, 1, 2, 1, 13, 1, 2, 1, 7, [], 'test');
const child2 = createExpectedDocumentSymbol('node2', SymbolKind.String, 2, 2, 2, 13, 2, 2, 2, 7, [], 'test');
const children = [child1, child2];
assert.deepEqual(symbols[0], createExpectedDocumentSymbol('scripts', SymbolKind.Module, 0, 0, 2, 13, 0, 0, 0, 7, children));
const object1 = createExpectedDocumentSymbol('name', SymbolKind.String, 4, 4, 4, 14, 4, 4, 4, 8, [], 'Josh');
const arrayChild1 = createExpectedDocumentSymbolNoDetail('0', SymbolKind.Module, 4, 4, 4, 14, 4, 4, 4, 14, [object1]);
const object2 = createExpectedDocumentSymbol('email', SymbolKind.String, 5, 4, 5, 13, 5, 4, 5, 9, [], 'jp');
const arrayChild2 = createExpectedDocumentSymbolNoDetail('1', SymbolKind.Module, 5, 4, 5, 13, 5, 4, 5, 13, [object2]);
const children2 = [arrayChild1, arrayChild2];
assert.deepEqual(symbols[1], createExpectedDocumentSymbol('authors', SymbolKind.Array, 3, 0, 5, 13, 3, 0, 3, 7, children2));
});
it('Document Symbols with multi documents', () => {
const content = '---\nanalytics: true\n...\n---\njson: test\n...';
const symbols = parseHierarchicalSetup(content);
assert.equal(symbols.length, 2);
assert.deepEqual(
symbols[0],
createExpectedDocumentSymbol('analytics', SymbolKind.Boolean, 1, 0, 1, 15, 1, 0, 1, 9, [], 'true')
);
assert.deepEqual(symbols[1], createExpectedDocumentSymbol('json', SymbolKind.String, 4, 0, 4, 10, 4, 0, 4, 4, [], 'test'));
});
it('Document Symbols with complex mapping and aliases', () => {
const content = `
version: 0.0.1
structure:
? &root root
:
element: div
conditions:
? *root
:
style:
height: 41
`;
const symbols = parseHierarchicalSetup(content);
assert.equal(symbols.length, 3);
assert.deepEqual(
symbols[0],
createExpectedDocumentSymbol('version', SymbolKind.String, 1, 12, 1, 26, 1, 12, 1, 19, [], '0.0.1')
);
const element = createExpectedDocumentSymbol('element', SymbolKind.String, 5, 16, 5, 28, 5, 16, 5, 23, [], 'div');
const root1 = createExpectedDocumentSymbol('root', SymbolKind.Module, 3, 22, 5, 28, 3, 22, 3, 26, [element]);
const height = createExpectedDocumentSymbol('height', SymbolKind.Number, 10, 18, 10, 28, 10, 18, 10, 24, [], '41');
const style = createExpectedDocumentSymbol('style', SymbolKind.Module, 9, 16, 10, 28, 9, 16, 9, 21, [height]);
const root2 = createExpectedDocumentSymbol('root', SymbolKind.Module, 7, 17, 10, 28, 7, 17, 7, 21, [style]);
assert.deepEqual(
symbols[1],
createExpectedDocumentSymbol('structure', SymbolKind.Module, 2, 12, 5, 28, 2, 12, 2, 21, [root1])
);
assert.deepEqual(
symbols[2],
createExpectedDocumentSymbol('conditions', SymbolKind.Module, 6, 12, 10, 28, 6, 12, 6, 22, [root2])
);
});
it('Document symbols with a limit', () => {
yamlSettings.maxItemsComputed = 3;
const symbols = parseHierarchicalSetup(limitContent) as DocumentSymbol[];
assert.equal(symbols.length, 2);
assert.equal(symbols[0].children.length, 1);
assert.equal(symbols[1].children.length, 0);
const el = createExpectedDocumentSymbolNoDetail('0', SymbolKind.Number, 1, 8, 1, 9, 1, 8, 1, 9, []);
const root = createExpectedDocumentSymbol('a', SymbolKind.Array, 1, 4, 1, 16, 1, 4, 1, 5, [el]);
assert.deepEqual(symbols[0], root);
assertLimitWarning();
});
});
});