| /******************************************************************************* |
| * Copyright 2017 General Electric Company |
| * |
| * 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. |
| * |
| * SPDX-License-Identifier: Apache-2.0 |
| *******************************************************************************/ |
| |
| // @formatter:off |
| package com.ge.predix.controller.test; |
| |
| import static org.hamcrest.Matchers.is; |
| import static org.hamcrest.Matchers.isIn; |
| import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; |
| import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; |
| |
| import java.net.URLEncoder; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| |
| import org.springframework.beans.factory.annotation.Autowired; |
| import org.springframework.core.env.ConfigurableEnvironment; |
| import org.springframework.http.HttpStatus; |
| import org.springframework.http.MediaType; |
| import org.springframework.test.context.ActiveProfiles; |
| import org.springframework.test.context.ContextConfiguration; |
| import org.springframework.test.context.testng.AbstractTestNGSpringContextTests; |
| import org.springframework.test.context.web.WebAppConfiguration; |
| import org.springframework.test.util.ReflectionTestUtils; |
| import org.springframework.test.web.servlet.ResultActions; |
| import org.springframework.web.context.WebApplicationContext; |
| import org.testng.Assert; |
| import org.testng.annotations.BeforeClass; |
| import org.testng.annotations.Test; |
| |
| import com.fasterxml.jackson.databind.ObjectMapper; |
| import com.ge.predix.acs.privilege.management.PrivilegeManagementUtility; |
| import com.ge.predix.acs.request.context.AcsRequestContext; |
| import com.ge.predix.acs.request.context.AcsRequestContextHolder; |
| import com.ge.predix.acs.rest.BaseResource; |
| import com.ge.predix.acs.rest.Zone; |
| import com.ge.predix.acs.testutils.MockAcsRequestContext; |
| import com.ge.predix.acs.testutils.MockMvcContext; |
| import com.ge.predix.acs.testutils.MockSecurityContext; |
| import com.ge.predix.acs.testutils.TestActiveProfilesResolver; |
| import com.ge.predix.acs.testutils.TestUtils; |
| import com.ge.predix.acs.utils.JsonUtils; |
| import com.ge.predix.acs.zone.management.ZoneService; |
| |
| @WebAppConfiguration |
| @ContextConfiguration("classpath:controller-tests-context.xml") |
| @ActiveProfiles(resolver = TestActiveProfilesResolver.class) |
| public class ResourcePrivilegeManagementControllerIT extends AbstractTestNGSpringContextTests { |
| static final String RESOURCE_BASE_URL = "/v1/resource"; |
| static final ObjectMapper OBJECT_MAPPER = new ObjectMapper(); |
| static final JsonUtils JSON_UTILS = new JsonUtils(); |
| static final TestUtils TEST_UTILS = new TestUtils(); |
| |
| @Autowired |
| private WebApplicationContext wac; |
| |
| @Autowired |
| private ZoneService zoneService; |
| |
| private Zone testZone; |
| |
| private Zone testZone2; |
| |
| @Autowired |
| private ConfigurableEnvironment env; |
| |
| @BeforeClass |
| public void setup() throws Exception { |
| this.testZone = TEST_UTILS.setupTestZone("ResourceMgmtControllerIT", zoneService); |
| |
| } |
| |
| |
| @Test |
| public void testResourceInvalidMediaTypeResponseStatusCheck() throws Exception { |
| |
| String thisUri = RESOURCE_BASE_URL + "/%2Fservices%2Fsecured-api"; |
| // create resource in first zone |
| MockMvcContext putContext = |
| TEST_UTILS.createWACWithCustomPUTRequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| putContext.getMockMvc().perform(putContext.getBuilder().contentType(MediaType.APPLICATION_OCTET_STREAM_VALUE) |
| .content("testString")).andExpect(status().isUnsupportedMediaType()); |
| |
| } |
| |
| @Test |
| public void resourceZoneDoesNotExistException() throws Exception { |
| // NOTE: To throw a ZoneDoesNotExistException, we must ensure that the AcsRequestContext in the |
| // SpringSecurityZoneResolver class returns a null ZoneEntity |
| MockSecurityContext.mockSecurityContext(null); |
| MockAcsRequestContext.mockAcsRequestContext(); |
| BaseResource resource = JSON_UTILS.deserializeFromFile("controller-test/a-resource.json", |
| BaseResource.class); |
| String thisUri = RESOURCE_BASE_URL + "/%2Fservices%2Fsecured-api"; |
| // create resource in first zone |
| MockMvcContext putContext = |
| TEST_UTILS.createWACWithCustomPUTRequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| ResultActions resultActions = putContext.getMockMvc().perform(putContext.getBuilder(). |
| contentType(MediaType.APPLICATION_JSON).content(OBJECT_MAPPER.writeValueAsString(resource))); |
| resultActions.andExpect(status().isBadRequest()); |
| resultActions.andReturn().getResponse().getContentAsString().contentEquals("Zone not found"); |
| MockSecurityContext.mockSecurityContext(this.testZone); |
| MockAcsRequestContext.mockAcsRequestContext(); |
| } |
| |
| |
| @Test |
| public void testSameResourceDifferentZones() throws Exception { |
| BaseResource resource = JSON_UTILS.deserializeFromFile("controller-test/a-resource.json", |
| BaseResource.class); |
| String thisUri = RESOURCE_BASE_URL + "/%2Fservices%2Fsecured-api"; |
| // create resource in first zone |
| MockMvcContext putContext = |
| TEST_UTILS.createWACWithCustomPUTRequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| putContext.getMockMvc().perform(putContext.getBuilder().contentType(MediaType.APPLICATION_JSON) |
| .content(OBJECT_MAPPER.writeValueAsString(resource))).andExpect(status().isCreated()); |
| |
| // create resource in second zone |
| this.testZone2 = TEST_UTILS.setupTestZone("ResourceMgmtControllerIT2", zoneService); |
| putContext = TEST_UTILS.createWACWithCustomPUTRequestBuilder(this.wac, this.testZone2.getSubdomain(), |
| thisUri); |
| putContext.getMockMvc().perform(putContext.getBuilder().contentType(MediaType.APPLICATION_JSON) |
| .content(OBJECT_MAPPER.writeValueAsString(resource))).andExpect(status().isCreated()); |
| // we expect both resources to be create in each zone |
| // set security context back to first test zone |
| MockSecurityContext.mockSecurityContext(this.testZone); |
| } |
| |
| @Test |
| @SuppressWarnings("unchecked") |
| public void testPOSTResources() throws Exception { |
| |
| List<BaseResource> resources = JSON_UTILS.deserializeFromFile("controller-test/resources-collection.json", |
| List.class); |
| Assert.assertNotNull(resources); |
| |
| // Append a list of resources |
| MockMvcContext postContext = |
| TEST_UTILS.createWACWithCustomPOSTRequestBuilder(this.wac, this.testZone.getSubdomain(), RESOURCE_BASE_URL); |
| postContext.getMockMvc().perform(postContext.getBuilder().contentType(MediaType.APPLICATION_JSON) |
| .content(OBJECT_MAPPER.writeValueAsString(resources))).andExpect(status().isNoContent()); |
| |
| // Get the list of resources |
| MockMvcContext getContext = |
| TEST_UTILS.createWACWithCustomGETRequestBuilder(this.wac, this.testZone.getSubdomain(), RESOURCE_BASE_URL); |
| getContext.getMockMvc().perform(getContext.getBuilder()).andExpect(status().isOk()) |
| .andExpect( |
| jsonPath("$[0].resourceIdentifier", |
| isIn(new String[] { "/services/secured-api", |
| "/services/reports/01928374102398741235123" }))) |
| .andExpect( |
| jsonPath("$[1].resourceIdentifier", |
| isIn(new String[] { "/services/secured-api", |
| "/services/reports/01928374102398741235123" }))) |
| .andExpect(jsonPath("$[0].attributes[0].value", isIn(new String[] { "sales", "admin" }))) |
| .andExpect(jsonPath("$[0].attributes[0].issuer", is("https://acs.attributes.int"))) |
| .andExpect(jsonPath("$[1].attributes[0].value", isIn(new String[] { "sales", "admin" }))) |
| .andExpect(jsonPath("$[1].attributes[0].issuer", is("https://acs.attributes.int"))); |
| |
| BaseResource resource = JSON_UTILS.deserializeFromFile("controller-test/a-resource.json", |
| BaseResource.class); |
| Assert.assertNotNull(resource); |
| |
| String aResourceURI = RESOURCE_BASE_URL + "/%2Fservices%2Fsecured-api"; |
| |
| // Update a given resource |
| MockMvcContext updateContext = |
| TEST_UTILS.createWACWithCustomPUTRequestBuilder(this.wac, this.testZone.getSubdomain(), aResourceURI); |
| updateContext.getMockMvc().perform(updateContext.getBuilder().contentType(MediaType.APPLICATION_JSON) |
| .content(OBJECT_MAPPER.writeValueAsString(resource))).andExpect(status().isNoContent()); |
| |
| // Get a given resource |
| getContext = TEST_UTILS.createWACWithCustomGETRequestBuilder(this.wac, this.testZone.getSubdomain(), |
| aResourceURI); |
| getContext.getMockMvc().perform(getContext.getBuilder()).andExpect(status().isOk()) |
| .andExpect(jsonPath("resourceIdentifier", is("/services/secured-api"))) |
| .andExpect(jsonPath("attributes[0].value", isIn(new String[] { "supervisor", "it" }))) |
| .andExpect(jsonPath("attributes[0].issuer", is("https://acs.attributes.int"))); |
| |
| MockMvcContext deleteContext = |
| TEST_UTILS.createWACWithCustomDELETERequestBuilder(this.wac, this.testZone.getSubdomain(), aResourceURI); |
| |
| // Delete a given resource |
| deleteContext.getMockMvc().perform(deleteContext.getBuilder()).andExpect(status().isNoContent()); |
| |
| // Delete a given resource |
| deleteContext = TEST_UTILS.createWACWithCustomDELETERequestBuilder(this.wac, this.testZone.getSubdomain(), |
| RESOURCE_BASE_URL + "/01928374102398741235123"); |
| deleteContext.getMockMvc().perform(deleteContext.getBuilder()).andExpect(status().isNoContent()); |
| |
| // Make sure resource does not exist anymore |
| getContext = TEST_UTILS.createWACWithCustomGETRequestBuilder(this.wac, this.testZone.getSubdomain(), |
| "/tenant/ge/resource/0192837410239874"); |
| getContext.getMockMvc().perform(getContext.getBuilder()).andExpect(status().isNotFound()); |
| |
| // Make sure resource does not exist anymore |
| getContext = TEST_UTILS.createWACWithCustomGETRequestBuilder(this.wac, this.testZone.getSubdomain(), |
| "/tenant/ge/resource/01928374102398741235123"); |
| getContext.getMockMvc().perform(getContext.getBuilder()).andExpect(status().isNotFound()); |
| } |
| |
| @Test |
| public void testZoneDoesNotExist() throws Exception { |
| |
| Zone testZone3 = new Zone("name", "subdomain", "description"); |
| MockSecurityContext.mockSecurityContext(testZone3); |
| |
| Map<AcsRequestContext.ACSRequestContextAttribute, Object> newMap = new HashMap<>(); |
| newMap.put(AcsRequestContext.ACSRequestContextAttribute.ZONE_ENTITY, null); |
| |
| ReflectionTestUtils.setField(AcsRequestContextHolder.getAcsRequestContext(), |
| "unModifiableRequestContextMap", newMap); |
| |
| MockMvcContext getContext = |
| TEST_UTILS.createWACWithCustomGETRequestBuilder(this.wac, testZone3.getSubdomain(), |
| RESOURCE_BASE_URL + "/test-resource"); |
| getContext.getMockMvc().perform(getContext.getBuilder()).andExpect(status().isBadRequest()) |
| .andExpect(jsonPath(PrivilegeManagementUtility.INCORRECT_PARAMETER_TYPE_ERROR, is("Bad Request"))) |
| .andExpect(jsonPath(PrivilegeManagementUtility.INCORRECT_PARAMETER_TYPE_MESSAGE, |
| is("Zone not found"))); |
| MockAcsRequestContext.mockAcsRequestContext(); |
| } |
| |
| @Test |
| public void testPOSTResourcesMissingResourceId() throws Exception { |
| List<BaseResource> resources = JSON_UTILS.deserializeFromFile( |
| "controller-test/missing-resourceIdentifier-resources-collection.json", List.class); |
| |
| Assert.assertNotNull(resources); |
| |
| // Append a list of resources |
| MockMvcContext postContext = |
| TEST_UTILS.createWACWithCustomPOSTRequestBuilder(this.wac, this.testZone.getSubdomain(), RESOURCE_BASE_URL); |
| postContext.getMockMvc() |
| .perform(postContext.getBuilder().contentType(MediaType.APPLICATION_JSON) |
| .content(OBJECT_MAPPER.writeValueAsString(resources))) |
| .andExpect(status().isUnprocessableEntity()); |
| |
| } |
| |
| @Test |
| @SuppressWarnings("unchecked") |
| public void testPOSTResourcesMissingIdentifier() throws Exception { |
| List<BaseResource> resources = JSON_UTILS |
| .deserializeFromFile("controller-test/missing-identifier-resources-collection.json", List.class); |
| |
| Assert.assertNotNull(resources); |
| |
| // Append a list of resources |
| MockMvcContext postContext = |
| TEST_UTILS.createWACWithCustomPOSTRequestBuilder(this.wac, this.testZone.getSubdomain(), RESOURCE_BASE_URL); |
| postContext.getMockMvc() |
| .perform(postContext.getBuilder().contentType(MediaType.APPLICATION_JSON) |
| .content(OBJECT_MAPPER.writeValueAsString(resources))) |
| .andExpect(status().isUnprocessableEntity()); |
| |
| } |
| |
| @Test |
| @SuppressWarnings("unchecked") |
| public void testPOSTResourcesEmptyIdentifier() throws Exception { |
| List<BaseResource> resources = JSON_UTILS |
| .deserializeFromFile("controller-test/empty-identifier-resources-collection.json", List.class); |
| |
| Assert.assertNotNull(resources); |
| |
| // Append a list of resources |
| MockMvcContext postContext = |
| TEST_UTILS.createWACWithCustomPOSTRequestBuilder(this.wac, this.testZone.getSubdomain(), RESOURCE_BASE_URL); |
| postContext.getMockMvc() |
| .perform(postContext.getBuilder().contentType(MediaType.APPLICATION_JSON) |
| .content(OBJECT_MAPPER.writeValueAsString(resources))) |
| .andExpect(status().isUnprocessableEntity()); |
| } |
| |
| @Test |
| public void testResourceIdentifierMismatch() throws Exception { |
| |
| BaseResource resource = JSON_UTILS.deserializeFromFile("controller-test/a-mismatched-resourceid.json", |
| BaseResource.class); |
| Assert.assertNotNull(resource); |
| |
| String thisUri = RESOURCE_BASE_URL + "/%2Fservices%2Fsecured-api"; |
| |
| // Update a given resource |
| MockMvcContext putContext = |
| TEST_UTILS.createWACWithCustomPUTRequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| putContext.getMockMvc() |
| .perform(putContext.getBuilder().contentType(MediaType.APPLICATION_JSON) |
| .content(OBJECT_MAPPER.writeValueAsString(resource))) |
| .andExpect(status().isUnprocessableEntity()); |
| |
| } |
| |
| @Test |
| public void testTypeMismatchForQueryParameter() throws Exception { |
| |
| // GET a given resource |
| String thisUri = RESOURCE_BASE_URL + "/%2Fservices%2Fsecured-api?includeInheritedAttributes=true)"; |
| MockMvcContext getContext = |
| TEST_UTILS.createWACWithCustomGETRequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| getContext.getMockMvc() |
| .perform(getContext.getBuilder().contentType(MediaType.APPLICATION_JSON)) |
| .andExpect(status().isBadRequest()) |
| .andExpect(jsonPath(PrivilegeManagementUtility.INCORRECT_PARAMETER_TYPE_ERROR, is(HttpStatus |
| .BAD_REQUEST.getReasonPhrase()))) |
| .andExpect(jsonPath(PrivilegeManagementUtility.INCORRECT_PARAMETER_TYPE_MESSAGE, |
| is("Request Parameter " + PrivilegeManagementUtility.INHERITED_ATTRIBUTES_REQUEST_PARAMETER |
| + " must be a boolean value"))); |
| |
| } |
| |
| @Test |
| public void testPUTResourceNoResourceId() throws Exception { |
| |
| BaseResource resource = JSON_UTILS |
| .deserializeFromFile("controller-test/no-resourceIdentifier-resource.json", BaseResource.class); |
| Assert.assertNotNull(resource); |
| |
| String thisUri = RESOURCE_BASE_URL + "/%2Fservices%2Fsecured-api%2Fsubresource"; |
| // Update a given resource |
| MockMvcContext putContext = |
| TEST_UTILS.createWACWithCustomPUTRequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| putContext.getMockMvc().perform(putContext.getBuilder().contentType(MediaType.APPLICATION_JSON) |
| .content(OBJECT_MAPPER.writeValueAsString(resource))).andExpect(status().is2xxSuccessful()); |
| |
| // Get a given resource |
| MockMvcContext getContext = |
| TEST_UTILS.createWACWithCustomGETRequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| getContext.getMockMvc().perform(getContext.getBuilder()).andExpect(status().isOk()) |
| .andExpect(jsonPath("resourceIdentifier", is("/services/secured-api/subresource"))) |
| .andExpect(jsonPath("attributes[0].value", isIn(new String[] { "supervisor", "it" }))) |
| .andExpect(jsonPath("attributes[0].issuer", is("https://acs.attributes.int"))); |
| |
| // Delete a given resource |
| MockMvcContext deleteContext = |
| TEST_UTILS.createWACWithCustomDELETERequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| deleteContext.getMockMvc().perform(deleteContext.getBuilder()).andExpect(status().isNoContent()); |
| } |
| |
| @Test |
| public void testPUTCreateResourceThenUpdateNoResourceIdentifier() throws Exception { |
| |
| BaseResource resource = JSON_UTILS |
| .deserializeFromFile("controller-test/with-resourceIdentifier-resource.json", BaseResource.class); |
| Assert.assertNotNull(resource); |
| |
| String thisUri = RESOURCE_BASE_URL + "/%2Fservices%2Fsecured-api%2Fsubresource"; |
| |
| MockMvcContext putContext = |
| TEST_UTILS.createWACWithCustomPUTRequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| putContext.getMockMvc().perform(putContext.getBuilder().contentType(MediaType.APPLICATION_JSON) |
| .content(OBJECT_MAPPER.writeValueAsString(resource))).andExpect(status().isCreated()); |
| |
| // Get a given resource |
| MockMvcContext getContext = |
| TEST_UTILS.createWACWithCustomGETRequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| getContext.getMockMvc().perform(getContext.getBuilder()).andExpect(status().isOk()) |
| .andExpect(jsonPath("resourceIdentifier", is(resource.getResourceIdentifier()))) |
| .andExpect(jsonPath("attributes[0].value", isIn(new String[] { "supervisor", "it" }))) |
| .andExpect(jsonPath("attributes[0].issuer", is("https://acs.attributes.int"))); |
| |
| // Ensure we can update resource without a resource identifier in json |
| // payload |
| // In this case, the resource identifier must be part of the URI. |
| BaseResource resourceNoResourceIdentifier = JSON_UTILS |
| .deserializeFromFile("controller-test/no-resourceIdentifier-resource.json", BaseResource.class); |
| Assert.assertNotNull(resourceNoResourceIdentifier); |
| |
| // Update a given resource |
| putContext = TEST_UTILS.createWACWithCustomPUTRequestBuilder(this.wac, this.testZone.getSubdomain(), |
| thisUri); |
| putContext.getMockMvc() |
| .perform(putContext.getBuilder().contentType(MediaType.APPLICATION_JSON) |
| .content(OBJECT_MAPPER.writeValueAsString(resourceNoResourceIdentifier))) |
| .andExpect(status().isNoContent()); |
| |
| // Get a given resource |
| getContext = TEST_UTILS.createWACWithCustomGETRequestBuilder(this.wac, this.testZone.getSubdomain(), |
| thisUri); |
| getContext.getMockMvc().perform(getContext.getBuilder()).andExpect(status().isOk()) |
| .andExpect(jsonPath("resourceIdentifier", is(resource.getResourceIdentifier()))) |
| .andExpect(jsonPath("attributes[0].value", isIn(new String[] { "supervisor", "it" }))) |
| .andExpect(jsonPath("attributes[0].issuer", is("https://acs.attributes.int"))); |
| |
| // Delete a given resource |
| MockMvcContext deleteContext = |
| TEST_UTILS.createWACWithCustomDELETERequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| deleteContext.getMockMvc().perform(deleteContext.getBuilder()).andExpect(status().isNoContent()); |
| |
| } |
| |
| @Test |
| public void testPathVariablesWithSpecialCharacters() throws Exception { |
| |
| // If the given string violates RFC 2396 it will throw http 422 |
| // error |
| // The following characters are valid: @#!$*&()_-+=[]:;{}'~`, |
| String decoded = "/services/special/@#!$*&()_-+=[]:;{}'~`,"; |
| String encoded = URLEncoder.encode(decoded, "UTF-8"); |
| String thisUri = RESOURCE_BASE_URL + "/" + encoded; |
| |
| BaseResource resource = JSON_UTILS |
| .deserializeFromFile("controller-test/special-character-resource-identifier.json", BaseResource.class); |
| Assert.assertNotNull(resource); |
| |
| MockMvcContext putContext = |
| TEST_UTILS.createWACWithCustomPUTRequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| putContext.getMockMvc().perform(putContext.getBuilder().contentType(MediaType.APPLICATION_JSON) |
| .content(OBJECT_MAPPER.writeValueAsString(resource))).andExpect(status().isCreated()); |
| |
| MockMvcContext getContext = |
| TEST_UTILS.createWACWithCustomGETRequestBuilder(this.wac, this.testZone.getSubdomain(), thisUri); |
| getContext.getMockMvc().perform(getContext.getBuilder()).andExpect(status().isOk()) |
| .andExpect(jsonPath("resourceIdentifier", is(decoded))); |
| } |
| |
| } |
| // @formatter:on |
