web-dev-qa-db-ja.com

パラメーター化されたテストの名前の変更

JUnit4でパラメーター化されたテストを使用するときに、独自のカスタムテストケース名を設定する方法はありますか？

デフォルトの[Test class].runTest[n] —を意味のあるものに変更したいと思います。

javajunitjunit4parameterized
190
Epaga

この機能は JUnit 4.11 。になりました

パラメータ化されたテストの名前を変更するには、次のように言います。

@Parameters(name="namestring")

namestringは文字列で、次の特別なプレースホルダーを持つことができます。

  • {index}-この引数セットのインデックス。デフォルトnamestringは{index}です。
  • {0}-このテスト呼び出しの最初のパラメーター値。
  • {1}-2番目のパラメーター値
  • 等々

以下に示すように、テストの最終的な名前は、テストメソッドの名前の後に、括弧内に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のメソッド名です）。

281
rescdsk

JUnit 4.5を見ると、そのロジックはParameterizedクラス内のプライベートクラスに埋め込まれているため、そのランナーは明らかにそれをサポートしていません。 JUnit Parameterizedランナーを使用することはできず、代わりに名前の概念を理解する独自のランナーを作成できません（名前を設定する方法についての質問につながります...）。

JUnitの観点から見ると、インクリメントを渡す代わりに（またはそれに加えて）コンマ区切りの引数を渡すといいでしょう。 TestNGはこれを行います。この機能が重要な場合は、www.junit.orgで参照されているyahooメーリングリストにコメントできます。

37
Yishai

私は最近、JUnit 4.3.1を使用しているときに同じ問題に遭遇しました。 LabelledParameterizedと呼ばれるParameterizedを拡張する新しいクラスを実装しました。 JUnit 4.3.1、4.4、および4.5を使用してテストされています。 @Parametersメソッドからの各パラメーター配列の最初の引数の文字列表現を使用して、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の複数のバージョンによってコンパイル可能です。

注：いくつかのリフレクションジグリーポケリーがあるため、上記のように異なるJUnitバージョン間で実行されます。 JUnit 4.3.1専用のバージョンは here で、JUnit 4.4および4.5の場合は here です。

20
darrenp

モデルとしてParameterizedを使用して、独自のカスタムテストランナー/スイートを作成しました。所要時間はわずか30分です。 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);
  }

}
13
David Moles

junit4.8.2からは、Parameterizedクラスをコピーするだけで、独自のMyParameterizedクラスを作成できます。 TestClassRunnerForParametersのgetName（）およびtestName（）メソッドを変更します。

6
yliang

JUnitParamsを試すこともできます。 http://code.google.com/p/junitparams/

6
dsaff

次のようなメソッドを作成できます

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

常に使用するわけではありませんが、どのテスト番号143かを正確に把握しておくと便利です。

2
Terra Caines

私は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
binkley

どれも私には役に立たなかったので、Parameterizedのソースを入手して修正し、新しいテストランナーを作成しました。あまり変更する必要はありませんでしたが、機能します!!!

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
Christian

回避策は、パラメータに関するすべての情報を含むカスタムメッセージを使用して、すべてのThrowableをキャッチして新しい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
2
mmirwaldt

アクセスされるパラメーター（たとえば、"{0}"で常にtoString()表現を返すため、回避策の1つは、匿名実装を作成し、それぞれの場合に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...
    );
}
0
Sina Madani

前述のdsaffのようにJUnitParamsをチェックしてください。antを使用して、htmlレポートにパラメーター化されたテストメソッドの説明を作成します。

これは、LabelledParameterizedを試してみたところ、Eclipseでは機能しますが、htmlレポートに関する限り、antでは機能しないことがわかったためです。

乾杯、

0
quarkonium