gui-cs.Terminal.Gui/UnitTests/Views/OverlappedTests.cs

using System;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Terminal.Gui;
using Xunit;

// Alias Console to MockConsole so we don't accidentally use Console
using Console = Terminal.Gui.FakeConsole;

namespace Terminal.Gui.ViewsTests {
	public class OverlappedTests {
		public OverlappedTests ()
		{
#if DEBUG_IDISPOSABLE
			Responder.Instances.Clear ();
			RunState.Instances.Clear ();
#endif
		}

		[Fact, TestRespondersDisposed]
		public void Dispose_Toplevel_IsOverlappedContainer_False_With_Begin_End ()
		{
			Application.Init (new FakeDriver ());

			var top = new Toplevel ();
			var rs = Application.Begin (top);
#if DEBUG_IDISPOSABLE
			Assert.Equal (4, Responder.Instances.Count);
#endif

			Application.End (rs);
			Application.Shutdown ();

#if DEBUG_IDISPOSABLE
			Assert.Empty (Responder.Instances);
#endif
		}

		[Fact, TestRespondersDisposed]
		public void Dispose_Toplevel_IsOverlappedContainer_True_With_Begin ()
		{
			Application.Init (new FakeDriver ());

			var overlapped = new Toplevel { IsOverlappedContainer = true };
			var rs = Application.Begin (overlapped);
			Application.End (rs);

			Application.Shutdown ();
		}

		[Fact, AutoInitShutdown]
		public void Application_RequestStop_With_Params_On_A_Not_OverlappedContainer_Always_Use_Application_Current ()
		{
			var top1 = new Toplevel ();
			var top2 = new Toplevel ();
			var top3 = new Window ();
			var top4 = new Window ();
			var d = new Dialog ();

			// top1, top2, top3, d1 = 4
			var iterations = 4;

			top1.Ready += (s, e) => {
				Assert.Null (Application.OverlappedChildren);
				Application.Run (top2);
			};
			top2.Ready += (s, e) => {
				Assert.Null (Application.OverlappedChildren);
				Application.Run (top3);
			};
			top3.Ready += (s, e) => {
				Assert.Null (Application.OverlappedChildren);
				Application.Run (top4);
			};
			top4.Ready += (s, e) => {
				Assert.Null (Application.OverlappedChildren);
				Application.Run (d);
			};

			d.Ready += (s, e) => {
				Assert.Null (Application.OverlappedChildren);
				// This will close the d because on a not OverlappedContainer the Application.Current it always used.
				Application.RequestStop (top1);
				Assert.True (Application.Current == d);
			};

			d.Closed += (s, e) => Application.RequestStop (top1);

			Application.Iteration += (s, a) => {
				Assert.Null (Application.OverlappedChildren);
				if (iterations == 4) Assert.True (Application.Current == d);
				else if (iterations == 3) Assert.True (Application.Current == top4);
				else if (iterations == 2) Assert.True (Application.Current == top3);
				else if (iterations == 1) Assert.True (Application.Current == top2);
				else Assert.True (Application.Current == top1);
				Application.RequestStop (top1);
				iterations--;
			};

			Application.Run (top1);

			Assert.Null (Application.OverlappedChildren);
		}

		class Overlapped : Toplevel {
			public Overlapped ()
			{
				IsOverlappedContainer = true;
			}
		}

		[Fact]
		[AutoInitShutdown]
		public void OverlappedContainer_With_Toplevel_RequestStop_Balanced ()
		{
			var overlapped = new Overlapped ();
			var c1 = new Toplevel ();
			var c2 = new Window ();
			var c3 = new Window ();
			var d = new Dialog ();

			// OverlappedChild = c1, c2, c3
			// d1 = 1
			var iterations = 4;

			overlapped.Ready += (s, e) => {
				Assert.Empty (Application.OverlappedChildren);
				Application.Run (c1);
			};
			c1.Ready += (s, e) => {
				Assert.Single (Application.OverlappedChildren);
				Application.Run (c2);
			};
			c2.Ready += (s, e) => {
				Assert.Equal (2, Application.OverlappedChildren.Count);
				Application.Run (c3);
			};
			c3.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				Application.Run (d);
			};

			// More easy because the Overlapped Container handles all at once
			d.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				// This will not close the OverlappedContainer because d is a modal Toplevel and will be closed.
				overlapped.RequestStop ();
			};

			// Now this will close the OverlappedContainer propagating through the OverlappedChildren.
			d.Closed += (s, e) => {
				overlapped.RequestStop ();
			};

			Application.Iteration += (s, a) => {
				if (iterations == 4) {
					// The Dialog was not closed before and will be closed now.
					Assert.True (Application.Current == d);
					Assert.False (d.Running);
				} else {
					Assert.Equal (iterations, Application.OverlappedChildren.Count);
					for (int i = 0; i < iterations; i++) Assert.Equal ((iterations - i + 1).ToString (), Application.OverlappedChildren [i].Id);
				}
				iterations--;
			};

			Application.Run (overlapped);

			Assert.Empty (Application.OverlappedChildren);
		}

		[Fact]
		[AutoInitShutdown]
		public void OverlappedContainer_With_Application_RequestStop_OverlappedTop_With_Params ()
		{
			var overlapped = new Overlapped ();
			var c1 = new Toplevel ();
			var c2 = new Window ();
			var c3 = new Window ();
			var d = new Dialog ();

			// OverlappedChild = c1, c2, c3
			// d1 = 1
			var iterations = 4;

			overlapped.Ready += (s, e) => {
				Assert.Empty (Application.OverlappedChildren);
				Application.Run (c1);
			};
			c1.Ready += (s, e) => {
				Assert.Single (Application.OverlappedChildren);
				Application.Run (c2);
			};
			c2.Ready += (s, e) => {
				Assert.Equal (2, Application.OverlappedChildren.Count);
				Application.Run (c3);
			};
			c3.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				Application.Run (d);
			};

			// Also easy because the Overlapped Container handles all at once
			d.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				// This will not close the OverlappedContainer because d is a modal Toplevel
				Application.RequestStop (overlapped);
			};

			// Now this will close the OverlappedContainer propagating through the OverlappedChildren.
			d.Closed += (s, e) => Application.RequestStop (overlapped);

			Application.Iteration += (s, a) => {
				if (iterations == 4) {
					// The Dialog was not closed before and will be closed now.
					Assert.True (Application.Current == d);
					Assert.False (d.Running);
				} else {
					Assert.Equal (iterations, Application.OverlappedChildren.Count);
					for (int i = 0; i < iterations; i++) Assert.Equal ((iterations - i + 1).ToString (), Application.OverlappedChildren [i].Id);
				}
				iterations--;
			};

			Application.Run (overlapped);

			Assert.Empty (Application.OverlappedChildren);
		}

		[Fact]
		[AutoInitShutdown]
		public void OverlappedContainer_With_Application_RequestStop_OverlappedTop_Without_Params ()
		{
			var overlapped = new Overlapped ();
			var c1 = new Toplevel ();
			var c2 = new Window ();
			var c3 = new Window ();
			var d = new Dialog ();

			// OverlappedChild = c1, c2, c3 = 3
			// d1 = 1
			var iterations = 4;

			overlapped.Ready += (s, e) => {
				Assert.Empty (Application.OverlappedChildren);
				Application.Run (c1);
			};
			c1.Ready += (s, e) => {
				Assert.Single (Application.OverlappedChildren);
				Application.Run (c2);
			};
			c2.Ready += (s, e) => {
				Assert.Equal (2, Application.OverlappedChildren.Count);
				Application.Run (c3);
			};
			c3.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				Application.Run (d);
			};

			//More harder because it's sequential.
			d.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				// Close the Dialog
				Application.RequestStop ();
			};

			// Now this will close the OverlappedContainer propagating through the OverlappedChildren.
			d.Closed += (s, e) => Application.RequestStop (overlapped);

			Application.Iteration += (s, a) => {
				if (iterations == 4) {
					// The Dialog still is the current top and we can't request stop to OverlappedContainer
					// because we are not using parameter calls.
					Assert.True (Application.Current == d);
					Assert.False (d.Running);
				} else {
					Assert.Equal (iterations, Application.OverlappedChildren.Count);
					for (int i = 0; i < iterations; i++) Assert.Equal ((iterations - i + 1).ToString (), Application.OverlappedChildren [i].Id);
				}
				iterations--;
			};

			Application.Run (overlapped);

			Assert.Empty (Application.OverlappedChildren);
		}

		[Fact]
		[AutoInitShutdown]
		public void IsOverlappedChild_Testing ()
		{
			var overlapped = new Overlapped ();
			var c1 = new Toplevel ();
			var c2 = new Window ();
			var c3 = new Window ();
			var d = new Dialog ();

			Application.Iteration += (s, a) => {
				Assert.False (overlapped.IsOverlapped);
				Assert.True (c1.IsOverlapped);
				Assert.True (c2.IsOverlapped);
				Assert.True (c3.IsOverlapped);
				Assert.False (d.IsOverlapped);

				overlapped.RequestStop ();
			};

			Application.Run (overlapped);
		}

		[Fact]
		[AutoInitShutdown]
		public void Modal_Toplevel_Can_Open_Another_Modal_Toplevel_But_RequestStop_To_The_Caller_Also_Sets_Current_Running_To_False_Too ()
		{
			var overlapped = new Overlapped ();
			var c1 = new Toplevel ();
			var c2 = new Window ();
			var c3 = new Window ();
			var d1 = new Dialog ();
			var d2 = new Dialog ();

			// OverlappedChild = c1, c2, c3 = 3
			// d1, d2 = 2
			var iterations = 5;

			overlapped.Ready += (s, e) => {
				Assert.Empty (Application.OverlappedChildren);
				Application.Run (c1);
			};
			c1.Ready += (s, e) => {
				Assert.Single (Application.OverlappedChildren);
				Application.Run (c2);
			};
			c2.Ready += (s, e) => {
				Assert.Equal (2, Application.OverlappedChildren.Count);
				Application.Run (c3);
			};
			c3.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				Application.Run (d1);
			};
			d1.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				Application.Run (d2);
			};

			d2.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				Assert.True (Application.Current == d2);
				Assert.True (Application.Current.Running);
				// Trying to close the Dialog1
				d1.RequestStop ();
			};

			// Now this will close the OverlappedContainer propagating through the OverlappedChildren.
			d1.Closed += (s, e) => {
				Assert.True (Application.Current == d1);
				Assert.False (Application.Current.Running);
				overlapped.RequestStop ();
			};

			Application.Iteration += (s, a) => {
				if (iterations == 5) {
					// The Dialog2 still is the current top and we can't request stop to OverlappedContainer
					// because Dialog2 and Dialog1 must be closed first.
					// Dialog2 will be closed in this iteration.
					Assert.True (Application.Current == d2);
					Assert.False (Application.Current.Running);
					Assert.False (d1.Running);
				} else if (iterations == 4) {
					// Dialog1 will be closed in this iteration.
					Assert.True (Application.Current == d1);
					Assert.False (Application.Current.Running);
				} else {
					Assert.Equal (iterations, Application.OverlappedChildren.Count);
					for (int i = 0; i < iterations; i++) Assert.Equal ((iterations - i + 1).ToString (), Application.OverlappedChildren [i].Id);
				}
				iterations--;
			};

			Application.Run (overlapped);

			Assert.Empty (Application.OverlappedChildren);
		}

		[Fact]
		[AutoInitShutdown]
		public void Modal_Toplevel_Can_Open_Another_Not_Modal_Toplevel_But_RequestStop_To_The_Caller_Also_Sets_Current_Running_To_False_Too ()
		{
			var overlapped = new Overlapped ();
			var c1 = new Toplevel ();
			var c2 = new Window ();
			var c3 = new Window ();
			var d1 = new Dialog ();
			var c4 = new Toplevel ();

			// OverlappedChild = c1, c2, c3, c4 = 4
			// d1 = 1
			var iterations = 5;

			overlapped.Ready += (s, e) => {
				Assert.Empty (Application.OverlappedChildren);
				Application.Run (c1);
			};
			c1.Ready += (s, e) => {
				Assert.Single (Application.OverlappedChildren);
				Application.Run (c2);
			};
			c2.Ready += (s, e) => {
				Assert.Equal (2, Application.OverlappedChildren.Count);
				Application.Run (c3);
			};
			c3.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				Application.Run (d1);
			};
			d1.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				Application.Run (c4);
			};

			c4.Ready += (s, e) => {
				Assert.Equal (4, Application.OverlappedChildren.Count);
				// Trying to close the Dialog1
				d1.RequestStop ();
			};

			// Now this will close the OverlappedContainer propagating through the OverlappedChildren.
			d1.Closed += (s, e) => {
				overlapped.RequestStop ();
			};

			Application.Iteration += (s, a) => {
				if (iterations == 5) {
					// The Dialog2 still is the current top and we can't request stop to OverlappedContainer
					// because Dialog2 and Dialog1 must be closed first.
					// Using request stop here will call the Dialog again without need
					Assert.True (Application.Current == d1);
					Assert.False (Application.Current.Running);
					Assert.True (c4.Running);
				} else {
					Assert.Equal (iterations, Application.OverlappedChildren.Count);
					for (int i = 0; i < iterations; i++) Assert.Equal ((iterations - i + (iterations == 4 && i == 0 ? 2 : 1)).ToString (),
							Application.OverlappedChildren [i].Id);
				}
				iterations--;
			};

			Application.Run (overlapped);

			Assert.Empty (Application.OverlappedChildren);
		}

		[Fact]
		[AutoInitShutdown]
		public void MoveCurrent_Returns_False_If_The_Current_And_Top_Parameter_Are_Both_With_Running_Set_To_False ()
		{
			var overlapped = new Overlapped ();
			var c1 = new Toplevel ();
			var c2 = new Window ();
			var c3 = new Window ();

			// OverlappedChild = c1, c2, c3
			var iterations = 3;

			overlapped.Ready += (s, e) => {
				Assert.Empty (Application.OverlappedChildren);
				Application.Run (c1);
			};
			c1.Ready += (s, e) => {
				Assert.Single (Application.OverlappedChildren);
				Application.Run (c2);
			};
			c2.Ready += (s, e) => {
				Assert.Equal (2, Application.OverlappedChildren.Count);
				Application.Run (c3);
			};
			c3.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				c3.RequestStop ();
				c1.RequestStop ();
			};
			// Now this will close the OverlappedContainer propagating through the OverlappedChildren.
			c1.Closed += (s, e) => {
				overlapped.RequestStop ();
			};
			Application.Iteration += (s, a) => {
				if (iterations == 3) {
					// The Current still is c3 because Current.Running is false.
					Assert.True (Application.Current == c3);
					Assert.False (Application.Current.Running);
					// But the Children order were reorder by Running = false
					Assert.True (Application.OverlappedChildren [0] == c3);
					Assert.True (Application.OverlappedChildren [1] == c1);
					Assert.True (Application.OverlappedChildren [^1] == c2);
				} else if (iterations == 2) {
					// The Current is c1 and Current.Running is false.
					Assert.True (Application.Current == c1);
					Assert.False (Application.Current.Running);
					Assert.True (Application.OverlappedChildren [0] == c1);
					Assert.True (Application.OverlappedChildren [^1] == c2);
				} else if (iterations == 1) {
					// The Current is c2 and Current.Running is false.
					Assert.True (Application.Current == c2);
					Assert.False (Application.Current.Running);
					Assert.True (Application.OverlappedChildren [^1] == c2);
				} else {
					// The Current is overlapped.
					Assert.True (Application.Current == overlapped);
					Assert.Empty (Application.OverlappedChildren);
				}
				iterations--;
			};

			Application.Run (overlapped);

			Assert.Empty (Application.OverlappedChildren);
		}

		[Fact]
		[AutoInitShutdown]
		public void OverlappedContainer_Throws_If_More_Than_One ()
		{
			var overlapped = new Overlapped ();
			var overlapped2 = new Overlapped ();

			overlapped.Ready += (s, e) => {
				Assert.Throws<InvalidOperationException> (() => Application.Run (overlapped2));
				overlapped.RequestStop ();
			};

			Application.Run (overlapped);
		}

		[Fact]
		[AutoInitShutdown]
		public void OverlappedContainer_Open_And_Close_Modal_And_Open_Not_Modal_Toplevels_Randomly ()
		{
			var overlapped = new Overlapped ();
			var logger = new Toplevel ();

			var iterations = 1; // The logger
			var running = true;
			var stageCompleted = true;
			var allStageClosed = false;
			var overlappedRequestStop = false;

			overlapped.Ready += (s, e) => {
				Assert.Empty (Application.OverlappedChildren);
				Application.Run (logger);
			};

			logger.Ready += (s, e) => Assert.Single (Application.OverlappedChildren);

			Application.Iteration += (s, a) => {
				if (stageCompleted && running) {
					stageCompleted = false;
					var stage = new Window () { Modal = true };

					stage.Ready += (s, e) => {
						Assert.Equal (iterations, Application.OverlappedChildren.Count);
						stage.RequestStop ();
					};

					stage.Closed += (_, _) => {
						if (iterations == 11) allStageClosed = true;
						Assert.Equal (iterations, Application.OverlappedChildren.Count);
						if (running) {
							stageCompleted = true;

							var rpt = new Window ();

							rpt.Ready += (s, e) => {
								iterations++;
								Assert.Equal (iterations, Application.OverlappedChildren.Count);
							};

							Application.Run (rpt);
						}
					};

					Application.Run (stage);

				} else if (iterations == 11 && running) {
					running = false;
					Assert.Equal (iterations, Application.OverlappedChildren.Count);

				} else if (!overlappedRequestStop && running && !allStageClosed) Assert.Equal (iterations, Application.OverlappedChildren.Count);
				else if (!overlappedRequestStop && !running && allStageClosed) {
					Assert.Equal (iterations, Application.OverlappedChildren.Count);
					overlappedRequestStop = true;
					overlapped.RequestStop ();
				} else Assert.Empty (Application.OverlappedChildren);
			};

			Application.Run (overlapped);

			Assert.Empty (Application.OverlappedChildren);
		}

		[Fact]
		[AutoInitShutdown]
		public void AllChildClosed_Event_Test ()
		{
			var overlapped = new Overlapped ();
			var c1 = new Toplevel ();
			var c2 = new Window ();
			var c3 = new Window ();

			// OverlappedChild = c1, c2, c3
			var iterations = 3;

			overlapped.Ready += (s, e) => {
				Assert.Empty (Application.OverlappedChildren);
				Application.Run (c1);
			};
			c1.Ready += (s, e) => {
				Assert.Single (Application.OverlappedChildren);
				Application.Run (c2);
			};
			c2.Ready += (s, e) => {
				Assert.Equal (2, Application.OverlappedChildren.Count);
				Application.Run (c3);
			};
			c3.Ready += (s, e) => {
				Assert.Equal (3, Application.OverlappedChildren.Count);
				c3.RequestStop ();
				c2.RequestStop ();
				c1.RequestStop ();
			};
			// Now this will close the OverlappedContainer when all OverlappedChildren was closed
			overlapped.AllChildClosed += (s, e) => {
				overlapped.RequestStop ();
			};
			Application.Iteration += (s, a) => {
				if (iterations == 3) {
					// The Current still is c3 because Current.Running is false.
					Assert.True (Application.Current == c3);
					Assert.False (Application.Current.Running);
					// But the Children order were reorder by Running = false
					Assert.True (Application.OverlappedChildren [0] == c3);
					Assert.True (Application.OverlappedChildren [1] == c2);
					Assert.True (Application.OverlappedChildren [^1] == c1);
				} else if (iterations == 2) {
					// The Current is c2 and Current.Running is false.
					Assert.True (Application.Current == c2);
					Assert.False (Application.Current.Running);
					Assert.True (Application.OverlappedChildren [0] == c2);
					Assert.True (Application.OverlappedChildren [^1] == c1);
				} else if (iterations == 1) {
					// The Current is c1 and Current.Running is false.
					Assert.True (Application.Current == c1);
					Assert.False (Application.Current.Running);
					Assert.True (Application.OverlappedChildren [^1] == c1);
				} else {
					// The Current is overlapped.
					Assert.True (Application.Current == overlapped);
					Assert.False (Application.Current.Running);
					Assert.Empty (Application.OverlappedChildren);
				}
				iterations--;
			};

			Application.Run (overlapped);

			Assert.Empty (Application.OverlappedChildren);
		}

		[Fact]
		public void MoveToOverlappedChild_Throw_NullReferenceException_Passing_Null_Parameter ()
		{
			Assert.Throws<NullReferenceException> (delegate { Application.MoveToOverlappedChild (null); });
		}
	}
}