Add unit tests for print_record() Fix function. (#238)

Author: blackwinter

metafix/src/test/java/org/metafacture/metafix/MetafixRecordTest.java

@@ -25,7 +25,10 @@
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 
+import java.io.IOException;
 import java.util.Arrays;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
 
 /**
  * Tests Metafix record level methods. Following the cheat sheet
@@ -1854,6 +1857,102 @@ public void pasteWithLiteralStrings() {
             });
     }
 
+    private void shouldPrintRecord(final String before, final String args, final String after, final Consumer<Supplier<StreamReceiver>> consumer, final String expected) {
+        MetafixTestHelpers.assertStdout(expected, () ->
+            MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                    before,
+                    "print_record(" + args + ")",
+                    after
+                ),
+                i -> {
+                    i.startRecord("rec1");
+                    i.literal("a", "eeny");
+                    i.literal("a", "meeny");
+                    i.startEntity("c");
+                    i.literal("d", "moe");
+                    i.endEntity();
+                    i.endRecord();
+                }, o -> {
+                    o.get().startRecord("rec1");
+                    o.get().literal("a", "eeny");
+                    o.get().literal("a", "meeny");
+                    o.get().startEntity("c");
+                    o.get().literal("d", "moe");
+                    o.get().endEntity();
+
+                    if (consumer != null) {
+                        consumer.accept(o);
+                    }
+
+                    o.get().endRecord();
+                }
+            )
+        );
+    }
+
+    @Test
+    public void shouldPrintRecord() {
+        shouldPrintRecord("", "", "", null,
+                "{\"a\":[\"eeny\",\"meeny\"],\"c\":{\"d\":\"moe\"}}\n");
+    }
+
+    @Test
+    public void shouldPrintRecordWithPrefix() {
+        shouldPrintRecord("", "'<%d:%s>'", "", null,
+                "<1:rec1>{\"a\":[\"eeny\",\"meeny\"],\"c\":{\"d\":\"moe\"}}\n");
+    }
+
+    @Test
+    public void shouldPrintRecordWithPrefixAndIdField() {
+        shouldPrintRecord("", "'<%d:%s>', id: 'c.d'", "", null,
+                "<1:moe>{\"a\":[\"eeny\",\"meeny\"],\"c\":{\"d\":\"moe\"}}\n");
+    }
+
+    @Test
+    public void shouldPrintRecordWithHeader() {
+        shouldPrintRecord("", "header: '<%d:%s>'", "", null,
+                "<%d:%s>{\"a\":[\"eeny\",\"meeny\"],\"c\":{\"d\":\"moe\"}}\n");
+    }
+
+    @Test
+    public void shouldPrintRecordWithFooter() {
+        shouldPrintRecord("", "footer: '<%d:%s>'", "", null,
+                "{\"a\":[\"eeny\",\"meeny\"],\"c\":{\"d\":\"moe\"}}<%d:%s>");
+    }
+
+    @Test
+    public void shouldPrintRecordWithPrettyPrinting() {
+        shouldPrintRecord("", "pretty: 'true'", "", null,
+                "{\n" +
+                "  \"a\" : [ \"eeny\", \"meeny\" ],\n" +
+                "  \"c\" : {\n" +
+                "    \"d\" : \"moe\"\n" +
+                "  }\n" +
+                "}\n"
+        );
+    }
+
+    @Test
+    public void shouldPrintRecordAfterTransformation() {
+        shouldPrintRecord("add_field('x', '23')", "", "",
+                o -> o.get().literal("x", "23"),
+                "{\"a\":[\"eeny\",\"meeny\"],\"c\":{\"d\":\"moe\"},\"x\":\"23\"}\n");
+    }
+
+    @Test
+    public void shouldPrintRecordBeforeTransformation() {
+        shouldPrintRecord("", "", "add_field('x', '23')",
+                o -> o.get().literal("x", "23"),
+                "{\"a\":[\"eeny\",\"meeny\"],\"c\":{\"d\":\"moe\"}}\n");
+    }
+
+    @Test
+    public void shouldPrintRecordToFile() throws IOException {
+        MetafixTestHelpers.assertTempFile(
+                "{\"a\":[\"eeny\",\"meeny\"],\"c\":{\"d\":\"moe\"}}\n",
+                p -> shouldPrintRecord("", "destination: '" + p + "'", "", null, ""));
+    }
+
     @Test
     public void hashFromArray() {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(

metafix/src/test/java/org/metafacture/metafix/MetafixTestHelpers.java

@@ -24,7 +24,12 @@
 import org.mockito.Mockito;
 import org.mockito.exceptions.base.MockitoAssertionError;
 
+import java.io.ByteArrayOutputStream;
+import java.io.File;
 import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.PrintStream;
+import java.nio.file.Files;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -76,6 +81,29 @@ private static void assertThrows(final Class<? extends Throwable> exceptionClass
         Assertions.assertEquals(expectedMessage, operator.apply(actualException.getMessage()));
     }
 
+    public static void assertStdout(final String expected, final Runnable runnable) {
+        final ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+        final PrintStream originalStdout = System.out;
+
+        try (PrintStream printStream = new PrintStream(outputStream)) {
+            System.setOut(printStream);
+            runnable.run();
+        }
+        finally {
+            System.setOut(originalStdout);
+        }
+
+        Assertions.assertEquals(expected, outputStream.toString());
+    }
+
+    public static void assertTempFile(final String expected, final Consumer<String> consumer) throws IOException {
+        final File tempFile = File.createTempFile("metafixTestHelpers", "");
+        tempFile.deleteOnExit();
+
+        consumer.accept(tempFile.getPath());
+        Assertions.assertEquals(expected, new String(Files.readAllBytes(tempFile.toPath())));
+    }
+
     public static void assertFix(final StreamReceiver receiver, final List<String> fixDef, final Consumer<Metafix> in,
             final Consumer<Supplier<StreamReceiver>> out) {
         assertFix(receiver, fixDef, in, (s, f) -> out.accept(s), Metafix.NO_VARS);