123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374 |
- using System.Collections.Concurrent;
- using System.Drawing;
- using FluentAssertions;
- using FluentAssertions.Numeric;
- using Terminal.Gui;
- using Terminal.Gui.ConsoleDrivers;
- using static Unix.Terminal.Curses;
- namespace TerminalGuiFluentAssertions;
- class FakeInput<T>(CancellationToken hardStopToken) : IConsoleInput<T>
- {
- /// <inheritdoc />
- public void Dispose () { }
- /// <inheritdoc />
- public void Initialize (ConcurrentQueue<T> inputBuffer) { InputBuffer = inputBuffer;}
- public ConcurrentQueue<T> InputBuffer { get; set; }
- /// <inheritdoc />
- public void Run (CancellationToken token)
- {
- // Blocks until either the token or the hardStopToken is cancelled.
- WaitHandle.WaitAny (new [] { token.WaitHandle, hardStopToken.WaitHandle });
- }
- }
- class FakeNetInput (CancellationToken hardStopToken) : FakeInput<ConsoleKeyInfo> (hardStopToken), INetInput
- {
- }
- class FakeWindowsInput (CancellationToken hardStopToken) : FakeInput<WindowsConsole.InputRecord> (hardStopToken), IWindowsInput
- {
- }
- class FakeOutput : IConsoleOutput
- {
- public IOutputBuffer LastBuffer { get; set; }
- public Size Size { get; set; }
- /// <inheritdoc />
- public void Dispose ()
- {
- }
- /// <inheritdoc />
- public void Write (ReadOnlySpan<char> text)
- {
- }
- /// <inheritdoc />
- public void Write (IOutputBuffer buffer)
- {
- LastBuffer = buffer;
- }
- /// <inheritdoc />
- public Size GetWindowSize ()
- {
- return Size;
- }
- /// <inheritdoc />
- public void SetCursorVisibility (CursorVisibility visibility)
- {
- }
- /// <inheritdoc />
- public void SetCursorPosition (int col, int row)
- {
- }
- }
- /// <summary>
- /// Entry point to fluent assertions.
- /// </summary>
- public static class With
- {
- /// <summary>
- /// Entrypoint to fluent assertions
- /// </summary>
- /// <param name="width"></param>
- /// <param name="height"></param>
- /// <returns></returns>
- public static GuiTestContext<T> A<T> (int width, int height) where T : Toplevel, new ()
- {
- return new GuiTestContext<T> (width,height);
- }
- }
- public class GuiTestContext<T> : IDisposable where T : Toplevel, new()
- {
- private readonly CancellationTokenSource _cts = new ();
- private readonly CancellationTokenSource _hardStop = new ();
- private readonly Task _runTask;
- private Exception _ex;
- private readonly FakeOutput _output = new ();
- private readonly FakeWindowsInput winInput;
- private View _lastView;
- internal GuiTestContext (int width, int height)
- {
- IApplication origApp = ApplicationImpl.Instance;
- var netInput = new FakeNetInput (_cts.Token);
- winInput = new FakeWindowsInput (_cts.Token);
- _output.Size = new (width, height);
- var v2 = new ApplicationV2(
- () => netInput,
- ()=>_output,
- () => winInput,
- () => _output);
- // Start the application in a background thread
- _runTask = Task.Run (() =>
- {
- try
- {
- ApplicationImpl.ChangeInstance (v2);
- v2.Init (null,"v2win");
- Application.Run<T> (); // This will block, but it's on a background thread now
- Application.Shutdown ();
- }
- catch (OperationCanceledException)
- { }
- catch (Exception ex)
- {
- _ex = ex;
- }
- finally
- {
- ApplicationImpl.ChangeInstance (origApp);
- }
- }, _cts.Token);
- WaitIteration ();
- }
- /// <summary>
- /// Stops the application and waits for the background thread to exit.
- /// </summary>
- public GuiTestContext<T> Stop ()
- {
- if (_runTask.IsCompleted)
- {
- return this;
- }
- Application.Invoke (()=> Application.RequestStop ());
- // Wait for the application to stop, but give it a 1-second timeout
- if (!_runTask.Wait (TimeSpan.FromMilliseconds (1000)))
- {
- _cts.Cancel ();
- // Timeout occurred, force the task to stop
- _hardStop.Cancel ();
- throw new TimeoutException ("Application failed to stop within the allotted time.");
- }
- _cts.Cancel ();
- if (_ex != null)
- {
- throw _ex; // Propagate any exception that happened in the background task
- }
- return this;
- }
- // Cleanup to avoid state bleed between tests
- public void Dispose ()
- {
- Stop ();
- _hardStop.Cancel();
- }
- /// <summary>
- /// Adds the given <paramref name="v"/> to the current top level view
- /// and performs layout.
- /// </summary>
- /// <param name="v"></param>
- /// <returns></returns>
- public GuiTestContext<T> Add (View v)
- {
- WaitIteration (
- () =>
- {
- var top = Application.Top ?? throw new Exception("Top was null so could not add view");
- top.Add (v);
- top.Layout ();
- _lastView = v;
- });
- return this;
- }
- public GuiTestContext<T> ResizeConsole (int width, int height)
- {
- _output.Size = new Size (width,height);
- return WaitIteration ();
- }
- public GuiTestContext<T> ScreenShot (string title, TextWriter writer)
- {
- writer.WriteLine(title +":");
- var text = Application.ToString ();
- writer.WriteLine(text);
- return WaitIteration ();
- }
- public GuiTestContext<T> WaitIteration (Action? a = null)
- {
- a ??= () => { };
- var ctsLocal = new CancellationTokenSource ();
- Application.Invoke (()=>
- {
- a();
- ctsLocal.Cancel ();
- });
- // Blocks until either the token or the hardStopToken is cancelled.
- WaitHandle.WaitAny (new []
- {
- _cts.Token.WaitHandle,
- _hardStop.Token.WaitHandle,
- ctsLocal.Token.WaitHandle
- });
- return this;
- }
- public GuiTestContext<T> Assert<T2> (AndConstraint<T2> be)
- {
- return this;
- }
- public GuiTestContext<T> RightClick (int screenX, int screenY)
- {
- return Click (WindowsConsole.ButtonState.Button3Pressed,screenX, screenY);
- }
- public GuiTestContext<T> LeftClick (int screenX, int screenY)
- {
- return Click (WindowsConsole.ButtonState.Button1Pressed, screenX, screenY);
- }
- private GuiTestContext<T> Click (WindowsConsole.ButtonState btn, int screenX, int screenY)
- {
- winInput.InputBuffer.Enqueue (new WindowsConsole.InputRecord ()
- {
- EventType = WindowsConsole.EventType.Mouse,
- MouseEvent = new WindowsConsole.MouseEventRecord ()
- {
- ButtonState = btn,
- MousePosition = new WindowsConsole.Coord ((short)screenX, (short)screenY)
- }
- });
- winInput.InputBuffer.Enqueue (new WindowsConsole.InputRecord ()
- {
- EventType = WindowsConsole.EventType.Mouse,
- MouseEvent = new WindowsConsole.MouseEventRecord ()
- {
- ButtonState = WindowsConsole.ButtonState.NoButtonPressed,
- MousePosition = new WindowsConsole.Coord ((short)screenX, (short)screenY)
- }
- });
- WaitIteration ();
- return this;
- }
- public GuiTestContext<T> Down ()
- {
- winInput.InputBuffer.Enqueue (new WindowsConsole.InputRecord ()
- {
- EventType = WindowsConsole.EventType.Key,
- KeyEvent = new WindowsConsole.KeyEventRecord
- {
- bKeyDown = true,
- wRepeatCount = 0,
- wVirtualKeyCode = ConsoleKeyMapping.VK.DOWN,
- wVirtualScanCode = 0,
- UnicodeChar = '\0',
- dwControlKeyState = WindowsConsole.ControlKeyState.NoControlKeyPressed
- }
- });
- winInput.InputBuffer.Enqueue (new WindowsConsole.InputRecord ()
- {
- EventType = WindowsConsole.EventType.Key,
- KeyEvent = new WindowsConsole.KeyEventRecord
- {
- bKeyDown = false,
- wRepeatCount = 0,
- wVirtualKeyCode = ConsoleKeyMapping.VK.DOWN,
- wVirtualScanCode = 0,
- UnicodeChar = '\0',
- dwControlKeyState = WindowsConsole.ControlKeyState.NoControlKeyPressed
- }
- });
- WaitIteration ();
- return this;
- }
- public GuiTestContext<T> Enter ()
- {
- winInput.InputBuffer.Enqueue (new WindowsConsole.InputRecord ()
- {
- EventType = WindowsConsole.EventType.Key,
- KeyEvent = new WindowsConsole.KeyEventRecord
- {
- bKeyDown = true,
- wRepeatCount = 0,
- wVirtualKeyCode = ConsoleKeyMapping.VK.RETURN,
- wVirtualScanCode = 0,
- UnicodeChar = '\0',
- dwControlKeyState = WindowsConsole.ControlKeyState.NoControlKeyPressed
- }
- });
- winInput.InputBuffer.Enqueue (new WindowsConsole.InputRecord ()
- {
- EventType = WindowsConsole.EventType.Key,
- KeyEvent = new WindowsConsole.KeyEventRecord
- {
- bKeyDown = false,
- wRepeatCount = 0,
- wVirtualKeyCode = ConsoleKeyMapping.VK.RETURN,
- wVirtualScanCode = 0,
- UnicodeChar = '\0',
- dwControlKeyState = WindowsConsole.ControlKeyState.NoControlKeyPressed
- }
- });
- WaitIteration ();
- return this;
- }
- public GuiTestContext<T> WithContextMenu (ContextMenu ctx, MenuBarItem menuItems)
- {
- LastView.MouseEvent += (s, e) =>
- {
- if (e.Flags.HasFlag (MouseFlags.Button3Clicked))
- {
- ctx.Show (menuItems);
- }
- };
- return this;
- }
- public View LastView => _lastView ?? Application.Top ?? throw new Exception ("Could not determine which view to add to");
- }
|