ApplicationTests.cs 40 KB

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