HHH-15082 Test that batch statements are aborted if a RuntimeException is thrown by Batch#addToBatch

Such an exception can be thrown if an expectation
(org.hibernate.jdbc.Expectation) is not met, for example if an update
statement for a given entity affects 0 rows (e.g. because of a concurrent
update).
This commit is contained in:
Yoann Rodière 2022-02-17 15:58:17 +01:00 committed by Sanne Grinovero
parent ec6cd5d0cc
commit 14c8fb752d
1 changed files with 213 additions and 0 deletions

View File

@ -0,0 +1,213 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
package org.hibernate.orm.test.jpa.transaction.batch;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.atomic.AtomicReference;
import org.hibernate.cfg.AvailableSettings;
import org.hibernate.engine.jdbc.batch.internal.BatchBuilderImpl;
import org.hibernate.engine.jdbc.batch.internal.BatchBuilderInitiator;
import org.hibernate.engine.jdbc.batch.internal.BatchingBatch;
import org.hibernate.engine.jdbc.batch.spi.Batch;
import org.hibernate.engine.jdbc.batch.spi.BatchKey;
import org.hibernate.engine.jdbc.spi.JdbcCoordinator;
import org.hibernate.testing.TestForIssue;
import org.hibernate.testing.orm.junit.EntityManagerFactoryScope;
import org.hibernate.testing.orm.junit.Jpa;
import org.hibernate.testing.orm.junit.Setting;
import org.hibernate.testing.orm.junit.SettingProvider;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.Id;
@TestForIssue(jiraKey = "HHH-15082")
@Jpa(
annotatedClasses = {
FailingAddToBatchTest.MyEntity.class
},
integrationSettings = {
@Setting(name = AvailableSettings.STATEMENT_BATCH_SIZE, value = "50")
},
settingProviders = {
@SettingProvider(
settingName = BatchBuilderInitiator.BUILDER,
provider = FailingAddToBatchTest.BatchBuilderSettingProvider.class
)
}
)
public class FailingAddToBatchTest {
private static TestBatch testBatch;
@BeforeEach
public void setup() {
TestBatch.nextAddToBatchFailure.set( null );
}
@Test
public void testInsert(EntityManagerFactoryScope scope) {
RuntimeException simulatedAddToBatchFailure = new RuntimeException( "Simulated RuntimeException" );
scope.inTransaction( em -> {
assertThatThrownBy( () -> {
MyEntity entity = new MyEntity();
entity.setText( "initial" );
TestBatch.nextAddToBatchFailure.set( simulatedAddToBatchFailure );
em.persist( entity );
em.flush();
} )
.isSameAs( simulatedAddToBatchFailure );
assertAllStatementsAreClosed( testBatch.createdStatements );
} );
}
@Test
public void testUpdate(EntityManagerFactoryScope scope) {
Long id = scope.fromTransaction( em -> {
MyEntity entity = new MyEntity();
entity.setText( "initial" );
em.persist( entity );
return entity.getId();
} );
RuntimeException simulatedAddToBatchFailure = new RuntimeException( "Simulated RuntimeException" );
scope.inTransaction( em -> {
assertThatThrownBy( () -> {
MyEntity entity = em.find( MyEntity.class, id );
TestBatch.nextAddToBatchFailure.set( simulatedAddToBatchFailure );
entity.setText( "updated" );
em.flush();
} )
.isSameAs( simulatedAddToBatchFailure );
assertAllStatementsAreClosed( testBatch.createdStatements );
} );
}
@Test
public void testRemove(EntityManagerFactoryScope scope) {
Long id = scope.fromTransaction( em -> {
MyEntity entity = new MyEntity();
entity.setText( "initial" );
em.persist( entity );
return entity.getId();
} );
RuntimeException simulatedAddToBatchFailure = new RuntimeException( "Simulated RuntimeException" );
scope.inTransaction( em -> {
assertThatThrownBy( () -> {
MyEntity entity = em.find( MyEntity.class, id );
TestBatch.nextAddToBatchFailure.set( simulatedAddToBatchFailure );
em.remove( entity );
em.flush();
} )
.isSameAs( simulatedAddToBatchFailure );
assertAllStatementsAreClosed( testBatch.createdStatements );
} );
}
protected void assertAllStatementsAreClosed(List<PreparedStatement> statements) {
statements.forEach( statement -> {
try {
assertThat( "A PreparedStatement has not been closed", statement.isClosed(), is( true ) );
}
catch (SQLException e) {
fail( e.getMessage() );
}
} );
}
@Entity(name = "MyEntity")
public static class MyEntity {
@Id
@GeneratedValue
private Long id;
private String text;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getText() {
return text;
}
public void setText(String text) {
this.text = text;
}
}
public static class BatchBuilderSettingProvider implements SettingProvider.Provider<String> {
@Override
public String getSetting() {
return TestBatchBuilder.class.getName();
}
}
public static class TestBatch extends BatchingBatch {
private static final AtomicReference<RuntimeException> nextAddToBatchFailure = new AtomicReference<>();
private final List<PreparedStatement> createdStatements = new ArrayList<>();
public TestBatch(BatchKey key, JdbcCoordinator jdbcCoordinator, int batchSize) {
super( key, jdbcCoordinator, batchSize );
}
@Override
public void addToBatch() {
RuntimeException failure = nextAddToBatchFailure.getAndSet( null );
if ( failure != null ) {
throw failure;
// Implementations really should call abortBatch() before propagating an exception.
// Purposely skipping the call to abortBatch() to ensure that Hibernate works properly when
// an implementation does not call abortBatch().
}
super.addToBatch();
}
@Override
public PreparedStatement getBatchStatement(String sql, boolean callable) {
PreparedStatement batchStatement = super.getBatchStatement( sql, callable );
createdStatements.add( batchStatement );
return batchStatement;
}
}
public static class TestBatchBuilder extends BatchBuilderImpl {
@Override
public Batch buildBatch(BatchKey key, JdbcCoordinator jdbcCoordinator) {
return buildBatchTest( key, jdbcCoordinator, getJdbcBatchSize() );
}
protected BatchingBatch buildBatchTest(BatchKey key, JdbcCoordinator jdbcCoordinator, int jdbcBatchSize) {
testBatch = new TestBatch( key, jdbcCoordinator, jdbcBatchSize );
return testBatch;
}
}
}