Зміна назв параметризованих тестів


204

Чи є спосіб встановити власні власні імена тестових випадків при використанні параметризованих тестів у JUnit4?

Я хотів би змінити типовий - [Test class].runTest[n]- на щось значиме.

Відповіді:


299

Ця функція перетворила його на 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).


4
Немає причини, щоб це не було в 4.11, це в master. Тепер, коли 4.11 буде доступний, це гарне питання :-)
Меттью Фарвелл

1
4.11 зараз знаходиться в бета-версії, і його можна завантажити з того ж посилання, що і вище :-)
rescdsk

2
Так, але є помилка. Якщо ви введете круглі дужки у значення параметра "name", як ви робите в цій публікації, воно порушує відображення імені одиничного тесту в Eclipse.
djangofan

7
великий, але що , якщо {0}і {1}масиви? JUnit в ідеалі повинен дзвонити Arrays.toString({0}), а не {0}.toString(). Наприклад, мій data()метод повертається Arrays.asList(new Object[][] {{ new int[] { 1, 3, 2 }, new int[] { 1, 2, 3 } }});.
dogbane

1
@djangofan Це помилка Eclipse для 8 років: bugs.eclipse.org/bugs/show_bug.cgi?id=102512
басейн

37

Дивлячись на JUnit 4.5, його бігун явно не підтримує це, оскільки ця логіка закопана у приватний клас всередині класу Параметризований. Ви не можете використовувати параметризований бігунок JUnit, а створити власний, який би зрозумів поняття імен (що призводить до питання, як ви можете встановити ім'я ...).

З точки зору JUnit, було б непогано, якби замість (або на додаток до) лише передачі приросту вони передавали б аргументи, розмежовані комами. TestNG робить це. Якщо ця функція важлива для вас, ви можете коментувати список розсилки yahoo, на який посилається www.junit.org.


3
Я дуже вдячний, якщо в JUnit є покращення для цього!
guerda

17
Щойно перевірено, для цього є непогашений запит на функцію: github.com/KentBeck/junit/isissue#issue/44 Будь ласка, проголосуйте за нього.
згадує

8
@Frank, я думаю, що реліз, який стосується цього питання, ще не вийшов. Це буде в JUnit 4.11. У той час (якщо припустити, що дизайн залишається колишнім) мова піде про текстовий спосіб вказати, як ви називаєте тест, включаючи прийняття параметрів як імен. Насправді приємно, насправді.
Ісіхай

5
JUnit 4.11 тепер вийшов :-)
rescdsk

7
Ось оновлене посилання на оригінальний випуск github.com/junit-team/junit/isissue/44 для подальшого ознайомлення
kldavis4

20

Нещодавно я зіткнувся з тією ж проблемою, коли користувався JUnit 4.3.1. Я реалізував новий клас, який розширює параметризований під назвою LabelledParameterized. Він був протестований за допомогою JUnit 4.3.1, 4.4 та 4.5. Він реконструює екземпляр Description за допомогою String-репрезентації першого аргументу кожного масиву параметрів методу @Parameters. Ви можете побачити код для цього:

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.


Примітка. Існує деякий спосіб відображення джиггери-покеру, щоб він працював у різних версіях JUnit, як зазначено вище. Версію, спеціально для JUnit 4.3.1, можна знайти тут, а для JUnit 4.4 та 4.5 - тут .


:-) У одного з моїх співавторів сьогодні виникла проблема, оскільки версія, на яку я вказую у вищенаведеному повідомленні, використовує JUnit 4.3.1 (а не 4.4, як я казав спочатку). Він використовує JUnit 4.5.0, і це спричинило проблеми. Я сьогодні звернуся до них.
darrenp

У мене знадобився певний час, щоб зрозуміти, що вам потрібно передати тестове ім’я в конструкторі, але не запам'ятати його. Дякуємо за код!
жираф

Чудово працює, доки я запускаю тести Eclipse. Хтось має досвід змусити його працювати з завданням JUnit Ant? Звіти про випробування названі execute[0], execute[1] ... execute[n]у створених тестових звітах.
Генрік Аастед Сьоренсен

Дуже хороша. Працює як шарм. Було б добре, якби ви могли додати інформацію, що потрібно додати "String label, ..." як перший параметр до викликаного @ Test-методу.
gia

13

З Parameterizedмоделлю, я написав свій власний користувальницький тест бігун / люкс - тільки займає близько півгодини. Він трохи відрізняється від darrenp's 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);
  }

}

6

з junit4.8.2 ви можете створити свій власний клас MyParameterized, просто скопіювавши параметризований клас. змінити методи getName () та testName () у TestClassRunnerForParameters.


Я спробував це, але не допомагає. Під час створення нового класу getParametersMethod не вдається.
java_enthu


2

Ви можете створити такий метод, як

@Test
public void name() {
    Assert.assertEquals("", inboundFileName);
}

Хоча я б не користувався цим постійно, було б корисно розібратися, який саме тест номер 143.


2

Я широко використовую статичний імпорт для Assert і друзів, тому мені легко переосмислити твердження:

private <T> void assertThat(final T actual, final Matcher<T> expected) {
    Assert.assertThat(editThisToDisplaySomethingForYourDatum, actual, expected);
}

Наприклад, ви можете додати поле "ім'я" до свого тестового класу, ініціалізованого в конструкторі, і відобразити це при відмові тесту. Просто передайте його як перші елементи масиву параметрів для кожного тесту. Це також допомагає мітити дані:

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}
    });
}

Це нормально, якщо тест не дає твердження, але є й інші випадки, наприклад, якщо викид викид, який не відповідає тесту, або якщо тест очікує, що викид буде викинутий, які змушують задуматися над назвою, яка повинна бути обробляється рамкою.
Ісіхай

2

Жодне з них не працювало для мене, тому я отримав джерело для Параметризованого та модифікованого, щоб створити новий тестовий бігун. Мені не довелося багато міняти, але це РОБОТА !!!

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;
}
}

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

0

Ознайомтеся з JUnitParams, як згадується dsaff, працює за допомогою мурахи для складання параметризованих описів методів тестування у звіті html.

Це було після спроби LabelledParameterized і виявив, що це, хоча працює з затемненням, але не працює з мурашкою, що стосується html-звіту.

Ура,


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...
    );
}
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.