一尘不染

带有HATEOAS PagedResources的Spring Boot的TestRestTemplate

spring-boot

我正在尝试在我的Spring Boot应用程序的Integration-Test中使用TestRestTemplate向Spring Data
REST存储库发出请求。

浏览器中的响应具有以下形式:

{
"links": [
    {
        "rel": "self",
        "href": "http://localhost:8080/apiv1/data/users"
    },
    {
        "rel": "profile",
        "href": "http://localhost:8080/apiv1/data/profile/users"
    },
    {
        "rel": "search",
        "href": "http://localhost:8080/apiv1/data/users/search"
    }
],
"content": [
    {
        "username": "admin",
        "enabled": true,
        "firstName": null,
        "lastName": null,
        "permissions": [ ],
        "authorities": [
            "ROLE_ADMIN"
        ],
        "accountNonExpired": true,
        "accountNonLocked": true,
        "credentialsNonExpired": true,
        "content": [ ],
        "links": [
            {
                "rel": "self",
                "href": "http://localhost:8080/apiv1/data/users/1"
            },
            {
                "rel": "myUser",
                "href": "http://localhost:8080/apiv1/data/users/1"
            },
            {
                "rel": "mandant",
                "href": "http://localhost:8080/apiv1/data/users/1/mandant"
            }
        ]
    },
    {
        "username": "dba",
        "enabled": true,
        "firstName": null,
        "lastName": null,
        "permissions": [ ],
        "authorities": [
            "ROLE_DBA"
        ],
        "accountNonExpired": true,
        "accountNonLocked": true,
        "credentialsNonExpired": true,
        "content": [ ],
        "links": [
            {
                "rel": "self",
                "href": "http://localhost:8080/apiv1/data/users/2"
            },
            {
                "rel": "myUser",
                "href": "http://localhost:8080/apiv1/data/users/2"
            },
            {
                "rel": "mandant",
                "href": "http://localhost:8080/apiv1/data/users/2/mandant"
            }
        ]
    },
    {
        "username": "user",
        "enabled": true,
        "firstName": null,
        "lastName": null,
        "permissions": [ ],
        "authorities": [
            "ROLE_USER"
        ],
        "accountNonExpired": true,
        "accountNonLocked": true,
        "credentialsNonExpired": true,
        "content": [ ],
        "links": [
            {
                "rel": "self",
                "href": "http://localhost:8080/apiv1/data/users/3"
            },
            {
                "rel": "myUser",
                "href": "http://localhost:8080/apiv1/data/users/3"
            },
            {
                "rel": "mandant",
                "href": "http://localhost:8080/apiv1/data/users/3/mandant"
            }
        ]
    }
],
"page": {
    "size": 20,
    "totalElements": 3,
    "totalPages": 1,
    "number": 0
}
}

这是测试:

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@ActiveProfiles("unittest")
public class MyUserRepositoryIntegrationTest {
  private static Logger logger = LoggerFactory.getLogger(MyUserRepositoryIntegrationTest.class);
  private static final int NUM_USERS = 4;
  private static final String USER_URL = "/apiv1/data/users";

  @Autowired
  private TestRestTemplate restTemplate;

  @Test
  public void listUsers() {
    ResponseEntity<PagedResources<MyUser>> response = restTemplate.withBasicAuth("user", "user").exchange(USER_URL,
        HttpMethod.GET, null, new ParameterizedTypeReference<PagedResources<MyUser>>() {
        });
    assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK);
    logger.debug("Res : " + response.getBody().toString());
    assertThat(response.getBody().getContent().size()).isEqualTo(NUM_USERS);
  }

  @TestConfiguration
  public static class MyTestConfig {
    @Autowired
    @Qualifier("halJacksonHttpMessageConverter")
    private TypeConstrainedMappingJackson2HttpMessageConverter halJacksonHttpMessageConverter;

    @Bean
    public RestTemplateBuilder restTemplateBuilder() {
      return new RestTemplateBuilder().messageConverters(halJacksonHttpMessageConverter);
    }
  }
}

问题是,我没有得到内容。有趣的是,元数据(分页信息)在那里。

我的TestConfig被检测到了,但我认为它没有使用’halJacksonHttpMessageConverter’(我从这里获得:https :
//github.com/bijukunjummen/hateoas-
sample/blob/master/src/test/java/univ/HALRestTemplateIntegrationTests。
java)。这就是为什么我使用“
messageConverters()”而不是“ additionalMessageConverters()”的原因(无济于事)。

这是日志:

m.m.a.RequestResponseBodyMethodProcessor : Written [PagedResource { content: [Resource { content: at.mycompany.myapp.auth.MyUser@7773211c, links: [<http://localhost:51708/apiv1/data/users/1>;rel="self", <http://localhost:51708/apiv1/data/users/1>;rel="logisUser"] }, Resource { content: at.mycompany.myapp.auth.MyUser@2c96fdee, links: [<http://localhost:51708/apiv1/data/users/2>;rel="self", <http://localhost:51708/apiv1/data/users/2>;rel="logisUser"] }, Resource { content: at.mycompany.myapp.auth.MyUser@1ddfd104, links: [<http://localhost:51708/apiv1/data/users/3>;rel="self", <http://localhost:51708/apiv1/data/users/3>;rel="logisUser"] }, Resource { content: at.mycompany.myapp.auth.MyUser@55d71419, links: [<http://localhost:51708/apiv1/data/users/4>;rel="self", <http://localhost:51708/apiv1/data/users/4>;rel="logisUser"] }], metadata: Metadata { number: 0, total pages: 1, total elements: 4, size: 20 }, links: [<http://localhost:51708/apiv1/data/users>;rel="self", <http://localhost:51708/apiv1/data/profile/users>;rel="profile", <http://localhost:51708/apiv1/data/users/search>;rel="search"] }] as "application/hal+json" using [org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration$ResourceSupportHttpMessageConverter@2f58f492]
o.s.web.servlet.DispatcherServlet        : Null ModelAndView returned to DispatcherServlet with name 'dispatcherServlet': assuming HandlerAdapter completed request handling
o.s.web.client.RestTemplate              : GET request for "http://localhost:51708/apiv1/data/users" resulted in 200 (null)
o.s.web.servlet.DispatcherServlet        : Successfully completed request
o.s.web.client.RestTemplate              : Reading [org.springframework.hateoas.PagedResources<at.mycompany.myapp.auth.MyUser>] as "application/hal+json;charset=UTF-8" using [org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration$ResourceSupportHttpMessageConverter@10ad95cd]
o.s.b.w.f.OrderedRequestContextFilter    : Cleared thread-bound request context: org.apache.catalina.connector.RequestFacade@76e257e2
d.l.a.MyUserRepositoryIntegrationTest : Res : PagedResource { content: [], metadata: Metadata { number: 0, total pages: 1, total elements: 4, size: 20 }, links: [] }

覆盖restTemplate Bean的想法来自以下文档:https ://docs.spring.io/spring-
boot/docs/current/reference/html/boot-features-testing.html#boot-features-
rest-templates- 测试效用

有什么想法可以简单地进行一些REST调用并获得测试对象的答案?


阅读 236

收藏
2020-05-30

共1个答案

一尘不染

我切换到MockMvc,一切正常:

import static org.hamcrest.Matchers.hasSize;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@ActiveProfiles("unittest")
public class MyUserRepositoryIntegrationTest {
    @Autowired WebApplicationContext context;
    @Autowired FilterChainProxy filterChain;
    MockMvc mvc;

    @Before
    public void setupTests() {
    this.mvc = MockMvcBuilders.webAppContextSetup(context).addFilters(filterChain).build();

    @Test
    public void listUsers() throws Exception {
      HttpHeaders headers = new HttpHeaders();
      headers.add(HttpHeaders.ACCEPT, MediaTypes.HAL_JSON_VALUE);
      headers.add(HttpHeaders.AUTHORIZATION, "Basic " + new String(Base64.encode(("user:user").getBytes())));

      mvc.perform(get(USER_URL).headers(headers))
          .andExpect(content().contentTypeCompatibleWith(MediaTypes.HAL_JSON))
          .andExpect(status().isOk())
          .andExpect(jsonPath("$.content", hasSize(NUM_USERS)));
    }
}

编辑:

对于那些感兴趣的人,基于WellingtonSouza解决方案的替代解决方案:

尽管jsonpath非常强大,但我还没有找到一种使用MockMvc将JSON解组为实际对象的方法。

如果查看我发布的JSON输出,您会注意到,它不是默认的Spring DataRestHAL+JSON输出。我将属性data.rest.defaultMediaType更改为“ application /
json”。这样,我也无法让特拉弗森工作。但是,当我停用它时,以下工作原理:

import static org.assertj.core.api.Assertions.assertThat;
import static org.hamcrest.Matchers.hasSize;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

import org.springframework.hateoas.MediaTypes;
import org.springframework.hateoas.PagedResources;
import org.springframework.hateoas.client.Hop;
import org.springframework.hateoas.client.Traverson;
import org.springframework.http.HttpHeaders;
import org.springframework.security.crypto.codec.Base64;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@ActiveProfiles("unittest")
public class MyUserRepositoryIntegrationTest {
  private static HttpHeaders userHeaders;
  private static HttpHeaders adminHeaders;

  @LocalServerPort
  private int port;

  @BeforeClass
  public static void setupTests() {
    MyUserRepositoryIntegrationTest.userHeaders = new HttpHeaders();
    MyUserRepositoryIntegrationTest.userHeaders.add(HttpHeaders.ACCEPT, MediaTypes.HAL_JSON_VALUE);
    MyUserRepositoryIntegrationTest.userHeaders.add(HttpHeaders.AUTHORIZATION,
        "Basic " + new String(Base64.encode(("user:user").getBytes())));

    MyUserRepositoryIntegrationTest.adminHeaders = new HttpHeaders();
    MyUserRepositoryIntegrationTest.adminHeaders.add(HttpHeaders.ACCEPT, MediaTypes.HAL_JSON_VALUE);
    MyUserRepositoryIntegrationTest.adminHeaders.add(HttpHeaders.AUTHORIZATION,
        "Basic " + new String(Base64.encode(("admin:admin").getBytes())));
  }

  @Test
  public void listUsersSorted() throws Exception {
    final ParameterizedTypeReference<PagedResources<MyUser>> resourceParameterizedTypeReference = //
        new ParameterizedTypeReference<PagedResources<MyUser>>() {
        };

    final PagedResources<MyUser> actual = new Traverson(new URI("http://localhost:" + port + "/apiv1/data"),
        MediaTypes.HAL_JSON)//
            .follow(Hop.rel("myUsers").withParameter("sort", "username,asc"))//
            .withHeaders(userHeaders)//
            .toObject(resourceParameterizedTypeReference);

    assertThat(actual.getContent()).isNotNull().isNotEmpty();
    assertThat(actual.getContent()//
        .stream()//
        .map(user -> user.getUsername())//
        .collect(Collectors.toList())//
    ).isSorted();
  }
}

(注意:可能不包含所有导入内容,因为我是从较大的Test Class复制而来的。)

“ .withParam”适用于模板化URL,即那些接受查询参数的URL。如果您尝试使用原始URL,它将失败,因为链接的字面意思是“ http://[…] / users {option1,option2,…}”,因此格式不正确。

2020-05-30