ApplicationTests.cs 36 KB

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