ApplicationTests.cs 35 KB

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