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

Always use unified testing binary #1049

Merged
merged 1 commit into from
Feb 25, 2025
Merged

Always use unified testing binary #1049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions src/TestExplorer/TestRunner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,7 @@ export class TestRunner {
fifoPipePath,
attachmentFolder
);
const testBuildConfig = await TestingConfigurationFactory.swiftTestingConfig(
const testBuildConfig = TestingConfigurationFactory.swiftTestingConfig(
this.folderContext,
swiftTestingArgs,
this.testKind,
Expand Down Expand Up @@ -612,7 +612,7 @@ export class TestRunner {
}

if (this.testArgs.hasXCTests) {
const testBuildConfig = await TestingConfigurationFactory.xcTestConfig(
const testBuildConfig = TestingConfigurationFactory.xcTestConfig(
this.folderContext,
this.testKind,
this.testArgs.xcTestArgs,
Expand Down Expand Up @@ -861,7 +861,7 @@ export class TestRunner {
attachmentFolder
);

const swiftTestBuildConfig = await TestingConfigurationFactory.swiftTestingConfig(
const swiftTestBuildConfig = TestingConfigurationFactory.swiftTestingConfig(
this.folderContext,
swiftTestingArgs,
this.testKind,
Expand Down Expand Up @@ -895,7 +895,7 @@ export class TestRunner {

// create launch config for testing
if (this.testArgs.hasXCTests) {
const xcTestBuildConfig = await TestingConfigurationFactory.xcTestConfig(
const xcTestBuildConfig = TestingConfigurationFactory.xcTestConfig(
this.folderContext,
this.testKind,
this.testArgs.xcTestArgs,
Expand Down
86 changes: 21 additions & 65 deletions src/debugger/buildConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,13 +186,13 @@ export class SwiftTestingConfigurationSetup {
* and `xcTestConfig` functions to create
*/
export class TestingConfigurationFactory {
public static async swiftTestingConfig(
public static swiftTestingConfig(
ctx: FolderContext,
buildArguments: SwiftTestingBuildAguments,
testKind: TestKind,
testList: string[],
expandEnvVariables = false
): Promise<vscode.DebugConfiguration | null> {
): vscode.DebugConfiguration | null {
return new TestingConfigurationFactory(
ctx,
testKind,
Expand All @@ -203,12 +203,12 @@ export class TestingConfigurationFactory {
).build();
}

public static async xcTestConfig(
public static xcTestConfig(
ctx: FolderContext,
testKind: TestKind,
testList: string[],
expandEnvVariables = false
): Promise<vscode.DebugConfiguration | null> {
): vscode.DebugConfiguration | null {
return new TestingConfigurationFactory(
ctx,
testKind,
Expand All @@ -219,11 +219,11 @@ export class TestingConfigurationFactory {
).build();
}

public static async testExecutableOutputPath(
public static testExecutableOutputPath(
ctx: FolderContext,
testKind: TestKind,
testLibrary: TestLibrary
): Promise<string> {
): string {
return new TestingConfigurationFactory(
ctx,
testKind,
Expand Down Expand Up @@ -251,7 +251,7 @@ export class TestingConfigurationFactory {
* - Test Kind (coverage, debugging)
* - Test Library (XCTest, swift-testing)
*/
private async build(): Promise<vscode.DebugConfiguration | null> {
private build(): vscode.DebugConfiguration | null {
if (!this.hasTestTarget) {
return null;
}
Expand All @@ -267,7 +267,7 @@ export class TestingConfigurationFactory {
}

/* eslint-disable no-case-declarations */
private async buildWindowsConfig(): Promise<vscode.DebugConfiguration | null> {
private buildWindowsConfig(): vscode.DebugConfiguration | null {
if (isDebugging(this.testKind)) {
const testEnv = {
...swiftRuntimeEnv(),
Expand All @@ -288,8 +288,8 @@ export class TestingConfigurationFactory {

return {
...this.baseConfig,
program: await this.testExecutableOutputPath(),
args: await this.debuggingTestExecutableArgs(),
program: this.testExecutableOutputPath(),
args: this.debuggingTestExecutableArgs(),
env: testEnv,
};
} else {
Expand All @@ -298,12 +298,12 @@ export class TestingConfigurationFactory {
}

/* eslint-disable no-case-declarations */
private async buildLinuxConfig(): Promise<vscode.DebugConfiguration | null> {
private buildLinuxConfig(): vscode.DebugConfiguration | null {
if (isDebugging(this.testKind) && this.testLibrary === TestLibrary.xctest) {
return {
...this.baseConfig,
program: await this.testExecutableOutputPath(),
args: await this.debuggingTestExecutableArgs(),
program: this.testExecutableOutputPath(),
args: this.debuggingTestExecutableArgs(),
env: {
...swiftRuntimeEnv(
process.env,
Expand All @@ -313,11 +313,11 @@ export class TestingConfigurationFactory {
},
};
} else {
return await this.buildDarwinConfig();
return this.buildDarwinConfig();
}
}

private async buildDarwinConfig(): Promise<vscode.DebugConfiguration | null> {
private buildDarwinConfig(): vscode.DebugConfiguration | null {
switch (this.testLibrary) {
case TestLibrary.swiftTesting:
switch (this.testKind) {
Expand Down Expand Up @@ -362,8 +362,8 @@ export class TestingConfigurationFactory {

const result = {
...this.baseConfig,
program: await this.testExecutableOutputPath(),
args: await this.debuggingTestExecutableArgs(),
program: this.testExecutableOutputPath(),
args: this.debuggingTestExecutableArgs(),
env: {
...this.testEnv,
...this.sanitizerRuntimeEnvironment,
Expand Down Expand Up @@ -631,45 +631,6 @@ export class TestingConfigurationFactory {
);
}

private swiftTestingOutputPath(): string {
return path.join(
this.buildDirectory,
this.artifactFolderForTestKind,
`${this.ctx.swiftPackage.name}PackageTests.swift-testing`
);
}

private buildDescriptionPath(): string {
return path.join(this.buildDirectory, this.artifactFolderForTestKind, "description.json");
}

private async isUnifiedTestingBinary(): Promise<boolean> {
// Toolchains that contain https://github.com/swiftlang/swift-package-manager/commit/844bd137070dcd18d0f46dd95885ef7907ea0697
// no longer produce a .swift-testing binary, instead we want to use `unifiedTestingOutputPath`.
// In order to determine if we're working with a unified binary we need to check if the .swift-testing
// binary was produced by the latest build. If it was then we are not using a unified binary.

// TODO: When Swift 6 is released and enough time has passed that we're sure no one is building the .swift-testing
// binary anymore this workaround can be removed and `swiftTestingPath` can be returned, and the build config
// generation can be made synchronous again.

try {
const buildDescriptionStr = await fs.readFile(this.buildDescriptionPath(), "utf-8");
const buildDescription = JSON.parse(buildDescriptionStr);
const testProducts = buildDescription.builtTestProducts as { binaryPath: string }[];
if (!testProducts) {
return false;
}
const testBinaryPaths = testProducts.map(({ binaryPath }) => binaryPath);
const swiftTestingBinaryRealPath = await fs.realpath(this.swiftTestingOutputPath());
return !testBinaryPaths.includes(swiftTestingBinaryRealPath);
} catch {
// If the .swift-testing binary wasn't produced by the latest build then we assume the
// swift-testing tests are in the unified binary.
return true;
}
}

private unifiedTestingOutputPath(): string {
// The unified binary that contains both swift-testing and XCTests
// is named the same as the old style .xctest binary. The swiftpm-testing-helper
Expand All @@ -686,24 +647,19 @@ export class TestingConfigurationFactory {
}
}

private async testExecutableOutputPath(): Promise<string> {
private testExecutableOutputPath(): string {
switch (this.testLibrary) {
case TestLibrary.swiftTesting:
return (await this.isUnifiedTestingBinary())
? this.unifiedTestingOutputPath()
: this.swiftTestingOutputPath();
return this.unifiedTestingOutputPath();
case TestLibrary.xctest:
return this.xcTestOutputPath();
}
}

private async debuggingTestExecutableArgs(): Promise<string[]> {
private debuggingTestExecutableArgs(): string[] {
switch (this.testLibrary) {
case TestLibrary.swiftTesting: {
const isUnifiedBinary = await this.isUnifiedTestingBinary();
const swiftTestingArgs = isUnifiedBinary
? ["--testing-library", "swift-testing"]
: [];
const swiftTestingArgs = ["--testing-library", "swift-testing"];

return this.addBuildOptionsToArgs(
this.addTestsToArgs(this.addSwiftTestingFlagsArgs(swiftTestingArgs))
Expand Down