ApplicationTests.cs 35 KB

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