Skip to content

Commit

Permalink
Enforce modifying methods are annotated with @transactional
Browse files Browse the repository at this point in the history
  • Loading branch information
quaff committed Jun 14, 2024
1 parent 3351350 commit 35d73bc
Showing 1 changed file with 22 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
package org.springframework.data.jpa.repository.support;

import static java.util.Collections.singletonMap;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatNoException;
import static org.mockito.Mockito.any;
import static org.mockito.Mockito.never;
Expand All @@ -31,12 +32,18 @@
import jakarta.persistence.criteria.CriteriaBuilder;
import jakarta.persistence.criteria.CriteriaQuery;

import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.Arrays;
import java.util.List;
import java.util.Optional;
import java.util.stream.Stream;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.mockito.junit.jupiter.MockitoSettings;
Expand All @@ -45,6 +52,7 @@
import org.springframework.data.jpa.domain.sample.User;
import org.springframework.data.jpa.repository.EntityGraph.EntityGraphType;
import org.springframework.data.repository.CrudRepository;
import org.springframework.transaction.annotation.Transactional;

/**
* Unit tests for {@link SimpleJpaRepository}.
Expand All @@ -54,6 +62,7 @@
* @author Mark Paluch
* @author Jens Schauder
* @author Greg Turnquist
* @author Yanming Zhou
*/
@ExtendWith(MockitoExtension.class)
@MockitoSettings(strictness = Strictness.LENIENT)
Expand Down Expand Up @@ -216,4 +225,17 @@ void applyQueryHintsToCountQueriesForSpecificationPageables() {

verify(metadata).getQueryHintsForCount();
}

@ParameterizedTest // GH-3188
@MethodSource("modifyingMethods")
void checkTransactionalAnnotation(Method method) {
Transactional transactional = method.getAnnotation(Transactional.class);
assertThat(transactional).as("Method [%s] should be annotated with @Transactional", method).isNotNull();
assertThat(transactional.readOnly()).as("Method [%s] should not be annotated with @Transactional(readOnly = true)", method).isFalse();
}

static List<Method> modifyingMethods() {
return Stream.of(SimpleJpaRepository.class.getDeclaredMethods()).filter(method -> Modifier.isPublic(method.getModifiers()) &&
!method.isBridge() && (method.getName().startsWith("delete") || method.getName().startsWith("save"))).toList();
}
}

0 comments on commit 35d73bc

Please sign in to comment.