Skip to content

Tests: Migrate PluginsBuildPlanTests to SwiftTesting and augment #9058

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

Merged
merged 1 commit into from
Sep 11, 2025
Merged

Tests: Migrate PluginsBuildPlanTests to SwiftTesting and augment #9058

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
4 changes: 3 additions & 1 deletion Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/Plugins/PluginScriptTarget/Script.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ import PackagePlugin
struct PluginScript: CommandPlugin {

func performCommand(context: PluginContext, arguments: [String]) async throws {
dump(context)
if !arguments.contains("--skip-dump") {
dump(context)
}
if let target = try context.package.targets(named: ["MySnippet"]).first as? SourceModuleTarget {
print("type of snippet target: \(target.kind)")
}
Expand Down
46 changes: 38 additions & 8 deletions Sources/_InternalTestSupport/SwiftTesting+Helpers.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,30 @@ import Testing

public func expectFileExists(
at path: AbsolutePath,
_ comment: Comment? = nil,
sourceLocation: SourceLocation = #_sourceLocation,
) {

let commentPrefix =
if let comment {
"\(comment): "
} else {
""
}
let msgSuffix: String
do {
msgSuffix = try "Directory contents: \(localFileSystem.getDirectoryContents(path.parentDirectory))"
} catch {
msgSuffix = ""
}
#expect(
localFileSystem.exists(path),
"Files '\(path)' does not exist.",
"\(commentPrefix)File '\(path)' does not exist. \(msgSuffix)",
sourceLocation: sourceLocation,
)
}

public func expectFileDoesNotExists(
at fixturePath: AbsolutePath,
at path: AbsolutePath,
_ comment: Comment? = nil,
sourceLocation: SourceLocation = #_sourceLocation,
) {
Expand All @@ -34,9 +46,15 @@ public func expectFileDoesNotExists(
} else {
""
}
let msgSuffix: String
do {
msgSuffix = try "Directory contents: \(localFileSystem.getDirectoryContents(path.parentDirectory))"
} catch {
msgSuffix = ""
}
#expect(
!localFileSystem.exists(fixturePath),
"\(commentPrefix)\(fixturePath) does not exist",
!localFileSystem.exists(path),
"\(commentPrefix)File: '\(path)' was not expected to exist, but does.\(msgSuffix))",
sourceLocation: sourceLocation,
)
}
Expand All @@ -54,7 +72,7 @@ public func expectFileIsExecutable(
}
#expect(
localFileSystem.isExecutableFile(fixturePath),
"\(commentPrefix)\(fixturePath) does not exist",
"\(commentPrefix)File '\(fixturePath)' expected to be executable, but is not.",
sourceLocation: sourceLocation,
)
}
Expand All @@ -63,9 +81,15 @@ public func expectDirectoryExists(
at path: AbsolutePath,
sourceLocation: SourceLocation = #_sourceLocation,
) {
let msgSuffix: String
do {
msgSuffix = try "Directory contents: \(localFileSystem.getDirectoryContents(path))"
} catch {
msgSuffix = ""
}
#expect(
localFileSystem.isDirectory(path),
"Expected directory doesn't exist: \(path)",
"Expected directory doesn't exist: '\(path)'. \(msgSuffix)",
sourceLocation: sourceLocation,
)
}
Expand All @@ -74,9 +98,15 @@ public func expectDirectoryDoesNotExist(
at path: AbsolutePath,
sourceLocation: SourceLocation = #_sourceLocation,
) {
let msgSuffix: String
do {
msgSuffix = try "Directory contents: \(localFileSystem.getDirectoryContents(path))"
} catch {
msgSuffix = ""
}
#expect(
!localFileSystem.isDirectory(path),
"Directory exists unexpectedly: \(path)",
"Directory exists unexpectedly: '\(path)'.\(msgSuffix)",
sourceLocation: sourceLocation,
)
}
Expand Down
204 changes: 147 additions & 57 deletions Tests/BuildTests/PluginsBuildPlanTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,91 +2,181 @@
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2024 Apple Inc. and the Swift project authors
// Copyright (c) 2014-2025 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import Foundation
import Basics
import _InternalTestSupport
@testable import SPMBuildCore
import XCTest
import PackageModel
import Testing
import _InternalTestSupport

final class PluginsBuildPlanTests: XCTestCase {
func testBuildToolsDatabasePath() async throws {
try XCTSkipOnWindows(because: "Fails to build the project to due to incorrect Path handling. Possibly related to https://github.com/swiftlang/swift-package-manager/issues/8511")
@testable import SPMBuildCore

try await fixtureXCTest(name: "Miscellaneous/Plugins/MySourceGenPlugin") { fixturePath in
let (stdout, _) = try await executeSwiftBuild(fixturePath, buildSystem: .native)
XCTAssertMatch(stdout, .contains("Build complete!"))
@Suite(
.serialized,
.tags(
.TestSize.large,
),
)
struct PluginsBuildPlanTests {
@Test(
.tags(
.Feature.Command.Build,
),
.issue("https://github.com/swiftlang/swift-package-manager/issues/8511", relationship: .defect), // Fails to build the project to due to incorrect Path handling
arguments: BuildConfiguration.allCases,
)
func buildToolsDatabasePath(
config: BuildConfiguration,
) async throws {
try await withKnownIssue(isIntermittent: true) {
try await fixture(name: "Miscellaneous/Plugins/MySourceGenPlugin") { fixturePath in
let (stdout, _) = try await executeSwiftBuild(
fixturePath,
configuration: config,
buildSystem: .native
)
#expect(stdout.contains("Build complete!"))
// FIXME: This is temporary until build of plugin tools is extracted into its own command.
XCTAssertTrue(localFileSystem.exists(fixturePath.appending(RelativePath(".build/plugin-tools.db"))))
XCTAssertTrue(localFileSystem.exists(fixturePath.appending(RelativePath(".build/build.db"))))
#expect(localFileSystem.exists(fixturePath.appending(RelativePath(".build/plugin-tools.db"))))
#expect(localFileSystem.exists(fixturePath.appending(RelativePath(".build/build.db"))))
}
} when: {
ProcessInfo.hostOperatingSystem == .windows
}
}

func testCommandPluginDependenciesWhenCrossCompiling() async throws {
// Command Plugin dependencies must be built for the host.
// This test is only supported on macOS because that is the only
// platform on which we can currently be sure of having a viable
// cross-compilation environment (arm64->x86_64 or vice versa).
// On Linux it is typically only possible to build for the host
// environment unless cross-compilation SDKs are being used.
#if !os(macOS)
try XCTSkipIf(true, "test is only supported on macOS")
#endif

let hostToolchain = try UserToolchain(swiftSDK: .hostSwiftSDK(environment: [:]), environment: [:])
@Test(
.serialized,
.tags(
.Feature.Command.Package.CommandPlugin,
),
.requireHostOS(.macOS),
arguments: getBuildData(for: SupportedBuildSystemOnAllPlatforms),
)
func commandPluginDependenciesWhenNotCrossCompiling(
buildData: BuildData,
) async throws {
let hostToolchain = try UserToolchain(
swiftSDK: .hostSwiftSDK(environment: [:]),
environment: [:]
)
let hostTriple = try! hostToolchain.targetTriple.withoutVersion().tripleString

let x86Triple = "x86_64-apple-macosx"
let armTriple = "arm64-apple-macosx"
let targetTriple = hostToolchain.targetTriple.arch == .aarch64 ? x86Triple : armTriple

let hostBinPathSegments = try buildData.buildSystem.binPath(
for: buildData.config,
triple: hostTriple,
)
let hostDebugBinPathSegments = try buildData.buildSystem.binPath(
for: .debug,
triple: hostTriple,
)
// By default, plugin dependencies are built for the host platform
try await fixtureXCTest(name: "Miscellaneous/Plugins/CommandPluginTestStub") { fixturePath in
try await fixture(name: "Miscellaneous/Plugins/CommandPluginTestStub") { fixturePath in
let hostBinPath: AbsolutePath = fixturePath.appending(components: hostBinPathSegments)
let hostDebugBinPath: AbsolutePath = fixturePath.appending(components: hostDebugBinPathSegments)
let (stdout, stderr) = try await executeSwiftPackage(
fixturePath,
configuration: buildData.config,
extraArgs: ["-v", "build-plugin-dependency"],
buildSystem: .native,
)
XCTAssertMatch(stdout, .contains("Hello from dependencies-stub"))
XCTAssertMatch(stderr, .contains("Build of product 'plugintool' complete!"))
XCTAssertTrue(
localFileSystem.exists(
fixturePath.appending(RelativePath(".build/\(hostTriple)/debug/plugintool-tool"))
)
)
XCTAssertTrue(
localFileSystem.exists(
fixturePath.appending(RelativePath(".build/\(hostTriple)/debug/placeholder"))
)
buildSystem: buildData.buildSystem,
)
#expect(stdout.contains("Hello from dependencies-stub"))
if buildData.buildSystem == .native {
#expect(stderr.contains("Build of product 'plugintool' complete!"))
}
let pluginToolName: String
switch buildData.buildSystem {
case .native:
pluginToolName = "plugintool-tool"
case .swiftbuild:
pluginToolName = "plugintool"
case .xcode:
pluginToolName = ""
Issue.record("Test has not been updated for this build system")
}
expectFileExists(at: hostBinPath.appending(pluginToolName))
expectFileExists(at: hostDebugBinPath.appending("placeholder"))
}
}

@Test(
.serialized,
.tags(
.Feature.Command.Package.CommandPlugin,
),
.requireHostOS(.macOS),
arguments: getBuildData(for: SupportedBuildSystemOnAllPlatforms),
)
func commandPluginDependenciesWhenCrossCompiling(
buildData: BuildData,
) async throws {
let hostToolchain = try UserToolchain(
swiftSDK: .hostSwiftSDK(environment: [:]),
environment: [:]
)
// let hostTriple = try! hostToolchain.targetTriple.withoutVersion().tripleString
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: was this accidentally left in?


let x86Triple = "x86_64-apple-macosx"
let armTriple = "arm64-apple-macosx"
let targetTriple = hostToolchain.targetTriple.arch == .aarch64 ? x86Triple : armTriple

let hostBinPathSegments = try buildData.buildSystem.binPath(
for: buildData.config,
)
let targetDebugBinPathSegments = try buildData.buildSystem.binPath(
for: .debug,
triple: targetTriple,
)

// When cross compiling the final product, plugin dependencies should still be built for the host
try await fixtureXCTest(name: "Miscellaneous/Plugins/CommandPluginTestStub") { fixturePath in
let (stdout, stderr) = try await executeSwiftPackage(
fixturePath,
extraArgs: ["--triple", targetTriple, "-v", "build-plugin-dependency"],
buildSystem: .native,
)
XCTAssertMatch(stdout, .contains("Hello from dependencies-stub"))
XCTAssertMatch(stderr, .contains("Build of product 'plugintool' complete!"))
XCTAssertTrue(
localFileSystem.exists(
fixturePath.appending(RelativePath(".build/\(hostTriple)/debug/plugintool-tool"))
try await fixture(name: "Miscellaneous/Plugins/CommandPluginTestStub") { fixturePath in
// let hostBinPath: AbsolutePath = fixturePath.appending(components: hostBinPathSegments)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: same as above

let targetDebugBinPath: AbsolutePath = fixturePath.appending(components: targetDebugBinPathSegments)
let hostBinPath = try fixturePath.appending(
components: buildData.buildSystem.binPath(
for: buildData.config,
)
)
XCTAssertTrue(
localFileSystem.exists(
fixturePath.appending(RelativePath(".build/\(targetTriple)/debug/placeholder"))
let targetBinPath = try fixturePath.appending(
components: buildData.buildSystem.binPath(
for: buildData.config,
triple: targetTriple,
)
)
let (stdout, stderr) = try await executeSwiftPackage(
fixturePath,
configuration: buildData.config,
extraArgs: ["-v", "--triple", targetTriple, "build-plugin-dependency"],
buildSystem: buildData.buildSystem,
)
#expect(stdout.contains("Hello from dependencies-stub"))
if buildData.buildSystem == .native {
#expect(stderr.contains("Build of product 'plugintool' complete!"))
}
let pluginToolName: String
let pluginToolBinPath: AbsolutePath
switch buildData.buildSystem {
case .native:
pluginToolName = "plugintool-tool"
pluginToolBinPath = hostBinPath
case .swiftbuild:
pluginToolName = "plugintool"
pluginToolBinPath = targetBinPath
case .xcode:
pluginToolName = ""
pluginToolBinPath = AbsolutePath("/")
Issue.record("Test has not been updated for this build system")
}

expectFileExists(at: targetDebugBinPath.appending("placeholder"))
expectFileExists(at: pluginToolBinPath.appending(pluginToolName))
}
}

}
22 changes: 7 additions & 15 deletions Tests/FunctionalTests/PluginTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1347,25 +1347,17 @@ final class PluginTests {
.bug("https://github.com/swiftlang/swift-package-manager/issues/8774"),
.bug("https://github.com/swiftlang/swift-package-manager/issues/8602"),
.requiresSwiftConcurrencySupport,
arguments: getBuildData(for: SupportedBuildSystemOnAllPlatforms),
)
func testSnippetSupport() async throws {
try await fixture(name: "Miscellaneous/Plugins") { path in
let (stdout, stderr) = try await executeSwiftPackage(
path.appending("PluginsAndSnippets"),
configuration: .debug,
extraArgs: ["do-something"],
buildSystem: .native,
)
#expect(stdout.contains("type of snippet target: snippet"), "output:\n\(stderr)\n\(stdout)")
}

// Try again with the Swift Build build system
func testSnippetSupport(
buildData: BuildData,
) async throws {
try await fixture(name: "Miscellaneous/Plugins") { path in
let (stdout, stderr) = try await executeSwiftPackage(
path.appending("PluginsAndSnippets"),
configuration: .debug,
extraArgs: ["--build-system", "swiftbuild", "do-something"],
buildSystem: .native,
configuration: buildData.config,
extraArgs: ["do-something", "--skip-dump"],
buildSystem: buildData.buildSystem,
)
#expect(stdout.contains("type of snippet target: snippet"), "output:\n\(stderr)\n\(stdout)")
}
Expand Down