ApplicationTests.cs 39 KB

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