How to autowire field in static @BeforeClass?

JavaSpringJunitSpring Test

Java Problem Overview


@RunWith(SpringJUnit4ClassRunner.class)
public void ITest {
	@Autowired
	private EntityRepository dao;

	@BeforeClass
	public static void init() {
		dao.save(initialEntity); //not possible as field is not static
	}
}

How can I have my service injected already in the static init class?

Java Solutions


Solution 1 - Java

With Junit 5 you can do this (@BeforeAll instead of @BeforeClass)

public void ITest {
    @Autowired
    private EntityRepository dao;

    @BeforeAll
    public static void init(@Autowired EntityRepository dao) {
        dao.save(initialEntity); //possible now as autowired function parameter is used
    }
}

By leaving the field it means it can be used in other tests

Solution 2 - Java

One workaround that I have been using to get this working is to use @Before with a flag to skip it being executed for each testcase

@RunWith(SpringJUnit4ClassRunner.class)
public class BaseTest {

@Autowired
private Service1 service1;

@Autowired
private Service2 service2;

private static boolean dataLoaded = false;

@Before
public void setUp() throws Exception {

	if (!dataLoaded) {
		service1.something();
		service2.somethingElse();
		dataLoaded = true;
	}
  }
}

Solution 3 - Java

UPD for Spring 2.x versions.

Spring 2.x supports new feature a SpringExtension for Junit 5 Jupiter, where all you have to do is:

  1. Declare your test class with @ExtendWith(SpringExtension.class)

  2. Inject your @BeforeAll (replacement for @BeforeClass in JUnit 5) with the bean

For example:

@ExtendWith(SpringExtension.class)
...
public void ITest {
    
    @BeforeAll
    public static void init(@Autowired EntityRepository dao) {
        dao.save(initialEntity);
    }

}

Assuming you correctly configured JUnit 5 Jupiter with Spring 2.x

More about it here: https://docs.spring.io/spring/docs/current/spring-framework-reference/testing.html#testcontext-junit-jupiter-extension

Solution 4 - Java

It looks to me that you are trying to populate DB before tests.

I would give a try to two options:

  • If you can extract initial scripts to sql file (if that is option for you without using repository bean) you can use this approach and annotate your test with @Sql
  • You can explore DbUnit and here is link to spring dbunit connector which is doing exactly that and helping you populate DB before tests. Here is a github link for integrating between spring test framework and dbunit. After you do that you have @DatabaseSetup and @DatabaseTearDown which will do thing on DB you need

I know that this does not answer how to inject bean in static @BeforeClass but form code it looks it is solving your problem.

Update: I recently run into same problem in my project and dug out this article which helped me and I think it is elegant way of dealing with this type of problem. You can extend SpringJUnit4ClassRunner with listener which can do instance level setup with all your defined beans.

Solution 5 - Java

To answer this question we should recap Spring 2.x versions.

If you want to "autowire" a bean in your @BeforeTest class you can use the ApplicationContext interface. Let's see an example:

@BeforeClass
    public static void init() {
	    ApplicationContext context = new ClassPathXmlApplicationContext("application-context.xml");
		EntityRepository dao2 = (EntityRepository) context.getBean("dao");
    	List<EntityRepository> all = dao2.getAll();
		Assert.assertNotNull(all);
	}

What's happening: using the ClassPathXmlApplicationContext we are instantiating all beans contained in the application-context.xml file.

With context.getBean() we read the bean specified (it must match the name of the bean!); and then you can use it for your initialization.

You should give to the bean another name (that's the dao2!) otherwise Spring normal "autowired" cannot work on the predefined bean.

As a side note, if your test extends AbstractTransactionalJUnit4SpringContextTests you can do some initialization using executeSqlScript(sqlResourcePath, continueOnError); method, so you don't depend on a class/method that you also have to test separately.

Solution 6 - Java

If you just want to use some DB data in your tests, you could also mock the repository and use the @Before workaround Narain Mittal describes:

@RunWith(SpringJUnit4ClassRunner.class)
public void ITest {
    @MockBean
    private EntityRepository dao;

    @Before
    public static void init() {
        when(dao.save(any())).thenReturn(initialEntity);
    }
}

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionmembersoundView Question on Stackoverflow
Solution 1 - JavaVladtnView Answer on Stackoverflow
Solution 2 - JavaNarain MittalView Answer on Stackoverflow
Solution 3 - JavayeralinView Answer on Stackoverflow
Solution 4 - JavaNenad BozicView Answer on Stackoverflow
Solution 5 - JavamusikeleView Answer on Stackoverflow
Solution 6 - JavaJacob van LingenView Answer on Stackoverflow