aboutsummaryrefslogtreecommitdiff
path: root/tests/drivers/vscode_hover_test.js
blob: 8239afd0541ebf6176ecb3712024d064009eabe8 (plain) (blame)
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
// run inside a vscode extension test host to check the real hover api objects.
const assert = require('assert');
const fs = require('fs');
const path = require('path');
const vscode = require('vscode');
exports.run = async () => {
    const root = path.resolve(__dirname, '..', '..');
    const fixture = path.join(root, 'build', 'review', 'hover-fixture.zc');
    fs.mkdirSync(path.dirname(fixture), { recursive: true });
    fs.writeFileSync(fixture, '// adds **two** numbers with `integer` arithmetic.\nint add(int a, int b) { return a + b; }\nfn main() { return add(1, 2); }\n');
    const extension = vscode.extensions.getExtension('tinyvm.zc-language-support');
    assert.ok(extension, 'development extension is loaded');
    const doc = await vscode.workspace.openTextDocument(fixture);
    await vscode.window.showTextDocument(doc);
    await extension.activate();
    let hover;
    for (let attempt = 0; attempt < 100; attempt++) {
        const replies = await vscode.commands.executeCommand('vscode.executeHoverProvider', doc.uri, new vscode.Position(2, 19));
        hover = replies && replies.find(reply => reply.contents.some(md => md.value.includes('adds **two** numbers')));
        if (hover) break;
        await new Promise(resolve => setTimeout(resolve, 100));
    }
    assert.ok(hover, 'real vscode provider returns declaration documentation');
    const md = hover.contents[0];
    assert.ok(md instanceof vscode.MarkdownString, 'hover contains a real MarkdownString');
    assert.match(md.value, /^```zc\nint add\(int a, int b\)\n```\n\n/);
    assert.ok(md.value.includes('**two**') && md.value.includes('`integer`'));
    assert.strictEqual(md.isTrusted, false);
    const storageFile = path.join(root, 'build', 'review', 'hover-storage.zc');
    fs.writeFileSync(storageFile, 'include rt; unchecked fn main() {\n let p = rt.new(int, 3);\n let /* borrowed array */ q = p;\n rt.free(p);\n return q[0];\n}\n');
    const storageDoc = await vscode.workspace.openTextDocument(storageFile);
    await vscode.window.showTextDocument(storageDoc);
    let storageHover;
    for (let attempt = 0; attempt < 100; attempt++) {
        const replies = await vscode.commands.executeCommand('vscode.executeHoverProvider', storageDoc.uri, new vscode.Position(4, 8));
        storageHover = replies && replies.find(reply => reply.contents.some(md => md.value.includes('size: 3 elements')));
        if (storageHover) break;
        await new Promise(resolve => setTimeout(resolve, 100));
    }
    assert.ok(storageHover, 'real editor returns storage metadata');
    const storageMd = storageHover.contents[0];
    assert.ok(storageMd instanceof vscode.MarkdownString);
    assert.match(storageMd.value, /borrowed array/);
    assert.match(storageMd.value, /lifetime: ended on line 4/);
    const valueFile = path.join(root, 'build', 'review', 'hover-values.zc');
    fs.writeFileSync(valueFile, 'include rt; fn unknown() { return 9; }\nfn main() {\n int count = 42;\n rt.put_n(count);\n count = unknown();\n return count;\n}\n');
    const valueDoc = await vscode.workspace.openTextDocument(valueFile);
    await vscode.window.showTextDocument(valueDoc);
    let valueHover;
    for (let attempt = 0; attempt < 100; attempt++) {
        const replies = await vscode.commands.executeCommand('vscode.executeHoverProvider', valueDoc.uri, new vscode.Position(3, 11));
        valueHover = replies && replies.find(reply => reply.contents.some(md => md.value.includes('value at this position:')));
        if (valueHover) break;
        await new Promise(resolve => setTimeout(resolve, 100));
    }
    assert.ok(valueHover, 'real editor returns a known value before the unknown assignment');
    assert.ok(valueHover.contents[0] instanceof vscode.MarkdownString);
    assert.match(valueHover.contents[0].value, /value at this position:\n```zc\n42\n```/);
    const unknownHover = await vscode.commands.executeCommand('vscode.executeHoverProvider', valueDoc.uri, new vscode.Position(5, 8));
    assert.ok(unknownHover.length, 'the later variable still has a type hover');
    assert.ok(!unknownHover.some(reply => reply.contents.some(md => md.value.includes('value at this position:'))));
    const result = 'ok   real vscode markdown, code fences, block docs, inferred types, lifetime metadata, and position-aware values\n';
    fs.writeFileSync(path.join(root, 'build', 'review', 'vscode-hover.log'), result);
    console.log(result.trim());
};