web-dev-qa-db-ja.com

jUnitのfixtureSetupを静的にする必要があるのはなぜですか?

メソッドをjUnitの@BeforeClassアノテーションでマークし、静的でなければならないという例外を受け取りました。根拠は何ですか?これは、私の知る限り、正当な理由がない限り、すべての初期化を静的フィールドに強制します。

.Net(NUnit)では、これは当てはまりません。

編集-@BeforeClassアノテーションが付けられたメソッドが一度だけ実行されるという事実は、静的メソッドであることとは関係ありません-非静的メソッドを一度だけ実行することができます(NUnitのように)。

104
ripper234

JUnitalwaysは、@ Testメソッドごとにテストクラスのインスタンスを1つ作成します。 これは基本的な設計上の決定です 副作用のないテストを簡単に記述できるようにします。良いテストには実行順序の依存関係がありません( F.I.R.S.T を参照)。テストクラスの新しいインスタンスと各テストのインスタンス変数を作成することは、これを達成するために重要です。一部のテストフレームワークは、すべてのテストで同じテストクラスインスタンスを再利用するため、テスト間で誤って副作用が発生する可能性が高くなります。

また、各テストメソッドには独自のインスタンスがあるため、@ BeforeClass/@ AfterClassメソッドをインスタンスメソッドにすることは意味がありません。それ以外の場合、どのテストクラスインスタンスでメソッドを呼び出す必要がありますか? @ BeforeClass/@ AfterClassメソッドがインスタンス変数を参照できる場合、@ Testメソッドの1つだけが同じインスタンス変数にアクセスできます-残りのインスタンス変数はデフォルト値になります-.classファイル内のメソッドの順序は指定されていない/コンパイラに依存するため、@ Testメソッドがランダムに選択されます(IIRC、JavaのリフレクションAPIはメソッドを返します.classファイルで宣言されているのと同じ順序で動作しますが、その動作も指定されていません-実際に行番号で並べ替えるために a library と書いています)。

したがって、これらのメソッドを静的にすることは唯一の妥当な解決策です。

以下に例を示します。

public class ExampleTest {

    @BeforeClass
    public static void beforeClass() {
        System.out.println("beforeClass");
    }

    @AfterClass
    public static void afterClass() {
        System.out.println("afterClass");
    }

    @Before
    public void before() {
        System.out.println(this + "\tbefore");
    }

    @After
    public void after() {
        System.out.println(this + "\tafter");
    }

    @Test
    public void test1() {
        System.out.println(this + "\ttest1");
    }

    @Test
    public void test2() {
        System.out.println(this + "\ttest2");
    }

    @Test
    public void test3() {
        System.out.println(this + "\ttest3");
    }
}

どの印刷:

beforeClass
ExampleTest@3358fd70    before
ExampleTest@3358fd70    test1
ExampleTest@3358fd70    after
ExampleTest@6293068a    before
ExampleTest@6293068a    test2
ExampleTest@6293068a    after
ExampleTest@22928095    before
ExampleTest@22928095    test3
ExampleTest@22928095    after
afterClass

ご覧のとおり、各テストは独自のインスタンスで実行されます。 JUnitが行うことは基本的にこれと同じです。

ExampleTest.beforeClass();

ExampleTest t1 = new ExampleTest();
t1.before();
t1.test1();
t1.after();

ExampleTest t2 = new ExampleTest();
t2.before();
t2.test2();
t2.after();

ExampleTest t3 = new ExampleTest();
t3.before();
t3.test3();
t3.after();

ExampleTest.afterClass();
118
Esko Luontola

短い答えはこれです:静的であるという正当な理由はありません。

実際、Junitを使用してDBUnitベースのDAO統合テストを実行する場合、静的にすると、あらゆる種類の問題が発生します。静的な要件は、依存性注入、アプリケーションコンテキストアクセス、リソース処理、ロギング、および「getClass」に依存するあらゆるものを妨害します。

40
HDave

JUnitのドキュメントは不足しているように見えますが、おそらく、JUnitは各テストケースを実行する前にテストクラスの新しいインスタンスを作成するため、「フィクスチャ」状態を実行間で維持する唯一の方法は、静的にすることです。 FixtureSetup(@BeforeClassメソッド)が静的であることを確認することにより実施されます。

12
Blair Conrad

これは元の質問には答えませんが。明らかなフォローアップに答えます。クラスの前後およびテストの前後に機能するルールを作成する方法。

これを実現するには、次のパターンを使用できます。

@ClassRule
public static JPAConnection jpaConnection = JPAConnection.forUITest("my-persistence-unit");

@Rule
public JPAConnection.EntityManager entityManager = jpaConnection.getEntityManager();

Before(Class)でJPAConnectionは一度接続を作成し、after(Class)で閉じます。

getEntityMangerは、jpaのEntityManagerを実装し、JPAConnection内の接続にアクセスできるjpaConnectionの内部クラスを返します。 before(test)でトランザクションを開始し、after(test)で再びロールバックします。

これはスレッドセーフではありませんが、そうすることができます。

JPAConnection.classの選択されたコード

package com.triodos.general.junit;

import com.triodos.log.Logger;
import org.jetbrains.annotations.NotNull;
import org.junit.rules.ExternalResource;

import javax.persistence.EntityManagerFactory;
import javax.persistence.EntityTransaction;
import javax.persistence.FlushModeType;
import javax.persistence.LockModeType;
import javax.persistence.Persistence;
import javax.persistence.Query;
import javax.persistence.TypedQuery;
import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.metamodel.Metamodel;
import Java.util.HashMap;
import Java.util.Map;

import static com.google.common.base.Preconditions.checkState;
import static com.triodos.dbconn.DB2DriverManager.DRIVERNAME_TYPE4;
import static com.triodos.dbconn.UnitTestProperties.getDatabaseConnectionProperties;
import static com.triodos.dbconn.UnitTestProperties.getPassword;
import static com.triodos.dbconn.UnitTestProperties.getUsername;
import static Java.lang.String.valueOf;
import static Java.sql.Connection.TRANSACTION_READ_UNCOMMITTED;

public final class JPAConnectionExample extends ExternalResource {

  private static final Logger LOG = Logger.getLogger(JPAConnectionExample.class);

  @NotNull
  public static JPAConnectionExample forUITest(String persistenceUnitName) {
    return new JPAConnectionExample(persistenceUnitName)
        .setManualEntityManager();
  }

  private final String persistenceUnitName;
  private EntityManagerFactory entityManagerFactory;
  private javax.persistence.EntityManager jpaEntityManager = null;
  private EntityManager entityManager;

  private JPAConnectionExample(String persistenceUnitName) {
    this.persistenceUnitName = persistenceUnitName;
  }

  @NotNull
  private JPAConnectionExample setEntityManager(EntityManager entityManager) {
    this.entityManager = entityManager;
    return this;
  }

  @NotNull
  private JPAConnectionExample setManualEntityManager() {
    return setEntityManager(new RollBackAfterTestEntityManager());
  }


  @Override
  protected void before() {
    entityManagerFactory = Persistence.createEntityManagerFactory(persistenceUnitName, createEntityManagerProperties());
    jpaEntityManager = entityManagerFactory.createEntityManager();
  }

  @Override
  protected void after() {

    if (jpaEntityManager.getTransaction().isActive()) {
      jpaEntityManager.getTransaction().rollback();
    }

    if(jpaEntityManager.isOpen()) {
      jpaEntityManager.close();
    }
    // Free for garbage collection as an instance
    // of EntityManager may be assigned to a static variable
    jpaEntityManager = null;

    entityManagerFactory.close();
    // Free for garbage collection as an instance
    // of JPAConnection may be assigned to a static variable
    entityManagerFactory = null;
  }

  private Map<String,String> createEntityManagerProperties(){
    Map<String, String> properties = new HashMap<>();
    properties.put("javax.persistence.jdbc.url", getDatabaseConnectionProperties().getURL());
    properties.put("javax.persistence.jtaDataSource", null);
    properties.put("hibernate.connection.isolation", valueOf(TRANSACTION_READ_UNCOMMITTED));
    properties.put("hibernate.connection.username", getUsername());
    properties.put("hibernate.connection.password", getPassword());
    properties.put("hibernate.connection.driver_class", DRIVERNAME_TYPE4);
    properties.put("org.hibernate.readOnly", valueOf(true));

    return properties;
  }

  @NotNull
  public EntityManager getEntityManager(){
    checkState(entityManager != null);
    return entityManager;
  }


  private final class RollBackAfterTestEntityManager extends EntityManager {

    @Override
    protected void before() throws Throwable {
      super.before();
      jpaEntityManager.getTransaction().begin();
    }

    @Override
    protected void after() {
      super.after();

      if (jpaEntityManager.getTransaction().isActive()) {
        jpaEntityManager.getTransaction().rollback();
      }
    }
  }

  public abstract class EntityManager extends ExternalResource implements javax.persistence.EntityManager {

    @Override
    protected void before() throws Throwable {
      checkState(jpaEntityManager != null, "JPAConnection was not initialized. Is it a @ClassRule? Did the test runner invoke the rule?");

      // Safety-close, if failed to close in setup
      if (jpaEntityManager.getTransaction().isActive()) {
        jpaEntityManager.getTransaction().rollback();
        LOG.error("EntityManager encountered an open transaction at the start of a test. Transaction has been closed but should have been closed in the setup method");
      }
    }

    @Override
    protected void after() {
      checkState(jpaEntityManager != null, "JPAConnection was not initialized. Is it a @ClassRule? Did the test runner invoke the rule?");
    }

    @Override
    public final void persist(Object entity) {
      jpaEntityManager.persist(entity);
    }

    @Override
    public final <T> T merge(T entity) {
      return jpaEntityManager.merge(entity);
    }

    @Override
    public final void remove(Object entity) {
      jpaEntityManager.remove(entity);
    }

    @Override
    public final <T> T find(Class<T> entityClass, Object primaryKey) {
      return jpaEntityManager.find(entityClass, primaryKey);
    }

    @Override
    public final <T> T find(Class<T> entityClass, Object primaryKey, Map<String, Object> properties) {
      return jpaEntityManager.find(entityClass, primaryKey, properties);
    }

    @Override
    public final <T> T find(Class<T> entityClass, Object primaryKey, LockModeType lockMode) {
      return jpaEntityManager.find(entityClass, primaryKey, lockMode);
    }

    @Override
    public final <T> T find(Class<T> entityClass, Object primaryKey, LockModeType lockMode, Map<String, Object> properties) {
      return jpaEntityManager.find(entityClass, primaryKey, lockMode, properties);
    }

    @Override
    public final <T> T getReference(Class<T> entityClass, Object primaryKey) {
      return jpaEntityManager.getReference(entityClass, primaryKey);
    }

    @Override
    public final void flush() {
      jpaEntityManager.flush();
    }

    @Override
    public final void setFlushMode(FlushModeType flushMode) {
      jpaEntityManager.setFlushMode(flushMode);
    }

    @Override
    public final FlushModeType getFlushMode() {
      return jpaEntityManager.getFlushMode();
    }

    @Override
    public final void lock(Object entity, LockModeType lockMode) {
      jpaEntityManager.lock(entity, lockMode);
    }

    @Override
    public final void lock(Object entity, LockModeType lockMode, Map<String, Object> properties) {
      jpaEntityManager.lock(entity, lockMode, properties);
    }

    @Override
    public final void refresh(Object entity) {
      jpaEntityManager.refresh(entity);
    }

    @Override
    public final void refresh(Object entity, Map<String, Object> properties) {
      jpaEntityManager.refresh(entity, properties);
    }

    @Override
    public final void refresh(Object entity, LockModeType lockMode) {
      jpaEntityManager.refresh(entity, lockMode);
    }

    @Override
    public final void refresh(Object entity, LockModeType lockMode, Map<String, Object> properties) {
      jpaEntityManager.refresh(entity, lockMode, properties);
    }

    @Override
    public final void clear() {
      jpaEntityManager.clear();
    }

    @Override
    public final void detach(Object entity) {
      jpaEntityManager.detach(entity);
    }

    @Override
    public final boolean contains(Object entity) {
      return jpaEntityManager.contains(entity);
    }

    @Override
    public final LockModeType getLockMode(Object entity) {
      return jpaEntityManager.getLockMode(entity);
    }

    @Override
    public final void setProperty(String propertyName, Object value) {
      jpaEntityManager.setProperty(propertyName, value);
    }

    @Override
    public final Map<String, Object> getProperties() {
      return jpaEntityManager.getProperties();
    }

    @Override
    public final Query createQuery(String qlString) {
      return jpaEntityManager.createQuery(qlString);
    }

    @Override
    public final <T> TypedQuery<T> createQuery(CriteriaQuery<T> criteriaQuery) {
      return jpaEntityManager.createQuery(criteriaQuery);
    }

    @Override
    public final <T> TypedQuery<T> createQuery(String qlString, Class<T> resultClass) {
      return jpaEntityManager.createQuery(qlString, resultClass);
    }

    @Override
    public final Query createNamedQuery(String name) {
      return jpaEntityManager.createNamedQuery(name);
    }

    @Override
    public final <T> TypedQuery<T> createNamedQuery(String name, Class<T> resultClass) {
      return jpaEntityManager.createNamedQuery(name, resultClass);
    }

    @Override
    public final Query createNativeQuery(String sqlString) {
      return jpaEntityManager.createNativeQuery(sqlString);
    }

    @Override
    public final Query createNativeQuery(String sqlString, Class resultClass) {
      return jpaEntityManager.createNativeQuery(sqlString, resultClass);
    }

    @Override
    public final Query createNativeQuery(String sqlString, String resultSetMapping) {
      return jpaEntityManager.createNativeQuery(sqlString, resultSetMapping);
    }

    @Override
    public final void joinTransaction() {
      jpaEntityManager.joinTransaction();
    }

    @Override
    public final <T> T unwrap(Class<T> cls) {
      return jpaEntityManager.unwrap(cls);
    }

    @Override
    public final Object getDelegate() {
      return jpaEntityManager.getDelegate();
    }

    @Override
    public final void close() {
      jpaEntityManager.close();
    }

    @Override
    public final boolean isOpen() {
      return jpaEntityManager.isOpen();
    }

    @Override
    public final EntityTransaction getTransaction() {
      return jpaEntityManager.getTransaction();
    }

    @Override
    public final EntityManagerFactory getEntityManagerFactory() {
      return jpaEntityManager.getEntityManagerFactory();
    }

    @Override
    public final CriteriaBuilder getCriteriaBuilder() {
      return jpaEntityManager.getCriteriaBuilder();
    }

    @Override
    public final Metamodel getMetamodel() {
      return jpaEntityManager.getMetamodel();
    }
  }
}
3
mpkorstanje

JUnitは各テストメソッドに対してテストクラスの新しいインスタンスを作成するようです。このコードを試してください

public class TestJunit
{

    int count = 0;

    @Test
    public void testInc1(){
        System.out.println(count++);
    }

    @Test
    public void testInc2(){
        System.out.println(count++);
    }

    @Test
    public void testInc3(){
        System.out.println(count++);
    }
}

出力は0 0 0です

これは、@ BeforeClassメソッドが静的でない場合、各テストメソッドの前に実行する必要があり、@ Beforeと@BeforeClassのセマンティクスを区別する方法がないことを意味します。

2
randomuser

注釈には2つのタイプがあります。

  • @BeforeClass(@AfterClass)テストクラスごとに1回呼び出される
  • @Before(および@After)各テストの前に呼び出される

そのため、@ BeforeClassは一度呼び出されるため、静的と宣言する必要があります。また、テスト間で適切な「状態」の伝播を保証する唯一の方法であることを考慮する必要があります(JUnitモデルは@Testごとに1つのテストインスタンスを課します)。Javaでは静的メソッドのみが静的データにアクセスできるため... @BeforeClassと@AfterClassは、静的メソッドにのみ適用できます。

このテスト例では、@ BeforeClassと@Beforeの使用法を明確にする必要があります。

public class OrderTest {

    @BeforeClass
    public static void beforeClass() {
        System.out.println("before class");
    }

    @AfterClass
    public static void afterClass() {
        System.out.println("after class");
    }

    @Before
    public void before() {
        System.out.println("before");
    }

    @After
    public void after() {
        System.out.println("after");
    }    

    @Test
    public void test1() {
        System.out.println("test 1");
    }

    @Test
    public void test2() {
        System.out.println("test 2");
    }
}

出力:

 -------------標準出力--------------- 
 classbefore 
 before 
テスト1 
 after 
 before 
テスト2 
 after 
 afterクラス
 -------- ----- ---------------- --------------- 
1
dfa

JUnit 5のように、テストメソッドごとに厳密に新しいインスタンスを作成するという哲学は多少緩められているようです。テストクラスを1回だけインスタンス化する アノテーション を追加しました。したがって、この注釈では、@ BeforeAll/@ AfterAll(@ BeforeClass/@ AfterClassの置換)で注釈が付けられたメソッドを非静的にすることもできます。したがって、次のようなテストクラス:

@TestInstance(Lifecycle.PER_CLASS)
class TestClass() {
    Object object;

    @BeforeAll
    void beforeAll() {
        object = new Object();
    }

    @Test
    void testOne() {
        System.out.println(object);
    }

    @Test
    void testTwo() {
        System.out.println(object);
    }
}

印刷します:

Java.lang.Object@799d4f69
Java.lang.Object@799d4f69

したがって、テストクラスごとにオブジェクトを実際にインスタンス化できます。もちろん、これにより、この方法でインスタンス化されたオブジェクトの変更を避けるのはあなた自身の責任となります。

0
EJJ