File: XCTestUtils.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 (56 lines) | stat: -rw-r--r-- 2,112 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
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftCrypto open source project
//
// Copyright (c) 2019-2020 Apple Inc. and the SwiftCrypto project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.md for the list of SwiftCrypto project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
import XCTest

// Xcode 11.4 catches errors thrown during tests and reports them on the
// correct line. But Linux and older Xcodes do not, so we need to use this
// wrapper as long as those platforms are supported.
func orFail<T>(file: StaticString = #file, line: UInt = #line, _ closure: () throws -> T) throws -> T {
    func wrapper<U>(_ closure: () throws -> U, file: StaticString, line: UInt) throws -> U {
        do {
            return try closure()
        } catch {
            XCTFail("Function threw error: \(error)", file: file, line: line)
            throw error
        }
    }

    if #available(macOS 10.15.4, macCatalyst 13.4, iOS 13.4, tvOS 13.4, watchOS 6.0, *) {
        return try closure()
    } else {
        return try wrapper(closure, file: file, line: line)
    }
}

extension XCTestCase {
    struct OptionalUnwrappingError: Error {
        let file: StaticString
        let line: UInt
    }

    /// Unwraps the given optional value, or if it is nil, throws an error and
    /// registers an XCTest failure. Meant to be used in a test method that has
    /// been marked as `throws`.
    /// - Note: this is a replacement for `XCTUnwrap`, which is not available
    /// in SPM command line builds as of this writing: <https://bugs.swift.org/browse/SR-11501>
    func unwrap<T>(_ optional: T?, file: StaticString = (#file), line: UInt = #line) throws -> T {
        guard let wrapped = optional else {
            XCTFail("Optional was nil", file: file, line: line)
            throw OptionalUnwrappingError(file: file, line: line)
        }

        return wrapped
    }

}