How to reset between tests

Question

I have a test class

@RunWith(SpringRunner.class)
@DataJpaTest

I have two tests. In every test I do the same operation, persist the object. Only the find call are different.

If I run both tests together they fail but if I run test one after another they are successful.

There is no reset between each test. How to do that? Only the call to the repository is different in each test.

@Test
public void findTopByCommerceCommerceIdOrderByEntryTimeDesc() {

    Long commerceId = 1L;

    Commerce commerce = new Commerce();
    commerce.setName("test");
    this.entityManager.persist(commerce);

    Member member = new Member();
    member.setCommerce(commerce);
    member.setMan(true);
    member.setName("bob binette");

    this.entityManager.persist(member);

    Visit visit1 = new Visit();
    visit1.setCommerce(commerce);

    visit1.setMember(member);
    visit1.setEntryTime(LocalDateTime.of(LocalDate.now(), LocalTime.now()));

    Visit visit2 = new Visit();
    visit2.setCommerce(commerce);

    visit2.setMember(member);
    visit2.setEntryTime(LocalDateTime.of(LocalDate.now().minusDays(2), LocalTime.now()));

    this.entityManager.persist(visit1);
    this.entityManager.persist(visit2);

    Visit visit = visitRepository.findTopByCommerceCommerceIdOrderByEntryTimeDesc(commerceId);

    assertEquals(visit.getVisitId(), Long.valueOf("1"));

}

Edit

i put all the code : http://pastebin.com/M9w9hEYQ

Use JUnit [`@Before`](http://junit.sourceforge.net/javadoc/org/junit/Before.html) and [`@After`](http://junit.sourceforge.net/javadoc/org/junit/After.html)? — manish, Dec 12 '16 at 05:41
`DataJpaTest` tests are transactional by default Martijn. Something else is going on that we don't see: it should work out of the box. — Stephane Nicoll, Dec 12 '16 at 08:19
Possible duplicate of [How to re-create database before each test in Spring?](https://stackoverflow.com/questions/34617152/how-to-re-create-database-before-each-test-in-spring) — Dherik, Jun 13 '19 at 17:19

score 43 · Answer 1 · answered Dec 19 '16 at 13:31

43

Add the @DirtiesContext annotation, but provide it with the AFTER_EACH_TEST_METHOD classMode

@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_EACH_TEST_METHOD)

answered Dec 19 '16 at 13:31

HPacquee

579
4
11

Thanks @HPacquee. Saved my day even if it was a long time ago. :) – oga May 19 '20 at 10:33
4

If you want a quick feedback loop, DO NOT use @DirtiesContext! It works, but it slows down your tests too much. This is the worst option that works. – TiggerToo Apr 02 '21 at 14:15

score 14 · Answer 2 · answered Dec 15 '16 at 08:43

In your case for each test you persist the same data. So you should persist data before all test or persist before each test and clean after it.

1. Persist before all test

@BeforeClass
public static void init(){
  //persist your data
}

@AfterClass
public static void clear(){
  //remove your data
}

@Test
public void findTopByCommerceCommerceIdOrderByEntryTimeDesc() {
    Visit visit = visitRepository.findTopByCommerceCommerceIdOrderByEntryTimeDesc(commerceId);

    assertEquals(visit.getVisitId(), Long.valueOf("1"));
}

In this case @AfterClass is optionally

2. Persist before each test and clean after each test

    @Before
    public void init(){
      //persist your data
    }

    @After
    public void clear(){
      //remove your data
    }

    @Test
    public void findTopByCommerceCommerceIdOrderByEntryTimeDesc() {
        Visit visit = visitRepository.findTopByCommerceCommerceIdOrderByEntryTimeDesc(commerceId);

        assertEquals(visit.getVisitId(), Long.valueOf("1"));
    }

Remember that methods which use @BeforeClass and @AfterClass must be static.

I would suggest `@Before` and `@After`. Recommended practice: http://stackoverflow.com/a/14737697/5012277 — , Dec 16 '16 at 19:23
tried to add this.entityManager.remove(visit1); this.entityManager.remove(visit2); after the assert... get same issue — robert trudel, Dec 17 '16 at 03:15

score 7 · Answer 3 · answered Dec 16 '16 at 12:04

7

You can use @DirtiesContext annotation on your test class to reset the tests, there you can also choose when to reset. Default is after every method, but you can change that by passing in different parameters to the @DirtiesContext annotation.

import org.springframework.test.annotation.DirtiesContext;

@RunWith(SpringRunner.class)
@DataJpaTest
@DirtiesContext
public class VisitRepositoryTest {

answered Dec 16 '16 at 12:04

nesohc

487
1
5
14

1

Add it before every method that persists one entity can reset the auto-incremented ID (Postgresql sequence in my case) back to 1. Brilliant Spring. – WesternGun Jul 18 '18 at 15:06

Ruchi Saini · Answer 4 · 2016-12-19T17:36:12.780

Use @Sql with ExecutionPhase.AFTER_TEST_METHOD and pass the script that is to be used to clean the database

@Sql(scripts="classpath:cleanup.sql",executionPhase=Sql.ExecutionPhase.AFTER_TEST_METHOD)
@Test
public void whateverIsYourTestMethod()
{
...
}

In case you are using @Transactional annotation , you can use :

@Sql(scripts="classpath:cleanup.sql",executionPhase=Sql.ExecutionPhase.AFTER_TEST_METHOD,config = @SqlConfig
        ( transactionMode = TransactionMode.ISOLATED,
        transactionManager = "transactionManager",
        dataSource= "dataSource" ))
@Test
@Commit
@Transactional
public void whateverIsYourTestMethod(){...}

score 4 · Answer 5 · answered Dec 18 '16 at 21:37

Have you try to clear the peristence cache between each tests, according to TestEntityManager#clear()

@After
public void clear() {
    this.entityManager.clear();
}

Or maybe try to set your Visitor as fields and remove them in an after, than flush the changes :

Visit visit1;

Visit visit2;

@After
public void clear(){
  if (visit1 != null)
      this.entityManager.remove(visit1);
  if (visit2 != null)
      this.entityManager.remove(visit2);
  this.entityManager.flush();
}

score 1 · Answer 6 · answered Jul 22 '20 at 14:30

1

Use the @Transactional(propagation = Propagation.REQUIRES_NEW) on top of your test class, that will explicitly request, the creation of a new transaction after each method

answered Jul 22 '20 at 14:30

Ikbel

1,817
1
17
30

score 0 · Answer 7 · answered Mar 06 '18 at 09:56

@DirtiesContext(classMode =DirtiesContext.ClassMode.AFTER_EACH_TEST_METHOD) works for me, but it is only necessary when I run @DataJpaTest() with @AutoConfigureTestDatabase(replace=Replace.NONE) and costum profile for mysql, default h2 works without this.

score 0 · Answer 8 · answered Jul 31 '20 at 14:24

Although this issue has been solved for you, I would just like to state that clearing the repository was not cutting for my particular use-case as I have an data.sql initialization for my h2 which creates a user by default, so I had to add an application.properties file under src/test/resources with the following property:

spring.datasource.initialization-mode=never

Reference to the thread that made that suggestion: Spring Boot ignore data.sql when running unit tests

How to reset between tests

8 Answers8