Move down the parsing of binary artifacts such as XCFrameworks and ArtifactArchives to SPMBuildCore (which makes sense anyway, but in particular so that plugins can have access to it). (#3349)

Author: abertelrud

Sources/Build/BuildPlan.swift

@@ -1967,66 +1967,18 @@ public class BuildPlan {
     /// Extracts the library information from an XCFramework.
     private func parseXCFramework(for target: BinaryTarget) throws -> [LibraryInfo] {
         try self.externalLibrariesCache.memoize(key: target) {
-            let metadata = try XCFrameworkMetadata.parse(fileSystem: self.fileSystem, rootPath: target.artifactPath)
-
-            // Check that it supports the target platform and architecture.
-            guard let library = metadata.libraries.first(where: {
-                $0.platform == buildParameters.triple.os.asXCFrameworkPlatformString && $0.architectures.contains(buildParameters.triple.arch.rawValue)
-            }) else {
-                throw StringError("""
-                    artifact '\(target.name)' does not support the target platform and architecture \
-                    ('\(buildParameters.triple)')
-                    """)
-            }
-
-            let libraryDirectory = target.artifactPath.appending(component: library.libraryIdentifier)
-            let libraryPath = libraryDirectory.appending(RelativePath(library.libraryPath))
-            let headersPath = library.headersPath.map({ libraryDirectory.appending(RelativePath($0)) })
-
-            return [LibraryInfo(libraryPath: libraryPath, headersPath: headersPath)]
+            return try target.parseXCFrameworks(for: self.buildParameters, fileSystem: self.fileSystem)
         }
     }
 
     /// Extracts the artifacts  from an artifactsArchive
     private func parseArtifactsArchive(for target: BinaryTarget) throws -> [ExecutableInfo] {
         try self.externalExecutablesCache.memoize(key: target) {
-            let metadata = try ArtifactsArchiveMetadata.parse(fileSystem: self.fileSystem, rootPath: target.artifactPath)
-
-            // filter the artifacts that are relevant to the triple
-            // FIXME: this filter needs to become more sophisticated
-            let supportedArtifacts = metadata.artifacts.filter { $0.value.variants.contains(where: { $0.supportedTriples.contains(buildParameters.triple) }) }
-            // TODO: add support for libraries
-            let executables = supportedArtifacts.filter { $0.value.type == .executable }
-
-            // flatten the results for easy access
-            return executables.reduce(into: [ExecutableInfo](), { partial, entry in
-                let executables = entry.value.variants.map {
-                    ExecutableInfo(name: entry.key, executablePath: target.artifactPath.appending(RelativePath($0.path)))
-                }
-                partial.append(contentsOf: executables)
-            })
+            return try target.parseArtifactArchives(for: self.buildParameters, fileSystem: self.fileSystem)
         }
     }
 }
 
-/// Information about a library from a binary dependency.
-private struct LibraryInfo: Equatable {
-    /// The path to the binary.
-    let libraryPath: AbsolutePath
-
-    /// The path to the headers directory, if one exists.
-    let headersPath: AbsolutePath?
-}
-
-/// Information about an executable from a binary dependency.
-private struct ExecutableInfo: Equatable {
-    /// The tool name
-    let name: String
-
-    /// The path to the executable.
-    let executablePath: AbsolutePath
-}
-
 private extension Diagnostic.Message {
     static var swiftBackDeployError: Diagnostic.Message {
         .warning("Swift compiler no longer supports statically linking the Swift libraries. They're included in the OS by default starting with macOS Mojave 10.14.4 beta 3. For macOS Mojave 10.14.3 and earlier, there's an optional Swift library package that can be downloaded from \"More Downloads\" for Apple Developers at https://developer.apple.com/download/more/")
@@ -2108,18 +2060,6 @@ private func generateResourceInfoPlist(
     return true
 }
 
-fileprivate extension Triple.OS {
-    /// Returns a representation of the receiver that can be compared with platform strings declared in an XCFramework.
-    var asXCFrameworkPlatformString: String? {
-        switch self {
-        case .darwin, .linux, .wasi, .windows:
-            return nil // XCFrameworks do not support any of these platforms today.
-        case .macOS:
-            return "macos"
-        }
-    }
-}
-
 fileprivate extension Triple {
     var isSupportingStaticStdlib: Bool {
         isLinux() || arch == .wasm32

Sources/Build/CMakeLists.txt

@@ -1,20 +1,18 @@
 # This source file is part of the Swift.org open source project
 #
-# Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+# Copyright (c) 2014 - 2021 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 Swift project authors
 
 add_library(Build
-  ArtifactsArchiveMetadata.swift
   BuildOperationBuildSystemDelegateHandler.swift
   BuildOperation.swift
   BuildPlan.swift
   ManifestBuilder.swift
   SPMSwiftDriverExecutor.swift
-  SwiftCompilerOutputParser.swift
-  XCFrameworkMetadata.swift)
+  SwiftCompilerOutputParser.swift)
 target_link_libraries(Build PUBLIC
   TSCBasic
   Basics

Sources/Build/ArtifactsArchiveMetadata.swift renamed to Sources/SPMBuildCore/ArtifactsArchiveMetadata.swift

@@ -10,7 +10,6 @@
 
 import Foundation
 import PackageModel
-import SPMBuildCore
 import TSCBasic
 import TSCUtility
 

Sources/SPMBuildCore/BinaryTarget+Extensions.swift

@@ -0,0 +1,78 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2021 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 Swift project authors
+*/
+
+import Foundation
+import Basics
+import PackageModel
+import PackageGraph
+import TSCBasic
+import TSCUtility
+
+
+/// Information about a library from a binary dependency.
+public struct LibraryInfo: Equatable {
+    /// The path to the binary.
+    public let libraryPath: AbsolutePath
+
+    /// The path to the headers directory, if one exists.
+    public let headersPath: AbsolutePath?
+}
+
+
+/// Information about an executable from a binary dependency.
+public struct ExecutableInfo: Equatable {
+    /// The tool name
+    public let name: String
+
+    /// The path to the executable.
+    public let executablePath: AbsolutePath
+}
+
+
+extension BinaryTarget {
+    
+    public func parseXCFrameworks(for buildParameters: BuildParameters, fileSystem: FileSystem) throws -> [LibraryInfo] {
+        let metadata = try XCFrameworkMetadata.parse(fileSystem: fileSystem, rootPath: self.artifactPath)
+        guard let library = metadata.libraries.first(where: {
+            $0.platform == buildParameters.triple.os.asXCFrameworkPlatformString &&
+            $0.architectures.contains(buildParameters.triple.arch.rawValue)
+        }) else {
+            return []
+        }
+        let libraryDir = self.artifactPath.appending(component: library.libraryIdentifier)
+        let libraryFile = libraryDir.appending(RelativePath(library.libraryPath))
+        let headersDir = library.headersPath.map({ libraryDir.appending(RelativePath($0)) })
+        return [LibraryInfo(libraryPath: libraryFile, headersPath: headersDir)]
+    }
+
+    public func parseArtifactArchives(for buildParameters: BuildParameters, fileSystem: FileSystem) throws -> [ExecutableInfo] {
+        let metadata = try ArtifactsArchiveMetadata.parse(fileSystem: fileSystem, rootPath: self.artifactPath)
+        // filter the artifacts that are relevant to the triple
+        // FIXME: this filter needs to become more sophisticated
+        let supportedArtifacts = metadata.artifacts.filter { $0.value.variants.contains(where: { $0.supportedTriples.contains(buildParameters.triple) }) }
+        // TODO: add support for libraries
+        let executables = supportedArtifacts.filter { $0.value.type == .executable }
+        return executables.flatMap { entry in
+            entry.value.variants.map{ ExecutableInfo(name: entry.key, executablePath: self.artifactPath.appending(RelativePath($0.path))) }
+        }
+    }
+}
+
+fileprivate extension Triple.OS {
+    /// Returns a representation of the receiver that can be compared with platform strings declared in an XCFramework.
+    var asXCFrameworkPlatformString: String? {
+        switch self {
+        case .darwin, .linux, .wasi, .windows:
+            return nil // XCFrameworks do not support any of these platforms today.
+        case .macOS:
+            return "macos"
+        }
+    }
+}

Sources/SPMBuildCore/CMakeLists.txt

@@ -7,6 +7,8 @@
 # See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 
 add_library(SPMBuildCore
+  ArtifactsArchiveMetadata.swift
+  BinaryTarget+Extensions.swift
   BuildParameters.swift
   BuildSystem.swift
   BuildSystemCommand.swift
@@ -15,7 +17,8 @@ add_library(SPMBuildCore
   PluginInvocation.swift
   PrebuildCommandResult.swift
   Sanitizers.swift
-  Toolchain.swift)
+  Toolchain.swift
+  XCFrameworkMetadata.swift)
 # NOTE(compnerd) workaround for CMake not setting up include flags yet
 set_target_properties(SPMBuildCore PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})

Sources/Build/XCFrameworkMetadata.swift renamed to Sources/SPMBuildCore/XCFrameworkMetadata.swift

@@ -10,7 +10,6 @@
 
 import Foundation
 import PackageModel
-import SPMBuildCore
 import TSCBasic
 import TSCUtility
 

Tests/BuildTests/ArtifactsArchiveMetadataTests.swift renamed to Tests/SPMBuildCoreTests/ArtifactsArchiveMetadataTests.swift

@@ -1,14 +1,14 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+ Copyright (c) 2014 - 2021 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 Swift project authors
  */
 
-import Build
+import SPMBuildCore
 import TSCBasic
 import TSCUtility
 import XCTest

Tests/BuildTests/XCFrameworkMetadataTests.swift renamed to Tests/SPMBuildCoreTests/XCFrameworkMetadataTests.swift

@@ -8,7 +8,7 @@
  See http://swift.org/CONTRIBUTORS.txt for Swift project authors
  */
 
-import Build
+import SPMBuildCore
 import TSCBasic
 import XCTest