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
|
//===-------------- Context.swift - Swift Testing ----------- ---------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import TSCBasic
import XCTest
/// Bundles up (incidental) values to be passed down to the various functions.
///
/// - seealso: Test
struct Context: CustomStringConvertible {
enum IncrementalImports: String, CustomStringConvertible {
case enabled, disabled
var description: String { rawValue }
}
/// The root directory for the whole test
let rootDir: AbsolutePath
let incrementalImports: IncrementalImports
/// Set to true for debugging by passing `verbose: true` to `IncrementalTest.perform`.
let verbose: Bool
/// Helpful for debugging
let stepIndex: Int
/// Help Xcode place the errors in the right places
let file: StaticString
let line: UInt
/// Copy with the passed values
func with(stepIndex: Int, file: StaticString, line: UInt) -> Self {
Self(rootDir: rootDir, incrementalImports: incrementalImports, verbose: verbose,
stepIndex: stepIndex,
file: file, line: line)
}
var description: String {
"Incremental imports \(incrementalImports)"
}
func failMessage(_ step: Step) -> String {
"\(description), in step \(stepIndex), \(step.whatIsBuilt)"
}
func fail(_ msg: String, _ step: Step) {
XCTFail("\(msg) \(failMessage(step))")
}
}
// MARK: Paths
extension Context {
/// Computes the directory containing the given module's build products.
///
/// - Parameter module: The module.
/// - Returns: An absolute path to the build root - relative to the root
/// directory of this test context.
func buildRoot(for module: Module) -> AbsolutePath {
self.rootDir.appending(component: "\(module.name)-buildroot")
}
/// Computes the directory containing the given module's source files.
///
/// - Parameter module: The module.
/// - Returns: An absolute path to the build root - relative to the root
/// directory of this test context.
func sourceRoot(for module: Module) -> AbsolutePath {
self.rootDir.appending(component: "\(module.name)-srcroot")
}
/// Computes the path to the output file map for the given module.
///
/// - Parameter module: The module.
/// - Returns: An absolute path to the output file map - relative to the root
/// directory of this test context.
func outputFileMapPath(for module: Module) -> AbsolutePath {
self.buildRoot(for: module).appending(component: "OFM")
}
/// Computes the path to the `.swiftmodule` file for the given module.
///
/// - Parameter module: The module.
/// - Returns: An absolute path to the swiftmodule file - relative to the root
/// directory of this test context.
func swiftmodulePath(for module: Module) -> AbsolutePath {
self.buildRoot(for: module).appending(component: "\(module.name).swiftmodule")
}
/// Computes the path to the `.swift` file for the given module.
///
/// - Parameter source: The name of the swift file.
/// - Parameter module: The module.
/// - Returns: An absolute path to the swift file - relative to the root
/// directory of this test context.
func swiftFilePath(for source: Source, in module: Module) -> AbsolutePath {
self.sourceRoot(for: module).appending(component: "\(source.name).swift")
}
/// Computes the path to the `.o` file for the given module.
///
/// - Parameter source: The name of the swift file.
/// - Parameter module: The module.
/// - Returns: An absolute path to the object file - relative to the root
/// directory of this test context.
func objectFilePath(for source: Source, in module: Module) -> AbsolutePath {
self.buildRoot(for: module).appending(component: "\(source.name).o")
}
/// Computes the path to the executable file for the given module.
///
/// - Parameter module: The module.
/// - Returns: An absolute path to the executable file - relative to the root
/// directory of this test context.
func executablePath(for module: Module) -> AbsolutePath {
#if os(Windows)
return self.buildRoot(for: module).appending(component: "a.exe")
#else
return self.buildRoot(for: module).appending(component: "a.out")
#endif
}
}
|
