Merge remote-tracking branch 'origin/main' into maxd/test-toolchain-argument

Author: xedin

CODEOWNERS

@@ -26,4 +26,4 @@
 
 Sources/XCBuildSupport/* @jakepetroules
 
-* @bnbarham @MaxDesiatov @tomerd
+* @bnbarham @MaxDesiatov @jakepetroules @francescomikulis

Examples/package-info/Package.swift

@@ -0,0 +1,25 @@
+// swift-tools-version:5.5
+
+import PackageDescription
+
+let package = Package(
+    name: "package-info",
+    platforms: [
+        .macOS(.v12),
+        .iOS(.v13)
+    ],
+    dependencies: [
+        // This just points to the SwiftPM at the root of this repository.
+        .package(name: "swift-package-manager", path: "../../"),
+        // You will want to depend on a stable semantic version instead:
+        // .package(url: "https://github.com/apple/swift-package-manager", .exact("0.4.0"))
+    ],
+    targets: [
+        .executableTarget(
+            name: "package-info",
+            dependencies: [
+                .product(name: "SwiftPM", package: "swift-package-manager")
+            ]
+        ),
+    ]
+)

Examples/package-info/README.md

@@ -0,0 +1,3 @@
+# package-info
+
+Sample package built on top of libSwiftPM.

Examples/package-info/Sources/package-info/example.swift

@@ -0,0 +1,49 @@
+import Basics
+import Workspace
+
+@main
+@available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
+struct Example {
+    static func main() async throws {
+        // PREREQUISITES
+        // ============
+
+        // We need a package to work with.
+        // This computes the path of this package root based on the file location
+        let packagePath = try AbsolutePath(validating: #file).parentDirectory.parentDirectory.parentDirectory
+
+        // LOADING
+        // =======
+
+        // There are several levels of information available.
+        // Each takes longer to load than the level above it, but provides more detail.
+
+        let observability = ObservabilitySystem({ print("\($0): \($1)") })
+
+        let workspace = try Workspace(forRootPackage: packagePath)
+
+        let manifest = try await workspace.loadRootManifest(at: packagePath, observabilityScope: observability.topScope)
+
+        let package = try await workspace.loadRootPackage(at: packagePath, observabilityScope: observability.topScope)
+
+        let graph = try workspace.loadPackageGraph(rootPath: packagePath, observabilityScope: observability.topScope)
+        
+        // EXAMPLES
+        // ========
+
+        // Manifest
+        let products = manifest.products.map({ $0.name }).joined(separator: ", ")
+        print("Products:", products)
+
+        let targets = manifest.targets.map({ $0.name }).joined(separator: ", ")
+        print("Targets:", targets)
+
+        // Package
+        let executables = package.targets.filter({ $0.type == .executable }).map({ $0.name })
+        print("Executable targets:", executables)
+
+        // PackageGraph
+        let numberOfFiles = graph.reachableTargets.reduce(0, { $0 + $1.sources.paths.count })
+        print("Total number of source files (including dependencies):", numberOfFiles)
+    }
+}

Fixtures/Miscellaneous/Plugins/DependentPlugins/Package.swift

@@ -10,15 +10,15 @@ let package = Package(
     targets: [
         .executableTarget(name: "MyExecutable"),
         .executableTarget(name: "MyExecutable2"),
-        
+
         .plugin(
             name: "MyPlugin",
             capability: .buildTool(),
             dependencies: [
                 "MyExecutable"
             ]
         ),
-        
+
         .plugin(
             name: "MyPlugin2",
             capability: .buildTool(),
@@ -34,5 +34,6 @@ let package = Package(
                 "MyPlugin2",
             ]
         ),
-    ]
+    ],
+    swiftLanguageVersions: [.v5]
 )

Fixtures/Miscellaneous/Plugins/MyBuildToolPluginDependencies/Sources/MySourceGenBuildTool/main.swift

@@ -13,6 +13,6 @@ let variableName = URL(fileURLWithPath: inputFile).deletingPathExtension().lastP
 
 let inputData = FileManager.default.contents(atPath: inputFile) ?? Data()
 let dataAsHex = inputData.map { String(format: "%02hhx", $0) }.joined()
-let outputString = "public var \(variableName) = \(dataAsHex.quotedForSourceCode)\n"
+let outputString = "public let \(variableName) = \(dataAsHex.quotedForSourceCode)\n"
 let outputData = outputString.data(using: .utf8)
 FileManager.default.createFile(atPath: outputFile, contents: outputData)

Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Sources/MySourceGenBuildTool/main.swift

@@ -13,6 +13,6 @@ let variableName = URL(fileURLWithPath: inputFile).deletingPathExtension().lastP
 
 let inputData = FileManager.default.contents(atPath: inputFile) ?? Data()
 let dataAsHex = inputData.map { String(format: "%02hhx", $0) }.joined()
-let outputString = "public var \(variableName) = \(dataAsHex.quotedForSourceCode)\n"
+let outputString = "public let \(variableName) = \(dataAsHex.quotedForSourceCode)\n"
 let outputData = outputString.data(using: .utf8)
 FileManager.default.createFile(atPath: outputFile, contents: outputData)

Fixtures/Miscellaneous/Plugins/MySourceGenPluginUsingURLBasedAPI/Sources/MySourceGenBuildTool/main.swift

@@ -13,6 +13,6 @@ let variableName = URL(fileURLWithPath: inputFile).deletingPathExtension().lastP
 
 let inputData = FileManager.default.contents(atPath: inputFile) ?? Data()
 let dataAsHex = inputData.map { String(format: "%02hhx", $0) }.joined()
-let outputString = "public var \(variableName) = \(dataAsHex.quotedForSourceCode)\n"
+let outputString = "public let \(variableName) = \(dataAsHex.quotedForSourceCode)\n"
 let outputData = outputString.data(using: .utf8)
 FileManager.default.createFile(atPath: outputFile, contents: outputData)

Fixtures/Miscellaneous/Plugins/PluginWithInternalExecutable/Sources/PluginExecutable/main.swift

@@ -12,6 +12,6 @@ let variableName = URL(fileURLWithPath: inputFile).deletingPathExtension().lastP
 
 let inputData = FileManager.default.contents(atPath: inputFile) ?? Data()
 let dataAsHex = inputData.map { String(format: "%02hhx", $0) }.joined()
-let outputString = "public var \(variableName) = \(dataAsHex.quotedForSourceCode)\n"
+let outputString = "public let \(variableName) = \(dataAsHex.quotedForSourceCode)\n"
 let outputData = outputString.data(using: .utf8)
 FileManager.default.createFile(atPath: outputFile, contents: outputData)

IntegrationTests/Tests/IntegrationTests/BasicTests.swift

@@ -19,6 +19,7 @@ final class BasicTests: XCTestCase {
 
     func testExamplePackageDealer() throws {
         try XCTSkipIf(isSelfHosted, "These packages don't use the latest runtime library, which doesn't work with self-hosted builds.")
+        try skipUnlessAtLeastSwift6()
 
         try withTemporaryDirectory { tempDir in
             let packagePath = tempDir.appending(component: "dealer")
@@ -93,9 +94,7 @@ final class BasicTests: XCTestCase {
     }
 
     func testSwiftPackageInitExec() throws {
-        #if swift(<5.5)
-        try XCTSkipIf(true, "skipping because host compiler doesn't support '-entry-point-function-name'")
-        #endif
+        try skipUnlessAtLeastSwift6()
 
         try withTemporaryDirectory { tempDir in
             // Create a new package with an executable target.
@@ -122,9 +121,7 @@ final class BasicTests: XCTestCase {
     }
 
     func testSwiftPackageInitExecTests() throws {
-        #if swift(<5.5)
-        try XCTSkipIf(true, "skipping because host compiler doesn't support '-entry-point-function-name'")
-        #endif
+        try skipUnlessAtLeastSwift6()
 
         try XCTSkip("FIXME: swift-test invocations are timing out in Xcode and self-hosted CI")
 
@@ -149,6 +146,8 @@ final class BasicTests: XCTestCase {
     }
 
     func testSwiftPackageInitLib() throws {
+        try skipUnlessAtLeastSwift6()
+
         try withTemporaryDirectory { tempDir in
             // Create a new package with an executable target.
             let packagePath = tempDir.appending(component: "Project")
@@ -167,6 +166,8 @@ final class BasicTests: XCTestCase {
     }
 
     func testSwiftPackageLibsTests() throws {
+        try skipUnlessAtLeastSwift6()
+
         try XCTSkip("FIXME: swift-test invocations are timing out in Xcode and self-hosted CI")
 
         try withTemporaryDirectory { tempDir in
@@ -225,9 +226,7 @@ final class BasicTests: XCTestCase {
     }
 
     func testSwiftRun() throws {
-        #if swift(<5.5)
-        try XCTSkipIf(true, "skipping because host compiler doesn't support '-entry-point-function-name'")
-        #endif
+        try skipUnlessAtLeastSwift6()
 
         try withTemporaryDirectory { tempDir in
             let packagePath = tempDir.appending(component: "secho")
@@ -256,6 +255,8 @@ final class BasicTests: XCTestCase {
     }
 
     func testSwiftTest() throws {
+        try skipUnlessAtLeastSwift6()
+
         try XCTSkip("FIXME: swift-test invocations are timing out in Xcode and self-hosted CI")
 
         try withTemporaryDirectory { tempDir in
@@ -377,3 +378,9 @@ private extension Character {
         }
     }
 }
+
+private func skipUnlessAtLeastSwift6() throws {
+    #if compiler(<6.0)
+    try XCTSkipIf(true, "Skipping because test requires at least Swift 6.0")
+    #endif
+}

IntegrationTests/Tests/IntegrationTests/SwiftPMTests.swift

@@ -53,6 +53,9 @@ final class SwiftPMTests: XCTestCase {
         #if !os(macOS)
         try XCTSkip("Test requires macOS")
         #endif
+        #if swift(<6.0)
+        try XCTSkipIf(true, "Skipping because test requires at least Swift 6.0")
+        #endif
 
         try withTemporaryDirectory { tmpDir in
             let packagePath = tmpDir.appending(component: "foo")

Package.swift

@@ -725,6 +725,12 @@ let package = Package(
             dependencies: ["XCBuildSupport", "SPMTestSupport"],
             exclude: ["Inputs/Foo.pc"]
         ),
+        // Examples (These are built to ensure they stay up to date with the API.)
+        .executableTarget(
+            name: "package-info",
+            dependencies: ["Workspace"],
+            path: "Examples/package-info/Sources/package-info"
+        )
     ],
     swiftLanguageVersions: [.v5]
 )

Sources/Basics/ProgressAnimation/NinjaProgressAnimation.swift

@@ -15,7 +15,8 @@ import protocol TSCBasic.WritableByteStream
 
 extension ProgressAnimation {
     /// A ninja-like progress animation that adapts to the provided output stream.
-    package static func ninja(
+    @_spi(SwiftPMInternal)
+    public static func ninja(
         stream: WritableByteStream,
         verbose: Bool
     ) -> any ProgressAnimationProtocol {

Sources/Basics/ProgressAnimation/PercentProgressAnimation.swift

@@ -15,7 +15,8 @@ import protocol TSCBasic.WritableByteStream
 
 extension ProgressAnimation {
     /// A percent-based progress animation that adapts to the provided output stream.
-    package static func percent(
+    @_spi(SwiftPMInternal)
+    public static func percent(
         stream: WritableByteStream,
         verbose: Bool,
         header: String

Sources/Basics/ProgressAnimation/ProgressAnimationProtocol.swift

@@ -15,10 +15,12 @@ import class TSCBasic.LocalFileOutputByteStream
 import protocol TSCBasic.WritableByteStream
 import protocol TSCUtility.ProgressAnimationProtocol
 
-package typealias ProgressAnimationProtocol = TSCUtility.ProgressAnimationProtocol
+@_spi(SwiftPMInternal)
+public typealias ProgressAnimationProtocol = TSCUtility.ProgressAnimationProtocol
 
 /// Namespace to nest public progress animations under.
-package enum ProgressAnimation {
+@_spi(SwiftPMInternal)
+public enum ProgressAnimation {
     /// Dynamically create a progress animation based on the current stream
     /// capabilities and desired verbosity.
     ///

Sources/Basics/ProgressAnimation/ThrottledProgressAnimation.swift

@@ -56,23 +56,27 @@ final class ThrottledProgressAnimation: ProgressAnimationProtocol {
     }
 }
 
+@_spi(SwiftPMInternal)
 extension ProgressAnimationProtocol {
-    package func throttled<C: Clock>(
+    @_spi(SwiftPMInternal)
+    public func throttled<C: Clock>(
         now: @escaping () -> C.Instant,
         interval: C.Duration,
         clock: C.Type = C.self
     ) -> some ProgressAnimationProtocol {
         ThrottledProgressAnimation(self, now: now, interval: interval, clock: clock)
     }
 
-    package func throttled<C: Clock>(
+    @_spi(SwiftPMInternal)
+    public func throttled<C: Clock>(
         clock: C,
         interval: C.Duration
     ) -> some ProgressAnimationProtocol {
         self.throttled(now: { clock.now }, interval: interval, clock: C.self)
     }
 
-    package func throttled(
+    @_spi(SwiftPMInternal)
+    public func throttled(
         interval: ContinuousClock.Duration
     )  -> some ProgressAnimationProtocol  {
         self.throttled(clock: ContinuousClock(), interval: interval)