在JUnit4中使用参数化测试时,有没有办法设置我自己的自定义测试用例名称?
我想将默认值 - [Test class].runTest[n]
- 更改为有意义的内容。
答案 0 :(得分:270)
此功能已进入JUnit 4.11。
要使用更改参数化测试的名称,请说:
@Parameters(name="namestring")
namestring
是一个字符串,可以包含以下特殊占位符:
{index}
- 这组参数的索引。默认 namestring
为{index}
。{0}
- 此测试调用的第一个参数值。{1}
- 第二个参数值测试的最终名称将是测试方法的名称,后面是括号中的 namestring
。如下所示。
例如(改编自Parameterized
注释的单元测试):
@RunWith(Parameterized.class)
static public class FibonacciTest {
@Parameters( name = "{index}: fib({0})={1}" )
public static Iterable<Object[]> data() {
return Arrays.asList(new Object[][] { { 0, 0 }, { 1, 1 }, { 2, 1 },
{ 3, 2 }, { 4, 3 }, { 5, 5 }, { 6, 8 } });
}
private final int fInput;
private final int fExpected;
public FibonacciTest(int input, int expected) {
fInput= input;
fExpected= expected;
}
@Test
public void testFib() {
assertEquals(fExpected, fib(fInput));
}
private int fib(int x) {
// TODO: actually calculate Fibonacci numbers
return 0;
}
}
会提供testFib[1: fib(1)=1]
和testFib[4: fib(4)=3]
等名称。 (名称的testFib
部分是@Test
)的方法名称。
答案 1 :(得分:37)
看看JUnit 4.5,它的运行者显然不支持它,因为该逻辑被隐藏在Parameterized类内的私有类中。您无法使用JUnit参数化运行器,而是创建您自己的运行器,这将理解名称的概念(这导致您可能如何设置名称的问题......)。
从JUnit的角度来看,如果不是(或除了)只传递一个增量,它们会传递逗号分隔的参数。 TestNG就是这么做的。如果该功能对您很重要,您可以在www.junit.org上引用的yahoo邮件列表上发表评论。
答案 2 :(得分:20)
我最近在使用JUnit 4.3.1时遇到了同样的问题。我实现了一个扩展Parameterized的新类,名为LabelledParameterized。它已使用JUnit 4.3.1,4.4和4.5进行了测试。它使用@Parameters方法中每个参数数组的第一个参数的String表示来重构Description实例。您可以在以下位置查看此代码:
http://code.google.com/p/migen/source/browse/trunk/java/src/.../LabelledParameterized.java?r=3789
以及在
中使用的一个例子http://code.google.com/p/migen/source/browse/trunk/java/src/.../ServerBuilderTest.java?r=3789
测试描述在Eclipse中很好地格式化,这是我想要的,因为这使得失败的测试更容易找到!我可能会在接下来的几天/几周内进一步完善和记录课程。放下'?'如果你想要最前沿的URL的一部分。 : - )
要使用它,您所要做的就是复制该类(GPL v3),并将@RunWith(Parameterized.class)更改为@RunWith(LabelledParameterized.class),假设参数列表的第一个元素是一个合理的标签
我不知道JUnit的任何后续版本是否解决了这个问题,但即使他们这样做了,我也无法更新JUnit,因为我的所有联合开发人员也必须更新,我们的优先级高于重新加工。因此,类中的工作可以由多个版本的JUnit进行编译。
注意:有一些反射jiggery-pokery,以便它运行在上面列出的不同JUnit版本上。可以找到专门针对JUnit 4.3.1的版本here,对于JUnit 4.4和4.5,here。
答案 3 :(得分:13)
以Parameterized
为模型,我编写了自己的自定义测试运行器/套件 - 只花了大约半小时。它与darrenp的LabelledParameterized
略有不同,因为它允许您明确指定名称,而不是依赖第一个参数toString()
。
它也不使用数组,因为我讨厌数组。 :)
public class PolySuite extends Suite {
// //////////////////////////////
// Public helper interfaces
/**
* Annotation for a method which returns a {@link Configuration}
* to be injected into the test class constructor
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public static @interface Config {
}
public static interface Configuration {
int size();
Object getTestValue(int index);
String getTestName(int index);
}
// //////////////////////////////
// Fields
private final List<Runner> runners;
// //////////////////////////////
// Constructor
/**
* Only called reflectively. Do not use programmatically.
* @param c the test class
* @throws Throwable if something bad happens
*/
public PolySuite(Class<?> c) throws Throwable {
super(c, Collections.<Runner>emptyList());
TestClass testClass = getTestClass();
Class<?> jTestClass = testClass.getJavaClass();
Configuration configuration = getConfiguration(testClass);
List<Runner> runners = new ArrayList<Runner>();
for (int i = 0, size = configuration.size(); i < size; i++) {
SingleRunner runner = new SingleRunner(jTestClass, configuration.getTestValue(i), configuration.getTestName(i));
runners.add(runner);
}
this.runners = runners;
}
// //////////////////////////////
// Overrides
@Override
protected List<Runner> getChildren() {
return runners;
}
// //////////////////////////////
// Private
private Configuration getConfiguration(TestClass testClass) throws Throwable {
return (Configuration) getConfigMethod(testClass).invokeExplosively(null);
}
private FrameworkMethod getConfigMethod(TestClass testClass) {
List<FrameworkMethod> methods = testClass.getAnnotatedMethods(Config.class);
if (methods.isEmpty()) {
throw new IllegalStateException("@" + Config.class.getSimpleName() + " method not found");
}
if (methods.size() > 1) {
throw new IllegalStateException("Too many @" + Config.class.getSimpleName() + " methods");
}
FrameworkMethod method = methods.get(0);
int modifiers = method.getMethod().getModifiers();
if (!(Modifier.isStatic(modifiers) && Modifier.isPublic(modifiers))) {
throw new IllegalStateException("@" + Config.class.getSimpleName() + " method \"" + method.getName() + "\" must be public static");
}
return method;
}
// //////////////////////////////
// Helper classes
private static class SingleRunner extends BlockJUnit4ClassRunner {
private final Object testVal;
private final String testName;
SingleRunner(Class<?> testClass, Object testVal, String testName) throws InitializationError {
super(testClass);
this.testVal = testVal;
this.testName = testName;
}
@Override
protected Object createTest() throws Exception {
return getTestClass().getOnlyConstructor().newInstance(testVal);
}
@Override
protected String getName() {
return testName;
}
@Override
protected String testName(FrameworkMethod method) {
return testName + ": " + method.getName();
}
@Override
protected void validateConstructor(List<Throwable> errors) {
validateOnlyOneConstructor(errors);
}
@Override
protected Statement classBlock(RunNotifier notifier) {
return childrenInvoker(notifier);
}
}
}
一个例子:
@RunWith(PolySuite.class)
public class PolySuiteExample {
// //////////////////////////////
// Fixture
@Config
public static Configuration getConfig() {
return new Configuration() {
@Override
public int size() {
return 10;
}
@Override
public Integer getTestValue(int index) {
return index * 2;
}
@Override
public String getTestName(int index) {
return "test" + index;
}
};
}
// //////////////////////////////
// Fields
private final int testVal;
// //////////////////////////////
// Constructor
public PolySuiteExample(int testVal) {
this.testVal = testVal;
}
// //////////////////////////////
// Test
@Ignore
@Test
public void odd() {
assertFalse(testVal % 2 == 0);
}
@Test
public void even() {
assertTrue(testVal % 2 == 0);
}
}
答案 4 :(得分:6)
答案 5 :(得分:6)
您可能还想尝试JUnitParams:http://code.google.com/p/junitparams/
答案 6 :(得分:2)
您可以创建类似
的方法@Test
public void name() {
Assert.assertEquals("", inboundFileName);
}
虽然我不会一直使用它,但确切地确定哪个测试编号143是有用的。
答案 7 :(得分:2)
我广泛使用Assert和朋友的静态导入,所以我很容易重新定义断言:
private <T> void assertThat(final T actual, final Matcher<T> expected) {
Assert.assertThat(editThisToDisplaySomethingForYourDatum, actual, expected);
}
例如,您可以在测试类中添加“name”字段,在构造函数中初始化,并在测试失败时显示该字段。只需将其作为参数数组的第一个元素传递给每个测试。这也有助于标记数据:
public ExampleTest(final String testLabel, final int one, final int two) {
this.testLabel = testLabel;
// ...
}
@Parameters
public static Collection<Object[]> data() {
return asList(new Object[][]{
{"first test", 3, 4},
{"second test", 5, 6}
});
}
答案 8 :(得分:2)
这些都不适合我,所以我获得了参数化的来源并修改了它创建了一个新的测试运行器。我不需要做太多改变,但IT工作!!!
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import org.junit.Assert;
import org.junit.internal.runners.ClassRoadie;
import org.junit.internal.runners.CompositeRunner;
import org.junit.internal.runners.InitializationError;
import org.junit.internal.runners.JUnit4ClassRunner;
import org.junit.internal.runners.MethodValidator;
import org.junit.internal.runners.TestClass;
import org.junit.runner.notification.RunNotifier;
public class LabelledParameterized extends CompositeRunner {
static class TestClassRunnerForParameters extends JUnit4ClassRunner {
private final Object[] fParameters;
private final String fParameterFirstValue;
private final Constructor<?> fConstructor;
TestClassRunnerForParameters(TestClass testClass, Object[] parameters, int i) throws InitializationError {
super(testClass.getJavaClass()); // todo
fParameters = parameters;
if (parameters != null) {
fParameterFirstValue = Arrays.asList(parameters).toString();
} else {
fParameterFirstValue = String.valueOf(i);
}
fConstructor = getOnlyConstructor();
}
@Override
protected Object createTest() throws Exception {
return fConstructor.newInstance(fParameters);
}
@Override
protected String getName() {
return String.format("%s", fParameterFirstValue);
}
@Override
protected String testName(final Method method) {
return String.format("%s%s", method.getName(), fParameterFirstValue);
}
private Constructor<?> getOnlyConstructor() {
Constructor<?>[] constructors = getTestClass().getJavaClass().getConstructors();
Assert.assertEquals(1, constructors.length);
return constructors[0];
}
@Override
protected void validate() throws InitializationError {
// do nothing: validated before.
}
@Override
public void run(RunNotifier notifier) {
runMethods(notifier);
}
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public static @interface Parameters {
}
private final TestClass fTestClass;
public LabelledParameterized(Class<?> klass) throws Exception {
super(klass.getName());
fTestClass = new TestClass(klass);
MethodValidator methodValidator = new MethodValidator(fTestClass);
methodValidator.validateStaticMethods();
methodValidator.validateInstanceMethods();
methodValidator.assertValid();
int i = 0;
for (final Object each : getParametersList()) {
if (each instanceof Object[])
add(new TestClassRunnerForParameters(fTestClass, (Object[]) each, i++));
else
throw new Exception(String.format("%s.%s() must return a Collection of arrays.", fTestClass.getName(), getParametersMethod().getName()));
}
}
@Override
public void run(final RunNotifier notifier) {
new ClassRoadie(notifier, fTestClass, getDescription(), new Runnable() {
public void run() {
runChildren(notifier);
}
}).runProtected();
}
private Collection<?> getParametersList() throws IllegalAccessException, InvocationTargetException, Exception {
return (Collection<?>) getParametersMethod().invoke(null);
}
private Method getParametersMethod() throws Exception {
List<Method> methods = fTestClass.getAnnotatedMethods(Parameters.class);
for (Method each : methods) {
int modifiers = each.getModifiers();
if (Modifier.isStatic(modifiers) && Modifier.isPublic(modifiers))
return each;
}
throw new Exception("No public static parameters method on class " + getName());
}
public static Collection<Object[]> eachOne(Object... params) {
List<Object[]> results = new ArrayList<Object[]>();
for (Object param : params)
results.add(new Object[] { param });
return results;
}
}
答案 9 :(得分:2)
解决方法是捕获并将所有Throwables嵌套到一个新的Throwable中,并使用包含有关参数的所有信息的自定义消息。该消息将出现在堆栈跟踪中。 只要测试对所有断言,错误和异常都失败,这都适用,因为它们都是Throwable的子类。
我的代码如下所示:
@RunWith(Parameterized.class)
public class ParameterizedTest {
int parameter;
public ParameterizedTest(int parameter) {
super();
this.parameter = parameter;
}
@Parameters
public static Collection<Object[]> data() {
return Arrays.asList(new Object[][] { {1}, {2} });
}
@Test
public void test() throws Throwable {
try {
assertTrue(parameter%2==0);
}
catch(Throwable thrown) {
throw new Throwable("parameter="+parameter, thrown);
}
}
}
失败测试的堆栈跟踪是:
java.lang.Throwable: parameter=1
at sample.ParameterizedTest.test(ParameterizedTest.java:34)
Caused by: java.lang.AssertionError
at org.junit.Assert.fail(Assert.java:92)
at org.junit.Assert.assertTrue(Assert.java:43)
at org.junit.Assert.assertTrue(Assert.java:54)
at sample.ParameterizedTest.test(ParameterizedTest.java:31)
... 31 more
答案 10 :(得分:0)
以dsaff提到的方式查看JUnitParams,使用ant在html报告中构建参数化测试方法描述。
这是在尝试使用LabelledParameterized并发现它虽然它与eclipse一起工作时,但就html报告而言,它不适用于ant。
干杯,
答案 11 :(得分:0)
由于访问的参数(例如,使用"{0}"
始终返回toString()
表示,因此一种解决方法是进行匿名实现并在每种情况下覆盖toString()
。例如:
public static Iterable<? extends Object> data() {
return Arrays.asList(
new MyObject(myParams...) {public String toString(){return "my custom test name";}},
new MyObject(myParams...) {public String toString(){return "my other custom test name";}},
//etc...
);
}
答案 12 :(得分:0)
参数化测试在内部调用 toString()
。
如果您创建一个覆盖 toString()
的对象包装器,它将更改测试的名称。
这是一个例子,我在其他帖子中回答过。 https://stackoverflow.com/a/67023556/1839360