From a0f2e231b6a4c6b002eb64b86b124400d9d048ae Mon Sep 17 00:00:00 2001 From: Bogumil Zebek Date: Mon, 18 May 2020 09:35:21 +0200 Subject: Add unit test to few classes Increase code coverage: - HeaderUtil - EnvProps - WebMvcConfig Change-Id: I880a4ff02d436cf153d41c795d8e95dfc67fd61b Issue-ID: DCAEGEN2-2245 Signed-off-by: Zebek Bogumil --- Changelog.md | 6 ++ pom.xml | 2 +- .../java/org/onap/dcae/restapi/WebMvcConfig.java | 29 ++++-- .../java/org/onap/dcae/common/HeaderUtilsTest.java | 79 ++++++++++++++++ .../org/onap/dcae/controller/EnvPropsTest.java | 39 ++++++++ .../org/onap/dcae/restapi/WebMvcConfigTest.java | 102 +++++++++++++++++++++ version.properties | 2 +- 7 files changed, 247 insertions(+), 12 deletions(-) create mode 100644 src/test/java/org/onap/dcae/common/HeaderUtilsTest.java create mode 100644 src/test/java/org/onap/dcae/controller/EnvPropsTest.java create mode 100644 src/test/java/org/onap/dcae/restapi/WebMvcConfigTest.java diff --git a/Changelog.md b/Changelog.md index dbaf0bd8..373d5538 100644 --- a/Changelog.md +++ b/Changelog.md @@ -8,3 +8,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - [DCAEGEN2-608](https://jira.onap.org/browse/DCAEGEN2-608) - Expose Prometheus API for performance tests ## [1.6.1] - 21/05/2020 - [DCAEGEN2-608](https://jira.onap.org/browse/DCAEGEN2-608) - Deployment Prometheus and Grafana on RKE for perf tests +## [1.6.2] - 01/06/2020 + - [DCAEGEN2-2245](https://jira.onap.org/browse/DCAEGEN2-2245) - Code improvements + Increase code coverage: + - HeaderUtil + - EnvProps + - WebMvcConfig diff --git a/pom.xml b/pom.xml index ef9ce691..a9f82c68 100644 --- a/pom.xml +++ b/pom.xml @@ -24,7 +24,7 @@ org.onap.dcaegen2.collectors.ves VESCollector - 1.6.1-SNAPSHOT + 1.6.2-SNAPSHOT dcaegen2-collectors-ves VESCollector diff --git a/src/main/java/org/onap/dcae/restapi/WebMvcConfig.java b/src/main/java/org/onap/dcae/restapi/WebMvcConfig.java index c8dd7ba4..cf180e71 100644 --- a/src/main/java/org/onap/dcae/restapi/WebMvcConfig.java +++ b/src/main/java/org/onap/dcae/restapi/WebMvcConfig.java @@ -1,9 +1,9 @@ /* * ============LICENSE_START======================================================= - * PROJECT + * org.onap.dcaegen2.collectors.ves * ================================================================================ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * Copyright (C) 2018 - 2019 Nokia. All rights reserved. + * Copyright (C) 2020 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. @@ -28,26 +28,35 @@ import org.springframework.web.servlet.view.InternalResourceViewResolver; public class WebMvcConfig extends WebMvcConfigurationSupport { + public static final String SWAGGER_PATH_PATTERN = "swagger-ui.html"; + public static final String SWAGGER_CLASSPATH_RESOURCES = "classpath:/META-INF/resources/"; + public static final String WEBJARS_PATH_PATTERN = "/webjars/**"; + public static final String WEBJARS_CLASSPATH_RESOURCES = "classpath:/META-INF/resources/webjars/"; + public static final String TEMPLATES_PATTERN = "**"; + public static final String TEMPLATES_CLASSPATH_RESOURCES = "classpath:/templates/"; + public static final String PREFIX = "/"; + public static final String SUFFIX = ".html"; + @Override protected void addResourceHandlers(ResourceHandlerRegistry registry) { registry - .addResourceHandler("swagger-ui.html") - .addResourceLocations("classpath:/META-INF/resources/"); + .addResourceHandler(SWAGGER_PATH_PATTERN) + .addResourceLocations(SWAGGER_CLASSPATH_RESOURCES); registry - .addResourceHandler("/webjars/**") - .addResourceLocations("classpath:/META-INF/resources/webjars/"); + .addResourceHandler(WEBJARS_PATH_PATTERN) + .addResourceLocations(WEBJARS_CLASSPATH_RESOURCES); registry - .addResourceHandler("**") - .addResourceLocations("classpath:/templates/"); + .addResourceHandler(TEMPLATES_PATTERN) + .addResourceLocations(TEMPLATES_CLASSPATH_RESOURCES); } @Bean public InternalResourceViewResolver jspViewResolver() { InternalResourceViewResolver resolver = new InternalResourceViewResolver(); - resolver.setPrefix("/"); - resolver.setSuffix(".html"); + resolver.setPrefix(PREFIX); + resolver.setSuffix(SUFFIX); return resolver; } } diff --git a/src/test/java/org/onap/dcae/common/HeaderUtilsTest.java b/src/test/java/org/onap/dcae/common/HeaderUtilsTest.java new file mode 100644 index 00000000..a3f0966d --- /dev/null +++ b/src/test/java/org/onap/dcae/common/HeaderUtilsTest.java @@ -0,0 +1,79 @@ +/* + * ============LICENSE_START======================================================= + * VES + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved.s + * ================================================================================ + * 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.dcae.common; + +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import org.springframework.mock.web.MockHttpServletRequest; + +import java.util.Map; + +import static java.util.Map.entry; +import static org.assertj.core.api.Assertions.assertThat; + +public class HeaderUtilsTest { + private HeaderUtils headerUtils = new HeaderUtils(); + + @Test + public void shouldReturnEventListenerRestApiIdentifier() { + assertThat( + headerUtils.getRestApiIdentify("http://localhost/eventListener/v2/eventListener") + ).isEqualTo("eventListener"); + } + + @Test + public void shouldReturnBatchEventRestApiIdentifier() { + assertThat( + headerUtils.getRestApiIdentify("http://localhost/eventListener/v2/eventBatch") + ).isEqualTo("eventListener_eventBatch"); + } + + @Test + public void shouldExtractHeadersFromRequest() { + // given + final MockHttpServletRequest httpServletRequest = new MockHttpServletRequest(); + httpServletRequest.addHeader("first", 1); + httpServletRequest.addHeader("second", 2); + // when/then + assertThat( + headerUtils.extractHeaders(httpServletRequest) + ).contains( + entry("first", "1"), + entry("second", "2") + ); + } + + @Test + public void shouldCreateHttpHeaderWithSelectedData() { + // given + Map data = Map.of("first", "1", "second", "2"); + // when + final HttpHeaders httpHeaders = headerUtils.fillHeaders(data); + //then + assertThatHeaderContainsElement(httpHeaders, "first", "1"); + assertThatHeaderContainsElement(httpHeaders, "second", "2"); + } + + private void assertThatHeaderContainsElement(HttpHeaders httpHeaders, String key, String value) { + assertThat(httpHeaders.containsKey(key)).isTrue(); + assertThat(httpHeaders.get(key)).contains(value); + } + +} diff --git a/src/test/java/org/onap/dcae/controller/EnvPropsTest.java b/src/test/java/org/onap/dcae/controller/EnvPropsTest.java new file mode 100644 index 00000000..ccc083e2 --- /dev/null +++ b/src/test/java/org/onap/dcae/controller/EnvPropsTest.java @@ -0,0 +1,39 @@ +package org.onap.dcae.controller; +/*- + * ============LICENSE_START======================================================= + * org.onap.dcaegen2.collectors.ves + * ================================================================================ + * Copyright (C) 2020 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========================================================= + */ +import org.jetbrains.annotations.NotNull; +import org.junit.Test; +import static org.assertj.core.api.Assertions.assertThat; +public class EnvPropsTest { + @Test + public void shouldBeEquals() { + // given + EnvProps envPropsOriginal = givenEnvProps(); + EnvProps envPropsCopy = givenEnvProps(); + // when/then + assertThat(envPropsOriginal).isEqualTo(envPropsCopy); + assertThat(envPropsOriginal.hashCode()).isEqualTo(envPropsCopy.hashCode()); + } + @NotNull + private EnvProps givenEnvProps() { + return new EnvProps("https", "localhost", 443, + "https", "cbsName", "appName"); + } +} diff --git a/src/test/java/org/onap/dcae/restapi/WebMvcConfigTest.java b/src/test/java/org/onap/dcae/restapi/WebMvcConfigTest.java new file mode 100644 index 00000000..551fdeac --- /dev/null +++ b/src/test/java/org/onap/dcae/restapi/WebMvcConfigTest.java @@ -0,0 +1,102 @@ +/*- + * ============LICENSE_START======================================================= + * org.onap.dcaegen2.collectors.ves + * ================================================================================ + * Copyright (C) 2020 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.dcae.restapi; + + +import org.assertj.core.api.Assertions; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.Mock; +import org.mockito.Mockito; +import org.mockito.junit.MockitoJUnitRunner; +import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistration; +import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; +import org.springframework.web.servlet.view.InternalResourceViewResolver; +import org.springframework.web.servlet.view.UrlBasedViewResolver; + +import java.lang.reflect.Field; + +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; +import static org.onap.dcae.restapi.WebMvcConfig.PREFIX; +import static org.onap.dcae.restapi.WebMvcConfig.SUFFIX; +import static org.onap.dcae.restapi.WebMvcConfig.SWAGGER_CLASSPATH_RESOURCES; +import static org.onap.dcae.restapi.WebMvcConfig.SWAGGER_PATH_PATTERN; +import static org.onap.dcae.restapi.WebMvcConfig.TEMPLATES_CLASSPATH_RESOURCES; +import static org.onap.dcae.restapi.WebMvcConfig.TEMPLATES_PATTERN; +import static org.onap.dcae.restapi.WebMvcConfig.WEBJARS_CLASSPATH_RESOURCES; +import static org.onap.dcae.restapi.WebMvcConfig.WEBJARS_PATH_PATTERN; + +@RunWith(MockitoJUnitRunner.class) +public class WebMvcConfigTest { + + @Mock + private ResourceHandlerRegistry resourceHandlerRegistry; + @Mock + private ResourceHandlerRegistration resourceHandlerRegistration; + private WebMvcConfig webMvcConfig = new WebMvcConfig(); + + @Test + public void shouldConfigureResourceHandlers() { + // given + when(resourceHandlerRegistry.addResourceHandler(Mockito.anyString())).thenReturn(resourceHandlerRegistration); + + // when + webMvcConfig.addResourceHandlers(resourceHandlerRegistry); + + // then + verifyThatResourceWasRegistered(SWAGGER_PATH_PATTERN, SWAGGER_CLASSPATH_RESOURCES); + verifyThatResourceWasRegistered(WEBJARS_PATH_PATTERN, WEBJARS_CLASSPATH_RESOURCES); + verifyThatResourceWasRegistered(TEMPLATES_PATTERN, TEMPLATES_CLASSPATH_RESOURCES); + } + + + @Test + public void shouldConfigureJspViewResolverToHandleHtmlRequests() throws NoSuchFieldException, IllegalAccessException { + // when + final InternalResourceViewResolver internalResourceViewResolver = webMvcConfig.jspViewResolver(); + + // then + verifyThatFieldWasSet(internalResourceViewResolver, "prefix", PREFIX); + verifyThatFieldWasSet(internalResourceViewResolver, "suffix", SUFFIX); + + } + + private void verifyThatResourceWasRegistered(String swaggerPathPattern, String swaggerClasspathResources) { + verify(resourceHandlerRegistry).addResourceHandler(swaggerPathPattern); + verify(resourceHandlerRegistration).addResourceLocations(swaggerClasspathResources); + } + + private void verifyThatFieldWasSet(InternalResourceViewResolver internalResourceViewResolver, String prefix, String prefix2) throws NoSuchFieldException, IllegalAccessException { + String fieldValue = getValueFromPrivateField(internalResourceViewResolver, prefix); + Assertions.assertThat(fieldValue).isEqualTo(prefix2); + } + + private String getValueFromPrivateField(InternalResourceViewResolver internalResourceViewResolver, String privateFieldName) throws NoSuchFieldException, IllegalAccessException { + final Field privatePrefixField = UrlBasedViewResolver.class. + getDeclaredField(privateFieldName); + + privatePrefixField.setAccessible(true); + + return (String) privatePrefixField.get(internalResourceViewResolver); + } + +} diff --git a/version.properties b/version.properties index 30223800..ceaeaeb0 100644 --- a/version.properties +++ b/version.properties @@ -1,6 +1,6 @@ major=1 minor=6 -patch=1 +patch=2 base_version=${major}.${minor}.${patch} release_version=${base_version} snapshot_version=${base_version}-SNAPSHOT -- cgit 1.2.3-korg