Merge pull request #27 from wwan13/feature/resolve

Configurations

Author: wwan13

src/main/java/io/wwan13/wintersecurity/config/ArgumentResolversRegistrar.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.wwan13.wintersecurity.config;
+
+import io.wwan13.wintersecurity.resolve.RolesResolver;
+import io.wwan13.wintersecurity.resolve.SubjectResolver;
+import io.wwan13.wintersecurity.resolve.TargetAnnotations;
+import org.springframework.web.method.support.HandlerMethodArgumentResolver;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+import java.util.List;
+
+public class ArgumentResolversRegistrar implements WebMvcConfigurer {
+
+    private final TargetAnnotations targetAnnotations;
+
+    public ArgumentResolversRegistrar(TargetAnnotations targetAnnotations) {
+        this.targetAnnotations = targetAnnotations;
+    }
+
+    @Override
+    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
+        SubjectResolver subjectResolver = new SubjectResolver(targetAnnotations);
+        resolvers.add(subjectResolver);
+
+        RolesResolver rolesResolver = new RolesResolver(targetAnnotations);
+        resolvers.add(rolesResolver);
+    }
+}

src/main/java/io/wwan13/wintersecurity/config/EnableSecureRequest.java

@@ -32,6 +32,7 @@
         AuthConfiguration.class,
         AuthProcessorRegistrar.class,
         TargetAnnotationsRegistrar.class,
+        ArgumentResolversRegistrar.class,
         SecretKeyRegistrar.class
 })
 public @interface EnableSecureRequest {

src/main/java/io/wwan13/wintersecurity/resolve/RolesResolver.java

@@ -16,10 +16,9 @@
 
 package io.wwan13.wintersecurity.resolve;
 
-import io.wwan13.wintersecurity.jwt.PayloadAnalysis;
 import io.wwan13.wintersecurity.jwt.TokenClaims;
 import io.wwan13.wintersecurity.resolve.util.AttributeExtractor;
-import io.wwan13.wintersecurity.util.TypeConverter;
+import io.wwan13.wintersecurity.resolve.util.ResolveTypeConverter;
 import org.springframework.core.MethodParameter;
 import org.springframework.web.bind.support.WebDataBinderFactory;
 import org.springframework.web.context.request.NativeWebRequest;
@@ -32,24 +31,15 @@
 public class RolesResolver implements HandlerMethodArgumentResolver {
 
     private final TargetAnnotations targetAnnotations;
-    private final PayloadAnalysis payloadAnalysis;
 
-    public RolesResolver(
-            TargetAnnotations targetAnnotations,
-            PayloadAnalysis payloadAnalysis
-    ) {
+    public RolesResolver(TargetAnnotations targetAnnotations) {
         this.targetAnnotations = targetAnnotations;
-        this.payloadAnalysis = payloadAnalysis;
     }
 
     @Override
     public boolean supportsParameter(MethodParameter parameter) {
-        boolean hasAnnotation = targetAnnotations.forRoles().stream()
+        return targetAnnotations.forRoles().stream()
                 .anyMatch(parameter::hasParameterAnnotation);
-        boolean isValidType = payloadAnalysis.roles().getType()
-                .isAssignableFrom(parameter.getParameterType());
-
-        return hasAnnotation && isValidType;
     }
 
     @Override
@@ -69,9 +59,9 @@ public Object resolveArgument(
                     .findFirst()
                     .orElseThrow(() -> new IllegalArgumentException("Empty role entered"));
 
-            return TypeConverter.convertTo(role, parameter.getParameterType());
+            return ResolveTypeConverter.convertTo(role, parameter.getParameterType());
         }
 
-        return TypeConverter.convertTo(claims.getRoles(), parameter.getParameterType());
+        return ResolveTypeConverter.convertTo(claims.getRoles(), parameter.getParameterType());
     }
 }

src/main/java/io/wwan13/wintersecurity/resolve/SubjectResolver.java

@@ -16,10 +16,9 @@
 
 package io.wwan13.wintersecurity.resolve;
 
-import io.wwan13.wintersecurity.jwt.PayloadAnalysis;
 import io.wwan13.wintersecurity.jwt.TokenClaims;
 import io.wwan13.wintersecurity.resolve.util.AttributeExtractor;
-import io.wwan13.wintersecurity.util.TypeConverter;
+import io.wwan13.wintersecurity.resolve.util.ResolveTypeConverter;
 import org.springframework.core.MethodParameter;
 import org.springframework.web.bind.support.WebDataBinderFactory;
 import org.springframework.web.context.request.NativeWebRequest;
@@ -31,24 +30,17 @@
 public class SubjectResolver implements HandlerMethodArgumentResolver {
 
     private final TargetAnnotations targetAnnotations;
-    private final PayloadAnalysis payloadAnalysis;
 
     public SubjectResolver(
-            TargetAnnotations targetAnnotations,
-            PayloadAnalysis payloadAnalysis
+            TargetAnnotations targetAnnotations
     ) {
         this.targetAnnotations = targetAnnotations;
-        this.payloadAnalysis = payloadAnalysis;
     }
 
     @Override
     public boolean supportsParameter(MethodParameter parameter) {
-        boolean hasAnnotation = targetAnnotations.forSubject().stream()
+        return targetAnnotations.forSubject().stream()
                 .anyMatch(parameter::hasParameterAnnotation);
-        boolean isValidType = payloadAnalysis.subject().getType()
-                .isAssignableFrom(parameter.getParameterType());
-
-        return hasAnnotation && isValidType;
     }
 
     @Override
@@ -61,7 +53,7 @@ public Object resolveArgument(
         HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
         TokenClaims claims = AttributeExtractor.extractClaims(request);
 
-        return TypeConverter.convertTo(
+        return ResolveTypeConverter.convertTo(
                 claims.getSubject(),
                 parameter.getParameterType()
         );

…3/wintersecurity/util/TypeConverter.java …y/resolve/util/ResolveTypeConverter.javasrc/main/java/io/wwan13/wintersecurity/util/TypeConverter.java renamed to src/main/java/io/wwan13/wintersecurity/resolve/util/ResolveTypeConverter.java src/main/java/io/wwan13/wintersecurity/util/TypeConverter.java renamed to src/main/java/io/wwan13/wintersecurity/resolve/util/ResolveTypeConverter.java

@@ -14,21 +14,29 @@
  * limitations under the License.
  */
 
-package io.wwan13.wintersecurity.util;
+package io.wwan13.wintersecurity.resolve.util;
 
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
-public class TypeConverter {
+public class ResolveTypeConverter {
 
     private static final ObjectMapper objectMapper = new ObjectMapper()
             .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
+    private static final String ERROR_MESSAGE_FORMAT =
+            "'%s' cannot be converted to declared type '%s'";
 
-    private TypeConverter() {
+    private ResolveTypeConverter() {
         throw new IllegalStateException("Cannot instantiate a utility class!");
     }
 
     public static Object convertTo(Object originValue, Class<?> targetClazz) {
-        return objectMapper.convertValue(originValue, targetClazz);
+        try {
+            return objectMapper.convertValue(originValue, targetClazz);
+        } catch (IllegalArgumentException e) {
+            throw new IllegalStateException(
+                    String.format(ERROR_MESSAGE_FORMAT, originValue, targetClazz.getSimpleName())
+            );
+        }
     }
 }

src/test/java/io/wwan13/wintersecurity/resolve/ResolveTestContainer.java

@@ -16,12 +16,7 @@
 
 package io.wwan13.wintersecurity.resolve;
 
-import io.wwan13.wintersecurity.jwt.PayloadAnalysis;
-import io.wwan13.wintersecurity.jwt.PayloadAnalyst;
 import io.wwan13.wintersecurity.jwt.TokenClaims;
-import io.wwan13.wintersecurity.jwt.payload.annotation.Roles;
-import io.wwan13.wintersecurity.jwt.payload.annotation.Subject;
-import io.wwan13.wintersecurity.jwt.payload.support.DefaultPayloadAnalyst;
 
 import java.util.Map;
 import java.util.Set;
@@ -33,31 +28,10 @@ public class ResolveTestContainer {
             Set.of(RequestUserRoles.class)
     );
 
-    public static PayloadAnalysis payloadAnalysis;
-
-    static {
-        PayloadAnalyst payloadAnalyst = new DefaultPayloadAnalyst();
-        payloadAnalysis = payloadAnalyst.analyze(ResolveTestPayload.class);
-    }
-
     public static TokenClaims defaultTestClaims = new TokenClaims(
             Map.of(
                     "sub", "1",
                     "roles", "ROLE_USER"
             )
     );
-
-    public static class ResolveTestPayload {
-        @Subject
-        Long subject;
-        @Roles
-        Set<String> roles;
-    }
-
-    public static class ResolveTestPayloadWithStringRole {
-        @Subject
-        Long subject;
-        @Roles
-        String role;
-    }
 }

src/test/java/io/wwan13/wintersecurity/resolve/RolesResolverTest.java

@@ -16,10 +16,7 @@
 
 package io.wwan13.wintersecurity.resolve;
 
-import io.wwan13.wintersecurity.jwt.PayloadAnalysis;
-import io.wwan13.wintersecurity.jwt.PayloadAnalyst;
 import io.wwan13.wintersecurity.jwt.TokenClaims;
-import io.wwan13.wintersecurity.jwt.payload.support.DefaultPayloadAnalyst;
 import io.wwan13.wintersecurity.resolve.stub.StubMethodParameter;
 import io.wwan13.wintersecurity.resolve.stub.StubModerAndViesContainer;
 import io.wwan13.wintersecurity.resolve.stub.StubNativeWebRequest;
@@ -31,21 +28,20 @@
 import java.util.Set;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
 class RolesResolverTest {
 
     static RolesResolver rolesResolver = new RolesResolver(
-            ResolveTestContainer.targetAnnotations,
-            ResolveTestContainer.payloadAnalysis
+            ResolveTestContainer.targetAnnotations
     );
 
     @Test
-    void should_ReturnTrue_when_AnnotationDeclaredWithValidParameterType() {
+    void should_ReturnTrue_when_AnnotationDeclared() {
         // given
         final StubMethodParameter methodParameter = new StubMethodParameter();
 
         methodParameter.declaredAnnotationsWillBe(RequestUserRoles.class);
-        methodParameter.parameterTypeWillBe(Set.class);
 
         // when
         boolean result = rolesResolver.supportsParameter(methodParameter);
@@ -54,43 +50,12 @@ void should_ReturnTrue_when_AnnotationDeclaredWithValidParameterType() {
         assertThat(result).isTrue();
     }
 
-    @Test
-    void should_ReturnFalse_when_InValidParameterType() {
-        // given
-        final StubMethodParameter methodParameter = new StubMethodParameter();
-
-        methodParameter.declaredAnnotationsWillBe(RequestUserRoles.class);
-        methodParameter.parameterTypeWillBe(Long.class);
-
-        // when
-        boolean result = rolesResolver.supportsParameter(methodParameter);
-
-        // then
-        assertThat(result).isFalse();
-    }
-
     @Test
     void should_ReturnFalse_when_AnnotationNotDeclared() {
         // given
         final StubMethodParameter methodParameter = new StubMethodParameter();
 
         methodParameter.declaredAnnotationsWillBe(Set.of());
-        methodParameter.parameterTypeWillBe(Set.class);
-
-        // when
-        boolean result = rolesResolver.supportsParameter(methodParameter);
-
-        // then
-        assertThat(result).isFalse();
-    }
-
-    @Test
-    void should_ReturnFalse_when_InValidParameterTypeIsDataType() {
-        // given
-        final StubMethodParameter methodParameter = new StubMethodParameter();
-
-        methodParameter.declaredAnnotationsWillBe(RequestUserRoles.class);
-        methodParameter.parameterTypeWillBe(Long.class);
 
         // when
         boolean result = rolesResolver.supportsParameter(methodParameter);
@@ -131,16 +96,11 @@ void should_ResolveStringRole_when_NoneCollectionTypeRoleEntered() {
         final StubNativeWebRequest nativeWebRequest = new StubNativeWebRequest();
         final StubWebDataBinderFactory webDataBinderFactory = new StubWebDataBinderFactory();
 
-        final PayloadAnalyst payloadAnalyst = new DefaultPayloadAnalyst();
-        final PayloadAnalysis payloadAnalysis =
-                payloadAnalyst.analyze(ResolveTestContainer.ResolveTestPayloadWithStringRole.class);
-
         nativeWebRequest.requestAttributesWillBe(new TokenClaims(Map.of("roles", "ROLE_USER")));
         methodParameter.parameterTypeWillBe(String.class);
 
         final RolesResolver rolesResolver = new RolesResolver(
-                ResolveTestContainer.targetAnnotations,
-                payloadAnalysis
+                ResolveTestContainer.targetAnnotations
         );
 
         // when
@@ -155,4 +115,27 @@ void should_ResolveStringRole_when_NoneCollectionTypeRoleEntered() {
         assertThat(value.getClass()).isAssignableFrom(String.class);
         assertThat((String) value).isEqualTo("ROLE_USER");
     }
+
+
+    @Test
+    void should_ThrowException_when_InValidParameterTypeDeclared() {
+        // given
+        final StubMethodParameter methodParameter = new StubMethodParameter();
+        final StubModerAndViesContainer modelAndViewContainer = new StubModerAndViesContainer();
+        final StubNativeWebRequest nativeWebRequest = new StubNativeWebRequest();
+        final StubWebDataBinderFactory webDataBinderFactory = new StubWebDataBinderFactory();
+
+        nativeWebRequest.requestAttributesWillBe(ResolveTestContainer.defaultTestClaims);
+        methodParameter.parameterTypeWillBe(Long.class);
+
+        // when
+        assertThatThrownBy(() ->
+                rolesResolver.resolveArgument(
+                        methodParameter,
+                        modelAndViewContainer,
+                        nativeWebRequest,
+                        webDataBinderFactory
+                )
+        ).isInstanceOf(IllegalStateException.class);
+    }
 }