From 1f9dc1a6464fc0dc015256908a87c110c073528a Mon Sep 17 00:00:00 2001 From: Greg Turnquist Date: Thu, 30 Jul 2015 18:21:35 -0500 Subject: [PATCH] DATAREST-630 - ALPS metadata now only exposes identifier property if explicitly configured to. The ALPS metadata exposed now considers the id exposure configuration to decide whether to skip the identifier property or not. Original pull request: #189. --- ...eInformationToAlpsDescriptorConverter.java | 14 ++- .../alps/AlpsControllerIntegrationTests.java | 17 ++- ...ntrollerWithExposedIdIntegrationTests.java | 119 ++++++++++++++++++ 3 files changed, 145 insertions(+), 5 deletions(-) create mode 100644 spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/alps/AlpsControllerWithExposedIdIntegrationTests.java diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/alps/RootResourceInformationToAlpsDescriptorConverter.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/alps/RootResourceInformationToAlpsDescriptorConverter.java index a1ae746ea..ad0cfa399 100644 --- a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/alps/RootResourceInformationToAlpsDescriptorConverter.java +++ b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/alps/RootResourceInformationToAlpsDescriptorConverter.java @@ -50,8 +50,11 @@ import org.springframework.data.rest.core.mapping.SimpleResourceDescription; import org.springframework.data.rest.core.mapping.SupportedHttpMethods; import org.springframework.data.rest.webmvc.RootResourceInformation; import org.springframework.data.rest.webmvc.json.JacksonMetadata; +import org.springframework.data.rest.webmvc.json.JsonSchema; import org.springframework.data.rest.webmvc.mapping.AssociationLinks; import org.springframework.data.rest.webmvc.mapping.PropertyMappings; +import org.springframework.data.util.ClassTypeInformation; +import org.springframework.data.util.TypeInformation; import org.springframework.hateoas.EntityLinks; import org.springframework.hateoas.Link; import org.springframework.hateoas.TemplateVariable; @@ -305,7 +308,7 @@ public class RootResourceInformationToAlpsDescriptorConverter { return descriptors; } - private List buildPropertyDescriptors(Class type, final String baseRel) { + private List buildPropertyDescriptors(final Class type, String baseRel) { final PersistentEntity entity = persistentEntities.getPersistentEntity(type); final List propertyDescriptors = new ArrayList(); @@ -322,6 +325,15 @@ public class RootResourceInformationToAlpsDescriptorConverter { ResourceMapping propertyMapping = propertyMappings.getMappingFor(property); if (propertyDefinition != null) { + PersistentProperty persistentProperty = entity.getPersistentProperty(propertyDefinition.getInternalName()); + TypeInformation propertyType = persistentProperty == null ? ClassTypeInformation.from(propertyDefinition + .getPrimaryMember().getRawType()) : persistentProperty.getTypeInformation(); + Class rawEntityType = entity.getTypeInformation().getType(); + + if (persistentProperty.isIdProperty() && !configuration.isIdExposedFor(type)) { + return; + } + propertyDescriptors.add(// descriptor(). // type(Type.SEMANTIC).// diff --git a/spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/alps/AlpsControllerIntegrationTests.java b/spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/alps/AlpsControllerIntegrationTests.java index 9d5fd651b..d87e52172 100644 --- a/spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/alps/AlpsControllerIntegrationTests.java +++ b/spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/alps/AlpsControllerIntegrationTests.java @@ -25,7 +25,11 @@ import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; +import org.springframework.data.rest.core.config.RepositoryRestConfiguration; import org.springframework.data.rest.webmvc.AbstractControllerIntegrationTests; +import org.springframework.data.rest.webmvc.TestMvcClient; +import org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration; +import org.springframework.data.rest.webmvc.jpa.Item; import org.springframework.data.rest.webmvc.jpa.JpaRepositoryConfig; import org.springframework.hateoas.Link; import org.springframework.hateoas.LinkDiscoverer; @@ -33,6 +37,7 @@ import org.springframework.hateoas.LinkDiscoverers; import org.springframework.hateoas.core.JsonPathLinkDiscoverer; import org.springframework.http.MediaType; import org.springframework.mock.web.MockHttpServletResponse; +import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.web.WebAppConfiguration; import org.springframework.test.web.servlet.MockMvc; @@ -53,7 +58,7 @@ public class AlpsControllerIntegrationTests extends AbstractControllerIntegratio @Autowired LinkDiscoverers discoverers; @Configuration - static class Config { + static class Config extends RepositoryRestMvcConfiguration { @Bean public LinkDiscoverer alpsLinkDiscoverer() { @@ -120,10 +125,11 @@ public class AlpsControllerIntegrationTests extends AbstractControllerIntegratio assertThat(usersLink, is(nullValue())); mvc.perform(get(itemsLink.getHref())) - .andExpect(jsonPath("$.descriptors[*].descriptors[*].name", hasItems("id", "name"))) + .andExpect(jsonPath("$.descriptors[*].descriptors[*].name", hasItems("name"))) + .andExpect(jsonPath("$.descriptors[*].descriptors[*].name", not(hasItems("id")))) .andExpect( - jsonPath("$.descriptors[*].descriptors[*].name", everyItem(not(isIn(new String[] { "owner", "manager", - "curator" }))))); + jsonPath("$.descriptors[*].descriptors[*].name", everyItem(not(isIn(new String[]{"owner", "manager", + "curator"}))))); } /** @@ -159,6 +165,9 @@ public class AlpsControllerIntegrationTests extends AbstractControllerIntegratio jsonPath(jsonPath, allOf(containsString("alps"), endsWith("-representation")))); } + /** + * TODO: Switch to {@link TestMvcClient#discoverUnique(String)} + */ private Link discoverUnique(String href, String rel) throws Exception { MockHttpServletResponse response = mvc.perform(get(href)).// diff --git a/spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/alps/AlpsControllerWithExposedIdIntegrationTests.java b/spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/alps/AlpsControllerWithExposedIdIntegrationTests.java new file mode 100644 index 000000000..b39330cf9 --- /dev/null +++ b/spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/alps/AlpsControllerWithExposedIdIntegrationTests.java @@ -0,0 +1,119 @@ +/* + * Copyright 2015 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.springframework.data.rest.webmvc.alps; + +import static org.hamcrest.Matchers.*; +import static org.junit.Assert.assertThat; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; + +import org.junit.Before; +import org.junit.Test; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.rest.core.config.RepositoryRestConfiguration; +import org.springframework.data.rest.webmvc.AbstractControllerIntegrationTests; +import org.springframework.data.rest.webmvc.TestMvcClient; +import org.springframework.data.rest.webmvc.config.RepositoryRestConfigurerAdapter; +import org.springframework.data.rest.webmvc.jpa.Item; +import org.springframework.data.rest.webmvc.jpa.JpaRepositoryConfig; +import org.springframework.hateoas.Link; +import org.springframework.hateoas.LinkDiscoverer; +import org.springframework.hateoas.LinkDiscoverers; +import org.springframework.hateoas.core.JsonPathLinkDiscoverer; +import org.springframework.http.MediaType; +import org.springframework.mock.web.MockHttpServletResponse; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.web.WebAppConfiguration; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.test.web.servlet.setup.MockMvcBuilders; +import org.springframework.web.context.WebApplicationContext; + +/** + * Additional integration tests for {@link AlpsController} with a different {@link RepositoryRestConfiguration} via the + * {@link RepositoryRestConfigurerAdapter}. + * + * @author Greg Turnquist + */ +@WebAppConfiguration +@ContextConfiguration(classes = { JpaRepositoryConfig.class, AlpsControllerWithExposedIdIntegrationTests.Config.class }) +public class AlpsControllerWithExposedIdIntegrationTests extends AbstractControllerIntegrationTests { + + @Autowired WebApplicationContext context; + @Autowired LinkDiscoverers discoverers; + + @Configuration + static class Config extends RepositoryRestConfigurerAdapter { + + @Bean + public LinkDiscoverer alpsLinkDiscoverer() { + return new JsonPathLinkDiscoverer("$.descriptors[?(@.name == '%s')].href", + MediaType.valueOf("application/alps+json")); + } + + @Override + public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config) { + config.exposeIdsFor(Item.class); + } + } + + protected MockMvc mvc; + + private TestMvcClient testMvcClient; + + @Before + public void setUp() { + + this.mvc = MockMvcBuilders.webAppContextSetup(context).build(); + this.testMvcClient = new TestMvcClient(this.mvc, this.discoverers); + } + + /** + * @see DATAREST-630 + */ + @Test + public void verifyThatIdAttributesAreOnlyShownWhenExposedInTheConfiguration() throws Exception { + + Link profileLink = discoverUnique("/", "profile"); + Link usersLink = discoverUnique(profileLink.getHref(), "users"); + Link itemsLink = discoverUnique(profileLink.getHref(), "items"); + + assertThat(usersLink, is(nullValue())); + + mvc.perform(get(itemsLink.getHref())) + .andExpect(jsonPath("$.descriptors[*].descriptors[*].name", hasItems("id", "name"))) + .andExpect( + jsonPath("$.descriptors[*].descriptors[*].name", everyItem(not(isIn(new String[] { "owner", "manager", + "curator" }))))); + } + + /** + * TODO: Switch to {@link TestMvcClient#discoverUnique(String)} + */ + private Link discoverUnique(String href, String rel) throws Exception { + + MockHttpServletResponse response = mvc.perform(get(href)).// + andExpect(status().is2xxSuccessful()).// + andReturn().getResponse(); + + LinkDiscoverer discoverer = discoverers.getLinkDiscovererFor(MediaType.valueOf(response.getContentType())); + return discoverer.findLinkWithRel(rel, response.getContentAsString()); + } + +}