Polish ReportEntry and simplify XmlReportWriter

Issue: #293

junit-console/src/main/java/org/junit/gen5/console/tasks/XmlReportWriter.java

@@ -18,15 +18,13 @@
 import static org.junit.gen5.console.tasks.XmlReportData.isFailure;
 import static org.junit.gen5.engine.TestExecutionResult.Status.FAILED;
 
-import java.io.IOException;
 import java.io.Writer;
 import java.net.InetAddress;
 import java.net.UnknownHostException;
 import java.text.NumberFormat;
 import java.time.LocalDateTime;
 import java.util.List;
 import java.util.Locale;
-import java.util.Map;
 import java.util.Optional;
 import java.util.Properties;
 import java.util.TreeSet;
@@ -35,8 +33,6 @@
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
 
-import org.junit.gen5.commons.util.ExceptionUtils;
-import org.junit.gen5.commons.util.Preconditions;
 import org.junit.gen5.engine.TestExecutionResult;
 import org.junit.gen5.engine.reporting.ReportEntry;
 import org.junit.gen5.engine.support.descriptor.JavaClassSource;
@@ -190,39 +186,26 @@ private void writeFailureAttributesAndContent(Throwable throwable, XMLStreamWrit
 		writer.writeCharacters(readStackTrace(throwable));
 	}
 
-	private void writeReportEntriesToSystemOutElement(TestIdentifier test, XMLStreamWriter writer)
+	private void writeReportEntriesToSystemOutElement(TestIdentifier testIdentifier, XMLStreamWriter writer)
 			throws XMLStreamException {
-		List<ReportEntry> entries = reportData.getReportEntries(test);
+		List<ReportEntry> entries = reportData.getReportEntries(testIdentifier);
 		if (!entries.isEmpty()) {
 			writer.writeStartElement("system-out");
 			for (int i = 0; i < entries.size(); i++) {
-				ReportEntry reportEntry = entries.get(i);
-				StringBuilder stringBuilder = new StringBuilder();
-				this.appendDescriptionOfReportEntry(stringBuilder, reportEntry, "#" + (i + 1));
-				writer.writeCharacters(stringBuilder.toString());
+				writer.writeCharacters(buildReportEntryDescription(entries.get(i), i + 1));
 			}
 			writer.writeEndElement();
 		}
 	}
 
-	private void appendDescriptionOfReportEntry(Appendable appendable, ReportEntry reportEntry, String entryTitle) {
-		Preconditions.notNull(appendable, "appendable must not be null");
-		Preconditions.notNull(entryTitle, "entryTitle must not be null");
+	private String buildReportEntryDescription(ReportEntry reportEntry, int entryNumber) {
+		StringBuilder builder = new StringBuilder((format("Report Entry #{0} (timestamp: {1})\n", entryNumber,
+			ISO_LOCAL_DATE_TIME.format(reportEntry.getTimestamp()))));
 
-		// Add left padding
-		entryTitle = (entryTitle.length() > 0 ? " " + entryTitle : entryTitle);
+		reportEntry.getKeyValuePairs().entrySet().forEach(
+			entry -> builder.append(format("\t- {0}: {1}\n", entry.getKey(), entry.getValue())));
 
-		try {
-			appendable.append(format("Report Entry{0} (creation timestamp: {1})\n", entryTitle,
-				ISO_LOCAL_DATE_TIME.format(reportEntry.getCreationTimestamp())));
-
-			for (Map.Entry<String, String> entry : reportEntry.getKeyValuePairs().entrySet()) {
-				appendable.append(format("\t- {0}: {1}\n", entry.getKey(), entry.getValue()));
-			}
-		}
-		catch (IOException cannotHappen) {
-			ExceptionUtils.throwAsUncheckedException(cannotHappen);
-		}
+		return builder.toString();
 	}
 
 	private String getTime(TestIdentifier testIdentifier, NumberFormat numberFormat) {

junit-engine-api/src/main/java/org/junit/gen5/engine/reporting/ReportEntry.java

@@ -32,7 +32,7 @@
 @API(Experimental)
 public final class ReportEntry {
 
-	private final LocalDateTime creationTimestamp = LocalDateTime.now();
+	private final LocalDateTime timestamp = LocalDateTime.now();
 	private final Map<String, String> keyValuePairs = new LinkedHashMap<>();
 
 	/**
@@ -79,20 +79,20 @@ public final Map<String, String> getKeyValuePairs() {
 	}
 
 	/**
-	 * Get the creation timestamp of this {@code ReportEntry}.
+	 * Get the timestamp for when this {@code ReportEntry} was created.
 	 *
 	 * <p>Can be used, for example, to order entries.
 	 *
 	 * @return when this entry was created; never {@code null}
 	 */
-	public final LocalDateTime getCreationTimestamp() {
-		return this.creationTimestamp;
+	public final LocalDateTime getTimestamp() {
+		return this.timestamp;
 	}
 
 	@Override
 	public String toString() {
 		ToStringBuilder builder = new ToStringBuilder(this);
-		builder.append("creationTimestamp", this.creationTimestamp);
+		builder.append("timestamp", this.timestamp);
 		this.keyValuePairs.forEach(builder::append);
 		return builder.toString();
 	}

junit-tests/src/test/java/org/junit/gen5/console/tasks/ColoredPrintingTestListenerTests.java

@@ -56,7 +56,7 @@ public void reportingEntryPublishedMessageIndented() {
 
 		assertEquals(2, split.length);
 		assertAll("lines in the message", () -> assertEquals("Reported:    failingTest [[engine:junit]]", split[0]),
-			() -> assertTrue(split[1].startsWith(INDENTATION + "=> Reported values: ReportEntry [creationTimestamp =")),
+			() -> assertTrue(split[1].startsWith(INDENTATION + "=> Reported values: ReportEntry [timestamp =")),
 			() -> assertTrue(split[1].endsWith(", foo = 'bar']")));
 	}
 

junit-tests/src/test/java/org/junit/gen5/console/tasks/XmlReportWriterTests.java

@@ -73,7 +73,7 @@ void writesReportEntry() throws Exception {
 		//@formatter:off
 		assertThat(content)
 			.containsSequence(
-				"<system-out>Report Entry #1 (creation timestamp: ",
+				"<system-out>Report Entry #1 (timestamp: ",
 				"- myKey: myValue",
 				"</system-out>");
 		//@formatter:on

junit-tests/src/test/java/org/junit/gen5/console/tasks/XmlReportsWritingListenerTests.java

@@ -375,9 +375,9 @@ void writesReportEntriesToSystemOutElement(@Root Path tempDirectory, TestReporte
 				"<testsuite",
 				"<testcase",
 				"<system-out>",
-				"Report Entry #1 (creation timestamp: " + Year.now(),
+				"Report Entry #1 (timestamp: " + Year.now(),
 				"- foo: bar\n",
-				"Report Entry #2 (creation timestamp: " + Year.now(),
+				"Report Entry #2 (timestamp: " + Year.now(),
 				"- bar: baz\n",
 				"- qux: foo\n",
 				"</system-out>",