1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
|
//===----------------------------------------------------------------------===//
//
// 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 XCTest
import struct Basics.IdentifiableSet
import PackageModel
import PackageGraph
package func PackageGraphTester(_ graph: ModulesGraph, _ result: (PackageGraphResult) throws -> Void) rethrows {
try result(PackageGraphResult(graph))
}
public final class PackageGraphResult {
public let graph: ModulesGraph
public init(_ graph: ModulesGraph) {
self.graph = graph
}
// TODO: deprecate / transition to PackageIdentity
public func check(roots: String..., file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(graph.rootPackages.map{$0.manifest.displayName }.sorted(), roots.sorted(), file: file, line: line)
}
public func check(roots: PackageIdentity..., file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(graph.rootPackages.map{$0.identity }.sorted(), roots.sorted(), file: file, line: line)
}
// TODO: deprecate / transition to PackageIdentity
public func check(packages: String..., file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(graph.packages.map {$0.manifest.displayName }.sorted(), packages.sorted(), file: file, line: line)
}
public func check(packages: PackageIdentity..., file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(graph.packages.map {$0.identity }.sorted(), packages.sorted(), file: file, line: line)
}
public func check(modules: String..., file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(
graph.allModules
.filter { $0.type != .test }
.map { $0.name }
.sorted(), modules.sorted(), file: file, line: line)
}
public func check(products: String..., file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(Set(graph.allProducts.map { $0.name }), Set(products), file: file, line: line)
}
public func check(reachableTargets: String..., file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(Set(graph.reachableModules.map { $0.name }), Set(reachableTargets), file: file, line: line)
}
public func check(reachableProducts: String..., file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(Set(graph.reachableProducts.map { $0.name }), Set(reachableProducts), file: file, line: line)
}
public func check(
reachableBuildTargets: String...,
in environment: BuildEnvironment,
file: StaticString = #file,
line: UInt = #line
) throws {
let targets = Set(try self.reachableBuildTargets(in: environment).map({ $0.name }))
XCTAssertEqual(targets, Set(reachableBuildTargets), file: file, line: line)
}
public func check(
reachableBuildProducts: String...,
in environment: BuildEnvironment,
file: StaticString = #file,
line: UInt = #line
) throws {
let products = Set(try self.reachableBuildProducts(in: environment).map({ $0.name }))
XCTAssertEqual(products, Set(reachableBuildProducts), file: file, line: line)
}
package func checkTarget(
_ name: String,
destination: BuildTriple? = .none,
file: StaticString = #file,
line: UInt = #line,
body: (ResolvedTargetResult) -> Void
) {
let target = graph.module(for: name, destination: destination)
guard let target else {
return XCTFail("Target \(name) not found", file: file, line: line)
}
body(ResolvedTargetResult(target))
}
package func checkTargets(
_ name: String,
file: StaticString = #file,
line: UInt = #line,
body: ([ResolvedTargetResult]) throws -> Void
) rethrows {
try body(graph.allModules.filter { $0.name == name }.map(ResolvedTargetResult.init))
}
public func checkProduct(
_ name: String,
destination: BuildTriple? = .none,
file: StaticString = #file,
line: UInt = #line,
body: (ResolvedProductResult) -> Void
) {
let product = graph.product(for: name, destination: destination)
guard let product else {
return XCTFail("Product \(name) not found", file: file, line: line)
}
body(ResolvedProductResult(product))
}
public func check(testModules: String..., file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(
graph.allModules
.filter{ $0.type == .test }
.map{ $0.name }
.sorted(), testModules.sorted(), file: file, line: line)
}
public func find(package: PackageIdentity) -> ResolvedPackage? {
return graph.packages.first(where: { $0.identity == package })
}
private func reachableBuildTargets(in environment: BuildEnvironment) throws -> IdentifiableSet<ResolvedModule> {
let inputTargets = graph.inputPackages.lazy.flatMap { $0.modules }
let recursiveBuildTargetDependencies = try inputTargets
.flatMap { try $0.recursiveDependencies(satisfying: environment) }
.compactMap { $0.module }
return IdentifiableSet(inputTargets).union(recursiveBuildTargetDependencies)
}
private func reachableBuildProducts(in environment: BuildEnvironment) throws -> IdentifiableSet<ResolvedProduct> {
let recursiveBuildProductDependencies = try graph.inputPackages
.lazy
.flatMap { $0.modules }
.flatMap { try $0.recursiveDependencies(satisfying: environment) }
.compactMap { $0.product }
return IdentifiableSet(graph.inputPackages.flatMap { $0.products }).union(recursiveBuildProductDependencies)
}
}
package final class ResolvedTargetResult {
let target: ResolvedModule
init(_ target: ResolvedModule) {
self.target = target
}
public func check(dependencies: String..., file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(Set(dependencies), Set(target.dependencies.map({ $0.name })), file: file, line: line)
}
package func check(dependencies: [String], file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(Set(dependencies), Set(target.dependencies.map({ $0.name })), file: file, line: line)
}
package func checkDependency(
_ name: String,
file: StaticString = #file,
line: UInt = #line,
body: (ResolvedTargetDependencyResult) -> Void
) {
guard let dependency = target.dependencies.first(where: { $0.name == name }) else {
return XCTFail("Dependency \(name) not found", file: file, line: line)
}
body(ResolvedTargetDependencyResult(dependency))
}
public func check(type: Module.Kind, file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(type, target.type, file: file, line: line)
}
package func checkDeclaredPlatforms(_ platforms: [String: String], file: StaticString = #file, line: UInt = #line) {
let targetPlatforms = Dictionary(
uniqueKeysWithValues: target.supportedPlatforms.map { ($0.platform.name, $0.version.versionString) }
)
XCTAssertEqual(platforms, targetPlatforms, file: file, line: line)
}
public func checkDerivedPlatforms(_ platforms: [String: String], file: StaticString = #file, line: UInt = #line) {
let derived = platforms.map {
let platform = PlatformRegistry.default.platformByName[$0.key] ?? PackageModel.Platform
.custom(name: $0.key, oldestSupportedVersion: $0.value)
return self.target.getSupportedPlatform(for: platform, usingXCTest: self.target.type == .test)
}
let targetPlatforms = Dictionary(
uniqueKeysWithValues: derived.map { ($0.platform.name, $0.version.versionString) }
)
XCTAssertEqual(platforms, targetPlatforms, file: file, line: line)
}
package func checkDerivedPlatformOptions(
_ platform: PackageModel.Platform,
options: [String],
file: StaticString = #file,
line: UInt = #line
) {
let platform = self.target.getSupportedPlatform(for: platform, usingXCTest: target.type == .test)
XCTAssertEqual(platform.options, options, file: file, line: line)
}
public func check(buildTriple: BuildTriple, file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(self.target.buildTriple, buildTriple, file: file, line: line)
}
}
package final class ResolvedTargetDependencyResult {
private let dependency: ResolvedModule.Dependency
init(_ dependency: ResolvedModule.Dependency) {
self.dependency = dependency
}
public func checkConditions(satisfy environment: BuildEnvironment, file: StaticString = #file, line: UInt = #line) {
XCTAssert(dependency.conditions.allSatisfy({ $0.satisfies(environment) }), file: file, line: line)
}
public func checkConditions(
dontSatisfy environment: BuildEnvironment,
file: StaticString = #file,
line: UInt = #line
) {
XCTAssert(!dependency.conditions.allSatisfy({ $0.satisfies(environment) }), file: file, line: line)
}
public func checkTarget(
file: StaticString = #file,
line: UInt = #line,
body: (ResolvedTargetResult) -> Void
) {
guard case let .module(target, _) = self.dependency else {
return XCTFail("Dependency \(dependency) is not a target", file: file, line: line)
}
body(ResolvedTargetResult(target))
}
public func checkProduct(
file: StaticString = #file,
line: UInt = #line,
body: (ResolvedProductResult) -> Void
) {
guard case let .product(product, _) = self.dependency else {
return XCTFail("Dependency \(dependency) is not a product", file: file, line: line)
}
body(ResolvedProductResult(product))
}
}
public final class ResolvedProductResult {
private let product: ResolvedProduct
init(_ product: ResolvedProduct) {
self.product = product
}
public func check(modules: String..., file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(Set(modules), Set(product.modules.map({ $0.name })), file: file, line: line)
}
public func check(type: ProductType, file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(type, product.type, file: file, line: line)
}
public func checkDeclaredPlatforms(_ platforms: [String: String], file: StaticString = #file, line: UInt = #line) {
let targetPlatforms = Dictionary(uniqueKeysWithValues: product.supportedPlatforms.map({ ($0.platform.name, $0.version.versionString) }))
XCTAssertEqual(platforms, targetPlatforms, file: file, line: line)
}
public func checkDerivedPlatforms(_ platforms: [String: String], file: StaticString = #file, line: UInt = #line) {
let derived = platforms.map {
let platform = PlatformRegistry.default.platformByName[$0.key] ?? PackageModel.Platform.custom(name: $0.key, oldestSupportedVersion: $0.value)
return product.getSupportedPlatform(for: platform, usingXCTest: product.isLinkingXCTest)
}
let targetPlatforms = Dictionary(uniqueKeysWithValues: derived.map({ ($0.platform.name, $0.version.versionString) }))
XCTAssertEqual(platforms, targetPlatforms, file: file, line: line)
}
public func checkDerivedPlatformOptions(_ platform: PackageModel.Platform, options: [String], file: StaticString = #file, line: UInt = #line) {
let platform = product.getSupportedPlatform(for: platform, usingXCTest: product.isLinkingXCTest)
XCTAssertEqual(platform.options, options, file: file, line: line)
}
public func check(buildTriple: BuildTriple, file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(self.product.buildTriple, buildTriple, file: file, line: line)
}
package func checkTarget(
_ name: String,
file: StaticString = #file,
line: UInt = #line,
body: (ResolvedTargetResult) -> Void
) {
guard let target = product.modules.first(where: { $0.name == name }) else {
return XCTFail("Target \(name) not found", file: file, line: line)
}
body(ResolvedTargetResult(target))
}
}
extension ResolvedModule.Dependency {
package var name: String {
switch self {
case .module(let target, _):
return target.name
case .product(let product, _):
return product.name
}
}
}
|