Files
Terminal.Gui/Tests/UnitTests/Dialogs/WizardTests.cs
Copilot aef88ad4bb Fixes #4332 - Refactor test infrastructure to use modern ApplicationImpl.Coordinator instead of legacy MainLoop (#4335)
* Initial plan

* Refactor tests to use modern ApplicationImpl.Coordinator architecture instead of legacy Application.RunIteration

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Changes before error encountered

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Replace Application.RunIteration implementation to use modern ApplicationImpl.Coordinator architecture

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Simplify Application.RunIteration to directly delegate to ApplicationImpl.Coordinator without legacy infrastructure

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update multitasking.md documentation to use Application.AddTimeout/RemoveTimeout instead of deprecated Application.MainLoop methods

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Refactor contribution guidelines and documentation

- Consolidated all contribution-related instructions into `CONTRIBUTING.md` as the single source of truth.
- Updated `copilot-instructions.md` and `AGENTS.md` to reference `CONTRIBUTING.md`.
- Enhanced build, test, and CI/CD workflow documentation.
- Updated repository structure documentation in `README.md` and `CONTRIBUTING.md`.
- Reinforced coding conventions and streamlined testing requirements.
- Documented GitHub Actions workflows and provided local CI replication steps.
- Refined API documentation requirements and PR guidelines.
- Simplified `.sln` file and removed redundant content.
- Updated links to point to the latest documentation resources.

* Revamp bug report template for clarity and detail

Updated the bug report template to improve structure, readability, and comprehensiveness:
- Specified "Terminal.Gui" in the `about` section.
- Replaced bold headings with Markdown heading syntax.
- Enhanced "To Reproduce" with placeholders for code and behavior details.
- Added an "Environment" section to collect OS, terminal, PowerShell, .NET, and `Terminal.Gui` version details.
- Expanded "Screenshots" to include GIFs and terminal output instructions.
- Removed outdated "Desktop" and "Smartphone" sections, consolidating relevant details.
- Improved "Additional Context" with prompts for consistency, prior behavior, and error messages.
- Streamlined "For Maintainers" instructions for setting project and milestone.

These changes aim to make bug reports more actionable and easier to reproduce.

* Remove [Obsolete] attribute and pragma warnings from Application.RunIteration - method now uses modern architecture internally

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Refactor Application.Run.cs for clarity and cleanup

Removed debug assertions and unused/commented-out code to simplify logic and improve maintainability. Renamed `forceDraw` to `forceRedraw` in `LayoutAndDraw` for better clarity. Removed the internal `OnNotifyStopRunState` method and its associated logic, indicating a refactor of the stop notification mechanism.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Tig <tig@users.noreply.github.com>
Co-authored-by: tig <585482+tig@users.noreply.github.com>
2025-10-26 09:15:46 -06:00

720 lines
22 KiB
C#

using UnitTests;
using Xunit.Abstractions;
namespace UnitTests.DialogTests;
public class WizardTests ()
{
// =========== Wizard Tests
[Fact]
public void DefaultConstructor_SizedProperly ()
{
var wizard = new Wizard ();
Assert.NotEqual (0, wizard.Width);
Assert.NotEqual (0, wizard.Height);
wizard.Dispose ();
}
[Fact]
[AutoInitShutdown]
public void Finish_Button_Closes ()
{
// https://github.com/gui-cs/Terminal.Gui/issues/1833
Wizard wizard = new ();
WizardStep step1 = new () { Title = "step1" };
wizard.AddStep (step1);
var finishedFired = false;
wizard.Finished += (s, args) => { finishedFired = true; };
var closedFired = false;
wizard.Closed += (s, e) => { closedFired = true; };
RunState runstate = Application.Begin (wizard);
AutoInitShutdownAttribute.RunIteration ();
wizard.NextFinishButton.InvokeCommand (Command.Accept);
AutoInitShutdownAttribute.RunIteration ();
Application.End (runstate);
Assert.True (finishedFired);
Assert.True (closedFired);
step1.Dispose ();
wizard.Dispose ();
// Same test, but with two steps
wizard = new ();
step1 = new() { Title = "step1" };
wizard.AddStep (step1);
WizardStep step2 = new () { Title = "step2" };
wizard.AddStep (step2);
finishedFired = false;
wizard.Finished += (s, args) => { finishedFired = true; };
closedFired = false;
wizard.Closed += (s, e) => { closedFired = true; };
runstate = Application.Begin (wizard);
AutoInitShutdownAttribute.RunIteration ();
Assert.Equal (step1.Title, wizard.CurrentStep.Title);
wizard.NextFinishButton.InvokeCommand (Command.Accept);
Assert.False (finishedFired);
Assert.False (closedFired);
Assert.Equal (step2.Title, wizard.CurrentStep.Title);
Assert.Equal (wizard.GetLastStep ().Title, wizard.CurrentStep.Title);
wizard.NextFinishButton.InvokeCommand (Command.Accept);
Application.End (runstate);
Assert.True (finishedFired);
Assert.True (closedFired);
step1.Dispose ();
step2.Dispose ();
wizard.Dispose ();
// Same test, but with two steps but the 1st one disabled
wizard = new ();
step1 = new() { Title = "step1" };
wizard.AddStep (step1);
step2 = new() { Title = "step2" };
wizard.AddStep (step2);
step1.Enabled = false;
finishedFired = false;
wizard.Finished += (s, args) => { finishedFired = true; };
closedFired = false;
wizard.Closed += (s, e) => { closedFired = true; };
runstate = Application.Begin (wizard);
AutoInitShutdownAttribute.RunIteration ();
Assert.Equal (step2.Title, wizard.CurrentStep.Title);
Assert.Equal (wizard.GetLastStep ().Title, wizard.CurrentStep.Title);
wizard.NextFinishButton.InvokeCommand (Command.Accept);
Application.End (runstate);
Assert.True (finishedFired);
Assert.True (closedFired);
wizard.Dispose ();
}
[Fact]
public void Navigate_GetFirstStep_Works ()
{
var wizard = new Wizard ();
Assert.Null (wizard.GetFirstStep ());
var step1 = new WizardStep { Title = "step1" };
wizard.AddStep (step1);
Assert.Equal (step1.Title, wizard.GetFirstStep ().Title);
var step2 = new WizardStep { Title = "step2" };
wizard.AddStep (step2);
Assert.Equal (step1.Title, wizard.GetFirstStep ().Title);
var step3 = new WizardStep { Title = "step3" };
wizard.AddStep (step3);
Assert.Equal (step1.Title, wizard.GetFirstStep ().Title);
step1.Enabled = false;
Assert.Equal (step2.Title, wizard.GetFirstStep ().Title);
step1.Enabled = true;
Assert.Equal (step1.Title, wizard.GetFirstStep ().Title);
step1.Enabled = false;
step2.Enabled = false;
Assert.Equal (step3.Title, wizard.GetFirstStep ().Title);
wizard.Dispose ();
}
[Fact]
public void Navigate_GetLastStep_Works ()
{
var wizard = new Wizard ();
Assert.Null (wizard.GetLastStep ());
var step1 = new WizardStep { Title = "step1" };
wizard.AddStep (step1);
Assert.Equal (step1.Title, wizard.GetLastStep ().Title);
var step2 = new WizardStep { Title = "step2" };
wizard.AddStep (step2);
Assert.Equal (step2.Title, wizard.GetLastStep ().Title);
var step3 = new WizardStep { Title = "step3" };
wizard.AddStep (step3);
Assert.Equal (step3.Title, wizard.GetLastStep ().Title);
step3.Enabled = false;
Assert.Equal (step2.Title, wizard.GetLastStep ().Title);
step3.Enabled = true;
Assert.Equal (step3.Title, wizard.GetLastStep ().Title);
step3.Enabled = false;
step2.Enabled = false;
Assert.Equal (step1.Title, wizard.GetLastStep ().Title);
wizard.Dispose ();
}
[Fact]
[AutoInitShutdown]
public void Navigate_GetNextStep_Correct ()
{
var wizard = new Wizard ();
// If no steps should be null
Assert.Null (wizard.GetNextStep ());
var step1 = new WizardStep { Title = "step1" };
wizard.AddStep (step1);
// If no current step, should be first step
Assert.Equal (step1.Title, wizard.GetNextStep ().Title);
wizard.CurrentStep = step1;
// If there is 1 step it's current step should be null
Assert.Null (wizard.GetNextStep ());
// If one disabled step should be null
step1.Enabled = false;
Assert.Null (wizard.GetNextStep ());
// If two steps and at 1 and step 2 is `Enabled = true`should be step 2
var step2 = new WizardStep { Title = "step2" };
wizard.AddStep (step2);
Assert.Equal (step2.Title, wizard.GetNextStep ().Title);
// If two steps and at 1 and step 2 is `Enabled = false` should be null
step1.Enabled = true;
wizard.CurrentStep = step1;
step2.Enabled = false;
Assert.Null (wizard.GetNextStep ());
// If three steps with Step2.Enabled = true
// At step 1 should be step 2
// At step 2 should be step 3
// At step 3 should be null
var step3 = new WizardStep { Title = "step3" };
wizard.AddStep (step3);
step1.Enabled = true;
wizard.CurrentStep = step1;
step2.Enabled = true;
step3.Enabled = true;
Assert.Equal (step2.Title, wizard.GetNextStep ().Title);
wizard.CurrentStep = step2;
Assert.Equal (step3.Title, wizard.GetNextStep ().Title);
wizard.CurrentStep = step3;
Assert.Null (wizard.GetNextStep ());
// If three steps with Step2.Enabled = false
// At step 1 should be step 3
// At step 3 should be null
step1.Enabled = true;
wizard.CurrentStep = step1;
step2.Enabled = false;
step3.Enabled = true;
Assert.Equal (step3.Title, wizard.GetNextStep ().Title);
wizard.CurrentStep = step3;
Assert.Null (wizard.GetNextStep ());
// If three steps with Step2.Enabled = false & Step3.Enabled = false
// At step 1 should be null
step1.Enabled = true;
wizard.CurrentStep = step1;
step2.Enabled = false;
step3.Enabled = false;
Assert.Null (wizard.GetNextStep ());
// If no current step, GetNextStep provides equivalent to GetFirstStep
wizard.CurrentStep = null;
step1.Enabled = true;
step2.Enabled = true;
step3.Enabled = true;
Assert.Equal (step1.Title, wizard.GetNextStep ().Title);
step1.Enabled = false;
step2.Enabled = true;
step3.Enabled = true;
Assert.Equal (step2.Title, wizard.GetNextStep ().Title);
step1.Enabled = false;
step2.Enabled = false;
step3.Enabled = true;
Assert.Equal (step3.Title, wizard.GetNextStep ().Title);
step1.Enabled = false;
step2.Enabled = true;
step3.Enabled = false;
Assert.Equal (step2.Title, wizard.GetNextStep ().Title);
step1.Enabled = true;
step2.Enabled = false;
step3.Enabled = false;
Assert.Equal (step1.Title, wizard.GetNextStep ().Title);
wizard.Dispose ();
}
[Fact]
[AutoInitShutdown]
public void Navigate_GetPreviousStep_Correct ()
{
var wizard = new Wizard ();
// If no steps should be null
Assert.Null (wizard.GetPreviousStep ());
var step1 = new WizardStep { Title = "step1" };
wizard.AddStep (step1);
// If no current step, should be last step
Assert.Equal (step1.Title, wizard.GetPreviousStep ().Title);
wizard.CurrentStep = step1;
// If there is 1 step it's current step should be null
Assert.Null (wizard.GetPreviousStep ());
// If one disabled step should be null
step1.Enabled = false;
Assert.Null (wizard.GetPreviousStep ());
// If two steps and at 2 and step 1 is `Enabled = true`should be step1
var step2 = new WizardStep { Title = "step2" };
wizard.AddStep (step2);
wizard.CurrentStep = step2;
step1.Enabled = true;
Assert.Equal (step1.Title, wizard.GetPreviousStep ().Title);
// If two steps and at 2 and step 1 is `Enabled = false` should be null
step1.Enabled = false;
Assert.Null (wizard.GetPreviousStep ());
// If three steps with Step2.Enabled = true
// At step 1 should be null
// At step 2 should be step 1
// At step 3 should be step 2
var step3 = new WizardStep { Title = "step3" };
wizard.AddStep (step3);
step1.Enabled = true;
wizard.CurrentStep = step1;
step2.Enabled = true;
step3.Enabled = true;
Assert.Null (wizard.GetPreviousStep ());
wizard.CurrentStep = step2;
Assert.Equal (step1.Title, wizard.GetPreviousStep ().Title);
wizard.CurrentStep = step3;
Assert.Equal (step2.Title, wizard.GetPreviousStep ().Title);
// If three steps with Step2.Enabled = false
// At step 1 should be null
// At step 3 should be step1
step1.Enabled = true;
step2.Enabled = false;
step3.Enabled = true;
wizard.CurrentStep = step1;
Assert.Null (wizard.GetPreviousStep ());
wizard.CurrentStep = step3;
Assert.Equal (step1.Title, wizard.GetPreviousStep ().Title);
// If three steps with Step1.Enabled = false & Step2.Enabled = false
// At step 3 should be null
// If no current step, GetPreviousStep provides equivalent to GetLastStep
wizard.CurrentStep = null;
step1.Enabled = true;
step2.Enabled = true;
step3.Enabled = true;
Assert.Equal (step3.Title, wizard.GetPreviousStep ().Title);
step1.Enabled = false;
step2.Enabled = true;
step3.Enabled = true;
Assert.Equal (step3.Title, wizard.GetPreviousStep ().Title);
step1.Enabled = false;
step2.Enabled = false;
step3.Enabled = true;
Assert.Equal (step3.Title, wizard.GetPreviousStep ().Title);
step1.Enabled = false;
step2.Enabled = true;
step3.Enabled = false;
Assert.Equal (step2.Title, wizard.GetPreviousStep ().Title);
step1.Enabled = true;
step2.Enabled = false;
step3.Enabled = false;
Assert.Equal (step1.Title, wizard.GetPreviousStep ().Title);
wizard.Dispose ();
}
[Fact]
public void Navigate_GoBack_Works ()
{
// If zero steps do nothing
// If one step do nothing (enabled or disabled)
// If two steps
// If current is 1 does nothing
// If current is 2 does nothing
// If 1 is enabled 2 becomes current
// If 1 is disabled 1 stays current
}
[Fact]
public void Navigate_GoNext_Works ()
{
// If zero steps do nothing
// If one step do nothing (enabled or disabled)
// If two steps
// If current is 1
// If 2 is enabled 2 becomes current
// If 2 is disabled 1 stays current
// If current is 2 does nothing
}
[Fact]
[AutoInitShutdown]
// This test verifies that a single step wizard shows the correct buttons
// and that the title is correct
public void OneStepWizard_Shows ()
{
var title = "1234";
var stepTitle = "ABCD";
var width = 30;
var height = 7;
AutoInitShutdownAttribute.FakeResize (new Size (width, height));
// var btnBackText = "Back";
var btnBack = string.Empty; // $"{Glyphs.LeftBracket} {btnBackText} {Glyphs.RightBracket}";
var btnNextText = "Finish"; // "Next";
var btnNext =
$"{
Glyphs.LeftBracket
}{
Glyphs.LeftDefaultIndicator
} {
btnNextText
} {
Glyphs.RightDefaultIndicator
}{
Glyphs.RightBracket
}";
var topRow =
$"{
Glyphs.ULCornerDbl
}╡{
title
} - {
stepTitle
}╞{
new (Glyphs.HLineDbl.ToString () [0], width - title.Length - stepTitle.Length - 7)
}{
Glyphs.URCornerDbl
}";
var row2 = $"{Glyphs.VLineDbl}{new (' ', width - 2)}{Glyphs.VLineDbl}";
string row3 = row2;
string row4 = row3;
var separatorRow =
$"{Glyphs.VLineDbl}{new (Glyphs.HLine.ToString () [0], width - 2)}{Glyphs.VLineDbl}";
var buttonRow =
$"{
Glyphs.VLineDbl
}{
btnBack
}{
new (' ', width - btnBack.Length - btnNext.Length - 2)
}{
btnNext
}{
Glyphs.VLineDbl
}";
var bottomRow =
$"{
Glyphs.LLCornerDbl
}{
new (Glyphs.HLineDbl.ToString () [0], width - 2)
}{
Glyphs.LRCornerDbl
}";
Wizard wizard = new () { Title = title, Width = width, Height = height };
wizard.AddStep (new() { Title = stepTitle });
//wizard.LayoutSubViews ();
RunState runstate = Application.Begin (wizard);
AutoInitShutdownAttribute.RunIteration ();
// TODO: Disabled until Dim.Auto is used in Dialog
//DriverAsserts.AssertDriverContentsWithFrameAre (
// $"{topRow}\n{row2}\n{row3}\n{row4}\n{separatorRow}\n{buttonRow}\n{bottomRow}",
// _output
// );
Application.End (runstate);
wizard.Dispose ();
}
[Fact]
[AutoInitShutdown]
// this test is needed because Wizard overrides Dialog's title behavior ("Title - StepTitle")
public void Setting_Title_Works ()
{
var d = (IConsoleDriverFacade)Application.Driver;
var title = "1234";
var stepTitle = " - ABCD";
var width = 40;
var height = 4;
d.OutputBuffer.SetWindowSize (width,height);
var btnNextText = "Finish";
var btnNext =
$"{
Glyphs.LeftBracket
}{
Glyphs.LeftDefaultIndicator
} {
btnNextText
} {
Glyphs.RightDefaultIndicator
}{
Glyphs.RightBracket
}";
var topRow =
$"{
Glyphs.ULCornerDbl
}╡{
title
}{
stepTitle
}╞{
new (Glyphs.HLineDbl.ToString () [0], width - title.Length - stepTitle.Length - 4)
}{
Glyphs.URCornerDbl
}";
var separatorRow =
$"{Glyphs.VLineDbl}{new (Glyphs.HLine.ToString () [0], width - 2)}{Glyphs.VLineDbl}";
// Once this is fixed, revert to commented out line: https://github.com/gui-cs/Terminal.Gui/issues/1791
var buttonRow =
$"{Glyphs.VLineDbl}{new (' ', width - btnNext.Length - 2)}{btnNext}{Glyphs.VLineDbl}";
//var buttonRow = $"{Glyphs.VDLine}{new String (' ', width - btnNext.Length - 2)}{btnNext}{Glyphs.VDLine}";
var bottomRow =
$"{
Glyphs.LLCornerDbl
}{
new (Glyphs.HLineDbl.ToString () [0], width - 2)
}{
Glyphs.LRCornerDbl
}";
var wizard = new Wizard { Title = title, Width = width, Height = height };
wizard.AddStep (new() { Title = "ABCD" });
Application.End (Application.Begin (wizard));
wizard.Dispose ();
}
[Fact]
// This test verifies that the 2nd step in a wizard with more than 2 steps
// shows the correct buttons on all steps
// and that the title is correct
public void ThreeStepWizard_Next_Shows_Steps ()
{
// verify step one
// Next
// verify step two
// Back
// verify step one again
}
[Fact]
// This test verifies that the 2nd step in a wizard with 2 steps
// shows the correct buttons on both steps
// and that the title is correct
public void TwoStepWizard_Next_Shows_SecondStep ()
{
// verify step one
// Next
// verify step two
// Back
// verify step one again
}
// =========== WizardStep Tests
[Fact]
public void WizardStep_ButtonText ()
{
// Verify default button text
// Verify set actually changes property
// Verify set actually changes buttons for the current step
}
[Fact]
public void WizardStep_Set_Title_Fires_TitleChanged ()
{
var r = new Window ();
Assert.Equal (string.Empty, r.Title);
var expected = string.Empty;
r.TitleChanged += (s, args) => { Assert.Equal (r.Title, args.Value); };
expected = "title";
r.Title = expected;
Assert.Equal (expected, r.Title);
expected = "another title";
r.Title = expected;
Assert.Equal (expected, r.Title);
r.Dispose ();
}
[Fact]
public void WizardStep_Set_Title_Fires_TitleChanging ()
{
var r = new Window ();
Assert.Equal (string.Empty, r.Title);
var expectedAfter = string.Empty;
var expectedDuring = string.Empty;
var cancel = false;
r.TitleChanging += (s, args) =>
{
Assert.Equal (expectedDuring, args.NewValue);
args.Cancel = cancel;
};
r.Title = expectedDuring = expectedAfter = "title";
Assert.Equal (expectedAfter, r.Title);
r.Title = expectedDuring = expectedAfter = "a different title";
Assert.Equal (expectedAfter, r.Title);
// Now setup cancelling the change and change it back to "title"
cancel = true;
r.Title = expectedDuring = "title";
Assert.Equal (expectedAfter, r.Title);
r.Dispose ();
}
[Fact]
[AutoInitShutdown]
// Verify a zero-step wizard doesn't crash and shows a blank wizard
// and that the title is correct
public void ZeroStepWizard_Shows ()
{
var title = "1234";
var stepTitle = "";
var width = 30;
var height = 6;
AutoInitShutdownAttribute.FakeResize (new Size (width, height));
var btnBackText = "Back";
var btnBack = $"{Glyphs.LeftBracket} {btnBackText} {Glyphs.RightBracket}";
var btnNextText = "Finish";
var btnNext =
$"{
Glyphs.LeftBracket
}{
Glyphs.LeftDefaultIndicator
} {
btnNextText
} {
Glyphs.RightDefaultIndicator
}{
Glyphs.RightBracket
}";
var topRow =
$"{
Glyphs.ULCornerDbl
}╡{
title
}{
stepTitle
}╞{
new (Glyphs.HLineDbl.ToString () [0], width - title.Length - stepTitle.Length - 4)
}{
Glyphs.URCornerDbl
}";
var row2 = $"{Glyphs.VLineDbl}{new (' ', width - 2)}{Glyphs.VLineDbl}";
string row3 = row2;
var separatorRow =
$"{Glyphs.VLineDbl}{new (Glyphs.HLine.ToString () [0], width - 2)}{Glyphs.VLineDbl}";
var buttonRow =
$"{
Glyphs.VLineDbl
}{
btnBack
}{
new (' ', width - btnBack.Length - btnNext.Length - 2)
}{
btnNext
}{
Glyphs.VLineDbl
}";
var bottomRow =
$"{
Glyphs.LLCornerDbl
}{
new (Glyphs.HLineDbl.ToString () [0], width - 2)
}{
Glyphs.LRCornerDbl
}";
var wizard = new Wizard { Title = title, Width = width, Height = height };
RunState runstate = Application.Begin (wizard);
// TODO: Disabled until Dim.Auto is used in Dialog
//DriverAsserts.AssertDriverContentsWithFrameAre (
// $"{topRow}\n{row2}\n{row3}\n{separatorRow}\n{buttonRow}\n{bottomRow}",
// _output
// );
Application.End (runstate);
wizard.Dispose ();
}
}