manager_test.go 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374
  1. package runtime
  2. import (
  3. "context"
  4. "errors"
  5. "sync"
  6. "testing"
  7. "time"
  8. "vocat/internal/vowifi"
  9. )
  10. type fakeSIM struct{}
  11. func (fakeSIM) ReadIdentity(context.Context, string) (vowifi.SIMIdentity, error) {
  12. return vowifi.SIMIdentity{
  13. ICCID: "8944100000000000000",
  14. HomeMCC: "234",
  15. HomeMNC: "15",
  16. HomeCountryCode: "GB",
  17. }, nil
  18. }
  19. type fakeAKA struct{}
  20. func (fakeAKA) CheckReady(context.Context, vowifi.SIMIdentity) (vowifi.AKAEvidence, error) {
  21. return vowifi.AKAEvidence{Ready: true, Application: "USIM"}, nil
  22. }
  23. func (fakeAKA) Authenticate(context.Context, vowifi.SIMIdentity, vowifi.AKAChallenge) (vowifi.AKAResult, error) {
  24. return vowifi.AKAResult{}, nil
  25. }
  26. type fakeRadio struct{}
  27. func (fakeRadio) Snapshot(context.Context, string) (vowifi.RadioSnapshot, error) {
  28. return vowifi.RadioSnapshot{CellularDataEnabled: true, OperatingMode: 1}, nil
  29. }
  30. func (fakeRadio) StopCellularData(context.Context, string) error { return nil }
  31. func (fakeRadio) EnterVoWiFiRFOff(context.Context, string) error { return nil }
  32. func (fakeRadio) Restore(context.Context, string, vowifi.RadioSnapshot) error {
  33. return nil
  34. }
  35. type fakeProxy struct{}
  36. func (fakeProxy) Resolve(context.Context, vowifi.ProxyRequest) (vowifi.ProxyRoute, error) {
  37. return vowifi.ProxyRoute{Mode: vowifi.ProxyModeDirect}, nil
  38. }
  39. type fakeTunnelProvider struct{}
  40. type fakeTunnelSession struct{}
  41. func (fakeTunnelProvider) Start(context.Context, vowifi.TunnelRequest) (vowifi.TunnelSession, error) {
  42. return fakeTunnelSession{}, nil
  43. }
  44. func (fakeTunnelSession) Evidence() vowifi.TunnelEvidence {
  45. return vowifi.TunnelEvidence{
  46. Established: true,
  47. Name: "xfrm-test",
  48. ResponderAUTH: vowifi.ResponderAUTHVerified,
  49. }
  50. }
  51. func (fakeTunnelSession) Close(context.Context) error { return nil }
  52. type flakyTunnelProvider struct {
  53. mu sync.Mutex
  54. attempts int
  55. failures int
  56. }
  57. func (provider *flakyTunnelProvider) Start(
  58. context.Context,
  59. vowifi.TunnelRequest,
  60. ) (vowifi.TunnelSession, error) {
  61. provider.mu.Lock()
  62. defer provider.mu.Unlock()
  63. provider.attempts++
  64. if provider.attempts <= provider.failures {
  65. return nil, errors.New("temporary tunnel failure")
  66. }
  67. return fakeTunnelSession{}, nil
  68. }
  69. func (provider *flakyTunnelProvider) Attempts() int {
  70. provider.mu.Lock()
  71. defer provider.mu.Unlock()
  72. return provider.attempts
  73. }
  74. type fakeIMSProvider struct{}
  75. type fakeIMSSession struct{}
  76. func (fakeIMSProvider) Start(context.Context, vowifi.IMSRequest) (vowifi.IMSSession, error) {
  77. return fakeIMSSession{}, nil
  78. }
  79. func (fakeIMSSession) Evidence() vowifi.IMSEvidence {
  80. return vowifi.IMSEvidence{
  81. Registered: true,
  82. RegistrationState: "registered",
  83. AssociatedMSISDN: "+447700900123",
  84. }
  85. }
  86. func (fakeIMSSession) EnableSMS(context.Context) (vowifi.SMSEvidence, error) {
  87. return vowifi.SMSEvidence{Ready: true}, nil
  88. }
  89. func (fakeIMSSession) Close(context.Context) error { return nil }
  90. type fakePhones struct{}
  91. func (fakePhones) SaveAssociatedNumber(context.Context, vowifi.PhoneRecord) error {
  92. return nil
  93. }
  94. func testOrchestrator(t *testing.T, id string) *vowifi.Orchestrator {
  95. t.Helper()
  96. orchestrator, err := vowifi.New(vowifi.Dependencies{
  97. SIM: fakeSIM{},
  98. AKA: fakeAKA{},
  99. Radio: fakeRadio{},
  100. Proxy: fakeProxy{},
  101. Tunnel: fakeTunnelProvider{},
  102. IMS: fakeIMSProvider{},
  103. Phones: fakePhones{},
  104. }, vowifi.Options{DeviceID: id})
  105. if err != nil {
  106. t.Fatal(err)
  107. }
  108. return orchestrator
  109. }
  110. func testOrchestratorWithTunnel(
  111. t *testing.T,
  112. id string,
  113. tunnel vowifi.TunnelProvider,
  114. ) *vowifi.Orchestrator {
  115. t.Helper()
  116. orchestrator, err := vowifi.New(vowifi.Dependencies{
  117. SIM: fakeSIM{},
  118. AKA: fakeAKA{},
  119. Radio: fakeRadio{},
  120. Proxy: fakeProxy{},
  121. Tunnel: tunnel,
  122. IMS: fakeIMSProvider{},
  123. Phones: fakePhones{},
  124. }, vowifi.Options{DeviceID: id})
  125. if err != nil {
  126. t.Fatal(err)
  127. }
  128. return orchestrator
  129. }
  130. func TestManagerRunsAndPublishesEnable(t *testing.T) {
  131. var mu sync.Mutex
  132. var states []vowifi.State
  133. manager := New(Options{
  134. OperationTimeout: time.Second,
  135. OnState: func(_ context.Context, state vowifi.State) error {
  136. mu.Lock()
  137. states = append(states, state)
  138. mu.Unlock()
  139. return nil
  140. },
  141. })
  142. t.Cleanup(func() {
  143. _ = manager.Close(context.Background())
  144. })
  145. if err := manager.Register(testOrchestrator(t, "ec20")); err != nil {
  146. t.Fatal(err)
  147. }
  148. if _, err := manager.RequestEnabled("ec20", true); err != nil {
  149. t.Fatal(err)
  150. }
  151. deadline := time.Now().Add(time.Second)
  152. for time.Now().Before(deadline) {
  153. state, err := manager.State("ec20")
  154. if err != nil {
  155. t.Fatal(err)
  156. }
  157. if state.Phase == vowifi.PhaseSMSReady {
  158. if state.PhoneNumber != "+447700900123" {
  159. t.Fatalf("phone number = %q", state.PhoneNumber)
  160. }
  161. mu.Lock()
  162. published := len(states)
  163. mu.Unlock()
  164. if published > 0 {
  165. return
  166. }
  167. }
  168. time.Sleep(time.Millisecond)
  169. }
  170. t.Fatal("enable did not finish")
  171. }
  172. func TestManagerRetriesEnabledPolicyUntilReady(t *testing.T) {
  173. provider := &flakyTunnelProvider{failures: 2}
  174. manager := New(Options{
  175. OperationTimeout: time.Second,
  176. RetryInitial: 5 * time.Millisecond,
  177. RetryMaximum: 10 * time.Millisecond,
  178. })
  179. t.Cleanup(func() { _ = manager.Close(context.Background()) })
  180. if err := manager.Register(testOrchestratorWithTunnel(t, "ec20", provider)); err != nil {
  181. t.Fatal(err)
  182. }
  183. if _, err := manager.RequestEnabled("ec20", true); err != nil {
  184. t.Fatal(err)
  185. }
  186. deadline := time.Now().Add(2 * time.Second)
  187. for time.Now().Before(deadline) {
  188. state, err := manager.State("ec20")
  189. if err != nil {
  190. t.Fatal(err)
  191. }
  192. if state.Phase == vowifi.PhaseSMSReady {
  193. if attempts := provider.Attempts(); attempts != 3 {
  194. t.Fatalf("tunnel attempts = %d, want 3", attempts)
  195. }
  196. return
  197. }
  198. time.Sleep(time.Millisecond)
  199. }
  200. t.Fatalf("VoWiFi did not become ready after retries; attempts=%d", provider.Attempts())
  201. }
  202. func TestManagerStopsAutomaticRetryWhenPolicyIsDisabled(t *testing.T) {
  203. provider := &flakyTunnelProvider{failures: 100}
  204. manager := New(Options{
  205. OperationTimeout: time.Second,
  206. RetryInitial: 100 * time.Millisecond,
  207. RetryMaximum: 100 * time.Millisecond,
  208. })
  209. t.Cleanup(func() { _ = manager.Close(context.Background()) })
  210. if err := manager.Register(testOrchestratorWithTunnel(t, "ec20", provider)); err != nil {
  211. t.Fatal(err)
  212. }
  213. if _, err := manager.RequestEnabled("ec20", true); err != nil {
  214. t.Fatal(err)
  215. }
  216. deadline := time.Now().Add(time.Second)
  217. for time.Now().Before(deadline) {
  218. manager.mu.Lock()
  219. pending := manager.entries["ec20"].autoRetryPending
  220. manager.mu.Unlock()
  221. if pending {
  222. break
  223. }
  224. time.Sleep(time.Millisecond)
  225. }
  226. if _, err := manager.RequestEnabled("ec20", false); err != nil {
  227. t.Fatal(err)
  228. }
  229. time.Sleep(150 * time.Millisecond)
  230. if attempts := provider.Attempts(); attempts != 1 {
  231. t.Fatalf("tunnel attempts after disable = %d, want 1", attempts)
  232. }
  233. state, err := manager.State("ec20")
  234. if err != nil {
  235. t.Fatal(err)
  236. }
  237. if state.Enabled || state.Phase != vowifi.PhaseIdle {
  238. t.Fatalf("state after disabling retry policy = %+v", state)
  239. }
  240. }
  241. func TestManagerRejectsUnknownDevice(t *testing.T) {
  242. manager := New(Options{})
  243. t.Cleanup(func() {
  244. _ = manager.Close(context.Background())
  245. })
  246. if _, err := manager.RequestEnabled("missing", true); !errors.Is(err, ErrNotRegistered) {
  247. t.Fatalf("error = %v", err)
  248. }
  249. }
  250. func TestManagerCreatesRuntimeOnDemand(t *testing.T) {
  251. created := 0
  252. manager := New(Options{
  253. Factory: func(_ context.Context, deviceID string) (*vowifi.Orchestrator, error) {
  254. created++
  255. return testOrchestrator(t, deviceID), nil
  256. },
  257. })
  258. t.Cleanup(func() {
  259. _ = manager.Close(context.Background())
  260. })
  261. state, err := manager.State("hot-added-ec20")
  262. if err != nil {
  263. t.Fatal(err)
  264. }
  265. if state.DeviceID != "hot-added-ec20" || created != 1 {
  266. t.Fatalf("state = %#v, created = %d", state, created)
  267. }
  268. if _, err := manager.RequestEnabled("hot-added-ec20", true); err != nil {
  269. t.Fatal(err)
  270. }
  271. if _, err := manager.State("hot-added-ec20"); err != nil {
  272. t.Fatal(err)
  273. }
  274. if created != 1 {
  275. t.Fatalf("factory calls = %d", created)
  276. }
  277. }
  278. func TestManagerCoalescesReconnectWhileLifecycleOperationIsBusy(t *testing.T) {
  279. manager := New(Options{OperationTimeout: time.Second})
  280. t.Cleanup(func() { _ = manager.Close(context.Background()) })
  281. if err := manager.Register(testOrchestrator(t, "ec20")); err != nil {
  282. t.Fatal(err)
  283. }
  284. if _, err := manager.RequestEnabled("ec20", true); err != nil {
  285. t.Fatal(err)
  286. }
  287. deadline := time.Now().Add(time.Second)
  288. for time.Now().Before(deadline) {
  289. manager.mu.Lock()
  290. busy := manager.entries["ec20"].busy
  291. manager.mu.Unlock()
  292. if !busy {
  293. break
  294. }
  295. time.Sleep(time.Millisecond)
  296. }
  297. before := manager.entries["ec20"].orchestrator.State()
  298. if before.Phase != vowifi.PhaseSMSReady {
  299. t.Fatalf("initial phase = %s", before.Phase)
  300. }
  301. started := make(chan struct{})
  302. release := make(chan struct{})
  303. if _, err := manager.startOperation("ec20", false, func(context.Context, *vowifi.Orchestrator) error {
  304. close(started)
  305. <-release
  306. return nil
  307. }); err != nil {
  308. t.Fatal(err)
  309. }
  310. <-started
  311. if _, err := manager.RequestReconnect("ec20"); err != nil {
  312. t.Fatalf("queued reconnect error = %v", err)
  313. }
  314. // Repeated route changes collapse into the same pending reconnect.
  315. if _, err := manager.RequestReconnect("ec20"); err != nil {
  316. t.Fatalf("second queued reconnect error = %v", err)
  317. }
  318. if _, err := manager.RequestEnabled("ec20", true); !errors.Is(err, ErrOperationInProgress) {
  319. t.Fatalf("non-reconnect operation error = %v, want ErrOperationInProgress", err)
  320. }
  321. manager.mu.Lock()
  322. pending := manager.entries["ec20"].reconnectPending
  323. manager.mu.Unlock()
  324. if !pending {
  325. t.Fatal("reconnect was not queued")
  326. }
  327. close(release)
  328. deadline = time.Now().Add(time.Second)
  329. for time.Now().Before(deadline) {
  330. manager.mu.Lock()
  331. busy := manager.entries["ec20"].busy
  332. manager.mu.Unlock()
  333. state := manager.entries["ec20"].orchestrator.State()
  334. if !busy && state.Phase == vowifi.PhaseSMSReady && state.Sequence > before.Sequence {
  335. return
  336. }
  337. time.Sleep(time.Millisecond)
  338. }
  339. t.Fatal("queued reconnect did not run after the active operation")
  340. }