如何在运行时从单元测试中获取单元测试方法名称

本文关键字:单元 获取 测试方法 单元测试 运行时 | 更新日期: 2023-09-27 18:27:42

如何从单元内测试中获取单元测试名称?

我在BaseTestFixture类中有以下方法:

public string GetCallerMethodName()
{
    var stackTrace = new StackTrace();
    StackFrame stackFrame = stackTrace.GetFrame(1);
    MethodBase methodBase = stackFrame.GetMethod();
    return methodBase.Name;
}

我的Test Fixture类继承自基本类:

[TestFixture]
public class WhenRegisteringUser : BaseTestFixture
{
}

我有以下系统测试:

[Test]
public void ShouldRegisterThenVerifyEmailThenSignInSuccessfully_WithValidUsersAndSites()
{
    string testMethodName = this.GetCallerMethodName();
    //
}

当我在VisualStudio中运行它时,它会按预期返回我的测试方法名称。

当它由TeamCity运行时,会返回_InvokeMethodFast(),这似乎是TeamCity在运行时生成的供自己使用的方法。

那么,如何在运行时获取测试方法名称呢?

如何在运行时从单元测试中获取单元测试方法名称

如果您使用NUnit 2.5.7/2.6,您可以使用TestContext类:

[Test]
public void ShouldRegisterThenVerifyEmailThenSignInSuccessfully()
{
    string testMethodName = TestContext.CurrentContext.Test.Name;
}

使用Visual Studio运行测试时,如果在测试类中添加TestContext属性,则可以轻松获得这些信息。

[TestClass]
public class MyTestClass
{
    public TestContext TestContext { get; set; }
    [TestInitialize]
    public void setup()
    {
        logger.Info(" SETUP " + TestContext.TestName);
        // .... //
    }
}

如果您不使用NUnit,您可以在堆栈上循环并找到测试方法:

foreach(var stackFrame in stackTrace.GetFrames()) {
  MethodBase methodBase = stackFrame.GetMethod();
  Object[] attributes = methodBase.GetCustomAttributes(typeof(TestAttribute), false);
  if (attributes.Length >= 1) {
    return methodBase.Name;
  } 
}
return "Not called from a test method";

谢谢大家;我使用了一种组合方法,所以它现在适用于所有环境:

public string GetTestMethodName()
{
    try
    {
        // for when it runs via TeamCity
        return TestContext.CurrentContext.Test.Name;
    }
    catch
    {
        // for when it runs via Visual Studio locally
        var stackTrace = new StackTrace(); 
        foreach (var stackFrame in stackTrace.GetFrames())
        {
            MethodBase methodBase = stackFrame.GetMethod();
            Object[] attributes = methodBase.GetCustomAttributes(
                                      typeof(TestAttribute), false); 
            if (attributes.Length >= 1)
            {
                return methodBase.Name;
            }
        }
        return "Not called from a test method";  
    }
}

如果您没有使用Nunit或任何其他第三方工具。您将不会得到TestAttribute

所以您可以这样做来获得测试方法名称。使用TestMethodAttribute代替TestAttribute

    public string GetTestMethodName()
    {
            // for when it runs via Visual Studio locally
            var stackTrace = new StackTrace();
            foreach (var stackFrame in stackTrace.GetFrames())
            {
                MethodBase methodBase = stackFrame.GetMethod();
                Object[] attributes = methodBase.GetCustomAttributes(typeof(TestMethodAttribute), false);
                if (attributes.Length >= 1)
                {
                    return methodBase.Name;
                }
            }
            return "Not called from a test method";
    }