Add warning for skipped fields

Issue #468
j-easy · Sep 9, 2023 · 51150d4 · 51150d4
1 parent 6838395
commit 51150d4
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/pom.xml b/pom.xml
@@ -24,6 +24,7 @@
         <objenesis.version>3.3</objenesis.version>
         <datafaker.version>2.0.1</datafaker.version>
         <classgraph.version>4.8.160</classgraph.version>
+        <slf4j.version>2.0.7</slf4j.version>
 
         <!-- test dependencies -->
         <junit.version>5.9.3</junit.version>
@@ -97,6 +98,11 @@
             <artifactId>datafaker</artifactId>
             <version>${datafaker.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>
@@ -121,7 +127,13 @@
             <version>${mockito.version}</version>
             <scope>test</scope>
         </dependency>
-    </dependencies>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <version>${slf4j.version}</version>
+            <scope>test</scope>
+        </dependency>
+        </dependencies>
 
     <build>
         <plugins>

diff --git a/src/main/java/org/jeasy/random/FieldPopulator.java b/src/main/java/org/jeasy/random/FieldPopulator.java
@@ -31,6 +31,8 @@
 import org.jeasy.random.api.Randomizer;
 import org.jeasy.random.api.RandomizerProvider;
 import org.jeasy.random.randomizers.misc.SkipRandomizer;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
@@ -52,6 +54,8 @@
  */
 class FieldPopulator {
 
+    private static final Logger logger = LoggerFactory.getLogger(FieldPopulator.class);
+
     private final EasyRandom easyRandom;
 
     private final ArrayPopulator arrayPopulator;
@@ -109,6 +113,9 @@ void populateField(final Object target, final Field field, final RandomizationCo
                     throw new ObjectCreationException(exceptionMessage,  e.getCause());
                 }
             }
+        } else {
+            logger.warn("Skipping populating field {}#{} as the randomization depth has been reached: {}",
+                    field.getDeclaringClass().getSimpleName(), field.getName(), context.getParameters().getRandomizationDepth());
         }
         context.popStackItem();
     }

diff --git a/src/test/java/org/jeasy/random/FieldPopulatorTest.java b/src/test/java/org/jeasy/random/FieldPopulatorTest.java
@@ -183,7 +183,9 @@ void whenRandomizationDepthIsExceeded_thenFieldsAreNotInitialized() throws Excep
         // Given
         Field name = Human.class.getDeclaredField("name");
         Human human = new Human();
+        EasyRandomParameters parameters = new EasyRandomParameters().randomizationDepth(5);
         RandomizationContext context = Mockito.mock(RandomizationContext.class);
+        when(context.getParameters()).thenReturn(parameters);
         when(context.hasExceededRandomizationDepth()).thenReturn(true);
 
         // When