-
Notifications
You must be signed in to change notification settings - Fork 14
/
snippets.test.ts
391 lines (358 loc) · 23.5 KB
/
snippets.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
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
/* eslint-disable @typescript-eslint/no-explicit-any */
'use strict';
import vscode = require('vscode');
import * as assert from 'assert';
import { getWorkspacePath } from './helpers';
const configName = 'yara';
const extensionId = 'infosec-intern.yara';
let extension: vscode.Extension<any>;
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export async function setTestConfig(id:string, value: any, configuration: vscode.WorkspaceConfiguration): Promise<void> {
return configuration.update(id, value, vscode.ConfigurationTarget.Global);
}
suite('Condition Snippet', function () {
let modifiedConfig: vscode.WorkspaceConfiguration;
let uri: vscode.Uri;
setup(async function () {
extension = vscode.extensions.getExtension(extensionId);
await extension.activate();
modifiedConfig = vscode.workspace.getConfiguration(configName);
uri = getWorkspacePath(extension.extensionUri, 'snippets.yar');
});
teardown(async function () {
await setTestConfig('snippets.condition', undefined, modifiedConfig);
});
test('it does not provide a condition snippet when the setting is false', async function () {
const pos: vscode.Position = new vscode.Position(2, 9);
await setTestConfig('snippets.condition', false, modifiedConfig);
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 0);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 3);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'condition'; });
assert.equal(item, undefined);
});
test('it provides a basic condition section when not resolved', async function () {
const pos: vscode.Position = new vscode.Position(5, 14);
// don't resolve any completion items yet
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 0);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 4);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'condition'; });
assert.equal(item.label, 'condition');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a condition section (YARA)');
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString('condition:\n\t${1:conditions}');
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock('condition:\n\tCONDITIONS');
assert.deepEqual(item.documentation, expectedDocs);
});
test('it provides a condition placeholder when resolved', async function () {
const pos: vscode.Position = new vscode.Position(5, 14);
// resolve items
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 4);
assert.equal(completions.isIncomplete, false);
const items: Array<vscode.CompletionItem> = completions.items;
assert.equal(items.length, 4);
const item: vscode.CompletionItem = items.find((value: vscode.CompletionItem) => { return value.label === 'condition'; });
assert.equal(item.label, 'condition');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a condition section (YARA)');
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString('condition:\n\t${1:any of them}');
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock('condition:\n\tCONDITIONS');
assert.deepEqual(item.documentation, expectedDocs);
});
});
suite('Metadata Snippet', function () {
let modifiedConfig: vscode.WorkspaceConfiguration;
let uri: vscode.Uri;
setup(async function () {
extension = vscode.extensions.getExtension(extensionId);
await extension.activate();
modifiedConfig = vscode.workspace.getConfiguration(configName);
uri = getWorkspacePath(extension.extensionUri, 'snippets.yar');
});
teardown(async function () {
await setTestConfig('metaEntries', undefined, modifiedConfig);
await setTestConfig('sortMeta', undefined, modifiedConfig);
await setTestConfig('snippets.meta', undefined, modifiedConfig);
});
test('it does not provide a meta snippet when the setting is false', async function () {
const pos: vscode.Position = new vscode.Position(2, 9);
await setTestConfig('snippets.meta', false, modifiedConfig);
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 0);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 3);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'meta'; });
assert.equal(item, undefined);
});
test('it provides a basic meta section when the user types in the correct prefix', async function () {
const pos: vscode.Position = new vscode.Position(2, 9);
// don't resolve any completion items yet
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 0);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 4);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'meta'; });
assert.equal(item.label, 'meta');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a meta section (YARA)');
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString('meta:\n\t$1 = "$2"');
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock('meta:\n\tkey = "value"');
assert.deepEqual(item.documentation, expectedDocs);
});
test('it provides an empty meta section when no configuration is present', async function () {
const pos: vscode.Position = new vscode.Position(2, 9);
// the editor will merge Object configurations rather than implicitly overwriting them
// ... so the only way to clear the config is manually undefining them
await setTestConfig('metaEntries', undefined, modifiedConfig);
// don't resolve any completion items yet
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 4);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 4);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'meta'; });
assert.equal(item.label, 'meta');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a meta section (YARA)');
const rawInsertText = 'meta:\n\t${1:KEY} = ${2:"VALUE"}';
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString(rawInsertText);
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock(rawInsertText);
assert.deepEqual(item.documentation, expectedDocs);
});
test('it provides a full meta section when a configuration is present', async function () {
const pos: vscode.Position = new vscode.Position(2, 9);
const testConfig: Record<string,string> = {'author': 'test user', 'hash': ''};
await setTestConfig('metaEntries', testConfig, modifiedConfig);
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 4);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 4);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'meta'; });
assert.equal(item.label, 'meta');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a meta section (YARA)');
const rawInsertText = `meta:\n\tauthor = "${testConfig['author']}"\n\thash = "$1"`;
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString(rawInsertText);
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock(rawInsertText);
assert.deepEqual(item.documentation, expectedDocs);
});
test('it provides tabstops when empty configuration values are present', async function () {
const pos: vscode.Position = new vscode.Position(2, 9);
const testConfig: Record<string,string> = {'author': ''};
await setTestConfig('metaEntries', testConfig, modifiedConfig);
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 4);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 4);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'meta'; });
assert.equal(item.label, 'meta');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a meta section (YARA)');
const rawInsertText = `meta:\n\tauthor = "$1"`;
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString(rawInsertText);
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock(rawInsertText);
assert.deepEqual(item.documentation, expectedDocs);
});
test.skip('it provides support for snippet variables', async function () {
const pos: vscode.Position = new vscode.Position(2, 9);
const testConfig: Record<string,string> = {'filename': '${TM_FILENAME}'};
await setTestConfig('metaEntries', testConfig, modifiedConfig);
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 4);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 4);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'meta'; });
assert.equal(item.label, 'meta');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a meta section (YARA)');
const rawInsertText = `meta:\n\tfilename = "snippets.yar"`;
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString(rawInsertText);
// TODO: Figure out how to resolve the variable in insertText, since VSCode only does it when the snippet has been chosen
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock(rawInsertText);
assert.deepEqual(item.documentation, expectedDocs);
});
test('it does not provide entries with empty configuration keys', async function () {
const pos: vscode.Position = new vscode.Position(2, 9);
const testConfig: Record<string,string> = {'author': '', '': 'This should not show up'};
await setTestConfig('metaEntries', testConfig, modifiedConfig);
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 4);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 4);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'meta'; });
assert.equal(item.label, 'meta');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a meta section (YARA)');
const rawInsertText = `meta:\n\tauthor = "$1"`;
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString(rawInsertText);
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock(rawInsertText);
assert.deepEqual(item.documentation, expectedDocs);
});
test('it sorts the metadata keys when sort_meta is set to true', async function () {
const pos: vscode.Position = new vscode.Position(2, 9);
const testConfig: Record<string,string> = {'c': 'third', 'a': 'first', 'd': 'fourth', 'b': 'second'};
await setTestConfig('metaEntries', testConfig, modifiedConfig);
await setTestConfig('sortMeta', true, modifiedConfig);
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 4);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 4);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'meta'; });
assert.equal(item.label, 'meta');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a meta section (YARA)');
const rawInsertText = `meta:\n\ta = "first"\n\tb = "second"\n\tc = "third"\n\td = "fourth"`;
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString(rawInsertText);
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock(rawInsertText);
assert.deepEqual(item.documentation, expectedDocs);
});
test('it does not sort metadata keys when sort_meta is set to false', async function () {
const pos: vscode.Position = new vscode.Position(2, 9);
const testConfig: Record<string,string> = {'c': 'third', 'a': 'first', 'd': 'fourth', 'b': 'second'};
await setTestConfig('metaEntries', testConfig, modifiedConfig);
await setTestConfig('sortMeta', false, modifiedConfig);
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 4);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 4);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'meta'; });
assert.equal(item.label, 'meta');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a meta section (YARA)');
const rawInsertText = `meta:\n\tc = "third"\n\ta = "first"\n\td = "fourth"\n\tb = "second"`;
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString(rawInsertText);
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock(rawInsertText);
assert.deepEqual(item.documentation, expectedDocs);
});
});
suite('Rule Snippet', function () {
let modifiedConfig: vscode.WorkspaceConfiguration;
let uri: vscode.Uri;
setup(async function () {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
extension = vscode.extensions.getExtension(extensionId);
await extension.activate();
modifiedConfig = vscode.workspace.getConfiguration(configName);
uri = getWorkspacePath(extension.extensionUri, 'snippets.yar');
});
teardown(async function () {
await setTestConfig('snippets.rule', undefined, modifiedConfig);
});
test('it does not provide a rule snippet when the setting is false', async function () {
const pos: vscode.Position = new vscode.Position(2, 9);
await setTestConfig('snippets.rule', false, modifiedConfig);
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 0);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 3);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'rule'; });
assert.equal(item, undefined);
});
test('it provides a basic rule skeleton when not resolved', async function () {
const pos: vscode.Position = new vscode.Position(0, 4);
// don't resolve any completion items yet
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 0);
assert.equal(completions.isIncomplete, false);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'rule'; });
assert.equal(item.label, 'rule');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a rule skeleton (YARA)');
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString('rule ${1:$TM_FILENAME_BASE} {\n\t');
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock('rule NAME {');
assert.deepEqual(item.documentation, expectedDocs);
});
test('it provides all sections when resolved', async function () {
const pos: vscode.Position = new vscode.Position(0, 4);
await setTestConfig('metaEntries', {'author': '', 'date': '${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}'}, modifiedConfig);
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 4);
assert.equal(completions.isIncomplete, false);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'rule'; });
assert.equal(item.label, 'rule');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a rule skeleton (YARA)');
const rawSnippetText: string = [
'rule ${1:my_rule} {',
'\tmeta:',
'\t\tauthor = "$2"',
'\t\tdate = "${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}"',
'\tstrings:',
'\t\t\\$${3:name} = ${4|"string",/regex/,{ HEX \\}|}',
'\tcondition:',
'\t\t${5:any of them}',
'\\}',
''
].join('\n');
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString(rawSnippetText);
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock(rawSnippetText);
assert.deepEqual(item.documentation, expectedDocs);
});
});
suite('Strings Snippet', function () {
let modifiedConfig: vscode.WorkspaceConfiguration;
let uri: vscode.Uri;
setup(async function () {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
extension = vscode.extensions.getExtension(extensionId);
await extension.activate();
modifiedConfig = vscode.workspace.getConfiguration(configName);
uri = getWorkspacePath(extension.extensionUri, 'snippets.yar');
});
teardown(async function () {
await setTestConfig('snippets.strings', undefined, modifiedConfig);
});
test('it does not provide a strings snippet when the setting is false', async function () {
const pos: vscode.Position = new vscode.Position(2, 9);
await setTestConfig('snippets.strings', false, modifiedConfig);
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 0);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 3);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'strings'; });
assert.equal(item, undefined);
});
test('it provides a basic strings section when not resolved', async function () {
const pos: vscode.Position = new vscode.Position(3, 12);
// don't resolve any completion items yet
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 0);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 4);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'strings'; });
assert.equal(item.label, 'strings');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a strings section (YARA)');
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString('strings:\n\t$${1:name} = "${2:string}"');
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock('strings:\n\t$NAME = "STRING"');
assert.deepEqual(item.documentation, expectedDocs);
});
test('it provides a choice of strings when resolved', async function () {
const pos: vscode.Position = new vscode.Position(3, 12);
// don't resolve any completion items yet
const completions: vscode.CompletionList = await vscode.commands.executeCommand('vscode.executeCompletionItemProvider', uri, pos, null, 4);
assert.equal(completions.isIncomplete, false);
assert.equal(completions.items.length, 4);
const item: vscode.CompletionItem = completions.items.find((value: vscode.CompletionItem) => { return value.label === 'strings'; });
assert.equal(item.label, 'strings');
assert.equal(item.kind, vscode.CompletionItemKind.Snippet);
assert.equal(item.detail, 'Generate a strings section (YARA)');
const expectedInsertText: vscode.SnippetString = new vscode.SnippetString('strings:\n\t\\$${1:name} = ${2|"string",/regex/,{ HEX \\}|}');
assert.deepEqual(item.insertText, expectedInsertText);
const expectedDocs: vscode.MarkdownString = new vscode.MarkdownString('');
expectedDocs.appendCodeblock('strings:\n\t$NAME = "STRING"');
assert.deepEqual(item.documentation, expectedDocs);
});
});