Spring Boot Test failing to autowire port with LocalServerPort annotation

Question

I am running Spring Boot 2.0.1 and Junit 5. I am trying to get port within an integration test . However the port value is always zero. I am not sure what could be causing it. I have tried changing web environment enum to random port but nothing seems to be working.

package com.example.demo;

import org.junit.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.server.LocalServerPort;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import static org.junit.jupiter.api.Assertions.assertNotEquals;

@ExtendWith(SpringExtension.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
public class DemoApplicationTests {

@LocalServerPort
private int port;
@Test


public void printPort() throws Exception {
     assertNotEquals(port, 0);
}
}

The following is the pom (NB. only shows the dependencies)

<properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <junit-jupiter.version>5.2.0</junit-jupiter.version>
        <junit-platform.version>1.2.0</junit-platform.version>
    </properties>

    <dependencies>
         <dependency>
                <groupId>org.junit.platform</groupId>
                <artifactId>junit-platform-launcher</artifactId>
                <scope>test</scope>
                <version>${junit-platform.version}</version>
            </dependency>
            <dependency>
                <groupId>org.junit.platform</groupId>
                <artifactId>junit-platform-engine</artifactId>
                <scope>test</scope>
                <version>${junit-platform.version}</version>
            </dependency>
            <dependency>
                <groupId>org.junit.jupiter</groupId>
                <artifactId>junit-jupiter-api</artifactId>
                <scope>test</scope>
                <version>${junit-jupiter.version}</version>
            </dependency>
            <dependency>
                <groupId>org.junit.jupiter</groupId>
                <artifactId>junit-jupiter-engine</artifactId>
                <scope>test</scope>
                <version>${junit-jupiter.version}</version>
            </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

application.properties

server.port=8080

Relaterd: https://stackoverflow.com/questions/30312058/spring-boot-how-to-get-the-running-port — tkruse, Mar 24 '20 at 06:55

score 8 · Answer 1 · answered Nov 26 '18 at 09:29

8

I had the same problem, this set of annotations below worked for me. Without @ContextConfiguration port was 0.

@ContextConfiguration
@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class TestBase {

@LocalServerPort
protected int port;

}

answered Nov 26 '18 at 09:29

gdybyjednak

89
1
2

There is no @RunWith in JUnit5 – Silk0vsky Feb 14 '19 at 12:03
1

Use @ExtendWith in JUnit5 – Mark Sep 03 '19 at 23:13

score 4 · Answer 2 · answered Oct 29 '18 at 17:47

I had same problem. This solution worked for me:

@Service
public class TestService implements ApplicationListener<ServletWebServerInitializedEvent> {

   private int localPort;

   @Override
   public void onApplicationEvent(final ServletWebServerInitializedEvent event) {
       localPort = event.getWebServer().getPort();
   }
}

You can autowire this service or you can implement ApplicationListener directly in your test class. Just a warning - the localPort variable is initialized during application startup after the bean is completely ready, so it won't be available in @PostConstruct etc.

score 2 · Answer 3 · answered May 09 '18 at 10:44

2

You're missing a dependency on spring-boot-starter-web.

answered May 09 '18 at 10:44

Sam Brannen

29,611
5
104
136

score 1 · Answer 4 · answered Sep 29 '20 at 08:34

1

I have the same problem, and i am using junit5, i guess your problem should be the same. just do as below:

remove the "import org.junit.Test";
reimport the "import org.junit.jupiter.api.Test";

this should solve the problem

answered Sep 29 '20 at 08:34

Ray

477
1
6
18

score 1 · Answer 5 · answered Jan 01 '22 at 08:21

1

I had this problem, After debugging I find out that the port initialization take time. So I changed my test case like this:

@LocalServerPort
lateinit var port: Number

val baseUrl by lazy {  "http://localhost:$port"}

answered Jan 01 '22 at 08:21

Azdy

170
9

score 0 · Answer 6 · answered May 08 '18 at 18:06

0

Add @TestPropertySource(locations = "classpath:test.properties") on top of your test class. Have you tried @Value("${server.port}") instead of @LocalServerPort?

answered May 08 '18 at 18:06

GabLeg

352
4
14

score 0 · Answer 7 · answered May 09 '18 at 09:39

0

Here you can find an example using RANDOM_PORT. You can change to DEFINED_PORT simply changing the value of webEnvironment and in that case the value of the variable serverPort will be 8080, the default one.

answered May 09 '18 at 09:39

Boni García

4,618
5
28
44

Spring Boot Test failing to autowire port with LocalServerPort annotation

7 Answers7

Linked