ApplicationTests.cs 36 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159
  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. // Keyboard
  256. Assert.Empty (Application.GetViewKeyBindings ());
  257. // Mouse
  258. Assert.Null (Application._lastMousePosition);
  259. // Navigation
  260. Assert.Null (Application.Navigation);
  261. // Events - Can't check
  262. //Assert.Null (Application.NotifyNewRunState);
  263. //Assert.Null (Application.NotifyNewRunState);
  264. //Assert.Null (Application.Iteration);
  265. //Assert.Null (Application.SizeChanging);
  266. //Assert.Null (Application.GrabbedMouse);
  267. //Assert.Null (Application.UnGrabbingMouse);
  268. //Assert.Null (Application.GrabbedMouse);
  269. //Assert.Null (Application.UnGrabbedMouse);
  270. //Assert.Null (Application.MouseEvent);
  271. //Assert.Null (Application.KeyDown);
  272. //Assert.Null (Application.KeyUp);
  273. }
  274. CheckReset ();
  275. // Set the values that can be set
  276. Application.Initialized = true;
  277. Application._forceFakeConsole = true;
  278. Application.MainThreadId = 1;
  279. //Application._topLevels = new List<Toplevel> ();
  280. Application._cachedViewsUnderMouse.Clear ();
  281. //Application.SupportedCultures = new List<CultureInfo> ();
  282. Application.Force16Colors = true;
  283. //Application.ForceDriver = "driver";
  284. Application.EndAfterFirstIteration = true;
  285. Application.PrevTabGroupKey = Key.A;
  286. Application.NextTabGroupKey = Key.B;
  287. Application.QuitKey = Key.C;
  288. Application.KeyBindings.Add (Key.D, KeyBindingScope.Application, Command.Cancel);
  289. Application._cachedViewsUnderMouse.Clear ();
  290. //Application.WantContinuousButtonPressedView = new View ();
  291. // Mouse
  292. Application._lastMousePosition = new Point (1, 1);
  293. Application.Navigation = new ();
  294. Application.ResetState ();
  295. CheckReset ();
  296. ThrowOnJsonErrors = false;
  297. }
  298. [Fact]
  299. public void Init_Shutdown_Cleans_Up ()
  300. {
  301. // Verify initial state is per spec
  302. //Pre_Init_State ();
  303. Application.Init (new FakeDriver ());
  304. // Verify post-Init state is correct
  305. //Post_Init_State ();
  306. Application.Shutdown ();
  307. // Verify state is back to initial
  308. //Pre_Init_State ();
  309. #if DEBUG_IDISPOSABLE
  310. // Validate there are no outstanding Responder-based instances
  311. // after a scenario was selected to run. This proves the main UI Catalog
  312. // 'app' closed cleanly.
  313. Assert.Empty (View.Instances);
  314. #endif
  315. }
  316. [Fact]
  317. public void Shutdown_Alone_Does_Nothing () { Application.Shutdown (); }
  318. [Theory]
  319. [InlineData (typeof (FakeDriver))]
  320. [InlineData (typeof (NetDriver))]
  321. [InlineData (typeof (WindowsDriver))]
  322. [InlineData (typeof (CursesDriver))]
  323. public void Init_Shutdown_Fire_InitializedChanged (Type driverType)
  324. {
  325. var initialized = false;
  326. var shutdown = false;
  327. Application.InitializedChanged += OnApplicationOnInitializedChanged;
  328. Application.Init (driverName: driverType.Name);
  329. Assert.True (initialized);
  330. Assert.False (shutdown);
  331. Application.Shutdown ();
  332. Assert.True (initialized);
  333. Assert.True (shutdown);
  334. Application.InitializedChanged -= OnApplicationOnInitializedChanged;
  335. return;
  336. void OnApplicationOnInitializedChanged (object s, EventArgs<bool> a)
  337. {
  338. if (a.CurrentValue)
  339. {
  340. initialized = true;
  341. }
  342. else
  343. {
  344. shutdown = true;
  345. }
  346. }
  347. }
  348. [Fact]
  349. public void Init_Unbalanced_Throws ()
  350. {
  351. Application.Init (new FakeDriver ());
  352. Assert.Throws<InvalidOperationException> (
  353. () =>
  354. Application.InternalInit (
  355. new FakeDriver ()
  356. )
  357. );
  358. Shutdown ();
  359. Assert.Null (Application.Top);
  360. Assert.Null (Application.MainLoop);
  361. Assert.Null (Application.Driver);
  362. // Now try the other way
  363. Application.InternalInit (new FakeDriver ());
  364. Assert.Throws<InvalidOperationException> (() => Application.Init (new FakeDriver ()));
  365. Shutdown ();
  366. Assert.Null (Application.Top);
  367. Assert.Null (Application.MainLoop);
  368. Assert.Null (Application.Driver);
  369. }
  370. [Fact]
  371. public void Init_WithoutTopLevelFactory_Begin_End_Cleans_Up ()
  372. {
  373. // Begin will cause Run() to be called, which will call Begin(). Thus will block the tests
  374. // if we don't stop
  375. Application.Iteration += (s, a) => { Application.RequestStop (); };
  376. // NOTE: Run<T>, when called after Init has been called behaves differently than
  377. // when called if Init has not been called.
  378. Toplevel topLevel = new ();
  379. Application.InternalInit (new FakeDriver ());
  380. RunState runstate = null;
  381. EventHandler<RunStateEventArgs> newRunStateFn = (s, e) =>
  382. {
  383. Assert.NotNull (e.State);
  384. runstate = e.State;
  385. };
  386. Application.NotifyNewRunState += newRunStateFn;
  387. RunState rs = Application.Begin (topLevel);
  388. Assert.NotNull (rs);
  389. Assert.NotNull (runstate);
  390. Assert.Equal (rs, runstate);
  391. Assert.Equal (topLevel, Application.Top);
  392. Application.NotifyNewRunState -= newRunStateFn;
  393. Application.End (runstate);
  394. Assert.NotNull (Application.Top);
  395. Assert.NotNull (Application.MainLoop);
  396. Assert.NotNull (Application.Driver);
  397. topLevel.Dispose ();
  398. Shutdown ();
  399. Assert.Null (Application.Top);
  400. Assert.Null (Application.MainLoop);
  401. Assert.Null (Application.Driver);
  402. }
  403. [Fact]
  404. public void Init_NoParam_ForceDriver_Works ()
  405. {
  406. Application.ForceDriver = "FakeDriver";
  407. Application.Init ();
  408. Assert.IsType<FakeDriver> (Application.Driver);
  409. Application.ResetState ();
  410. }
  411. [Fact]
  412. public void Init_KeyBindings_Set_To_Defaults ()
  413. {
  414. // arrange
  415. Locations = ConfigLocations.All;
  416. ThrowOnJsonErrors = true;
  417. Application.QuitKey = Key.Q;
  418. Application.Init (new FakeDriver ());
  419. Assert.Equal (Key.Esc, Application.QuitKey);
  420. Application.Shutdown ();
  421. }
  422. [Fact]
  423. public void Init_KeyBindings_Set_To_Custom ()
  424. {
  425. // arrange
  426. Locations = ConfigLocations.Runtime;
  427. ThrowOnJsonErrors = true;
  428. RuntimeConfig = """
  429. {
  430. "Application.QuitKey": "Ctrl-Q"
  431. }
  432. """;
  433. Assert.Equal (Key.Esc, Application.QuitKey);
  434. // Act
  435. Application.Init (new FakeDriver ());
  436. Assert.Equal (Key.Q.WithCtrl, Application.QuitKey);
  437. Assert.Contains (Key.Q.WithCtrl, Application.KeyBindings.Bindings);
  438. Application.Shutdown ();
  439. Locations = ConfigLocations.Default;
  440. }
  441. [Fact]
  442. [AutoInitShutdown (verifyShutdown: true)]
  443. public void Internal_Properties_Correct ()
  444. {
  445. Assert.True (Application.Initialized);
  446. Assert.Null (Application.Top);
  447. RunState rs = Application.Begin (new ());
  448. Assert.Equal (Application.Top, rs.Toplevel);
  449. Assert.Null (Application.MouseGrabView); // public
  450. Assert.Null (Application.WantContinuousButtonPressedView); // public
  451. Application.Top.Dispose ();
  452. }
  453. // Invoke Tests
  454. // TODO: Test with threading scenarios
  455. [Fact]
  456. public void Invoke_Adds_Idle ()
  457. {
  458. Application.Init (new FakeDriver ());
  459. var top = new Toplevel ();
  460. RunState rs = Application.Begin (top);
  461. var firstIteration = false;
  462. var actionCalled = 0;
  463. Application.Invoke (() => { actionCalled++; });
  464. Application.MainLoop.Running = true;
  465. Application.RunIteration (ref rs, firstIteration);
  466. Assert.Equal (1, actionCalled);
  467. top.Dispose ();
  468. Application.Shutdown ();
  469. }
  470. [Fact]
  471. public void Run_Iteration_Fires ()
  472. {
  473. var iteration = 0;
  474. Application.Init (new FakeDriver ());
  475. Application.Iteration += Application_Iteration;
  476. Application.Run<Toplevel> ().Dispose ();
  477. Assert.Equal (1, iteration);
  478. Application.Shutdown ();
  479. return;
  480. void Application_Iteration (object sender, IterationEventArgs e)
  481. {
  482. if (iteration > 0)
  483. {
  484. Assert.Fail ();
  485. }
  486. iteration++;
  487. Application.RequestStop ();
  488. }
  489. }
  490. [Fact]
  491. public void Screen_Size_Changes ()
  492. {
  493. var driver = new FakeDriver ();
  494. Application.Init (driver);
  495. Assert.Equal (new (0, 0, 80, 25), driver.Screen);
  496. Assert.Equal (new (0, 0, 80, 25), Application.Screen);
  497. driver.Cols = 100;
  498. driver.Rows = 30;
  499. // IConsoleDriver.Screen isn't assignable
  500. //driver.Screen = new (0, 0, driver.Cols, Rows);
  501. Assert.Equal (new (0, 0, 100, 30), driver.Screen);
  502. Assert.NotEqual (new (0, 0, 100, 30), Application.Screen);
  503. Assert.Equal (new (0, 0, 80, 25), Application.Screen);
  504. Application.Screen = new (0, 0, driver.Cols, driver.Rows);
  505. Assert.Equal (new (0, 0, 100, 30), driver.Screen);
  506. Application.Shutdown ();
  507. }
  508. private void Init ()
  509. {
  510. Application.Init (new FakeDriver ());
  511. Assert.NotNull (Application.Driver);
  512. Assert.NotNull (Application.MainLoop);
  513. Assert.NotNull (SynchronizationContext.Current);
  514. }
  515. private void Shutdown () { Application.Shutdown (); }
  516. #region RunTests
  517. [Fact]
  518. public void Run_T_After_InitWithDriver_with_TopLevel_Does_Not_Throws ()
  519. {
  520. // Setup Mock driver
  521. Init ();
  522. Application.Iteration += (s, e) => Application.RequestStop ();
  523. // Run<Toplevel> when already initialized or not with a Driver will not throw (because Window is derived from Toplevel)
  524. // Using another type not derived from Toplevel will throws at compile time
  525. Application.Run<Window> ();
  526. Assert.True (Application.Top is Window);
  527. Application.Top.Dispose ();
  528. Shutdown ();
  529. Assert.Null (Application.Top);
  530. Assert.Null (Application.MainLoop);
  531. Assert.Null (Application.Driver);
  532. }
  533. [Fact]
  534. public void Run_T_After_InitWithDriver_with_TopLevel_and_Driver_Does_Not_Throws ()
  535. {
  536. // Setup Mock driver
  537. Init ();
  538. Application.Iteration += (s, e) => Application.RequestStop ();
  539. // Run<Toplevel> when already initialized or not with a Driver will not throw (because Window is derived from Toplevel)
  540. // Using another type not derived from Toplevel will throws at compile time
  541. Application.Run<Window> (null, new FakeDriver ());
  542. Assert.True (Application.Top is Window);
  543. Application.Top.Dispose ();
  544. // Run<Toplevel> when already initialized or not with a Driver will not throw (because Dialog is derived from Toplevel)
  545. Application.Run<Dialog> (null, new FakeDriver ());
  546. Assert.True (Application.Top is Dialog);
  547. Application.Top.Dispose ();
  548. Shutdown ();
  549. Assert.Null (Application.Top);
  550. Assert.Null (Application.MainLoop);
  551. Assert.Null (Application.Driver);
  552. }
  553. [Fact]
  554. [TestRespondersDisposed]
  555. public void Run_T_After_Init_Does_Not_Disposes_Application_Top ()
  556. {
  557. Init ();
  558. // Init doesn't create a Toplevel and assigned it to Application.Top
  559. // but Begin does
  560. var initTop = new Toplevel ();
  561. Application.Iteration += (s, a) =>
  562. {
  563. Assert.NotEqual (initTop, Application.Top);
  564. #if DEBUG_IDISPOSABLE
  565. Assert.False (initTop.WasDisposed);
  566. #endif
  567. Application.RequestStop ();
  568. };
  569. Application.Run<Toplevel> ();
  570. #if DEBUG_IDISPOSABLE
  571. Assert.False (initTop.WasDisposed);
  572. initTop.Dispose ();
  573. Assert.True (initTop.WasDisposed);
  574. #endif
  575. Application.Top.Dispose ();
  576. Shutdown ();
  577. Assert.Null (Application.Top);
  578. Assert.Null (Application.MainLoop);
  579. Assert.Null (Application.Driver);
  580. }
  581. [Fact]
  582. [TestRespondersDisposed]
  583. public void Run_T_After_InitWithDriver_with_TestTopLevel_DoesNotThrow ()
  584. {
  585. // Setup Mock driver
  586. Init ();
  587. Application.Iteration += (s, a) => { Application.RequestStop (); };
  588. // Init has been called and we're passing no driver to Run<TestTopLevel>. This is ok.
  589. Application.Run<Toplevel> ();
  590. Application.Top.Dispose ();
  591. Shutdown ();
  592. Assert.Null (Application.Top);
  593. Assert.Null (Application.MainLoop);
  594. Assert.Null (Application.Driver);
  595. }
  596. [Fact]
  597. [TestRespondersDisposed]
  598. public void Run_T_After_InitNullDriver_with_TestTopLevel_DoesNotThrow ()
  599. {
  600. Application.ForceDriver = "FakeDriver";
  601. Application.Init ();
  602. Assert.Equal (typeof (FakeDriver), Application.Driver?.GetType ());
  603. Application.Iteration += (s, a) => { Application.RequestStop (); };
  604. // Init has been called, selecting FakeDriver; we're passing no driver to Run<TestTopLevel>. Should be fine.
  605. Application.Run<Toplevel> ();
  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_T_Init_Driver_Cleared_with_TestTopLevel_Throws ()
  615. {
  616. Init ();
  617. Application.Driver = null;
  618. // Init has been called, but Driver has been set to null. Bad.
  619. Assert.Throws<InvalidOperationException> (() => Application.Run<Toplevel> ());
  620. Shutdown ();
  621. Assert.Null (Application.Top);
  622. Assert.Null (Application.MainLoop);
  623. Assert.Null (Application.Driver);
  624. }
  625. [Fact]
  626. [TestRespondersDisposed]
  627. public void Run_T_NoInit_DoesNotThrow ()
  628. {
  629. Application.ForceDriver = "FakeDriver";
  630. Application.Iteration += (s, a) => { Application.RequestStop (); };
  631. Application.Run<Toplevel> ();
  632. Assert.Equal (typeof (FakeDriver), Application.Driver?.GetType ());
  633. Application.Top.Dispose ();
  634. Shutdown ();
  635. Assert.Null (Application.Top);
  636. Assert.Null (Application.MainLoop);
  637. Assert.Null (Application.Driver);
  638. }
  639. [Fact]
  640. [TestRespondersDisposed]
  641. public void Run_T_NoInit_WithDriver_DoesNotThrow ()
  642. {
  643. Application.Iteration += (s, a) => { Application.RequestStop (); };
  644. // Init has NOT been called and we're passing a valid driver to Run<TestTopLevel>. This is ok.
  645. Application.Run<Toplevel> (null, new FakeDriver ());
  646. Application.Top.Dispose ();
  647. Shutdown ();
  648. Assert.Null (Application.Top);
  649. Assert.Null (Application.MainLoop);
  650. Assert.Null (Application.Driver);
  651. }
  652. [Fact]
  653. [TestRespondersDisposed]
  654. public void Run_RequestStop_Stops ()
  655. {
  656. // Setup Mock driver
  657. Init ();
  658. var top = new Toplevel ();
  659. RunState rs = Application.Begin (top);
  660. Assert.NotNull (rs);
  661. Application.Iteration += (s, a) => { Application.RequestStop (); };
  662. Application.Run (top);
  663. top.Dispose ();
  664. Application.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_RunningFalse_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) => { top.Running = false; };
  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. [TestRespondersDisposed]
  688. public void Run_Loaded_Ready_Unloaded_Events ()
  689. {
  690. Init ();
  691. Toplevel top = new ();
  692. var count = 0;
  693. top.Loaded += (s, e) => count++;
  694. top.Ready += (s, e) => count++;
  695. top.Unloaded += (s, e) => count++;
  696. Application.Iteration += (s, a) => Application.RequestStop ();
  697. Application.Run (top);
  698. top.Dispose ();
  699. Application.Shutdown ();
  700. Assert.Equal (3, count);
  701. }
  702. // TODO: All Toplevel layout tests should be moved to ToplevelTests.cs
  703. [Fact (Skip = "#2491 - Changing focus should cause NeedsDraw = true, so bogus test?")]
  704. public void Run_Toplevel_With_Modal_View_Does_Not_Refresh_If_Not_Dirty ()
  705. {
  706. Init ();
  707. var count = 0;
  708. // Don't use Dialog here as it has more layout logic. Use Window instead.
  709. Dialog d = null;
  710. Toplevel top = new ();
  711. top.DrawingContent += (s, a) => count++;
  712. int iteration = -1;
  713. Application.Iteration += (s, a) =>
  714. {
  715. iteration++;
  716. if (iteration == 0)
  717. {
  718. // TODO: Don't use Dialog here as it has more layout logic. Use Window instead.
  719. d = new ();
  720. d.DrawingContent += (s, a) => count++;
  721. Application.Run (d);
  722. }
  723. else if (iteration < 3)
  724. {
  725. Application.RaiseMouseEvent (new () { Flags = MouseFlags.ReportMousePosition });
  726. Assert.False (top.NeedsDraw);
  727. Assert.False (top.SubViewNeedsDraw);
  728. Assert.False (top.NeedsLayout);
  729. Assert.False (d.NeedsDraw);
  730. Assert.False (d.SubViewNeedsDraw);
  731. Assert.False (d.NeedsLayout);
  732. }
  733. else
  734. {
  735. Application.RequestStop ();
  736. }
  737. };
  738. Application.Run (top);
  739. top.Dispose ();
  740. Application.Shutdown ();
  741. // 1 - First top load, 1 - Dialog load, 1 - Dialog unload, Total - 3.
  742. Assert.Equal (3, count);
  743. }
  744. // TODO: All Toplevel layout tests should be moved to ToplevelTests.cs
  745. [Fact]
  746. public void Run_A_Modal_Toplevel_Refresh_Background_On_Moving ()
  747. {
  748. Init ();
  749. // Don't use Dialog here as it has more layout logic. Use Window instead.
  750. var w = new Window
  751. {
  752. Width = 5, Height = 5,
  753. Arrangement = ViewArrangement.Movable
  754. };
  755. ((FakeDriver)Application.Driver!).SetBufferSize (10, 10);
  756. RunState rs = Application.Begin (w);
  757. // Don't use visuals to test as style of border can change over time.
  758. Assert.Equal (new (0, 0), w.Frame.Location);
  759. Application.RaiseMouseEvent (new () { Flags = MouseFlags.Button1Pressed });
  760. Assert.Equal (w.Border, Application.MouseGrabView);
  761. Assert.Equal (new (0, 0), w.Frame.Location);
  762. // Move down and to the right.
  763. Application.RaiseMouseEvent (new () { ScreenPosition = new (1, 1), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition });
  764. Assert.Equal (new (1, 1), w.Frame.Location);
  765. Application.End (rs);
  766. w.Dispose ();
  767. Application.Shutdown ();
  768. }
  769. [Fact]
  770. public void End_Does_Not_Dispose ()
  771. {
  772. Init ();
  773. var top = new Toplevel ();
  774. Window w = new ();
  775. w.Ready += (s, e) => Application.RequestStop (); // Causes `End` to be called
  776. Application.Run (w);
  777. #if DEBUG_IDISPOSABLE
  778. Assert.False (w.WasDisposed);
  779. #endif
  780. Assert.NotNull (w);
  781. Assert.Equal (string.Empty, w.Title); // Valid - w has not been disposed. The user may want to run it again
  782. Assert.NotNull (Application.Top);
  783. Assert.Equal (w, Application.Top);
  784. Assert.NotEqual (top, Application.Top);
  785. Application.Run (w); // Valid - w has not been disposed.
  786. #if DEBUG_IDISPOSABLE
  787. Assert.False (w.WasDisposed);
  788. Exception exception = Record.Exception (Application.Shutdown); // Invalid - w has not been disposed.
  789. Assert.NotNull (exception);
  790. w.Dispose ();
  791. Assert.True (w.WasDisposed);
  792. //exception = Record.Exception (
  793. // () => Application.Run (
  794. // w)); // Invalid - w has been disposed. Run it in debug mode will throw, otherwise the user may want to run it again
  795. //Assert.NotNull (exception);
  796. exception = Record.Exception (() => Assert.Equal (string.Empty, w.Title)); // Invalid - w has been disposed and cannot be accessed
  797. Assert.NotNull (exception);
  798. exception = Record.Exception (() => w.Title = "NewTitle"); // Invalid - w has been disposed and cannot be accessed
  799. Assert.NotNull (exception);
  800. #endif
  801. Application.Shutdown ();
  802. Assert.NotNull (w);
  803. Assert.NotNull (top);
  804. Assert.Null (Application.Top);
  805. }
  806. [Fact]
  807. public void Run_Creates_Top_Without_Init ()
  808. {
  809. var driver = new FakeDriver ();
  810. Assert.Null (Application.Top);
  811. Application.Iteration += (s, e) =>
  812. {
  813. Assert.NotNull (Application.Top);
  814. Application.RequestStop ();
  815. };
  816. Toplevel top = Application.Run (null, driver);
  817. #if DEBUG_IDISPOSABLE
  818. Assert.Equal (top, Application.Top);
  819. Assert.False (top.WasDisposed);
  820. Exception exception = Record.Exception (Application.Shutdown);
  821. Assert.NotNull (exception);
  822. Assert.False (top.WasDisposed);
  823. #endif
  824. // It's up to caller to dispose it
  825. top.Dispose ();
  826. #if DEBUG_IDISPOSABLE
  827. Assert.True (top.WasDisposed);
  828. #endif
  829. Assert.NotNull (Application.Top);
  830. Application.Shutdown ();
  831. Assert.Null (Application.Top);
  832. }
  833. [Fact]
  834. public void Run_T_Creates_Top_Without_Init ()
  835. {
  836. var driver = new FakeDriver ();
  837. Assert.Null (Application.Top);
  838. Application.Iteration += (s, e) =>
  839. {
  840. Assert.NotNull (Application.Top);
  841. Application.RequestStop ();
  842. };
  843. Application.Run<Toplevel> (null, driver);
  844. #if DEBUG_IDISPOSABLE
  845. Assert.False (Application.Top.WasDisposed);
  846. Exception exception = Record.Exception (Application.Shutdown);
  847. Assert.NotNull (exception);
  848. Assert.False (Application.Top.WasDisposed);
  849. // It's up to caller to dispose it
  850. Application.Top.Dispose ();
  851. Assert.True (Application.Top.WasDisposed);
  852. #endif
  853. Assert.NotNull (Application.Top);
  854. Application.Shutdown ();
  855. Assert.Null (Application.Top);
  856. }
  857. [Fact]
  858. public void Run_t_Does_Not_Creates_Top_Without_Init ()
  859. {
  860. // When a Toplevel is created it must already have all the Application configuration loaded
  861. // This is only possible by two ways:
  862. // 1 - Using Application.Init first
  863. // 2 - Using Application.Run() or Application.Run<T>()
  864. // The Application.Run(new(Toplevel)) must always call Application.Init() first because
  865. // the new(Toplevel) may be a derived class that is possible using Application static
  866. // properties that is only available after the Application.Init was called
  867. var driver = new FakeDriver ();
  868. Assert.Null (Application.Top);
  869. Assert.Throws<InvalidOperationException> (() => Application.Run (new Toplevel ()));
  870. Application.Init (driver);
  871. Application.Iteration += (s, e) =>
  872. {
  873. Assert.NotNull (Application.Top);
  874. Application.RequestStop ();
  875. };
  876. Application.Run (new Toplevel ());
  877. #if DEBUG_IDISPOSABLE
  878. Assert.False (Application.Top.WasDisposed);
  879. Exception exception = Record.Exception (Application.Shutdown);
  880. Assert.NotNull (exception);
  881. Assert.False (Application.Top.WasDisposed);
  882. // It's up to caller to dispose it
  883. Application.Top.Dispose ();
  884. Assert.True (Application.Top.WasDisposed);
  885. #endif
  886. Assert.NotNull (Application.Top);
  887. Application.Shutdown ();
  888. Assert.Null (Application.Top);
  889. }
  890. // TODO: Add tests for Run that test errorHandler
  891. #endregion
  892. #region ShutdownTests
  893. [Fact]
  894. public async void Shutdown_Allows_Async ()
  895. {
  896. var isCompletedSuccessfully = false;
  897. async Task TaskWithAsyncContinuation ()
  898. {
  899. await Task.Yield ();
  900. await Task.Yield ();
  901. isCompletedSuccessfully = true;
  902. }
  903. Init ();
  904. Application.Shutdown ();
  905. Assert.False (isCompletedSuccessfully);
  906. await TaskWithAsyncContinuation ();
  907. Thread.Sleep (100);
  908. Assert.True (isCompletedSuccessfully);
  909. }
  910. [Fact]
  911. public void Shutdown_Resets_SyncContext ()
  912. {
  913. Init ();
  914. Application.Shutdown ();
  915. Assert.Null (SynchronizationContext.Current);
  916. }
  917. #endregion
  918. }