Should I test the main() method of Spring Boot Application and how?

Question

When I create Spring Boot Application it generates 2 classes:

@SpringBootApplication public class App { public static void main(String[] args) { SpringApplication.run(App.class, args); } }

And the second on is test:

@RunWith(SpringRunner.class) @SpringBootTest public class AppTest { @Test public void contextLoads() { } }

Like you can notice contextLoads test is empty. How should I provide correct test for contextLoad? It should stay empty maybe? Is it correct? Or I should put something inside?

UPDATE:

Why this test should stay? If I have more tests in application I'll know if spring context is loaded or nope. Isn't it just excessive.

I readed answers like this but it didn't gave me a clear answer.

In fact your question is rather : "why test main method in Spring Boot Application?" and not "how". — davidxxx
– davidxxx, Commented Mar 18, 2018 at 8:24

davidxxx · Accepted Answer · 2018-03-22 20:18:40Z

Actually, the main() method of the Spring Boot Application is not covered by the unit/integration tests as the Spring Boot tests don't invoke the main() method to start the Spring Boot application.

Now I consider that all answers of this post seem overkill.
They want to add a test of the main() method to make a metric tool happy (Sonar).
Loading a Spring context and loading the application takes time.
Don't add it in each developer build just to win about 0.1% of coverage in your application.
I added an answer about that.

Beyond your simple example and the other post that you refer to, in absolute terms it may make sense to create a test for the main() method if you included some logic in. It is the case for example as you pass specific arguments to the application and that you handle them in the main() meethod.

jax · Accepted Answer · 2018-03-18 23:16:46Z

Leave it empty. If an exception occurs while loading the application context the test will fail. This test is just saying "Will my application load without throwing an exception"

Update for Second Question

The reason you want to keep this test is that when something fails you want to find the root cause. If you application context is unable to load, you can assume all other tests that are failing are due to this. If the above test passes, you can assume that the failing tests are unrelated to loading the context.

So maybe I should put inside some kind of assertion? to be sure if its correct.
This test is just ensuring your application loads with no exceptions. You have nothing to assert. If any exceptions are thrown while creating spring beans the test will fail.
I edited question, if you could answer for the second part :)

Ashish Lahoti · Accepted Answer · 2021-05-10 02:25:49Z

When you build a Spring boot application using Spring Initializer. It auto creates Application and its Test Class

@SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } @SpringBootTest class ApplicationTest { @Test void contextLoads() { } }

Note the use of @SpringBootTest annotation on test class which tells Spring Boot to look for a main configuration class (one with @SpringBootApplication, for instance) and use that to start a Spring application context. Empty contextLoads() is a test to verify if the application is able to load Spring context successfully or not.

You do not need to provide any test cases for empty method as such. Though you can do something like this to verify your controller or service bean context:-

@SpringBootTest public class ApplicationContextTest { @Autowired private MyController myController; @Autowired private MyService myService; @Test public void contextLoads() throws Exception { assertThat(myController).isNotNull(); assertThat(myService).isNotNull(); } }

Aleksei Samoshin · Accepted Answer · 2024-08-08 03:55:15Z

In your case you can invoke main method manually

@SpringBootTest public class AppTest { @Test public void contextLoads() { Application.main(new String[0]); } }

It makes 100% coverage

Collectives™ on Stack Overflow

Should I test the main() method of Spring Boot Application and how?

4 Answers 4

Comments

Update for Second Question

4 Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Update for Second Question

4 Comments

Comments

Comments

Linked

Related