From 74006b2db922bf3371018ed009336112c54e3c3c Mon Sep 17 00:00:00 2001 From: Edoardo Pirovano Date: Thu, 18 Mar 2021 18:37:52 +0000 Subject: [PATCH 1/2] Report description for test failure when possible --- extensions/ql-vscode/src/cli.ts | 1 + extensions/ql-vscode/src/test-adapter.ts | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/extensions/ql-vscode/src/cli.ts b/extensions/ql-vscode/src/cli.ts index fb7155e2d95..189f5cca1e6 100644 --- a/extensions/ql-vscode/src/cli.ts +++ b/extensions/ql-vscode/src/cli.ts @@ -104,6 +104,7 @@ export interface TestCompleted { evaluationMs: number; expected: string; diff: string[] | undefined; + failureDescription?: string; } /** diff --git a/extensions/ql-vscode/src/test-adapter.ts b/extensions/ql-vscode/src/test-adapter.ts index e0f94a16f4f..44f33c90d8e 100644 --- a/extensions/ql-vscode/src/test-adapter.ts +++ b/extensions/ql-vscode/src/test-adapter.ts @@ -223,8 +223,8 @@ export class QLTestAdapter extends DisposableObject implements TestAdapter { ? 'errored' : 'failed'; let message: string | undefined; - if (event.diff?.length) { - message = ['', `${state}: ${event.test}`, ...event.diff, ''].join('\n'); + if (event.failureDescription || event.diff?.length) { + message = ['', `${state}: ${event.test}`, event.failureDescription || event.diff?.join('\n'), ''].join('\n'); testLogger.log(message); } this._testStates.fire({ From 9e9c8ed2d5e67f29a90919c755b4bef43c1d998b Mon Sep 17 00:00:00 2001 From: Andrew Eisenberg Date: Fri, 19 Mar 2021 08:51:13 -0700 Subject: [PATCH 2/2] Update Changelog --- extensions/ql-vscode/CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/extensions/ql-vscode/CHANGELOG.md b/extensions/ql-vscode/CHANGELOG.md index f425efe592b..9b1493b90a7 100644 --- a/extensions/ql-vscode/CHANGELOG.md +++ b/extensions/ql-vscode/CHANGELOG.md @@ -10,6 +10,7 @@ - Add a configuration option to pass additional arguments to the CLI when running tests. [#785](https://github.com/github/vscode-codeql/pull/785) - Introduce option to view query results as CSV. [#784](https://github.com/github/vscode-codeql/pull/784) - Add some snippets for commonly used QL statements. [#780](https://github.com/github/vscode-codeql/pull/780) +- More descriptive error messages on QL test failures. [#788](https://github.com/github/vscode-codeql/pull/788) ## 1.4.3 - 22 February 2021