RatReportMojo.java
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.rat.mp;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkFactory;
import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;
import org.apache.maven.doxia.site.SiteModel;
import org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
import org.apache.maven.doxia.siterenderer.Renderer;
import org.apache.maven.doxia.siterenderer.RendererException;
import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
import org.apache.maven.doxia.tools.SiteTool;
import org.apache.maven.doxia.tools.SiteToolException;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.reporting.MavenMultiPageReport;
import org.apache.maven.reporting.MavenReportException;
import org.apache.rat.ReportConfiguration;
import org.apache.rat.Reporter;
import org.apache.rat.VersionInfo;
import org.apache.rat.api.RatException;
import org.apache.rat.license.LicenseSetFactory.LicenseFilter;
import org.apache.rat.utils.DefaultLog;
import org.codehaus.plexus.util.ReaderFactory;
import org.eclipse.aether.repository.ArtifactRepository;
import org.eclipse.aether.repository.RemoteRepository;
import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;
/**
* Generates a report with RAT's output.
*/
@Mojo(name = "rat", requiresDependencyResolution = ResolutionScope.TEST, threadSafe = true)
public class RatReportMojo extends AbstractRatMojo implements MavenMultiPageReport {
/**
* The output directory for the report. Note that this parameter is only
* evaluated if the goal is run directly from the command line. If the goal is
* run indirectly as part of a site generation, the output directory configured
* in the Maven Site Plugin is used instead.
*/
@Parameter(defaultValue = "${project.reporting.outputDirectory}", readonly = true, required = true)
protected File outputDirectory;
/**
* Specifies the input encoding.
*/
@Parameter(property = "encoding", defaultValue = "${project.build.sourceEncoding}", readonly = true)
private String inputEncoding;
/**
* Specifies the output encoding.
*/
@Parameter(property = "outputEncoding", defaultValue = "${project.reporting.outputEncoding}", readonly = true)
private String outputEncoding;
/**
* The local repository.
*/
@Parameter(defaultValue = "${session}", readonly = true, required = true)
protected MavenSession session;
/**
* Remote repositories used for the project.
*
* @deprecated replaced by {@link #remoteRepositories}
*/
@Parameter(defaultValue = "${project.remoteArtifactRepositories}", readonly = true, required = true)
@Deprecated
protected List<ArtifactRepository> remoteArtifactRepositories;
/**
* Remote repositories used for the project.
*/
@Parameter(defaultValue = "${project.remoteProjectRepositories}", readonly = true, required = true)
protected List<RemoteRepository> remoteRepositories;
/**
* SiteTool.
*/
@Component
protected SiteTool siteTool;
/**
* Doxia Site Renderer component.
*/
@Component
protected Renderer siteRenderer;
/**
* The current sink to use
*/
private Sink sink;
/**
* The sink factory to use
*/
private SinkFactory sinkFactory;
/**
* The current report output directory to use
*/
private File reportOutputDirectory;
/**
* This method is called when the report generation is invoked directly as a
* standalone Mojo.
*
* @throws MojoExecutionException if an error occurs when generating the report
* @see org.apache.maven.plugin.Mojo#execute()
*/
@Override
public void execute() throws MojoExecutionException {
if (!canGenerateReport()) {
return;
}
File outputDirectory = new File(getOutputDirectory());
String filename = getOutputName() + ".html";
Locale locale = Locale.getDefault();
try {
SiteRenderingContext siteContext = createSiteRenderingContext(locale);
// copy resources
getSiteRenderer().copyResources(siteContext, outputDirectory);
// TODO Replace null with real value
DocumentRenderingContext docContext =
new DocumentRenderingContext(outputDirectory, filename, "xhtml5");
SiteRendererSink sink = new SiteRendererSink(docContext);
generate(sink, null, locale);
// MSHARED-204: only render Doxia sink if not an external report
if (!isExternalReport()) {
if (!outputDirectory.exists() && !outputDirectory.mkdirs()) {
getLog().error("Unable to create output directory: " + outputDirectory);
}
try (Writer writer = new OutputStreamWriter(
Files.newOutputStream(new File(outputDirectory, filename).toPath()),
getOutputEncoding())) {
// render report
getSiteRenderer().mergeDocumentIntoSite(writer, sink, siteContext);
}
}
// copy generated resources also
getSiteRenderer().copyResources(siteContext, outputDirectory);
} catch (RendererException | IOException | MavenReportException e) {
throw new MojoExecutionException(
"An error has occurred in " + getName(Locale.ENGLISH) + " report generation.", e);
}
}
private SiteRenderingContext createSiteRenderingContext(final Locale locale)
throws MavenReportException, IOException {
SiteModel siteModel = new SiteModel();
Map<String, Object> templateProperties = new HashMap<>();
templateProperties.put("standalone", Boolean.TRUE);
templateProperties.put("project", getProject());
templateProperties.put("inputEncoding", getInputEncoding());
templateProperties.put("outputEncoding", getOutputEncoding());
for (Map.Entry<Object, Object> entry : getProject().getProperties().entrySet()) {
templateProperties.put((String) entry.getKey(), entry.getValue());
}
org.apache.maven.doxia.site.Skin siteSkin = siteModel.getSkin();
if (siteSkin == null || siteSkin.getGroupId() == null
|| siteSkin.getArtifactId() == null || siteSkin.getVersion() == null) {
getLog().debug("No skin configuration found in site.xml. Using default Maven skin configuration.");
// Create a minimal default skin configuration
siteSkin = new org.apache.maven.doxia.site.Skin();
siteSkin.setGroupId("org.apache.maven.skins");
siteSkin.setArtifactId("maven-fluido-skin");
}
try {
Artifact skinArtifact = siteTool.getSkinArtifactFromRepository(
session.getRepositorySession(),
remoteRepositories,
siteSkin
);
getLog().debug(buffer().a("Rendering content with ").strong(skinArtifact.getId() + " skin").a('.').build());
SiteRenderingContext context = siteRenderer.createContextForSkin(
skinArtifact,
templateProperties,
siteModel,
project.getName(),
locale
);
context.setRootDirectory(project.getBasedir());
return context;
} catch (SiteToolException e) {
throw new MavenReportException("Failed to retrieve skin artifact", e);
} catch (RendererException e) {
throw new MavenReportException("Failed to create context for skin", e);
}
}
/**
* This method is called when the report generation is invoked by
* maven-site-plugin.
*
* @param sink the sink to use for the generation.
* @param sinkFactory the sink factory to use for the generation.
* @param locale the wanted locale to generate the report, could be null.
* @throws MavenReportException if any
*/
@Override
public void generate(final Sink sink, final SinkFactory sinkFactory, final Locale locale) throws MavenReportException {
if (!canGenerateReport()) {
// This report cannot be generated as part of the current build.
getLog().info("This report cannot be generated as part of the current build. "
+ "The report name should be referenced in this line of output.");
} else {
this.sink = sink;
this.sinkFactory = sinkFactory;
if (!(sink instanceof SiteRendererSink)) {
generateReportManually(locale);
} else {
executeReport(locale);
}
closeReport();
}
}
private void generateReportManually(final Locale locale) throws MavenReportException {
try {
File outputDir = new File(getOutputDirectory());
String filename = getOutputName() + ".html";
SiteRenderingContext siteContext = createSiteRenderingContext(locale);
if (!outputDir.exists() && !outputDir.mkdirs()) {
getLog().error("Unable to create output directory: " + outputDir);
}
DocumentRenderingContext docContext =
new DocumentRenderingContext(outputDir, filename, "xhtml5");
SiteRendererSink sink = new SiteRendererSink(docContext);
this.sink = sink;
this.sinkFactory = null;
executeReport(locale);
try (Writer writer = new OutputStreamWriter(
Files.newOutputStream(new File(outputDir, filename).toPath()),
getOutputEncoding())) {
getSiteRenderer().mergeDocumentIntoSite(writer, sink, siteContext);
}
} catch (IOException | RendererException e) {
throw new MavenReportException("Failed to render RAT report manually", e);
}
}
/**
* Generate a report.
*
* @param sink the sink to use for the generation.
* @param locale the wanted locale to generate the report, could be null.
* @throws MavenReportException if any
* @deprecated use {@link #generate(Sink, SinkFactory, Locale)} instead.
*/
@Deprecated
public void generate(final Sink sink, final Locale locale) throws MavenReportException {
generate(sink, null, locale);
}
/**
* @return CATEGORY_PROJECT_REPORTS
*/
@Override
public String getCategoryName() {
return CATEGORY_PROJECT_REPORTS;
}
@Override
public File getReportOutputDirectory() {
if (reportOutputDirectory == null) {
reportOutputDirectory = new File(getOutputDirectory());
}
return reportOutputDirectory;
}
@Override
public void setReportOutputDirectory(final File reportOutputDirectory) {
this.reportOutputDirectory = reportOutputDirectory;
this.outputDirectory = reportOutputDirectory;
}
protected String getOutputDirectory() {
return outputDirectory.getAbsolutePath();
}
protected Renderer getSiteRenderer() {
return siteRenderer;
}
/**
* Gets the input files encoding.
*
* @return The input files encoding, never <code>null</code>.
*/
protected String getInputEncoding() {
return (inputEncoding == null) ? ReaderFactory.FILE_ENCODING : inputEncoding;
}
/**
* Gets the effective reporting output files encoding.
*
* @return The effective reporting output file encoding, never
* <code>null</code>.
*/
protected String getOutputEncoding() {
return (outputEncoding == null) ? StandardCharsets.UTF_8.toString() : outputEncoding;
}
/**
* Actions when closing the report.
*/
protected void closeReport() {
getSink().close();
}
/**
* @return the sink used
*/
public Sink getSink() {
return sink;
}
/**
* @return the sink factory used
*/
public SinkFactory getSinkFactory() {
return sinkFactory;
}
/**
* @return {@code false} by default.
* @see org.apache.maven.reporting.MavenReport#isExternalReport()
*/
@Override
public boolean isExternalReport() {
return false;
}
@Override
public boolean canGenerateReport() {
return !skip;
}
/**
* Writes the report to the Doxia sink.
*
* @param locale The locale to use for writing the report.
* @throws MavenReportException Writing the report failed.
*/
protected void executeReport(final Locale locale) throws MavenReportException {
ResourceBundle bundle = getBundle(locale);
final String title = bundle.getString("report.rat.title");
sink.head();
sink.title();
sink.text(title);
sink.title_();
sink.head_();
sink.body();
sink.section1();
sink.sectionTitle1();
sink.text(title);
sink.sectionTitle1_();
sink.paragraph();
sink.text(bundle.getString("report.rat.link") + " ");
sink.link(bundle.getString("report.rat.url"));
sink.text(bundle.getString("report.rat.fullName"));
sink.link_();
sink.text(" " + new VersionInfo(RatReportMojo.class));
sink.text(".");
sink.paragraph_();
sink.paragraph();
sink.verbatim(new SinkEventAttributeSet());
try (Writer logWriter = DefaultLog.getInstance().asWriter()) {
try {
ReportConfiguration config = getConfiguration();
config.setFrom(getDefaultsBuilder().build());
logLicenses(config.getLicenses(LicenseFilter.ALL));
if (verbose) {
config.reportExclusions(logWriter);
}
ByteArrayOutputStream baos = new ByteArrayOutputStream();
config.setOut(() -> baos);
Reporter reporter = new Reporter(config);
reporter.output();
if (verbose) {
reporter.writeSummary(logWriter);
}
sink.text(baos.toString(StandardCharsets.UTF_8.name()));
} catch (IOException | MojoExecutionException | RatException e) {
throw new MavenReportException(e.getMessage(), e);
}
} catch (IOException e) {
DefaultLog.getInstance().warn("Unable to close log writer", e);
}
sink.verbatim_();
sink.paragraph_();
sink.section1_();
sink.body_();
}
/**
* Returns the reports bundle
*
* @param locale Requested locale of the bundle
* @return The bundle, which is used to read localized strings.
*/
private ResourceBundle getBundle(final Locale locale) {
return ResourceBundle.getBundle("org/apache/rat/mp/rat-report", locale, getClass().getClassLoader());
}
/**
* Returns the reports description.
*
* @param locale Requested locale of the bundle
* @return Report description, as given by the key "report.rat.description" in
* the bundle.
*/
@Override
public String getDescription(final Locale locale) {
return getBundle(locale).getString("report.rat.description");
}
/**
* Returns the reports name.
*
* @param locale Requested locale of the bundle
* @return Report name, as given by the key "report.rat.name" in the bundle.
*/
@Override
public String getName(final Locale locale) {
return getBundle(locale).getString("report.rat.name");
}
/**
* Returns the reports file name.
*
* @return "rat-report"
*/
@Override
public String getOutputName() {
return "rat-report";
}
}