From bb8b7aaaa10e5ecc7c3984ebc66efb86c7063359 Mon Sep 17 00:00:00 2001 From: avigaffa Date: Thu, 13 Sep 2018 14:33:47 +0300 Subject: Fix USER_ID not shown in swagger Fix USER_ID not shown in swagger after centralized USER_ID header Change-Id: I8e16562ec9e182b1332d3f5a25a9f1d6622c427c Issue-ID: SDC-1670 Signed-off-by: avigaffa --- .../sdc/workflow/api/swagger/UserIdReader.java | 61 ++++++++++++++++ .../sdc/workflow/api/swagger/UserIdReaderTest.java | 81 ++++++++++++++++++++++ 2 files changed, 142 insertions(+) create mode 100644 workflow-designer-be/src/main/java/org/onap/sdc/workflow/api/swagger/UserIdReader.java create mode 100644 workflow-designer-be/src/test/java/org/onap/sdc/workflow/api/swagger/UserIdReaderTest.java diff --git a/workflow-designer-be/src/main/java/org/onap/sdc/workflow/api/swagger/UserIdReader.java b/workflow-designer-be/src/main/java/org/onap/sdc/workflow/api/swagger/UserIdReader.java new file mode 100644 index 00000000..d16c9407 --- /dev/null +++ b/workflow-designer-be/src/main/java/org/onap/sdc/workflow/api/swagger/UserIdReader.java @@ -0,0 +1,61 @@ +/* + * Copyright © 2018 European Support Limited + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.onap.sdc.workflow.api.swagger; + +import static org.onap.sdc.workflow.api.RestParams.USER_ID_HEADER; + +import com.fasterxml.classmate.TypeResolver; +import com.google.common.base.Optional; +import org.onap.sdc.workflow.services.annotations.UserId; +import org.springframework.core.annotation.Order; +import org.springframework.stereotype.Component; +import springfox.documentation.service.ResolvedMethodParameter; +import springfox.documentation.spi.DocumentationType; +import springfox.documentation.spi.service.ParameterBuilderPlugin; +import springfox.documentation.spi.service.contexts.ParameterContext; +import springfox.documentation.swagger.common.SwaggerPluginSupport; + +/** + * This component is neccesary because swagger cannot find a custom annotations in API. + * This is needed to find specifically the {@link UserId} annotation + */ +@Component +@Order(SwaggerPluginSupport.SWAGGER_PLUGIN_ORDER + 1000) +public class UserIdReader implements ParameterBuilderPlugin { + + private static final String HEADER = "header"; + private final TypeResolver resolver; + + public UserIdReader(TypeResolver resolver) { + this.resolver = resolver; + } + + @Override + public void apply(ParameterContext parameterContext) { + ResolvedMethodParameter methodParameter = parameterContext.resolvedMethodParameter(); + Optional requestParam = methodParameter.findAnnotation(UserId.class); + if (requestParam.isPresent()) { + parameterContext.parameterBuilder().parameterType(HEADER).name(USER_ID_HEADER) + .type(resolver.resolve(String.class)); + } + } + + @Override + public boolean supports(DocumentationType documentationType) { + return true; + } +} diff --git a/workflow-designer-be/src/test/java/org/onap/sdc/workflow/api/swagger/UserIdReaderTest.java b/workflow-designer-be/src/test/java/org/onap/sdc/workflow/api/swagger/UserIdReaderTest.java new file mode 100644 index 00000000..6899e984 --- /dev/null +++ b/workflow-designer-be/src/test/java/org/onap/sdc/workflow/api/swagger/UserIdReaderTest.java @@ -0,0 +1,81 @@ +/* + * Copyright © 2018 European Support Limited + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.onap.sdc.workflow.api.swagger; + +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import com.fasterxml.classmate.TypeResolver; +import com.google.common.base.Optional; +import java.lang.annotation.Annotation; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.onap.sdc.workflow.services.annotations.UserId; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +import springfox.documentation.builders.ParameterBuilder; +import springfox.documentation.service.ResolvedMethodParameter; +import springfox.documentation.spi.service.contexts.ParameterContext; + +@RunWith(SpringJUnit4ClassRunner.class) +public class UserIdReaderTest { + + private static final UserId USER_ID_ANNOTATION = new UserId() { + + @Override + public Class annotationType() { + return UserId.class; + } + }; + + @Mock + TypeResolver resolver; // do not delete. this is used in the injection of UserIdReader constructor + @Mock + ResolvedMethodParameter resolvedMethodParameter; + @Mock + ParameterBuilder parameterBuilder; + @Mock + ParameterContext parameterContext; + @InjectMocks + UserIdReader userIdReader; + + @Test + public void shouldNotCallToParameterBuilderIfUserIdAnnotationNotFound() { + when(parameterContext.resolvedMethodParameter()).thenReturn(resolvedMethodParameter); + when(resolvedMethodParameter.findAnnotation(UserId.class)).thenReturn(Optional.absent()); + userIdReader.apply(parameterContext); + verify(parameterContext, times(0)).parameterBuilder(); + } + + @Test + public void shouldCallToParameterBuilderIfUserIdAnnotationFound() { + + doReturn(resolvedMethodParameter).when(parameterContext).resolvedMethodParameter(); + doReturn(parameterBuilder).when(parameterContext).parameterBuilder(); + doReturn(parameterBuilder).when(parameterBuilder).parameterType(any()); + doReturn(parameterBuilder).when(parameterBuilder).name(any()); + doReturn(parameterBuilder).when(parameterBuilder).type(any()); + doReturn(Optional.of(USER_ID_ANNOTATION)).when(resolvedMethodParameter).findAnnotation(UserId.class); + + userIdReader.apply(parameterContext); + verify(parameterContext, times(1)).parameterBuilder(); + } +} \ No newline at end of file -- cgit 1.2.3-korg