|
| 1 | +import XCTest |
| 2 | +@testable import WordPress |
| 3 | + |
| 4 | +class KeychainUtilsTests: XCTestCase { |
| 5 | + |
| 6 | + let username = "Username" |
| 7 | + let password = "Password" |
| 8 | + let service = "Service" |
| 9 | + let sharedGroup = WPAppKeychainAccessGroup |
| 10 | + |
| 11 | + override func setUp() { |
| 12 | + super.setUp() |
| 13 | + |
| 14 | + SFHFKeychainUtilsMock.configure(with: [:]) |
| 15 | + } |
| 16 | + |
| 17 | + func testNilAppGroupSavesToSharedGroupWhenFeatureEnabled() { |
| 18 | + let subject = KeychainUtils(shouldUseSharedKeychain: true, keychainUtils: SFHFKeychainUtilsMock.self) |
| 19 | + |
| 20 | + try? subject.storeUsername(username, password: password, serviceName: service, updateExisting: true) |
| 21 | + |
| 22 | + let result = getPassword(username: username, serviceName: service, accessGroup: sharedGroup) |
| 23 | + XCTAssertEqual(result, password) |
| 24 | + } |
| 25 | + |
| 26 | + func testNilAppGroupDoesNotSaveToSharedGroupWhenFeatureDisabled() { |
| 27 | + let subject = KeychainUtils(shouldUseSharedKeychain: false, keychainUtils: SFHFKeychainUtilsMock.self) |
| 28 | + |
| 29 | + try? subject.storeUsername(username, password: password, serviceName: service, updateExisting: true) |
| 30 | + |
| 31 | + let result = getPassword(username: username, serviceName: service, accessGroup: sharedGroup) |
| 32 | + XCTAssertNotEqual(result, password) |
| 33 | + } |
| 34 | + |
| 35 | + func testFeatureFlagChanging() { |
| 36 | + var enabled = false |
| 37 | + let subject = KeychainUtils(shouldUseSharedKeychain: enabled, keychainUtils: SFHFKeychainUtilsMock.self) |
| 38 | + |
| 39 | + enabled = true |
| 40 | + try? subject.storeUsername(username, password: password, serviceName: service, updateExisting: true) |
| 41 | + |
| 42 | + let result = getPassword(username: username, serviceName: service, accessGroup: sharedGroup) |
| 43 | + XCTAssertEqual(result, password) |
| 44 | + } |
| 45 | + |
| 46 | + func testNilAppGroupReadsFromSharedGroupWhenFeatureEnabled() { |
| 47 | + let subject = KeychainUtils(shouldUseSharedKeychain: true, keychainUtils: SFHFKeychainUtilsMock.self) |
| 48 | + storeUsername(username, password: password, serviceName: service, accessGroup: sharedGroup) |
| 49 | + |
| 50 | + let result = try? subject.getPasswordForUsername(username, serviceName: service) |
| 51 | + |
| 52 | + XCTAssertEqual(result, password) |
| 53 | + } |
| 54 | + |
| 55 | + func testNilAppGroupDoesNotReadFromSharedGroupWhenFeatureDisabled() { |
| 56 | + let subject = KeychainUtils(shouldUseSharedKeychain: false, keychainUtils: SFHFKeychainUtilsMock.self) |
| 57 | + storeUsername(username, password: password, serviceName: service, accessGroup: sharedGroup) |
| 58 | + |
| 59 | + let result = try? subject.getPasswordForUsername(username, serviceName: service) |
| 60 | + |
| 61 | + XCTAssertNotEqual(result, password) |
| 62 | + } |
| 63 | + |
| 64 | + func testNilAppGroupDeletesFromSharedGroupWhenEnabled() { |
| 65 | + storeUsername(username, password: password, serviceName: service, accessGroup: sharedGroup) |
| 66 | + storeUsername(username, password: password, serviceName: service, accessGroup: nil) |
| 67 | + let subject = KeychainUtils(shouldUseSharedKeychain: true, keychainUtils: SFHFKeychainUtilsMock.self) |
| 68 | + |
| 69 | + try? subject.deleteItem(username: username, serviceName: service) |
| 70 | + |
| 71 | + XCTAssertNil(getPassword(username: username, serviceName: service, accessGroup: sharedGroup)) |
| 72 | + XCTAssertEqual(getPassword(username: username, serviceName: service, accessGroup: nil), password) |
| 73 | + } |
| 74 | + |
| 75 | + func testNilAppGroupDeletesFromNilGroupWhenDisabled() { |
| 76 | + storeUsername(username, password: password, serviceName: service, accessGroup: sharedGroup) |
| 77 | + storeUsername(username, password: password, serviceName: service, accessGroup: nil) |
| 78 | + let subject = KeychainUtils(shouldUseSharedKeychain: false, keychainUtils: SFHFKeychainUtilsMock.self) |
| 79 | + |
| 80 | + try? subject.deleteItem(username: username, serviceName: service) |
| 81 | + |
| 82 | + XCTAssertEqual(getPassword(username: username, serviceName: service, accessGroup: sharedGroup), password) |
| 83 | + XCTAssertNil(getPassword(username: username, serviceName: service, accessGroup: nil)) |
| 84 | + } |
| 85 | + |
| 86 | + func testAppGroupIsAPassthroughWhenSaving() { |
| 87 | + let group = "Test" |
| 88 | + let subject = KeychainUtils(shouldUseSharedKeychain: true, keychainUtils: SFHFKeychainUtilsMock.self) |
| 89 | + |
| 90 | + try? subject.storeUsername(username, password: password, serviceName: service, accessGroup: group, updateExisting: true) |
| 91 | + |
| 92 | + let result = getPassword(username: username, serviceName: service, accessGroup: group) |
| 93 | + XCTAssertEqual(result, password) |
| 94 | + } |
| 95 | + |
| 96 | + func testAppGroupIsAPassthroughWhenReading() { |
| 97 | + let group = "Test" |
| 98 | + let subject = KeychainUtils(shouldUseSharedKeychain: true, keychainUtils: SFHFKeychainUtilsMock.self) |
| 99 | + storeUsername(username, password: password, serviceName: service, accessGroup: group) |
| 100 | + |
| 101 | + let result = try? subject.getPasswordForUsername(username, serviceName: service, accessGroup: group) |
| 102 | + |
| 103 | + XCTAssertEqual(result, password) |
| 104 | + } |
| 105 | + |
| 106 | + func testAppGroupIsAPassthroughWhenDeleting() { |
| 107 | + let group = "Test" |
| 108 | + storeUsername(username, password: password, serviceName: service, accessGroup: group) |
| 109 | + let subject = KeychainUtils(shouldUseSharedKeychain: false, keychainUtils: SFHFKeychainUtilsMock.self) |
| 110 | + |
| 111 | + try? subject.deleteItem(username: username, serviceName: service, accessGroup: group) |
| 112 | + |
| 113 | + XCTAssertNil(getPassword(username: username, serviceName: service, accessGroup: group)) |
| 114 | + } |
| 115 | + |
| 116 | +} |
| 117 | + |
| 118 | +// MARK: - Helper functions |
| 119 | + |
| 120 | +private extension KeychainUtilsTests { |
| 121 | + |
| 122 | + func getPassword(username: String, serviceName: String, accessGroup: String?) -> String? { |
| 123 | + let result = (try? SFHFKeychainUtilsMock.getPasswordForUsername(username, andServiceName: serviceName, accessGroup: accessGroup)) ?? "" |
| 124 | + return result.count > 0 ? result : nil |
| 125 | + } |
| 126 | + |
| 127 | + func storeUsername(_ username: String, password: String, serviceName: String, accessGroup: String?) { |
| 128 | + try? SFHFKeychainUtilsMock.storeUsername(username, andPassword: password, forServiceName: serviceName, accessGroup: accessGroup, updateExisting: true) |
| 129 | + } |
| 130 | + |
| 131 | +} |
| 132 | + |
| 133 | +// MARK: - SFHFKeychainUtilsMock |
| 134 | + |
| 135 | +final private class SFHFKeychainUtilsMock: SFHFKeychainUtils { |
| 136 | + typealias MockKeychain = [String: [String: [String: String]]] |
| 137 | + |
| 138 | + static var keychain: MockKeychain = [:] |
| 139 | + |
| 140 | + class func configure(with keychain: MockKeychain) { |
| 141 | + self.keychain = keychain |
| 142 | + } |
| 143 | + |
| 144 | + override class func getPasswordForUsername(_ username: String!, andServiceName serviceName: String!, accessGroup: String!) throws -> String { |
| 145 | + let group = accessGroup ?? "default" |
| 146 | + if let value = keychain[group]?[serviceName]?[username] { |
| 147 | + return value |
| 148 | + } |
| 149 | + |
| 150 | + return "" |
| 151 | + } |
| 152 | + |
| 153 | + override class func storeUsername(_ username: String!, andPassword password: String!, forServiceName serviceName: String!, accessGroup: String!, updateExisting: Bool) throws { |
| 154 | + let group = accessGroup ?? "default" |
| 155 | + if keychain[group] == nil { |
| 156 | + keychain[group] = [:] |
| 157 | + } |
| 158 | + if keychain[group]?[serviceName] == nil { |
| 159 | + keychain[group]?[serviceName] = [:] |
| 160 | + } |
| 161 | + keychain[group]?[serviceName]?[username] = password |
| 162 | + } |
| 163 | + |
| 164 | + override class func deleteItem(forUsername username: String!, andServiceName serviceName: String!, accessGroup: String!) throws { |
| 165 | + let group = accessGroup ?? "default" |
| 166 | + keychain[group]?[serviceName]?.removeValue(forKey: username) |
| 167 | + } |
| 168 | +} |
0 commit comments