summaryrefslogtreecommitdiffhomepage
path: root/ios/PacketTunnelCoreTests/EventChannelTests.swift
blob: 5661f34e9a19f7441bca3bcfa2fe7f616e76a723 (plain)
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
//
//  EventChannelTests.swift
//  PacketTunnelCoreTests
//
//  Created by pronebird on 27/09/2023.
//  Copyright © 2025 Mullvad VPN AB. All rights reserved.
//  Formerly known as CommandChannelTests
//

import XCTest

@testable import MullvadMockData
@testable import PacketTunnelCore

final class EventChannelTests: XCTestCase {
    func testCoalescingReconnect() async {
        let channel = PacketTunnelActor.EventChannel()

        channel.send(.start(StartOptions(launchSource: .app)))
        channel.send(.reconnect(.random))
        channel.send(.reconnect(.random))
        channel.send(.switchKey)
        channel.send(.reconnect(.current))
        channel.sendEnd()

        let events = await channel.map { $0.primitiveCommand }.collect()

        XCTAssertEqual(events, [.start, .switchKey, .reconnect(.current)])
    }

    /// Test that stops cancels all preceding tasks.
    func testCoalescingStop() async {
        let channel = PacketTunnelActor.EventChannel()

        channel.send(.start(StartOptions(launchSource: .app)))
        channel.send(.reconnect(.random))
        channel.send(.stop)
        channel.send(.reconnect(.current))
        channel.send(.stop)
        channel.send(.switchKey)
        channel.sendEnd()

        let events = await channel.map { $0.primitiveCommand }.collect()

        XCTAssertEqual(events, [.stop, .switchKey])
    }

    /// Test that iterations over the finished channel yield `nil`.
    func testFinishFlushingUnconsumedValues() async {
        let channel = PacketTunnelActor.EventChannel()
        channel.send(.stop)
        channel.finish()

        let value = await channel.makeAsyncIterator().next()
        XCTAssertNil(value)
    }

    /// Test that the call to `finish()` ends the iteration that began prior to that.
    func testFinishEndsAsyncIterator() async throws {
        let channel = PacketTunnelActor.EventChannel()
        let expectFinish = expectation(description: "Call to finish()")
        let expectEndIteration = expectation(description: "Iteration over channel should end upon call to finish()")

        // Start iterating over events in channel. The for-await loop should suspend the continuation.
        Task {
            for await event in channel {
                print(event)
            }

            expectEndIteration.fulfill()
        }

        // Tell channel to finish() after a small delay. This should resume execution in the task above and exit the
        // for-await loop.
        Task {
            try await Task.sleep(nanoseconds: 1_000_000)

            expectFinish.fulfill()
            channel.finish()
        }

        await fulfillment(of: [expectFinish, expectEndIteration], timeout: .UnitTest.timeout, enforceOrder: true)
    }
}

extension AsyncSequence {
    func collect() async rethrows -> [Element] {
        try await reduce(into: [Element]()) { $0.append($1) }
    }
}

/// Simplified version of `Event` that can be used in tests and easily compared against.
enum SimplifiedEvent: Equatable {
    case start, stop
    case reconnect(NextRelays)
    case switchKey, other
}

extension PacketTunnelActor.Event {
    var primitiveCommand: SimplifiedEvent {
        switch self {
        case .start:
            return .start
        case let .reconnect(nextRelay, _):
            return .reconnect(nextRelay)
        case .switchKey:
            return .switchKey
        case .stop:
            return .stop
        default:
            return .other
        }
    }
}