Skip to content

Mark tests as skipped when they fail to compile #1659

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.

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

Merged
merged 5 commits into from
Jun 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- Make sure newline starts with /// when splitting doc comment ([#1651](https://github.com/swiftlang/vscode-swift/pull/1651))
- Prevent continuous "package resolve" cycles ([#1654](https://github.com/swiftlang/vscode-swift/pull/1654))
- Fix error when running `Reset Package Dependencies` command from the Project view ([#1661](https://github.com/swiftlang/vscode-swift/pull/1661))
- Mark tests as skipped when a compilation error preempts a test run ([#1659](https://github.com/swiftlang/vscode-swift/pull/1659))

## 2.6.0 - 2025-06-26

Expand Down
58 changes: 55 additions & 3 deletions src/TestExplorer/TestRunner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,12 @@ import * as stream from "stream";
import * as os from "os";
import * as asyncfs from "fs/promises";
import { FolderContext } from "../FolderContext";
import { compactMap, execFile, getErrorDescription } from "../utilities/utilities";
import {
compactMap,
execFile,
getErrorDescription,
IS_PRODUCTION_BUILD,
} from "../utilities/utilities";
import { createSwiftTask } from "../tasks/SwiftTaskProvider";
import configuration from "../configuration";
import { WorkspaceContext } from "../WorkspaceContext";
Expand Down Expand Up @@ -67,6 +72,7 @@ export interface TestRunState {
passed: vscode.TestItem[];
skipped: vscode.TestItem[];
errored: vscode.TestItem[];
enqueued: vscode.TestItem[];
unknown: number;
output: string[];
}
Expand Down Expand Up @@ -95,6 +101,7 @@ export class TestRunProxy {
passed: [],
skipped: [],
errored: [],
enqueued: [],
unknown: 0,
output: [],
};
Expand Down Expand Up @@ -181,10 +188,9 @@ export class TestRunProxy {
for (const outputLine of this.queuedOutput) {
this.performAppendOutput(this.testRun, outputLine);
}
this.queuedOutput = [];

for (const test of this.testItems) {
this.testRun.enqueued(test);
this.enqueued(test);
}
};

Expand Down Expand Up @@ -218,11 +224,17 @@ export class TestRunProxy {
}
}

private enqueued(test: vscode.TestItem) {
this.testRun?.enqueued(test);
this.runState.enqueued.push(test);
}

public unknownTestRan() {
this.runState.unknown++;
}

public started(test: vscode.TestItem) {
this.clearEnqueuedTest(test);
this.runState.pending.push(test);
this.testRun?.started(test);
}
Expand All @@ -231,7 +243,29 @@ export class TestRunProxy {
this.runState.pending = this.runState.pending.filter(t => t !== test);
}

private clearEnqueuedTest(test: vscode.TestItem) {
if (IS_PRODUCTION_BUILD) {
// `runState.enqueued` exists only for test validation purposes.
return;
}

this.runState.enqueued = this.runState.enqueued.filter(t => t !== test);

if (!test.parent) {
return;
}

const parentHasEnqueuedChildren = Array.from(test.parent.children).some(([_, child]) =>
this.runState.enqueued.includes(child)
);

if (!parentHasEnqueuedChildren) {
this.clearEnqueuedTest(test.parent);
}
}

public skipped(test: vscode.TestItem) {
this.clearEnqueuedTest(test);
test.tags = [...test.tags, new vscode.TestTag(TestRunProxy.Tags.SKIPPED)];

this.runState.skipped.push(test);
Expand All @@ -240,6 +274,7 @@ export class TestRunProxy {
}

public passed(test: vscode.TestItem, duration?: number) {
this.clearEnqueuedTest(test);
this.runState.passed.push(test);
this.clearPendingTest(test);
this.testRun?.passed(test, duration);
Expand All @@ -250,6 +285,7 @@ export class TestRunProxy {
message: vscode.TestMessage | readonly vscode.TestMessage[],
duration?: number
) {
this.clearEnqueuedTest(test);
this.runState.failed.push({ test, message });
this.clearPendingTest(test);
this.testRun?.failed(test, message, duration);
Expand All @@ -260,6 +296,7 @@ export class TestRunProxy {
message: vscode.TestMessage | readonly vscode.TestMessage[],
duration?: number
) {
this.clearEnqueuedTest(test);
this.runState.errored.push(test);
this.clearPendingTest(test);
this.testRun?.errored(test, message, duration);
Expand All @@ -278,6 +315,21 @@ export class TestRunProxy {
this.failed(test, new vscode.TestMessage("Test did not complete."));
});

// If there are tests that never started, mark them as skipped.
// This can happen if there is a build error preventing tests from running.
this.runState.enqueued.forEach(test => {
// Omit adding the root test item as a skipped test to keep just the suites/tests
// in the test run output, just like a regular pass/fail test run.
if (test.parent) {
for (const output of this.queuedOutput) {
this.appendOutputToTest(output, test);
}
this.skipped(test);
}
});

this.queuedOutput = [];

this.reportAttachments();
this.testRun?.end();
this.testRunCompleteEmitter.fire();
Expand Down
3 changes: 3 additions & 0 deletions test/integration-tests/testexplorer/utilities.ts
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ export function assertTestResults(
passed?: string[];
skipped?: string[];
errored?: string[];
enqueued?: string[];
unknown?: number;
}
) {
Expand All @@ -161,6 +162,7 @@ export function assertTestResults(
.sort(),
skipped: testRun.runState.skipped.map(({ id }) => id).sort(),
errored: testRun.runState.errored.map(({ id }) => id).sort(),
enqueued: testRun.runState.enqueued.map(({ id }) => id).sort(),
unknown: testRun.runState.unknown,
},
{
Expand All @@ -173,6 +175,7 @@ export function assertTestResults(
.sort(),
skipped: (state.skipped ?? []).sort(),
errored: (state.errored ?? []).sort(),
enqueued: (state.enqueued ?? []).sort(),
unknown: 0,
},
`
Expand Down