mirror of
https://github.com/Novaloop-AG/element-x-ios.git
synced 2026-11-03 06:31:27 +00:00
Swift Testing for Unit Tests PART 1 (#5119)
* migrated a lot of unit tests to Swift Testing and added a new implementation for deferred fulfillment more tests migration Cleaned the code manually to establish some good patterns more code improvements some more code improvements removed empty tests update project * more pr suggestions and cleanups * removed the TestSetup pattern * fixing claude not reusing tests * pr suggestion + added indent rule to swiftformat so that we can prevent AIs to change that
This commit is contained in:
Mauro
GitHub
@@ -7,22 +7,25 @@
|
||||
//
|
||||
|
||||
@testable import ElementX
|
||||
import Foundation
|
||||
import KeychainAccess
|
||||
import XCTest
|
||||
import Testing
|
||||
|
||||
class KeychainControllerTests: XCTestCase {
|
||||
var keychain: KeychainController!
|
||||
@Suite
|
||||
struct KeychainControllerTests {
|
||||
var keychain: KeychainController
|
||||
|
||||
override func setUp() {
|
||||
init() {
|
||||
keychain = KeychainController(service: .tests,
|
||||
accessGroup: InfoPlistReader.main.keychainAccessGroupIdentifier)
|
||||
keychain.removeAllRestorationTokens()
|
||||
keychain.resetSecrets()
|
||||
}
|
||||
|
||||
func testAddRestorationToken() {
|
||||
@Test
|
||||
func addRestorationToken() {
|
||||
// Given an empty keychain.
|
||||
XCTAssertTrue(keychain.restorationTokens().isEmpty, "The keychain should be empty to begin with.")
|
||||
#expect(keychain.restorationTokens().isEmpty, "The keychain should be empty to begin with.")
|
||||
|
||||
// When adding an restoration token.
|
||||
let username = "@test:example.com"
|
||||
@@ -39,10 +42,11 @@ class KeychainControllerTests: XCTestCase {
|
||||
keychain.setRestorationToken(restorationToken, forUsername: username)
|
||||
|
||||
// Then the restoration token should be stored in the keychain.
|
||||
XCTAssertEqual(keychain.restorationTokenForUsername(username), restorationToken, "The retrieved restoration token should match the value that was stored.")
|
||||
#expect(keychain.restorationTokenForUsername(username) == restorationToken, "The retrieved restoration token should match the value that was stored.")
|
||||
}
|
||||
|
||||
func testRemovingRestorationToken() {
|
||||
@Test
|
||||
func removingRestorationToken() {
|
||||
// Given a keychain with a stored restoration token.
|
||||
let username = "@test:example.com"
|
||||
let restorationToken = RestorationToken(session: .init(accessToken: "accessToken",
|
||||
@@ -56,18 +60,19 @@ class KeychainControllerTests: XCTestCase {
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: username)
|
||||
XCTAssertEqual(keychain.restorationTokens().count, 1, "The keychain should have 1 restoration token.")
|
||||
XCTAssertEqual(keychain.restorationTokenForUsername(username), restorationToken, "The initial restoration token should match the value that was stored.")
|
||||
#expect(keychain.restorationTokens().count == 1, "The keychain should have 1 restoration token.")
|
||||
#expect(keychain.restorationTokenForUsername(username) == restorationToken, "The initial restoration token should match the value that was stored.")
|
||||
|
||||
// When deleting the restoration token.
|
||||
keychain.removeRestorationTokenForUsername(username)
|
||||
|
||||
// Then the keychain should be empty.
|
||||
XCTAssertTrue(keychain.restorationTokens().isEmpty, "The keychain should be empty after deleting the token.")
|
||||
XCTAssertNil(keychain.restorationTokenForUsername(username), "There restoration token should not be returned after removal.")
|
||||
#expect(keychain.restorationTokens().isEmpty, "The keychain should be empty after deleting the token.")
|
||||
#expect(keychain.restorationTokenForUsername(username) == nil, "There restoration token should not be returned after removal.")
|
||||
}
|
||||
|
||||
func testRemovingAllRestorationTokens() {
|
||||
@Test
|
||||
func removingAllRestorationTokens() {
|
||||
// Given a keychain with 5 stored restoration tokens.
|
||||
for index in 0..<5 {
|
||||
let restorationToken = RestorationToken(session: .init(accessToken: "accessToken",
|
||||
@@ -82,16 +87,17 @@ class KeychainControllerTests: XCTestCase {
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: "@test\(index):example.com")
|
||||
}
|
||||
XCTAssertEqual(keychain.restorationTokens().count, 5, "The keychain should have 5 restoration tokens.")
|
||||
#expect(keychain.restorationTokens().count == 5, "The keychain should have 5 restoration tokens.")
|
||||
|
||||
// When deleting all of the restoration tokens.
|
||||
keychain.removeAllRestorationTokens()
|
||||
|
||||
// Then the keychain should be empty.
|
||||
XCTAssertTrue(keychain.restorationTokens().isEmpty, "The keychain should be empty after deleting the token.")
|
||||
#expect(keychain.restorationTokens().isEmpty, "The keychain should be empty after deleting the token.")
|
||||
}
|
||||
|
||||
func testRemovingSingleRestorationTokens() {
|
||||
@Test
|
||||
func removingSingleRestorationTokens() {
|
||||
// Given a keychain with 5 stored restoration tokens.
|
||||
for index in 0..<5 {
|
||||
let restorationToken = RestorationToken(session: .init(accessToken: "accessToken",
|
||||
@@ -106,137 +112,140 @@ class KeychainControllerTests: XCTestCase {
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: "@test\(index):example.com")
|
||||
}
|
||||
XCTAssertEqual(keychain.restorationTokens().count, 5, "The keychain should have 5 restoration tokens.")
|
||||
#expect(keychain.restorationTokens().count == 5, "The keychain should have 5 restoration tokens.")
|
||||
|
||||
// When deleting one of the restoration tokens.
|
||||
keychain.removeRestorationTokenForUsername("@test2:example.com")
|
||||
|
||||
// Then the other 4 items should remain untouched.
|
||||
XCTAssertEqual(keychain.restorationTokens().count, 4, "The keychain have 4 remaining restoration tokens.")
|
||||
XCTAssertNotNil(keychain.restorationTokenForUsername("@test0:example.com"), "The restoration token should not have been deleted.")
|
||||
XCTAssertNotNil(keychain.restorationTokenForUsername("@test1:example.com"), "The restoration token should not have been deleted.")
|
||||
XCTAssertNil(keychain.restorationTokenForUsername("@test2:example.com"), "The restoration token should have been deleted.")
|
||||
XCTAssertNotNil(keychain.restorationTokenForUsername("@test3:example.com"), "The restoration token should not have been deleted.")
|
||||
XCTAssertNotNil(keychain.restorationTokenForUsername("@test4:example.com"), "The restoration token should not have been deleted.")
|
||||
#expect(keychain.restorationTokens().count == 4, "The keychain have 4 remaining restoration tokens.")
|
||||
#expect(keychain.restorationTokenForUsername("@test0:example.com") != nil, "The restoration token should not have been deleted.")
|
||||
#expect(keychain.restorationTokenForUsername("@test1:example.com") != nil, "The restoration token should not have been deleted.")
|
||||
#expect(keychain.restorationTokenForUsername("@test2:example.com") == nil, "The restoration token should have been deleted.")
|
||||
#expect(keychain.restorationTokenForUsername("@test3:example.com") != nil, "The restoration token should not have been deleted.")
|
||||
#expect(keychain.restorationTokenForUsername("@test4:example.com") != nil, "The restoration token should not have been deleted.")
|
||||
}
|
||||
|
||||
func testUnsupportedRestorationToken() {
|
||||
@Test
|
||||
func unsupportedRestorationToken() throws {
|
||||
// Given a keychain with an unsupported restoration token with a sliding sync proxy URL value.
|
||||
let underlyingKeychain = Keychain(service: KeychainControllerService.tests.restorationTokenID,
|
||||
accessGroup: InfoPlistReader.main.keychainAccessGroupIdentifier)
|
||||
// Note: We assert with this underlying keychain's keys as keychain.restorationTokens() triggers the deletion that we're testing.
|
||||
XCTAssertTrue(underlyingKeychain.allKeys().isEmpty, "The keychain should be empty to begin with.")
|
||||
#expect(underlyingKeychain.allKeys().isEmpty, "The keychain should be empty to begin with.")
|
||||
|
||||
do {
|
||||
let unsupportedToken = RestorationTokenV4(session: SessionV1(accessToken: "1234",
|
||||
refreshToken: nil,
|
||||
userId: "@test:example.com",
|
||||
deviceId: "D3V1C3",
|
||||
homeserverUrl: "https://matrix.example.com",
|
||||
oidcData: nil,
|
||||
slidingSyncVersion: .proxy(url: "https://sync.example.com")),
|
||||
sessionDirectory: .sessionsBaseDirectory.appending(component: UUID().uuidString),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
let tokenData = try JSONEncoder().encode(unsupportedToken)
|
||||
try underlyingKeychain.set(tokenData, key: "@test:example.com")
|
||||
XCTAssertEqual(underlyingKeychain.allKeys().count, 1)
|
||||
} catch {
|
||||
XCTFail("Failed storing user restore token with error: \(error)")
|
||||
}
|
||||
let unsupportedToken = RestorationTokenV4(session: SessionV1(accessToken: "1234",
|
||||
refreshToken: nil,
|
||||
userId: "@test:example.com",
|
||||
deviceId: "D3V1C3",
|
||||
homeserverUrl: "https://matrix.example.com",
|
||||
oidcData: nil,
|
||||
slidingSyncVersion: .proxy(url: "https://sync.example.com")),
|
||||
sessionDirectory: .sessionsBaseDirectory.appending(component: UUID().uuidString),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
let tokenData = try JSONEncoder().encode(unsupportedToken)
|
||||
try underlyingKeychain.set(tokenData, key: "@test:example.com")
|
||||
#expect(underlyingKeychain.allKeys().count == 1)
|
||||
|
||||
// When attempting to retrieve the unsupported token.
|
||||
let retrievedToken = keychain.restorationTokenForUsername("@test:example.com")
|
||||
|
||||
// Then nothing should be returned and the restoration token should be automatically removed.
|
||||
XCTAssertNil(retrievedToken, "The token should not be decoded.")
|
||||
XCTAssertTrue(underlyingKeychain.allKeys().isEmpty, "The keychain should be empty again.")
|
||||
#expect(retrievedToken == nil, "The token should not be decoded.")
|
||||
#expect(underlyingKeychain.allKeys().isEmpty, "The keychain should be empty again.")
|
||||
}
|
||||
|
||||
func testAddPINCode() throws {
|
||||
@Test
|
||||
func addPINCode() throws {
|
||||
// Given a keychain without a PIN code set.
|
||||
try XCTAssertFalse(keychain.containsPINCode(), "A new keychain shouldn't contain a PIN code.")
|
||||
XCTAssertNil(keychain.pinCode(), "A new keychain shouldn't return a PIN code.")
|
||||
#expect(try !keychain.containsPINCode(), "A new keychain shouldn't contain a PIN code.")
|
||||
#expect(keychain.pinCode() == nil, "A new keychain shouldn't return a PIN code.")
|
||||
|
||||
// When setting a PIN code.
|
||||
try keychain.setPINCode("0000")
|
||||
|
||||
// Then the PIN code should be stored.
|
||||
try XCTAssertTrue(keychain.containsPINCode(), "The keychain should contain the PIN code.")
|
||||
XCTAssertEqual(keychain.pinCode(), "0000", "The stored PIN code should match what was set.")
|
||||
#expect(try keychain.containsPINCode(), "The keychain should contain the PIN code.")
|
||||
#expect(keychain.pinCode() == "0000", "The stored PIN code should match what was set.")
|
||||
}
|
||||
|
||||
func testUpdatePINCode() throws {
|
||||
@Test
|
||||
func updatePINCode() throws {
|
||||
// Given a keychain with a PIN code already set.
|
||||
try keychain.setPINCode("0000")
|
||||
try XCTAssertTrue(keychain.containsPINCode(), "The keychain should contain the PIN code.")
|
||||
XCTAssertEqual(keychain.pinCode(), "0000", "The stored PIN code should match what was set.")
|
||||
#expect(try keychain.containsPINCode(), "The keychain should contain the PIN code.")
|
||||
#expect(keychain.pinCode() == "0000", "The stored PIN code should match what was set.")
|
||||
|
||||
// When setting a different PIN code.
|
||||
try keychain.setPINCode("1234")
|
||||
|
||||
// Then the PIN code should be updated.
|
||||
try XCTAssertTrue(keychain.containsPINCode(), "The keychain should still contain the PIN code.")
|
||||
XCTAssertEqual(keychain.pinCode(), "1234", "The stored PIN code should match the new value.")
|
||||
#expect(try keychain.containsPINCode(), "The keychain should still contain the PIN code.")
|
||||
#expect(keychain.pinCode() == "1234", "The stored PIN code should match the new value.")
|
||||
}
|
||||
|
||||
func testRemovePINCode() throws {
|
||||
@Test
|
||||
func removePINCode() throws {
|
||||
// Given a keychain with a PIN code already set.
|
||||
try keychain.setPINCode("0000")
|
||||
try XCTAssertTrue(keychain.containsPINCode(), "The keychain should contain the PIN code.")
|
||||
XCTAssertEqual(keychain.pinCode(), "0000", "The stored PIN code should match what was set.")
|
||||
#expect(try keychain.containsPINCode(), "The keychain should contain the PIN code.")
|
||||
#expect(keychain.pinCode() == "0000", "The stored PIN code should match what was set.")
|
||||
|
||||
// When removing the PIN code.
|
||||
keychain.removePINCode()
|
||||
|
||||
// Then the PIN code should no longer be stored.
|
||||
try XCTAssertFalse(keychain.containsPINCode(), "The keychain should no longer contain the PIN code.")
|
||||
XCTAssertNil(keychain.pinCode(), "There shouldn't be a stored PIN code after removing it.")
|
||||
#expect(try !keychain.containsPINCode(), "The keychain should no longer contain the PIN code.")
|
||||
#expect(keychain.pinCode() == nil, "There shouldn't be a stored PIN code after removing it.")
|
||||
}
|
||||
|
||||
func testAddPINCodeBiometricState() throws {
|
||||
@Test
|
||||
func addPINCodeBiometricState() throws {
|
||||
// Given a keychain without any biometric state.
|
||||
XCTAssertFalse(keychain.containsPINCodeBiometricState(), "A new keychain shouldn't contain biometric state.")
|
||||
XCTAssertNil(keychain.pinCodeBiometricState(), "A new keychain shouldn't return biometric state.")
|
||||
#expect(!keychain.containsPINCodeBiometricState(), "A new keychain shouldn't contain biometric state.")
|
||||
#expect(keychain.pinCodeBiometricState() == nil, "A new keychain shouldn't return biometric state.")
|
||||
|
||||
// When setting the state.
|
||||
let data = Data("Face ID".utf8)
|
||||
try keychain.setPINCodeBiometricState(data)
|
||||
|
||||
// Then the state should be stored.
|
||||
XCTAssertTrue(keychain.containsPINCodeBiometricState(), "The keychain should contain the biometric state.")
|
||||
XCTAssertEqual(keychain.pinCodeBiometricState(), data, "The stored biometric state should match what was set.")
|
||||
#expect(keychain.containsPINCodeBiometricState(), "The keychain should contain the biometric state.")
|
||||
#expect(keychain.pinCodeBiometricState() == data, "The stored biometric state should match what was set.")
|
||||
}
|
||||
|
||||
func testUpdatePINCodeBiometricState() throws {
|
||||
@Test
|
||||
func updatePINCodeBiometricState() throws {
|
||||
// Given a keychain that contains PIN code biometric state.
|
||||
let data = Data("😃".utf8)
|
||||
try keychain.setPINCodeBiometricState(data)
|
||||
XCTAssertTrue(keychain.containsPINCodeBiometricState(), "The keychain should contain the biometric state.")
|
||||
XCTAssertEqual(keychain.pinCodeBiometricState(), data, "The stored biometric state should match what was set.")
|
||||
#expect(keychain.containsPINCodeBiometricState(), "The keychain should contain the biometric state.")
|
||||
#expect(keychain.pinCodeBiometricState() == data, "The stored biometric state should match what was set.")
|
||||
|
||||
// When setting different state.
|
||||
let newData = Data("😎".utf8)
|
||||
try keychain.setPINCodeBiometricState(newData)
|
||||
|
||||
// Then the state should be updated.
|
||||
XCTAssertTrue(keychain.containsPINCodeBiometricState(), "The keychain should still contain biometric state.")
|
||||
XCTAssertNotEqual(keychain.pinCodeBiometricState(), data, "The stored biometric state shouldn't match the old value.")
|
||||
XCTAssertEqual(keychain.pinCodeBiometricState(), newData, "The stored biometric state should match the new value.")
|
||||
#expect(keychain.containsPINCodeBiometricState(), "The keychain should still contain biometric state.")
|
||||
#expect(keychain.pinCodeBiometricState() != data, "The stored biometric state shouldn't match the old value.")
|
||||
#expect(keychain.pinCodeBiometricState() == newData, "The stored biometric state should match the new value.")
|
||||
}
|
||||
|
||||
func testRemovePINCodeBiometricState() throws {
|
||||
@Test
|
||||
func removePINCodeBiometricState() throws {
|
||||
// Given a keychain that contains PIN code biometric state.
|
||||
let data = Data("Face ID".utf8)
|
||||
try keychain.setPINCodeBiometricState(data)
|
||||
XCTAssertTrue(keychain.containsPINCodeBiometricState(), "The keychain should contain the biometric state.")
|
||||
XCTAssertEqual(keychain.pinCodeBiometricState(), data, "The stored biometric state should match what was set.")
|
||||
#expect(keychain.containsPINCodeBiometricState(), "The keychain should contain the biometric state.")
|
||||
#expect(keychain.pinCodeBiometricState() == data, "The stored biometric state should match what was set.")
|
||||
|
||||
// When removing the state.
|
||||
keychain.removePINCodeBiometricState()
|
||||
|
||||
// Then the state should no longer be stored.
|
||||
XCTAssertFalse(keychain.containsPINCodeBiometricState(), "The keychain should no longer contain the biometric state.")
|
||||
XCTAssertNil(keychain.pinCodeBiometricState(), "There shouldn't be any stored biometric state after removing it.")
|
||||
#expect(!keychain.containsPINCodeBiometricState(), "The keychain should no longer contain the biometric state.")
|
||||
#expect(keychain.pinCodeBiometricState() == nil, "There shouldn't be any stored biometric state after removing it.")
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user