[MSITE-998] MavenReport#setReportOutputDirectory(File) is called too …

…late
apache · Dec 14, 2023 · a3fe002 · a3fe002
1 parent 5488257
commit a3fe002
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 27 deletions.
diff --git a/src/it/projects/site-sd-lang/pom.xml b/src/it/projects/site-sd-lang/pom.xml
@@ -71,6 +71,43 @@ under the License.
           </reportSet>
         </reportSets>
       </plugin>
+      <plugin>
+        <artifactId>maven-pmd-plugin</artifactId>
+        <version>@pmdPluginVersion@</version>
+        <reportSets>
+          <reportSet>
+            <reports>
+              <report>pmd</report>
+              <report>cpd</report>
+            </reports>
+          </reportSet>
+        </reportSets>
+        <configuration>
+          <includeXmlInSite>true</includeXmlInSite>
+        </configuration>
+      </plugin>
+      <plugin>
+        <artifactId>maven-jxr-plugin</artifactId>
+        <version>@jxrPluginVersion@</version>
+        <reportSets>
+          <reportSet>
+            <reports>
+              <report>jxr-no-fork</report>
+            </reports>
+          </reportSet>
+        </reportSets>
+      </plugin>
+      <plugin>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>@javadocPluginVersion@</version>
+        <reportSets>
+          <reportSet>
+            <reports>
+              <report>javadoc-no-fork</report>
+            </reports>
+          </reportSet>
+        </reportSets>
+      </plugin>
     </plugins>
   </reporting>
 

diff --git a/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java b/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
@@ -213,7 +213,7 @@ protected void checkInputEncoding() {
         }
     }
 
-    protected List<MavenReportExecution> getReports() throws MojoExecutionException {
+    protected List<MavenReportExecution> getReports(File outputDirectory) throws MojoExecutionException {
         MavenReportExecutorRequest mavenReportExecutorRequest = new MavenReportExecutorRequest();
         mavenReportExecutorRequest.setMavenSession(mavenSession);
         mavenReportExecutorRequest.setExecutionId(mojoExecution.getExecutionId());
@@ -226,6 +226,7 @@ protected List<MavenReportExecution> getReports() throws MojoExecutionException
         List<MavenReportExecution> reportExecutions = new ArrayList<>(allReports.size());
         for (MavenReportExecution exec : allReports) {
             String reportMojoInfo = exec.getPlugin().getId() + ":" + exec.getGoal();
+            exec.getMavenReport().setReportOutputDirectory(outputDirectory);
             try {
                 if (exec.canGenerateReport()) {
                     reportExecutions.add(exec);

diff --git a/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java b/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
@@ -39,7 +39,6 @@
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.plugins.annotations.ResolutionScope;
 import org.apache.maven.project.MavenProject;
-import org.apache.maven.reporting.MavenReport;
 import org.apache.maven.reporting.MavenReportException;
 import org.apache.maven.reporting.exec.MavenReportExecution;
 import org.apache.maven.shared.utils.logging.MessageBuilder;
@@ -95,13 +94,6 @@ public void execute() throws MojoExecutionException, MojoFailureException {
 
         checkInputEncoding();
 
-        List<MavenReportExecution> reports;
-        if (generateReports) {
-            reports = getReports();
-        } else {
-            reports = Collections.emptyList();
-        }
-
         try {
             List<Locale> localesList = getLocales();
 
@@ -112,7 +104,10 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                                                 ? "locale '" + locale + "'"
                                                 : "default locale"))
                                 .toString());
-                renderLocale(locale, reports, localesList);
+                File outputDirectory = getOutputDirectory(locale);
+                List<MavenReportExecution> reports =
+                        generateReports ? getReports(outputDirectory) : Collections.emptyList();
+                renderLocale(locale, reports, localesList, outputDirectory);
             }
         } catch (RendererException e) {
             if (e.getCause() instanceof MavenReportException) {
@@ -125,7 +120,8 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         }
     }
 
-    private void renderLocale(Locale locale, List<MavenReportExecution> reports, List<Locale> supportedLocales)
+    private void renderLocale(
+            Locale locale, List<MavenReportExecution> reports, List<Locale> supportedLocales, File outputDirectory)
             throws IOException, RendererException, MojoFailureException, MojoExecutionException {
         SiteRenderingContext context = createSiteRenderingContext(locale);
         context.addSiteLocales(supportedLocales);
@@ -142,8 +138,6 @@ private void renderLocale(Locale locale, List<MavenReportExecution> reports, Lis
             getLog().info("Validation is switched on, xml input documents will be validated!");
         }
 
-        File outputDirectory = getOutputDirectory(locale);
-
         Map<String, DocumentRenderer> documents = locateDocuments(context, reports, locale);
 
         // copy resources
@@ -152,12 +146,6 @@ private void renderLocale(Locale locale, List<MavenReportExecution> reports, Lis
         // 1. render Doxia documents first
         List<DocumentRenderer> nonDoxiaDocuments = renderDoxiaDocuments(documents, context, outputDirectory, false);
 
-        // prepare external reports
-        for (MavenReportExecution mavenReportExecution : reports) {
-            MavenReport report = mavenReportExecution.getMavenReport();
-            report.setReportOutputDirectory(outputDirectory);
-        }
-
         // 2. then non-Doxia documents (e.g., reports)
         renderNonDoxiaDocuments(nonDoxiaDocuments, context, outputDirectory);
 
@@ -185,7 +173,10 @@ private void renderLocale(Locale locale, List<MavenReportExecution> reports, Lis
      * @return the sublist of documents that are not Doxia source files
      */
     private List<DocumentRenderer> renderDoxiaDocuments(
-            Map<String, DocumentRenderer> documents, SiteRenderingContext context, File outputDirectory, boolean generated)
+            Map<String, DocumentRenderer> documents,
+            SiteRenderingContext context,
+            File outputDirectory,
+            boolean generated)
             throws RendererException, IOException {
         Map<String, DocumentRenderer> doxiaDocuments = new TreeMap<>();
         List<DocumentRenderer> nonDoxiaDocuments = new ArrayList<>();
@@ -244,7 +235,8 @@ private List<DocumentRenderer> renderDoxiaDocuments(
      *
      * @param documents a collection of documents containing non-Doxia source files
      */
-    private void renderNonDoxiaDocuments(List<DocumentRenderer> documents, SiteRenderingContext context, File outputDirectory)
+    private void renderNonDoxiaDocuments(
+            List<DocumentRenderer> documents, SiteRenderingContext context, File outputDirectory)
             throws RendererException, IOException {
         Map<String, Integer> counts = new TreeMap<>();
 

diff --git a/src/main/java/org/apache/maven/plugins/site/run/SiteRunMojo.java b/src/main/java/org/apache/maven/plugins/site/run/SiteRunMojo.java
@@ -121,12 +121,6 @@ private WebAppContext createWebApplication() throws MojoExecutionException {
 
         // For external reports
         project.getReporting().setOutputDirectory(tempWebappDirectory.getAbsolutePath());
-        for (MavenReportExecution mavenReportExecution : getReports()) {
-            mavenReportExecution.getMavenReport().setReportOutputDirectory(tempWebappDirectory);
-        }
-
-        List<MavenReportExecution> reports =
-                getReports(); // TODO: is it sane to call getReports() method a second time?
 
         List<Locale> localesList = getLocales();
         webapp.setAttribute(DoxiaFilter.LOCALES_LIST_KEY, localesList);
@@ -144,6 +138,9 @@ private WebAppContext createWebApplication() throws MojoExecutionException {
                 i18nGeneratedSiteContext.setOutputEncoding(getOutputEncoding());
                 i18nGeneratedSiteContext.getSiteDirectories().clear();
 
+                File outputDirectory = getOutputDirectory(locale);
+                List<MavenReportExecution> reports = getReports(outputDirectory);
+
                 Map<String, DocumentRenderer> i18nDocuments = locateDocuments(i18nContext, reports, locale);
                 if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
                     i18nGeneratedSiteContext.addSiteDirectory(new File(generatedSiteDirectory, locale.toString()));
@@ -172,6 +169,22 @@ private WebAppContext createWebApplication() throws MojoExecutionException {
         return webapp;
     }
 
+    private File getOutputDirectory(Locale locale) {
+        File file;
+        if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
+            file = new File(tempWebappDirectory, locale.toString());
+        } else {
+            file = tempWebappDirectory;
+        }
+
+        // Safety
+        if (!file.exists()) {
+            file.mkdirs();
+        }
+
+        return file;
+    }
+
     public void setTempWebappDirectory(File tempWebappDirectory) {
         this.tempWebappDirectory = tempWebappDirectory;
     }