ehealthsolutions/element-x-ios
3
0
Fork 0
mirror of https://github.com/Novaloop-AG/element-x-ios.git synced 2026-11-02 12:07:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

AppSettings are Mockable (#5589)

Browse Source 
* create DependenciesProtocol and replace ServiceLocator registration with it

replace mocking calls for ServiceLocator to Dependencies

replace ServiceLocator with instance level calls

replace ServiceLocator configs with TestDependencies config in Tests

replace servicelocator usage in analytics service

replace remaining ServiceLocator calls in unit tests

that depended on the UnitTestAppCoordinator configuration with per suite dependencies instances

fix swiftlint warning

remove remaining references to ServiceLocator

make dependencies properties consistent in tests

delete Dependencies and DependenciesProtocol

fix whitespace modifications

updates from PR feedback

a pass over converting AppSettings and AnalyticsService test instance properties to per test instantiation

fix a missed PR feedback

Sync up after rebase

create DependenciesProtocol and replace ServiceLocator registration with it

replace mocking calls for ServiceLocator to Dependencies

replace ServiceLocator with instance level calls

replace ServiceLocator configs with TestDependencies config in Tests

replace servicelocator usage in analytics service

replace remaining ServiceLocator calls in unit tests

that depended on the UnitTestAppCoordinator configuration with per suite dependencies instances

fix swiftlint warning

remove remaining references to ServiceLocator

make dependencies properties consistent in tests

delete Dependencies and DependenciesProtocol

* AppSettings is instance level mockable now

* replace mocked and preview usages of reset + AppSettings global init with

AppSettings(store: UserDefaultsMock())

* AppSettings.UserDefaultsKeys is now a RawRep struct, making it extensible

* update tests with new AppSettings so it builds

* update remaining AppSettings test/mock inits

* AppSettings.UserDefaultsKey conformed to ExpressibleByStringLiteral

* addressed issues found in first pass ai review

* update AppSettings instantiations after rebase

* fix accessibility tests coordinator after rebase

* Rename to VolatileUserDefaults

* AppSettings init uses mandatory parameter

* Revert UserDefaultsKey to enum

* Add TrackedUserDefaults to be able to reset the defaults object

* Added volatile static func to AppSettings

* Use .volatile() static func instead of full init

* review fixups

* Resolve build issues after rebase

* updated enterprise module

* remove the static reset settings call from the preview tests

---------

Co-authored-by: Mauro Romito <mauro.romito@element.io>
This commit is contained in:
Michael
2026-05-22 08:14:08 -05:00
committed by GitHub
parent 97d4a35af7
commit 22d14ff8e4
122 changed files with 572 additions and 747 deletions
Download Patch File Download Diff File Expand all files Collapse all files
UnitTests/Sources/UserPreferenceTests.swift
+55 -46
View File
@@ -11,128 +11,131 @@ import Foundation
import Testing
struct UserPreferenceTests {
init() {
UserDefaults.testDefaults.removeVolatileDomain(forName: .userDefaultsSuiteName)
UserDefaults.testDefaults.removePersistentDomain(forName: .userDefaultsSuiteName)
}
@Test
func storePlistValue() {
let testDefaults = VolatileUserDefaults()
let setPreference = {
let value = TestPreferences()
let value = TestPreferences(testDefaults)
value.plist = "Hello"
}
setPreference()
let value = TestPreferences()
let value = TestPreferences(testDefaults)
#expect(value.plist == "Hello")
#expect(UserDefaults.testDefaults.string(forKey: .key2) != nil)
#expect(UserDefaults.testDefaults.data(forKey: .key2) == nil)
#expect(testDefaults.object(forKey: TestsKey.key2.rawValue) is String)
#expect(testDefaults.data(forKey: TestsKey.key2.rawValue) == nil)
}
@Test
func storeCodableValue() {
let testDefaults = VolatileUserDefaults()
let storedType = CodableTestType(a: "some", b: [1, 2, 3])
let setPreference = {
let value = TestPreferences()
let value = TestPreferences(testDefaults)
value.codable = storedType
}
setPreference()
let value = TestPreferences()
let value = TestPreferences(testDefaults)
#expect(value.codable == storedType)
#expect(UserDefaults.testDefaults.data(forKey: .key3) != nil)
#expect(testDefaults.data(forKey: TestsKey.key3.rawValue) != nil)
}
@Test
func storePlistValueOnVolatileStorage() {
let testDefaults = VolatileUserDefaults()
let setPreference = {
let value = TestPreferences()
let value = TestPreferences(testDefaults)
value.volatileVar = "Hello"
}
setPreference()
let value = TestPreferences()
let value = TestPreferences(testDefaults)
#expect(value.volatileVar == nil)
}
@Test
func storeCodableValueOnVolatileStorage() {
let testDefaults = VolatileUserDefaults()
let storedType = CodableTestType(a: "some", b: [1, 2, 3])
let setPreference = {
let value = TestPreferences()
let value = TestPreferences(testDefaults)
value.volatileCodable = storedType
}
setPreference()
let value = TestPreferences()
let value = TestPreferences(testDefaults)
#expect(value.volatileCodable == nil)
#expect(UserDefaults.testDefaults.data(forKey: .key4) == nil)
#expect(testDefaults.data(forKey: TestsKey.key4.rawValue) == nil)
}
@Test
func storePlistArray() {
let testDefaults = VolatileUserDefaults()
let setPreference = {
let value = TestPreferences()
let value = TestPreferences(testDefaults)
value.plistArray = [1, 2, 3]
}
setPreference()
let value = TestPreferences()
let value = TestPreferences(testDefaults)
#expect(value.plistArray == [1, 2, 3])
#expect(UserDefaults.testDefaults.array(forKey: .key5) as? [Int] == [1, 2, 3])
#expect(UserDefaults.testDefaults.data(forKey: .key5) == nil)
#expect(testDefaults.object(forKey: TestsKey.key5.rawValue) as? [Int] == [1, 2, 3])
#expect(testDefaults.data(forKey: TestsKey.key5.rawValue) == nil)
}
@Test
func assignNilToPlistType() {
let testDefaults = VolatileUserDefaults()
let setPreference = {
let value = TestPreferences()
let value = TestPreferences(testDefaults)
value.plist = "Hello"
}
setPreference()
let value = TestPreferences()
let value = TestPreferences(testDefaults)
value.plist = nil
#expect(value.plist == nil)
#expect(UserDefaults.testDefaults.string(forKey: .key2) == nil)
#expect(testDefaults.object(forKey: TestsKey.key2.rawValue) as? String == nil)
}
@Test
func assignNilToCodableType() {
let testDefaults = VolatileUserDefaults()
let storedType = CodableTestType(a: "some", b: [1, 2, 3])
let setPreference = {
let value = TestPreferences()
let value = TestPreferences(testDefaults)
value.codable = storedType
}
setPreference()
let value = TestPreferences()
let value = TestPreferences(testDefaults)
value.codable = nil
#expect(value.codable == nil)
#expect(UserDefaults.testDefaults.data(forKey: .key3) == nil)
#expect(testDefaults.data(forKey: TestsKey.key3.rawValue) == nil)
}
@Test
func localOverRemoteValue() {
@UserPreference(key: "testKey", defaultValue: "", storageType: .userDefaults(.testDefaults)) var preference
let storage = VolatileUserDefaults()
@UserPreference(key: TestsKey.testKey, defaultValue: "", storage: storage) var preference
#expect(preference == "")
_preference.remoteValue = "remote"
@@ -144,7 +147,8 @@ struct UserPreferenceTests {
@Test
func remoteOverLocalValue() {
@UserPreference(key: "testKey", defaultValue: "", storageType: .userDefaults(.testDefaults), mode: .remoteOverLocal) var preference
let storage = VolatileUserDefaults()
@UserPreference(key: TestsKey.testKey, defaultValue: "", storage: storage, mode: .remoteOverLocal) var preference
#expect(preference == "")
_preference.remoteValue = "remote"
@@ -157,20 +161,28 @@ struct UserPreferenceTests {
}
private struct TestPreferences {
@UserPreference(key: .key1, storageType: .volatile)
@UserPreference
var volatileVar: String?
@UserPreference(key: .key2, storageType: .userDefaults(.testDefaults))
@UserPreference
var plist: String?
@UserPreference(key: .key3, storageType: .userDefaults(.testDefaults))
@UserPreference
var codable: CodableTestType?
@UserPreference(key: .key4, storageType: .volatile)
@UserPreference
var volatileCodable: CodableTestType?
@UserPreference(key: .key5, storageType: .userDefaults(.testDefaults))
@UserPreference
var plistArray: [Int]?
init(_ storage: UserDefaultsProtocol) {
_volatileVar = UserPreference(key: TestsKey.key1, storage: VolatileUserDefaults())
_plist = UserPreference(key: TestsKey.key2, storage: storage)
_codable = UserPreference(key: TestsKey.key3, storage: storage)
_volatileCodable = UserPreference(key: TestsKey.key4, storage: VolatileUserDefaults())
_plistArray = UserPreference(key: TestsKey.key5, storage: storage)
}
}
private struct CodableTestType: Equatable, Codable {
@@ -178,16 +190,13 @@ private struct CodableTestType: Equatable, Codable {
let b: [Int]
}
private extension String {
static let key1 = "foo.volatile"
static let key2 = "foo.plist"
static let key3 = "foo.codable"
static let key4 = "foo.volatile.codable"
static let key5 = "foo.plist.array"
static let userDefaultsSuiteName = "io.element.elementx.unitests"
}
private extension UserDefaults {
// swiftlint:disable:next force_unwrapping
static let testDefaults = UserDefaults(suiteName: .userDefaultsSuiteName)!
private struct TestsKey: PreferenceKeyable, RawRepresentable {
static let testKey = Self(rawValue: "testKey")
static let key1 = Self(rawValue: "foo.volatile")
static let key2 = Self(rawValue: "foo.plist")
static let key3 = Self(rawValue: "foo.codable")
static let key4 = Self(rawValue: "foo.volatile.codable")
static let key5 = Self(rawValue: "foo.plist.array")
let rawValue: String
}