File: PIFTester.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (376 lines) | stat: -rw-r--r-- 14,485 bytes parent folder | download
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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
//===----------------------------------------------------------------------===//
//
// 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 XCBuildSupport
import XCTest

public func PIFTester(_ pif: PIF.TopLevelObject, _ body: (PIFWorkspaceTester) throws -> Void) throws {
    try body(PIFWorkspaceTester(workspace: pif.workspace))
}

public final class PIFWorkspaceTester {
    private let workspace: PIF.Workspace
    private let projectMap: [PIF.GUID: PIF.Project]
    private let targetMap: [PIF.GUID: PIF.BaseTarget]

    fileprivate init(workspace: PIF.Workspace) {
        self.workspace = workspace

        let projectsByGUID = workspace.projects.map { ($0.guid, $0) }
        projectMap = Dictionary(uniqueKeysWithValues: projectsByGUID)
        let targetsByGUID = workspace.projects.flatMap { $0.targets.map { ($0.guid, $0) } }
        targetMap = Dictionary(uniqueKeysWithValues: targetsByGUID)
    }

    public func checkProject(
        _ guid: PIF.GUID,
        file: StaticString = #file,
        line: UInt = #line,
        body: (PIFProjectTester) -> Void
    ) throws {
        guard let project = projectMap[guid] else {
            return XCTFail("project \(guid) not found", file: file, line: line)
        }

        body(try PIFProjectTester(project: project, targetMap: targetMap))
    }
}

public final class PIFProjectTester {
    private let project: PIF.Project
    private let targetMap: [PIF.GUID: PIF.BaseTarget]
    private let fileMap: [PIF.GUID: String]

    public var guid: PIF.GUID { project.guid }
    public var path: AbsolutePath { project.path }
    public var projectDirectory: AbsolutePath { project.projectDirectory }
    public var name: String { project.name }
    public var developmentRegion: String { project.developmentRegion }

    fileprivate init(project: PIF.Project, targetMap: [PIF.GUID: PIF.BaseTarget]) throws {
        self.project = project
        self.targetMap = targetMap
        self.fileMap = try collectFiles(
            from: project.groupTree,
            parentPath: project.path,
            projectPath: project.path,
            builtProductsPath: project.path
        )
    }

    public func checkTarget(
        _ guid: PIF.GUID,
        file: StaticString = #file,
        line: UInt = #line,
        body: ((PIFTargetTester) -> Void)? = nil
    ) {
        guard let baseTarget = baseTarget(withGUID: guid) else {
            let guids = project.targets.map { $0.guid }.joined(separator: ", ")
            return XCTFail("target \(guid) not found among \(guids)", file: file, line: line)
        }

        guard let target = baseTarget as? PIF.Target else {
            return XCTFail("target \(guid) is not a standard target", file: file, line: line)
        }

        body?(PIFTargetTester(target: target, targetMap: targetMap, fileMap: fileMap))
    }

    public func checkNoTarget(
        _ guid: PIF.GUID,
        file: StaticString = #file,
        line: UInt = #line,
        body: ((PIFTargetTester) -> Void)? = nil
    ) {
        if baseTarget(withGUID: guid) != nil {
            XCTFail("target \(guid) found", file: file, line: line)
        }
    }

    public func checkAggregateTarget(
        _ guid: PIF.GUID,
        file: StaticString = #file,
        line: UInt = #line,
        body: ((PIFAggregateTargetTester) -> Void)? = nil
    ) {
        guard let baseTarget = baseTarget(withGUID: guid) else {
            let guids = project.targets.map { $0.guid }.joined(separator: ", ")
            return XCTFail("target \(guid) not found among \(guids)", file: file, line: line)
        }

        guard let target = baseTarget as? PIF.AggregateTarget else {
            return XCTFail("target \(guid) is not an aggregate target", file: file, line: line)
        }

        body?(PIFAggregateTargetTester(target: target, targetMap: targetMap, fileMap: fileMap))
    }

    public func checkBuildConfiguration(
        _ name: String,
        file: StaticString = #file,
        line: UInt = #line,
        body: (PIFBuildConfigurationTester) -> Void
    ) {
        guard let configuration = buildConfiguration(withName: name) else {
            let names = project.buildConfigurations.map { $0.name }.joined(separator: ", ")
            return XCTFail("build configuration \(name) not found among \(names)", file: file, line: line)
        }

        body(PIFBuildConfigurationTester(buildConfiguration: configuration))
    }

    public func buildConfiguration(withName name: String) -> PIF.BuildConfiguration? {
        return project.buildConfigurations.first { $0.name == name }
    }

    public func baseTarget(withGUID guid: PIF.GUID) -> PIF.BaseTarget? {
        return project.targets.first { $0.guid == guid }
    }
}

public class PIFBaseTargetTester {
    public let baseTarget: PIF.BaseTarget

    public var guid: PIF.GUID { baseTarget.guid }
    public var name: String { baseTarget.name }
    public let dependencies: Set<PIF.GUID>
    public let sources: Set<String>
    public let frameworks: Set<String>
    public let resources: Set<String>

    fileprivate init(baseTarget: PIF.BaseTarget, targetMap: [PIF.GUID: PIF.BaseTarget], fileMap: [PIF.GUID: String]) {
        self.baseTarget = baseTarget
        dependencies = Set(baseTarget.dependencies.map { targetMap[$0.targetGUID]!.guid })

        let sourcesBuildFiles = baseTarget.buildPhases.first { $0 is PIF.SourcesBuildPhase }?.buildFiles ?? []
        sources = Set(sourcesBuildFiles.map { buildFile -> String in
            if case .file(let guid) = buildFile.reference {
                return fileMap[guid]!
            } else {
                fatalError("unexpected build file reference: \(buildFile)")
            }
        })

        let frameworksBuildFiles = baseTarget.buildPhases.first { $0 is PIF.FrameworksBuildPhase }?.buildFiles ?? []
        frameworks = Set(frameworksBuildFiles.map { buildFile -> String in
            switch buildFile.reference {
            case .target(let guid):
                return targetMap[guid]!.guid
            case .file(let guid):
                return fileMap[guid]!
            }
        })

        let resourcesBuildFiles = baseTarget.buildPhases.first { $0 is PIF.ResourcesBuildPhase }?.buildFiles ?? []
        resources = Set(resourcesBuildFiles.map { buildFile -> String in
            if case .file(let guid) = buildFile.reference {
                return fileMap[guid]!
            } else {
                fatalError("unexpected build file reference: \(buildFile)")
            }
        })
    }

    public func checkBuildConfiguration(
        _ name: String,
        file: StaticString = #file,
        line: UInt = #line,
        body: (PIFBuildConfigurationTester) -> Void
    ) {
        guard let configuration = buildConfiguration(withName: name) else {
            return XCTFail("build configuration \(name) not found", file: file, line: line)
        }

        body(PIFBuildConfigurationTester(buildConfiguration: configuration))
    }

    public func buildConfiguration(withName name: String) -> PIF.BuildConfiguration? {
        return baseTarget.buildConfigurations.first { $0.name == name }
    }

    public func checkImpartedBuildSettings(
        file: StaticString = #file,
        line: UInt = #line,
        _ body: (PIFBuildSettingsTester) -> Void
    ) {
        let buildSettingsTester = PIFBuildSettingsTester(
            buildSettings: baseTarget.buildConfigurations.first!.impartedBuildProperties.buildSettings
        )
        body(buildSettingsTester)
    }

    public func checkAllImpartedBuildSettings(
        file: StaticString = #file,
        line: UInt = #line,
        _ body: (PIFBuildSettingsTester) -> Void
    ) {
        let buildSettingsTester = PIFBuildSettingsTester(
            buildSettings: baseTarget.buildConfigurations.first!.impartedBuildProperties.buildSettings
        )
        body(buildSettingsTester)
        buildSettingsTester.checkUncheckedSettings(file: file, line: line)
    }

    public func checkNoImpartedBuildSettings(file: StaticString = #file, line: UInt = #line) {
        let buildSettingsTester = PIFBuildSettingsTester(
            buildSettings: baseTarget.buildConfigurations.first!.impartedBuildProperties.buildSettings
        )
        buildSettingsTester.checkUncheckedSettings(file: file, line: line)
    }
}

public final class PIFTargetTester: PIFBaseTargetTester {
    private let target: PIF.Target
    public var productType: PIF.Target.ProductType { target.productType }
    public var productName: String { target.productName }

    fileprivate init(target: PIF.Target, targetMap: [PIF.GUID: PIF.BaseTarget], fileMap: [PIF.GUID: String]) {
        self.target = target
        super.init(baseTarget: target, targetMap: targetMap, fileMap: fileMap)
    }
}

public final class PIFAggregateTargetTester: PIFBaseTargetTester {
    private let target: PIF.AggregateTarget

    fileprivate init(target: PIF.AggregateTarget, targetMap: [PIF.GUID: PIF.BaseTarget], fileMap: [PIF.GUID: String]) {
        self.target = target
        super.init(baseTarget: target, targetMap: targetMap, fileMap: fileMap)
    }
}

public final class PIFBuildConfigurationTester {
    private let buildConfiguration: PIF.BuildConfiguration

    public var guid: PIF.GUID { buildConfiguration.guid }
    public var name: String { buildConfiguration.name }

    fileprivate init(buildConfiguration: PIF.BuildConfiguration) {
        self.buildConfiguration = buildConfiguration
    }

    public func checkBuildSettings(file: StaticString = #file, line: UInt = #line, _ body: (PIFBuildSettingsTester) -> Void) {
        let buildSettingsTester = PIFBuildSettingsTester(buildSettings: buildConfiguration.buildSettings)
        body(buildSettingsTester)
    }

    public func checkAllBuildSettings(file: StaticString = #file, line: UInt = #line, _ body: (PIFBuildSettingsTester) -> Void) {
        let buildSettingsTester = PIFBuildSettingsTester(buildSettings: buildConfiguration.buildSettings)
        body(buildSettingsTester)
        buildSettingsTester.checkUncheckedSettings(file: file, line: line)
    }

    public func checkNoBuildSettings(file: StaticString = #file, line: UInt = #line) {
        let buildSettingsTester = PIFBuildSettingsTester(buildSettings: buildConfiguration.buildSettings)
        buildSettingsTester.checkUncheckedSettings(file: file, line: line)
    }
}

public final class PIFBuildSettingsTester {
    private var buildSettings: PIF.BuildSettings

    fileprivate init(buildSettings: PIF.BuildSettings) {
        self.buildSettings = buildSettings
    }

    public subscript(_ key: PIF.BuildSettings.SingleValueSetting) -> String? {
        if let value = buildSettings[key] {
            buildSettings[key] = nil
            return value
        } else {
            return nil
        }
    }

    public subscript(_ key: PIF.BuildSettings.SingleValueSetting, for platform: PIF.BuildSettings.Platform) -> String? {
        if let value = buildSettings[key, for: platform] {
            buildSettings[key, for: platform] = nil
            return value
        } else {
            return nil
        }
    }

    public subscript(_ key: PIF.BuildSettings.MultipleValueSetting) -> [String]? {
        if let value = buildSettings[key] {
            buildSettings[key] = nil
            return value
        } else {
            return nil
        }
    }

    public subscript(_ key: PIF.BuildSettings.MultipleValueSetting, for platform: PIF.BuildSettings.Platform) -> [String]? {
        if let value = buildSettings[key, for: platform] {
            buildSettings[key, for: platform] = nil
            return value
        } else {
            return nil
        }
    }

    public func checkUncheckedSettings(file: StaticString = #file, line: UInt = #line) {
        let uncheckedKeys =
            Array(buildSettings.singleValueSettings.keys.map { $0.rawValue }) +
            Array(buildSettings.multipleValueSettings.keys.map { $0.rawValue })
        XCTAssert(uncheckedKeys.isEmpty, "settings are left unchecked: \(uncheckedKeys)", file: file, line: line)

        for (platform, settings) in buildSettings.platformSpecificSingleValueSettings {
            let uncheckedKeys = Array(settings.keys.map { $0.rawValue })
            XCTAssert(uncheckedKeys.isEmpty, "\(platform) settings are left unchecked: \(uncheckedKeys)", file: file, line: line)
        }

        for (platform, settings) in buildSettings.platformSpecificMultipleValueSettings {
            let uncheckedKeys = Array(settings.keys.map { $0.rawValue })
            XCTAssert(uncheckedKeys.isEmpty, "\(platform) settings are left unchecked: \(uncheckedKeys)", file: file, line: line)
        }
    }
}

private func collectFiles(
    from reference: PIF.Reference,
    parentPath: AbsolutePath,
    projectPath: AbsolutePath,
    builtProductsPath: AbsolutePath
) throws -> [PIF.GUID: String] {
    let referencePath: AbsolutePath
    switch reference.sourceTree {
    case .absolute:
        referencePath = try AbsolutePath(validating: reference.path)
    case .group:
        referencePath = try AbsolutePath(validating: reference.path, relativeTo: parentPath)
    case .sourceRoot:
        referencePath = try AbsolutePath(validating: reference.path, relativeTo: projectPath)
    case .builtProductsDir:
        referencePath = try AbsolutePath(validating: reference.path, relativeTo: builtProductsPath)
    }

    var files: [PIF.GUID: String] = [:]

    if reference is PIF.FileReference {
        assert(files[reference.guid] == nil, "non-unique GUID")
        files[reference.guid] = referencePath.pathString
    } else if let group = reference as? PIF.Group {
        for child in group.children {
            let childFiles = try collectFiles(
                from: child,
                parentPath: referencePath,
                projectPath: projectPath,
                builtProductsPath: builtProductsPath
            )
            files.merge(childFiles, uniquingKeysWith: { _, _ in fatalError("non-unique GUID") })
        }
    }

    return files
}