gui-cs.Terminal.Gui/UnitTests/Application/RunStateTests.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.ApplicationTests {
	/// <summary>
	/// These tests focus on Application.RunState and the various ways it can be changed.
	/// </summary>
	public class RunStateTests {
		public RunStateTests ()
		{
#if DEBUG_IDISPOSABLE
			Responder.Instances.Clear ();
			Application.RunState.Instances.Clear ();
#endif
		}

		[Fact]
		public void New_Creates_RunState ()
		{
			var rs = new Application.RunState (null);
			Assert.Null (rs.Toplevel);

			var top = new Toplevel ();
			rs = new Application.RunState (top);
			Assert.Equal (top, rs.Toplevel);
		}

		[Fact]
		public void Dispose_Cleans_Up_RunState ()
		{
			var rs = new Application.RunState (null);
			Assert.NotNull (rs);

			// Should not throw because Toplevel was null
			rs.Dispose ();
#if DEBUG_IDISPOSABLE
			Assert.True (rs.WasDisposed);
#endif
			var top = new Toplevel ();
			rs = new Application.RunState (top);
			Assert.NotNull (rs);

			// Should not throw because Toplevel was cleaned up
			var exception = Record.Exception (() => rs.Dispose ());
			Assert.Null (exception);

			Assert.Null (rs.Toplevel);
#if DEBUG_IDISPOSABLE
			Assert.True (rs.WasDisposed);
			Assert.True (top.WasDisposed);
#endif
		}

		void Init ()
		{
			Application.Init (new FakeDriver ());

			Assert.NotNull (Application.Driver);
			Assert.NotNull (Application.MainLoop);
			Assert.NotNull (SynchronizationContext.Current);
		}

		void Shutdown ()
		{
			Application.Shutdown ();
#if DEBUG_IDISPOSABLE
			// Validate there are no outstanding RunState-based instances left
			foreach (var inst in Application.RunState.Instances) Assert.True (inst.WasDisposed);
#endif
		}

		[Fact]
		public void Begin_End_Cleans_Up_RunState ()
		{
			// Setup Mock driver
			Init ();

			// Test null Toplevel
			Assert.Throws<ArgumentNullException> (() => Application.Begin (null));

			var top = new Toplevel ();
			var rs = Application.Begin (top);
			Assert.NotNull (rs);
			Assert.Equal (top, Application.Current);
			Application.End (rs);

			Assert.Null (Application.Current);
			Assert.Null (Application.Top);
			Assert.NotNull (Application.MainLoop);
			Assert.NotNull (Application.Driver);

			Shutdown ();

#if DEBUG_IDISPOSABLE
			Assert.True (rs.WasDisposed);
#endif

			Assert.Null (Application.MainLoop);
			Assert.Null (Application.Driver);
		}

		WeakReference CreateToplevelInstance ()
		{
			// Setup Mock driver
			Init ();

			var top = new Toplevel ();
			var rs = Application.Begin (top);

			Assert.NotNull (rs);
			Assert.Equal (top, Application.Current);
			Assert.Equal (top, Application.Top);
			Application.End (rs);
#if DEBUG_IDISPOSABLE
			Assert.True (rs.WasDisposed);
			Assert.True (top.WasDisposed);
#endif
			Assert.Null (Application.Current);
			Assert.Null (Application.Top);
			Assert.NotNull (top);
			Assert.NotNull (Application.MainLoop);
			Assert.NotNull (Application.Driver);

			return new WeakReference (top, true);
		}

		[Fact]
		public void Begin_End_Cleans_Up_RunState_Without_Shutdown ()
		{
			WeakReference wrInstance = CreateToplevelInstance ();

			GC.Collect ();
			GC.WaitForPendingFinalizers ();
			Assert.False (wrInstance.IsAlive);

			// Shutdown Mock driver
			Shutdown ();
			Assert.Null (Application.MainLoop);
			Assert.Null (Application.Driver);
		}
	}
}