Skip to content

Fix overlapping plugins/products build database access #7273

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 1 commit into from
Jan 19, 2024
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
13 changes: 10 additions & 3 deletions Sources/Build/BuildOperation.swift
Original file line number Diff line number Diff line change
Expand Up @@ -455,9 +455,16 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
let prebuildCommandResults: [ResolvedTarget.ID: [PrebuildCommandResult]]
// Invoke any build tool plugins in the graph to generate prebuild commands and build commands.
if let pluginConfiguration, !self.productsBuildParameters.shouldSkipBuilding {
// Hacky workaround for rdar://120560817, but it replicates precisely enough the original behavior before
// products/tools build parameters were split. Ideally we want to have specify the correct path at the time
// when `toolsBuildParameters` is initialized, but we have too many places in the codebase where that's
// done, which makes it hard to realign them all at once.
var pluginsBuildParameters = self.toolsBuildParameters
pluginsBuildParameters.dataPath = pluginsBuildParameters.dataPath.parentDirectory.appending(components: ["plugins", "tools"])
let buildOperationForPluginDependencies = BuildOperation(
productsBuildParameters: self.productsBuildParameters,
toolsBuildParameters: self.toolsBuildParameters,
// FIXME: this doesn't maintain the products/tools split cleanly
productsBuildParameters: pluginsBuildParameters,
toolsBuildParameters: pluginsBuildParameters,
cacheBuildManifest: false,
packageGraphLoader: { return graph },
additionalFileRules: self.additionalFileRules,
Expand All @@ -469,7 +476,7 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
)
buildToolPluginInvocationResults = try graph.invokeBuildToolPlugins(
outputDir: pluginConfiguration.workDirectory.appending("outputs"),
buildParameters: self.toolsBuildParameters,
buildParameters: pluginsBuildParameters,
additionalFileRules: self.additionalFileRules,
toolSearchDirectories: [self.toolsBuildParameters.toolchain.swiftCompilerPath.parentDirectory],
pkgConfigDirectories: self.pkgConfigDirectories,
Expand Down
25 changes: 25 additions & 0 deletions Tests/BuildTests/PluginsBuildPlanTests.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2024 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 Basics
import SPMTestSupport
import XCTest

final class PluginsBuildPlanTests: XCTestCase {
func testBuildToolsDatabasePath() throws {
try fixture(name: "Miscellaneous/Plugins/MySourceGenPlugin") { fixturePath in
let (stdout, stderr) = try executeSwiftBuild(fixturePath)
XCTAssertMatch(stdout, .contains("Build complete!"))
XCTAssertTrue(localFileSystem.exists(fixturePath.appending(RelativePath(".build/plugins/tools/build.db"))))
}
}
}