|
| 1 | +package com.bobocode; |
| 2 | + |
| 3 | +import static java.util.stream.Collectors.toList; |
| 4 | +import static org.assertj.core.api.Assertions.assertThat; |
| 5 | +import static org.junit.jupiter.api.Assertions.assertEquals; |
| 6 | +import static org.junit.jupiter.api.Assertions.assertNull; |
| 7 | +import static org.junit.jupiter.api.Assertions.assertTrue; |
| 8 | + |
| 9 | +import com.bobocode.config.TrimmingEnabledConfig; |
| 10 | +import com.bobocode.config.TrimmingNotEnabledConfig; |
| 11 | +import com.bobocode.service.TrimmedService; |
| 12 | +import java.lang.annotation.Annotation; |
| 13 | +import java.lang.annotation.ElementType; |
| 14 | +import java.lang.annotation.Retention; |
| 15 | +import java.lang.annotation.RetentionPolicy; |
| 16 | +import java.lang.annotation.Target; |
| 17 | +import java.lang.reflect.Constructor; |
| 18 | +import java.lang.reflect.Method; |
| 19 | +import java.util.Arrays; |
| 20 | +import java.util.List; |
| 21 | +import java.util.NoSuchElementException; |
| 22 | +import java.util.Optional; |
| 23 | +import java.util.stream.Stream; |
| 24 | +import lombok.AllArgsConstructor; |
| 25 | +import lombok.EqualsAndHashCode; |
| 26 | +import lombok.SneakyThrows; |
| 27 | +import org.junit.jupiter.api.DisplayName; |
| 28 | +import org.junit.jupiter.api.MethodOrderer; |
| 29 | +import org.junit.jupiter.api.Nested; |
| 30 | +import org.junit.jupiter.api.Order; |
| 31 | +import org.junit.jupiter.api.Test; |
| 32 | +import org.junit.jupiter.api.TestMethodOrder; |
| 33 | +import org.reflections.Reflections; |
| 34 | +import org.reflections.scanners.SubTypesScanner; |
| 35 | +import org.springframework.beans.factory.annotation.Autowired; |
| 36 | +import org.springframework.beans.factory.config.BeanPostProcessor; |
| 37 | +import org.springframework.context.annotation.Bean; |
| 38 | +import org.springframework.context.annotation.Configuration; |
| 39 | +import org.springframework.context.annotation.Import; |
| 40 | +import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; |
| 41 | + |
| 42 | + |
| 43 | +@TestMethodOrder(MethodOrderer.OrderAnnotation.class) |
| 44 | +class EnableStringTrimmingTest { |
| 45 | + |
| 46 | + @Test |
| 47 | + @Order(1) |
| 48 | + @DisplayName("Annotation @EnableStringTrimming has target 'TYPE'") |
| 49 | + void enableStringTrimmingAnnotationHasCorrectTarget() { |
| 50 | + Optional<Class<? extends Annotation>> annotation = findAnnotationInPackage("EnableStringTrimming"); |
| 51 | + Optional<ElementType[]> targetValues = annotation.map(a -> a.getAnnotation(Target.class)).map(Target::value); |
| 52 | + |
| 53 | + assertTrue(targetValues.isPresent()); |
| 54 | + assertEquals(1, targetValues.get().length); |
| 55 | + assertThat(List.of(targetValues.get())).contains(ElementType.TYPE); |
| 56 | + |
| 57 | + } |
| 58 | + |
| 59 | + @Test |
| 60 | + @Order(2) |
| 61 | + @DisplayName("Annotation @EnableStringTrimming has retention 'RUNTIME'") |
| 62 | + void enableStringTrimmingAnnotationHasRuntimeRetention() { |
| 63 | + Optional<Class<? extends Annotation>> annotation = findAnnotationInPackage("EnableStringTrimming"); |
| 64 | + Optional<Retention> retention = annotation.map(a -> a.getAnnotation(Retention.class)) |
| 65 | + .filter(r -> r.value().equals(RetentionPolicy.RUNTIME)); |
| 66 | + |
| 67 | + assertTrue(retention.isPresent()); |
| 68 | + } |
| 69 | + |
| 70 | + @Test |
| 71 | + @Order(3) |
| 72 | + @DisplayName("Annotation @EnableStringTrimming imports StringTrimmingConfiguration") |
| 73 | + void enableStringTrimmingAnnotationImportsCorrectConfig() { |
| 74 | + Optional<Class<? extends Annotation>> annotation = findAnnotationInPackage("EnableStringTrimming"); |
| 75 | + List<Class<?>> importValues = Arrays.stream(annotation |
| 76 | + .map(a -> a.getAnnotation(Import.class)) |
| 77 | + .map(Import::value) |
| 78 | + .orElseGet(() -> new Class<?>[0])) |
| 79 | + .toList(); |
| 80 | + List<String> importNames = importValues.stream().map(Class::getSimpleName).collect(toList()); |
| 81 | + assertThat(importNames).contains("StringTrimmingConfiguration"); |
| 82 | + } |
| 83 | + |
| 84 | + @Test |
| 85 | + @Order(4) |
| 86 | + @DisplayName("StringTrimmingConfiguration is implemented") |
| 87 | + void stringTrimmingConfiguration() { |
| 88 | + Optional<Class<?>> configClass = findClassInPackage("StringTrimmingConfiguration"); |
| 89 | + assertTrue(configClass.isPresent()); |
| 90 | + } |
| 91 | + |
| 92 | + @Test |
| 93 | + @Order(5) |
| 94 | + @DisplayName("StringTrimmingConfiguration is not annotated by @Configuration Spring annotation.") |
| 95 | + void stringTrimmingConfigurationIsNotAnnotatedAsConfiguration() { |
| 96 | + Optional<Class<?>> configClass = findClassInPackage("StringTrimmingConfiguration"); |
| 97 | + assertNull(configClass.get().getDeclaredAnnotation(Configuration.class)); |
| 98 | + } |
| 99 | + |
| 100 | + @Test |
| 101 | + @Order(6) |
| 102 | + @DisplayName("StringTrimmingConfiguration declares a TrimmedAnnotationBeanPostProcessor bean") |
| 103 | + void stringTrimmingConfigurationCreatesBeanOfTrimmedAnnotationPostProcessor() { |
| 104 | + Optional<Class<?>> configClass = findClassInPackage("StringTrimmingConfiguration"); |
| 105 | + |
| 106 | + Method[] methods = |
| 107 | + configClass.orElseThrow(() -> new NoSuchElementException("StringTrimmingConfiguration class is not found")) |
| 108 | + .getDeclaredMethods(); |
| 109 | + |
| 110 | + Optional<Method> postProcessorBeanMethod = |
| 111 | + Stream.of(methods).filter(m -> m.getReturnType().equals(TrimmedAnnotationBeanPostProcessor.class)) |
| 112 | + .findFirst(); |
| 113 | + assertTrue(postProcessorBeanMethod.isPresent()); |
| 114 | + } |
| 115 | + |
| 116 | + @Test |
| 117 | + @Order(7) |
| 118 | + @DisplayName("Methods of StringTrimmingConfiguration that provides TrimmedAnnotationBeanPostProcessor instance annotated with" + |
| 119 | + " @Bean annotation") |
| 120 | + void trimmedAnnotationBeanPostProcessorMethodMarkedAsBean() { |
| 121 | + Optional<Class<?>> configClass = findClassInPackage("StringTrimmingConfiguration"); |
| 122 | + Method[] methods = configClass.orElseThrow( |
| 123 | + () -> new NoSuchElementException("StringTrimmingConfiguration class is not found")).getDeclaredMethods(); |
| 124 | + Optional<Bean> beanAnnotation = Stream.of(methods) |
| 125 | + .filter(m -> m.getReturnType().equals(TrimmedAnnotationBeanPostProcessor.class)) |
| 126 | + .map(m -> m.getAnnotation(Bean.class)).findFirst(); |
| 127 | + assertTrue(beanAnnotation.isPresent()); |
| 128 | + } |
| 129 | + |
| 130 | + @Test |
| 131 | + @Order(8) |
| 132 | + @DisplayName("TrimmedAnnotationBeanPostProcessor implements BeanPostProcessor interface") |
| 133 | + void trimmedAnnotationBeanPostProcessorImplementsBeanPostProcessor() { |
| 134 | + boolean isBeanPostProcessorPresent = Arrays.stream(TrimmedAnnotationBeanPostProcessor.class.getInterfaces()) |
| 135 | + .anyMatch(i -> i.isAssignableFrom( |
| 136 | + BeanPostProcessor.class)); |
| 137 | + assertTrue(isBeanPostProcessorPresent); |
| 138 | + } |
| 139 | + |
| 140 | + @Test |
| 141 | + @Order(9) |
| 142 | + @DisplayName("TrimmedAnnotationBeanPostProcessor overrides postProcessAfterInitialization() method") |
| 143 | + void trimmedAnnotationBeanPostProcessorOverridesPostProcessAfterInitMethod() { |
| 144 | + List<String> methodNames = Arrays.stream(TrimmedAnnotationBeanPostProcessor.class.getDeclaredMethods()) |
| 145 | + .map(Method::getName) |
| 146 | + .toList(); |
| 147 | + assertThat(methodNames).contains("postProcessAfterInitialization"); |
| 148 | + } |
| 149 | + |
| 150 | + @Test |
| 151 | + @Order(10) |
| 152 | + @DisplayName("Method postProcessBeforeInitialization() does not create a new proxy") |
| 153 | + @SneakyThrows |
| 154 | + void trimmedAnnotationBeanPostProcessorNotOverridesPostProcessAfterInitMethod() { |
| 155 | + Constructor<TrimmedAnnotationBeanPostProcessor> constructor = TrimmedAnnotationBeanPostProcessor.class.getDeclaredConstructor(); |
| 156 | + TrimmedAnnotationBeanPostProcessor processor = constructor.newInstance(); |
| 157 | + TestBean testBean = new TestBean(1L, "Bobobean"); |
| 158 | + |
| 159 | + Method method = null; |
| 160 | + try { |
| 161 | + method = processor.getClass().getDeclaredMethod( |
| 162 | + "postProcessBeforeInitialization", Object.class, String.class); |
| 163 | + } catch (NoSuchMethodException e) { |
| 164 | + |
| 165 | + Optional<Class<?>> beanPostProcessor = Arrays.stream(processor.getClass().getInterfaces()) |
| 166 | + .filter(i -> i.getSimpleName().equals("BeanPostProcessor")).findFirst(); |
| 167 | + |
| 168 | + if (beanPostProcessor.isPresent()) { |
| 169 | + method = beanPostProcessor.get().getDeclaredMethod( |
| 170 | + "postProcessBeforeInitialization", Object.class, String.class); |
| 171 | + } |
| 172 | + } |
| 173 | + Object beanAfterPostProcessing = method.invoke(processor, testBean, testBean.getClass().getName()); |
| 174 | + |
| 175 | + assertEquals(beanAfterPostProcessing, testBean); |
| 176 | + } |
| 177 | + |
| 178 | + @Nested |
| 179 | + @SpringJUnitConfig(classes = {TrimmingEnabledConfig.class}) |
| 180 | + class TrimmingEnabledTest { |
| 181 | + |
| 182 | + @Test |
| 183 | + @DisplayName("TrimmedAnnotationBeanPostProcessor trims String input params marked with @Trimmed") |
| 184 | + void trimmedAnnotationPostProcessorAnnotatedInputParams(@Autowired TrimmedService service) { |
| 185 | + String inputArgs = " Simba Bimba "; |
| 186 | + String actual = service.getTheTrimmedString(inputArgs); |
| 187 | + |
| 188 | + assertEquals(inputArgs.trim(), actual); |
| 189 | + } |
| 190 | + |
| 191 | + @Test |
| 192 | + @DisplayName("TrimmedAnnotationBeanPostProcessor not trims String input params that not marked by @Trimmed") |
| 193 | + void trimmedAnnotationPostProcessorNotAnnotatedInputParams(@Autowired TrimmedService service) { |
| 194 | + String inputArgs = " Simba Bimba "; |
| 195 | + String actual = service.getNotTrimmedString(inputArgs); |
| 196 | + |
| 197 | + assertEquals(inputArgs, actual); |
| 198 | + } |
| 199 | + } |
| 200 | + |
| 201 | + @Nested |
| 202 | + @SpringJUnitConfig(classes = TrimmingNotEnabledConfig.class) |
| 203 | + class TrimmingNotEnabledTest { |
| 204 | + |
| 205 | + @Test |
| 206 | + @DisplayName( |
| 207 | + "TrimmedAnnotationBeanPostProcessor does not trims String input parameters marked by " + |
| 208 | + "@Trimmed if trimming is not enabled by @EnableStringTrimming") |
| 209 | + void trimmedAnnotationPostProcessorAnnotatedInputParams(@Autowired TrimmedService service) { |
| 210 | + String inputArgs = " Mufasa LionKing "; |
| 211 | + String actual = service.getTheTrimmedString(inputArgs); |
| 212 | + |
| 213 | + assertEquals(inputArgs, actual); |
| 214 | + } |
| 215 | + } |
| 216 | + |
| 217 | + private Optional<Class<?>> findClassInPackage(String className) { |
| 218 | + String packageName = TrimmedAnnotationBeanPostProcessor.class.getPackageName(); |
| 219 | + Reflections reflections = new Reflections(packageName, new SubTypesScanner(false)); |
| 220 | + return reflections.getSubTypesOf(Object.class) |
| 221 | + .stream() |
| 222 | + .filter(c -> c.getSimpleName().equals(className)) |
| 223 | + .findFirst(); |
| 224 | + } |
| 225 | + |
| 226 | + private Optional<Class<? extends Annotation>> findAnnotationInPackage(String annotationName) { |
| 227 | + String packageName = TrimmedAnnotationBeanPostProcessor.class.getPackageName(); |
| 228 | + Reflections reflections = new Reflections(packageName, new SubTypesScanner(false)); |
| 229 | + return reflections.getSubTypesOf(Annotation.class) |
| 230 | + .stream() |
| 231 | + .filter(a -> a.getSimpleName().equals(annotationName)) |
| 232 | + .findFirst(); |
| 233 | + } |
| 234 | + |
| 235 | + @EqualsAndHashCode |
| 236 | + @AllArgsConstructor |
| 237 | + private class TestBean { |
| 238 | + |
| 239 | + private Long id; |
| 240 | + private String name; |
| 241 | + |
| 242 | + @Override |
| 243 | + public String toString() { |
| 244 | + return "TestBean{" + |
| 245 | + "id=" + id + |
| 246 | + ", name='" + name + '\'' + |
| 247 | + '}'; |
| 248 | + } |
| 249 | + } |
| 250 | +} |
0 commit comments