File: XCTWaiter%2BValidation.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 (92 lines) | stat: -rw-r--r-- 3,726 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
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2018 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
//
//
//  XCTWaiter+Validation.swift
//
#if !DISABLE_XCTWAITER

protocol XCTWaiterValidatableExpectation: Equatable {
    var isFulfilled: Bool { get }
    var fulfillmentToken: UInt64 { get }
    var isInverted: Bool { get }
}

extension XCTWaiter {
    struct ValidatableXCTestExpectation: XCTWaiterValidatableExpectation {
        let expectation: XCTestExpectation

        var isFulfilled: Bool {
            return expectation.queue_isFulfilled
        }

        var fulfillmentToken: UInt64 {
            return expectation.queue_fulfillmentToken
        }

        var isInverted: Bool {
            return expectation.queue_isInverted
        }
    }
}

extension XCTWaiter {
    enum ValidationResult<ExpectationType: XCTWaiterValidatableExpectation> {
        case complete
        case fulfilledInvertedExpectation(invertedExpectation: ExpectationType)
        case violatedOrderingConstraints(expectation: ExpectationType, requiredExpectation: ExpectationType)
        case timedOut(unfulfilledExpectations: [ExpectationType])
        case incomplete
    }

    static func validateExpectations<ExpectationType: XCTWaiterValidatableExpectation>(_ expectations: [ExpectationType], dueToTimeout didTimeOut: Bool, enforceOrder: Bool) -> ValidationResult<ExpectationType> {
        var unfulfilledExpectations = [ExpectationType]()
        var fulfilledExpectations = [ExpectationType]()

        for expectation in expectations {
            if expectation.isFulfilled {
                // Check for any fulfilled inverse expectations. If they were fulfilled before wait was called,
                // this is where we'd catch that.
                if expectation.isInverted {
                    return .fulfilledInvertedExpectation(invertedExpectation: expectation)
                } else {
                    fulfilledExpectations.append(expectation)
                }
            } else {
                unfulfilledExpectations.append(expectation)
            }
        }

        if enforceOrder {
            fulfilledExpectations.sort { $0.fulfillmentToken < $1.fulfillmentToken }
            let nonInvertedExpectations = expectations.filter { !$0.isInverted }

            assert(fulfilledExpectations.count <= nonInvertedExpectations.count, "Internal error: number of fulfilledExpectations (\(fulfilledExpectations.count)) must not exceed number of non-inverted expectations (\(nonInvertedExpectations.count))")

            for (fulfilledExpectation, nonInvertedExpectation) in zip(fulfilledExpectations, nonInvertedExpectations) where fulfilledExpectation != nonInvertedExpectation {
                return .violatedOrderingConstraints(expectation: fulfilledExpectation, requiredExpectation: nonInvertedExpectation)
            }
        }

        if unfulfilledExpectations.isEmpty {
            return .complete
        } else if didTimeOut {
            // If we've timed out, our new state is just based on whether or not we have any remaining unfulfilled, non-inverted expectations.
            let nonInvertedUnfilledExpectations = unfulfilledExpectations.filter { !$0.isInverted }
            if nonInvertedUnfilledExpectations.isEmpty {
                return .complete
            } else {
                return .timedOut(unfulfilledExpectations: nonInvertedUnfilledExpectations)
            }
        }

        return .incomplete
    }
}

#endif