Repository Public License
1// ORIX Alarm2// File: Packages/AlarmCore/Tests/AlarmCoreTests/ProgressiveWakeTimelineTests.swift3// Description: Unit tests for the progressive wake timeline (stages, boundaries, monotonic intensity, clamping, absolute dates).4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import XCTest8@testable import AlarmCore910final class ProgressiveWakeTimelineTests: XCTestCase {11 private let fire = Date(timeIntervalSinceReferenceDate: 800_000_000)12 private func timeline(_ minutes: Int = 20, curve: IntensityCurve = .smoothstep, enabled: Bool = true, sunrise: Bool = true,13 override: TimeInterval? = nil, cap: TimeInterval = 900) -> ProgressiveWakeTimeline {14 ProgressiveWakeTimeline(fireDate: fire, progressive: .init(isEnabled: enabled, leadMinutes: minutes, curve: curve, sunrise: sunrise),15 leadOverride: override, mainAlarmDuration: cap)16 }17 private func at(_ t: ProgressiveWakeTimeline, _ secondsBeforeFire: TimeInterval) -> ProgressiveWakeTimeline.Snapshot {18 t.snapshot(at: fire.addingTimeInterval(-secondsBeforeFire))19 }2021 func testStagesAndBoundaries() {22 let t = timeline(20)23 XCTAssertEqual(t.lead, 1200)24 let idle = at(t, 1201)25 XCTAssertEqual(idle.stage, .idle); XCTAssertEqual(idle.progress, 0); XCTAssertEqual(idle.audioIntensity, 0); XCTAssertEqual(idle.sunriseProgress, 0)26 XCTAssertEqual(idle.nextBoundary, t.windowStart)2728 let open = at(t, 1200) // the window opens exactly here29 XCTAssertEqual(open.stage, .preparation); XCTAssertEqual(open.progress, 0, accuracy: 1e-9); XCTAssertEqual(open.nextBoundary, t.gentleWakeStart)3031 let prepEnd = 1200 * (1 - ProgressiveWakeTimeline.preparationFraction)32 XCTAssertEqual(at(t, prepEnd + 1).stage, .preparation)33 XCTAssertEqual(at(t, prepEnd - 1).stage, .gentleWake)34 XCTAssertEqual(at(t, prepEnd - 1).nextBoundary, fire)3536 let last = at(t, 0.5)37 XCTAssertEqual(last.stage, .gentleWake); XCTAssertEqual(last.progress, 1, accuracy: 0.001)38 XCTAssertEqual(last.audioIntensity, ProgressiveWakeTimeline.maxAudioIntensity, accuracy: 0.001)39 XCTAssertEqual(last.sunriseProgress, 1, accuracy: 1e-9)4041 let ringing = at(t, 0)42 XCTAssertEqual(ringing.stage, .mainAlarm); XCTAssertEqual(ringing.audioIntensity, 0); XCTAssertEqual(ringing.sunriseProgress, 1)43 XCTAssertEqual(ringing.nextBoundary, t.finishDate)44 XCTAssertEqual(at(t, -899).stage, .mainAlarm)45 let done = at(t, -900)46 XCTAssertEqual(done.stage, .finished); XCTAssertNil(done.nextBoundary); XCTAssertEqual(done.sunriseProgress, 1)47 }4849 func testTimeUntilFireAndFarPast() {50 let t = timeline()51 XCTAssertEqual(at(t, 3600).timeUntilFire, 3600, accuracy: 1e-6)52 let past = t.snapshot(at: fire.addingTimeInterval(86_400 * 400))53 XCTAssertEqual(past.stage, .finished); XCTAssertLessThan(past.timeUntilFire, 0); XCTAssertEqual(past.audioIntensity, 0)54 let longBefore = t.snapshot(at: .distantPast)55 XCTAssertEqual(longBefore.stage, .idle); XCTAssertEqual(longBefore.audioIntensity, 0)56 }5758 func testBuiltInCurvesAreMonotonicAndBounded() {59 for curve in [IntensityCurve.linear, .exponential, .smoothstep, .multiStage] {60 let t = timeline(30, curve: curve)61 var previousAudio = -1.0, previousLight = -1.0, previousProgress = -1.062 for second in stride(from: 1800.0, through: 1.0, by: -1.0) {63 let s = at(t, second)64 XCTAssertGreaterThanOrEqual(s.audioIntensity, previousAudio - 1e-12, "\(curve.kindName) at \(second)")65 XCTAssertGreaterThanOrEqual(s.sunriseProgress, previousLight - 1e-12)66 XCTAssertGreaterThan(s.progress, previousProgress)67 XCTAssertLessThanOrEqual(s.audioIntensity, ProgressiveWakeTimeline.maxAudioIntensity + 1e-12)68 XCTAssertGreaterThanOrEqual(s.sunriseProgress, s.progress * s.progress * (3 - 2 * s.progress) - 1e-9, "light leads the smooth ramp")69 previousAudio = s.audioIntensity; previousLight = s.sunriseProgress; previousProgress = s.progress70 }71 XCTAssertEqual(previousAudio, ProgressiveWakeTimeline.maxAudioIntensity, accuracy: 0.02)72 }73 }7475 func testCustomCurveIsScaledAndClamped() {76 let t = timeline(10, curve: .custom([0.5, 2.0, -1.0]))77 XCTAssertEqual(at(t, 600).audioIntensity, 0.5 * ProgressiveWakeTimeline.maxAudioIntensity, accuracy: 1e-9)78 XCTAssertEqual(at(t, 300).audioIntensity, ProgressiveWakeTimeline.maxAudioIntensity, accuracy: 1e-9)79 XCTAssertEqual(at(t, 0.001).audioIntensity, 0, accuracy: 1e-3)80 }8182 func testLeadClamping() throws {83 XCTAssertEqual(timeline(1).lead, 300)84 XCTAssertEqual(timeline(500).lead, 3600)85 // A value written directly bypasses the initialiser's clamp (as a decoded one would): the timeline clamps again.86 var raw = ProgressiveWake(isEnabled: true)87 raw.leadMinutes = 088 XCTAssertEqual(ProgressiveWakeTimeline(fireDate: fire, progressive: raw).lead, 300)89 raw.leadMinutes = 100_00090 XCTAssertEqual(ProgressiveWakeTimeline(fireDate: fire, progressive: raw).lead, 3600)91 XCTAssertEqual(timeline(20, override: 40).lead, 40)92 XCTAssertEqual(timeline(20, override: -5).lead, 1)93 XCTAssertEqual(timeline(20, cap: -3).mainAlarmDuration, 0)94 }9596 func testDisabledProgressiveHasNoLeadStages() {97 let t = timeline(20, enabled: false)98 XCTAssertEqual(t.lead, 0)99 let before = at(t, 10)100 XCTAssertEqual(before.stage, .idle); XCTAssertEqual(before.audioIntensity, 0); XCTAssertEqual(before.sunriseProgress, 0); XCTAssertEqual(before.nextBoundary, fire)101 XCTAssertEqual(at(t, 0).stage, .mainAlarm); XCTAssertEqual(at(t, 0).sunriseProgress, 0)102 }103104 func testSunriseOffKeepsAudio() {105 let s = at(timeline(20, sunrise: false), 60)106 XCTAssertEqual(s.sunriseProgress, 0); XCTAssertGreaterThan(s.audioIntensity, 0.5)107 XCTAssertEqual(at(timeline(20, sunrise: false), -1).sunriseProgress, 0)108 }109110 /// The timeline works on absolute instants: a fire date just after a daylight-saving jump gives the same stages as any other.111 func testAbsoluteDatesAcrossDaylightSavingChange() throws {112 var calendar = Calendar(identifier: .gregorian)113 calendar.timeZone = try XCTUnwrap(TimeZone(identifier: "America/Toronto"))114 // 2027-03-14 03:10 local: the clocks jumped from 02:00 to 03:00 ten real minutes earlier.115 let springFire = try XCTUnwrap(calendar.date(from: DateComponents(year: 2027, month: 3, day: 14, hour: 3, minute: 10)))116 let t = ProgressiveWakeTimeline(fireDate: springFire, progressive: .init(isEnabled: true, leadMinutes: 30, curve: .linear))117 XCTAssertEqual(calendar.component(.hour, from: t.windowStart), 1, "30 real minutes before 03:10 is 01:40 on the wall clock")118 XCTAssertEqual(calendar.component(.minute, from: t.windowStart), 40)119 let mid = t.snapshot(at: springFire.addingTimeInterval(-900))120 XCTAssertEqual(mid.progress, 0.5, accuracy: 1e-9)121 XCTAssertEqual(mid.audioIntensity, 0.5 * ProgressiveWakeTimeline.maxAudioIntensity, accuracy: 1e-9)122 XCTAssertEqual(t.snapshot(at: springFire.addingTimeInterval(-1801)).stage, .idle)123 }124}125