ApplicationTests.cs 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086
  1. using Xunit.Abstractions;
  2. // Alias Console to MockConsole so we don't accidentally use Console
  3. namespace Terminal.Gui.ApplicationTests;
  4. public class ApplicationTests
  5. {
  6. public ApplicationTests (ITestOutputHelper output)
  7. {
  8. _output = output;
  9. ConsoleDriver.RunningUnitTests = true;
  10. #if DEBUG_IDISPOSABLE
  11. Responder.Instances.Clear ();
  12. RunState.Instances.Clear ();
  13. #endif
  14. }
  15. private readonly ITestOutputHelper _output;
  16. private object _timeoutLock;
  17. [Fact]
  18. public void AddTimeout_Fires ()
  19. {
  20. Assert.Null (_timeoutLock);
  21. _timeoutLock = new ();
  22. uint timeoutTime = 250;
  23. var initialized = false;
  24. var iteration = 0;
  25. var shutdown = false;
  26. object timeout = null;
  27. var timeoutCount = 0;
  28. Application.InitializedChanged += OnApplicationOnInitializedChanged;
  29. Application.Init (new FakeDriver ());
  30. Assert.True (initialized);
  31. Assert.False (shutdown);
  32. _output.WriteLine ("Application.Run<Toplevel> ().Dispose ()..");
  33. Application.Run<Toplevel> ().Dispose ();
  34. _output.WriteLine ("Back from Application.Run<Toplevel> ().Dispose ()");
  35. Assert.True (initialized);
  36. Assert.False (shutdown);
  37. Assert.Equal (1, timeoutCount);
  38. Application.Shutdown ();
  39. Application.InitializedChanged -= OnApplicationOnInitializedChanged;
  40. lock (_timeoutLock)
  41. {
  42. if (timeout is { })
  43. {
  44. Application.RemoveTimeout (timeout);
  45. timeout = null;
  46. }
  47. }
  48. Assert.True (initialized);
  49. Assert.True (shutdown);
  50. #if DEBUG_IDISPOSABLE
  51. Assert.Empty (Responder.Instances);
  52. #endif
  53. lock (_timeoutLock)
  54. {
  55. _timeoutLock = null;
  56. }
  57. return;
  58. void OnApplicationOnInitializedChanged (object s, EventArgs<bool> a)
  59. {
  60. if (a.CurrentValue)
  61. {
  62. Application.Iteration += OnApplicationOnIteration;
  63. initialized = true;
  64. lock (_timeoutLock)
  65. {
  66. _output.WriteLine ($"Setting timeout for {timeoutTime}ms");
  67. timeout = Application.AddTimeout (TimeSpan.FromMilliseconds (timeoutTime), TimeoutCallback);
  68. }
  69. }
  70. else
  71. {
  72. Application.Iteration -= OnApplicationOnIteration;
  73. shutdown = true;
  74. }
  75. }
  76. bool TimeoutCallback ()
  77. {
  78. lock (_timeoutLock)
  79. {
  80. _output.WriteLine ($"TimeoutCallback. Count: {++timeoutCount}. Application Iteration: {iteration}");
  81. if (timeout is { })
  82. {
  83. _output.WriteLine (" Nulling timeout.");
  84. timeout = null;
  85. }
  86. }
  87. // False means "don't re-do timer and remove it"
  88. return false;
  89. }
  90. void OnApplicationOnIteration (object s, IterationEventArgs a)
  91. {
  92. lock (_timeoutLock)
  93. {
  94. if (timeoutCount > 0)
  95. {
  96. _output.WriteLine ($"Iteration #{iteration} - Timeout fired. Calling Application.RequestStop.");
  97. Application.RequestStop ();
  98. return;
  99. }
  100. }
  101. iteration++;
  102. // Simulate a delay
  103. Thread.Sleep ((int)timeoutTime / 10);
  104. // Worst case scenario - something went wrong
  105. if (Application.IsInitialized && iteration > 25)
  106. {
  107. _output.WriteLine ($"Too many iterations ({iteration}): Calling Application.RequestStop.");
  108. Application.RequestStop ();
  109. }
  110. }
  111. }
  112. [Fact]
  113. public void Begin_Null_Toplevel_Throws ()
  114. {
  115. // Setup Mock driver
  116. Init ();
  117. // Test null Toplevel
  118. Assert.Throws<ArgumentNullException> (() => Application.Begin (null));
  119. Shutdown ();
  120. Assert.Null (Application.Top);
  121. Assert.Null (Application.MainLoop);
  122. Assert.Null (Application.Driver);
  123. }
  124. [Fact]
  125. [AutoInitShutdown]
  126. public void Begin_Sets_Application_Top_To_Console_Size ()
  127. {
  128. Assert.Null (Application.Top);
  129. Toplevel top = new ();
  130. Application.Begin (top);
  131. Assert.Equal (new (0, 0, 80, 25), Application.Top.Frame);
  132. ((FakeDriver)Application.Driver!).SetBufferSize (5, 5);
  133. Assert.Equal (new (0, 0, 5, 5), Application.Top.Frame);
  134. top.Dispose ();
  135. }
  136. [Fact]
  137. public void End_And_Shutdown_Should_Not_Dispose_ApplicationTop ()
  138. {
  139. Init ();
  140. RunState rs = Application.Begin (new ());
  141. Assert.Equal (rs.Toplevel, Application.Top);
  142. Application.End (rs);
  143. #if DEBUG_IDISPOSABLE
  144. Assert.True (rs.WasDisposed);
  145. Assert.False (Application.Top.WasDisposed); // Is true because the rs.Toplevel is the same as Application.Top
  146. #endif
  147. Assert.Null (rs.Toplevel);
  148. Toplevel top = Application.Top;
  149. #if DEBUG_IDISPOSABLE
  150. Exception exception = Record.Exception (() => Shutdown ());
  151. Assert.NotNull (exception);
  152. Assert.False (top.WasDisposed);
  153. top.Dispose ();
  154. Assert.True (top.WasDisposed);
  155. #endif
  156. Shutdown ();
  157. Assert.Null (Application.Top);
  158. }
  159. [Fact]
  160. public void Init_Begin_End_Cleans_Up ()
  161. {
  162. Init ();
  163. // Begin will cause Run() to be called, which will call Begin(). Thus will block the tests
  164. // if we don't stop
  165. Application.Iteration += (s, a) => { Application.RequestStop (); };
  166. RunState runstate = null;
  167. EventHandler<RunStateEventArgs> newRunStateFn = (s, e) =>
  168. {
  169. Assert.NotNull (e.State);
  170. runstate = e.State;
  171. };
  172. Application.NotifyNewRunState += newRunStateFn;
  173. var topLevel = new Toplevel ();
  174. RunState rs = Application.Begin (topLevel);
  175. Assert.NotNull (rs);
  176. Assert.NotNull (runstate);
  177. Assert.Equal (rs, runstate);
  178. Assert.Equal (topLevel, Application.Top);
  179. Application.NotifyNewRunState -= newRunStateFn;
  180. Application.End (runstate);
  181. Assert.NotNull (Application.Top);
  182. Assert.NotNull (Application.MainLoop);
  183. Assert.NotNull (Application.Driver);
  184. topLevel.Dispose ();
  185. Shutdown ();
  186. Assert.Null (Application.Top);
  187. Assert.Null (Application.MainLoop);
  188. Assert.Null (Application.Driver);
  189. }
  190. [Theory]
  191. [InlineData (typeof (FakeDriver))]
  192. [InlineData (typeof (NetDriver))]
  193. //[InlineData (typeof (ANSIDriver))]
  194. [InlineData (typeof (WindowsDriver))]
  195. [InlineData (typeof (CursesDriver))]
  196. public void Init_DriverName_Should_Pick_Correct_Driver (Type driverType)
  197. {
  198. var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
  199. Application.Init (driverName: driverType.Name);
  200. Assert.NotNull (Application.Driver);
  201. Assert.NotEqual (driver, Application.Driver);
  202. Assert.Equal (driverType, Application.Driver?.GetType ());
  203. Shutdown ();
  204. }
  205. [Fact]
  206. public void Init_Null_Driver_Should_Pick_A_Driver ()
  207. {
  208. Application.Init ();
  209. Assert.NotNull (Application.Driver);
  210. Shutdown ();
  211. }
  212. [Theory]
  213. [InlineData (typeof (FakeDriver))]
  214. [InlineData (typeof (NetDriver))]
  215. [InlineData (typeof (WindowsDriver))]
  216. [InlineData (typeof (CursesDriver))]
  217. public void Init_ResetState_Resets_Properties (Type driverType)
  218. {
  219. ConfigurationManager.ThrowOnJsonErrors = true;
  220. // For all the fields/properties of Application, check that they are reset to their default values
  221. // Set some values
  222. Application.Init (driverName: driverType.Name);
  223. Application.IsInitialized = true;
  224. // Reset
  225. Application.ResetState ();
  226. void CheckReset ()
  227. {
  228. // Check that all fields and properties are set to their default values
  229. // Public Properties
  230. Assert.Null (Application.Top);
  231. Assert.Null (Application.MouseGrabView);
  232. Assert.Null (Application.WantContinuousButtonPressedView);
  233. // Don't check Application.ForceDriver
  234. // Assert.Empty (Application.ForceDriver);
  235. // Don't check Application.Force16Colors
  236. //Assert.False (Application.Force16Colors);
  237. Assert.Null (Application.Driver);
  238. Assert.Null (Application.MainLoop);
  239. Assert.False (Application.EndAfterFirstIteration);
  240. Assert.Equal (Key.Tab.WithShift, Application.PrevTabKey);
  241. Assert.Equal (Key.Tab, Application.NextTabKey);
  242. Assert.Equal (Key.F6.WithShift, Application.PrevTabGroupKey);
  243. Assert.Equal (Key.F6, Application.NextTabGroupKey);
  244. Assert.Equal (Key.Esc, Application.QuitKey);
  245. // Internal properties
  246. Assert.False (Application.IsInitialized);
  247. Assert.Equal (Application.GetSupportedCultures (), Application.SupportedCultures);
  248. Assert.Equal (Application.GetAvailableCulturesFromEmbeddedResources (), Application.SupportedCultures);
  249. Assert.False (Application._forceFakeConsole);
  250. Assert.Equal (-1, Application.MainThreadId);
  251. Assert.Empty (Application.TopLevels);
  252. Assert.Null (Application.MouseEnteredView);
  253. // Keyboard
  254. Assert.Empty (Application.GetViewKeyBindings ());
  255. // Navigation
  256. Assert.Null (Application.Navigation);
  257. // Events - Can't check
  258. //Assert.Null (Application.NotifyNewRunState);
  259. //Assert.Null (Application.NotifyNewRunState);
  260. //Assert.Null (Application.Iteration);
  261. //Assert.Null (Application.SizeChanging);
  262. //Assert.Null (Application.GrabbedMouse);
  263. //Assert.Null (Application.UnGrabbingMouse);
  264. //Assert.Null (Application.GrabbedMouse);
  265. //Assert.Null (Application.UnGrabbedMouse);
  266. //Assert.Null (Application.MouseEvent);
  267. //Assert.Null (Application.KeyDown);
  268. //Assert.Null (Application.KeyUp);
  269. }
  270. CheckReset ();
  271. // Set the values that can be set
  272. Application.IsInitialized = true;
  273. Application._forceFakeConsole = true;
  274. Application.MainThreadId = 1;
  275. //Application._topLevels = new List<Toplevel> ();
  276. Application.MouseEnteredView = new ();
  277. //Application.SupportedCultures = new List<CultureInfo> ();
  278. Application.Force16Colors = true;
  279. //Application.ForceDriver = "driver";
  280. Application.EndAfterFirstIteration = true;
  281. Application.PrevTabGroupKey = Key.A;
  282. Application.NextTabGroupKey = Key.B;
  283. Application.QuitKey = Key.C;
  284. Application.KeyBindings.Add (Key.D, KeyBindingScope.Application, Command.Cancel);
  285. //ApplicationOverlapped.OverlappedChildren = new List<View> ();
  286. //ApplicationOverlapped.OverlappedTop =
  287. Application.MouseEnteredView = new ();
  288. //Application.WantContinuousButtonPressedView = new View ();
  289. Application.Navigation = new ();
  290. Application.ResetState ();
  291. CheckReset ();
  292. ConfigurationManager.ThrowOnJsonErrors = false;
  293. }
  294. [Fact]
  295. public void Init_Shutdown_Cleans_Up ()
  296. {
  297. // Verify initial state is per spec
  298. //Pre_Init_State ();
  299. Application.Init (new FakeDriver ());
  300. // Verify post-Init state is correct
  301. //Post_Init_State ();
  302. Application.Shutdown ();
  303. // Verify state is back to initial
  304. //Pre_Init_State ();
  305. #if DEBUG_IDISPOSABLE
  306. // Validate there are no outstanding Responder-based instances
  307. // after a scenario was selected to run. This proves the main UI Catalog
  308. // 'app' closed cleanly.
  309. Assert.Empty (Responder.Instances);
  310. #endif
  311. }
  312. [Theory]
  313. [InlineData (typeof (FakeDriver))]
  314. [InlineData (typeof (NetDriver))]
  315. [InlineData (typeof (WindowsDriver))]
  316. [InlineData (typeof (CursesDriver))]
  317. public void Init_Shutdown_Fire_InitializedChanged (Type driverType)
  318. {
  319. var initialized = false;
  320. var shutdown = false;
  321. Application.InitializedChanged += OnApplicationOnInitializedChanged;
  322. Application.Init (driverName: driverType.Name);
  323. Assert.True (initialized);
  324. Assert.False (shutdown);
  325. Application.Shutdown ();
  326. Assert.True (initialized);
  327. Assert.True (shutdown);
  328. Application.InitializedChanged -= OnApplicationOnInitializedChanged;
  329. return;
  330. void OnApplicationOnInitializedChanged (object s, EventArgs<bool> a)
  331. {
  332. if (a.CurrentValue)
  333. {
  334. initialized = true;
  335. }
  336. else
  337. {
  338. shutdown = true;
  339. }
  340. }
  341. }
  342. [Fact]
  343. public void Init_Unbalanced_Throws ()
  344. {
  345. Application.Init (new FakeDriver ());
  346. Assert.Throws<InvalidOperationException> (
  347. () =>
  348. Application.InternalInit (
  349. new FakeDriver ()
  350. )
  351. );
  352. Shutdown ();
  353. Assert.Null (Application.Top);
  354. Assert.Null (Application.MainLoop);
  355. Assert.Null (Application.Driver);
  356. // Now try the other way
  357. Application.InternalInit (new FakeDriver ());
  358. Assert.Throws<InvalidOperationException> (() => Application.Init (new FakeDriver ()));
  359. Shutdown ();
  360. Assert.Null (Application.Top);
  361. Assert.Null (Application.MainLoop);
  362. Assert.Null (Application.Driver);
  363. }
  364. [Fact]
  365. public void Init_WithoutTopLevelFactory_Begin_End_Cleans_Up ()
  366. {
  367. // Begin will cause Run() to be called, which will call Begin(). Thus will block the tests
  368. // if we don't stop
  369. Application.Iteration += (s, a) => { Application.RequestStop (); };
  370. // NOTE: Run<T>, when called after Init has been called behaves differently than
  371. // when called if Init has not been called.
  372. Toplevel topLevel = new ();
  373. Application.InternalInit (new FakeDriver ());
  374. RunState runstate = null;
  375. EventHandler<RunStateEventArgs> newRunStateFn = (s, e) =>
  376. {
  377. Assert.NotNull (e.State);
  378. runstate = e.State;
  379. };
  380. Application.NotifyNewRunState += newRunStateFn;
  381. RunState rs = Application.Begin (topLevel);
  382. Assert.NotNull (rs);
  383. Assert.NotNull (runstate);
  384. Assert.Equal (rs, runstate);
  385. Assert.Equal (topLevel, Application.Top);
  386. Application.NotifyNewRunState -= newRunStateFn;
  387. Application.End (runstate);
  388. Assert.NotNull (Application.Top);
  389. Assert.NotNull (Application.MainLoop);
  390. Assert.NotNull (Application.Driver);
  391. topLevel.Dispose ();
  392. Shutdown ();
  393. Assert.Null (Application.Top);
  394. Assert.Null (Application.MainLoop);
  395. Assert.Null (Application.Driver);
  396. }
  397. [Fact]
  398. public void Init_NoParam_ForceDriver_Works ()
  399. {
  400. Application.ForceDriver = "FakeDriver";
  401. Application.Init ();
  402. Assert.IsType<FakeDriver> (Application.Driver);
  403. Application.ResetState ();
  404. }
  405. [Fact]
  406. [AutoInitShutdown]
  407. public void Internal_Properties_Correct ()
  408. {
  409. Assert.True (Application.IsInitialized);
  410. Assert.Null (Application.Top);
  411. RunState rs = Application.Begin (new ());
  412. Assert.Equal (Application.Top, rs.Toplevel);
  413. Assert.Null (Application.MouseGrabView); // public
  414. Assert.Null (Application.WantContinuousButtonPressedView); // public
  415. Application.Top.Dispose ();
  416. }
  417. // Invoke Tests
  418. // TODO: Test with threading scenarios
  419. [Fact]
  420. public void Invoke_Adds_Idle ()
  421. {
  422. Application.Init (new FakeDriver ());
  423. var top = new Toplevel ();
  424. RunState rs = Application.Begin (top);
  425. var firstIteration = false;
  426. var actionCalled = 0;
  427. Application.Invoke (() => { actionCalled++; });
  428. Application.MainLoop.Running = true;
  429. Application.RunIteration (ref rs, ref firstIteration);
  430. Assert.Equal (1, actionCalled);
  431. top.Dispose ();
  432. Application.Shutdown ();
  433. }
  434. [Fact]
  435. public void Run_Iteration_Fires ()
  436. {
  437. var iteration = 0;
  438. Application.Init (new FakeDriver ());
  439. Application.Iteration += Application_Iteration;
  440. Application.Run<Toplevel> ().Dispose ();
  441. Assert.Equal (1, iteration);
  442. Application.Shutdown ();
  443. return;
  444. void Application_Iteration (object sender, IterationEventArgs e)
  445. {
  446. if (iteration > 0)
  447. {
  448. Assert.Fail ();
  449. }
  450. iteration++;
  451. Application.RequestStop ();
  452. }
  453. }
  454. private void Init ()
  455. {
  456. Application.Init (new FakeDriver ());
  457. Assert.NotNull (Application.Driver);
  458. Assert.NotNull (Application.MainLoop);
  459. Assert.NotNull (SynchronizationContext.Current);
  460. }
  461. private void Shutdown () { Application.Shutdown (); }
  462. #region RunTests
  463. [Fact]
  464. public void Run_T_After_InitWithDriver_with_TopLevel_Does_Not_Throws ()
  465. {
  466. // Setup Mock driver
  467. Init ();
  468. Application.Iteration += (s, e) => Application.RequestStop ();
  469. // Run<Toplevel> when already initialized or not with a Driver will not throw (because Window is derived from Toplevel)
  470. // Using another type not derived from Toplevel will throws at compile time
  471. Application.Run<Window> ();
  472. Assert.True (Application.Top is Window);
  473. Application.Top.Dispose ();
  474. Shutdown ();
  475. Assert.Null (Application.Top);
  476. Assert.Null (Application.MainLoop);
  477. Assert.Null (Application.Driver);
  478. }
  479. [Fact]
  480. public void Run_T_After_InitWithDriver_with_TopLevel_and_Driver_Does_Not_Throws ()
  481. {
  482. // Setup Mock driver
  483. Init ();
  484. Application.Iteration += (s, e) => Application.RequestStop ();
  485. // Run<Toplevel> when already initialized or not with a Driver will not throw (because Window is derived from Toplevel)
  486. // Using another type not derived from Toplevel will throws at compile time
  487. Application.Run<Window> (null, new FakeDriver ());
  488. Assert.True (Application.Top is Window);
  489. Application.Top.Dispose ();
  490. // Run<Toplevel> when already initialized or not with a Driver will not throw (because Dialog is derived from Toplevel)
  491. Application.Run<Dialog> (null, new FakeDriver ());
  492. Assert.True (Application.Top is Dialog);
  493. Application.Top.Dispose ();
  494. Shutdown ();
  495. Assert.Null (Application.Top);
  496. Assert.Null (Application.MainLoop);
  497. Assert.Null (Application.Driver);
  498. }
  499. [Fact]
  500. [TestRespondersDisposed]
  501. public void Run_T_After_Init_Does_Not_Disposes_Application_Top ()
  502. {
  503. Init ();
  504. // Init doesn't create a Toplevel and assigned it to Application.Top
  505. // but Begin does
  506. var initTop = new Toplevel ();
  507. Application.Iteration += (s, a) =>
  508. {
  509. Assert.NotEqual (initTop, Application.Top);
  510. #if DEBUG_IDISPOSABLE
  511. Assert.False (initTop.WasDisposed);
  512. #endif
  513. Application.RequestStop ();
  514. };
  515. Application.Run<Toplevel> ();
  516. #if DEBUG_IDISPOSABLE
  517. Assert.False (initTop.WasDisposed);
  518. initTop.Dispose ();
  519. Assert.True (initTop.WasDisposed);
  520. #endif
  521. Application.Top.Dispose ();
  522. Shutdown ();
  523. Assert.Null (Application.Top);
  524. Assert.Null (Application.MainLoop);
  525. Assert.Null (Application.Driver);
  526. }
  527. [Fact]
  528. [TestRespondersDisposed]
  529. public void Run_T_After_InitWithDriver_with_TestTopLevel_DoesNotThrow ()
  530. {
  531. // Setup Mock driver
  532. Init ();
  533. Application.Iteration += (s, a) => { Application.RequestStop (); };
  534. // Init has been called and we're passing no driver to Run<TestTopLevel>. This is ok.
  535. Application.Run<Toplevel> ();
  536. Application.Top.Dispose ();
  537. Shutdown ();
  538. Assert.Null (Application.Top);
  539. Assert.Null (Application.MainLoop);
  540. Assert.Null (Application.Driver);
  541. }
  542. [Fact]
  543. [TestRespondersDisposed]
  544. public void Run_T_After_InitNullDriver_with_TestTopLevel_DoesNotThrow ()
  545. {
  546. Application.ForceDriver = "FakeDriver";
  547. Application.Init ();
  548. Assert.Equal (typeof (FakeDriver), Application.Driver?.GetType ());
  549. Application.Iteration += (s, a) => { Application.RequestStop (); };
  550. // Init has been called, selecting FakeDriver; we're passing no driver to Run<TestTopLevel>. Should be fine.
  551. Application.Run<Toplevel> ();
  552. Application.Top.Dispose ();
  553. Shutdown ();
  554. Assert.Null (Application.Top);
  555. Assert.Null (Application.MainLoop);
  556. Assert.Null (Application.Driver);
  557. }
  558. [Fact]
  559. [TestRespondersDisposed]
  560. public void Run_T_Init_Driver_Cleared_with_TestTopLevel_Throws ()
  561. {
  562. Init ();
  563. Application.Driver = null;
  564. // Init has been called, but Driver has been set to null. Bad.
  565. Assert.Throws<InvalidOperationException> (() => Application.Run<Toplevel> ());
  566. Shutdown ();
  567. Assert.Null (Application.Top);
  568. Assert.Null (Application.MainLoop);
  569. Assert.Null (Application.Driver);
  570. }
  571. [Fact]
  572. [TestRespondersDisposed]
  573. public void Run_T_NoInit_DoesNotThrow ()
  574. {
  575. Application.ForceDriver = "FakeDriver";
  576. Application.Iteration += (s, a) => { Application.RequestStop (); };
  577. Application.Run<Toplevel> ();
  578. Assert.Equal (typeof (FakeDriver), Application.Driver?.GetType ());
  579. Application.Top.Dispose ();
  580. Shutdown ();
  581. Assert.Null (Application.Top);
  582. Assert.Null (Application.MainLoop);
  583. Assert.Null (Application.Driver);
  584. }
  585. [Fact]
  586. [TestRespondersDisposed]
  587. public void Run_T_NoInit_WithDriver_DoesNotThrow ()
  588. {
  589. Application.Iteration += (s, a) => { Application.RequestStop (); };
  590. // Init has NOT been called and we're passing a valid driver to Run<TestTopLevel>. This is ok.
  591. Application.Run<Toplevel> (null, new FakeDriver ());
  592. Application.Top.Dispose ();
  593. Shutdown ();
  594. Assert.Null (Application.Top);
  595. Assert.Null (Application.MainLoop);
  596. Assert.Null (Application.Driver);
  597. }
  598. [Fact]
  599. [TestRespondersDisposed]
  600. public void Run_RequestStop_Stops ()
  601. {
  602. // Setup Mock driver
  603. Init ();
  604. var top = new Toplevel ();
  605. RunState rs = Application.Begin (top);
  606. Assert.NotNull (rs);
  607. Application.Iteration += (s, a) => { Application.RequestStop (); };
  608. Application.Run (top);
  609. top.Dispose ();
  610. Application.Shutdown ();
  611. Assert.Null (Application.Top);
  612. Assert.Null (Application.MainLoop);
  613. Assert.Null (Application.Driver);
  614. }
  615. [Fact]
  616. [TestRespondersDisposed]
  617. public void Run_RunningFalse_Stops ()
  618. {
  619. // Setup Mock driver
  620. Init ();
  621. var top = new Toplevel ();
  622. RunState rs = Application.Begin (top);
  623. Assert.NotNull (rs);
  624. Application.Iteration += (s, a) => { top.Running = false; };
  625. Application.Run (top);
  626. top.Dispose ();
  627. Application.Shutdown ();
  628. Assert.Null (Application.Top);
  629. Assert.Null (Application.MainLoop);
  630. Assert.Null (Application.Driver);
  631. }
  632. [Fact]
  633. [TestRespondersDisposed]
  634. public void Run_Loaded_Ready_Unloaded_Events ()
  635. {
  636. Init ();
  637. Toplevel top = new ();
  638. var count = 0;
  639. top.Loaded += (s, e) => count++;
  640. top.Ready += (s, e) => count++;
  641. top.Unloaded += (s, e) => count++;
  642. Application.Iteration += (s, a) => Application.RequestStop ();
  643. Application.Run (top);
  644. top.Dispose ();
  645. Application.Shutdown ();
  646. Assert.Equal (3, count);
  647. }
  648. // TODO: All Toplevel layout tests should be moved to ToplevelTests.cs
  649. [Fact (Skip = "#2491 - Changing focus should cause NeedsDisplay = true, so bogus test?")]
  650. public void Run_Toplevel_With_Modal_View_Does_Not_Refresh_If_Not_Dirty ()
  651. {
  652. Init ();
  653. var count = 0;
  654. // Don't use Dialog here as it has more layout logic. Use Window instead.
  655. Dialog d = null;
  656. Toplevel top = new ();
  657. top.DrawContent += (s, a) => count++;
  658. int iteration = -1;
  659. Application.Iteration += (s, a) =>
  660. {
  661. iteration++;
  662. if (iteration == 0)
  663. {
  664. // TODO: Don't use Dialog here as it has more layout logic. Use Window instead.
  665. d = new ();
  666. d.DrawContent += (s, a) => count++;
  667. Application.Run (d);
  668. }
  669. else if (iteration < 3)
  670. {
  671. Application.OnMouseEvent (new () { Flags = MouseFlags.ReportMousePosition });
  672. Assert.False (top.NeedsDisplay);
  673. Assert.False (top.SubViewNeedsDisplay);
  674. Assert.False (top.LayoutNeeded);
  675. Assert.False (d.NeedsDisplay);
  676. Assert.False (d.SubViewNeedsDisplay);
  677. Assert.False (d.LayoutNeeded);
  678. }
  679. else
  680. {
  681. Application.RequestStop ();
  682. }
  683. };
  684. Application.Run (top);
  685. top.Dispose ();
  686. Application.Shutdown ();
  687. // 1 - First top load, 1 - Dialog load, 1 - Dialog unload, Total - 3.
  688. Assert.Equal (3, count);
  689. }
  690. // TODO: All Toplevel layout tests should be moved to ToplevelTests.cs
  691. [Fact]
  692. public void Run_A_Modal_Toplevel_Refresh_Background_On_Moving ()
  693. {
  694. Init ();
  695. // Don't use Dialog here as it has more layout logic. Use Window instead.
  696. var w = new Window
  697. {
  698. Width = 5, Height = 5,
  699. Arrangement = ViewArrangement.Movable
  700. };
  701. ((FakeDriver)Application.Driver!).SetBufferSize (10, 10);
  702. RunState rs = Application.Begin (w);
  703. // Don't use visuals to test as style of border can change over time.
  704. Assert.Equal (new (0, 0), w.Frame.Location);
  705. Application.OnMouseEvent (new () { Flags = MouseFlags.Button1Pressed });
  706. Assert.Equal (w.Border, Application.MouseGrabView);
  707. Assert.Equal (new (0, 0), w.Frame.Location);
  708. // Move down and to the right.
  709. Application.OnMouseEvent (new () { Position = new (1, 1), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition });
  710. Assert.Equal (new (1, 1), w.Frame.Location);
  711. Application.End (rs);
  712. w.Dispose ();
  713. Application.Shutdown ();
  714. }
  715. [Fact]
  716. public void End_Does_Not_Dispose ()
  717. {
  718. Init ();
  719. var top = new Toplevel ();
  720. Window w = new ();
  721. w.Ready += (s, e) => Application.RequestStop (); // Causes `End` to be called
  722. Application.Run (w);
  723. #if DEBUG_IDISPOSABLE
  724. Assert.False (w.WasDisposed);
  725. #endif
  726. Assert.NotNull (w);
  727. Assert.Equal (string.Empty, w.Title); // Valid - w has not been disposed. The user may want to run it again
  728. Assert.NotNull (Application.Top);
  729. Assert.Equal (w, Application.Top);
  730. Assert.NotEqual (top, Application.Top);
  731. Application.Run (w); // Valid - w has not been disposed.
  732. #if DEBUG_IDISPOSABLE
  733. Assert.False (w.WasDisposed);
  734. Exception exception = Record.Exception (Application.Shutdown); // Invalid - w has not been disposed.
  735. Assert.NotNull (exception);
  736. w.Dispose ();
  737. Assert.True (w.WasDisposed);
  738. exception = Record.Exception (
  739. () => Application.Run (
  740. w)); // Invalid - w has been disposed. Run it in debug mode will throw, otherwise the user may want to run it again
  741. Assert.NotNull (exception);
  742. exception = Record.Exception (() => Assert.Equal (string.Empty, w.Title)); // Invalid - w has been disposed and cannot be accessed
  743. Assert.NotNull (exception);
  744. exception = Record.Exception (() => w.Title = "NewTitle"); // Invalid - w has been disposed and cannot be accessed
  745. Assert.NotNull (exception);
  746. #endif
  747. Application.Shutdown ();
  748. Assert.NotNull (w);
  749. Assert.NotNull (top);
  750. Assert.Null (Application.Top);
  751. }
  752. [Fact]
  753. public void Run_Creates_Top_Without_Init ()
  754. {
  755. var driver = new FakeDriver ();
  756. Assert.Null (Application.Top);
  757. Application.Iteration += (s, e) =>
  758. {
  759. Assert.NotNull (Application.Top);
  760. Application.RequestStop ();
  761. };
  762. Toplevel top = Application.Run (null, driver);
  763. #if DEBUG_IDISPOSABLE
  764. Assert.Equal (top, Application.Top);
  765. Assert.False (top.WasDisposed);
  766. Exception exception = Record.Exception (Application.Shutdown);
  767. Assert.NotNull (exception);
  768. Assert.False (top.WasDisposed);
  769. #endif
  770. // It's up to caller to dispose it
  771. top.Dispose ();
  772. #if DEBUG_IDISPOSABLE
  773. Assert.True (top.WasDisposed);
  774. #endif
  775. Assert.NotNull (Application.Top);
  776. Application.Shutdown ();
  777. Assert.Null (Application.Top);
  778. }
  779. [Fact]
  780. public void Run_T_Creates_Top_Without_Init ()
  781. {
  782. var driver = new FakeDriver ();
  783. Assert.Null (Application.Top);
  784. Application.Iteration += (s, e) =>
  785. {
  786. Assert.NotNull (Application.Top);
  787. Application.RequestStop ();
  788. };
  789. Application.Run<Toplevel> (null, driver);
  790. #if DEBUG_IDISPOSABLE
  791. Assert.False (Application.Top.WasDisposed);
  792. Exception exception = Record.Exception (Application.Shutdown);
  793. Assert.NotNull (exception);
  794. Assert.False (Application.Top.WasDisposed);
  795. // It's up to caller to dispose it
  796. Application.Top.Dispose ();
  797. Assert.True (Application.Top.WasDisposed);
  798. #endif
  799. Assert.NotNull (Application.Top);
  800. Application.Shutdown ();
  801. Assert.Null (Application.Top);
  802. }
  803. [Fact]
  804. public void Run_t_Does_Not_Creates_Top_Without_Init ()
  805. {
  806. // When a Toplevel is created it must already have all the Application configuration loaded
  807. // This is only possible by two ways:
  808. // 1 - Using Application.Init first
  809. // 2 - Using Application.Run() or Application.Run<T>()
  810. // The Application.Run(new(Toplevel)) must always call Application.Init() first because
  811. // the new(Toplevel) may be a derived class that is possible using Application static
  812. // properties that is only available after the Application.Init was called
  813. var driver = new FakeDriver ();
  814. Assert.Null (Application.Top);
  815. Assert.Throws<InvalidOperationException> (() => Application.Run (new Toplevel ()));
  816. Application.Init (driver);
  817. Application.Iteration += (s, e) =>
  818. {
  819. Assert.NotNull (Application.Top);
  820. Application.RequestStop ();
  821. };
  822. Application.Run (new Toplevel ());
  823. #if DEBUG_IDISPOSABLE
  824. Assert.False (Application.Top.WasDisposed);
  825. Exception exception = Record.Exception (Application.Shutdown);
  826. Assert.NotNull (exception);
  827. Assert.False (Application.Top.WasDisposed);
  828. // It's up to caller to dispose it
  829. Application.Top.Dispose ();
  830. Assert.True (Application.Top.WasDisposed);
  831. #endif
  832. Assert.NotNull (Application.Top);
  833. Application.Shutdown ();
  834. Assert.Null (Application.Top);
  835. }
  836. // TODO: Add tests for Run that test errorHandler
  837. #endregion
  838. #region ShutdownTests
  839. [Fact]
  840. public async void Shutdown_Allows_Async ()
  841. {
  842. var isCompletedSuccessfully = false;
  843. async Task TaskWithAsyncContinuation ()
  844. {
  845. await Task.Yield ();
  846. await Task.Yield ();
  847. isCompletedSuccessfully = true;
  848. }
  849. Init ();
  850. Application.Shutdown ();
  851. Assert.False (isCompletedSuccessfully);
  852. await TaskWithAsyncContinuation ();
  853. Thread.Sleep (100);
  854. Assert.True (isCompletedSuccessfully);
  855. }
  856. [Fact]
  857. public void Shutdown_Resets_SyncContext ()
  858. {
  859. Init ();
  860. Application.Shutdown ();
  861. Assert.Null (SynchronizationContext.Current);
  862. }
  863. #endregion
  864. }