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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 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
//
//===----------------------------------------------------------------------===//
/// A type that has different `CustomStringConvertible` and
/// `CustomDebugStringConvertible` representations.
///
/// This type also conforms to other protocols, to make it
/// usable in constrained contexts. It is not intended to be a
/// minimal type that only conforms to certain protocols.
///
/// This type can be used to check that code uses the correct
/// kind of string representation.
public struct CustomPrintableValue
: Equatable, Comparable, Hashable, Strideable
{
public static var timesDescriptionWasCalled = ResettableValue(0)
public static var timesDebugDescriptionWasCalled = ResettableValue(0)
public static var descriptionImpl =
ResettableValue<(_ value: Int, _ identity: Int) -> String>({
(value: Int, identity: Int) -> String in
if identity == 0 {
return "(value: \(value)).description"
} else {
return "(value: \(value), identity: \(identity)).description"
}
})
public static var debugDescriptionImpl =
ResettableValue<(_ value: Int, _ identity: Int) -> String>({
(value: Int, identity: Int) -> String in
CustomPrintableValue.timesDescriptionWasCalled.value += 1
if identity == 0 {
return "(value: \(value)).debugDescription"
} else {
return "(value: \(value), identity: \(identity)).debugDescription"
}
})
public var value: Int
public var identity: Int
public init(_ value: Int) {
self.value = value
self.identity = 0
}
public init(_ value: Int, identity: Int) {
self.value = value
self.identity = identity
}
public var hashValue: Int {
return value.hashValue
}
public func hash(into hasher: inout Hasher) {
hasher.combine(value)
}
public typealias Stride = Int
public func distance(to other: CustomPrintableValue) -> Stride {
return other.value - self.value
}
public func advanced(by n: Stride) -> CustomPrintableValue {
return CustomPrintableValue(self.value + n, identity: self.identity)
}
}
public func == (
lhs: CustomPrintableValue,
rhs: CustomPrintableValue
) -> Bool {
return lhs.value == rhs.value
}
public func < (
lhs: CustomPrintableValue,
rhs: CustomPrintableValue
) -> Bool {
return lhs.value < rhs.value
}
extension CustomPrintableValue : CustomStringConvertible {
public var description: String {
CustomPrintableValue.timesDescriptionWasCalled.value += 1
return CustomPrintableValue.descriptionImpl.value(
value, identity)
}
}
extension CustomPrintableValue : CustomDebugStringConvertible {
public var debugDescription: String {
CustomPrintableValue.timesDebugDescriptionWasCalled.value += 1
return CustomPrintableValue.debugDescriptionImpl.value(
value, identity)
}
}
public func expectPrinted<T>(
expectedOneOf patterns: [String], _ object: T,
_ message: @autoclosure () -> String = "",
stackTrace: SourceLocStack = SourceLocStack(),
showFrame: Bool = true,
file: String = #file, line: UInt = #line
) {
let actual = String(describing: object)
if !patterns.contains(actual) {
expectationFailure(
"expected: any of \(String(reflecting: patterns))\n"
+ "actual: \(String(reflecting: actual))",
trace: message(),
stackTrace: stackTrace.pushIf(showFrame, file: file, line: line))
}
}
public func expectPrinted<T>(
_ expected: String, _ object: T,
_ message: @autoclosure () -> String = "",
stackTrace: SourceLocStack = SourceLocStack(),
showFrame: Bool = true,
file: String = #file, line: UInt = #line
) {
expectPrinted(expectedOneOf: [expected], object, message(),
stackTrace: stackTrace.pushIf(showFrame, file: file, line: line))
}
public func expectDebugPrinted<T>(
expectedOneOf patterns: [String], _ object: T,
_ message: @autoclosure () -> String = "",
stackTrace: SourceLocStack = SourceLocStack(),
showFrame: Bool = true,
file: String = #file, line: UInt = #line
) {
expectPrinted(expectedOneOf: patterns, String(reflecting: object), message(),
stackTrace: stackTrace.pushIf(showFrame, file: file, line: line))
}
public func expectDebugPrinted<T>(
_ expected: String, _ object: T,
_ message: @autoclosure () -> String = "",
stackTrace: SourceLocStack = SourceLocStack(),
showFrame: Bool = true,
file: String = #file, line: UInt = #line
) {
expectDebugPrinted(expectedOneOf: [expected], object, message(),
stackTrace: stackTrace.pushIf(showFrame, file: file, line: line))
}
public func expectDumped<T>(
_ expected: String, _ object: T,
_ message: @autoclosure () -> String = "",
stackTrace: SourceLocStack = SourceLocStack(),
showFrame: Bool = true,
file: String = #file, line: UInt = #line
) {
var actual = ""
dump(object, to: &actual)
expectEqual(expected, actual, message(),
stackTrace: stackTrace.pushIf(showFrame, file: file, line: line))
}
|