How to add basic auth to Autowired testRestTemplate in SpringBootTest; Spring Boot 1.4

Question

My OAuth integration test before Spring Boot 1.4 looked as follows(updates just to not use deprecated features):

@RunWith(SpringRunner.class)
@SpringBootTest(classes = { ApplicationConfiguration.class }, webEnvironment = WebEnvironment.RANDOM_PORT)
public class OAuth2IntegrationTest {

    @Value("${local.server.port}")
    private int port;

    private static final String CLIENT_NAME = "client";
    private static final String CLIENT_PASSWORD = "123456";

    @Test
    public void testOAuthAccessTokenIsReturned() {
        MultiValueMap<String, String> request = new LinkedMultiValueMap<String, String>();
        request.set("username", "user");
        request.set("password", password);
        request.set("grant_type", "password");
        @SuppressWarnings("unchecked")
        Map<String, Object> token = new TestRestTemplate(CLIENT_NAME, CLIENT_PASSWORD)
            .postForObject("http://localhost:" + port + "/oauth/token", request, Map.class);
        assertNotNull("Wrong response: " + token, token.get("access_token"));
    }
}

I now want to use Autowired TestRestTemplate as stated here http://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-testing.html#boot-features-testing-spring-boot-applications-working-with-random-ports

@RunWith(SpringRunner.class)
@SpringBootTest(classes = {
    ApplicationConfiguration.class }, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class OAuth2IntegrationTest {

    private static final String CLIENT_NAME = "client";
    private static final String CLIENT_PASSWORD = "123456";

    @Autowired
    private TestRestTemplate testRestTemplate;

    @Test
    public void testOAuthAccessTokenIsReturned() {
        MultiValueMap<String, String> request = new LinkedMultiValueMap<String, String>();
        request.set("username", "user");
        request.set("password", password);
        request.set("grant_type", "password");
        @SuppressWarnings("unchecked")

        Map<String, Object> token1 = this.testRestTemplate. //how to add basic auth here
        assertNotNull("Wrong response: " + token, token.get("access_token"));
    }
}

I saw this as the closest way to add auth:

Spring 4.0.0 basic authentication with RestTemplate

I want to use the Autowired testRestTemplate to avoid resolving host and ports in my test. Is there a way to do this?

public TestRestTemplate withBasicAuth(String username, String password) this looks to be only available in spring boot 1.4.1, is this the solution — Tuhin Kanti Sharma, Sep 23 '16 at 01:16

score 19 · Accepted Answer · answered Sep 23 '16 at 20:30

This got fixed in Spring Boot 1.4.1 which has an additional method

testRestTemplate.withBasicAuth(USERNAME,PASSWORD)

@Autowired
private TestRestTemplate testRestTemplate;

@Test
public void testOAuthAccessTokenIsReturned() {
    MultiValueMap<String, String> request = new LinkedMultiValueMap<String, String>();
    request.set("username", USERNAME);
    request.set("password", password);
    request.set("grant_type", "password");
    @SuppressWarnings("unchecked")
    Map<String, Object> token = this.testRestTemplate.withBasicAuth(CLIENT_NAME, CLIENT_PASSWORD)
            .postForObject(SyntheticsConstants.OAUTH_ENDPOINT, request, Map.class);
    assertNotNull("Wrong response: " + token, token.get("access_token"));
}

Is there a way to do that in a more central place? This way I would have to repeat the password in every testcase that needs Basic Auth. Can the TestRestTemplate be used to always use basic auth somehow? How can I inject the testRestTemplate as a @Bean? — Robert, Jan 11 '17 at 14:03

score 2 · Answer 2 · answered May 16 '17 at 23:22

There is a better solution so you don't need to retype withBasicAuth part each time

@Autowired
private TestRestTemplate testRestTemplate;

@BeforeClass
public void setup() {
    BasicAuthorizationInterceptor bai = new BasicAuthorizationInterceptor(CLIENT_NAME, CLIENT_PASSWORD);
    testRestTemplate.getRestTemplate().getInterceptors().add(bai);
}

@Test
public void testOAuthAccessTokenIsReturned() {
    MultiValueMap<String, String> request = new LinkedMultiValueMap<String, String>();
    request.set("username", USERNAME);
    request.set("password", password);
    request.set("grant_type", "password");
    @SuppressWarnings("unchecked")
    Map<String, Object> token = this.testRestTemplate.postForObject(SyntheticsConstants.OAUTH_ENDPOINT, request, Map.class);
    assertNotNull("Wrong response: " + token, token.get("access_token"));
}

This does not work as setup method needs to be static – Eva M Apr 13 '18 at 12:04 — Eva M, Apr 13 '18 at 12:04
You can try with @BeforeEach, no need to be static – Kumar Abhishek Feb 14 '20 at 19:39 — Kumar Abhishek, Feb 14 '20 at 19:39

fabriziocucci · Answer 3 · 2017-12-27T20:04:25.167

Although the accepted answer is correct, in my case I had to replicate the testRestTemplate.withBasicAuth(...) in each test method and class.

So, I tried to define in src/test/java/my.microservice.package a configuration like this:

@Configuration
@Profile("test")
public class MyMicroserviceConfigurationForTest {

    @Bean
    public TestRestTemplate testRestTemplate(TestRestTemplate testRestTemplate, SecurityProperties securityProperties) {
        return testRestTemplate.withBasicAuth(securityProperties.getUser().getName(), securityProperties.getUser().getPassword());
    }

}

That seems to have the effect of overriding the default TestRestTemplate definition, allowing the injection of a credentials-aware TestRestTemplate anywhere in my test classes.

I'm not entirely sure whether this is really a valid solution but you can give it a try...

score 1 · Answer 4 · answered Dec 13 '18 at 12:11

I think there is a better solution if you are still using Basic Authentication in your application, with the "user.name" and "user.password" properties set on your application.properties file:

public class YourEndpointClassTest {
    private static final Logger logger = LoggerFactory.getLogger(YourEndpointClassTest.class);  

    private static final String BASE_URL = "/your/base/url";

    @TestConfiguration
    static class TestRestTemplateAuthenticationConfiguration {

        @Value("${spring.security.user.name}")
        private String userName;

        @Value("${spring.security.user.password}")
        private String password;

        @Bean
        public RestTemplateBuilder restTemplateBuilder() {
            return new RestTemplateBuilder().basicAuthentication(userName, password);
        }
    }


    @Autowired
    private TestRestTemplate restTemplate;

//here add your tests...

Did not work directly for me but with a separate @Configuration annotated class that implements the shown restTemplateBuilder() method. — yasd, Nov 25 '21 at 11:30

score 1 · Answer 5 · answered Dec 21 '20 at 05:57

In single testcase, you can do like this:

@Test
public void test() {
    ResponseEntity<String> entity = testRestTemplate
            .withBasicAuth("username", "password")
            .postForEntity(xxxx,String.class);
    Assert.assertNotNull(entity.getBody());
}

and for every testcase add this method in your test class:

@Before
public void before() {
    // because .withBasicAuth() creates a new TestRestTemplate with the same 
    // configuration as the autowired one.
     testRestTemplate = testRestTemplate.withBasicAuth("username", "password");
}

How to add basic auth to Autowired testRestTemplate in SpringBootTest; Spring Boot 1.4

5 Answers5

Linked