Управление транзакциями

В фреймворке TestContext транзакции управляются с помощью TransactionalTestExecutionListener, который настроен по умолчанию, даже если явно аннотация @TestExecutionListeners явно не объявлена в своем тестовом классе. Однако, чтобы активировать средства поддержки транзакций, необходимо сконфигурировать бин PlatformTransactionManager в ApplicationContext, который загружается с семантикой аннотации @ContextConfiguration (более подробная информация будет представлена позже). Кроме того, нужно объявить для ваших тестов аннотацию @Transactional из Spring либо на уровне класса, либо на уровне метода.

Транзакции, управляемые тестированием

Управляемые тестами транзакции – это транзакции, которые управляются декларативно при помощи TransactionalTestExecutionListener или программно при помощи TestTransaction (описано далее). Не следует путать такие транзакции с транзакциями, управляемыми Spring (управляемыми непосредственно через фреймворк Spring в ApplicationContext, загруженном для тестов) или транзакциями, управляемыми приложением (управляемыми программно в коде приложения, который вызывается тестами). Управляемые Spring и управляемые приложением транзакции обычно участвуют в управляемых тестами транзакциях. Однако следует соблюдать осторожность, если транзакции, управляемые Spring или приложением, сконфигурированы с использованием любого типа распространения, кроме REQUIRED или SUPPORTS (подробнее см. описание в подразделе, посвященному распространению транзакций ).

Активация и дезактивация транзакций

Аннотирование тестового метода с помощью @Transactional приводит к тому, что тест запускается в транзакции, которая по умолчанию автоматически откатывается после завершения теста. Если тестовый класс помечен аннотацией @Transactional, то каждый тестовый метод в иерархии этого класса выполняется в рамках транзакции. Тестовые методы, не аннотированные @Transactional (на уровне класса или метода), не выполняются в рамках транзакции. Обратите внимание, что аннотация @Transactiona.l не поддерживается для методов жизненного цикла теста – например, методов, аннотированных с помощью аннотаций @BeforeAll, @BeforeEach из JUnit Jupiter и т.д. Более того, тесты, помеченные аннотацией @Transactional, но имеющие атрибут propagation, установленный в NOT_SUPPORTED или NEVER, не выполняются в рамках транзакции.

Обратите внимание, что AbstractTransactionalJUnit4SpringContextTests и AbstractTransactionalTestNGSpringContextTests предварительно настроены на поддержку транзакций на уровне классов.

В следующем примере продемонстрирован общий сценарий написания интеграционного теста для UserRepository на основе Hibernate:

@SpringJUnitConfig(TestConfig.class)
@Transactional
class HibernateUserRepositoryTests {
    @Autowired
    HibernateUserRepository repository;
    @Autowired
    SessionFactory sessionFactory;
    JdbcTemplate jdbcTemplate;
    @Autowired
    void setDataSource(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }
    @Test
    void createUser() {
        // отслеживаем начальное состояние в тестовой базе данных:
        final int count = countRowsInTable("user");
        User user = new User(...);
        repository.save(user);
        // Во избежание ложных срабатываний при тестировании требуется ручной сброс
        sessionFactory.getCurrentSession().flush();
        assertNumUsers(count + 1);
    }
    private int countRowsInTable(String tableName) {
        return JdbcTestUtils.countRowsInTable(this.jdbcTemplate, tableName);
    }
    private void assertNumUsers(int expected) {
        assertEquals("Number of rows in the [user] table.", expected, countRowsInTable("user"));
    }
}

@SpringJUnitConfig(TestConfig::class)
@Transactional
class HibernateUserRepositoryTests {
    @Autowired
    lateinit var repository: HibernateUserRepository
    @Autowired
    lateinit var sessionFactory: SessionFactory
    lateinit var jdbcTemplate: JdbcTemplate
    @Autowired
    fun setDataSource(dataSource: DataSource) {
        this.jdbcTemplate = JdbcTemplate(dataSource)
    }
    @Test
    fun createUser() {
        // отслеживаем начальное состояние в тестовой базе данных:
        val count = countRowsInTable("user")
        val user = User()
        repository.save(user)
        // Во избежание ложных срабатываний при тестировании требуется ручной сброс
        sessionFactory.getCurrentSession().flush()
        assertNumUsers(count + 1)
    }
    private fun countRowsInTable(tableName: String): Int {
        return JdbcTestUtils.countRowsInTable(jdbcTemplate, tableName)
    }
    private fun assertNumUsers(expected: Int) {
        assertEquals("Number of rows in the [user] table.", expected, countRowsInTable("user"))
    }
}

Как объясняется в разделе "Логика работы при откате и фиксации транзакций", нет необходимости очищать базу данных после выполнения метода createUser(), поскольку любые изменения, внесенные в базу данных, автоматически откатываются TransactionalTestExecutionListener.

Логика работы при откате и фиксации транзакций

По умолчанию тестовые транзакции автоматически откатываются после завершения теста; однако логику работы при фиксации и откате транзакций можно сконфигурировать декларативно с помощью аннотаций @Commit и @Rollback. Подробнее см. соответствующие записи в разделе, посвященному поддержке аннотаций.

Управление программными транзакциями

Вы можете взаимодействовать с управляемыми тестами транзакциями программно, используя статические методы в TestTransaction. Например, можно использовать TestTransaction в тестовых методах, методах "перед" и "после" для запуска или завершения текущей управляемой тестом транзакции или для конфигурирования текущей управляемой тестом транзакции на откат или фиксацию. Поддержка TestTransaction автоматически доступна всегда, когда включен слушатель TransactionalTestExecutionListener.

В следующем примере продемонстрированы некоторые возможности TestTransaction. Более подробную информацию см. в javadoc по TestTransaction.

@ContextConfiguration(classes = TestConfig.class)
public class ProgrammaticTransactionManagementTests extends
        AbstractTransactionalJUnit4SpringContextTests {
    @Test
    public void transactionalTest() {
        // подтверждаем начальное состояние в тестовой базе данных:
        assertNumUsers(2);
        deleteFromTables("user");
        // изменения в базе данных будут зафиксированы!
        TestTransaction.flagForCommit();
        TestTransaction.end();
        assertFalse(TestTransaction.isActive());
        assertNumUsers(0);
        TestTransaction.start();
        // выполняем другие действия с базой данных, которые будут
        // будут автоматически откачены после завершения теста...
    }
    protected void assertNumUsers(int expected) {
        assertEquals("Number of rows in the [user] table.", expected, countRowsInTable("user"));
    }
}

@ContextConfiguration(classes = [TestConfig::class])
class ProgrammaticTransactionManagementTests : AbstractTransactionalJUnit4SpringContextTests() {
    @Test
    fun transactionalTest() {
        // подтверждаем начальное состояние в тестовой базе данных:
        assertNumUsers(2)
        deleteFromTables("user")
        // изменения в базе данных будут зафиксированы!
        TestTransaction.flagForCommit()
        TestTransaction.end()
        assertFalse(TestTransaction.isActive())
        assertNumUsers(0)
        TestTransaction.start()
        // выполняем другие действия с базой данных, которые будут
        // будут автоматически откачены после завершения теста...
    }
    protected fun assertNumUsers(expected: Int) {
        assertEquals("Number of rows in the [user] table.", expected, countRowsInTable("user"))
    }
}

Выполнение кода вне транзакции

Иногда может потребоваться выполнить определенный код перед или после транзакционного тестового метода, но вне транзакционного контекста – например, для проверки начального состояния базы данных перед запуском теста или для проверки ожидаемого поведения транзакционной фиксации после выполнения теста (если тест был сконфигурирован на фиксацию транзакции). TransactionalTestExecutionListener поддерживает аннотации @BeforeTransaction и @AfterTransactio.n именно для таких сценариев. Вы можете аннотировать любой void метод в тестовом классе или любой void метод по умолчанию в тестовом интерфейсе одной из этих аннотаций, а слушатель TransactionalTestExecutionListener обеспечит, чтоб ваш метод "перед транзакцией" или "после транзакции" был запущен в нужное время.

Настройка диспетчера транзакций

TransactionalTestExecutionListener ожидает, что в ApplicationContext из Spring для теста будет определен бин PlatformTransactionManager. Если существует несколько экземпляров PlatformTransactionManager в пределах ApplicationContext теста, можно объявить квалификатор, используя аннотацию @Transactional("myTxMgr") или @Transactional(transactionManager = "myTxMgr"), или же TransactionManagementConfigurer может быть реализован классом, помеченным аннотацией @Configuration. Обратитесь к javadoc по TestContextTransactionUtils.retrieveTransactionManager() для ознакомления с более подробной информацией об алгоритме, используемом для поиска диспетчера транзакций в ApplicationContext теста.

Демонстрация всех аннотаций, связанных с транзакциями

В следующем примере на основе JUnit Jupiter отражен фиктивный сценарий интеграционного тестирования, в котором выделены все аннотации, связанные с транзакциями. Пример не является демонстрацией передовой практики, а скорее служит демонстрацией того, как можно использовать эти аннотации. Дополнительную информацию и примеры конфигурации см. в разделе, посвященном поддержке аннотаций. Управление транзакциями для аннотации @Sql содержит дополнительный пример, использующий аннотацию @Sql для выполнения декларативного SQL-скрипта с семантикой отката транзакции по умолчанию. В следующем примере показаны соответствующие аннотации:

@SpringJUnitConfig
@Transactional(transactionManager = "txMgr")
@Commit
class FictitiousTransactionalTest {
    @BeforeTransaction
    void verifyInitialDatabaseState() {
        // логика проверки достоверности начального состояния перед запуском транзакции
    }
    @BeforeEach
    void setUpTestDataWithinTransaction() {
        // устанавливаем тестовые данные в рамках транзакции
    }
    @Test
    // переопределяет настройку аннотации @Commit на уровне класса
    @Rollback
    void modifyDatabaseWithinTransaction() {
        // логика, использующая тестовые данные и изменяющая состояние базы данных
    }
    @AfterEach
    void tearDownWithinTransaction() {
        // запускаем логику "разрушения (tear down)" внутри транзакции
    }
    @AfterTransaction
    void verifyFinalDatabaseState() {
        // логика проверки достоверности конечного состояния после отката транзакции
    }
}

@SpringJUnitConfig
@Transactional(transactionManager = "txMgr")
@Commit
class FictitiousTransactionalTest {
    @BeforeTransaction
    fun verifyInitialDatabaseState() {
        // логика проверки достоверности начального состояния перед запуском транзакции
    }
    @BeforeEach
    fun setUpTestDataWithinTransaction() {
        // устанавливаем тестовые данные в рамках транзакции
    }
    @Test
    // переопределяет настройку аннотации @Commit на уровне класса
    @Rollback
    fun modifyDatabaseWithinTransaction() {
        // логика, использующая тестовые данные и изменяющая состояние базы данных
    }
    @AfterEach
    fun tearDownWithinTransaction() {
        // запускаем логику "разрушения (tear down)" внутри транзакции
    }
    @AfterTransaction
    fun verifyFinalDatabaseState() {
        // логика проверки достоверности конечного состояния после отката транзакции
    }
}

// ...
@Autowired
SessionFactory sessionFactory;
@Transactional
@Test // ожидаемого исключения нет!
public void falsePositive() {
    updateEntityInHibernateSession();
    // Ложное срабатывание: исключение будет сгенерировано, как только сессия Hibernate
    // будет окончательно сброшена (т.е. в производственном коде)
}
@Transactional
@Test(expected = ...)
public void updateWithSessionFlush() {
    updateEntityInHibernateSession();
    // Во избежание ложных срабатываний при тестировании требуется ручной сброс
    sessionFactory.getCurrentSession().flush();
}
// ...

// ...
@Autowired
lateinit var sessionFactory: SessionFactory
@Transactional
@Test // ожидаемого исключения нет!
fun falsePositive() {
    updateEntityInHibernateSession()
    // Ложное срабатывание: исключение будет сгенерировано, как только сессия Hibernate
    // будет окончательно сброшена (т.е. в производственном коде)
}
@Transactional
@Test(expected = ...)
fun updateWithSessionFlush() {
    updateEntityInHibernateSession()
    // Во избежание ложных срабатываний при тестировании требуется ручной сброс
    sessionFactory.getCurrentSession().flush()
}
// ...

// ...
@PersistenceContext
EntityManager entityManager;
@Transactional
@Test // ожидаемого исключения нет!
public void falsePositive() {
    updateEntityInJpaPersistenceContext();
    // Ложное срабатывание: исключение будет сгенерировано, как только 
    // EntityManager из JPA будет окончательно сброшен (т.е. в производственном коде)
}
@Transactional
@Test(expected = ...)
public void updateWithEntityManagerFlush() {
    updateEntityInJpaPersistenceContext();
    // Во избежание ложных срабатываний при тестировании требуется ручной сброс
    entityManager.flush();
}
// ...

// ...
@PersistenceContext
lateinit var entityManager:EntityManager
@Transactional
@Test // ожидаемого исключения нет!
fun falsePositive() {
    updateEntityInJpaPersistenceContext()
    // Ложное срабатывание: исключение будет сгенерировано, как только 
    // EntityManager из JPA будет окончательно сброшен (т.е. в производственном коде)
}
@Transactional
@Test(expected = ...)
void updateWithEntityManagerFlush() {
    updateEntityInJpaPersistenceContext()
    // Во избежание ложных срабатываний при тестировании требуется ручной сброс
    entityManager.flush()
}
// ...

// ...
@Autowired
JpaPersonRepository repo;
@PersistenceContext
EntityManager entityManager;
@Transactional
@Test
void savePerson() {
    // EntityManager#persist(...) приводит к @PrePersist, но не @PostPersist
    repo.save(new Person("Jane"));
    // Для осуществления обратного вызова с аннотацией @PostPersist требуется ручной сброс
    entityManager.flush();
    // Тестовый код, который использует обратный вызов с аннотацией @PostPersist
    // был вызван...
}
// ...

// ...
@Autowired
lateinit var repo: JpaPersonRepository
@PersistenceContext
lateinit var entityManager: EntityManager
@Transactional
@Test
fun savePerson() {
    // EntityManager#persist(...) приводит к @PrePersist, но не @PostPersist
    repo.save(Person("Jane"))
    // Для осуществления обратного вызова с аннотацией @PostPersist требуется ручной сброс
    entityManager.flush()
    // Тестовый код, который использует обратный вызов с аннотацией @PostPersist
    // был вызван...
}
// ...