Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix bugs in parent class init/cleanup logic #660

Merged
merged 6 commits into from
Dec 20, 2019
Merged

Fix bugs in parent class init/cleanup logic #660

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7158165
Adding UT to catch issue where base class cleanup isn't called if not…
NGloreous Nov 19, 2019
e46cdf0
Fixing test
NGloreous Nov 19, 2019
60ca008
Fix issue where base class cleanup isn't called when there is no top …
NGloreous Nov 19, 2019
40e6fa9
Add test to catch null ref ex when grandparent test class has class i…
NGloreous Nov 20, 2019
e4e01f4
Fix null ref ex when grandparent test class has class init/cleanup me…
NGloreous Nov 20, 2019
8002eda
Addressing PR feedback
NGloreous Dec 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions src/Adapter/MSTest.CoreAdapter/Execution/TestClassInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,12 @@ public bool HasExecutableCleanupMethod
{
get
{
if (this.BaseClassCleanupMethodsStack.Any())
{
// If any base cleanups were pushed to the stack we need to run them
return true;
}

// If no class cleanup, then continue with the next one.
if (this.ClassCleanupMethod == null)
{
Expand Down Expand Up @@ -274,7 +280,11 @@ public void RunClassInitialize(TestContext testContext)
var baseInitCleanupMethods = baseClassInitializeStack.Pop();
initializeMethod = baseInitCleanupMethods.Item1;
initializeMethod?.InvokeAsSynchronousTask(null, testContext);
this.BaseClassCleanupMethodsStack.Push(baseInitCleanupMethods.Item2);

if (baseInitCleanupMethods.Item2 != null)
{
this.BaseClassCleanupMethodsStack.Push(baseInitCleanupMethods.Item2);
}
}
}
catch (Exception ex)
Expand Down Expand Up @@ -355,16 +365,16 @@ public void RunClassInitialize(TestContext testContext)
[SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Justification = "Requirement is to handle all kinds of user exceptions and message appropriately.")]
public string RunClassCleanup()
{
if (this.ClassCleanupMethod is null && !this.BaseClassInitAndCleanupMethods.Any(p => p.Item2 != null))
if (this.ClassCleanupMethod is null && !this.BaseClassCleanupMethodsStack.Any())
NGloreous marked this conversation as resolved.
Show resolved Hide resolved
{
return null;
}

if (this.IsClassInitializeExecuted || this.ClassInitializeMethod is null || this.BaseClassCleanupMethodsStack.Any())
{
var classCleanupMethod = this.ClassCleanupMethod;
try
{
var classCleanupMethod = this.ClassCleanupMethod;
classCleanupMethod?.InvokeAsSynchronousTask(null);
var baseClassCleanupQueue = new Queue<MethodInfo>(this.BaseClassCleanupMethodsStack);
while (baseClassCleanupQueue.Count > 0)
Expand Down
14 changes: 6 additions & 8 deletions src/Adapter/MSTest.CoreAdapter/Execution/TypeCache.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,17 +485,15 @@ private void UpdateInfoWithInitializeAndCleanupMethods(
TestClassInfo classInfo,
ref MethodInfo[] initAndCleanupMethods)
{
if (initAndCleanupMethods is null)
if (initAndCleanupMethods.Any(x => x != null))
NGloreous marked this conversation as resolved.
Show resolved Hide resolved
{
return;
classInfo.BaseClassInitAndCleanupMethods.Enqueue(
new Tuple<MethodInfo, MethodInfo>(
initAndCleanupMethods.FirstOrDefault(),
initAndCleanupMethods.LastOrDefault()));
}

classInfo.BaseClassInitAndCleanupMethods.Enqueue(
new Tuple<MethodInfo, MethodInfo>(
initAndCleanupMethods.FirstOrDefault(),
initAndCleanupMethods.LastOrDefault()));

initAndCleanupMethods = null;
initAndCleanupMethods = new MethodInfo[2];
}

/// <summary>
Expand Down
34 changes: 24 additions & 10 deletions test/UnitTests/MSTest.CoreAdapter.Unit.Tests/Execution/TestClassInfoTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,16 +431,6 @@ public void RunClassInitializeShouldThrowForAlreadyExecutedTestClassInitWithExce
exception.Message);
}

[TestMethod]
public void RunClassCleanupShouldInvokeIfClassCleanupMethod()
{
var classcleanupCallCount = 0;
DummyTestClass.ClassCleanupMethodBody = () => classcleanupCallCount++;
this.testClassInfo.ClassCleanupMethod = typeof(DummyTestClass).GetMethod("ClassCleanupMethod");
Assert.IsNull(this.testClassInfo.RunClassCleanup());
Assert.AreEqual(1, classcleanupCallCount);
}

[TestMethod]
public void RunAssemblyInitializeShouldPassOnTheTestContextToAssemblyInitMethod()
{
Expand All @@ -454,6 +444,16 @@ public void RunAssemblyInitializeShouldPassOnTheTestContextToAssemblyInitMethod(

#region Run Class Cleanup tests

[TestMethod]
public void RunClassCleanupShouldInvokeIfClassCleanupMethod()
{
var classcleanupCallCount = 0;
DummyTestClass.ClassCleanupMethodBody = () => classcleanupCallCount++;
this.testClassInfo.ClassCleanupMethod = typeof(DummyTestClass).GetMethod("ClassCleanupMethod");
Assert.IsNull(this.testClassInfo.RunClassCleanup());
Assert.AreEqual(1, classcleanupCallCount);
}

[TestMethod]
public void RunClassCleanupShouldNotInvokeIfClassCleanupIsNull()
{
Expand Down Expand Up @@ -500,6 +500,20 @@ public void RunClassCleanupShouldReturnExceptionDetailsOfNonAssertExceptions()
"Class Cleanup method DummyTestClass.ClassCleanupMethod failed. Error Message: System.ArgumentException: Argument Exception. Stack Trace: at Microsoft.VisualStudio.TestPlatform.MSTestAdapter.UnitTests.Execution.TestClassInfoTests.<>c.<RunClassCleanupShouldReturnExceptionDetailsOfNonAssertExceptions>");
}

[TestMethod]
public void RunBaseClassCleanupEvenIfThereIsNoTopLevelClassCleanup()
NGloreous marked this conversation as resolved.
Show resolved Hide resolved
{
var classcleanupCallCount = 0;
DummyBaseTestClass.ClassCleanupMethodBody = () => classcleanupCallCount++;

this.testClassInfo.ClassCleanupMethod = null;
this.testClassInfo.BaseClassCleanupMethodsStack.Push(typeof(DummyBaseTestClass).GetMethod("CleanupClassMethod"));

Assert.IsTrue(this.testClassInfo.HasExecutableCleanupMethod);
Assert.IsNull(this.testClassInfo.RunClassCleanup());
Assert.AreEqual(1, classcleanupCallCount, "DummyBaseTestClass.CleanupClassMethod call count");
}

#endregion

[DummyTestClass]
Expand Down
100 changes: 94 additions & 6 deletions test/UnitTests/MSTest.CoreAdapter.Unit.Tests/Execution/TypeCacheTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,8 @@ public void GetTestMethodInfoShouldCacheClassInitializeAttribute()
false);

Assert.AreEqual(1, this.typeCache.ClassInfoCache.Count());
Assert.AreEqual(type.GetMethod("AssemblyInit"), this.typeCache.ClassInfoCache.ToArray()[0].ClassInitializeMethod);
Assert.AreEqual(0, this.typeCache.ClassInfoCache.First().BaseClassInitAndCleanupMethods.Count);
Assert.AreEqual(type.GetMethod("AssemblyInit"), this.typeCache.ClassInfoCache.First().ClassInitializeMethod);
}

[TestMethodV1]
Expand Down Expand Up @@ -489,8 +490,8 @@ public void GetTestMethodInfoShouldCacheBaseClassInitializeAttributes()

Assert.AreEqual(1, this.typeCache.ClassInfoCache.Count());
Assert.AreEqual(1, this.typeCache.ClassInfoCache.ToArray()[0].BaseClassInitAndCleanupMethods.Count);
Assert.AreEqual(null, this.typeCache.ClassInfoCache.ToArray()[0].BaseClassInitAndCleanupMethods.First().Item2);
Assert.AreEqual(baseType.GetMethod("AssemblyInit"), this.typeCache.ClassInfoCache.ToArray()[0].BaseClassInitAndCleanupMethods.First().Item1);
Assert.IsNull(this.typeCache.ClassInfoCache.First().BaseClassInitAndCleanupMethods.First().Item2, "No base class cleanup");
Assert.AreEqual(baseType.GetMethod("AssemblyInit"), this.typeCache.ClassInfoCache.First().BaseClassInitAndCleanupMethods.First().Item1);
}

[TestMethodV1]
Expand Down Expand Up @@ -536,9 +537,9 @@ public void GetTestMethodInfoShouldCacheBaseClassCleanupAttributes()
false);

Assert.AreEqual(1, this.typeCache.ClassInfoCache.Count());
Assert.AreEqual(1, this.typeCache.ClassInfoCache.ToArray()[0].BaseClassInitAndCleanupMethods.Count);
Assert.AreEqual(null, this.typeCache.ClassInfoCache.ToArray()[0].BaseClassInitAndCleanupMethods.First().Item1);
Assert.AreEqual(baseType.GetMethod("AssemblyCleanup"), this.typeCache.ClassInfoCache.ToArray()[0].BaseClassInitAndCleanupMethods.First().Item2);
Assert.AreEqual(1, this.typeCache.ClassInfoCache.First().BaseClassInitAndCleanupMethods.Count);
Assert.IsNull(this.typeCache.ClassInfoCache.First().BaseClassInitAndCleanupMethods.First().Item1, "No base class init");
Assert.AreEqual(baseType.GetMethod("AssemblyCleanup"), this.typeCache.ClassInfoCache.First().BaseClassInitAndCleanupMethods.First().Item2);
}

[TestMethodV1]
Expand Down Expand Up @@ -608,6 +609,72 @@ public void GetTestMethodInfoShouldCacheBaseClassInitAndCleanupAttributes()
Assert.AreEqual(baseCleanupMethod, this.typeCache.ClassInfoCache.ToArray()[0].BaseClassInitAndCleanupMethods.First().Item2);
}

[TestMethodV1]
public void GetTestMethodInfoShouldCacheParentAndGrandparentClassInitAndCleanupAttributes()
{
var grandparentType = typeof(DummyBaseTestClassWithInitAndCleanupMethods);
var parentType = typeof(DummyChildBaseTestClassWithInitAndCleanupMethods);
var type = typeof(DummyTestClassWithParentAndGrandparentInitAndCleanupMeethods);

var grandparentInitMethod = grandparentType.GetMethod("ClassInit");
var grandparentCleanupMethod = grandparentType.GetMethod("ClassCleanup");
var parentInitMethod = parentType.GetMethod("ChildClassInit");
var parentCleanupMethod = parentType.GetMethod("ChildClassCleanup");

this.mockReflectHelper
.Setup(rh => rh.IsAttributeDefined(type, typeof(UTF.TestClassAttribute), true))
.Returns(true);

// Setup grandparent class init/cleanup methods
this.mockReflectHelper
.Setup(rh => rh.IsAttributeDefined(grandparentInitMethod, typeof(UTF.ClassInitializeAttribute), false))
.Returns(true);
this.mockReflectHelper
.Setup(rh => rh.GetCustomAttribute(grandparentInitMethod, typeof(UTF.ClassInitializeAttribute)))
.Returns(new UTF.ClassInitializeAttribute(UTF.InheritanceBehavior.BeforeEachDerivedClass));
this.mockReflectHelper
.Setup(rh => rh.IsAttributeDefined(grandparentCleanupMethod, typeof(UTF.ClassCleanupAttribute), false))
.Returns(true);
this.mockReflectHelper
.Setup(rh => rh.GetCustomAttribute(grandparentCleanupMethod, typeof(UTF.ClassCleanupAttribute)))
.Returns(new UTF.ClassCleanupAttribute(UTF.InheritanceBehavior.BeforeEachDerivedClass));

// Setup parent class init/cleanup methods
this.mockReflectHelper
.Setup(rh => rh.IsAttributeDefined(parentInitMethod, typeof(UTF.ClassInitializeAttribute), false))
.Returns(true);
this.mockReflectHelper
.Setup(rh => rh.GetCustomAttribute(parentInitMethod, typeof(UTF.ClassInitializeAttribute)))
.Returns(new UTF.ClassInitializeAttribute(UTF.InheritanceBehavior.BeforeEachDerivedClass));
this.mockReflectHelper
.Setup(rh => rh.IsAttributeDefined(parentCleanupMethod, typeof(UTF.ClassCleanupAttribute), false))
.Returns(true);
this.mockReflectHelper
.Setup(rh => rh.GetCustomAttribute(parentCleanupMethod, typeof(UTF.ClassCleanupAttribute)))
.Returns(new UTF.ClassCleanupAttribute(UTF.InheritanceBehavior.BeforeEachDerivedClass));

var testMethod = new TestMethod("TestMethod", type.FullName, "A", isAsync: false);
this.typeCache.GetTestMethodInfo(
testMethod,
new TestContextImplementation(testMethod, null, new Dictionary<string, object>()),
false);

var classInfo = this.typeCache.ClassInfoCache.FirstOrDefault();
Assert.AreEqual(1, this.typeCache.ClassInfoCache.Count());
Assert.IsNull(classInfo.ClassInitializeMethod);
Assert.IsNull(classInfo.ClassCleanupMethod);

Assert.AreEqual(2, classInfo.BaseClassInitAndCleanupMethods.Count);

var parentInitAndCleanup = classInfo.BaseClassInitAndCleanupMethods.Dequeue();
Assert.AreEqual(parentInitMethod, parentInitAndCleanup.Item1);
Assert.AreEqual(parentCleanupMethod, parentInitAndCleanup.Item2);

var grandparentInitAndCleanup = classInfo.BaseClassInitAndCleanupMethods.Dequeue();
Assert.AreEqual(grandparentInitMethod, grandparentInitAndCleanup.Item1);
Assert.AreEqual(grandparentCleanupMethod, grandparentInitAndCleanup.Item2);
}

[TestMethodV1]
public void GetTestMethodInfoShouldThrowIfClassInitHasIncorrectSignature()
{
Expand Down Expand Up @@ -1573,6 +1640,27 @@ public void TestInitOrCleanup()
}
}

[DummyTestClass]
private class DummyChildBaseTestClassWithInitAndCleanupMethods : DummyBaseTestClassWithInitAndCleanupMethods
{
[UTF.ClassInitialize(UTF.InheritanceBehavior.BeforeEachDerivedClass)]
public static void ChildClassInit(UTFExtension.TestContext tc)
{
}

public static void ChildClassCleanup()
{
}
}

[DummyTestClass]
private class DummyTestClassWithParentAndGrandparentInitAndCleanupMeethods : DummyChildBaseTestClassWithInitAndCleanupMethods
{
public void TestMethod()
{
}
}

[DummyTestClass]
private class DummyTestClassWithIncorrectInitializeMethods
{
Expand Down