Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2026-01-01 00:46:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix issue where the TestViewsDisposeCorrectly was not doing what it was supposed to do (#2964)

Browse Source 
* add Disposal Test and fix an ssue where the CopyClipboard test was failing

* Update ViewDisposalTest.cs

* Update ViewDisposalTest.cs: Some Formatting, and adding code comments.

* Fix ViewDisposalTests (Wasn't working the way it was supposed to)

* update test

* update test

* update test

* try to fix as many conflicts as possible

* make test output prettier

* fix formatting

* Fix Subviews not being empty after disposing on all views.

* The fail cause was Application.Top not being disposed.

* Fix others containers that weren't being removed.

* Revert "The fail cause was Application.Top not being disposed."

This reverts commit 0c2183ed9e.

* Application.Top isn't null and need disposing.

* Fixes #2985. Application.RunState must be responsible for dispose the Toplevel property.

* Change the unit test with ans without Application.Shutdown method.

* Update ViewDisposeTests to actually check wether ALL views have been disposed (not just container)

* small additional check just to be safe

* Update ViewDisposalTest.cs: Formatting

* Update ViewDisposalTest.cs: Minor change to re-trigger Action

TestVKPacket is acting up again. Maybe the test is running async and is receiving scan codes from other instances?

---------

Co-authored-by: John Züchler <john.zuechler@eks-intec.de>
Co-authored-by: BDisp <bd.bdisp@gmail.com>
Co-authored-by: Tig <tig@users.noreply.github.com>
This commit is contained in:
usr
2023-11-15 17:22:22 +01:00
committed by GitHub
parent 91865eed22
commit c7942ae3bb
12 changed files with 140 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
UnitTests/Views/ViewDisposalTest.cs
View File

@@ -1,3 +1,4 @@
using SixLabors.ImageSharp.Processing.Processors.Quantization;
using System;
using System.Collections.Generic;
using System.Linq;
@@ -23,21 +24,38 @@ namespace UnitTests.ViewsTests {
}
}
[Fact]
[AutoInitShutdown]
public void TestViewsDisposeCorrectly ()
[Theory]
[InlineData (true)]
[InlineData (false)]
public void TestViewsDisposeCorrectly (bool callShutdown)
{
var reference = DoTest ();
for (var i = 0; i < 10 && reference.IsAlive; i++) {
var refs = DoTest (callShutdown);
//var reference = refs [0];
for (var i = 0; i < 10 && refs [0].IsAlive; i++) {
GC.Collect ();
GC.WaitForPendingFinalizers ();
}
foreach (var reference in refs) {
if (reference.IsAlive) {
#if DEBUG_IDISPOSABLE
if (reference.IsAlive) {
Assert.True (((View)reference.Target).WasDisposed);
Assert.Fail ($"Some Views didnt get Garbage Collected: {((View)reference.Target).Subviews}");
}
Assert.True (((View)reference.Target).WasDisposed);
#endif
string alive = ""; // Instead of just checking the subviews of the container, we now iterate through a list
foreach (var r in refs) { // of Weakreferences Referencing every View that was tested. This makes more sense because
if (r.IsAlive) { // View.Dispose removes all of its subviews, wich is why View.Subviews is always empty
if (r == refs [0]) { // after View.Dispose has run. Luckily I didnt discover any more bugs or this wouldv'e
alive += "\n View (Container)"; // been a little bit annoying to find an answer for. Thanks to BDisp for listening to
} // me and giving his best to help me fix this thing. If you take a look at the commit log
alive += ",\n--"; // you will find that he did most of the work. -a-usr
alive += r.Target.GetType ().Name;
} // NOTE: DELETE BEFORE NEXT COMMIT
}
Assert.Fail ($"Some Views didnt get Garbage Collected: {alive}");
}
}
if (!callShutdown) {
Application.Shutdown ();
}
}
void getSpecialParams ()
@@ -46,11 +64,16 @@ namespace UnitTests.ViewsTests {
//special_params.Add (typeof (LineView), new object [] { Orientation.Horizontal });
}
WeakReference DoTest ()
List<WeakReference> DoTest (bool callShutdown)
{
var driver = new FakeDriver ();
Application.Init (driver, new FakeMainLoop (driver));
getSpecialParams ();
View Container = new View ();
Toplevel top = Application.Top;
List<WeakReference> refs = new List<WeakReference> { new WeakReference (Container, true) };
Container.Add (new View ());
Toplevel top = new ();
var state = Application.Begin (top);
var views = GetViews ();
foreach (var view in views) {
View instance;
@@ -63,6 +86,8 @@ namespace UnitTests.ViewsTests {
Assert.NotNull (instance);
Container.Add (instance);
refs.Add (new WeakReference (instance, true));
output.WriteLine ($"Added instance of {view}!");
}
top.Add (Container);
@@ -72,9 +97,22 @@ namespace UnitTests.ViewsTests {
}
top.Remove (Container);
WeakReference reference = new (Container, true);
Application.End (state);
Assert.True (refs.All (r => r.IsAlive));
#if DEBUG_IDISPOSABLE
Assert.True (top.WasDisposed);
Assert.False (Container.WasDisposed);
#endif
Assert.Null (Application.Top);
Container.Dispose ();
return reference;
#if DEBUG_IDISPOSABLE
Assert.True (Container.WasDisposed);
#endif
if (callShutdown) {
Application.Shutdown ();
}
return refs;
}
/// <summary>