Merge pull request #5 from json-snapshot/extractArgs

Includes SnapshotUtils with extractArgs for Mockito mocks

Author: andrebonna

pom.xml

@@ -71,6 +71,11 @@
             <artifactId>assertj-core</artifactId>
             <version>3.8.0</version>
         </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-all</artifactId>
+            <version>1.10.19</version>
+        </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>
@@ -85,6 +90,7 @@
             <version>4.12</version>
             <scope>test</scope>
         </dependency>
+
     </dependencies>
 
     <build>

src/main/java/io/github/jsonSnapshot/SnapshotMatcher.java

@@ -3,15 +3,23 @@
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.assertj.core.util.Arrays;
+import org.mockito.ArgumentCaptor;
+import org.mockito.verification.VerificationMode;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
+import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
+import java.lang.reflect.Parameter;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
 import java.util.stream.Collectors;
 
+import static org.mockito.Mockito.atLeastOnce;
+import static org.mockito.Mockito.verify;
+
 public class SnapshotMatcher {
 
     private static Logger log = LoggerFactory.getLogger(SnapshotMatcher.class);

src/main/java/io/github/jsonSnapshot/SnapshotUtils.java

@@ -0,0 +1,59 @@
+package io.github.jsonSnapshot;
+
+import org.mockito.ArgumentCaptor;
+
+import java.lang.reflect.Parameter;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.List;
+
+import static org.mockito.Mockito.atLeastOnce;
+import static org.mockito.Mockito.verify;
+
+public class SnapshotUtils {
+
+    public static <T> HashMap<String, List<LinkedHashMap<String, Object>>> extractArgs(T object, String methodName,
+                                                                                       Class... classes) {
+        List<ArgumentCaptor> captors = new ArrayList<>();
+        HashMap<String, List<LinkedHashMap<String, Object>>> result = new HashMap<>();
+
+        for (Class clazz : classes) {
+            captors.add(ArgumentCaptor.forClass(clazz));
+        }
+
+        try {
+            Parameter[] parameters = object.getClass().getMethod(methodName, classes).getParameters();
+
+            object.getClass()
+                    .getMethod(methodName, classes)
+                    .invoke(verify(object, atLeastOnce()), captors.stream().map(ArgumentCaptor::capture).toArray());
+
+
+            List<LinkedHashMap<String, Object>> extractedObjects = new ArrayList<>();
+
+            int numberOfCall;
+
+            if (captors.size() > 0) {
+                numberOfCall = captors.get(0).getAllValues().size();
+
+                for (int i = 0; i < numberOfCall; i++) {
+                    LinkedHashMap<String, Object> objectMap = new LinkedHashMap<>();
+
+                    int j = 0;
+                    for (ArgumentCaptor captor : captors) {
+                        objectMap.put(parameters[j].getName(), captor.getAllValues().get(i));
+                        j++;
+                    }
+                    extractedObjects.add(objectMap);
+                }
+            }
+
+            result.put(object.getClass().getSuperclass().getSimpleName() + "." + methodName, extractedObjects);
+        } catch (Exception e) {
+            throw new SnapshotMatchException(e.getMessage());
+        }
+
+        return result;
+    }
+}

src/test/java/io/github/jsonSnapshot/FakeObject.java

@@ -3,6 +3,8 @@
 import lombok.Builder;
 import lombok.Setter;
 
+import java.util.List;
+
 @Builder
 public class FakeObject {
 
@@ -15,4 +17,9 @@ public class FakeObject {
     @Setter
     private FakeObject fakeObject;
 
+
+    public void fakeMethod(String fakeName, Long fakeNumber, List<String> fakeList) {
+
+    }
+
 }

src/test/java/io/github/jsonSnapshot/SnapshotIntegrationTest.java

@@ -1,14 +1,17 @@
 package io.github.jsonSnapshot;
 
+import org.hamcrest.core.StringStartsWith;
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
+import org.junit.runner.RunWith;
+import org.mockito.runners.MockitoJUnitRunner;
 
 import static io.github.jsonSnapshot.SnapshotMatcher.*;
-import static org.hamcrest.CoreMatchers.startsWith;
 
+@RunWith(MockitoJUnitRunner.class)
 public class SnapshotIntegrationTest {
 
     @Rule
@@ -47,7 +50,7 @@ public void shouldMatchSnapshotFour() {
     @Test
     public void shouldThrowSnapshotMatchException() {
         expectedException.expect(SnapshotMatchException.class);
-        expectedException.expectMessage(startsWith("Error on: \n" +
+        expectedException.expectMessage(StringStartsWith.startsWith("Error on: \n" +
                 "io.github.jsonSnapshot.SnapshotIntegrationTest.shouldThrowSnapshotMatchException=["));
         expect(FakeObject.builder().id("anyId5").value(6).name("anyName5").build()).toMatchSnapshot();
     }

src/test/java/io/github/jsonSnapshot/SnapshotMatcherTest.java

@@ -2,7 +2,9 @@
 
 import org.apache.commons.lang3.StringUtils;
 import org.junit.*;
+import org.junit.runner.RunWith;
 import org.junit.runners.MethodSorters;
+import org.mockito.runners.MockitoJUnitRunner;
 
 import java.io.File;
 import java.io.IOException;
@@ -11,6 +13,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+@RunWith(MockitoJUnitRunner.class)
 @FixMethodOrder(MethodSorters.NAME_ASCENDING)
 public class SnapshotMatcherTest {
 

src/test/java/io/github/jsonSnapshot/SnapshotTest.java

@@ -3,6 +3,8 @@
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.runners.MockitoJUnitRunner;
 
 import java.io.IOException;
 import java.nio.file.Files;
@@ -12,6 +14,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+@RunWith(MockitoJUnitRunner.class)
 public class SnapshotTest {
 
     private static final String FILE_PATH = "src/test/java/anyFilePath";

src/test/java/io/github/jsonSnapshot/SnapshotUtilsTest.java

@@ -0,0 +1,46 @@
+package io.github.jsonSnapshot;
+
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+
+import static io.github.jsonSnapshot.SnapshotMatcher.expect;
+import static io.github.jsonSnapshot.SnapshotMatcher.start;
+import static io.github.jsonSnapshot.SnapshotMatcher.validateSnapshots;
+
+@RunWith(MockitoJUnitRunner.class)
+public class SnapshotUtilsTest {
+
+    @Mock
+    private FakeObject fakeObject;
+
+    @BeforeClass
+    public static void beforeAll() {
+        start();
+    }
+
+    @AfterClass
+    public static void afterAll() {
+        validateSnapshots();
+    }
+
+
+    @Test
+    public void shouldExtractArgsFromMethod() throws NoSuchMethodException {
+
+        fakeObject.fakeMethod("test1", 1L, Arrays.asList("listTest1"));
+        fakeObject.fakeMethod("test2", 2L, Arrays.asList("listTest1", "listTest2"));
+
+        HashMap<?, ?> fakeMethodArgs = SnapshotUtils.extractArgs(fakeObject, "fakeMethod", String.class, Long.class, List.class);
+        expect(fakeMethodArgs).toMatchSnapshot();
+
+    }
+
+}

src/test/java/io/github/jsonSnapshot/SnapshotUtilsTest.snap

@@ -0,0 +1,21 @@
+io.github.jsonSnapshot.SnapshotUtilsTest.shouldExtractArgsFromMethod=[
+  {
+    "FakeObject.fakeMethod": [
+      {
+        "arg0": "test1",
+        "arg1": 1,
+        "arg2": [
+          "listTest1"
+        ]
+      },
+      {
+        "arg0": "test2",
+        "arg1": 2,
+        "arg2": [
+          "listTest1",
+          "listTest2"
+        ]
+      }
+    ]
+  }
+]