ApplicationTests.cs 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223
  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 InitWithoutTopLevelFactory_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. [AutoInitShutdown]
  406. public void Internal_Properties_Correct ()
  407. {
  408. Assert.True (Application.IsInitialized);
  409. Assert.Null (Application.Top);
  410. RunState rs = Application.Begin (new ());
  411. Assert.Equal (Application.Top, rs.Toplevel);
  412. Assert.Null (Application.MouseGrabView); // public
  413. Assert.Null (Application.WantContinuousButtonPressedView); // public
  414. Assert.False (ApplicationOverlapped.MoveToOverlappedChild (Application.Top!));
  415. Application.Top.Dispose ();
  416. }
  417. // Invoke Tests
  418. // TODO: Test with threading scenarios
  419. [Fact]
  420. public void Invoke_Adds_Idle ()
  421. {
  422. Application.Init (new FakeDriver ());
  423. var top = new Toplevel ();
  424. RunState rs = Application.Begin (top);
  425. var firstIteration = false;
  426. var actionCalled = 0;
  427. Application.Invoke (() => { actionCalled++; });
  428. Application.MainLoop.Running = true;
  429. Application.RunIteration (ref rs, ref firstIteration);
  430. Assert.Equal (1, actionCalled);
  431. top.Dispose ();
  432. Application.Shutdown ();
  433. }
  434. [Fact]
  435. public void Run_Iteration_Fires ()
  436. {
  437. var iteration = 0;
  438. Application.Init (new FakeDriver ());
  439. Application.Iteration += Application_Iteration;
  440. Application.Run<Toplevel> ().Dispose ();
  441. Assert.Equal (1, iteration);
  442. Application.Shutdown ();
  443. return;
  444. void Application_Iteration (object sender, IterationEventArgs e)
  445. {
  446. if (iteration > 0)
  447. {
  448. Assert.Fail ();
  449. }
  450. iteration++;
  451. Application.RequestStop ();
  452. }
  453. }
  454. [Fact]
  455. [AutoInitShutdown]
  456. public void SetCurrentAsTop_Run_A_Not_Modal_Toplevel_Make_It_The_Current_Application_Top ()
  457. {
  458. var top = new Toplevel ();
  459. var t1 = new Toplevel ();
  460. var t2 = new Toplevel ();
  461. var t3 = new Toplevel ();
  462. // Don't use Dialog here as it has more layout logic. Use Window instead.
  463. var d = new Dialog ();
  464. var t4 = new Toplevel ();
  465. // t1, t2, t3, d, t4
  466. var iterations = 5;
  467. t1.Ready += (s, e) =>
  468. {
  469. Assert.Equal (t1, Application.Top);
  470. Application.Run (t2);
  471. };
  472. t2.Ready += (s, e) =>
  473. {
  474. Assert.Equal (t2, Application.Top);
  475. Application.Run (t3);
  476. };
  477. t3.Ready += (s, e) =>
  478. {
  479. Assert.Equal (t3, Application.Top);
  480. Application.Run (d);
  481. };
  482. d.Ready += (s, e) =>
  483. {
  484. Assert.Equal (t3, Application.Top);
  485. Application.Run (t4);
  486. };
  487. t4.Ready += (s, e) =>
  488. {
  489. Assert.Equal (t4, Application.Top);
  490. t4.RequestStop ();
  491. d.RequestStop ();
  492. t3.RequestStop ();
  493. t2.RequestStop ();
  494. };
  495. // Now this will close the OverlappedContainer when all OverlappedChildren was closed
  496. t2.Closed += (s, _) => { t1.RequestStop (); };
  497. Application.Iteration += (s, a) =>
  498. {
  499. if (iterations == 5)
  500. {
  501. // The Current still is t4 because Current.Running is false.
  502. Assert.Equal (t4, Application.Current);
  503. Assert.False (Application.Current.Running);
  504. Assert.Equal (t4, Application.Top);
  505. }
  506. else if (iterations == 4)
  507. {
  508. // The Current is d and Current.Running is false.
  509. Assert.Equal (d, Application.Current);
  510. Assert.False (Application.Current.Running);
  511. Assert.Equal (t4, Application.Top);
  512. }
  513. else if (iterations == 3)
  514. {
  515. // The Current is t3 and Current.Running is false.
  516. Assert.Equal (t3, Application.Current);
  517. Assert.False (Application.Current.Running);
  518. Assert.Equal (t3, Application.Top);
  519. }
  520. else if (iterations == 2)
  521. {
  522. // The Current is t2 and Current.Running is false.
  523. Assert.Equal (t2, Application.Current);
  524. Assert.False (Application.Current.Running);
  525. Assert.Equal (t2, Application.Top);
  526. }
  527. else
  528. {
  529. // The Current is t1.
  530. Assert.Equal (t1, Application.Current);
  531. Assert.False (Application.Current.Running);
  532. Assert.Equal (t1, Application.Top);
  533. }
  534. iterations--;
  535. };
  536. Application.Run (t1);
  537. Assert.Equal (t1, Application.Top);
  538. // top wasn't run and so never was added to toplevel's stack
  539. Assert.NotEqual (top, Application.Top);
  540. #if DEBUG_IDISPOSABLE
  541. Assert.False (Application.Top.WasDisposed);
  542. t1.Dispose ();
  543. Assert.True (Application.Top.WasDisposed);
  544. #endif
  545. }
  546. private void Init ()
  547. {
  548. Application.Init (new FakeDriver ());
  549. Assert.NotNull (Application.Driver);
  550. Assert.NotNull (Application.MainLoop);
  551. Assert.NotNull (SynchronizationContext.Current);
  552. }
  553. private void Post_Init_State ()
  554. {
  555. Assert.NotNull (Application.Driver);
  556. Assert.NotNull (Application.Top);
  557. Assert.NotNull (Application.Current);
  558. Assert.NotNull (Application.MainLoop);
  559. // FakeDriver is always 80x25
  560. Assert.Equal (80, Application.Driver!.Cols);
  561. Assert.Equal (25, Application.Driver!.Rows);
  562. }
  563. private void Pre_Init_State ()
  564. {
  565. Assert.Null (Application.Driver);
  566. Assert.Null (Application.Top);
  567. Assert.Null (Application.Current);
  568. Assert.Null (Application.MainLoop);
  569. }
  570. private void Shutdown () { Application.Shutdown (); }
  571. private class TestToplevel : Toplevel
  572. {
  573. public TestToplevel () { IsOverlappedContainer = false; }
  574. }
  575. #region RunTests
  576. [Fact]
  577. public void Run_T_After_InitWithDriver_with_TopLevel_Does_Not_Throws ()
  578. {
  579. // Setup Mock driver
  580. Init ();
  581. Application.Iteration += (s, e) => Application.RequestStop ();
  582. // Run<Toplevel> when already initialized or not with a Driver will not throw (because Window is derived from Toplevel)
  583. // Using another type not derived from Toplevel will throws at compile time
  584. Application.Run<Window> ();
  585. Assert.True (Application.Top is Window);
  586. Application.Top.Dispose ();
  587. Shutdown ();
  588. Assert.Null (Application.Top);
  589. Assert.Null (Application.MainLoop);
  590. Assert.Null (Application.Driver);
  591. }
  592. [Fact]
  593. public void Run_T_After_InitWithDriver_with_TopLevel_and_Driver_Does_Not_Throws ()
  594. {
  595. // Setup Mock driver
  596. Init ();
  597. Application.Iteration += (s, e) => Application.RequestStop ();
  598. // Run<Toplevel> when already initialized or not with a Driver will not throw (because Window is derived from Toplevel)
  599. // Using another type not derived from Toplevel will throws at compile time
  600. Application.Run<Window> (null, new FakeDriver ());
  601. Assert.True (Application.Top is Window);
  602. Application.Top.Dispose ();
  603. // Run<Toplevel> when already initialized or not with a Driver will not throw (because Dialog is derived from Toplevel)
  604. Application.Run<Dialog> (null, new FakeDriver ());
  605. Assert.True (Application.Top is Dialog);
  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_After_Init_Does_Not_Disposes_Application_Top ()
  615. {
  616. Init ();
  617. // Init doesn't create a Toplevel and assigned it to Application.Top
  618. // but Begin does
  619. var initTop = new Toplevel ();
  620. Application.Iteration += (s, a) =>
  621. {
  622. Assert.NotEqual (initTop, Application.Top);
  623. #if DEBUG_IDISPOSABLE
  624. Assert.False (initTop.WasDisposed);
  625. #endif
  626. Application.RequestStop ();
  627. };
  628. Application.Run<TestToplevel> ();
  629. #if DEBUG_IDISPOSABLE
  630. Assert.False (initTop.WasDisposed);
  631. initTop.Dispose ();
  632. Assert.True (initTop.WasDisposed);
  633. #endif
  634. Application.Top.Dispose ();
  635. Shutdown ();
  636. Assert.Null (Application.Top);
  637. Assert.Null (Application.MainLoop);
  638. Assert.Null (Application.Driver);
  639. }
  640. [Fact]
  641. [TestRespondersDisposed]
  642. public void Run_T_After_InitWithDriver_with_TestTopLevel_DoesNotThrow ()
  643. {
  644. // Setup Mock driver
  645. Init ();
  646. Application.Iteration += (s, a) => { Application.RequestStop (); };
  647. // Init has been called and we're passing no driver to Run<TestTopLevel>. This is ok.
  648. Application.Run<TestToplevel> ();
  649. Application.Top.Dispose ();
  650. Shutdown ();
  651. Assert.Null (Application.Top);
  652. Assert.Null (Application.MainLoop);
  653. Assert.Null (Application.Driver);
  654. }
  655. [Fact]
  656. [TestRespondersDisposed]
  657. public void Run_T_After_InitNullDriver_with_TestTopLevel_DoesNotThrow ()
  658. {
  659. Application.ForceDriver = "FakeDriver";
  660. Application.Init ();
  661. Assert.Equal (typeof (FakeDriver), Application.Driver?.GetType ());
  662. Application.Iteration += (s, a) => { Application.RequestStop (); };
  663. // Init has been called, selecting FakeDriver; we're passing no driver to Run<TestTopLevel>. Should be fine.
  664. Application.Run<TestToplevel> ();
  665. Application.Top.Dispose ();
  666. Shutdown ();
  667. Assert.Null (Application.Top);
  668. Assert.Null (Application.MainLoop);
  669. Assert.Null (Application.Driver);
  670. }
  671. [Fact]
  672. [TestRespondersDisposed]
  673. public void Run_T_Init_Driver_Cleared_with_TestTopLevel_Throws ()
  674. {
  675. Init ();
  676. Application.Driver = null;
  677. // Init has been called, but Driver has been set to null. Bad.
  678. Assert.Throws<InvalidOperationException> (() => Application.Run<TestToplevel> ());
  679. Shutdown ();
  680. Assert.Null (Application.Top);
  681. Assert.Null (Application.MainLoop);
  682. Assert.Null (Application.Driver);
  683. }
  684. [Fact]
  685. [TestRespondersDisposed]
  686. public void Run_T_NoInit_DoesNotThrow ()
  687. {
  688. Application.ForceDriver = "FakeDriver";
  689. Application.Iteration += (s, a) => { Application.RequestStop (); };
  690. Application.Run<TestToplevel> ();
  691. Assert.Equal (typeof (FakeDriver), Application.Driver?.GetType ());
  692. Application.Top.Dispose ();
  693. Shutdown ();
  694. Assert.Null (Application.Top);
  695. Assert.Null (Application.MainLoop);
  696. Assert.Null (Application.Driver);
  697. }
  698. [Fact]
  699. [TestRespondersDisposed]
  700. public void Run_T_NoInit_WithDriver_DoesNotThrow ()
  701. {
  702. Application.Iteration += (s, a) => { Application.RequestStop (); };
  703. // Init has NOT been called and we're passing a valid driver to Run<TestTopLevel>. This is ok.
  704. Application.Run<TestToplevel> (null, new FakeDriver ());
  705. Application.Top.Dispose ();
  706. Shutdown ();
  707. Assert.Null (Application.Top);
  708. Assert.Null (Application.MainLoop);
  709. Assert.Null (Application.Driver);
  710. }
  711. [Fact]
  712. [TestRespondersDisposed]
  713. public void Run_RequestStop_Stops ()
  714. {
  715. // Setup Mock driver
  716. Init ();
  717. var top = new Toplevel ();
  718. RunState rs = Application.Begin (top);
  719. Assert.NotNull (rs);
  720. Assert.Equal (top, Application.Current);
  721. Application.Iteration += (s, a) => { Application.RequestStop (); };
  722. Application.Run (top);
  723. top.Dispose ();
  724. Application.Shutdown ();
  725. Assert.Null (Application.Current);
  726. Assert.Null (Application.Top);
  727. Assert.Null (Application.MainLoop);
  728. Assert.Null (Application.Driver);
  729. }
  730. [Fact]
  731. [TestRespondersDisposed]
  732. public void Run_RunningFalse_Stops ()
  733. {
  734. // Setup Mock driver
  735. Init ();
  736. var top = new Toplevel ();
  737. RunState rs = Application.Begin (top);
  738. Assert.NotNull (rs);
  739. Assert.Equal (top, Application.Current);
  740. Application.Iteration += (s, a) => { top.Running = false; };
  741. Application.Run (top);
  742. top.Dispose ();
  743. Application.Shutdown ();
  744. Assert.Null (Application.Current);
  745. Assert.Null (Application.Top);
  746. Assert.Null (Application.MainLoop);
  747. Assert.Null (Application.Driver);
  748. }
  749. [Fact]
  750. [TestRespondersDisposed]
  751. public void Run_Loaded_Ready_Unlodaded_Events ()
  752. {
  753. Init ();
  754. Toplevel top = new ();
  755. var count = 0;
  756. top.Loaded += (s, e) => count++;
  757. top.Ready += (s, e) => count++;
  758. top.Unloaded += (s, e) => count++;
  759. Application.Iteration += (s, a) => Application.RequestStop ();
  760. Application.Run (top);
  761. top.Dispose ();
  762. Application.Shutdown ();
  763. Assert.Equal (3, count);
  764. }
  765. // TODO: All Toplevel layout tests should be moved to ToplevelTests.cs
  766. [Fact (Skip = "#2491 - Changing focus should cause NeedsDispay = true, so bogus test?")]
  767. public void Run_Toplevel_With_Modal_View_Does_Not_Refresh_If_Not_Dirty ()
  768. {
  769. Init ();
  770. var count = 0;
  771. // Don't use Dialog here as it has more layout logic. Use Window instead.
  772. Dialog d = null;
  773. Toplevel top = new ();
  774. top.DrawContent += (s, a) => count++;
  775. int iteration = -1;
  776. Application.Iteration += (s, a) =>
  777. {
  778. iteration++;
  779. if (iteration == 0)
  780. {
  781. // TODO: Don't use Dialog here as it has more layout logic. Use Window instead.
  782. d = new ();
  783. d.DrawContent += (s, a) => count++;
  784. Application.Run (d);
  785. }
  786. else if (iteration < 3)
  787. {
  788. Application.OnMouseEvent (new () { Flags = MouseFlags.ReportMousePosition });
  789. Assert.False (top.NeedsDisplay);
  790. Assert.False (top.SubViewNeedsDisplay);
  791. Assert.False (top.LayoutNeeded);
  792. Assert.False (d.NeedsDisplay);
  793. Assert.False (d.SubViewNeedsDisplay);
  794. Assert.False (d.LayoutNeeded);
  795. }
  796. else
  797. {
  798. Application.RequestStop ();
  799. }
  800. };
  801. Application.Run (top);
  802. top.Dispose ();
  803. Application.Shutdown ();
  804. // 1 - First top load, 1 - Dialog load, 1 - Dialog unload, Total - 3.
  805. Assert.Equal (3, count);
  806. }
  807. // TODO: All Toplevel layout tests should be moved to ToplevelTests.cs
  808. [Fact]
  809. public void Run_A_Modal_Toplevel_Refresh_Background_On_Moving ()
  810. {
  811. Init ();
  812. // Don't use Dialog here as it has more layout logic. Use Window instead.
  813. var w = new Window
  814. {
  815. Width = 5, Height = 5,
  816. Arrangement = ViewArrangement.Movable
  817. };
  818. ((FakeDriver)Application.Driver!).SetBufferSize (10, 10);
  819. RunState rs = Application.Begin (w);
  820. // Don't use visuals to test as style of border can change over time.
  821. Assert.Equal (new (0, 0), w.Frame.Location);
  822. Application.OnMouseEvent (new () { Flags = MouseFlags.Button1Pressed });
  823. Assert.Equal (w.Border, Application.MouseGrabView);
  824. Assert.Equal (new (0, 0), w.Frame.Location);
  825. // Move down and to the right.
  826. Application.OnMouseEvent (new () { Position = new (1, 1), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition });
  827. Assert.Equal (new (1, 1), w.Frame.Location);
  828. Application.End (rs);
  829. w.Dispose ();
  830. Application.Shutdown ();
  831. }
  832. [Fact]
  833. public void End_Does_Not_Dispose ()
  834. {
  835. Init ();
  836. var top = new Toplevel ();
  837. Window w = new ();
  838. w.Ready += (s, e) => Application.RequestStop (); // Causes `End` to be called
  839. Application.Run (w);
  840. #if DEBUG_IDISPOSABLE
  841. Assert.False (w.WasDisposed);
  842. #endif
  843. Assert.NotNull (w);
  844. Assert.Equal (string.Empty, w.Title); // Valid - w has not been disposed. The user may want to run it again
  845. Assert.NotNull (Application.Top);
  846. Assert.Equal (w, Application.Top);
  847. Assert.NotEqual (top, Application.Top);
  848. Assert.Null (Application.Current);
  849. Application.Run (w); // Valid - w has not been disposed.
  850. #if DEBUG_IDISPOSABLE
  851. Assert.False (w.WasDisposed);
  852. Exception exception = Record.Exception (Application.Shutdown); // Invalid - w has not been disposed.
  853. Assert.NotNull (exception);
  854. w.Dispose ();
  855. Assert.True (w.WasDisposed);
  856. exception = Record.Exception (
  857. () => Application.Run (
  858. w)); // Invalid - w has been disposed. Run it in debug mode will throw, otherwise the user may want to run it again
  859. Assert.NotNull (exception);
  860. exception = Record.Exception (() => Assert.Equal (string.Empty, w.Title)); // Invalid - w has been disposed and cannot be accessed
  861. Assert.NotNull (exception);
  862. exception = Record.Exception (() => w.Title = "NewTitle"); // Invalid - w has been disposed and cannot be accessed
  863. Assert.NotNull (exception);
  864. #endif
  865. Application.Shutdown ();
  866. Assert.NotNull (w);
  867. Assert.Null (Application.Current);
  868. Assert.NotNull (top);
  869. Assert.Null (Application.Top);
  870. }
  871. [Fact]
  872. public void Run_Creates_Top_Without_Init ()
  873. {
  874. var driver = new FakeDriver ();
  875. Assert.Null (Application.Top);
  876. Application.Iteration += (s, e) =>
  877. {
  878. Assert.NotNull (Application.Top);
  879. Application.RequestStop ();
  880. };
  881. Toplevel top = Application.Run (null, driver);
  882. #if DEBUG_IDISPOSABLE
  883. Assert.Equal (top, Application.Top);
  884. Assert.False (top.WasDisposed);
  885. Exception exception = Record.Exception (Application.Shutdown);
  886. Assert.NotNull (exception);
  887. Assert.False (top.WasDisposed);
  888. #endif
  889. // It's up to caller to dispose it
  890. top.Dispose ();
  891. #if DEBUG_IDISPOSABLE
  892. Assert.True (top.WasDisposed);
  893. #endif
  894. Assert.NotNull (Application.Top);
  895. Application.Shutdown ();
  896. Assert.Null (Application.Top);
  897. }
  898. [Fact]
  899. public void Run_T_Creates_Top_Without_Init ()
  900. {
  901. var driver = new FakeDriver ();
  902. Assert.Null (Application.Top);
  903. Application.Iteration += (s, e) =>
  904. {
  905. Assert.NotNull (Application.Top);
  906. Application.RequestStop ();
  907. };
  908. Application.Run<Toplevel> (null, driver);
  909. #if DEBUG_IDISPOSABLE
  910. Assert.False (Application.Top.WasDisposed);
  911. Exception exception = Record.Exception (Application.Shutdown);
  912. Assert.NotNull (exception);
  913. Assert.False (Application.Top.WasDisposed);
  914. // It's up to caller to dispose it
  915. Application.Top.Dispose ();
  916. Assert.True (Application.Top.WasDisposed);
  917. #endif
  918. Assert.NotNull (Application.Top);
  919. Application.Shutdown ();
  920. Assert.Null (Application.Top);
  921. }
  922. [Fact]
  923. public void Run_t_Does_Not_Creates_Top_Without_Init ()
  924. {
  925. // When a Toplevel is created it must already have all the Application configuration loaded
  926. // This is only possible by two ways:
  927. // 1 - Using Application.Init first
  928. // 2 - Using Application.Run() or Application.Run<T>()
  929. // The Application.Run(new(Toplevel)) must always call Application.Init() first because
  930. // the new(Toplevel) may be a derived class that is possible using Application static
  931. // properties that is only available after the Application.Init was called
  932. var driver = new FakeDriver ();
  933. Assert.Null (Application.Top);
  934. Assert.Throws<InvalidOperationException> (() => Application.Run (new Toplevel ()));
  935. Application.Init (driver);
  936. Application.Iteration += (s, e) =>
  937. {
  938. Assert.NotNull (Application.Top);
  939. Application.RequestStop ();
  940. };
  941. Application.Run (new Toplevel ());
  942. #if DEBUG_IDISPOSABLE
  943. Assert.False (Application.Top.WasDisposed);
  944. Exception exception = Record.Exception (Application.Shutdown);
  945. Assert.NotNull (exception);
  946. Assert.False (Application.Top.WasDisposed);
  947. // It's up to caller to dispose it
  948. Application.Top.Dispose ();
  949. Assert.True (Application.Top.WasDisposed);
  950. #endif
  951. Assert.NotNull (Application.Top);
  952. Application.Shutdown ();
  953. Assert.Null (Application.Top);
  954. }
  955. // TODO: Add tests for Run that test errorHandler
  956. #endregion
  957. #region ShutdownTests
  958. [Fact]
  959. public async void Shutdown_Allows_Async ()
  960. {
  961. var isCompletedSuccessfully = false;
  962. async Task TaskWithAsyncContinuation ()
  963. {
  964. await Task.Yield ();
  965. await Task.Yield ();
  966. isCompletedSuccessfully = true;
  967. }
  968. Init ();
  969. Application.Shutdown ();
  970. Assert.False (isCompletedSuccessfully);
  971. await TaskWithAsyncContinuation ();
  972. Thread.Sleep (100);
  973. Assert.True (isCompletedSuccessfully);
  974. }
  975. [Fact]
  976. public void Shutdown_Resets_SyncContext ()
  977. {
  978. Init ();
  979. Application.Shutdown ();
  980. Assert.Null (SynchronizationContext.Current);
  981. }
  982. #endregion
  983. }