File: SynchronizationTests.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 (169 lines) | stat: -rw-r--r-- 5,306 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
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
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 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 Swift project authors
*/

import XCTest
@testable import SwiftDocC
#if os(Windows)
import func WinSDK.TryAcquireSRWLockExclusive
#endif

private func XCTAssertLockIsUnlocked<T>(_ synced: Synchronized<T>) {
    #if os(macOS) || os(iOS)
    XCTAssertTrue(os_unfair_lock_trylock(synced.lock))
    #elseif os(Windows)
    XCTAssertNotEqual(TryAcquireSRWLockExclusive(synced.lock), 0)
    #else
    XCTAssertEqual(pthread_mutex_trylock(synced.lock), 0)
    #endif
}

private func XCTAssertLockIsLocked<T>(_ synced: Synchronized<T>) {
    #if os(macOS) || os(iOS)
    XCTAssertFalse(os_unfair_lock_trylock(synced.lock))
    #elseif os(Windows)
    XCTAssertEqual(TryAcquireSRWLockExclusive(synced.lock), 0)
    #else
    XCTAssertNotEqual(pthread_mutex_trylock(synced.lock), 0)
    #endif
}

class SynchronizationTests: XCTestCase {
    func testInitialState() {
        let synced = Synchronized(false)
        
        // Verify the value was stored
        XCTAssertEqual(synced.sync({ $0 }), false)
        
        // Verify the lock is unlocked
        XCTAssertLockIsUnlocked(synced)
    }
    
    func testUpdatesWrappedValue() {
        let synced = Synchronized(false)
        synced.sync({ $0 = true })
        XCTAssertEqual(synced.sync({ $0 }), true)
    }
    
    func testUnlocksLockWhenDoneWithWork() {
        let synced = Synchronized(false)
        
        // Run a sync block
        synced.sync({ $0 = true })
        
        // Verify the block was executed
        XCTAssertEqual(synced.sync({ $0 }), true)
        
        // Verify the lock is unlocked after running the block
        XCTAssertLockIsUnlocked(synced)
    }
    
    func testLocksLockDuringPerformingWork() {
        let synced = Synchronized(false)
        
        let didTest = expectation(description: "Did test if lock is locked")
        
        let testQueue = DispatchQueue(label: "Lock Test Queue", qos: .default, attributes: .concurrent)

        // Schedule the synchronized block of work asynchronously
        testQueue.async {
            synced.sync { _ in Thread.sleep(forTimeInterval: 5) }
        }
        
        // Asynchronously perform a check after 0.25 secs that the lock is locked
        testQueue.asyncAfter(deadline: .now() + 0.25) {
            // Verify the used lock is lock in here
            XCTAssertLockIsLocked(synced)
            didTest.fulfill()
        }

        wait(for: [didTest], timeout: 7)
    }
    
    enum MyError: Foundation.LocalizedError {
        case test
        var errorDescription: String? { return "My test error" }
    }
    
    func testRethrowsAndUnlocks() {
        let synced = Synchronized(false)
        
        XCTAssertThrowsError(try synced.sync({ _ in throw MyError.test }), "withLock() didn't rethrow") { error in
            XCTAssertEqual(error.localizedDescription, "My test error")
        }
        
        // Verify that the lock is unlocked after re-throwing
        XCTAssertLockIsUnlocked(synced)
    }

    func testBlocking() {
        let synced = Synchronized(false)
        
        let didTest = expectation(description: "Did test if lock is locked")
        
        let testQueue = DispatchQueue(label: "Lock Test Queue", qos: .default, attributes: .concurrent)

        // Block the access for a second, then update to `true`
        testQueue.async {
            synced.sync {
                Thread.sleep(forTimeInterval: 1)
                $0 = true
            }
        }
        
        testQueue.asyncAfter(deadline: .now() + 0.25) {
            // Assert that syncValue() returns when the previous block is finished and updated the value.
            XCTAssertEqual(synced.sync({ $0 }), true)
            didTest.fulfill()
        }

        wait(for: [didTest], timeout: 2)
        
        // The final state of the wrapped value
        XCTAssertEqual(synced.sync({ $0 }), true)
    }
    
    func testGenericLockInitialState() {
        let synced = Lock()
                
        // Verify the lock is unlocked
        XCTAssertLockIsUnlocked(synced)
    }
    
    func testBlockingWithLock() {
        let synced = Lock()
        var value = false
        
        let didTest = expectation(description: "Did test if lock is locked")
        
        let testQueue = DispatchQueue(label: "Lock Test Queue", qos: .default, attributes: .concurrent)

        // Block the access for a second, then update to `true`
        testQueue.async {
            synced.sync {
                Thread.sleep(forTimeInterval: 5)
                value = true
            }
        }
        
        testQueue.asyncAfter(deadline: .now() + 0.25) {
            // Assert that the lock is blocking access
            XCTAssertEqual(value, false)
            let syncedValue = synced.sync({ value })
            XCTAssertEqual(syncedValue, true)
            didTest.fulfill()
        }

        wait(for: [didTest], timeout: 7)
        
        // The final state of the value
        XCTAssertEqual(value, true)
    }

}