#35 - Add DbJson for easier asserting of JSON content of bean(s)

Author: rbygrave

pom.xml

@@ -29,14 +29,20 @@
     <dependency>
       <groupId>io.ebean</groupId>
       <artifactId>ebean</artifactId>
-      <version>12.1.3</version>
+      <version>12.1.6</version>
       <scope>provided</scope>
     </dependency>
 
     <dependency>
       <groupId>io.ebean.test</groupId>
       <artifactId>ebean-test-docker</artifactId>
-      <version>2.11.1</version>
+      <version>2.11.2</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.assertj</groupId>
+      <artifactId>assertj-core</artifactId>
+      <version>3.14.0</version>
     </dependency>
 
     <!-- Including JAXB for DB Migration generation with Java 11+ -->
@@ -90,13 +96,6 @@
       <scope>test</scope>
     </dependency>
 
-    <dependency>
-      <groupId>org.assertj</groupId>
-      <artifactId>assertj-core</artifactId>
-      <version>3.3.0</version>
-      <scope>test</scope>
-    </dependency>
-
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>

src/main/java/io/ebean/test/DbJson.java

@@ -0,0 +1,110 @@
+package io.ebean.test;
+
+import io.ebean.DB;
+import io.ebean.migration.util.IOUtils;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Helper for testing to assert that the JSON form of an entity
+ * or list of entities match a String / typically test resource.
+ *
+ * <pre>{@code
+ *
+ *    DbJson.of(timedEntries)
+ *      .replace("id", "eventTime")
+ *      .assertContentMatches("/assertJson/full-1-timed.json");
+ *
+ * }</pre>
+ */
+public class DbJson {
+
+  /**
+   * Create a PrettyJson object that has the JSON form of the
+   * entity bean or beans.
+   *
+   * <pre>{@code
+   *
+   *    DbJson.of(timedEntries)
+   *      .replace("id", "eventTime")
+   *      .assertContentMatches("/assertJson/full-1-timed.json");
+   *
+   * }</pre>
+   */
+  public static PrettyJson of(Object bean) {
+    return new PrettyJson(DB.json().toJsonPretty(bean));
+  }
+
+  /**
+   * Read the content for the given resource path.
+   */
+  public static String readResource(String resourcePath) {
+    InputStream is = DbJson.class.getResourceAsStream(resourcePath);
+    try {
+      return IOUtils.readUtf8(is).trim();
+    } catch (IOException e) {
+      throw new IllegalArgumentException(e);
+    }
+  }
+
+  /**
+   * Contains the JSON of beans(s).
+   */
+  public static class PrettyJson {
+
+    private String placeHolder = "\"*\"";
+    private String rawJson;
+
+    PrettyJson(String rawJson) {
+      this.rawJson = rawJson;
+    }
+
+    /**
+     * Set the placeHolder to use when replacing property values.
+     */
+    public PrettyJson withPlaceholder(String placeHolder) {
+      this.placeHolder = placeHolder;
+      return this;
+    }
+
+    /**
+     * Replace the values of the given properties with a placeholder value.
+     * <p>
+     * Typically we do this on generated properties such as id and timestamp properties.
+     * </p>
+     */
+    public PrettyJson replace(String... propertyNames) {
+      for (String propertyName : propertyNames) {
+        String placeholder = "\"" + propertyName + "\": " + placeHolder;
+        rawJson = rawJson.replaceAll("\"" + propertyName + "\": (\\d+)", placeholder);
+        rawJson = rawJson.replaceAll("\"" + propertyName + "\": \"(.*?)\"", placeholder);
+      }
+      return this;
+    }
+
+    /**
+     * Return the JSON content.
+     */
+    public String asJson() {
+      return rawJson;
+    }
+
+    /**
+     * Assert the json matches the content at the given resource path.
+     *
+     * <pre>{@code
+     *
+     *    DbJson.of(timedEntries)
+     *      .replace("id", "eventTime")
+     *      .assertContentMatches("/assertJson/full-1-timed.json");
+     *
+     * }</pre>
+     */
+    public void assertContentMatches(String resourcePath) {
+      assertThat(rawJson).isEqualTo(readResource(resourcePath));
+    }
+  }
+}

src/test/java/io/ebean/test/DbJsonTest.java

@@ -0,0 +1,41 @@
+package io.ebean.test;
+
+import io.ebean.DB;
+import org.junit.Test;
+import org.test.BSimpleWithGen;
+
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+
+public class DbJsonTest {
+
+  @Test
+  public void of() {
+
+    DB.find(BSimpleWithGen.class).delete();
+
+    BSimpleWithGen bean = new BSimpleWithGen("something");
+    DB.save(bean);
+
+    assertThat(bean.getVersion()).isEqualTo(1);
+
+    DbJson.of(bean)
+      .withPlaceholder("_")
+      .replace("id", "whenModified")
+      .assertContentMatches("/bean/example-bean.json");
+
+
+    BSimpleWithGen bean2 = new BSimpleWithGen("other");
+    DB.save(bean2);
+
+    final List<BSimpleWithGen> beans = DB.find(BSimpleWithGen.class).findList();
+
+    DbJson.of(beans)
+      //.withPlaceholder("_")
+      .replace("id", "whenModified")
+      .assertContentMatches("/bean/example-list.json");
+
+  }
+}

src/test/java/org/test/BSimpleWithGen.java

@@ -1,8 +1,12 @@
 package org.test;
 
+import io.ebean.annotation.WhenModified;
+
 import javax.persistence.Entity;
 import javax.persistence.Id;
 import javax.persistence.Transient;
+import javax.persistence.Version;
+import java.time.Instant;
 import java.util.List;
 import java.util.Map;
 
@@ -17,6 +21,12 @@ public class BSimpleWithGen {
   @Transient
   private Map<String, List<String>> someMap;
 
+  @WhenModified
+  private Instant whenModified;
+
+  @Version
+  private long version;
+
   public BSimpleWithGen(String name) {
     this.name = name;
   }
@@ -45,4 +55,11 @@ public void setSomeMap(Map<String, List<String>> someMap) {
     this.someMap = someMap;
   }
 
+  public Instant getWhenModified() {
+    return whenModified;
+  }
+
+  public long getVersion() {
+    return version;
+  }
 }

src/test/java/org/test/ForTestsTest.java

@@ -50,4 +50,5 @@ private void doInsert() {
     BSimpleWithGen bean = new BSimpleWithGen("doInsert");
     DB.save(bean);
   }
+
 }

src/test/resources/bean/example-bean.json

@@ -0,0 +1,6 @@
+{
+  "id": _,
+  "name": "something",
+  "whenModified": _,
+  "version": 1
+}

src/test/resources/bean/example-list.json

@@ -0,0 +1,11 @@
+[ {
+  "id": "*",
+  "name": "something",
+  "whenModified": "*",
+  "version": 1
+}, {
+  "id": "*",
+  "name": "other",
+  "whenModified": "*",
+  "version": 1
+} ]