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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org 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 https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
// Loosely adapted from https://github.com/apple/swift/tree/main/stdlib/private/StdlibCollectionUnittest
// FIXME: Port all of the collection validation tests from the Swift compiler codebase.
import XCTest
// FIXME: Port the collection validation tests from the Swift compiler codebase.
extension Sequence {
func _contentsByIterator() -> [Element] {
var result: [Element] = []
var it = makeIterator()
while let item = it.next() {
result.append(item)
}
return result
}
func _contentsByCopyContents(_ count: Int? = nil) -> [Element] {
var it: Iterator?
var result = Array(
unsafeUninitializedCapacity: count ?? self.underestimatedCount
) { buffer, count in
(it, count) = self._copyContents(initializing: buffer)
}
while let next = it!.next() {
result.append(next)
}
return result
}
}
extension Collection {
func _indicesByIndexAfter() -> [Index] {
var result: [Index] = []
var i = startIndex
while i != endIndex {
result.append(i)
i = index(after: i)
}
return result
}
func _indicesByFormIndexAfter() -> [Index] {
var result: [Index] = []
var i = startIndex
while i != endIndex {
result.append(i)
formIndex(after: &i)
}
return result
}
}
public func checkCollection<C: Collection, Expected: Sequence>(
_ collection: C,
expectedContents: Expected,
maxSamples: Int? = nil,
file: StaticString = #file,
line: UInt = #line
) where C.Element: Equatable, Expected.Element == C.Element {
let expectedContents = Array(expectedContents)
checkCollection(
collection,
expectedContents: expectedContents,
by: ==,
maxSamples: maxSamples,
file: file, line: line)
let indicesByIndexAfter = collection._indicesByIndexAfter()
for item in expectedContents {
if let first = collection._customIndexOfEquatableElement(item) {
expectNotNil(first) { first in
expectEqual(collection[first], item)
let expected = expectedContents.firstIndex(of: item)!
expectEqual(first, indicesByIndexAfter[expected])
}
}
if let last = collection._customLastIndexOfEquatableElement(item) {
expectNotNil(last) { last in
expectEqual(collection[last], item)
let expected = expectedContents.lastIndex(of: item)!
expectEqual(last, indicesByIndexAfter[expected])
}
}
}
}
public func checkCollection<C: Collection, Expected: Sequence>(
_ collection: C,
expectedContents: Expected,
by areEquivalent: (C.Element, C.Element) -> Bool,
maxSamples: Int? = nil,
file: StaticString = #file,
line: UInt = #line
) where Expected.Element == C.Element {
checkSequence(
{ collection },
expectedContents: expectedContents,
by: areEquivalent,
file: file, line: line)
_checkCollection(
collection,
expectedContents: expectedContents,
by: areEquivalent,
maxSamples: maxSamples,
file: file, line: line)
}
public func _checkCollection<C: Collection, Expected: Sequence>(
_ collection: C,
expectedContents: Expected,
by areEquivalent: (C.Element, C.Element) -> Bool,
maxSamples: Int? = nil,
file: StaticString = #file,
line: UInt = #line
) where Expected.Element == C.Element {
let entry = TestContext.current.push("checkCollection", file: file, line: line)
defer { TestContext.current.pop(entry) }
let expectedContents = Array(expectedContents)
expectEqual(collection.isEmpty, expectedContents.isEmpty)
expectEqual(collection.count, expectedContents.count)
// Check that `index(after:)` produces the same results as `formIndex(after:)`
let indicesByIndexAfter = collection._indicesByIndexAfter()
let indicesByFormIndexAfter = collection._indicesByFormIndexAfter()
expectEqual(indicesByIndexAfter, indicesByFormIndexAfter)
// Check contents using the iterator.
expectEquivalentElements(
collection._contentsByIterator(),
expectedContents,
by: areEquivalent)
// Check _copyContents.
expectEquivalentElements(
collection._contentsByCopyContents(),
expectedContents,
by: areEquivalent)
// Check contents using indexing.
let indexContents1 = indicesByIndexAfter.map { collection[$0] }
expectEquivalentElements(indexContents1, expectedContents, by: areEquivalent)
let indexContents2 = indicesByFormIndexAfter.map { collection[$0] }
expectEquivalentElements(indexContents2, expectedContents, by: areEquivalent)
// Check the endIndex.
expectEqual(collection.endIndex, collection.indices.endIndex)
// Quickly check the Indices associated type
expectEqual(collection.indices.count, collection.count)
expectEqualElements(collection.indices, indicesByIndexAfter)
expectEqual(collection.indices.endIndex, collection.endIndex)
// The sequence of indices must be monotonically increasing.
var allIndices = indicesByIndexAfter
allIndices.append(collection.endIndex)
if C.Index.self != Int.self {
checkComparable(
allIndices,
oracle: { .comparing($0, $1) },
maxSamples: maxSamples)
}
// Check `index(_,offsetBy:limitedBy:)`
let limits =
Set([0, allIndices.count - 1, allIndices.count / 2])
.sorted()
withEvery("limit", in: limits) { limit in
withEvery("i", in: 0 ..< allIndices.count) { i in
let max = allIndices.count - i + (limit >= i ? 2 : 0)
withEvery("delta", in: 0 ..< max) { delta in
let actual = collection.index(
allIndices[i],
offsetBy: delta,
limitedBy: allIndices[limit])
let j = i + delta
let expected = i > limit || j <= limit ? allIndices[j] : nil
expectEqual(actual, expected)
}
}
}
withSomeRanges(
"range", in: 0 ..< allIndices.count - 1, maxSamples: maxSamples
) { range in
let i = range.lowerBound
let j = range.upperBound
// Check `index(_,offsetBy:)`
let e = collection.index(allIndices[i], offsetBy: j - i)
expectEqual(e, allIndices[j])
if j < expectedContents.count {
expectEquivalent(collection[e], expectedContents[j], by: areEquivalent)
}
// Check `distance(from:to:)`
let d = collection.distance(from: allIndices[i], to: allIndices[j])
expectEqual(d, j - i)
// Check slicing.
let range = allIndices[i] ..< allIndices[j]
let slice = collection[range]
expectEqual(slice.count, j - i)
expectEqual(slice.isEmpty, i == j)
expectEqual(slice.startIndex, allIndices[i])
expectEqual(slice.endIndex, allIndices[j])
expectEqual(slice.distance(from: allIndices[i], to: allIndices[j]), j - i)
expectEqual(slice.index(allIndices[i], offsetBy: j - i), allIndices[j])
expectEqual(slice.index(allIndices[i], offsetBy: j - i, limitedBy: allIndices[j]),
allIndices[j])
expectEqual(slice.index(allIndices[i], offsetBy: j - i, limitedBy: allIndices[i]),
j - i > 0 ? nil : allIndices[i])
expectEqual(slice.index(allIndices[i], offsetBy: j - i, limitedBy: allIndices[0]),
i > 0 || j == 0 ? allIndices[j] : nil)
expectEquivalentElements(slice, expectedContents[i ..< j],
by: areEquivalent)
expectEquivalentElements(
slice._contentsByIterator(), expectedContents[i ..< j],
by: areEquivalent)
expectEquivalentElements(
slice._contentsByCopyContents(), expectedContents[i ..< j],
by: areEquivalent)
// Check _copyContents.
let copyContents = collection._contentsByCopyContents()
expectEquivalentElements(
copyContents, expectedContents,
by: areEquivalent)
expectEqualElements(slice._indicesByIndexAfter(), allIndices[i ..< j])
expectEqualElements(slice._indicesByFormIndexAfter(), allIndices[i ..< j])
expectEqualElements(slice.indices, allIndices[i ..< j])
expectEqualElements(slice.indices._indicesByIndexAfter(), allIndices[i ..< j])
expectEqualElements(slice.indices._indicesByFormIndexAfter(), allIndices[i ..< j])
// Check the subsequence iterator.
expectEquivalentElements(
slice, expectedContents[i ..< j],
by: areEquivalent)
// Check the subsequence subscript.
withSome("k", in: i ..< j, maxSamples: 25) { k in
expectEquivalent(
slice[allIndices[k]],
expectedContents[k],
by: areEquivalent)
}
// Check _copyToContiguousArray.
expectEquivalentElements(
Array(slice), expectedContents[i ..< j],
by: areEquivalent)
// Check slicing of slices.
expectEquivalentElements(
slice[range], expectedContents[i ..< j],
by: areEquivalent)
}
if C.Indices.self != C.self && C.Indices.self != DefaultIndices<C>.self {
// Do a more exhaustive check on Indices.
TestContext.current.withTrace("Indices") {
checkCollection(
collection.indices,
expectedContents: indicesByIndexAfter,
maxSamples: maxSamples)
}
}
}
|