Armeria doesn't stop between test suites when running with Spring Boot

Consider the following scenario:

• A Spring Boot application backed by Armeria just like the one in the examples;
• We want to test our application using different configurations (for instance an application that uses different datasources, or caches, or something else)

One way to do this is to use Spring @ContextConfiguration where we inject the configurations we want to use. So if we reuse the spring-boot-minimal example we would do something like the following:

package example.springframework.boot.minimal;

// our import declarations

@ActiveProfiles("testbed")
@SpringBootTest(webEnvironment = WebEnvironment.NONE)
@ContextConfiguration(initializers = { HelloApplicationIntegrationTest.Initializer.class })
class HelloApplicationIntegrationTest {

    static class Initializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
        public void initialize(ConfigurableApplicationContext configurableApplicationContext) {
            TestPropertyValues
                    .of("the property overrides we want to test against")
                    .applyTo(configurableApplicationContext.getEnvironment());
        }
    }

// our test cases and so on

}

If we debug this test suite with a breakpoint at the ArmeriaServerGracefulShutdownLifecycle.java the execution will stop at the stop() method during shutdown as expected.

The issue here is that if we create another test class to test another configuration setup:

package example.springframework.boot.minimal;

// our import declarations

@ActiveProfiles("testbed")
@SpringBootTest(webEnvironment = WebEnvironment.NONE)
@ContextConfiguration(initializers = { HelloApplicationIntegrationTest2.Initializer.class })
class HelloApplicationIntegrationTest2 {

    static class Initializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
        public void initialize(ConfigurableApplicationContext configurableApplicationContext) {
            TestPropertyValues
                    .of("the property overrides we want to test against different than the ones used at HelloApplicationIntegrationTest")
                    .applyTo(configurableApplicationContext.getEnvironment());
        }
    }

// same tests as HelloApplicationIntegrationTest

}

… and debug the tests again the stop() method at ArmeriaServerGracefulShutdownLifecycle.java will be called twice (as expected since we wanted to test 2 different Server instances) but at the end of the entire test execution and not at the end of each test suite.

This means that given a sufficiently big project that needs to test different configurations (like the one I’m currently working on) we will eventually reach an out of memory error because all Server instances are only stopped at the end of the execution.

Currently what we are seeing in our tests is the following:

// several log entries stating that an Armeria Server instance is shutting down
Error:  Surefire is going to kill self fork JVM. The exit has elapsed 30 seconds after System.exit(0).

My guess is that Spring’s Application Context is bound to the lifecycle of the JVM (shutdown hook or something similar) and Armeria is bound to Spring’s Application Context lifecycle which explains why it is stopping when Spring stops as well.

Is this the intended behaviour? Shouldn’t Spring stop the current Armeria Server before launching the new one or am I missing a piece of configuration?

[minwoox]

Thanks for the report, @jmadureira! @kojilin Would you mind taking a look at this? 😄

[minwoox]

My 2 cents is that this should be included in the spring-boot examples otherwise someone will eventually bump into this problem.

That’s a good suggestion. Are you interested in fixing the example?