refactor: Catch InaccessibleObjectException early

Any exception happening during reflection should
be caught by the Reflector class and turned into a
SpecimenException that we can potentially handle somewhere else in the call stack.
This allows us to keep responsibilities a little closer to where they should be.

Author: akutschera

pom.xml

@@ -24,6 +24,7 @@
         <maven-gpg-plugin.version>1.5</maven-gpg-plugin.version>
         <nexus-staging-maven-plugin.version>1.6.8</nexus-staging-maven-plugin.version>
         <junit-jupiter-engine.version>5.5.1</junit-jupiter-engine.version>
+        <mockito.version>4.5.1</mockito.version>
     </properties>
 
     <dependencies>
@@ -70,7 +71,13 @@
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-core</artifactId>
-            <version>3.0.0</version>
+            <version>${mockito.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-inline</artifactId>
+            <version>${mockito.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>

src/main/java/com/github/nylle/javafixture/Reflector.java

@@ -1,6 +1,7 @@
 package com.github.nylle.javafixture;
 
 import java.lang.reflect.Field;
+import java.lang.reflect.InaccessibleObjectException;
 import java.lang.reflect.Modifier;
 import java.util.Optional;
 import java.util.stream.Stream;
@@ -63,7 +64,7 @@ public void setField(Field field, Object value) {
             field.set(instance, value);
         } catch (SecurityException e) {
             throw new SpecimenException(format("Unable to access field %s on object of type %s", field.getName(), instance.getClass().getName()), e);
-        } catch (IllegalAccessException e) {
+        } catch (IllegalAccessException | InaccessibleObjectException e) {
             throw new SpecimenException(format("Unable to set field %s on object of type %s", field.getName(), instance.getClass().getName()), e);
         }
     }

src/main/java/com/github/nylle/javafixture/specimen/GenericSpecimen.java

@@ -5,11 +5,11 @@
 import com.github.nylle.javafixture.ISpecimen;
 import com.github.nylle.javafixture.InstanceFactory;
 import com.github.nylle.javafixture.Reflector;
+import com.github.nylle.javafixture.SpecimenException;
 import com.github.nylle.javafixture.SpecimenFactory;
 import com.github.nylle.javafixture.SpecimenType;
 
 import java.lang.annotation.Annotation;
-import java.lang.reflect.InaccessibleObjectException;
 import java.util.Map;
 import java.util.stream.IntStream;
 
@@ -97,7 +97,7 @@ private T populate(CustomizationContext customizationContext) {
                                     specimens.getOrDefault(
                                             field.getGenericType().getTypeName(),
                                             specimenFactory.build(SpecimenType.fromClass(field.getType()))).create(new Annotation[0]))));
-        } catch (InaccessibleObjectException ex ) {
+        } catch (SpecimenException ex ) {
             return context.overwrite(type, instanceFactory.construct(type));
         }
         return result;

src/main/java/com/github/nylle/javafixture/specimen/ObjectSpecimen.java

@@ -5,11 +5,11 @@
 import com.github.nylle.javafixture.ISpecimen;
 import com.github.nylle.javafixture.InstanceFactory;
 import com.github.nylle.javafixture.Reflector;
+import com.github.nylle.javafixture.SpecimenException;
 import com.github.nylle.javafixture.SpecimenFactory;
 import com.github.nylle.javafixture.SpecimenType;
 
 import java.lang.annotation.Annotation;
-import java.lang.reflect.InaccessibleObjectException;
 import java.util.Map;
 
 import static com.github.nylle.javafixture.CustomizationContext.noContext;
@@ -76,7 +76,7 @@ private T populate(CustomizationContext customizationContext) {
                                     Map.<String, ISpecimen<?>>of().getOrDefault(
                                             field.getGenericType().getTypeName(),
                                             specimenFactory.build(SpecimenType.fromClass(field.getGenericType()))).create(field.getAnnotations()))));
-        } catch (InaccessibleObjectException ex ) {
+        } catch (SpecimenException ex ) {
             return context.overwrite(type, instanceFactory.construct(type));
         }
         return result;

src/test/java/com/github/nylle/javafixture/ReflectorTest.java

@@ -4,12 +4,17 @@
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
 
+import java.lang.reflect.Field;
+import java.lang.reflect.InaccessibleObjectException;
 import java.util.List;
 import java.util.Map;
 
 import static org.assertj.core.api.Assertions.assertThatCode;
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.doThrow;
 
 class ReflectorTest {
 
@@ -79,4 +84,40 @@ void omittingDuplicateFields() {
                     .withNoCause();
         }
     }
+
+    @Nested
+    @DisplayName("when setting a field via reflection")
+    class SetField {
+        @DisplayName("an IllegalAccessException is turned to a SpecimenException")
+        @Test
+        void catchIllegalAccessException() throws Exception {
+            var mockedField = Mockito.mock(Field.class);
+            var sut = new Reflector<>("");
+            doThrow(new IllegalAccessException("expected")).when(mockedField).set(any(), any());
+
+            assertThatExceptionOfType(SpecimenException.class)
+                    .isThrownBy(() -> sut.setField(mockedField, ""));
+        }
+
+        @DisplayName("an IllegalAccessException is turned to a SpecimenException")
+        @Test
+        void catchSecurityException() {
+            var mockedField = Mockito.mock(Field.class);
+            var sut = new Reflector<>("");
+            doThrow(new SecurityException("expected")).when(mockedField).setAccessible(true);
+            assertThatExceptionOfType(SpecimenException.class)
+                    .isThrownBy(() -> sut.setField(mockedField, ""));
+        }
+
+        @DisplayName("an InaccessibleObjectException is turned to a SpecimenException")
+        @Test
+        void catchInaccessibleObjectException() {
+            var mockedField = Mockito.mock(Field.class);
+            var sut = new Reflector<>("");
+            doThrow(new InaccessibleObjectException("expected")).when(mockedField).setAccessible(true);
+            assertThatExceptionOfType(SpecimenException.class)
+                    .isThrownBy(() -> sut.setField(mockedField, ""));
+        }
+    }
+
 }