From: Wojciech Sliwka Date: Fri, 1 Feb 2019 10:28:19 +0000 (+0000) Subject: Merge "Introduce JS unit tests into VID" X-Git-Tag: 4.0.0~89 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=fd2a54c8aee2bfc4ae2f62a2eac392aad66d2578;hp=ec4f95457ec430838feeae6da48d0fd011ddffa9;p=vid.git Merge "Introduce JS unit tests into VID" --- diff --git a/deliveries/pom.xml b/deliveries/pom.xml index 48b588ec5..1b89e1e5c 100755 --- a/deliveries/pom.xml +++ b/deliveries/pom.xml @@ -43,7 +43,7 @@ io.fabric8 docker-maven-plugin - 0.16.5 + 0.28.0 true diff --git a/deliveries/src/main/docker/docker-files/Dockerfile b/deliveries/src/main/docker/docker-files/Dockerfile index 02cc98f23..4c1dd7b65 100755 --- a/deliveries/src/main/docker/docker-files/Dockerfile +++ b/deliveries/src/main/docker/docker-files/Dockerfile @@ -1,8 +1,7 @@ -FROM tomcat:8.0-jre8 +FROM tomcat:8.0-jre8-alpine # add vim and uncomment alias to speedup troubleshooting purpose -RUN apt-get update && apt-get install -y \ - openjdk-8-jdk vim net-tools +RUN apk update && apk add openjdk8 vim net-tools COPY conf.d/ /etc/onap/vid/conf.d/ diff --git a/epsdk-app-onap/src/main/java/org/onap/portalapp/conf/ExternalAppConfig.java b/epsdk-app-onap/src/main/java/org/onap/portalapp/conf/ExternalAppConfig.java index fc45f1c27..e29218d9f 100644 --- a/epsdk-app-onap/src/main/java/org/onap/portalapp/conf/ExternalAppConfig.java +++ b/epsdk-app-onap/src/main/java/org/onap/portalapp/conf/ExternalAppConfig.java @@ -82,8 +82,7 @@ import java.util.List; @EnableAspectJAutoProxy(proxyTargetClass=true) public class ExternalAppConfig extends AppConfig implements Configurable { - private RegistryAdapter schedulerRegistryAdapter; - /** The Constant LOG. */ + /** The Constant LOG. */ private static final EELFLoggerDelegate LOG = EELFLoggerDelegate.getLogger(ExternalAppConfig.class); /** The vid schema script. */ @@ -102,31 +101,13 @@ public class ExternalAppConfig extends AppConfig implements Configurable { static class InnerConfiguration { } - /** - * @see org.onap.portalsdk.core.conf.AppConfig#viewResolver() - */ - @Override - public ViewResolver viewResolver() { - return super.viewResolver(); - } - - /** - * @see org.onap.portalsdk.core.conf.AppConfig#addResourceHandlers(ResourceHandlerRegistry) - * - * @param registry - */ - @Override - public void addResourceHandlers(ResourceHandlerRegistry registry) { - super.addResourceHandlers(registry); - } - /** * @see org.onap.portalsdk.core.conf.AppConfig#dataAccessService() */ @Override public DataAccessService dataAccessService() { // Echo the JDBC URL to assist developers when starting the app. - System.out.println("ExternalAppConfig: " + SystemProperties.DB_CONNECTIONURL + " is " + LOG.info("ExternalAppConfig: " + SystemProperties.DB_CONNECTIONURL + " is " + SystemProperties.getProperty(SystemProperties.DB_CONNECTIONURL)); return super.dataAccessService(); } @@ -211,25 +192,6 @@ public class ExternalAppConfig extends AppConfig implements Configurable { populator.addScript(vidDataScript); return populator; } - - - /*@Bean - public SpringLiquibase liquibaseBean(DataSource dataSource) { - SpringLiquibase springLiquibase = new SpringLiquibase(); - springLiquibase.setDataSource(dataSource); - springLiquibase.setChangeLog("classpath:db-master-changelog.xml"); - return springLiquibase; - }*/ - - /** - * Sets the scheduler registry adapter. - * - * @param schedulerRegistryAdapter - */ - @Autowired - public void setSchedulerRegistryAdapter(final RegistryAdapter schedulerRegistryAdapter) { - this.schedulerRegistryAdapter = schedulerRegistryAdapter; - } @Bean public LoginStrategy loginStrategy() { diff --git a/epsdk-app-onap/src/main/java/org/onap/portalapp/conf/ExternalAppInitializer.java b/epsdk-app-onap/src/main/java/org/onap/portalapp/conf/ExternalAppInitializer.java index dc6973fef..7c1b5c693 100644 --- a/epsdk-app-onap/src/main/java/org/onap/portalapp/conf/ExternalAppInitializer.java +++ b/epsdk-app-onap/src/main/java/org/onap/portalapp/conf/ExternalAppInitializer.java @@ -38,43 +38,22 @@ package org.onap.portalapp.conf; import org.onap.portalsdk.core.conf.AppInitializer; +import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate; import java.util.TimeZone; public class ExternalAppInitializer extends AppInitializer { - @Override - protected Class[] getRootConfigClasses() { - return super.getRootConfigClasses(); - } + private static final EELFLoggerDelegate LOG = EELFLoggerDelegate.getLogger(ExternalAppInitializer.class); @Override protected Class[] getServletConfigClasses() { Class appConfigClass = ExternalAppConfig.class; // Show something on stdout to indicate the app is starting. - System.out.println("ExternalAppInitializer: servlet configuration class is " + appConfigClass.getName()); + LOG.info("ExternalAppInitializer: servlet configuration class is " + appConfigClass.getName()); return new Class[] { appConfigClass }; } - /* - * URL request will direct to the Spring dispatcher for processing - */ - @Override - protected String[] getServletMappings() { - return super.getServletMappings(); - } - -// @Override -// public void onStartup(ServletContext servletContext) throws ServletException { -// super.onStartup(servletContext); -// setDefaultTimeZoneToUTC(); -// servletContext.addFilter("requestFromLocalhost", LocalhostFilter.class) -// .addMappingForUrlPatterns(null, false, -// String.format("/%s/%s/*", ChangeManagementController.CHANGE_MANAGEMENT, ChangeManagementController.VNF_WORKFLOW_RELATION), -// String.format("/%s/*", RoleGeneratorController.GENERATE_ROLE_SCRIPT), -// String.format("/%s/*", MaintenanceController.MAINTENANCE)); -// } - //set time zone to UTC so Dates would be written to DB in UTC timezone private void setDefaultTimeZoneToUTC() { System.setProperty("user.timezone", "UTC"); diff --git a/epsdk-app-onap/src/main/java/org/onap/portalapp/filter/SecurityXssFilter.java b/epsdk-app-onap/src/main/java/org/onap/portalapp/filter/SecurityXssFilter.java index 71ab7359a..d9d1b6dcd 100644 --- a/epsdk-app-onap/src/main/java/org/onap/portalapp/filter/SecurityXssFilter.java +++ b/epsdk-app-onap/src/main/java/org/onap/portalapp/filter/SecurityXssFilter.java @@ -89,13 +89,13 @@ public class SecurityXssFilter extends OncePerRequestFilter { protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException { - if (request.getMethod().equalsIgnoreCase("POST") || request.getMethod().equalsIgnoreCase("PUT")) { + if ("POST".equalsIgnoreCase(request.getMethod())|| "PUT".equalsIgnoreCase(request.getMethod())) { HttpServletRequest requestToCache = new ContentCachingRequestWrapper(request); HttpServletResponse responseToCache = new ContentCachingResponseWrapper(response); filterChain.doFilter(requestToCache, responseToCache); String requestData = getRequestData(requestToCache); - String responseData = getResponseData(responseToCache); + getResponseData(responseToCache); if (StringUtils.isNotBlank(requestData) && validator.denyXSS(requestData)) { throw new SecurityException(BAD_REQUEST); } diff --git a/epsdk-app-onap/src/test/java/org/onap/portalapp/conf/ExternalAppConfigTest.java b/epsdk-app-onap/src/test/java/org/onap/portalapp/conf/ExternalAppConfigTest.java index 120ea25ec..693df2f24 100644 --- a/epsdk-app-onap/src/test/java/org/onap/portalapp/conf/ExternalAppConfigTest.java +++ b/epsdk-app-onap/src/test/java/org/onap/portalapp/conf/ExternalAppConfigTest.java @@ -72,7 +72,6 @@ public class ExternalAppConfigTest { // default test testSubject = createTestSubject(); - testSubject.setSchedulerRegistryAdapter(schedulerRegistryAdapter); } @Test diff --git a/vid-app-common/src/main/java/org/onap/vid/controller/PropertyController.java b/vid-app-common/src/main/java/org/onap/vid/controller/PropertyController.java index 2f8d6e299..579f17a7d 100644 --- a/vid-app-common/src/main/java/org/onap/vid/controller/PropertyController.java +++ b/vid-app-common/src/main/java/org/onap/vid/controller/PropertyController.java @@ -4,12 +4,14 @@ * ================================================================================ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. * ================================================================================ + * Modifications Copyright 2019 Nokia + * ================================================================================ * 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. @@ -22,12 +24,11 @@ package org.onap.vid.controller; import org.onap.portalsdk.core.controller.RestrictedBaseController; import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate; -import org.onap.portalsdk.core.util.SystemProperties; import org.onap.vid.category.CategoryParametersResponse; import org.onap.vid.model.CategoryParameter.Family; import org.onap.vid.services.CategoryParameterService; +import org.onap.vid.utils.SystemPropertiesWrapper; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.*; import org.springframework.web.servlet.ModelAndView; @@ -35,92 +36,59 @@ import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import static org.onap.vid.utils.Logging.getMethodName; +import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR; +import static org.springframework.http.HttpStatus.OK; -/** - * The Class PropertyController. - */ @RestController -public class PropertyController extends RestrictedBaseController{ - +public class PropertyController extends RestrictedBaseController { - /** The logger. */ - private static final EELFLoggerDelegate LOGGER = EELFLoggerDelegate.getLogger(PropertyController.class); + private static final String ERROR_MESSAGE = "Internal error occurred: "; + private static final EELFLoggerDelegate LOGGER = EELFLoggerDelegate.getLogger(PropertyController.class); + private final CategoryParameterService categoryParameterService; + private final SystemPropertiesWrapper systemPropertiesWrapper; - @Autowired - protected CategoryParameterService categoryParameterService; + @Autowired + public PropertyController(CategoryParameterService service, SystemPropertiesWrapper systemPropertiesWrapper) { + categoryParameterService = service; + this.systemPropertiesWrapper = systemPropertiesWrapper; + } - - /** - * Welcome. - * - * @param request the request - * @return the model and view - */ - @RequestMapping(value = {"/propertyhome" }, method = RequestMethod.GET) - public ModelAndView welcome(HttpServletRequest request) { - LOGGER.debug(EELFLoggerDelegate.debugLogger, "<== PropertyController welcome start"); - return new ModelAndView(getViewName()); - } - - /** - * Gets the property. - * - * @param name the name - * @param defaultvalue the defaultvalue - * @param request the request - * @return the property - * @throws Exception the exception - */ - @RequestMapping(value = "/get_property/{name}/{defaultvalue}", method = RequestMethod.GET) - public ResponseEntity getProperty (@PathVariable("name") String name, @PathVariable("defaultvalue") String defaultvalue, - HttpServletRequest request) { - - String methodName = "getProperty"; - ResponseEntity resp = null; - String pvalue = null; - LOGGER.debug(EELFLoggerDelegate.debugLogger, "<== " + methodName + " start"); - - try { - // convert "_" to "." in the property name - if (name == null || name.length() == 0 ) { - return ( new ResponseEntity (defaultvalue, HttpStatus.OK)); - } - // convert "_" to "." in the property name - String propertyName = name.replace('_', '.'); - pvalue = SystemProperties.getProperty(propertyName); - if ( ( pvalue == null ) || ( pvalue.length() == 0 ) ) { - pvalue = defaultvalue; - } - resp = new ResponseEntity<>(pvalue, HttpStatus.OK); - } - catch (Exception e) { - LOGGER.info(EELFLoggerDelegate.errorLogger, "<== " + "." + methodName + e.toString()); - LOGGER.debug(EELFLoggerDelegate.debugLogger, "<== " + "." + methodName + e.toString()); - throw e; - } - LOGGER.debug(EELFLoggerDelegate.debugLogger, "<== " + methodName + " returning " + pvalue); - return ( resp ); - } + @RequestMapping(value = {"/propertyhome"}, method = RequestMethod.GET) + public ModelAndView welcome(HttpServletRequest request) { + LOGGER.debug(EELFLoggerDelegate.debugLogger, "<== PropertyController welcome start"); + return new ModelAndView(getViewName()); + } - /** - * Gets the owning entity properties. - * @param request the request - * @return the property - * @throws Exception the exception - */ - @RequestMapping(value = "/category_parameter", method = RequestMethod.GET) - public ResponseEntity getCategoryParameter(HttpServletRequest request, @RequestParam(value="familyName", required = true) Family familyName) { - LOGGER.debug(EELFLoggerDelegate.debugLogger, "start {}({})", getMethodName()); - try { - CategoryParametersResponse response = categoryParameterService.getCategoryParameters(familyName); - LOGGER.debug(EELFLoggerDelegate.debugLogger, "end {}() => {}", getMethodName(), response); - return new ResponseEntity<>(response, HttpStatus.OK); - } - catch (Exception exception) { - LOGGER.error("failed to retrieve category parameter list from DB.", exception); - return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR); - } - } + @RequestMapping(value = "/get_property/{name}/{defaultvalue}", method = RequestMethod.GET) + public ResponseEntity getProperty(@PathVariable("name") String name, + @PathVariable("defaultvalue") String defaultvalue, + HttpServletRequest request) { + String methodName = "getProperty"; + LOGGER.debug(EELFLoggerDelegate.debugLogger, "<== {} {}", methodName, " start"); + try { + String propertyName = name.replace('_', '.'); + String pvalue = systemPropertiesWrapper.getOrDefault(propertyName, defaultvalue); + LOGGER.debug(EELFLoggerDelegate.debugLogger, "<== {} {} {}", methodName, "returning", pvalue); + return ResponseEntity.status(OK).body(pvalue); + } catch (Exception e) { + LOGGER.info(EELFLoggerDelegate.errorLogger, "<== {} {}", methodName, e.toString()); + LOGGER.debug(EELFLoggerDelegate.debugLogger, "<== {} {}", methodName, e.toString()); + return ResponseEntity.status(INTERNAL_SERVER_ERROR).body(ERROR_MESSAGE + e.getMessage()); + } + } + @RequestMapping(value = "/category_parameter", method = RequestMethod.GET) + public ResponseEntity getCategoryParameter(HttpServletRequest request, + @RequestParam(value = "familyName", required = true) Family familyName) { + LOGGER.debug(EELFLoggerDelegate.debugLogger, "start {}({})", getMethodName()); + try { + CategoryParametersResponse response = categoryParameterService.getCategoryParameters(familyName); + LOGGER.debug(EELFLoggerDelegate.debugLogger, "end {}() => {}", getMethodName(), response); + return ResponseEntity.status(OK).body(response); + } catch (Exception e) { + LOGGER.error("failed to retrieve category parameter list from DB.", e); + return ResponseEntity.status(INTERNAL_SERVER_ERROR).body(ERROR_MESSAGE + e.getMessage()); + } + } } diff --git a/vid-app-common/src/main/java/org/onap/vid/controller/RoleGeneratorController.java b/vid-app-common/src/main/java/org/onap/vid/controller/RoleGeneratorController.java index 78f1e37d5..97718bd1d 100644 --- a/vid-app-common/src/main/java/org/onap/vid/controller/RoleGeneratorController.java +++ b/vid-app-common/src/main/java/org/onap/vid/controller/RoleGeneratorController.java @@ -1,9 +1,32 @@ +/*- + * ============LICENSE_START======================================================= + * VID + * ================================================================================ + * Copyright © 2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Modifications Copyright 2019 Nokia + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + package org.onap.vid.controller; +import static org.springframework.http.HttpStatus.OK; + import org.onap.portalsdk.core.controller.UnRestrictedBaseController; import org.onap.vid.services.RoleGeneratorService; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; @@ -12,15 +35,15 @@ import org.springframework.web.bind.annotation.RestController; @RestController public class RoleGeneratorController extends UnRestrictedBaseController { - @Autowired - private RoleGeneratorService roleGeneratorService; public static final String GENERATE_ROLE_SCRIPT = "generateRoleScript"; + private RoleGeneratorService roleGeneratorService; + + @Autowired + public RoleGeneratorController(RoleGeneratorService roleGeneratorService) { + this.roleGeneratorService = roleGeneratorService; + } @RequestMapping(value = GENERATE_ROLE_SCRIPT +"/{firstRun}", method = RequestMethod.GET ) public ResponseEntity generateRoleScript (@PathVariable("firstRun") boolean firstRun) { - ResponseEntity response = null; - String query = roleGeneratorService.generateRoleScript(firstRun); - response = new ResponseEntity<>(query, HttpStatus.OK); - return response; + return ResponseEntity.status(OK).body(roleGeneratorService.generateRoleScript(firstRun)); } - } diff --git a/vid-app-common/src/main/java/org/onap/vid/mso/MsoResponseWrapper.java b/vid-app-common/src/main/java/org/onap/vid/mso/MsoResponseWrapper.java index 5a35e1092..95b039bad 100644 --- a/vid-app-common/src/main/java/org/onap/vid/mso/MsoResponseWrapper.java +++ b/vid-app-common/src/main/java/org/onap/vid/mso/MsoResponseWrapper.java @@ -48,8 +48,12 @@ public class MsoResponseWrapper implements MsoResponseWrapperInterface { setStatus(response.getStatus()); } + public MsoResponseWrapper(int status, String entity) { + this.status = status; + this.entity = entity; + } - /** The status. */ + /** The status. */ @JsonProperty("status") private int status; diff --git a/vid-app-common/src/main/java/org/onap/vid/mso/MsoUtil.java b/vid-app-common/src/main/java/org/onap/vid/mso/MsoUtil.java index 999188ffc..6a1030cfc 100644 --- a/vid-app-common/src/main/java/org/onap/vid/mso/MsoUtil.java +++ b/vid-app-common/src/main/java/org/onap/vid/mso/MsoUtil.java @@ -3,13 +3,14 @@ * VID * ================================================================================ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * Modifications Copyright (C) 2018 Nokia. All rights reserved. * ================================================================================ * 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. @@ -20,111 +21,27 @@ package org.onap.vid.mso; -import com.fasterxml.jackson.core.JsonProcessingException; -import com.fasterxml.jackson.databind.ObjectMapper; import io.joshworks.restclient.http.HttpResponse; -import org.apache.commons.lang3.ObjectUtils; -import org.glassfish.jersey.client.ClientResponse; -import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate; -import static org.onap.vid.utils.Logging.getMethodName; +import java.util.Objects; -/** - * The Class MsoUtil. - */ public class MsoUtil { - - /** The logger. */ - private static final EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(MsoUtil.class); - - /** - * Wrap response. - * - * @param body the body - * @param statusCode the status code - * @return the mso response wrapper - */ - public static MsoResponseWrapper wrapResponse ( String body, int statusCode ) { - - MsoResponseWrapper w = new MsoResponseWrapper(); - w.setStatus (statusCode); - w.setEntity(body); - - return w; - } - - /** - * Wrap response. - * - * @param cres the cres - * @return the mso response wrapper - */ - public static MsoResponseWrapper wrapResponse (ClientResponse cres) { - String respStr = ""; - int statuscode = 0; - if ( cres != null ) { - respStr = cres.readEntity(String.class); - statuscode = cres.getStatus(); - } - MsoResponseWrapper w = MsoUtil.wrapResponse ( respStr, statuscode ); - return (w); - } - - /** - * Wrap response. - * - * @param rs the rs - * @return the mso response wrapper - */ - public static MsoResponseWrapper wrapResponse (RestObject rs) { - String respStr = null; - int status = 0; - if ( rs != null ) { - respStr = rs.get() != null ? rs.get() : rs.getRaw(); - status = rs.getStatusCode(); - } - MsoResponseWrapper w = MsoUtil.wrapResponse ( respStr, status ); - return (w); - } - - public static MsoResponseWrapper wrapResponse (HttpResponse rs) { - MsoResponseWrapper w = new MsoResponseWrapper(); - w.setStatus (rs.getStatus()); - if(rs.getRawBody() != null) { - w.setEntity(ObjectUtils.toString(rs.getBody())); - } - return w; - } - - /** - * Convert pojo to string. - * - * @param the generic type - * @param t the t - * @return the string - * @throws JsonProcessingException the json processing exception - */ - public static String convertPojoToString ( T t ) { - ObjectMapper mapper = new ObjectMapper(); - String rJsonStr = ""; - if ( t != null ) { - try { - rJsonStr = mapper.writeValueAsString(t); - } - catch ( com.fasterxml.jackson.core.JsonProcessingException j ) { - logger.debug(EELFLoggerDelegate.debugLogger,getMethodName() + " Unable to parse object of type " + t.getClass().getName() + " as json", j); - } - } - return (rJsonStr); - } - - /** - * The main method. - * - * @param args the arguments - */ - public static void main(String[] args) { - // TODO Auto-generated method stub - } + private MsoUtil() { + } + + public static MsoResponseWrapper wrapResponse(RestObject restObject) { + String response = restObject.get() != null ? restObject.get() : restObject.getRaw(); + int status = restObject.getStatusCode(); + return new MsoResponseWrapper(status, response); + } + + public static MsoResponseWrapper wrapResponse(HttpResponse httpResponse) { + MsoResponseWrapper msoResponseWrapper = new MsoResponseWrapper(); + msoResponseWrapper.setStatus(httpResponse.getStatus()); + if (httpResponse.getRawBody() != null) { + msoResponseWrapper.setEntity(Objects.toString(httpResponse.getBody())); + } + return msoResponseWrapper; + } } diff --git a/vid-app-common/src/main/java/org/onap/vid/mso/RestObject.java b/vid-app-common/src/main/java/org/onap/vid/mso/RestObject.java index 7ebecba57..cf3941478 100644 --- a/vid-app-common/src/main/java/org/onap/vid/mso/RestObject.java +++ b/vid-app-common/src/main/java/org/onap/vid/mso/RestObject.java @@ -3,13 +3,14 @@ * VID * ================================================================================ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * Modifications Copyright (C) 2019 Nokia. All rights reserved. * ================================================================================ * 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. @@ -20,97 +21,37 @@ package org.onap.vid.mso; -import com.fasterxml.jackson.databind.ObjectMapper; import com.google.common.base.MoreObjects; -import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate; - -import javax.ws.rs.core.Response; - -import static org.onap.vid.utils.Logging.getMethodCallerName; -/** - * The Class RestObject. - * - * @param the generic type - */ public class RestObject { - static final ObjectMapper objectMapper = new ObjectMapper(); - - /** - * Generic version of the RestObject class. - * - */ - // T stands for "Type" private T t; - - // The string source of t, if available + + /** + * The string source of t, if available + */ private String rawT; - /** The status code. */ - private int statusCode= 0; + private int statusCode = 0; public RestObject() { } - public void copyFrom(RestObject src) { - set(src.get()); - setRaw(src.getRaw()); - setStatusCode(src.getStatusCode()); + public void set(T t) { + this.t = t; } - public RestObject(Response cres, Class tClass, EELFLoggerDelegate logger) { - - String rawEntity = null; - try { - cres.bufferEntity(); - rawEntity = cres.readEntity(String.class); - T t = (T) objectMapper.readValue(rawEntity, tClass); - this.set(t); - } - catch ( Exception e ) { - try { - this.setRaw(rawEntity); - logger.debug(EELFLoggerDelegate.debugLogger, "<== " + getMethodCallerName() + " Error reading response entity as " + tClass + ": , e=" - + e.getMessage() + ", Entity=" + rawEntity); - } catch (Exception e2) { - logger.debug(EELFLoggerDelegate.debugLogger, "<== " + getMethodCallerName() + " No response entity, this is probably ok, e=" - + e.getMessage()); - } - } - - int status = cres.getStatus(); - this.setStatusCode (status); + public T get() { + return t; } + public void setStatusCode(int v) { + this.statusCode = v; + } - /** - * Sets the. - * - * @param t the t - */ - public void set(T t) { this.t = t; } - - /** - * Gets the. - * - * @return the t - */ - public T get() { return t; } - - /** - * Sets the status code. - * - * @param v the new status code - */ - public void setStatusCode(int v) { this.statusCode = v; } - - /** - * Gets the status code. - * - * @return the status code - */ - public int getStatusCode() { return this.statusCode; } + public int getStatusCode() { + return this.statusCode; + } public String getRaw() { return rawT; @@ -120,6 +61,12 @@ public class RestObject { this.rawT = rawT; } + public void copyFrom(RestObject src) { + set(src.get()); + setRaw(src.getRaw()); + setStatusCode(src.getStatusCode()); + } + @Override public String toString() { return MoreObjects.toStringHelper(this) diff --git a/vid-app-common/src/main/java/org/onap/vid/roles/RoleProvider.java b/vid-app-common/src/main/java/org/onap/vid/roles/RoleProvider.java index d4256f893..e792139bf 100644 --- a/vid-app-common/src/main/java/org/onap/vid/roles/RoleProvider.java +++ b/vid-app-common/src/main/java/org/onap/vid/roles/RoleProvider.java @@ -36,6 +36,7 @@ import org.springframework.stereotype.Component; import javax.servlet.http.HttpServletRequest; import java.util.*; +import java.util.function.Function; import java.util.stream.Collectors; @@ -50,16 +51,32 @@ public class RoleProvider { static final String READ_PERMISSION_STRING = "read"; private final ObjectMapper om = new ObjectMapper(); - @Autowired private AaiService aaiService; + private Function getUserIdFunction; + private Function getRolesFunction; + + @Autowired + public RoleProvider(AaiService aaiService) { + this.aaiService=aaiService; + getUserIdFunction = UserUtils::getUserId; + getRolesFunction = UserUtils::getRoles; + } + + RoleProvider(AaiService aaiService, Function getUserIdFunction, Function getRolesFunction) { + this.aaiService = aaiService; + this.getRolesFunction = getRolesFunction; + this.getUserIdFunction = getUserIdFunction; + } + public List getUserRoles(HttpServletRequest request) { - String logPrefix = "Role Provider (" + UserUtils.getUserId(request) + ") ==>"; + int userId= getUserIdFunction.apply(request); + String logPrefix = "Role Provider (" + userId + ") ==>"; - LOG.debug(EELFLoggerDelegate.debugLogger, logPrefix + "Entering to get user role for user " + UserUtils.getUserId(request)); + LOG.debug(EELFLoggerDelegate.debugLogger, logPrefix + "Entering to get user role for user " + userId); List roleList = new ArrayList<>(); - Map roles = UserUtils.getRoles(request); + Map roles = getRolesFunction.apply(request); for (Object role : roles.keySet()) { org.onap.portalsdk.core.domain.Role sdkRol = (org.onap.portalsdk.core.domain.Role) roles.get(role); @@ -72,7 +89,7 @@ public class RoleProvider { } String[] roleParts = splitRole((sdkRol.getName()), logPrefix); roleList.add(createRoleFromStringArr(roleParts, logPrefix)); - String msg = String.format("%s User %s got permissions %s", logPrefix, UserUtils.getUserId(request), Arrays.toString(roleParts)); + String msg = String.format("%s User %s got permissions %s", logPrefix, userId, Arrays.toString(roleParts)); LOG.debug(EELFLoggerDelegate.debugLogger, msg); } catch (Exception e) { LOG.error(logPrefix + " Failed to parse permission"); diff --git a/vid-app-common/src/main/java/org/onap/vid/roles/RoleValidator.java b/vid-app-common/src/main/java/org/onap/vid/roles/RoleValidator.java index 7486eba9c..6afac9881 100644 --- a/vid-app-common/src/main/java/org/onap/vid/roles/RoleValidator.java +++ b/vid-app-common/src/main/java/org/onap/vid/roles/RoleValidator.java @@ -18,8 +18,8 @@ public class RoleValidator { } public boolean isSubscriberPermitted(String subscriberName) { - if(this.disableRoles) return true; - + if (this.disableRoles) return true; + for (Role role : userRoles) { if (role.getSubscribeName().equals(subscriberName)) return true; @@ -28,8 +28,8 @@ public class RoleValidator { } public boolean isServicePermitted(String subscriberName, String serviceType) { - if(this.disableRoles) return true; - + if (this.disableRoles) return true; + for (Role role : userRoles) { if (role.getSubscribeName().equals(subscriberName) && role.getServiceType().equals(serviceType)) return true; @@ -38,8 +38,8 @@ public class RoleValidator { } public boolean isMsoRequestValid(RequestDetails mso_request) { - if(this.disableRoles) return true; - + if (this.disableRoles) return true; + try { String globalSubscriberIdRequested = (String) ((Map) ((Map) mso_request.getAdditionalProperties().get("requestDetails")).get("subscriberInfo")).get("globalSubscriberId"); String serviceType = (String) ((Map) ((Map) mso_request.getAdditionalProperties().get("requestDetails")).get("requestParameters")).get("subscriptionServiceType"); @@ -48,12 +48,11 @@ public class RoleValidator { //Until we'll get the exact information regarding the tenants and the global customer id, we'll return true on unknown requests to mso return true; } -// return false; } public boolean isTenantPermitted(String globalCustomerId, String serviceType, String tenantName) { - if(this.disableRoles) return true; - + if (this.disableRoles) return true; + for (Role role : userRoles) { if (role.getSubscribeName().equals(globalCustomerId) && role.getServiceType().equals(serviceType) @@ -63,4 +62,8 @@ public class RoleValidator { } return false; } + + void enableRoles() { + this.disableRoles = false; + } } diff --git a/vid-app-common/src/main/java/org/onap/vid/utils/SystemPropertiesWrapper.java b/vid-app-common/src/main/java/org/onap/vid/utils/SystemPropertiesWrapper.java new file mode 100644 index 000000000..d24be4dcc --- /dev/null +++ b/vid-app-common/src/main/java/org/onap/vid/utils/SystemPropertiesWrapper.java @@ -0,0 +1,38 @@ +/*- + * ============LICENSE_START======================================================= + * VID + * ================================================================================ + * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Modifications Copyright 2019 Nokia + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.vid.utils; + +import org.apache.commons.lang.StringUtils; + +import org.onap.portalsdk.core.util.SystemProperties; +import org.springframework.stereotype.Component; + +@Component +public class SystemPropertiesWrapper { + public String getProperty(String key) { + return SystemProperties.getProperty(key); + } + public String getOrDefault(String key, String defaultValue) { + return StringUtils.defaultIfEmpty(getProperty(key), defaultValue); + } +} diff --git a/vid-app-common/src/test/java/org/onap/vid/controller/PropertyControllerTest.java b/vid-app-common/src/test/java/org/onap/vid/controller/PropertyControllerTest.java index e9d2cfd44..5dbe010bf 100644 --- a/vid-app-common/src/test/java/org/onap/vid/controller/PropertyControllerTest.java +++ b/vid-app-common/src/test/java/org/onap/vid/controller/PropertyControllerTest.java @@ -1,39 +1,139 @@ +/*- + * ============LICENSE_START======================================================= + * VID + * ================================================================================ + * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Modifications Copyright 2019 Nokia + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + package org.onap.vid.controller; -import org.junit.Test; -import org.springframework.http.ResponseEntity; -import org.springframework.web.servlet.ModelAndView; +import static org.mockito.BDDMockito.given; +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.status; -import javax.servlet.http.HttpServletRequest; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableMap; +import org.apache.log4j.BasicConfigurator; +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.Mock; +import org.mockito.junit.MockitoJUnitRunner; +import org.onap.vid.category.CategoryParameterOptionRep; +import org.onap.vid.category.CategoryParametersResponse; +import org.onap.vid.model.CategoryParameter.Family; +import org.onap.vid.services.CategoryParameterService; +import org.onap.vid.utils.SystemPropertiesWrapper; +import org.springframework.http.MediaType; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.test.web.servlet.setup.MockMvcBuilders; +@RunWith(MockitoJUnitRunner.class) public class PropertyControllerTest { - private PropertyController createTestSubject() { - return new PropertyController(); - } - - @Test - public void testWelcome() throws Exception { - PropertyController testSubject; - HttpServletRequest request = null; - ModelAndView result; - - // default test - testSubject = createTestSubject(); - result = testSubject.welcome(request); - } - - - @Test - public void testGetProperty() throws Exception { - PropertyController testSubject; - String name = ""; - String defaultvalue = ""; - HttpServletRequest request = null; - ResponseEntity result; - - // default test - testSubject = createTestSubject(); - result = testSubject.getProperty(name, defaultvalue, request); - } + private static final String GET_PROPERTY = "/get_property/{name}/{defaultvalue}"; + private static final String CATEGORY_PARAMETER = "/category_parameter"; + + private static final String ERROR_MSG = "Internal error occurred: "; + private static final String FAMILY_NAME = "familyName"; + + private PropertyController propertyController; + private MockMvc mockMvc; + private ObjectMapper objectMapper; + + @Mock + private CategoryParameterService service; + @Mock + private SystemPropertiesWrapper systemPropertiesWrapper; + + @Before + public void setUp() { + propertyController = new PropertyController(service, systemPropertiesWrapper); + BasicConfigurator.configure(); + mockMvc = MockMvcBuilders.standaloneSetup(propertyController).build(); + objectMapper = new ObjectMapper(); + } + + @Test + public void shouldReturnInputJson_whenPropertyIsNotFound() throws Exception { + String inputJson = "{key1: val1}"; + given(systemPropertiesWrapper.getOrDefault("name.1", inputJson)).willReturn(inputJson); + + mockMvc.perform(get(GET_PROPERTY, "name_1", inputJson) + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isOk()) + .andExpect(content().json(inputJson)); + } + + @Test + public void shouldReturnGivenJson_whenPropertyIsFound() throws Exception { + String propertyJson = "{key1: val1}"; + String inputJson = "{key2: val2}"; + given(systemPropertiesWrapper.getOrDefault("name.1", inputJson)).willReturn(propertyJson); + + mockMvc.perform(get(GET_PROPERTY, "name_1", inputJson) + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isOk()) + .andExpect(content().json(propertyJson)); + } + + @Test + public void shouldReturnInternalServerError_whenExceptionIsThrownFromSystemProperties() throws Exception { + String exceptionMessage = "Test exception message from system properties"; + String inputJson = "{key1: val1}"; + given(systemPropertiesWrapper.getOrDefault("name.1", inputJson)).willThrow(new RuntimeException(exceptionMessage)); + + mockMvc.perform(get(GET_PROPERTY, "name_1", inputJson) + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isInternalServerError()) + .andExpect(content().string(ERROR_MSG + exceptionMessage)); + } + + @Test + public void shouldReturnResponse_whenResponseIsFound() throws Exception { + + CategoryParametersResponse categoryParametersResponse = + new CategoryParametersResponse( + ImmutableMap.of( + "key1", ImmutableList.of( + new CategoryParameterOptionRep("testId", "testName")))); + + given(service.getCategoryParameters(Family.PARAMETER_STANDARDIZATION)).willReturn(categoryParametersResponse); + + mockMvc.perform(get(CATEGORY_PARAMETER) + .param(FAMILY_NAME, "PARAMETER_STANDARDIZATION") + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isOk()) + .andExpect(content().json(objectMapper.writeValueAsString(categoryParametersResponse))); + } + + @Test + public void shouldReturnInternalServerError_whenExceptionIsThrownFromService() throws Exception { + String exceptionMessage = "Test exception message from category parameter service"; + given(service.getCategoryParameters(Family.PARAMETER_STANDARDIZATION)).willThrow(new RuntimeException( + exceptionMessage)); + + mockMvc.perform(get(CATEGORY_PARAMETER) + .param(FAMILY_NAME, "PARAMETER_STANDARDIZATION") + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isInternalServerError()) + .andExpect(content().string(ERROR_MSG + exceptionMessage)); + } } \ No newline at end of file diff --git a/vid-app-common/src/test/java/org/onap/vid/controller/RoleGeneratorControllerTest.java b/vid-app-common/src/test/java/org/onap/vid/controller/RoleGeneratorControllerTest.java index c19b810d0..e1c6504ed 100644 --- a/vid-app-common/src/test/java/org/onap/vid/controller/RoleGeneratorControllerTest.java +++ b/vid-app-common/src/test/java/org/onap/vid/controller/RoleGeneratorControllerTest.java @@ -1,26 +1,80 @@ +/*- + * ============LICENSE_START======================================================= + * VID + * ================================================================================ + * Copyright © 2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Modifications Copyright 2019 Nokia + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + package org.onap.vid.controller; +import static org.mockito.BDDMockito.given; +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.status; + +import org.apache.log4j.BasicConfigurator; +import org.junit.Before; import org.junit.Test; -import org.springframework.http.ResponseEntity; +import org.junit.runner.RunWith; +import org.mockito.Mock; +import org.mockito.runners.MockitoJUnitRunner; +import org.onap.vid.services.RoleGeneratorService; +import org.springframework.http.MediaType; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.test.web.servlet.setup.MockMvcBuilders; +@RunWith(MockitoJUnitRunner.class) public class RoleGeneratorControllerTest { - private RoleGeneratorController createTestSubject() { - return new RoleGeneratorController(); + private static final String PATH = "/generateRoleScript/{firstRun}"; + + private static final String FIRST_JSON = "{key1: val1}"; + private static final String SECOND_JSON = "{key2: val2}"; + + private RoleGeneratorController roleGeneratorController; + private MockMvc mockMvc; + + @Mock + private RoleGeneratorService service; + + @Before + public void setUp() { + roleGeneratorController = new RoleGeneratorController(service); + BasicConfigurator.configure(); + mockMvc = MockMvcBuilders.standaloneSetup(roleGeneratorController).build(); + + given(service.generateRoleScript(true)).willReturn(FIRST_JSON); + given(service.generateRoleScript(false)).willReturn(SECOND_JSON); + } + + @Test + public void generateRoleScript_shouldReturnJson_whenFirstRun() throws Exception { + mockMvc.perform(get(PATH, "true") + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isOk()) + .andExpect(content().json(FIRST_JSON)); } @Test - public void testGenerateRoleScript() throws Exception { - RoleGeneratorController testSubject; - boolean firstRun = false; - ResponseEntity result; - - // default test - try { - testSubject = createTestSubject(); - result = testSubject.generateRoleScript(firstRun); - } catch (Exception e) { - - } + public void generateRoleScript_shouldReturnJson_whenNoFirstRun() throws Exception { + mockMvc.perform(get(PATH, "false") + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isOk()) + .andExpect(content().json(SECOND_JSON)); } } \ No newline at end of file diff --git a/vid-app-common/src/test/java/org/onap/vid/mso/MsoUtilTest.java b/vid-app-common/src/test/java/org/onap/vid/mso/MsoUtilTest.java index 9d625c4f7..82242b6d1 100644 --- a/vid-app-common/src/test/java/org/onap/vid/mso/MsoUtilTest.java +++ b/vid-app-common/src/test/java/org/onap/vid/mso/MsoUtilTest.java @@ -1,50 +1,83 @@ +/*- + * ============LICENSE_START======================================================= + * VID + * ================================================================================ + * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * Modifications Copyright (C) 2019 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + package org.onap.vid.mso; -import org.glassfish.jersey.client.ClientResponse; -import org.junit.Assert; +import io.joshworks.restclient.http.HttpResponse; +import io.joshworks.restclient.http.mapper.ObjectMapper; +import org.apache.http.HttpResponseFactory; +import org.apache.http.entity.StringEntity; +import org.apache.http.impl.DefaultHttpResponseFactory; +import org.apache.http.message.BasicStatusLine; import org.junit.Test; -public class MsoUtilTest { - - private MsoUtil createTestSubject() { - return new MsoUtil(); - } - - @Test - public void testWrapResponse() throws Exception { - String body = ""; - int statusCode = 0; - MsoResponseWrapper result; +import static org.apache.http.HttpStatus.SC_OK; +import static org.apache.http.HttpVersion.HTTP_1_1; +import static org.assertj.core.api.Assertions.assertThat; - // default test - result = MsoUtil.wrapResponse(body, statusCode); - } - - - @Test - public void testWrapResponse_2() throws Exception { - RestObject rs = null; - MsoResponseWrapper result; - - // test 1 - result = MsoUtil.wrapResponse(rs); - Assert.assertNotNull(result); - } +public class MsoUtilTest { - @Test - public void testConvertPojoToString() throws Exception { - String result; + @Test + public void shouldWrapRestObject() { + // given + String entity = "entity"; + RestObject restObject = new RestObject<>(); + restObject.set(entity); + restObject.setStatusCode(SC_OK); + // when + MsoResponseWrapper result = MsoUtil.wrapResponse(restObject); + // then + assertThat(result.getEntity()).isEqualTo(entity); + assertThat(result.getStatus()).isEqualTo(SC_OK); + } - // test 1 - result = MsoUtil.convertPojoToString(null); - Assert.assertEquals("", result); - } + @Test + public void shouldWrapHttpResponse() throws Exception { + // given + HttpResponse httpResponse = createTestHttpResponse(SC_OK, null); + // when + MsoResponseWrapper result = MsoUtil.wrapResponse(httpResponse); + // then + assertThat(result.getEntity()).isEqualTo(null); + assertThat(result.getStatus()).isEqualTo(SC_OK); + } - @Test - public void testMain() throws Exception { - String[] args = new String[] { "" }; + @Test + public void shouldWrapHttpResponseWithEntity() throws Exception { + // given + String entity = "entity"; + HttpResponse httpResponse = createTestHttpResponse(SC_OK, entity); + // when + MsoResponseWrapper result = MsoUtil.wrapResponse(httpResponse); + // then + assertThat(result.getEntity()).isEqualTo(entity); + assertThat(result.getStatus()).isEqualTo(SC_OK); + } - // default test - MsoUtil.main(args); - } + private HttpResponse createTestHttpResponse(int statusCode, String entity) throws Exception { + HttpResponseFactory factory = new DefaultHttpResponseFactory(); + org.apache.http.HttpResponse response = factory.newHttpResponse(new BasicStatusLine(HTTP_1_1, statusCode, null), null); + if (entity != null) { + response.setEntity(new StringEntity(entity)); + } + return new HttpResponse<>(response, String.class, null); + } } \ No newline at end of file diff --git a/vid-app-common/src/test/java/org/onap/vid/roles/RoleProviderTest.java b/vid-app-common/src/test/java/org/onap/vid/roles/RoleProviderTest.java index 6fdc21f78..3c22ea718 100644 --- a/vid-app-common/src/test/java/org/onap/vid/roles/RoleProviderTest.java +++ b/vid-app-common/src/test/java/org/onap/vid/roles/RoleProviderTest.java @@ -1,36 +1,144 @@ package org.onap.vid.roles; -import org.junit.Test; +import com.google.common.collect.ImmutableMap; +import io.joshworks.restclient.http.HttpResponse; +import org.assertj.core.util.Lists; +import org.mockito.Mock; +import org.onap.vid.aai.exceptions.RoleParsingException; +import org.onap.vid.model.Subscriber; +import org.onap.vid.model.SubscriberList; +import org.onap.vid.services.AaiService; +import org.testng.annotations.BeforeMethod; +import org.testng.annotations.Test; + +import javax.servlet.http.HttpServletRequest; +import java.util.List; +import java.util.Map; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.when; +import static org.mockito.MockitoAnnotations.initMocks; public class RoleProviderTest { - private RoleProvider createTestSubject() { - return new RoleProvider(); - } - - -// @Test -// public void testGetUserRoles() throws Exception { -// RoleProvider testSubject; -// HttpServletRequest request = null; -// List result; -// -// // default test -// testSubject = createTestSubject(); -// result = testSubject.getUserRoles(request); -// } - - - @Test - public void testSplitRole() throws Exception { - RoleProvider testSubject; - String roleAsString = ""; - String[] result; - - // default test - testSubject = createTestSubject(); - //TODO:fix result = testSubject.splitRole(roleAsString); - } + private static final String SAMPLE_SUBSCRIBER = "sampleSubscriber"; + private static final String SAMPLE_CUSTOMER_ID = "sampleCustomerId"; + private static final String SERVICE_TYPE_LOGS = "LOGS"; + private static final String TENANT_PERMITTED = "PERMITTED"; + private static final String SAMPLE_SERVICE = "sampleService"; + private static final String SAMPLE_TENANT = "sampleTenant"; + private static final String SAMPLE_ROLE_PREFIX = "prefix"; + + @Mock + private AaiService aaiService; + + @Mock + private HttpServletRequest request; + + @Mock + private HttpResponse subscriberListHttpResponse; + + + private RoleProvider roleProvider; + + + @BeforeMethod + public void setUp() { + initMocks(this); + roleProvider = new RoleProvider(aaiService, httpServletRequest -> 5, httpServletRequest -> createRoles()); + } + + @Test + public void shouldSplitRolesWhenDelimiterIsPresent() { + String roles = "role_a___role_b"; + + assertThat(roleProvider.splitRole(roles, "")).isEqualTo(new String[]{"role_a", "role_b"}); + } + + + @Test + public void shouldProperlyCreateRoleFromCorrectArray() throws RoleParsingException { + setSubscribers(); + String[] roleParts = {SAMPLE_SUBSCRIBER, SAMPLE_SERVICE, SAMPLE_TENANT}; + + Role role = roleProvider.createRoleFromStringArr(roleParts, SAMPLE_ROLE_PREFIX); + + assertThat(role.getEcompRole()).isEqualTo(EcompRole.READ); + assertThat(role.getSubscribeName()).isEqualTo(SAMPLE_CUSTOMER_ID); + assertThat(role.getTenant()).isEqualTo(SAMPLE_TENANT); + assertThat(role.getServiceType()).isEqualTo(SAMPLE_SERVICE); + } + + @Test + public void shouldProperlyCreateRoleWhenTenantIsNotProvided() throws RoleParsingException { + setSubscribers(); + + String[] roleParts = {SAMPLE_SUBSCRIBER, SAMPLE_SERVICE}; + + Role role = roleProvider.createRoleFromStringArr(roleParts, SAMPLE_ROLE_PREFIX); + + assertThat(role.getEcompRole()).isEqualTo(EcompRole.READ); + assertThat(role.getSubscribeName()).isEqualTo(SAMPLE_CUSTOMER_ID); + assertThat(role.getServiceType()).isEqualTo(SAMPLE_SERVICE); + assertThat(role.getTenant()).isNullOrEmpty(); + } + + @Test(expectedExceptions = RoleParsingException.class) + public void shouldRaiseExceptionWhenRolePartsAreIncomplete() throws RoleParsingException { + setSubscribers(); + + roleProvider.createRoleFromStringArr(new String[]{SAMPLE_SUBSCRIBER}, SAMPLE_ROLE_PREFIX); + } + + @Test + public void shouldProperlyRetrieveUserRolesWhenPermissionIsDifferentThanRead() { + Role expectedRole = new Role(EcompRole.READ, SAMPLE_CUSTOMER_ID, SAMPLE_SERVICE, SAMPLE_TENANT); + setSubscribers(); + + List userRoles = roleProvider.getUserRoles(request); + + + assertThat(userRoles.size()).isEqualTo(1); + Role actualRole = userRoles.get(0); + + assertThat(actualRole.getTenant()).isEqualTo(expectedRole.getTenant()); + assertThat(actualRole.getSubscribeName()).isEqualTo(expectedRole.getSubscribeName()); + assertThat(actualRole.getServiceType()).isEqualTo(expectedRole.getServiceType()); + } + + @Test + public void shouldReturnReadOnlyPermissionWhenRolesAreEmpty() { + assertThat(roleProvider.userPermissionIsReadOnly(Lists.emptyList())).isTrue(); + } + + @Test + public void shouldReturnNotReadOnlyPermissionWhenRolesArePresent() { + assertThat(roleProvider.userPermissionIsReadOnly(Lists.list(new Role(EcompRole.READ, SAMPLE_SUBSCRIBER, SAMPLE_SERVICE, SAMPLE_TENANT)))).isFalse(); + } + + @Test + public void userShouldHavePermissionToReadLogsWhenServiceAndTenantAreCorrect() { + Role withoutPermission = new Role(EcompRole.READ, SAMPLE_SUBSCRIBER, SAMPLE_SERVICE, SAMPLE_TENANT); + Role withPermission = new Role(EcompRole.READ, SAMPLE_SUBSCRIBER, SERVICE_TYPE_LOGS, TENANT_PERMITTED); + + assertThat(roleProvider.userPermissionIsReadLogs(Lists.list(withoutPermission, withPermission))).isTrue(); + } + + private void setSubscribers() { + Subscriber subscriber = new Subscriber(); + subscriber.subscriberName = SAMPLE_SUBSCRIBER; + subscriber.globalCustomerId = SAMPLE_CUSTOMER_ID; + SubscriberList subscriberList = new SubscriberList(Lists.list(subscriber)); + when(aaiService.getFullSubscriberList()).thenReturn(subscriberListHttpResponse); + when(subscriberListHttpResponse.getBody()).thenReturn(subscriberList); + } + private Map createRoles() { + org.onap.portalsdk.core.domain.Role role1 = new org.onap.portalsdk.core.domain.Role(); + role1.setName("read___role2"); + org.onap.portalsdk.core.domain.Role role2 = new org.onap.portalsdk.core.domain.Role(); + role2.setName("sampleSubscriber___sampleService___sampleTenant"); + return ImmutableMap.of(1L, role1, 2L, role2); + } } \ No newline at end of file diff --git a/vid-app-common/src/test/java/org/onap/vid/roles/RoleTest.java b/vid-app-common/src/test/java/org/onap/vid/roles/RoleTest.java deleted file mode 100644 index 463b29f57..000000000 --- a/vid-app-common/src/test/java/org/onap/vid/roles/RoleTest.java +++ /dev/null @@ -1,60 +0,0 @@ -package org.onap.vid.roles; - -import org.junit.Test; - -public class RoleTest { - - private Role createTestSubject() { - return new Role(EcompRole.READ, "", "", ""); - } - - @Test - public void testGetEcompRole() throws Exception { - Role testSubject; - EcompRole result; - - // default test - testSubject = createTestSubject(); - result = testSubject.getEcompRole(); - } - - @Test - public void testGetSubscribeName() throws Exception { - Role testSubject; - String result; - - // default test - testSubject = createTestSubject(); - result = testSubject.getSubscribeName(); - } - - @Test - public void testSetSubscribeName() throws Exception { - Role testSubject; - String subscribeName = ""; - - // default test - testSubject = createTestSubject(); - testSubject.setSubscribeName(subscribeName); - } - - @Test - public void testGetServiceType() throws Exception { - Role testSubject; - String result; - - // default test - testSubject = createTestSubject(); - result = testSubject.getServiceType(); - } - - @Test - public void testGetTenant() throws Exception { - Role testSubject; - String result; - - // default test - testSubject = createTestSubject(); - result = testSubject.getTenant(); - } -} \ No newline at end of file diff --git a/vid-app-common/src/test/java/org/onap/vid/roles/RoleValidatorTest.java b/vid-app-common/src/test/java/org/onap/vid/roles/RoleValidatorTest.java index b303b257c..adb257b01 100644 --- a/vid-app-common/src/test/java/org/onap/vid/roles/RoleValidatorTest.java +++ b/vid-app-common/src/test/java/org/onap/vid/roles/RoleValidatorTest.java @@ -1,59 +1,96 @@ package org.onap.vid.roles; -import org.junit.Test; + +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableMap; import org.onap.vid.mso.rest.RequestDetails; +import org.testng.annotations.BeforeMethod; +import org.testng.annotations.Test; + +import java.util.List; +import java.util.Map; + +import static org.assertj.core.api.Assertions.assertThat; public class RoleValidatorTest { - private RoleValidator createTestSubject() { - return new RoleValidator(null); + private static final String SAMPLE_SUBSCRIBER = "sampleSubscriber"; + private static final String NOT_MATCHING_SUBSCRIBER = "notMatchingSubscriber"; + private static final String SAMPLE_SERVICE_TYPE = "sampleServiceType"; + private static final String NOT_MATCHING_TENANT = "notMatchingTenant"; + private static final String SAMPLE_TENANT = "sampleTenant"; + + private static final Role SAMPLE_ROLE = new Role(EcompRole.READ, SAMPLE_SUBSCRIBER, SAMPLE_SERVICE_TYPE, SAMPLE_TENANT); + + private List roles = ImmutableList.of(SAMPLE_ROLE); + private Map subscriberInfo = ImmutableMap.of("globalSubscriberId", SAMPLE_SUBSCRIBER); + private Map requestParameters = ImmutableMap.of("subscriptionServiceType", SAMPLE_SERVICE_TYPE); + private Map requestDetailsProperties = ImmutableMap.of("subscriberInfo", subscriberInfo, "requestParameters", requestParameters); + private RequestDetails requestDetails; + private RoleValidator roleValidator; + + @BeforeMethod + public void setUp() { + roleValidator = new RoleValidator(roles); + roleValidator.enableRoles(); + requestDetails = new RequestDetails(); } @Test - public void testIsMsoRequestValid() throws Exception { - RoleValidator testSubject; - RequestDetails mso_request = null; - boolean result; + public void shouldPermitSubscriberWhenNameMatchesAndRolesAreEnabled() { + assertThat(roleValidator.isSubscriberPermitted(SAMPLE_SUBSCRIBER)).isTrue(); + } - // default test - testSubject = createTestSubject(); - result = testSubject.isMsoRequestValid(mso_request); + @Test + public void shouldNotPermitSubscriberWhenNameNotMatches() { + assertThat(roleValidator.isSubscriberPermitted(NOT_MATCHING_SUBSCRIBER)).isFalse(); } @Test - public void testIsServicePermitted() throws Exception { - RoleValidator testSubject; - String subscriberName = ""; - String serviceType = ""; - boolean result; + public void shouldPermitServiceWhenNamesMatches() { + assertThat(roleValidator.isServicePermitted(SAMPLE_SUBSCRIBER, SAMPLE_SERVICE_TYPE)).isTrue(); + } - // default test - testSubject = createTestSubject(); - result = testSubject.isServicePermitted(subscriberName, serviceType); + + @Test + public void shouldNotPermitServiceWhenSubscriberNameNotMatches() { + assertThat(roleValidator.isServicePermitted(NOT_MATCHING_SUBSCRIBER, SAMPLE_SERVICE_TYPE)).isFalse(); } @Test - public void testIsSubscriberPermitted() throws Exception { - RoleValidator testSubject; - String subscriberName = ""; - boolean result; + public void shouldNotPermitServiceWhenServiceTypeNotMatches() { + assertThat(roleValidator.isServicePermitted(SAMPLE_SUBSCRIBER, NOT_MATCHING_SUBSCRIBER)).isFalse(); + } - // default test - testSubject = createTestSubject(); - result = testSubject.isSubscriberPermitted(subscriberName); + @Test + public void shouldPermitTenantWhenNameMatches() { + assertThat(roleValidator.isTenantPermitted(SAMPLE_SUBSCRIBER, SAMPLE_SERVICE_TYPE, SAMPLE_TENANT)).isTrue(); + } + + + @Test + public void shouldNotPermitTenantWhenNameNotMatches() { + assertThat(roleValidator.isTenantPermitted(SAMPLE_SUBSCRIBER, SAMPLE_SERVICE_TYPE, NOT_MATCHING_TENANT)).isFalse(); } @Test - public void testIsTenantPermitted() throws Exception { - RoleValidator testSubject; - String globalCustomerId = ""; - String serviceType = ""; - String tenantName = ""; - boolean result; + public void shouldValidateProperlySORequest() { + requestDetails.setAdditionalProperty("requestDetails", requestDetailsProperties); - // default test - testSubject = createTestSubject(); - result = testSubject.isTenantPermitted(globalCustomerId, serviceType, tenantName); + assertThat(roleValidator.isMsoRequestValid(requestDetails)).isTrue(); } + @Test + public void shouldValidateUnknownSORequest() { + assertThat(roleValidator.isMsoRequestValid(new RequestDetails())).isTrue(); + } + + @Test + public void shouldRejectSORequestWhenSubscriberNotMatches() { + Map subscriberInfo = ImmutableMap.of("globalSubscriberId", "sample"); + Map requestDetailsProperties = ImmutableMap.of("subscriberInfo", subscriberInfo, "requestParameters", requestParameters); + requestDetails.setAdditionalProperty("requestDetails", requestDetailsProperties); + + assertThat(roleValidator.isMsoRequestValid(requestDetails)).isFalse(); + } } \ No newline at end of file