我正在处理一个需要以编程方式调用TestNG的项目(使用数据提供程序)。一切都很好，只是在报告中，我们获得了@Test方法的名称，这是一个处理许多情况的通用方法。我们想要的是在报告中获得一个有意义的名称。
我研究了一下，发现了3种方法，但不幸的是，对我来说都失败了。
1)执行测试
我在这里和这里都找到了这个
我正在设置我想要的名称，只要我进入@Test方法(对于我尝试的所有3种方式，这就是我如何设置名称)。这个名称是从getTestName()返回的。我观察到的是getTestName()在@Test之前和之后被调用。最初，它返回null(为了处理NullPointerException，我返回"而不是null)，后来它返回正确的值。但我没有看到这在报告中得到反映
Edit:也尝试按照artdanil
的建议设置名称from@BeforeMethod2和3
两者都基于上面第二个链接给出的解决方案
通过在XmlSuite中重写setName，我得到
Exception in thread "main" java.lang.AssertionError: l should not be null
at org.testng.ClassMethodMap.removeAndCheckIfLast(ClassMethodMap.java:58)
at org.testng.internal.TestMethodWorker.invokeAfterClassMethods(TestMethodWorker.java:208)
at org.testng.internal.TestMethodWorker.run(TestMethodWorker.java:114)
at org.testng.TestRunner.privateRun(TestRunner.java:767)
...
通过重写toString()，我在日志中看到这些(带有我的注释)，但在报告
中没有更新[2013-03-05 14:53:22,174] (Main.java:30) - calling execute
[2013-03-05 14:53:22,346] GenericFunctionTest.<init>(GenericFunctionTest.java:52) - inside constructor
[2013-03-05 14:53:22,372] GenericFunctionTest.toString(GenericFunctionTest.java:276) - returning **//this followed by 3 invocations before arriving at @Test method**
[2013-03-05 14:53:22,410] GenericFunctionTest.toString(GenericFunctionTest.java:276) - returning
[2013-03-05 14:53:22,416] GenericFunctionTest.toString(GenericFunctionTest.java:276) - returning
[2013-03-05 14:53:22,455] GenericFunctionTest.toString(GenericFunctionTest.java:276) - returning
[2013-03-05 14:53:22,892] GenericFunctionTest.<init>(GenericFunctionTest.java:52) - inside constructor
[2013-03-05 14:53:23,178] GenericFunctionTest.toString(GenericFunctionTest.java:276) - returning **//again blank as i havent set it yet**
[2013-03-05 14:53:23,182] GenericFunctionTest.getResult(GenericFunctionTest.java:69) - inside with test case:TestCase{signature=Signature{...}}**//I am setting it immedietely after this**
[2013-03-05 14:53:23,293] GenericFunctionTest.toString(GenericFunctionTest.java:276) - returning MyMethodName **//What i want**
[2013-03-05 14:53:23,299] GenericFunctionTest.toString(GenericFunctionTest.java:276) - returning MyMethodName **// again**
编辑:通过硬编码值而不是在我的测试方法的条目上设置它再次尝试了所有3。但是同样的结果
我有同样的问题，并且发现它有助于在用@BeforeMethod注释的方法中设置存储测试用例名称的字段，使用TestNG的本地注入来提供方法名称和测试参数。试验名称取自DataProvider提供的试验参数。如果您的测试方法没有参数，只需报告方法名。
//oversimplified for demontration purposes
public class TestParameters {
private String testName = null;
private String testDescription = null;
public TestParameters(String name,
String description) {
this.testName = name;
this.testDescription = description;
}
public String getTestName() {
return testName;
}
public String getTestDescription() {
return testDescription;
}
}
public class SampleTest implements ITest {
// Has to be set to prevent NullPointerException from reporters
protected String mTestCaseName = "";
@DataProvider(name="BasicDataProvider")
public Object[][] getTestData() {
Object[][] data = new Object[][] {
{ new TestParameters("TestCase1", "Sample test 1")},
{ new TestParameters("TestCase2", "Sample test 2")},
{ new TestParameters("TestCase3", "Sample test 3")},
{ new TestParameters("TestCase4", "Sample test 4")},
{ new TestParameters("TestCase5", "Sample test 5") }
};
return data;
}
@BeforeMethod(alwaysRun = true)
public void testData(Method method, Object[] testData) {
String testCase = "";
if (testData != null && testData.length > 0) {
TestParameters testParams = null;
//Check if test method has actually received required parameters
for (Object testParameter : testData) {
if (testParameter instanceof TestParameters) {
testParams = (TestParameters)testParameter;
break;
}
}
if (testParams != null) {
testCase = testParams.getTestName();
}
}
this.mTestCaseName = String.format("%s(%s)", method.getName(), testCase);
}
@Override
public String getTestName() {
return this.mTestCaseName;
}
@Test(dataProvider="BasicDataProvider")
public void testSample1(TestParameters testParams){
//test code here
}
@Test(dataProvider="BasicDataProvider")
public void testSample2(TestParameters testParams){
//test code here
}
@Test
public void testSample3(){
//test code here
}
}
EDIT:根据下面的评论，我意识到报告中的一个示例将是有用的。
从上面运行的代码中提取报告:
<testng-results skipped="0" failed="0" total="5" passed="5">
<suite name="SampleTests" duration-ms="2818" started-at="<some-time>" finished-at="<some-time>">
<test name="Test1" duration-ms="2818" started-at="<some-time>" finished-at="<some-time>">
<test-method
status="PASS"
signature="testSample1(org.example.test.TestParameters)[pri:0, instance:org.example.test.TimeTest@c9d92c]"
test-instance-name="testSample1(TestCase5)"
name="testSample1"
duration-ms="1014"
started-at="<some-time-before>"
data-provider="BasicDataProvider"
finished-at="<some-time-later>" >
<!-- excluded for demonstration purposes -->
</test-method>
<!-- the rest of test results excluded for brevity -->
</test>
</suite>
</testng-result>
注意，getTestName()方法返回的值在test-instance-name属性中，不在name属性中。
我遇到了一个类似的问题。首先，我实现了前面提到的ITest策略。这是解决方案的一部分，但不是全部。
TestNG，由于某种原因，在构建不同的报告时，在构建报告时对测试调用getName()。如果您没有使用数据提供程序来生成不同的运行，并通过使用ittest策略为每次运行设置唯一的名称，那么这很好。如果您使用数据提供程序生成同一测试的多个运行，并希望每个运行都有一个唯一的名称，那么就会出现问题。因为ittest策略将测试的名称保留为上次运行设置的名称。
所以我必须实现一个非常自定义的getName()。一些假设(在我的特殊情况下):
- 只运行三个报告:TestHTMLReporter, EmailableReporter, xmlsuiteresultwwriter。
- 当某个假定的报告器没有调用get name时，返回当前设置的名称就可以了。
- 当报告程序运行时，它按顺序调用getName()，每次运行只调用1次。
public String getTestName()
{
String name = testName;
StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();//.toString();
if(calledFrom(stackTrace, "XMLSuiteResultWriter"))
{
name = testNames.size()>0?testNames.get(xmlNameIndex<testNames.size()?xmlNameIndex:0):"undefined";
xmlNameIndex++;
if(xmlNameIndex>=testNames.size())
xmlNameIndex = 0;
}
else if(calledFrom(stackTrace, "EmailableReporter"))
{
name = testNames.size()>0?testNames.get(emailNameIndex<testNames.size()?emailNameIndex:0):"undefined";
emailNameIndex++;
if(emailNameIndex>=testNames.size())
emailNameIndex = 0;
}
if(calledFrom(stackTrace, "TestHTMLReporter"))
{
if(testNames.size()<0)
{
name = "undefined";
}
else
{
if(htmlNameIndex < testNamesFailed.size())
{
name = testNamesFailed.get(htmlNameIndex);
}
else
{
int htmlPassedIndex = htmlNameIndex - testNamesFailed.size();
if(htmlPassedIndex < testNamesPassed.size())
{
name = testNamesPassed.get(htmlPassedIndex);
}
else
{
name = "undefined";
}
}
}
htmlNameIndex++;
if(htmlNameIndex>=testNames.size())
htmlNameIndex = 0;
}
return name;
}
private boolean calledFrom(StackTraceElement[] stackTrace, String checkForMethod)
{
boolean calledFrom = false;
for(StackTraceElement element : stackTrace)
{
String stack = element.toString();
if(stack.contains(checkForMethod))
calledFrom = true;
}
return calledFrom;
}
当为运行设置名称时(我在@BeforeMethod(alwaysRun=true)方法中这样做了，我在测试策略之后定义)，我将名称添加到ArrayList testNames中。但是html报告是不正确的。大多数其他报告都是按顺序提取信息的，比如xmlsuiteresultwwriter，但TestHTMLReporter是先获取失败测试的所有名称，然后再获取通过测试的名称来获取名称的。所以我必须实现额外的ArrayLists: testNamesFailed和testNamesPassed，并在测试完成时根据测试是否通过添加测试名称。
我坦率地承认，这是一个非常黑客和非常脆弱。理想情况下，TestNG在运行时将测试添加到集合中，并从该集合而不是从原始测试中获取名称。如果你有TestNG来运行其他报告，你必须弄清楚它们请求名称的顺序，以及在线程堆栈跟踪中搜索的唯一字符串是什么。
——编辑1
或者，使用ittest策略和工厂模式(@factory注释)。
TestNG使用@Factory和@DataProvider
http://beust.com/weblog/2004/09/27/testngs-factory/确实需要一些小改动。这包括创建一个具有与原始测试方法相同参数的构造函数。测试方法现在没有参数。您可以在新的构造函数中设置名称，并在getTestName方法中返回该名称。确保从测试方法中删除数据提供程序规范。
如果您想更改HTML报告中的名称，这将是一个完全的hack。我是这样做的:
public class NinjaTest {
...
...
@AfterMethod (alwaysRun = true)
public void afterMethod(ITestResult result, Method method) {
try {
//I have XML test suites organized in directories.
String xmlFile = result.getTestContext().getCurrentXmlTest().getSuite().getFileName();
String suiteName = xmlFile.substring(xmlFile.lastIndexOf("\") + 1, xmlFile.lastIndexOf(".xml"));
String pathToFile = xmlFile.substring(0, xmlFile.lastIndexOf("\") );
String directory = pathToFile.substring(pathToFile.lastIndexOf("\") + 1);
String testMethodName = String.format("%s/%s - %s", directory, suiteName, method.getName());
//Total hack to change display name in HTML report ＼(^o^)／
Field methodName = org.testng.internal.BaseTestMethod.class.getDeclaredField("m_methodName");
methodName.setAccessible(true);
methodName.set(result.getMethod(), testMethodName);
} catch (Exception e) {
// Eh.... ¯_(ツ)_/¯
e.printStackTrace();
}
}
...
...
在TestNG报告中设置自定义名称的代码如下:
下列功能在此代码中可用:
- 同一测试用例在多个时间内的动态执行
- 为报告设置自定义测试用例名称
-
设置多个测试用例并行执行
import java.lang.reflect.Field; import org.testng.ITest; import org.testng.ITestResult; import org.testng.Reporter; import org.testng.annotations.AfterMethod; import org.testng.annotations.DataProvider; import org.testng.annotations.Factory; import org.testng.annotations.Test; import org.testng.internal.BaseTestMethod; import com.test.data.ServiceProcessData; public class ServiceTest implements ITest { protected ServiceProcessData serviceProcessData; protected String testCaseName = ""; @Test public void executeServiceTest() { System.out.println(this.serviceProcessData.toString()); } @Factory(dataProvider = "processDataList") public RiskServiceTest(ServiceProcessData serviceProcessData) { this.serviceProcessData = serviceProcessData; } @DataProvider(name = "processDataList", parallel = true) public static Object[] getProcessDataList() { Object[] serviceProcessDataList = new Object[0]; //Set data in serviceProcessDataList return serviceProcessDataList; } @Override public String getTestName() { this.testCaseName = "User custom testcase name"; return this.testCaseName; } @AfterMethod(alwaysRun = true) public void setResultTestName(ITestResult result) { try { BaseTestMethod baseTestMethod = (BaseTestMethod) result.getMethod(); Field f = baseTestMethod.getClass().getSuperclass().getDeclaredField("m_methodName"); f.setAccessible(true); f.set(baseTestMethod, this.testCaseName); } catch (Exception e) { ErrorMessageHelper.getInstance().setErrorMessage(e); Reporter.log("Exception : " + e.getMessage()); } }}谢谢
artdanil的回答并没有完全解决我的问题，email报告中没有更新测试名。
@jersey-city-ninja发布的答案确实更新了Emailable报告中的名称，但它重复了所有数据提供程序值的相同更新的testname，因为pilotg2发布的内容对于消费数据提供程序的测试是正确的，即getTestName方法不断返回方法的最后一组名称，并且数据提供程序的所有testname都是相同的。所以这里是答案，这是由@pilotg2和@jersey-city-ninja发布的答案的组合，并有额外的步骤来克服重复的方法名称。
注意将更新Emailable报告、XML报告、HTML报告、Junit报告中的testname。我没有看到它在更新Eclipse——TestNg执行视图——如果我发现了什么，它会更新的
import org.testng.Assert;
import org.testng.ITest;
import org.testng.ITestContext;
import org.testng.ITestResult;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
public class NewDataProviderTest implements ITest {
//The Java ThreadLocal class enables you to create variables that can only be read and written by the same thread
private ThreadLocal<String> testName = new ThreadLocal<>();
/*
* TestNG, for some reason, when building different reports, calls getName() on the test while building the report.
* This is fine if you are not using a data provider to generate different runs and set a unique name for each run by using the ITest strategy.
* If you are using a data provider to generate multiple runs of the same test and want each run to have a unique name then there is a problem.
* As the ITest strategy returns the name for the test as the name set by the last run.
* */
private int emailNameIndex = 0;
private int htmlNameIndex = 0;
private int xmlNameIndex = 0;
private ArrayList<String> allTests = new ArrayList<String>();
/*
* TestHTMLReporter gets the name by first getting all the names for failed tests and then the names for passing tests
* Hence keeping them in 2 separate lists
* */
private ArrayList<String> passedTests = new ArrayList<String>();
private ArrayList<String> failedTests = new ArrayList<String>();
@BeforeClass(alwaysRun = true)
public void initialize() {
this.testName.set("");
}
@BeforeMethod(alwaysRun = true)
public void setCustomTestcaseName(Method method, Object[] testData) {
//Set the default name
this.testName.set(method.getName());
//Change the test name only if Dataprovider is used
//Check if data provider is used in the test
if (testData != null && testData.length > 0) {
System.out.println("nnParameters "+testData[0]+" are passed to the test - "+method.getName());
//Taking 1st field in the Dataprovider for updating testname - can be changed as desired maybe using a variable
//I'm changing the name only if the Dataprovider field is String
if (testData[0] instanceof String) {
//Taking 1st field in the Dataprovider for updating testname - can be changed as desired
System.out.println("I'm setting custom name to the test as "+method.getName() + "_" + testData[0]);
this.testName.set(method.getName() + "_" + testData[0]);
}
}
//Add the name to the collection that stores all list names
allTests.add(testName.get());
}
@AfterMethod (alwaysRun = true)
public void setTheTestcaseNameInResult(ITestResult result, Method method) {
//Fill the Passed and Failed tests collections
try {
if(result.getStatus() == ITestResult.SUCCESS) {
System.out.println("Adding "+ result.getTestName() + " to passed tests collection");
passedTests.add(result.getTestName());
}
if(result.getStatus() == ITestResult.FAILURE) {
System.out.println("Adding " + result.getTestName() + " to FAILURE tests collection");
failedTests.add(result.getTestName());
}
} catch (Exception e) {
e.printStackTrace();
}
// To change display name in HTML report
//Only changing the name if the parameter is instance of String
if(iTestResult.getParameters().length > 0) {
if (iTestResult.getParameters()[0] instanceof String) {
System.out.println("Updating the name as Parameters are passed to the test-"+method.getName());
try {
/* This helps in setting unique name to method for each test instance for a data provider*/
Field resultMethod = TestResult.class.getDeclaredField("m_method");
resultMethod.setAccessible(true);
resultMethod.set(iTestResult, iTestResult.getMethod().clone());
Field methodName = org.testng.internal.BaseTestMethod.class.getDeclaredField("m_methodName");
methodName.setAccessible(true);
methodName.set(iTestResult.getMethod(), this.getTestName());
} catch (Exception e) {
e.printStackTrace();
}
System.out.println("New Name is - " + iTestResult.getMethod().getMethodName());
}
}
}
@Override
public String getTestName() {
String name = testName.get();
StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();// .toString();
//This is called
if (isCalledFromMethod(stackTrace, "XMLSuiteResultWriter")) {
//System.out.println("Got called from XMLSuiteResultWriter");
if (allTestNames.size() > 0) {
if (xmlNameIndex < allTestNames.size()) {
name = allTestNames.get(xmlNameIndex);
} else {
name = allTestNames.get(0);
}
} else {
name = "undefined";
}
xmlNameIndex++;
if (xmlNameIndex >= allTestNames.size()) {
xmlNameIndex = 0;
}
// System.out.println("Got called from XMLSuiteResultWriter returning name - "+name);
} else if (isCalledFromMethod(stackTrace, "EmailableReporter")) {
if (allTestNames.size() > 0) {
if (emailNameIndex < allTestNames.size()) {
name = allTestNames.get(emailNameIndex);
} else {
name = allTestNames.get(0);
}
} else {
name = "undefined";
}
emailNameIndex++;
if (emailNameIndex >= allTestNames.size()) {
emailNameIndex = 0;
}
System.out.println("Got called from EmailableReporter returning name -"+name);
}
if (isCalledFromMethod(stackTrace, "TestHTMLReporter")) {
if (allTestNames.size() <= 0) {
name = "undefined";
} else {
if (htmlNameIndex < failedTestNames.size()) {
name = failedTestNames.get(htmlNameIndex);
} else {
int htmlPassedIndex = htmlNameIndex - failedTestNames.size();
if (htmlPassedIndex < passedTestNames.size()) {
name = passedTestNames.get(htmlPassedIndex);
} else {
name = "undefined";
}
}
}
htmlNameIndex++;
if (htmlNameIndex >= allTestNames.size()) {
htmlNameIndex = 0;
}
System.out.println("Got called from TestHTMLReporter returning name - "+name);
}
System.out.println("Returning testname as-"+name);
return name;
}
private boolean isCalledFromMethod(StackTraceElement[] stackTrace, String checkForMethod) {
boolean calledFrom = false;
for (StackTraceElement element : stackTrace) {
String stack = element.toString();
// System.out.println("Rohit the called from value is:"+stack);
if (stack.contains(checkForMethod))
calledFrom = true;
}
return calledFrom;
}
@Test(groups= {"L1", "L2", "L3"}, dataProvider = "dp1")
public void dataProviderTest(String username) {
System.out.println("nnI'm in dataProviderTest with data-"+username);
/* Fail the test if value is L2 - deliberately so that we have failed test in report */
if(username.contains("L2")) {
Assert.fail();
}
}
@Test(dependsOnMethods = "dataProviderTest", groups= {"L1", "L2", "L3"}, dataProvider = "dp1")
public void dataProviderDependentTest(String username) {
System.out.println("nnI'm in dataProvider DEPENDENT Test with data-"+username);
}
//This test consumes data of type list so the name will not be updated in report
@Test(groups= {"L1", "L2", "L3"}, dataProvider = "dp2")
public void dataListProviderTest(List<String[]> list) {
Object[] arr = list.get(0);
List<Object> arrList = Arrays.asList(arr);
Iterator<Object> iterator = arrList.iterator();
while (iterator.hasNext()) {
String[] data = (String[]) iterator.next();
System.out.println("In list test - "+data[0]);
}
}
@DataProvider(name="dp1")
public Object[][] getDataForTest(ITestContext iTestContext){
Object[][] L1 = new Object[][] {
{"L1"}, {"L2"}, {"L3"}
};
return L1;
}
@DataProvider(name="dp2")
public Object[][] getDataListForTest(ITestContext iTestContext){
List<Object[][]> list = new ArrayList<Object[][]>();
Object[][] L1 = new Object[][] {
new String [] {"L1", "l1"},
new String [] {"L1", "l1"}
};
list.add(L1);
return new Object[][] { { list } };
}
}
尝试实现需要getTestName()方法的org.testng.ITest接口。这样报表就可以正确地处理返回值。
遇到同样的问题，我们是这样解决的:
问题是所有的ITestResult结果对象共享一个单一的ITestNGMethod对象实例，所以当方法名被改变时，它会影响所有的结果。
:org.testng.reporters.XMLSuiteResultWriter # getTestResultAttributes
attributes.setProperty(XMLReporterConfig.ATTR_NAME, testResult.getMethod().getMethodName());
正在从testResult.getMethod().getMethodName()中读取name属性
基本上我们为每个结果克隆了方法对象，因此每个结果都可以有一个独立的getMethod()。
我们添加了以下代码:
@AfterMethod(alwaysRun = true)
public void setResultTestName(ITestResult result, ITestContext context) {
try {
BaseTestMethod baseTestMethod = (BaseTestMethod) result.getMethod().clone();
String featureName = StringUtils.substringBetween(result.getParameters()[1].toString(), "[", "]");
String scenarioName = result.getParameters()[0].toString().replace(""", "");
Field f = baseTestMethod.getClass().getSuperclass().getDeclaredField("m_methodName");
f.setAccessible(true);
f.set(baseTestMethod, featureName + " - " + scenarioName);
f = result.getClass().getDeclaredField("m_method");
f.setAccessible(true);
f.set(result, baseTestMethod);
} catch (Exception e) {
e.printStackTrace();
}
}