mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 07:47:54 +01:00
* Initial plan * Phase 1: Update IConsoleDriver.Init() to return void instead of MainLoop Co-authored-by: tig <585482+tig@users.noreply.github.com> * Phase 2: Remove legacy MainLoop infrastructure Co-authored-by: tig <585482+tig@users.noreply.github.com> * Complete Phase 1 and Phase 2 - All tests pass Co-authored-by: tig <585482+tig@users.noreply.github.com> * Update deep dive docs to reflect MainLoop removal Co-authored-by: tig <585482+tig@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: tig <585482+tig@users.noreply.github.com> Co-authored-by: Tig <tig@users.noreply.github.com>
This commit is contained in:
Copilot
GitHub
@@ -159,7 +159,6 @@ public class ApplicationTests
|
||||
Application.Shutdown ();
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -316,7 +315,6 @@ public class ApplicationTests
|
||||
// Don't check Application.Force16Colors
|
||||
//Assert.False (Application.Force16Colors);
|
||||
Assert.Null (Application.Driver);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.False (Application.EndAfterFirstIteration);
|
||||
|
||||
// Commented out because if CM changed the defaults, those changes should
|
||||
@@ -472,7 +470,6 @@ public class ApplicationTests
|
||||
Application.Shutdown ();
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -486,7 +483,6 @@ public class ApplicationTests
|
||||
Application.Shutdown ();
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -522,14 +518,12 @@ public class ApplicationTests
|
||||
Application.End (runstate);
|
||||
|
||||
Assert.NotNull (Application.Top);
|
||||
Assert.NotNull (Application.MainLoop);
|
||||
Assert.NotNull (Application.Driver);
|
||||
|
||||
topLevel.Dispose ();
|
||||
Application.Shutdown ();
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -676,7 +670,6 @@ public class ApplicationTests
|
||||
Application.Shutdown ();
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -700,7 +693,6 @@ public class ApplicationTests
|
||||
Application.Shutdown ();
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -734,7 +726,6 @@ public class ApplicationTests
|
||||
Application.Shutdown ();
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -752,7 +743,6 @@ public class ApplicationTests
|
||||
Application.Shutdown ();
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -774,7 +764,6 @@ public class ApplicationTests
|
||||
Application.Shutdown ();
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
|
||||
a.After (null);
|
||||
@@ -793,7 +782,6 @@ public class ApplicationTests
|
||||
Application.Shutdown ();
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -812,7 +800,6 @@ public class ApplicationTests
|
||||
Application.Shutdown ();
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -829,7 +816,6 @@ public class ApplicationTests
|
||||
Application.Shutdown ();
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -849,7 +835,6 @@ public class ApplicationTests
|
||||
top.Dispose ();
|
||||
Application.Shutdown ();
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -872,7 +857,6 @@ public class ApplicationTests
|
||||
top.Dispose ();
|
||||
Application.Shutdown ();
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
@@ -892,7 +876,6 @@ public class ApplicationTests
|
||||
top.Dispose ();
|
||||
Application.Shutdown ();
|
||||
Assert.Null (Application.Top);
|
||||
Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
|
||||
@@ -1,940 +0,0 @@
|
||||
using System.Diagnostics;
|
||||
using Xunit.Abstractions;
|
||||
|
||||
// Alias Console to MockConsole so we don't accidentally use Console
|
||||
|
||||
namespace UnitTests.ApplicationTests;
|
||||
|
||||
/// <summary>Tests MainLoop using the FakeMainLoop.</summary>
|
||||
public class MainLoopTests
|
||||
{
|
||||
private readonly ITestOutputHelper _output;
|
||||
|
||||
public MainLoopTests (ITestOutputHelper output)
|
||||
{
|
||||
_output = output;
|
||||
ConsoleDriver.RunningUnitTests = true;
|
||||
}
|
||||
|
||||
private static Button btn;
|
||||
private static string cancel;
|
||||
private static string clickMe;
|
||||
private static int four;
|
||||
private static int one;
|
||||
private static string pewPew;
|
||||
private static bool taskCompleted;
|
||||
|
||||
// TODO: EventsPending tests
|
||||
// - wait = true
|
||||
// - wait = false
|
||||
|
||||
// TODO: Add IMainLoop tests
|
||||
private static int three;
|
||||
private static int total;
|
||||
private static int two;
|
||||
private static int zero;
|
||||
|
||||
// See Also ConsoleDRivers/MainLoopDriverTests.cs for tests of the MainLoopDriver
|
||||
|
||||
// Idle Handler tests
|
||||
[Fact]
|
||||
public void AddTimeout_Adds_And_Removes ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
|
||||
Func<bool> fnTrue = () => true;
|
||||
Func<bool> fnFalse = () => false;
|
||||
|
||||
var a = ml.TimedEvents.Add (TimeSpan.Zero, fnTrue);
|
||||
var b = ml.TimedEvents.Add (TimeSpan.Zero, fnFalse);
|
||||
|
||||
Assert.Equal (2, ml.TimedEvents.Timeouts.Count);
|
||||
Assert.Equal (fnTrue, ml.TimedEvents.Timeouts.ElementAt (0).Value.Callback);
|
||||
Assert.NotEqual (fnFalse, ml.TimedEvents.Timeouts.ElementAt (0).Value.Callback);
|
||||
|
||||
Assert.True (ml.TimedEvents.Remove (a));
|
||||
Assert.Single (ml.TimedEvents.Timeouts);
|
||||
|
||||
// BUGBUG: This doesn't throw or indicate an error. Ideally RemoveIdle would either
|
||||
// throw an exception in this case, or return an error.
|
||||
// No. Only need to return a boolean.
|
||||
Assert.False (ml.TimedEvents.Remove (a));
|
||||
|
||||
Assert.True (ml.TimedEvents.Remove (b));
|
||||
|
||||
// BUGBUG: This doesn't throw an exception or indicate an error. Ideally RemoveIdle would either
|
||||
// throw an exception in this case, or return an error.
|
||||
// No. Only need to return a boolean.
|
||||
Assert.False (ml.TimedEvents.Remove(b));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddTimeout_Function_GetsCalled_OnIteration ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
|
||||
var functionCalled = 0;
|
||||
|
||||
Func<bool> fn = () =>
|
||||
{
|
||||
functionCalled++;
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
ml.TimedEvents.Add (TimeSpan.Zero, fn);
|
||||
ml.RunIteration ();
|
||||
Assert.Equal (1, functionCalled);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddTimeout_Twice_Returns_False_Called_Twice ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
|
||||
var functionCalled = 0;
|
||||
|
||||
Func<bool> fn1 = () =>
|
||||
{
|
||||
functionCalled++;
|
||||
|
||||
return false;
|
||||
};
|
||||
|
||||
// Force stop if 10 iterations
|
||||
var stopCount = 0;
|
||||
|
||||
Func<bool> fnStop = () =>
|
||||
{
|
||||
stopCount++;
|
||||
|
||||
if (stopCount == 10)
|
||||
{
|
||||
ml.Stop ();
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
var a = ml.TimedEvents.Add (TimeSpan.Zero, fnStop);
|
||||
var b = ml.TimedEvents.Add (TimeSpan.Zero, fn1);
|
||||
ml.Run ();
|
||||
|
||||
Assert.True (ml.TimedEvents.Remove(a));
|
||||
Assert.False (ml.TimedEvents.Remove (a));
|
||||
|
||||
// Cannot remove b because it returned false i.e. auto removes itself
|
||||
Assert.False (ml.TimedEvents.Remove (b));
|
||||
|
||||
Assert.Equal (1, functionCalled);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddTimeoutTwice_Function_CalledTwice ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
|
||||
var functionCalled = 0;
|
||||
|
||||
Func<bool> fn = () =>
|
||||
{
|
||||
functionCalled++;
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
var a = ml.TimedEvents.Add (TimeSpan.Zero, fn);
|
||||
var b = ml.TimedEvents.Add (TimeSpan.Zero, fn);
|
||||
ml.RunIteration ();
|
||||
Assert.Equal (2, functionCalled);
|
||||
Assert.Equal (2, ml.TimedEvents.Timeouts.Count);
|
||||
|
||||
functionCalled = 0;
|
||||
Assert.True (ml.TimedEvents.Remove (a));
|
||||
Assert.Single (ml.TimedEvents.Timeouts);
|
||||
ml.RunIteration ();
|
||||
Assert.Equal (1, functionCalled);
|
||||
|
||||
functionCalled = 0;
|
||||
Assert.True (ml.TimedEvents.Remove (b));
|
||||
Assert.Empty (ml.TimedEvents.Timeouts);
|
||||
ml.RunIteration ();
|
||||
Assert.Equal (0, functionCalled);
|
||||
Assert.False (ml.TimedEvents.Remove (b));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddThenRemoveIdle_Function_NotCalled ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
|
||||
var functionCalled = 0;
|
||||
|
||||
Func<bool> fn = () =>
|
||||
{
|
||||
functionCalled++;
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
var a = ml.TimedEvents.Add (TimeSpan.Zero, fn);
|
||||
Assert.True (ml.TimedEvents.Remove (a));
|
||||
ml.RunIteration ();
|
||||
Assert.Equal (0, functionCalled);
|
||||
}
|
||||
|
||||
// Timeout Handler Tests
|
||||
[Fact]
|
||||
public void AddTimer_Adds_Removes_NoFaults ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
var ms = 100;
|
||||
|
||||
var callbackCount = 0;
|
||||
|
||||
Func<bool> callback = () =>
|
||||
{
|
||||
callbackCount++;
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
object token = ml.TimedEvents.Add (TimeSpan.FromMilliseconds (ms), callback);
|
||||
|
||||
Assert.True (ml.TimedEvents.Remove (token));
|
||||
|
||||
// BUGBUG: This should probably fault?
|
||||
// Must return a boolean.
|
||||
Assert.False (ml.TimedEvents.Remove (token));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task AddTimer_Duplicate_Keys_Not_Allowed ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
const int ms = 100;
|
||||
object token1 = null, token2 = null;
|
||||
|
||||
var callbackCount = 0;
|
||||
|
||||
Func<bool> callback = () =>
|
||||
{
|
||||
callbackCount++;
|
||||
|
||||
if (callbackCount == 2)
|
||||
{
|
||||
ml.Stop ();
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
var task1 = new Task (() => token1 = ml.TimedEvents.Add (TimeSpan.FromMilliseconds (ms), callback));
|
||||
var task2 = new Task (() => token2 = ml.TimedEvents.Add (TimeSpan.FromMilliseconds (ms), callback));
|
||||
Assert.Null (token1);
|
||||
Assert.Null (token2);
|
||||
task1.Start ();
|
||||
task2.Start ();
|
||||
ml.Run ();
|
||||
Assert.NotNull (token1);
|
||||
Assert.NotNull (token2);
|
||||
await Task.WhenAll (task1, task2);
|
||||
Assert.True (ml.TimedEvents.Remove (token1));
|
||||
Assert.True (ml.TimedEvents.Remove (token2));
|
||||
|
||||
Assert.Equal (2, callbackCount);
|
||||
}
|
||||
|
||||
// Timeout Handler Tests
|
||||
[Fact]
|
||||
public void AddTimer_EventFired ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
var ms = 100;
|
||||
|
||||
// Use Stopwatch ticks since TimedEvents now uses Stopwatch.GetTimestamp internally
|
||||
long originTicks = Stopwatch.GetTimestamp () * TimeSpan.TicksPerSecond / Stopwatch.Frequency;
|
||||
|
||||
var callbackCount = 0;
|
||||
|
||||
Func<bool> callback = () =>
|
||||
{
|
||||
callbackCount++;
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
object sender = null;
|
||||
TimeoutEventArgs args = null;
|
||||
|
||||
ml.TimedEvents.Added += (s, e) =>
|
||||
{
|
||||
sender = s;
|
||||
args = e;
|
||||
};
|
||||
|
||||
object token = ml.TimedEvents.Add (TimeSpan.FromMilliseconds (ms), callback);
|
||||
|
||||
Assert.Same (ml.TimedEvents, sender);
|
||||
Assert.NotNull (args.Timeout);
|
||||
Assert.True (args.Ticks - originTicks >= 100 * TimeSpan.TicksPerMillisecond);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddTimer_In_Parallel_Wont_Throw ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
const int ms = 100;
|
||||
object token1 = null, token2 = null;
|
||||
|
||||
var callbackCount = 0;
|
||||
|
||||
Func<bool> callback = () =>
|
||||
{
|
||||
callbackCount++;
|
||||
|
||||
if (callbackCount == 2)
|
||||
{
|
||||
ml.Stop ();
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
Parallel.Invoke (
|
||||
() => token1 = ml.TimedEvents.Add (TimeSpan.FromMilliseconds (ms), callback),
|
||||
() => token2 = ml.TimedEvents.Add (TimeSpan.FromMilliseconds (ms), callback)
|
||||
);
|
||||
ml.Run ();
|
||||
Assert.NotNull (token1);
|
||||
Assert.NotNull (token2);
|
||||
Assert.True (ml.TimedEvents.Remove (token1));
|
||||
Assert.True (ml.TimedEvents.Remove (token2));
|
||||
|
||||
Assert.Equal (2, callbackCount);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddTimer_Remove_NotCalled ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
TimeSpan ms = TimeSpan.FromMilliseconds (50);
|
||||
|
||||
// Force stop if 10 iterations
|
||||
var stopCount = 0;
|
||||
|
||||
Func<bool> fnStop = () =>
|
||||
{
|
||||
stopCount++;
|
||||
|
||||
if (stopCount == 10)
|
||||
{
|
||||
ml.Stop ();
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
ml.TimedEvents.Add (TimeSpan.Zero, fnStop);
|
||||
|
||||
var callbackCount = 0;
|
||||
|
||||
Func<bool> callback = () =>
|
||||
{
|
||||
callbackCount++;
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
object token = ml.TimedEvents.Add (ms, callback);
|
||||
Assert.True (ml.TimedEvents.Remove (token));
|
||||
ml.Run ();
|
||||
Assert.Equal (0, callbackCount);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddTimer_ReturnFalse_StopsBeingCalled ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
TimeSpan ms = TimeSpan.FromMilliseconds (50);
|
||||
|
||||
// Force stop if 10 iterations
|
||||
var stopCount = 0;
|
||||
|
||||
Func<bool> fnStop = () =>
|
||||
{
|
||||
Thread.Sleep (10); // Sleep to enable timer to fire
|
||||
stopCount++;
|
||||
|
||||
if (stopCount == 10)
|
||||
{
|
||||
ml.Stop ();
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
ml.TimedEvents.Add (TimeSpan.Zero, fnStop);
|
||||
|
||||
var callbackCount = 0;
|
||||
|
||||
Func<bool> callback = () =>
|
||||
{
|
||||
callbackCount++;
|
||||
|
||||
return false;
|
||||
};
|
||||
|
||||
object token = ml.TimedEvents.Add (ms, callback);
|
||||
ml.Run ();
|
||||
Assert.Equal (1, callbackCount);
|
||||
Assert.Equal (10, stopCount);
|
||||
Assert.False (ml.TimedEvents.Remove (token));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddTimer_Run_Called ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
var ms = 100;
|
||||
|
||||
var callbackCount = 0;
|
||||
|
||||
Func<bool> callback = () =>
|
||||
{
|
||||
callbackCount++;
|
||||
ml.Stop ();
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
object token = ml.TimedEvents.Add (TimeSpan.FromMilliseconds (ms), callback);
|
||||
ml.Run ();
|
||||
Assert.True (ml.TimedEvents.Remove (token));
|
||||
|
||||
Assert.Equal (1, callbackCount);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddTimer_Run_CalledAtApproximatelyRightTime ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
TimeSpan ms = TimeSpan.FromMilliseconds (50);
|
||||
var watch = new Stopwatch ();
|
||||
|
||||
var callbackCount = 0;
|
||||
|
||||
Func<bool> callback = () =>
|
||||
{
|
||||
watch.Stop ();
|
||||
callbackCount++;
|
||||
ml.Stop ();
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
object token = ml.TimedEvents.Add (ms, callback);
|
||||
watch.Start ();
|
||||
ml.Run ();
|
||||
|
||||
// +/- 100ms should be good enuf
|
||||
// https://github.com/xunit/assert.xunit/pull/25
|
||||
Assert.Equal (ms * callbackCount, watch.Elapsed, new MillisecondTolerance (100));
|
||||
|
||||
Assert.True (ml.TimedEvents.Remove (token));
|
||||
Assert.Equal (1, callbackCount);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddTimer_Run_CalledTwiceApproximatelyRightTime ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
TimeSpan ms = TimeSpan.FromMilliseconds (50);
|
||||
var watch = new Stopwatch ();
|
||||
|
||||
var callbackCount = 0;
|
||||
|
||||
Func<bool> callback = () =>
|
||||
{
|
||||
callbackCount++;
|
||||
|
||||
if (callbackCount == 2)
|
||||
{
|
||||
watch.Stop ();
|
||||
ml.Stop ();
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
object token = ml.TimedEvents.Add (ms, callback);
|
||||
watch.Start ();
|
||||
ml.Run ();
|
||||
|
||||
// +/- 100ms should be good enuf
|
||||
// https://github.com/xunit/assert.xunit/pull/25
|
||||
Assert.Equal (ms * callbackCount, watch.Elapsed, new MillisecondTolerance (100));
|
||||
|
||||
Assert.True (ml.TimedEvents.Remove (token));
|
||||
Assert.Equal (2, callbackCount);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void CheckTimersAndIdleHandlers_NoTimers_Returns_False ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
bool retVal = ml.TimedEvents.CheckTimers(out int waitTimeOut);
|
||||
Assert.False (retVal);
|
||||
Assert.Equal (-1, waitTimeOut);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void CheckTimersAndIdleHandlers_NoTimers_WithIdle_Returns_True ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
Func<bool> fnTrue = () => true;
|
||||
|
||||
ml.TimedEvents.Add (TimeSpan.Zero, fnTrue);
|
||||
bool retVal = ml.TimedEvents.CheckTimers(out int waitTimeOut);
|
||||
Assert.True (retVal);
|
||||
Assert.Equal (0, waitTimeOut);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void CheckTimersAndIdleHandlers_With1Timer_Returns_Timer ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
TimeSpan ms = TimeSpan.FromMilliseconds (50);
|
||||
|
||||
static bool Callback () { return false; }
|
||||
|
||||
_ = ml.TimedEvents.Add (ms, Callback);
|
||||
bool retVal = ml.TimedEvents.CheckTimers (out int waitTimeOut);
|
||||
|
||||
Assert.True (retVal);
|
||||
|
||||
// It should take < 10ms to execute to here
|
||||
Assert.True (ms.TotalMilliseconds <= waitTimeOut + 10);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void CheckTimersAndIdleHandlers_With2Timers_Returns_Timer ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
TimeSpan ms = TimeSpan.FromMilliseconds (50);
|
||||
|
||||
static bool Callback () { return false; }
|
||||
|
||||
_ = ml.TimedEvents.Add (ms, Callback);
|
||||
_ = ml.TimedEvents.Add (ms, Callback);
|
||||
bool retVal = ml.TimedEvents.CheckTimers (out int waitTimeOut);
|
||||
|
||||
Assert.True (retVal);
|
||||
|
||||
// It should take < 10ms to execute to here
|
||||
Assert.True (ms.TotalMilliseconds <= waitTimeOut + 10);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void False_Idle_Stops_It_Being_Called_Again ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
|
||||
var functionCalled = 0;
|
||||
|
||||
Func<bool> fn1 = () =>
|
||||
{
|
||||
functionCalled++;
|
||||
|
||||
if (functionCalled == 10)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
// Force stop if 20 iterations
|
||||
var stopCount = 0;
|
||||
|
||||
Func<bool> fnStop = () =>
|
||||
{
|
||||
stopCount++;
|
||||
|
||||
if (stopCount == 20)
|
||||
{
|
||||
ml.Stop ();
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
var a = ml.TimedEvents.Add (TimeSpan.Zero, fnStop);
|
||||
var b = ml.TimedEvents.Add (TimeSpan.Zero, fn1);
|
||||
ml.Run ();
|
||||
Assert.True (ml.TimedEvents.Remove (a));
|
||||
Assert.False (ml.TimedEvents.Remove (a));
|
||||
|
||||
Assert.Equal (10, functionCalled);
|
||||
Assert.Equal (20, stopCount);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Internal_Tests ()
|
||||
{
|
||||
var testMainloop = new TestMainloop ();
|
||||
var mainloop = new MainLoop (testMainloop);
|
||||
Assert.Empty (mainloop.TimedEvents.Timeouts);
|
||||
|
||||
Assert.NotNull (
|
||||
new Terminal.Gui.App.Timeout { Span = new (), Callback = () => true }
|
||||
);
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[MemberData (nameof (TestAddTimeout))]
|
||||
public void Mainloop_Invoke_Or_AddTimeout_Can_Be_Used_For_Events_Or_Actions (
|
||||
Action action,
|
||||
string pclickMe,
|
||||
string pcancel,
|
||||
string ppewPew,
|
||||
int pzero,
|
||||
int pone,
|
||||
int ptwo,
|
||||
int pthree,
|
||||
int pfour
|
||||
)
|
||||
{
|
||||
// TODO: Expand this test to test all drivers
|
||||
Application.Init (null, "fakedriver");
|
||||
|
||||
total = 0;
|
||||
btn = null;
|
||||
clickMe = pclickMe;
|
||||
cancel = pcancel;
|
||||
pewPew = ppewPew;
|
||||
zero = pzero;
|
||||
one = pone;
|
||||
two = ptwo;
|
||||
three = pthree;
|
||||
four = pfour;
|
||||
taskCompleted = false;
|
||||
|
||||
var btnLaunch = new Button { Text = "Open Window" };
|
||||
|
||||
btnLaunch.Accepting += (s, e) => action ();
|
||||
|
||||
var top = new Toplevel ();
|
||||
top.Add (btnLaunch);
|
||||
|
||||
int iterations = -1;
|
||||
|
||||
Application.Iteration += (s, a) =>
|
||||
{
|
||||
iterations++;
|
||||
|
||||
if (iterations == 0)
|
||||
{
|
||||
Assert.Null (btn);
|
||||
Assert.Equal (zero, total);
|
||||
Assert.False (btnLaunch.NewKeyDownEvent (Key.Space));
|
||||
|
||||
if (btn == null)
|
||||
{
|
||||
Assert.Null (btn);
|
||||
Assert.Equal (zero, total);
|
||||
}
|
||||
else
|
||||
{
|
||||
Assert.Equal (clickMe, btn.Text);
|
||||
Assert.Equal (four, total);
|
||||
}
|
||||
}
|
||||
else if (iterations == 1)
|
||||
{
|
||||
Assert.Equal (clickMe, btn.Text);
|
||||
Assert.Equal (zero, total);
|
||||
Assert.False (btn.NewKeyDownEvent (Key.Space));
|
||||
Assert.Equal (cancel, btn.Text);
|
||||
Assert.Equal (one, total);
|
||||
}
|
||||
else if (taskCompleted)
|
||||
{
|
||||
Application.RequestStop ();
|
||||
}
|
||||
};
|
||||
|
||||
Application.Run (top);
|
||||
top.Dispose ();
|
||||
|
||||
Assert.True (taskCompleted);
|
||||
Assert.Equal (clickMe, btn.Text);
|
||||
Assert.Equal (four, total);
|
||||
|
||||
Application.Shutdown ();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void RemoveIdle_Function_NotCalled ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
|
||||
var functionCalled = 0;
|
||||
|
||||
Func<bool> fn = () =>
|
||||
{
|
||||
functionCalled++;
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
Assert.False (ml.TimedEvents.Remove ("flibble"));
|
||||
ml.RunIteration ();
|
||||
Assert.Equal (0, functionCalled);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Run_Runs_Idle_Stop_Stops_Idle ()
|
||||
{
|
||||
var ml = new MainLoop (new FakeMainLoop ());
|
||||
|
||||
var functionCalled = 0;
|
||||
|
||||
Func<bool> fn = () =>
|
||||
{
|
||||
functionCalled++;
|
||||
|
||||
if (functionCalled == 10)
|
||||
{
|
||||
ml.Stop ();
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
var a = ml.TimedEvents.Add (TimeSpan.Zero, fn);
|
||||
ml.Run ();
|
||||
Assert.True (ml.TimedEvents.Remove (a));
|
||||
|
||||
Assert.Equal (10, functionCalled);
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData ("fake")]
|
||||
[InlineData ("windows")]
|
||||
[InlineData ("dotnet")]
|
||||
[InlineData ("unix")]
|
||||
public void Application_Invoke_Run_TimedEvents (string driverName)
|
||||
{
|
||||
// Arrange
|
||||
Application.Init (driverName: driverName);
|
||||
var functionCalled = 0;
|
||||
var stopwatch = new Stopwatch ();
|
||||
|
||||
// Act
|
||||
Application.Invoke (() =>
|
||||
{
|
||||
// Stop the stopwatch *after* the function is called.
|
||||
functionCalled++;
|
||||
stopwatch.Stop ();
|
||||
Application.RequestStop ();
|
||||
});
|
||||
|
||||
// Start timing just before running the application loop.
|
||||
stopwatch.Start ();
|
||||
Application.Run ();
|
||||
|
||||
// Assert
|
||||
Assert.NotNull (Application.Top);
|
||||
Application.Top.Dispose ();
|
||||
Application.Shutdown ();
|
||||
Assert.Equal (1, functionCalled);
|
||||
|
||||
// Output the elapsed time for this test case.
|
||||
// ReSharper disable once Xunit.XunitTestWithConsoleOutput
|
||||
// ReSharper disable once LocalizableElement
|
||||
Console.WriteLine ($"[{driverName}] Duration: {stopwatch.Elapsed.TotalMilliseconds:F2} ms");
|
||||
|
||||
// Output elapsed duration to xUnit's test output
|
||||
_output.WriteLine ($"[{driverName}] Duration: {stopwatch.Elapsed.TotalMilliseconds:F2} ms");
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData ("fake")]
|
||||
[InlineData ("windows")]
|
||||
[InlineData ("dotnet")]
|
||||
[InlineData ("unix")]
|
||||
public void Application_AddTimeout_Run_TimedEvents (string driverName)
|
||||
{
|
||||
// Arrange
|
||||
Application.Init (driverName: driverName);
|
||||
var functionCalled = 0;
|
||||
var stopwatch = new Stopwatch ();
|
||||
|
||||
// Act
|
||||
bool Function ()
|
||||
{
|
||||
functionCalled++;
|
||||
|
||||
if (functionCalled == 10 && Application.Top is { Running: true })
|
||||
{
|
||||
stopwatch.Stop ();
|
||||
Application.RequestStop ();
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
Application.AddTimeout (TimeSpan.FromMilliseconds (1), Function);
|
||||
|
||||
// Start timing just before running the application loop.
|
||||
stopwatch.Start ();
|
||||
Application.Run ();
|
||||
|
||||
// Assert
|
||||
Assert.NotNull (Application.Top);
|
||||
Application.Top.Dispose ();
|
||||
Application.Shutdown ();
|
||||
Assert.Equal (10, functionCalled);
|
||||
|
||||
// Output the elapsed time for this test case.
|
||||
// ReSharper disable once Xunit.XunitTestWithConsoleOutput
|
||||
// ReSharper disable once LocalizableElement
|
||||
Console.WriteLine ($"[{driverName}] Duration: {stopwatch.Elapsed.TotalMilliseconds:F2} ms");
|
||||
|
||||
// Output elapsed duration to xUnit's test output
|
||||
_output.WriteLine ($"[{driverName}] Duration: {stopwatch.Elapsed.TotalMilliseconds:F2} ms");
|
||||
}
|
||||
|
||||
public static IEnumerable<object []> TestAddTimeout
|
||||
{
|
||||
get
|
||||
{
|
||||
// Goes fine
|
||||
Action a1 = StartWindow;
|
||||
|
||||
yield return new object [] { a1, "Click Me", "Cancel", "Pew Pew", 0, 1, 2, 3, 4 };
|
||||
|
||||
// Also goes fine
|
||||
Action a2 = () => Application.Invoke (StartWindow);
|
||||
|
||||
yield return new object [] { a2, "Click Me", "Cancel", "Pew Pew", 0, 1, 2, 3, 4 };
|
||||
}
|
||||
}
|
||||
|
||||
private static async void RunAsyncTest (object sender, EventArgs e)
|
||||
{
|
||||
Assert.Equal (clickMe, btn.Text);
|
||||
Assert.Equal (zero, total);
|
||||
|
||||
btn.Text = "Cancel";
|
||||
Interlocked.Increment (ref total);
|
||||
btn.SetNeedsDraw ();
|
||||
|
||||
await Task.Run (
|
||||
() =>
|
||||
{
|
||||
try
|
||||
{
|
||||
Assert.Equal (cancel, btn.Text);
|
||||
Assert.Equal (one, total);
|
||||
|
||||
RunSql ();
|
||||
}
|
||||
finally
|
||||
{
|
||||
SetReadyToRun ();
|
||||
}
|
||||
}
|
||||
)
|
||||
.ContinueWith (
|
||||
async (s, e) =>
|
||||
{
|
||||
await Task.Delay (1000);
|
||||
Assert.Equal (clickMe, btn.Text);
|
||||
Assert.Equal (three, total);
|
||||
|
||||
Interlocked.Increment (ref total);
|
||||
|
||||
Assert.Equal (clickMe, btn.Text);
|
||||
Assert.Equal (four, total);
|
||||
|
||||
taskCompleted = true;
|
||||
},
|
||||
TaskScheduler.FromCurrentSynchronizationContext ()
|
||||
);
|
||||
}
|
||||
|
||||
private static void RunSql ()
|
||||
{
|
||||
Thread.Sleep (100);
|
||||
Assert.Equal (cancel, btn.Text);
|
||||
Assert.Equal (one, total);
|
||||
|
||||
Application.Invoke (
|
||||
() =>
|
||||
{
|
||||
btn.Text = "Pew Pew";
|
||||
Interlocked.Increment (ref total);
|
||||
btn.SetNeedsDraw ();
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
private static void SetReadyToRun ()
|
||||
{
|
||||
Thread.Sleep (100);
|
||||
Assert.Equal (pewPew, btn.Text);
|
||||
Assert.Equal (two, total);
|
||||
|
||||
Application.Invoke (
|
||||
() =>
|
||||
{
|
||||
btn.Text = "Click Me";
|
||||
Interlocked.Increment (ref total);
|
||||
btn.SetNeedsDraw ();
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
private static void StartWindow ()
|
||||
{
|
||||
var startWindow = new Window { Modal = true };
|
||||
|
||||
btn = new() { Text = "Click Me" };
|
||||
|
||||
btn.Accepting += RunAsyncTest;
|
||||
|
||||
var totalbtn = new Button { X = Pos.Right (btn), Text = "total" };
|
||||
|
||||
totalbtn.Accepting += (s, e) => { MessageBox.Query ("Count", $"Count is {total}", "Ok"); };
|
||||
|
||||
startWindow.Add (btn);
|
||||
startWindow.Add (totalbtn);
|
||||
|
||||
Application.Run (startWindow);
|
||||
|
||||
Assert.Equal (clickMe, btn.Text);
|
||||
Assert.Equal (four, total);
|
||||
|
||||
Application.RequestStop ();
|
||||
}
|
||||
|
||||
private class MillisecondTolerance : IEqualityComparer<TimeSpan>
|
||||
{
|
||||
public MillisecondTolerance (int tolerance) { _tolerance = tolerance; }
|
||||
private readonly int _tolerance;
|
||||
public bool Equals (TimeSpan x, TimeSpan y) { return Math.Abs (x.Milliseconds - y.Milliseconds) <= _tolerance; }
|
||||
public int GetHashCode (TimeSpan obj) { return obj.GetHashCode (); }
|
||||
}
|
||||
|
||||
private class TestMainloop : IMainLoopDriver
|
||||
{
|
||||
private MainLoop mainLoop;
|
||||
public bool EventsPending () { throw new NotImplementedException (); }
|
||||
public void Iteration () { throw new NotImplementedException (); }
|
||||
public void TearDown () { throw new NotImplementedException (); }
|
||||
public void Setup (MainLoop mainLoop) { this.mainLoop = mainLoop; }
|
||||
public void Wakeup () { throw new NotImplementedException (); }
|
||||
}
|
||||
}
|
||||
@@ -45,7 +45,6 @@ public class RunStateTests
|
||||
#endif
|
||||
|
||||
Assert.Null (Application.Top);
|
||||
// Assert.Null (Application.MainLoop);
|
||||
Assert.Null (Application.Driver);
|
||||
}
|
||||
|
||||
|
||||
@@ -50,8 +50,8 @@ public class ConsoleDriverTests
|
||||
public void Init_Inits (Type driverType)
|
||||
{
|
||||
var driver = (IConsoleDriver)Activator.CreateInstance (driverType);
|
||||
MainLoop ml = driver.Init ();
|
||||
Assert.NotNull (ml);
|
||||
driver.Init ();
|
||||
// Note: MainLoop is no longer returned from Init() as part of legacy MainLoop removal
|
||||
Assert.NotNull (driver.Clipboard);
|
||||
Console.ForegroundColor = ConsoleColor.Red;
|
||||
Assert.Equal (ConsoleColor.Red, Console.ForegroundColor);
|
||||
|
||||
@@ -12,7 +12,6 @@ public class AllViewsDrawTests (ITestOutputHelper output) : TestsAllViews
|
||||
{
|
||||
Application.ResetState (true);
|
||||
// Required for spinner view that wants to register timeouts
|
||||
Application.MainLoop = new MainLoop (new FakeMainLoop (Application.Driver));
|
||||
|
||||
var view = (View)CreateInstanceIfNotGeneric (viewType);
|
||||
|
||||
|
||||
@@ -12,7 +12,6 @@ public class LayoutTests (ITestOutputHelper output) : TestsAllViews
|
||||
{
|
||||
|
||||
// Required for spinner view that wants to register timeouts
|
||||
Application.MainLoop = new MainLoop (new FakeMainLoop (Application.Driver));
|
||||
|
||||
var view = (View)CreateInstanceIfNotGeneric (viewType);
|
||||
|
||||
|
||||
@@ -14,7 +14,6 @@ public class AllViewsTests (ITestOutputHelper output) : TestsAllViews
|
||||
public void AllViews_Center_Properly (Type viewType)
|
||||
{
|
||||
// Required for spinner view that wants to register timeouts
|
||||
Application.MainLoop = new (new FakeMainLoop (Application.Driver));
|
||||
|
||||
var view = CreateInstanceIfNotGeneric (viewType);
|
||||
|
||||
|
||||
@@ -623,7 +623,6 @@ public class MenuBarv1Tests (ITestOutputHelper output)
|
||||
Application.RaiseMouseEvent (new () { ScreenPosition = new (20, 5), Flags = MouseFlags.Button1Clicked });
|
||||
|
||||
// Need to fool MainLoop into thinking it's running
|
||||
Application.MainLoop.Running = true;
|
||||
AutoInitShutdownAttribute.RunIteration ();
|
||||
Assert.Equal (items [0], menu.Menus [0].Title);
|
||||
|
||||
@@ -815,7 +814,6 @@ public class MenuBarv1Tests (ITestOutputHelper output)
|
||||
Application.RaiseMouseEvent (new () { ScreenPosition = new (20, 5), Flags = MouseFlags.Button1Clicked });
|
||||
|
||||
// Need to fool MainLoop into thinking it's running
|
||||
Application.MainLoop.Running = true;
|
||||
AutoInitShutdownAttribute.RunIteration ();
|
||||
Assert.Equal (items [0], menu.Menus [0].Title);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user