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

add some handy warnings about non-static coyote test methods. #239

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

add some handy warnings about non-static coyote test methods. #239

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8c98263
add some handy warnings about non-static coyote test methods.
lovettchris Oct 15, 2021
5dd510f
remove unused code.
lovettchris Oct 18, 2021
779f36b
Improved error messages
lovettchris Oct 18, 2021
aa9b154
Merge branch 'main' into clovett/issue238
lovettchris Mar 16, 2022
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
47 changes: 44 additions & 3 deletions Source/Test/SystematicTesting/TestMethodInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Threading.Tasks;
using Microsoft.Coyote.Actors;
using Microsoft.Coyote.IO;
Expand Down Expand Up @@ -156,8 +157,18 @@ private static (Delegate testMethod, string testName) GetTestMethod(Assembly ass
}
else if (testMethods.Count is 0)
{
throw new InvalidOperationException("Cannot detect a Coyote test method declared with the " +
$"'[{typeof(TestAttribute).FullName}]' attribute.");
// see if user forgot to make it static!
flags = BindingFlags.DeclaredOnly | BindingFlags.Instance | BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic;
testMethods = FindTestMethodsWithAttribute(typeof(TestAttribute), flags, assembly);
if (testMethods.Count > 0)
{
ReportBadTestMethods(testMethods, "test");
}
else
{
throw new InvalidOperationException($"Cannot detect a public static Coyote test method declared with the " +
$"'[{typeof(TestAttribute).FullName}]' attribute.");
}
}

MethodInfo testMethod = testMethods[0];
Expand Down Expand Up @@ -224,6 +235,29 @@ private static (Delegate testMethod, string testName) GetTestMethod(Assembly ass
return (test, $"{testMethod.DeclaringType}.{testMethod.Name}");
}

private static void ReportBadTestMethods(List<MethodInfo> testMethods, string caption)
{
StringBuilder sb = new StringBuilder();

foreach (var method in testMethods)
{
string wrong = null;
if (!method.IsStatic)
{
wrong = "not static";
}

if (!method.IsPublic)
{
wrong = string.IsNullOrEmpty(wrong) ? "not public" : wrong + " and not public";
}

sb.AppendLine($"Ignoring method '{method.DeclaringType.Name + "." + method.Name}' because it is {wrong}");
}

throw new InvalidOperationException($"The following Coyote {caption} methods cannot be used :\n{sb}");
}

/// <summary>
/// Returns the test method with the specified attribute.
/// Returns null if no such method is found.
Expand All @@ -235,6 +269,13 @@ private static MethodInfo GetTestSetupMethod(Assembly assembly, Type attribute)

if (testMethods.Count is 0)
{
flags = BindingFlags.DeclaredOnly | BindingFlags.Instance | BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic;
testMethods = FindTestMethodsWithAttribute(attribute, flags, assembly);
if (testMethods.Count > 0)
{
ReportBadTestMethods(testMethods, "test setup");
}

return null;
}
else if (testMethods.Count > 1)
Expand Down Expand Up @@ -295,7 +336,7 @@ private static List<MethodInfo> FindTestMethodsWithAttribute(Type attribute, Bin
try
{
testMethods = assembly.GetTypes().SelectMany(t => t.GetMethods(bindingFlags)).
Where(m => m.GetCustomAttributes(attribute, false).Length > 0).ToList();
Where(m => m.GetCustomAttributes(attribute, false).Any()).ToList();
}
catch (ReflectionTypeLoadException ex)
{
Expand Down