Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added test for signature help #2117

Merged
merged 3 commits into from
Mar 19, 2018
Merged

Added test for signature help #2117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
78b50ce
Added parameter
akshita31 Mar 19, 2018
4ffbfa9
modifications
akshita31 Mar 19, 2018
05c6840
Cleaned up tests
akshita31 Mar 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 30 additions & 30 deletions test/integrationTests/signatureHelp.integration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,59 +35,59 @@ suite(`SignatureHelp: ${testAssetWorkspace.description}`, function () {
await vscode.commands.executeCommand("vscode.open", fileUri);
});


test("Returns response with documentation as undefined when method does not have documentation", async function () {
let c = <vscode.SignatureHelp>await vscode.commands.executeCommand("vscode.executeSignatureHelpProvider", fileUri, new vscode.Position(19, 23));
let c = await GetSignatureHelp(fileUri, new vscode.Position(19, 23));
expect(c.signatures[0].documentation).to.be.undefined;
});

test("Returns label when method does not have documentation", async function () {
let c = <vscode.SignatureHelp>await vscode.commands.executeCommand("vscode.executeSignatureHelpProvider", fileUri, new vscode.Position(19, 23));
let answer = `void sigHelp.noDocMethod()`;
expect(c.signatures[0].label).to.equal(answer);
let c = await GetSignatureHelp(fileUri, new vscode.Position(19, 23));
expect(c.signatures[0].label).to.equal(`void sigHelp.noDocMethod()`);
});

test("Returns summary as documentation for the method", async function () {
let c = <vscode.SignatureHelp>await vscode.commands.executeCommand("vscode.executeSignatureHelpProvider", fileUri, new vscode.Position(18, 18));
let answer = `DoWork is some method.`;
expect(c.signatures[0].documentation).to.equal(answer);
let c = await GetSignatureHelp(fileUri, new vscode.Position(18, 18));
expect(c.signatures[0].documentation).to.equal(`DoWork is some method.`);
});

test("Returns label for the method", async function () {
let c = <vscode.SignatureHelp>await vscode.commands.executeCommand("vscode.executeSignatureHelpProvider", fileUri, new vscode.Position(18, 18));
let answer = `void sigHelp.DoWork(int Int1, float Float1)`;
expect(c.signatures[0].label).to.equal(answer);
let c = await GetSignatureHelp(fileUri, new vscode.Position(18, 18));
expect(c.signatures[0].label).to.equal(`void sigHelp.DoWork(int Int1, float Float1, double Double1)`);
});

test("Returns label for the parameters", async function () {
let c = <vscode.SignatureHelp>await vscode.commands.executeCommand("vscode.executeSignatureHelpProvider", fileUri, new vscode.Position(18, 18));
let param1 = `int Int1`;
let param2 = `float Float1`;
expect(c.signatures[0].parameters[0].label).to.equal(param1);
expect(c.signatures[0].parameters[1].label).to.equal(param2);
let c = await GetSignatureHelp(fileUri, new vscode.Position(18, 18));
expect(c.signatures[0].parameters[0].label).to.equal(`int Int1`);
expect(c.signatures[0].parameters[1].label).to.equal(`float Float1`);
});

test("Returns documentation for the parameters", async function () {
let c = <vscode.SignatureHelp>await vscode.commands.executeCommand("vscode.executeSignatureHelpProvider", fileUri, new vscode.Position(18, 18));
let param1 = `**Int1**: Used to indicate status.`;
let param2 = `**Float1**: Used to specify context.`;
expect((<vscode.MarkdownString> c.signatures[0].parameters[0].documentation).value).to.equal(param1);
expect((<vscode.MarkdownString> c.signatures[0].parameters[1].documentation).value).to.equal(param2);
let c = await GetSignatureHelp(fileUri, new vscode.Position(18, 18));
expect((<vscode.MarkdownString>c.signatures[0].parameters[0].documentation).value).to.equal(`**Int1**: Used to indicate status.`);
expect((<vscode.MarkdownString>c.signatures[0].parameters[1].documentation).value).to.equal(`**Float1**: Used to specify context.`);
});

test("Signature Help identifies active parameter if there is no comma", async function () {
let c = <vscode.SignatureHelp>await vscode.commands.executeCommand("vscode.executeSignatureHelpProvider", fileUri, new vscode.Position(18, 18));
let answer = `int Int1`;
expect(c.signatures[0].parameters[c.activeParameter].label).to.equal(answer);
let c = await GetSignatureHelp(fileUri, new vscode.Position(18, 18));
expect(c.signatures[0].parameters[c.activeParameter].label).to.equal(`int Int1`);
});

test("Signature Help identifies active parameter based on comma", async function () {
let c = <vscode.SignatureHelp>await vscode.commands.executeCommand("vscode.executeSignatureHelpProvider", fileUri, new vscode.Position(18, 20));
let answer = `float Float1`;
expect(c.signatures[0].parameters[c.activeParameter].label).to.equal(answer);
let c = await GetSignatureHelp(fileUri, new vscode.Position(18, 20));
expect(c.signatures[0].parameters[c.activeParameter].label).to.equal(`float Float1`);
});

suiteTeardown(async () => {
await testAssetWorkspace.cleanupWorkspace();
test("Signature Help identifies active parameter based on comma for multiple commas", async function () {
let c = await GetSignatureHelp(fileUri, new vscode.Position(18, 27));
expect(c.signatures[0].parameters[c.activeParameter].label).to.equal(`double Double1`);
});
});
});

suiteTeardown(async () => {
await testAssetWorkspace.cleanupWorkspace();
});

async function GetSignatureHelp(fileUri: vscode.Uri, position: vscode.Position) {
return <vscode.SignatureHelp>await vscode.commands.executeCommand("vscode.executeSignatureHelpProvider", fileUri, position);
}
4 changes: 2 additions & 2 deletions test/integrationTests/testAssets/singleCsproj/sigHelp.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ class sigHelp
///<summary>DoWork is some method.</summary>
/// <param name="Int1">Used to indicate status.</param>
/// <param name="Float1">Used to specify context.</param>
public static void DoWork(int Int1, float Float1)
public static void DoWork(int Int1, float Float1, double Double1)
{
}

Expand All @@ -16,7 +16,7 @@ public static void noDocMethod()

public static void main()
{
DoWork(4, 4.0f);
DoWork(4, 4.0f, 5.0);
noDocMethod();
}
}
Expand Down
4 changes: 2 additions & 2 deletions test/integrationTests/testAssets/slnWithCsproj/src/app/sigHelp.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ class sigHelp
///<summary>DoWork is some method.</summary>
/// <param name="Int1">Used to indicate status.</param>
/// <param name="Float1">Used to specify context.</param>
public static void DoWork(int Int1, float Float1)
public static void DoWork(int Int1, float Float1, double Double1)
{
}

Expand All @@ -16,7 +16,7 @@ public static void noDocMethod()

public static void main()
{
DoWork(4, 4.0f);
DoWork(4, 4.0f, 5.0);
noDocMethod();
}
}
Expand Down