Skip to content

Commit 6a5f590

Browse files
michael-omichael-o
committed
Prepare for Doxia 2.0.0
1 parent 47c5816 commit 6a5f590

File tree

34 files changed

+444
-196
lines changed

34 files changed

+444
-196
lines changed

‎maven-surefire-report-plugin/pom.xml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
</prerequisites>
4747

4848
<properties>
49-
<doxiaVersion>1.11.1</doxiaVersion>
49+
<doxiaVersion>2.0.0-M8</doxiaVersion>
5050
<aetherVersion>1.0.0.v20140518</aetherVersion>
5151
</properties>
5252

@@ -89,10 +89,12 @@
8989
<dependency>
9090
<groupId>org.apache.maven.reporting</groupId>
9191
<artifactId>maven-reporting-api</artifactId>
92+
<version>4.0.0-M8</version>
9293
</dependency>
9394
<dependency>
9495
<groupId>org.apache.maven.reporting</groupId>
9596
<artifactId>maven-reporting-impl</artifactId>
97+
<version>4.0.0-M11</version>
9698
</dependency>
9799
<dependency>
98100
<groupId>org.codehaus.plexus</groupId>

‎maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/AbstractSurefireReportMojo.java‎ renamed to ‎maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/AbstractSurefireReport.java‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
*
5656
* @author Stephen Connolly
5757
*/
58-
public abstract class AbstractSurefireReportMojo extends AbstractMavenReport {
58+
public abstract class AbstractSurefireReport extends AbstractMavenReport {
5959

6060
/**
6161
* If set to false, only failures are shown.
@@ -77,12 +77,6 @@ public abstract class AbstractSurefireReportMojo extends AbstractMavenReport {
7777
@Parameter
7878
private File reportsDirectory;
7979

80-
/**
81-
* The projects in the reactor for aggregation report.
82-
*/
83-
@Parameter(defaultValue = "${reactorProjects}", readonly = true)
84-
private List<MavenProject> reactorProjects;
85-
8680
/**
8781
* Location of the Xrefs to link.
8882
*/
@@ -155,9 +149,9 @@ public void executeReport(Locale locale) throws MavenReportException {
155149
getI18Nsection(),
156150
locale,
157151
getConsoleLogger(),
158-
showSuccess,
159152
getReportsDirectories(),
160-
determineXrefLocation());
153+
determineXrefLocation(),
154+
showSuccess);
161155
r.render();
162156
}
163157

@@ -262,7 +256,8 @@ private String determineXrefLocation() {
262256
String location = null;
263257

264258
if (linkXRef) {
265-
String relativePath = PathTool.getRelativePath(getOutputDirectory(), xrefLocation.getAbsolutePath());
259+
String relativePath = PathTool.getRelativePath(
260+
getReportOutputDirectory().getAbsolutePath(), xrefLocation.getAbsolutePath());
266261
if (relativePath == null || relativePath.isEmpty()) {
267262
relativePath = ".";
268263
}
@@ -345,6 +340,10 @@ protected MavenProject getProject() {
345340
return project;
346341
}
347342

343+
protected List<MavenProject> getReactorProjects() {
344+
return reactorProjects;
345+
}
346+
348347
// TODO Review, especially Locale.getDefault()
349348
private static class CustomI18N implements I18N {
350349
private final MavenProject project;

‎maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/FailsafeReportMojo.java‎ renamed to ‎maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/FailsafeOnlyReport.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@
3535
*/
3636
@Mojo(name = "failsafe-report-only")
3737
@SuppressWarnings("unused")
38-
public class FailsafeReportMojo extends AbstractSurefireReportMojo {
38+
public class FailsafeOnlyReport extends AbstractSurefireReport {
3939

4040
/**
4141
* The filename to use for the report.
4242
*/
43-
@Parameter(defaultValue = "failsafe-report", property = "outputName", required = true)
43+
@Parameter(defaultValue = "failsafe", property = "outputName", required = true)
4444
private String outputName;
4545

4646
/**
@@ -61,7 +61,7 @@ public class FailsafeReportMojo extends AbstractSurefireReportMojo {
6161
@Override
6262
protected File getSurefireReportsDirectory(MavenProject subProject) {
6363
String buildDir = subProject.getBuild().getDirectory();
64-
return new File(buildDir + "/failsafe-reports");
64+
return new File(buildDir, "failsafe-reports");
6565
}
6666

6767
@Override

‎maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportOnlyMojo.java‎ renamed to ‎maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireOnlyReport.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@
3434
@Mojo(name = "report-only")
3535
@Execute(phase = LifecyclePhase.NONE)
3636
@SuppressWarnings("unused")
37-
public class SurefireReportOnlyMojo extends SurefireReportMojo {}
37+
public class SurefireOnlyReport extends SurefireReport {}

‎maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportMojo.java‎ renamed to ‎maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReport.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@
3434
@Mojo(name = "report", inheritByDefault = false)
3535
@Execute(lifecycle = "surefire", phase = LifecyclePhase.TEST)
3636
@SuppressWarnings("unused")
37-
public class SurefireReportMojo extends AbstractSurefireReportMojo {
37+
public class SurefireReport extends AbstractSurefireReport {
3838

3939
/**
4040
* The filename to use for the report.
4141
*/
42-
@Parameter(defaultValue = "surefire-report", property = "outputName", required = true)
42+
@Parameter(defaultValue = "surefire", property = "outputName", required = true)
4343
private String outputName;
4444

4545
/**

‎maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportRenderer.java‎

Lines changed: 20 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -50,19 +50,19 @@ public class SurefireReportRenderer extends AbstractMavenReportRenderer {
5050
private final Locale locale;
5151

5252
private final SurefireReportParser parser;
53-
private final boolean showSuccess;
54-
private final String xrefLocation;
5553
private final List<ReportTestSuite> testSuites;
54+
private final String xrefLocation;
55+
private final boolean showSuccess;
5656

5757
public SurefireReportRenderer(
5858
Sink sink,
5959
I18N i18n,
6060
String i18nSection,
6161
Locale locale,
6262
ConsoleLogger consoleLogger,
63-
boolean showSuccess,
6463
List<File> reportsDirectories,
65-
String xrefLocation) {
64+
String xrefLocation,
65+
boolean showSuccess) {
6666
super(sink);
6767
this.i18n = i18n;
6868
this.i18nSection = i18nSection;
@@ -112,11 +112,7 @@ private String formatI18nString(String section, String key, Object... args) {
112112
public void renderBody() {
113113
javaScript(javascriptToggleDisplayCode());
114114

115-
sink.section1();
116-
sink.sectionTitle1();
117-
sink.text(getTitle());
118-
sink.sectionTitle1_();
119-
sink.section1_();
115+
startSection(getTitle());
120116

121117
renderSectionSummary();
122118

@@ -125,16 +121,14 @@ public void renderBody() {
125121
renderSectionTestCases();
126122

127123
renderSectionFailureDetails();
124+
125+
endSection();
128126
}
129127

130128
private void renderSectionSummary() {
131129
Map<String, Object> summary = parser.getSummary(testSuites);
132130

133-
sink.section1();
134-
sinkAnchor("Summary");
135-
sink.sectionTitle1();
136-
sink.text(getI18nString("surefire", "label.summary"));
137-
sink.sectionTitle1_();
131+
startSection(getI18nString("surefire", "label.summary"), "Summary");
138132

139133
constructHotLinks();
140134

@@ -168,7 +162,7 @@ private void renderSectionSummary() {
168162

169163
sink.lineBreak();
170164

171-
sink.section1_();
165+
endSection();
172166
}
173167

174168
private void renderSectionPackages() {
@@ -177,11 +171,7 @@ private void renderSectionPackages() {
177171
return;
178172
}
179173

180-
sink.section1();
181-
sinkAnchor("Package_List");
182-
sink.sectionTitle1();
183-
sink.text(getI18nString("surefire", "label.packagelist"));
184-
sink.sectionTitle1_();
174+
startSection(getI18nString("surefire", "label.packagelist"), "Package_List");
185175

186176
constructHotLinks();
187177

@@ -227,11 +217,7 @@ private void renderSectionPackages() {
227217

228218
List<ReportTestSuite> testSuiteList = entry.getValue();
229219

230-
sink.section2();
231-
sinkAnchor(packageName);
232-
sink.sectionTitle2();
233-
sink.text(packageName);
234-
sink.sectionTitle2_();
220+
startSection(packageName);
235221

236222
boolean showTable = false;
237223

@@ -266,12 +252,12 @@ private void renderSectionPackages() {
266252
endTable();
267253
}
268254

269-
sink.section2_();
255+
endSection();
270256
}
271257

272258
sink.lineBreak();
273259

274-
sink.section1_();
260+
endSection();
275261
}
276262

277263
private void renderSectionTestSuite(ReportTestSuite suite) {
@@ -320,23 +306,15 @@ private void renderSectionTestCases() {
320306
return;
321307
}
322308

323-
sink.section1();
324-
sinkAnchor("Test_Cases");
325-
sink.sectionTitle1();
326-
sink.text(getI18nString("surefire", "label.testcases"));
327-
sink.sectionTitle1_();
309+
startSection(getI18nString("surefire", "label.testcases"), "Test_Cases");
328310

329311
constructHotLinks();
330312

331313
for (ReportTestSuite suite : testSuites) {
332314
List<ReportTestCase> testCases = suite.getTestCases();
333315

334316
if (!testCases.isEmpty()) {
335-
sink.section2();
336-
sinkAnchor(suite.getPackageName() + '.' + suite.getName());
337-
sink.sectionTitle2();
338-
sink.text(suite.getName());
339-
sink.sectionTitle2_();
317+
startSection(suite.getName(), suite.getPackageName() + '.' + suite.getName());
340318

341319
boolean showTable = false;
342320

@@ -360,13 +338,13 @@ private void renderSectionTestCases() {
360338
endTable();
361339
}
362340

363-
sink.section2_();
341+
endSection();
364342
}
365343
}
366344

367345
sink.lineBreak();
368346

369-
sink.section1_();
347+
endSection();
370348
}
371349

372350
private void constructTestCaseSection(ReportTestCase testCase) {
@@ -469,7 +447,7 @@ private void constructTestCaseSection(ReportTestCase testCase) {
469447
}
470448

471449
private String toHtmlId(String id) {
472-
return DoxiaUtils.isValidId(id) ? id : DoxiaUtils.encodeId(id, true);
450+
return DoxiaUtils.isValidId(id) ? id : DoxiaUtils.encodeId(id);
473451
}
474452

475453
private void renderSectionFailureDetails() {
@@ -478,11 +456,7 @@ private void renderSectionFailureDetails() {
478456
return;
479457
}
480458

481-
sink.section1();
482-
sinkAnchor("Failure_Details");
483-
sink.sectionTitle1();
484-
sink.text(getI18nString("surefire", "label.failuredetails"));
485-
sink.sectionTitle1_();
459+
startSection(getI18nString("surefire", "label.failuredetails"), "Failure_Details");
486460

487461
constructHotLinks();
488462

@@ -554,7 +528,7 @@ private void renderSectionFailureDetails() {
554528

555529
sink.lineBreak();
556530

557-
sink.section1_();
531+
endSection();
558532
}
559533

560534
private void constructHotLinks() {

‎maven-surefire-report-plugin/src/test/java/org/apache/maven/plugins/surefire/report/JUnit4SuiteTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public static Test suite() {
3434
TestSuite suite = new TestSuite();
3535
suite.addTest(new JUnit4TestAdapter(Surefire597Test.class));
3636
suite.addTest(new JUnit4TestAdapter(SurefireSchemaValidationTest.class));
37-
suite.addTestSuite(SurefireReportMojoTest.class);
37+
suite.addTestSuite(SurefireReportTest.class);
3838
return suite;
3939
}
4040
}

‎maven-surefire-report-plugin/src/test/java/org/apache/maven/plugins/surefire/report/Surefire597Test.java‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ public void testCorruptedTestCaseFailureWithMissingErrorTypeAndMessage() throws
4848
i18n.initialize();
4949
ConsoleLogger consoleLogger = new NullConsoleLogger();
5050
SurefireReportRenderer r = new SurefireReportRenderer(
51-
sink, i18n, "surefire", SiteTool.DEFAULT_LOCALE, consoleLogger, true, singletonList(report), null);
51+
sink, i18n, "surefire", SiteTool.DEFAULT_LOCALE, consoleLogger, singletonList(report), null, true);
5252
r.render();
5353
String xml = writer.toString();
5454
assertThat(
5555
xml,
56-
containsString(toSystemNewLine("<table border=\"0\" class=\"bodyTable\">\n"
56+
containsString(toSystemNewLine("<table class=\"bodyTable\">\n"
5757
+ "<tr class=\"a\">\n"
5858
+ "<th>Tests</th>\n"
5959
+ "<th>Errors</th>\n"
@@ -62,7 +62,7 @@ public void testCorruptedTestCaseFailureWithMissingErrorTypeAndMessage() throws
6262
+ "<th>Success Rate</th>\n"
6363
+ "<th>Time</th></tr>\n"
6464
+ "<tr class=\"b\">\n"
65-
+ "<td align=\"left\">1</td>\n"
65+
+ "<td>1</td>\n"
6666
+ "<td>1</td>\n"
6767
+ "<td>0</td>\n"
6868
+ "<td>0</td>\n"
@@ -72,7 +72,7 @@ public void testCorruptedTestCaseFailureWithMissingErrorTypeAndMessage() throws
7272
+ "</table>")));
7373
assertThat(
7474
xml,
75-
containsString(toSystemNewLine("<table border=\"0\" class=\"bodyTable\">\n"
75+
containsString(toSystemNewLine("<table class=\"bodyTable\">\n"
7676
+ "<tr class=\"a\">\n"
7777
+ "<th>Package</th>\n"
7878
+ "<th>Tests</th>\n"
@@ -82,7 +82,7 @@ public void testCorruptedTestCaseFailureWithMissingErrorTypeAndMessage() throws
8282
+ "<th>Success Rate</th>\n"
8383
+ "<th>Time</th></tr>\n"
8484
+ "<tr class=\"b\">\n"
85-
+ "<td align=\"left\"><a href=\"#surefire\">surefire</a></td>\n"
85+
+ "<td><a href=\"#surefire\">surefire</a></td>\n"
8686
+ "<td>1</td>\n"
8787
+ "<td>1</td>\n"
8888
+ "<td>0</td>\n"
@@ -91,7 +91,7 @@ public void testCorruptedTestCaseFailureWithMissingErrorTypeAndMessage() throws
9191
+ "<td>0 s</td></tr></table>")));
9292
assertThat(
9393
xml,
94-
containsString(toSystemNewLine("<table border=\"0\" class=\"bodyTable\">\n"
94+
containsString(toSystemNewLine("<table class=\"bodyTable\">\n"
9595
+ "<tr class=\"a\">\n"
9696
+ "<th>-</th>\n"
9797
+ "<th>Class</th>\n"
@@ -102,7 +102,7 @@ public void testCorruptedTestCaseFailureWithMissingErrorTypeAndMessage() throws
102102
+ "<th>Success Rate</th>\n"
103103
+ "<th>Time</th></tr>\n"
104104
+ "<tr class=\"b\">\n"
105-
+ "<td align=\"left\"><a href=\"#surefire.MyTest\"><img src=\"images/icon_error_sml.gif\" alt=\"\" /></a></td>\n"
105+
+ "<td><a href=\"#surefire.MyTest\"><img src=\"images/icon_error_sml.gif\" /></a></td>\n"
106106
+ "<td><a href=\"#surefire.MyTest\">MyTest</a></td>\n"
107107
+ "<td>1</td>\n"
108108
+ "<td>1</td>\n"
@@ -112,15 +112,15 @@ public void testCorruptedTestCaseFailureWithMissingErrorTypeAndMessage() throws
112112
+ "<td>0 s</td></tr></table>")));
113113
assertThat(
114114
xml,
115-
containsString(toSystemNewLine("<table border=\"0\" class=\"bodyTable\">\n"
115+
containsString(toSystemNewLine("<table class=\"bodyTable\">\n"
116116
+ "<tr class=\"a\">\n"
117-
+ "<td align=\"left\"><img src=\"images/icon_error_sml.gif\" alt=\"\" /></td>\n"
117+
+ "<td><img src=\"images/icon_error_sml.gif\" /></td>\n"
118118
+ "<td><a id=\"surefire.MyTest.test\"></a>test</td></tr>\n"
119119
+ "<tr class=\"b\">\n"
120-
+ "<td align=\"left\">-</td>\n"
120+
+ "<td>-</td>\n"
121121
+ "<td>java.lang.RuntimeException: java.lang.IndexOutOfBoundsException: msg</td></tr>\n"
122122
+ "<tr class=\"a\">\n"
123-
+ "<td align=\"left\">-</td>\n"
123+
+ "<td>-</td>\n"
124124
+ "<td>\n"
125125
+ "<div id=\"test-error\">surefire.MyTest:13</div></td></tr></table>")));
126126
}

0 commit comments

Comments
 (0)