summaryrefslogtreecommitdiffhomepage
path: root/ios/MullvadRESTTests/MullvadApiTests.swift
blob: 8111e1b16dcbd9e59440949efe75368a41fc9a57 (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
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
//
//  MullvadApiTests.swift
//  MullvadVPN
//
//  Created by Steffen Ernst on 2025-02-27.
//  Copyright © 2025 Mullvad VPN AB. All rights reserved.
//

import MullvadMockData
import MullvadRustRuntime
import MullvadTypes
import Network
import XCTest

@testable import MullvadREST

/// This tests main purpose is to test the functionallity of the FFI rather than every function of the proxy itself.
/// It makes sure the response and errors are parsed correctly.

class MullvadApiTests: XCTestCase {
    let encoder = JSONEncoder()
    let addressCache = REST.AddressCache(canWriteToCache: false, fileCache: MemoryCache())

    func makeApiProxy(port: UInt16) throws -> APIQuerying {
        let shadowsocksLoader = ShadowsocksLoaderStub(
            configuration: ShadowsocksConfiguration(
                address: .ipv4(.loopback),
                port: 1080,
                password: "123",
                cipher: CipherIdentifiers.CHACHA20.description
            ))

        let accessMethodsRepository = AccessMethodRepositoryStub.stub

        let context = try MullvadApiContext(
            host: "localhost",
            address: "\(IPv4Address.loopback.debugDescription):\(port)",
            domain: REST.encryptedDNSHostname,
            disableTls: true,
            shadowsocksProvider: shadowsocksLoader,
            accessMethodWrapper: initAccessMethodSettingsWrapper(
                methods:
                    accessMethodsRepository
                    .fetchAll()
            ),
            addressCacheProvider: addressCache,
            accessMethodChangeListeners: []
        )

        let proxy = REST.MullvadAPIProxy(
            transportProvider: APITransportProvider(
                requestFactory: .init(
                    apiContext: context,
                    encoder: JSONEncoder()
                )
            ),
            dispatchQueue: .main,
            responseDecoder: REST.Coding.makeJSONDecoder()
        )

        return proxy
    }

    func testSuccessfulResponse() async throws {
        let expectedEndpoints: [AnyIPEndpoint] = [AnyIPEndpoint(string: "12.34.56.78:80")!]

        let bodyData = try encoder.encode(expectedEndpoints)
        let body = String(data: bodyData, encoding: .utf8)!
        let responseCode: UInt = 200
        let mock = mullvad_api_mock_get(
            "/app/v1/api-addrs",
            UInt(responseCode),
            body
        )
        defer { mullvad_api_mock_drop(mock) }
        let apiProxy = try makeApiProxy(port: mock.port)

        let result: Result<[AnyIPEndpoint], Error> = await withCheckedContinuation { continuation in
            _ =
                apiProxy
                .getAddressList(
                    retryStrategy: .noRetry
                ) { result in
                    continuation.resume(returning: result)
                }
        }

        guard let receivedEndpoints = result.value else {
            XCTFail(result.error!.localizedDescription)
            return
        }

        XCTAssertEqual(receivedEndpoints, expectedEndpoints)
    }

    func testHTTPError() async throws {
        let expectedResponseCode = 500
        let mock = mullvad_api_mock_get(
            "/app/v1/api-addrs",
            UInt(expectedResponseCode),
            ""
        )
        defer { mullvad_api_mock_drop(mock) }
        let apiProxy = try makeApiProxy(port: mock.port)

        let result: Result<[AnyIPEndpoint], Error> = await withCheckedContinuation { continuation in
            _ =
                apiProxy
                .getAddressList(
                    retryStrategy: .noRetry
                ) { result in
                    continuation.resume(returning: result)
                }
        }

        let error = try XCTUnwrap(result.error as? REST.Error)

        switch error {
        case let .unhandledResponse(responseCode, _):
            XCTAssertEqual(responseCode, expectedResponseCode)
        default:
            XCTFail("GetAddressList failed with the wrong error: \(error)")
        }
    }

    func testInvalidBody() async throws {
        let expectedResponseCode = 200
        let mock = mullvad_api_mock_get(
            "/app/v1/api-addrs",
            UInt(expectedResponseCode),
            "This is an invalid JSON"
        )
        defer { mullvad_api_mock_drop(mock) }
        let apiProxy = try makeApiProxy(port: mock.port)

        let result: Result<[AnyIPEndpoint], Error> = await withCheckedContinuation { continuation in
            _ =
                apiProxy
                .getAddressList(
                    retryStrategy: .noRetry
                ) { result in
                    continuation.resume(returning: result)
                }
        }

        let error = try XCTUnwrap(result.error as? REST.Error)

        switch error {
        case let .unhandledResponse(_, response):
            XCTAssertEqual(response?.code, REST.ServerResponseCode.parsingError)
        default:
            XCTFail("GetAddressList failed with the wrong error: \(error)")
        }
    }

    func testCustomErrorCode() async throws {
        let expectedResponseCode = 400
        let expectedErrorCode = 123
        let mock = mullvad_api_mock_get(
            "/app/v1/api-addrs",
            UInt(expectedResponseCode),
            """
            {"code": "\(expectedErrorCode)",
            "error": "A magical error occurred"
            }
            """
        )
        defer { mullvad_api_mock_drop(mock) }
        let apiProxy = try makeApiProxy(port: mock.port)

        let result: Result<[AnyIPEndpoint], Error> = await withCheckedContinuation { continuation in
            _ =
                apiProxy
                .getAddressList(
                    retryStrategy: .noRetry
                ) { result in
                    continuation.resume(returning: result)
                }
        }

        let error = try XCTUnwrap(result.error as? REST.Error)

        switch error {
        case let .unhandledResponse(responseCode, response):
            XCTAssertEqual(responseCode, expectedResponseCode)
            guard let response else {
                XCTFail("Expected error response object, but got nil")
                return
            }
            XCTAssertEqual(response.code.rawValue, String(expectedErrorCode))
        default:
            XCTFail("GetAddressList failed with the wrong error: \(error)")
        }
    }

    // This test makes sure the body gets encoded correct.
    func testSuccessfulPostRequest() async throws {
        let problemReportRequest = ProblemReportRequest(
            address: "test@email.com",
            message: "This test should succeed",
            log: "A long log string",
            metadata: [:]
        )

        // The mock server will only responde to requests with `matchBodyString` as body.
        let matchBodyString = String(data: try encoder.encode(problemReportRequest), encoding: .utf8)!
        let expectedResponseCode: UInt = 204
        let mock = mullvad_api_mock_post(
            "/app/v1/problem-report",
            UInt(expectedResponseCode),
            matchBodyString
        )
        defer { mullvad_api_mock_drop(mock) }
        let apiProxy = try makeApiProxy(port: mock.port)

        let result: Result<Void, Error> = await withCheckedContinuation { continuation in
            _ =
                apiProxy
                .sendProblemReport(
                    problemReportRequest,
                    retryStrategy:
                        .noRetry
                ) { result in
                    continuation.resume(returning: result)
                }
        }

        XCTAssertNil(result.error)
    }
}