1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 package org.apache.maven.plugin.failsafe.util;
20
21 import javax.xml.xpath.XPath;
22 import javax.xml.xpath.XPathExpressionException;
23 import javax.xml.xpath.XPathFactory;
24
25 import java.io.File;
26 import java.io.FileInputStream;
27 import java.io.IOException;
28 import java.io.InputStreamReader;
29 import java.io.Reader;
30 import java.nio.file.Files;
31 import java.nio.file.StandardOpenOption;
32 import java.util.Locale;
33
34 import org.apache.maven.surefire.api.suite.RunResult;
35 import org.w3c.dom.Node;
36 import org.xml.sax.InputSource;
37
38 import static java.lang.Boolean.parseBoolean;
39 import static java.lang.Integer.parseInt;
40 import static java.lang.String.format;
41 import static java.nio.charset.StandardCharsets.UTF_8;
42 import static javax.xml.xpath.XPathConstants.NODE;
43 import static org.apache.maven.surefire.shared.lang3.StringEscapeUtils.escapeXml10;
44 import static org.apache.maven.surefire.shared.lang3.StringEscapeUtils.unescapeXml;
45 import static org.apache.maven.surefire.shared.utils.StringUtils.isBlank;
46
47
48
49
50
51 public final class FailsafeSummaryXmlUtils {
52 private static final String FAILSAFE_SUMMARY_XML_SCHEMA_LOCATION =
53 "https://maven.apache.org/surefire/maven-surefire-plugin/xsd/failsafe-summary.xsd";
54
55 private static final String MESSAGE_NIL_ELEMENT =
56 "<failureMessage xsi:nil=\"true\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>";
57
58 private static final String MESSAGE_ELEMENT = "<failureMessage>%s</failureMessage>";
59
60 private static final String FAILSAFE_SUMMARY_XML_TEMPLATE = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
61 + "<failsafe-summary xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""
62 + " xsi:noNamespaceSchemaLocation=\"" + FAILSAFE_SUMMARY_XML_SCHEMA_LOCATION + "\""
63 + " result=\"%s\" timeout=\"%s\">\n"
64 + " <completed>%d</completed>\n"
65 + " <errors>%d</errors>\n"
66 + " <failures>%d</failures>\n"
67 + " <skipped>%d</skipped>\n"
68 + " <flakes>%d</flakes>\n"
69 + " %s\n"
70 + "</failsafe-summary>";
71
72 private FailsafeSummaryXmlUtils() {
73 throw new IllegalStateException("No instantiable constructor.");
74 }
75
76 public static RunResult toRunResult(File failsafeSummaryXml) throws IOException {
77 XPathFactory xpathFactory = XPathFactory.newInstance();
78 XPath xpath = xpathFactory.newXPath();
79
80 try (Reader reader = new InputStreamReader(new FileInputStream(failsafeSummaryXml), UTF_8)) {
81 Node root = (Node) xpath.evaluate("/", new InputSource(reader), NODE);
82
83 String completed = xpath.evaluate("/failsafe-summary/completed", root);
84 String errors = xpath.evaluate("/failsafe-summary/errors", root);
85 String failures = xpath.evaluate("/failsafe-summary/failures", root);
86 String skipped = xpath.evaluate("/failsafe-summary/skipped", root);
87 String failureMessage = xpath.evaluate("/failsafe-summary/failureMessage", root);
88 String timeout = xpath.evaluate("/failsafe-summary/@timeout", root);
89 String flakes = xpath.evaluate("/failsafe-summary/flakes", root);
90
91 return new RunResult(
92 parseInt(completed),
93 parseInt(errors),
94 parseInt(failures),
95 parseInt(skipped),
96
97
98 isBlank(flakes) ? 0 : parseInt(flakes),
99 isBlank(failureMessage) ? null : unescapeXml(failureMessage),
100 parseBoolean(timeout));
101 } catch (XPathExpressionException | NumberFormatException e) {
102 throw new IOException("Could not parse " + failsafeSummaryXml.getPath(), e);
103 }
104 }
105
106 public static void fromRunResultToFile(RunResult fromRunResult, File toFailsafeSummaryXml) throws IOException {
107 String failure = fromRunResult.getFailure();
108 String msg = isBlank(failure) ? MESSAGE_NIL_ELEMENT : format(MESSAGE_ELEMENT, escapeXml10(failure));
109 String xml = format(
110 Locale.ROOT,
111 FAILSAFE_SUMMARY_XML_TEMPLATE,
112 fromRunResult.getFailsafeCode(),
113 fromRunResult.isTimeout(),
114 fromRunResult.getCompletedCount(),
115 fromRunResult.getErrors(),
116 fromRunResult.getFailures(),
117 fromRunResult.getSkipped(),
118 fromRunResult.getFlakes(),
119 msg);
120
121 Files.write(
122 toFailsafeSummaryXml.toPath(),
123 xml.getBytes(UTF_8),
124 StandardOpenOption.CREATE,
125 StandardOpenOption.TRUNCATE_EXISTING,
126 StandardOpenOption.WRITE);
127 }
128
129 public static void writeSummary(RunResult mergedSummary, File mergedSummaryFile, boolean inProgress)
130 throws Exception {
131 if (!mergedSummaryFile.getParentFile().isDirectory()) {
132
133 mergedSummaryFile.getParentFile().mkdirs();
134 }
135
136 if (mergedSummaryFile.exists() && inProgress) {
137 RunResult runResult = toRunResult(mergedSummaryFile);
138 mergedSummary = mergedSummary.aggregate(runResult);
139 }
140
141 fromRunResultToFile(mergedSummary, mergedSummaryFile);
142 }
143 }