Implement the manifest API changes necessary for implementing SE0226

Author: hartbit

Documentation/PackageDescription.md

@@ -578,7 +578,7 @@ Represents dependency on other targets in the package or products from other pac
 public static func target(name: String) -> Target.Dependency
 
 /// A dependency on a product from a package dependency.
-public static func product(name: String, package: String? = nil) -> Target.Dependency
+public static func product(name: String, package: String) -> Target.Dependency
 
 // A by-name dependency that resolves to either a target or a product,
 // as above, after the package graph has been loaded.

Sources/PackageDescription4/Package.swift

@@ -147,14 +147,18 @@ public final class Package {
             }
         }
 
+        /// The name of the package, or nil to deduce it from the URL.
+        public let name: String?
+
         /// The Git url of the package dependency.
         public let url: String
 
         /// The dependency requirement of the package dependency.
         public let requirement: Requirement
 
         /// Initializes and returns a newly allocated requirement with the specified url and requirements.
-        init(url: String, requirement: Requirement) {
+        init(name: String?, url: String, requirement: Requirement) {
+            self.name = name
             self.url = url
             self.requirement = requirement
         }

Sources/PackageDescription4/PackageDependency.swift

@@ -26,26 +26,30 @@ extension Package.Dependency {
     ///    .package(url: "https://example.com/example-package.git", from: "1.2.3"),
     ///
     /// - Parameters:
+    ///     - name: The name of the package, or nil to deduce it from the URL.
     ///     - url: The valid Git URL of the package.
     ///     - version: The minimum version requirement.
     public static func package(
+        name: String? = nil,
         url: String,
         from version: Version
     ) -> Package.Dependency {
-        return .package(url: url, .upToNextMajor(from: version))
+        return .package(name: name, url: url, .upToNextMajor(from: version))
     }
 
     /// Add a remote package dependency given a version requirement.
     ///
     /// - Parameters:
+    ///     - name: The name of the package, or nil to deduce it from the URL.
     ///     - url: The valid Git URL of the package.
     ///     - requirement: A dependency requirement. See static methods on `Package.Dependency.Requirement` for available options.
     public static func package(
+        name: String? = nil,
         url: String,
         _ requirement: Package.Dependency.Requirement
     ) -> Package.Dependency {
         precondition(!requirement.isLocalPackage, "Use `.package(path:)` API to declare a local package dependency")
-        return .init(url: url, requirement: requirement)
+        return .init(name: name, url: url, requirement: requirement)
     }
 
     /// Add a package dependency starting with a specific minimum version, up to
@@ -57,16 +61,18 @@ extension Package.Dependency {
     ///     .package(url: "https://example.com/example-package.git", "1.2.3"..<"1.2.6"),
     ///
     /// - Parameters:
+    ///     - name: The name of the package, or nil to deduce it from the URL.
     ///     - url: The valid Git URL of the package.
     ///     - range: The custom version range requirement.
     public static func package(
+        name: String? = nil,
         url: String,
         _ range: Range<Version>
     ) -> Package.Dependency {
       #if PACKAGE_DESCRIPTION_4
-        return .init(url: url, requirement: .rangeItem(range))
+        return .init(name: name, url: url, requirement: .rangeItem(range))
       #else
-        return .init(url: url, requirement: ._rangeItem(range))
+        return .init(name: name, url: url, requirement: ._rangeItem(range))
       #endif
     }
 
@@ -79,9 +85,11 @@ extension Package.Dependency {
     ///     .package(url: "https://example.com/example-package.git", "1.2.3"..."1.2.6"),
     ///
     /// - Parameters:
+    ///     - name: The name of the package, or nil to deduce it from the URL.
     ///     - url: The valid Git URL of the package.
     ///     - range: The closed version range requirement.
     public static func package(
+        name: String? = nil,
         url: String,
         _ range: ClosedRange<Version>
     ) -> Package.Dependency {
@@ -91,7 +99,7 @@ extension Package.Dependency {
             upper.major, upper.minor, upper.patch + 1,
             prereleaseIdentifiers: upper.prereleaseIdentifiers,
             buildMetadataIdentifiers: upper.buildMetadataIdentifiers)
-        return .package(url: url, range.lowerBound..<upperBound)
+        return .package(name: name, url: url, range.lowerBound..<upperBound)
     }
 
   #if !PACKAGE_DESCRIPTION_4
@@ -106,7 +114,7 @@ extension Package.Dependency {
     public static func package(
         path: String
     ) -> Package.Dependency {
-        return .init(url: path, requirement: ._localPackageItem)
+        return .init(name: nil, url: path, requirement: ._localPackageItem)
     }
   #endif
 }

Sources/PackageDescription4/Target.swift

@@ -9,10 +9,10 @@
 */
 
 /// A target, the basic building block of a Swift package.
-/// 
+///
 /// Each target contains a set of source files that are compiled into a module or test suite.
 /// You can vend targets to other packages by defining products that include the targets.
-/// 
+///
 /// A target may depend on other targets within the same package and on products vended by the package's dependencies.
 public final class Target {
 
@@ -93,7 +93,7 @@ public final class Target {
 
     /// The `pkgconfig` name to use for a system library target.
     ///
-    /// If present, the Swift Package Manager tries to 
+    /// If present, the Swift Package Manager tries to
     /// search for the `<name>.pc` file to get the additional flags needed for the
     /// system target.
     public let pkgConfig: String?
@@ -400,7 +400,7 @@ public final class Target {
 
   #if !PACKAGE_DESCRIPTION_4
     /// Create a system library target.
-    /// 
+    ///
     /// Use system library targets to adapt a library installed on the system to work with Swift packages.
     /// Such libraries are generally installed by system package managers (such as Homebrew and apt-get)
     /// and exposed to Swift packages by providing a `modulemap` file along with other metadata such as the library's `pkgConfig` name.
@@ -500,6 +500,7 @@ extension Target.Dependency {
     /// - parameters:
     ///   - name: The name of the product.
     ///   - package: The name of the package.
+    @available(_PackageDescription, obsoleted: 5.3, message: "the 'package' argument is now mandatory")
     public static func product(name: String, package: String? = nil) -> Target.Dependency {
       #if PACKAGE_DESCRIPTION_4
         return .productItem(name: name, package: package)
@@ -508,6 +509,20 @@ extension Target.Dependency {
       #endif
     }
 
+    /// Creates a dependency on a product from a package dependency.
+    ///
+    /// - parameters:
+    ///   - name: The name of the product.
+    ///   - package: The name of the package.
+    @available(_PackageDescription, introduced: 5.3)
+    public static func product(name: String, package: String) -> Target.Dependency {
+      #if PACKAGE_DESCRIPTION_4
+        return .productItem(name: name, package: package)
+      #else
+        return ._productItem(name: name, package: package)
+      #endif
+    }
+
     /// Creates a by-name dependency that resolves to either a target or a product but
     /// after the package graph has been loaded.
     ///

Sources/PackageLoading/ManifestLoader.swift

@@ -23,6 +23,8 @@ public enum ManifestParseError: Swift.Error {
     case runtimeManifestErrors([String])
 
     case duplicateDependencyDecl([[PackageDependencyDescription]])
+
+    case targetDependencyUnknownPackage(targetName: String, packageName: String)
 }
 
 /// Resources required for manifest loading.
@@ -230,7 +232,7 @@ public final class ManifestLoader: ManifestLoaderProtocol {
             baseURL: baseURL,
             fileSystem: fileSystem ?? localFileSystem
         )
-        try manifestBuilder.build(v4: json)
+        try manifestBuilder.build(v4: json, toolsVersion: toolsVersion)
 
         // Throw if we encountered any runtime errors.
         guard manifestBuilder.errors.isEmpty else {
@@ -254,17 +256,46 @@ public final class ManifestLoader: ManifestLoaderProtocol {
             targets: manifestBuilder.targets
         )
 
-        try validate(manifest)
+        try validate(manifest, toolsVersion: toolsVersion)
 
         return manifest
     }
 
     /// Validate the provided manifest.
-    private func validate(_ manifest: Manifest) throws {
+    private func validate(_ manifest: Manifest, toolsVersion: ToolsVersion) throws {
         let duplicateDecls = manifest.dependencies.map({ KeyedPair($0, key: PackageReference.computeIdentity(packageURL: $0.url)) }).spm_findDuplicateElements()
         if !duplicateDecls.isEmpty {
             throw ManifestParseError.duplicateDependencyDecl(duplicateDecls.map({ $0.map({ $0.item }) }))
         }
+
+        // If the tools version is 5.3 or greater, we want to make sure all target package dependencies are valid.
+        if toolsVersion >= .v5_3 {
+            let targetNames = Set(manifest.targets.map({ $0.name }))
+            for target in manifest.targets {
+                for targetDependency in target.dependencies {
+                    // If this is a target dependency (or byName that references a target), we don't need to check.
+                    if case .target = targetDependency { continue }
+                    if case .byName(let name) = targetDependency, targetNames.contains(name) { continue }
+
+                    // If we can't find the package dependency it references, the manifest is invalid.
+                    if manifest.packageDependency(referencedBy: targetDependency) == nil {
+                        let packageName: String
+                        switch targetDependency {
+                        case .product(_, package: let name?),
+                             .byName(let name):
+                            packageName = name
+                        default:
+                            fatalError("Invalid case: this shouldn't be a target, or a product with no name")
+                        }
+
+                        throw ManifestParseError.targetDependencyUnknownPackage(
+                            targetName: target.name,
+                            packageName: packageName
+                        )
+                    }
+                }
+            }
+        }
     }
 
     /// Load the JSON string for the given manifest.

Sources/PackageLoading/PackageDescription4Loader.swift

@@ -11,9 +11,10 @@
 import TSCBasic
 import TSCUtility
 import PackageModel
+import Foundation
 
 extension ManifestBuilder {
-    mutating func build(v4 json: JSON) throws {
+    mutating func build(v4 json: JSON, toolsVersion: ToolsVersion) throws {
         let package = try json.getJSON("package")
         self.name = try package.get(String.self, forKey: "name")
         self.pkgConfig = package.get("pkgConfig")
@@ -22,9 +23,14 @@ extension ManifestBuilder {
         self.products = try package.getArray("products").map(ProductDescription.init(v4:))
         self.providers = try? package.getArray("providers").map(SystemPackageProviderDescription.init(v4:))
         self.targets = try package.getArray("targets").map(parseTarget(json:))
-        self.dependencies = try package
-             .getArray("dependencies")
-             .map({ try PackageDependencyDescription(v4: $0, baseURL: self.baseURL, fileSystem: self.fs) })
+        self.dependencies = try package.getArray("dependencies").map({
+            try PackageDependencyDescription(
+                v4: $0,
+                toolsVersion: toolsVersion,
+                baseURL: self.baseURL,
+                fileSystem: self.fs
+            )
+        })
 
         self.cxxLanguageStandard = package.get("cxxLanguageStandard")
         self.cLanguageStandard = package.get("cLanguageStandard")
@@ -265,7 +271,7 @@ extension PackageDependencyDescription.Requirement {
 }
 
 extension PackageDependencyDescription {
-    fileprivate init(v4 json: JSON, baseURL: String, fileSystem: FileSystem) throws {
+    fileprivate init(v4 json: JSON, toolsVersion: ToolsVersion, baseURL: String, fileSystem: FileSystem) throws {
         let isBaseURLRemote = URL.scheme(baseURL) != nil
 
         func fixURL(_ url: String, requirement: Requirement) throws -> String {
@@ -297,11 +303,14 @@ extension PackageDependencyDescription {
         }
 
         let requirement = try Requirement(v4: json.get("requirement"))
+        let url = try fixURL(json.get("url"), requirement: requirement)
+        var name: String? = json.get("name")
+
+        if name == nil && toolsVersion >= .v5_3 {
+            name = URL(string: url)?.deletingPathExtension().lastPathComponent
+        }
 
-        try self.init(
-            url: fixURL(json.get("url"), requirement: requirement),
-            requirement: requirement
-        )
+        self.init(name: name, url: url, requirement: requirement)
     }
 }
 

Sources/PackageModel/Manifest.swift

@@ -163,6 +163,25 @@ extension Manifest {
         try container.encode(targets, forKey: .targets)
         try container.encode(platforms, forKey: .platforms)
     }
+
+    /// Finds the package dependency referenced by the specified target dependency.
+    /// - Returns: Returns `nil` if the dependency is a target dependency, if it is a product dependency but has no
+    /// package name (for tools versions less than 5.3), or if there were no dependencies with the provided name.
+    public func packageDependency(
+        referencedBy targetDependency: TargetDescription.Dependency
+    ) -> PackageDependencyDescription? {
+        let packageName: String
+
+        switch targetDependency {
+        case .product(_, package: let name?),
+             .byName(name: let name):
+            packageName = name
+        default:
+            return nil
+        }
+
+        return dependencies.first(where: { $0.name == packageName })
+    }
 }
 
 /// The description of an individual target.
@@ -346,14 +365,18 @@ public struct PackageDependencyDescription: Equatable, Codable {
         }
     }
 
+    /// The name of the dependency.
+    public let name: String?
+
     /// The url of the dependency.
     public let url: String
 
     /// The dependency requirement.
     public let requirement: Requirement
 
     /// Create a dependency.
-    public init(url: String, requirement: Requirement) {
+    public init(name: String?, url: String, requirement: Requirement) {
+        self.name = name
         self.url = url
         self.requirement = requirement
     }

Sources/PackageModel/ToolsVersion.swift

@@ -21,6 +21,7 @@ public struct ToolsVersion: CustomStringConvertible, Comparable, Hashable, Codab
     public static let v4_2 = ToolsVersion(version: "4.2.0")
     public static let v5 = ToolsVersion(version: "5.0.0")
     public static let v5_2 = ToolsVersion(version: "5.2.0")
+    public static let v5_3 = ToolsVersion(version: "5.3.0")
 
     /// The current tools version in use.
     public static let currentToolsVersion = ToolsVersion(string:

Sources/SPMTestSupport/MockDependencyGraph.swift

@@ -178,6 +178,7 @@ public struct MockManifestGraph {
     ) -> [PackageDependencyDescription] {
         return dependencies.map({ dependency in
             return PackageDependencyDescription(
+                name: dependency.name,
                 url: repos[dependency.name]?.url ?? "//\(dependency.name)",
                 requirement: .range(dependency.version.lowerBound ..< dependency.version.upperBound))
         })

Sources/SPMTestSupport/TestWorkspace.swift

@@ -474,7 +474,11 @@ public struct TestDependency {
     }
 
     public func convert(baseURL: AbsolutePath) -> PackageDependencyDescription {
-        return PackageDependencyDescription(url: baseURL.appending(RelativePath(name)).pathString, requirement: requirement)
+        return PackageDependencyDescription(
+            name: name,
+            url: baseURL.appending(RelativePath(name)).pathString,
+            requirement: requirement
+        )
     }
 }
 

Sources/Workspace/Diagnostics.swift

@@ -52,6 +52,15 @@ public struct ManifestDuplicateDeclDiagnostic: DiagnosticData {
     }
 }
 
+public struct TargetDependencyUnknownPackageDiagnostic: DiagnosticData {
+    public let targetName: String
+    public let packageName: String
+
+    public var description: String {
+        "manifest parse error: target '\(targetName)' depends on an unknown package '\(packageName)'\n"
+    }
+}
+
 extension ManifestParseError: DiagnosticDataConvertible {
     public var diagnosticData: DiagnosticData {
         switch self {
@@ -61,6 +70,8 @@ extension ManifestParseError: DiagnosticDataConvertible {
             return ManifestParseDiagnostic(errors, diagnosticFile: nil)
         case .duplicateDependencyDecl(let duplicates):
             return ManifestDuplicateDeclDiagnostic(duplicates)
+        case .targetDependencyUnknownPackage(let targetName, let packageName):
+            return TargetDependencyUnknownPackageDiagnostic(targetName: targetName, packageName: packageName)
         }
     }
 }