-
-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathAppStateTests.swift
More file actions
606 lines (483 loc) · 21.4 KB
/
Copy pathAppStateTests.swift
File metadata and controls
606 lines (483 loc) · 21.4 KB
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
// AppStateTests.swift
// VocaMac Tests
//
// Tests for AppState: translation toggle, onboarding, launch at login.
import XCTest
import ServiceManagement
@testable import VocaMac
// MARK: - Translation Toggle Tests
final class TranslationToggleTests: XCTestCase {
@MainActor
func testTranslationEnabledDefaultValue() {
let (appState, _) = AppState.makeTestState()
XCTAssertFalse(appState.translationEnabled)
}
@MainActor
func testTranslationEnabledCanBeToggled() {
let (appState, _) = AppState.makeTestState()
XCTAssertFalse(appState.translationEnabled)
appState.translationEnabled = true
XCTAssertTrue(appState.translationEnabled)
appState.translationEnabled = false
XCTAssertFalse(appState.translationEnabled)
}
}
// MARK: - OnboardingStep Tests
final class OnboardingStepTests: XCTestCase {
func testOnboardingStepOrdering() {
let steps = OnboardingStep.allCases
XCTAssertEqual(steps.count, 5)
XCTAssertEqual(steps[0], .welcome)
XCTAssertEqual(steps[1], .permissions)
XCTAssertEqual(steps[2], .hotkeyConfig)
XCTAssertEqual(steps[3], .quickTest)
XCTAssertEqual(steps[4], .complete)
}
func testOnboardingStepTitles() {
for step in OnboardingStep.allCases {
XCTAssertFalse(step.title.isEmpty)
}
}
func testOnboardingStepNumbers() {
for (index, step) in OnboardingStep.allCases.enumerated() {
XCTAssertEqual(step.stepNumber, "Step \(index + 1) of \(OnboardingStep.allCases.count)")
}
}
func testOnboardingStepIdentifiable() {
let steps = OnboardingStep.allCases
let ids = steps.map { $0.id }
let uniqueIds = Set(ids)
XCTAssertEqual(ids.count, uniqueIds.count)
}
}
// MARK: - Launch at Login Tests
final class LaunchAtLoginTests: XCTestCase {
override func setUp() {
super.setUp()
UserDefaults.standard.removeObject(forKey: "vocamac.launchAtLogin")
}
override func tearDown() {
UserDefaults.standard.removeObject(forKey: "vocamac.launchAtLogin")
super.tearDown()
}
@MainActor
func testLaunchAtLoginDefaultsToFalse() {
let (appState, _) = AppState.makeTestState()
XCTAssertFalse(appState.launchAtLogin)
}
@MainActor
func testLaunchAtLoginPersistence() {
UserDefaults.standard.set(true, forKey: "vocamac.launchAtLogin")
let (appState, _) = AppState.makeTestState()
XCTAssertTrue(appState.launchAtLogin)
}
@MainActor
func testSetLaunchAtLoginEnableUpdatesPreference() {
let (appState, _) = AppState.makeTestState()
XCTAssertFalse(appState.launchAtLogin)
appState.setLaunchAtLogin(true)
let expected = SMAppService.mainApp.status == .enabled
XCTAssertEqual(appState.launchAtLogin, expected)
}
@MainActor
func testSetLaunchAtLoginDisableUpdatesPreference() {
let (appState, _) = AppState.makeTestState()
appState.setLaunchAtLogin(true)
appState.setLaunchAtLogin(false)
let expected = SMAppService.mainApp.status == .enabled
XCTAssertEqual(appState.launchAtLogin, expected)
}
@MainActor
func testSetLaunchAtLoginToggleRoundTrip() {
let (appState, _) = AppState.makeTestState()
appState.setLaunchAtLogin(true)
let afterEnable = appState.launchAtLogin
appState.setLaunchAtLogin(false)
let afterDisable = appState.launchAtLogin
if SMAppService.mainApp.status != .enabled {
XCTAssertFalse(afterDisable,
"After disabling, launchAtLogin should be false")
}
XCTAssertNotNil(afterEnable)
XCTAssertNotNil(afterDisable)
}
}
// MARK: - AppState Onboarding Tests
final class AppStateOnboardingTests: XCTestCase {
override func setUp() {
super.setUp()
clearPersistedSettings()
}
override func tearDown() {
clearPersistedSettings()
super.tearDown()
}
private func clearPersistedSettings() {
[
"vocamac.hasCompletedOnboarding",
"vocamac.activationMode",
"vocamac.hotKeyCode",
"vocamac.hotKeyModifiers",
"vocamac.doubleTapThreshold",
"vocamac.maxRecordingDuration",
].forEach { UserDefaults.standard.removeObject(forKey: $0) }
}
@MainActor
func testOnboardingFlagInitiallyFalse() {
let (appState, _) = AppState.makeTestState()
XCTAssertFalse(appState.hasCompletedOnboarding)
}
@MainActor
func testCompleteOnboardingSetsFlagTrue() {
let (appState, _) = AppState.makeTestState()
XCTAssertFalse(appState.hasCompletedOnboarding)
appState.completeOnboarding()
XCTAssertTrue(appState.hasCompletedOnboarding)
}
@MainActor
func testCompleteOnboardingSyncsHotKeyConfiguration() {
let (appState, mocks) = AppState.makeTestState()
appState.activationMode = .doubleTapToggle
appState.hotKeyCode = 58
appState.doubleTapThreshold = 0.55
appState.maxRecordingDuration = 120
appState.completeOnboarding()
XCTAssertEqual(mocks.hotKeyManager.updateConfigurationCallCount, 1)
XCTAssertEqual(mocks.hotKeyManager.lastMode, .doubleTapToggle)
XCTAssertEqual(mocks.hotKeyManager.lastKeyCode, 58)
XCTAssertEqual(mocks.hotKeyManager.lastDoubleTapThreshold, 0.55)
XCTAssertEqual(mocks.hotKeyManager.lastSafetyTimeout, 125.0)
XCTAssertEqual(mocks.hotKeyManager.resetKeyStateCallCount, 1)
}
@MainActor
func testCompleteOnboardingDoesNotResetHotKeyStateWhileRecording() {
let (appState, mocks) = AppState.makeTestState()
appState.isRecording = true
appState.completeOnboarding()
XCTAssertEqual(mocks.hotKeyManager.updateConfigurationCallCount, 1)
XCTAssertEqual(mocks.hotKeyManager.resetKeyStateCallCount, 0)
XCTAssertTrue(appState.hasCompletedOnboarding)
}
@MainActor
func testSyncHotKeyConfigurationAppliesCurrentSettings() {
let (appState, mocks) = AppState.makeTestState()
appState.activationMode = .doubleTapToggle
appState.hotKeyCode = 54
appState.doubleTapThreshold = 0.3
appState.maxRecordingDuration = 30
appState.syncHotKeyConfiguration()
XCTAssertEqual(mocks.hotKeyManager.updateConfigurationCallCount, 1)
XCTAssertEqual(mocks.hotKeyManager.lastMode, .doubleTapToggle)
XCTAssertEqual(mocks.hotKeyManager.lastKeyCode, 54)
XCTAssertEqual(mocks.hotKeyManager.lastDoubleTapThreshold, 0.3)
XCTAssertEqual(mocks.hotKeyManager.lastSafetyTimeout, 35.0)
}
@MainActor
func testSyncHotKeyConfigurationAppliesDefaultSettings() {
let (appState, mocks) = AppState.makeTestState()
appState.syncHotKeyConfiguration()
XCTAssertEqual(mocks.hotKeyManager.updateConfigurationCallCount, 1)
XCTAssertEqual(mocks.hotKeyManager.lastMode, .pushToTalk)
XCTAssertEqual(mocks.hotKeyManager.lastKeyCode, 61)
XCTAssertEqual(mocks.hotKeyManager.lastDoubleTapThreshold, 0.4)
XCTAssertEqual(mocks.hotKeyManager.lastSafetyTimeout, 65.0)
}
@MainActor
func testOnboardingFlagPersistence() {
UserDefaults.standard.set(true, forKey: "vocamac.hasCompletedOnboarding")
let (appState, _) = AppState.makeTestState()
XCTAssertTrue(appState.hasCompletedOnboarding)
}
@MainActor
func testPerformStartupInstallsBundledTinyModelBeforeDownload() async {
let (appState, mocks) = AppState.makeTestState()
mocks.modelManager.bundledModels = [.tiny]
appState.selectedModelSize = ModelSize.tiny.rawValue
await appState.performStartup()
// Bundled model should have been installed
XCTAssertEqual(mocks.modelManager.installedBundledModels, [.tiny])
// WhisperKit handles tokenizer fetching internally — we no longer
// pre-validate tokenizer assets before loading. Asserting that
// ensuredTokenizerSizes is empty confirms we removed the incorrect check.
XCTAssertEqual(mocks.modelManager.ensuredTokenizerSizes, [])
XCTAssertEqual(mocks.whisperService.loadedModelName, "openai_whisper-tiny")
}
}
// MARK: - AppState Model Loading Tests
final class AppStateModelLoadingTests: XCTestCase {
private static let ownedDefaultsKeys = [
"vocamac.selectedModelSize",
"vocamac.selectedLanguage",
]
override func setUp() {
super.setUp()
Self.ownedDefaultsKeys.forEach { UserDefaults.standard.removeObject(forKey: $0) }
}
override func tearDown() {
Self.ownedDefaultsKeys.forEach { UserDefaults.standard.removeObject(forKey: $0) }
super.tearDown()
}
@MainActor
func testSetupKeepsLargeSupportedWhenMediumIsNotRecommended() {
let modelManager = MockModelManager()
modelManager.defaultModel = "openai_whisper-large-v3-v20240930"
modelManager.supportedModelNames = [
"openai_whisper-tiny",
"openai_whisper-base",
"openai_whisper-small",
"openai_whisper-large-v3-v20240930",
"openai_whisper-large-v3-v20240930_626MB",
]
let (appState, _) = AppState.makeTestState(modelManager: modelManager)
XCTAssertEqual(appState.deviceRecommendedModel, "openai_whisper-large-v3-v20240930")
XCTAssertNil(appState.availableModels.first(where: { $0.size == .medium }))
XCTAssertEqual(
appState.availableModels.first(where: { $0.size == .largeV3Latest })?.isSupported,
true
)
}
@MainActor
func testFailedModelSwitchShowsErrorAndRestoresPreviousModel() async {
UserDefaults.standard.set(ModelSize.small.rawValue, forKey: "vocamac.selectedModelSize")
let modelManager = MockModelManager()
modelManager.downloadedModels = [.small, .medium]
let whisperService = MockWhisperService()
whisperService.loadedModelName = "openai_whisper-small"
whisperService.isModelLoaded = true
let loadError = NSError(
domain: "VocaMacTests",
code: 1,
userInfo: [NSLocalizedDescriptionKey: "CoreML rejected model"]
)
whisperService.loadResponses = [
.failure(loadError),
.success("openai_whisper-small"),
]
let (appState, mocks) = AppState.makeTestState(
modelManager: modelManager,
whisperService: whisperService
)
await appState.loadModel(.medium)
XCTAssertEqual(
mocks.whisperService.loadRequests.map { $0.name },
["openai_whisper-medium", "openai_whisper-small"]
)
XCTAssertEqual(appState.appStatus, .error)
XCTAssertTrue(appState.errorMessage?.contains("Failed to load Medium") == true)
XCTAssertEqual(appState.currentModel?.size, .small)
XCTAssertEqual(appState.selectedModelSize, ModelSize.small.rawValue)
XCTAssertEqual(
appState.availableModels.first(where: { $0.size == .small })?.isActive,
true
)
XCTAssertEqual(
appState.availableModels.first(where: { $0.size == .medium })?.isLoading,
false
)
}
@MainActor
func testLowMemoryGateRefusesMediumBeforeWhisperWithoutTouchingLoadedModel() async {
UserDefaults.standard.set(ModelSize.small.rawValue, forKey: "vocamac.selectedModelSize")
let modelManager = MockModelManager()
modelManager.downloadedModels = [.small, .medium]
let whisperService = MockWhisperService()
whisperService.loadResponses = [
.success("openai_whisper-small"),
]
let (appState, mocks) = AppState.makeTestState(
modelManager: modelManager,
whisperService: whisperService
)
await appState.loadModel(.small)
let loadsAfterSmall = mocks.whisperService.loadRequests.count
XCTAssertEqual(appState.currentModel?.size, .small)
XCTAssertTrue(mocks.whisperService.isModelLoaded)
appState.modelFitsInMemory = { $0 != .medium }
await appState.loadModel(.medium)
XCTAssertTrue(
appState.errorMessage?.contains("Not enough") == true
|| appState.errorMessage?.localizedCaseInsensitiveContains("free memory") == true
)
XCTAssertEqual(mocks.whisperService.loadRequests.count, loadsAfterSmall)
XCTAssertFalse(
mocks.whisperService.loadRequests.map { $0.name }.contains("openai_whisper-medium")
)
XCTAssertEqual(appState.currentModel?.size, .small)
XCTAssertEqual(appState.selectedModelSize, ModelSize.small.rawValue)
XCTAssertTrue(mocks.whisperService.isModelLoaded)
XCTAssertEqual(mocks.whisperService.loadedModelName, "openai_whisper-small")
}
@MainActor
func testDeleteModelRemovesDownloadedModel() async {
let modelManager = MockModelManager()
modelManager.downloadedModels = [.small, .medium]
let (appState, _) = AppState.makeTestState(modelManager: modelManager)
await appState.deleteModel(.medium)
XCTAssertEqual(modelManager.deletedModels, [.medium])
XCTAssertEqual(appState.availableModels.first(where: { $0.size == .medium })?.isDownloaded, false)
XCTAssertNil(appState.errorMessage)
}
@MainActor
func testDeleteModelRefusesToDeleteTheActiveModel() async {
let modelManager = MockModelManager()
modelManager.downloadedModels = [.small]
let (appState, _) = AppState.makeTestState(modelManager: modelManager)
await appState.loadModel(.small)
await appState.deleteModel(.small)
XCTAssertTrue(modelManager.deletedModels.isEmpty)
XCTAssertEqual(appState.availableModels.first(where: { $0.size == .small })?.isDownloaded, true)
XCTAssertTrue(appState.errorMessage?.contains("active model") == true)
}
@MainActor
func testDeleteModelRefusesToDeleteAModelThatIsLoading() async {
// A model mid-load or mid-download must not have its files pulled out
// from under the in-flight read.
let modelManager = MockModelManager()
modelManager.downloadedModels = [.small]
let (appState, _) = AppState.makeTestState(modelManager: modelManager)
let index = appState.availableModels.firstIndex(where: { $0.size == .small })!
appState.availableModels[index].isLoading = true
await appState.deleteModel(.small)
XCTAssertTrue(modelManager.deletedModels.isEmpty)
XCTAssertTrue(appState.errorMessage?.contains("loading") == true)
}
@MainActor
func testDeleteModelSurfacesUnderlyingError() async {
let modelManager = MockModelManager()
modelManager.downloadedModels = [.small]
modelManager.deleteModelError = NSError(
domain: "VocaMacTests",
code: 1,
userInfo: [NSLocalizedDescriptionKey: "Permission denied"]
)
let (appState, _) = AppState.makeTestState(modelManager: modelManager)
await appState.deleteModel(.small)
XCTAssertTrue(appState.errorMessage?.contains("Permission denied") == true)
XCTAssertEqual(appState.availableModels.first(where: { $0.size == .small })?.isDownloaded, true)
}
@MainActor
func testConcurrentModelDownloadsAreSerialized() async throws {
let modelManager = MockModelManager()
modelManager.downloadDelayNanoseconds = 50_000_000
let (appState, _) = AppState.makeTestState(modelManager: modelManager)
async let firstDownload: Void = appState.downloadModel(.small)
try await Task.sleep(nanoseconds: 5_000_000)
async let secondDownload: Void = appState.downloadModel(.medium)
await firstDownload
await secondDownload
XCTAssertEqual(modelManager.downloadRequests, [.small, .medium])
XCTAssertEqual(modelManager.maxConcurrentDownloadCount, 1)
XCTAssertEqual(modelManager.downloadedModels, [.small, .medium])
}
@MainActor
func testConcurrentModelLoadsAreSerialized() async throws {
let modelManager = MockModelManager()
modelManager.downloadedModels = [.small, .medium]
let whisperService = MockWhisperService()
whisperService.loadDelayNanoseconds = 50_000_000
let (appState, _) = AppState.makeTestState(
modelManager: modelManager,
whisperService: whisperService
)
async let firstLoad: Void = appState.loadModel(.small)
try await Task.sleep(nanoseconds: 5_000_000)
async let secondLoad: Void = appState.loadModel(.medium)
await firstLoad
await secondLoad
XCTAssertEqual(
whisperService.loadRequests.map { $0.name },
["openai_whisper-small", "openai_whisper-medium"]
)
XCTAssertEqual(whisperService.maxConcurrentLoadCount, 1)
XCTAssertEqual(appState.currentModel?.size, .medium)
}
@MainActor
func testStartupFallsBackFromUnsupportedMediumPreference() async {
UserDefaults.standard.set(ModelSize.medium.rawValue, forKey: "vocamac.selectedModelSize")
let modelManager = MockModelManager()
modelManager.defaultModel = "openai_whisper-large-v3-v20240930"
modelManager.supportedModelNames = [
"openai_whisper-tiny",
"openai_whisper-base",
"openai_whisper-small",
"openai_whisper-large-v3-v20240930",
]
modelManager.downloadedModels = [.small, .medium]
let whisperService = MockWhisperService()
whisperService.loadedModelName = nil
whisperService.isModelLoaded = false
let (appState, mocks) = AppState.makeTestState(
modelManager: modelManager,
whisperService: whisperService
)
await appState.performStartup()
XCTAssertEqual(mocks.whisperService.loadRequests.first?.name, "openai_whisper-small")
XCTAssertEqual(appState.selectedModelSize, ModelSize.small.rawValue)
XCTAssertEqual(appState.currentModel?.size, .small)
}
@MainActor
func testStartupFallbackStaysOnTheSameEngine() async {
UserDefaults.standard.set(ModelSize.medium.rawValue, forKey: "vocamac.selectedModelSize")
// Apple Speech is supported and always counts as downloaded, and it
// sits after the Whisper models in the catalog. A Whisper user whose
// preference became unsupported should still land on Whisper.
let modelManager = MockModelManager()
modelManager.supportedModelNames = [
"openai_whisper-tiny",
"openai_whisper-small",
"apple-speech",
]
modelManager.downloadedModels = [.tiny, .small, .medium, .appleSpeech]
let whisperService = MockWhisperService()
whisperService.loadedModelName = nil
whisperService.isModelLoaded = false
let (appState, mocks) = AppState.makeTestState(
modelManager: modelManager,
whisperService: whisperService
)
await appState.performStartup()
XCTAssertEqual(appState.currentModel?.size, .small)
XCTAssertEqual(mocks.whisperService.loadRequests.first?.name, "openai_whisper-small")
}
// MARK: - Language-bound model reloading
@MainActor
func testLanguageChangeReloadsALanguageBoundModel() async {
// SenseVoice takes its recognition language when the recognizer is
// built, so the change only lands on reload.
let modelManager = MockModelManager()
modelManager.downloadedModels = [.senseVoiceSmall]
let (appState, mocks) = AppState.makeTestState(modelManager: modelManager)
await appState.loadModel(.senseVoiceSmall)
XCTAssertEqual(appState.currentModel?.size, .senseVoiceSmall)
let loadsAfterInitial = mocks.whisperService.loadRequests.count
appState.selectedLanguage = "zh"
await appState.reloadModelForLanguageChangeIfNeeded()
XCTAssertEqual(mocks.whisperService.loadRequests.count, loadsAfterInitial + 1)
XCTAssertEqual(mocks.whisperService.loadRequests.last?.name, "sense-voice-small")
}
@MainActor
func testLanguageChangeDoesNotReloadAMonolingualONNXModel() async {
// Moonshine is English-only, so it has no language to rebind and
// should not pay for a reload.
let modelManager = MockModelManager()
modelManager.downloadedModels = [.moonshineTiny]
let (appState, mocks) = AppState.makeTestState(modelManager: modelManager)
await appState.loadModel(.moonshineTiny)
let loadsAfterInitial = mocks.whisperService.loadRequests.count
appState.selectedLanguage = "ru"
await appState.reloadModelForLanguageChangeIfNeeded()
XCTAssertEqual(mocks.whisperService.loadRequests.count, loadsAfterInitial)
}
@MainActor
func testLanguageChangeDoesNotReloadWhisperModel() async {
let modelManager = MockModelManager()
modelManager.downloadedModels = [.tiny]
let (appState, mocks) = AppState.makeTestState(modelManager: modelManager)
await appState.loadModel(.tiny)
let loadsAfterInitial = mocks.whisperService.loadRequests.count
appState.selectedLanguage = "ru"
await appState.reloadModelForLanguageChangeIfNeeded()
// Whisper takes the language per transcription — no reload needed.
XCTAssertEqual(mocks.whisperService.loadRequests.count, loadsAfterInitial)
}
}