Running Spring Boot application through Eclipse picks up test classes

Question

I am developing a Spring Boot application using STS with the Gradle plugin. I have a different configuration for tests, to prevent our Selenium tests from having to login.

So in src/test/java/etc I have something like this:

@Configuration
@EnableGlobalMethodSecurity(prePostEnabled = true)
@EnableWebSecurity
public static class SecurityConfig extends WebSecurityConfigurerAdapter
{
    @Override
    protected void configure(HttpSecurity http) throws Exception
    {   
        http.authorizeRequests().anyRequest().permitAll();
    }
}

Whereas in src/main/java I have an equivalent class that configures login etc, requiring login for all pages.

If I run the application through the Gradle plugin (bootRun), everything works fine.

However, if I run or debug it through Eclipse directly (e.g. right clicking on the project, Run As->Spring Boot App or by clicking the run/debug buttons in the Spring or Java view) then the test config is applied, so access is granted to all pages without login.

I'm guessing that the test classes are being included in the classpath when I start the application this way. Is there an easy way to prevent this from happening?

Kristin

I could imagine you could workaround this by adding @Profile("test") to this class + @ActiveProfiles("test") on the test. That would make the bean condtional on that profile. See docs.spring.io/spring/docs/current/spring-framework-reference/… – Patronymic

Looks like a good potential solution, although even after I added @profile("test") to the test config class it is still being used when I run the app. I'll investigate this further later - thanks. – Kristin

I can confirm that the problem almost certainly that runtime classpath includes 'test' things on it. It is kind of a known problem though I do not think there is an issue ticket for it. This is a problem caused by gradle's tooling model not distinuguishing between 'test' and 'runtime' classpaths. I'm afraid the easiest way to avoid this problem is to switch to using maven. I know m2e/maven does this correctly. – Fingerling

Thanks @Fingerling - I've got round it for now by removing the need for a separate config for the tests. – Kristin

I have written some code in my build.gradle file that generates an Eclipse launch configuration using the runtime classpath. I use this launch configuration to run my local app server. See https://mcmap.net/q/1168515/-spring-tools-suite-and-gradle-setup-to-use-correct-resources-from-inside-sts – Everyone

I use maven and have the same problem. – Krouse

Answer 1

When you run the test from eclipse, the classpath is prepared by eclipse (and not by maven or gradle).

Eclipse only uses one classpath per project and does not know anything about dependency scopes (like 'compile' or 'test'). So the classpath always contains any resources of a referenced project.

You cannot change this behavior of eclipse. You need to use naming conventions, profile etc. to avoid accidental use of test resources.

Trawick

Answer 2

At least Eclipse IDE Version: 2022-12 (4.26.0) has the feature that allows to exclude test code from Debug/Run configuration classpath:

Go to Run/Debug configuration you use to run your app, choose Dependencies tab, click the checkbox 'Exclude test code'.

Already

Answer 3

You can append @TestComponent to you test configuration class. These bean configurations will be skipped during component scan of your application. Depending on the component scan configuration, you need to define an @ComponentScan exclude filter: excludeFilters = @ComponentScan.Filter(value = TestComponent.class, type = FilterType.ANNOTATION))

Bosanquet

It works, but there is one problem with this approach: you have to add spring test class in production, otherwise you will get ClassNotFoundException – Horntail

@WellingtonSouza that's true. Alternatively you can also use a regexp expression to exclude test classes, e.g. excludeFilters = @ComponentScan.Filter(pattern = ".*TestConfiguration", type = FilterType.REGEX) – Bosanquet