1 package org.apache.rat.mp;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 import org.apache.commons.io.IOUtils;
23 import org.apache.maven.plugin.MojoExecutionException;
24 import org.apache.maven.plugin.MojoFailureException;
25 import org.apache.maven.plugins.annotations.LifecyclePhase;
26 import org.apache.maven.plugins.annotations.Mojo;
27 import org.apache.maven.plugins.annotations.Parameter;
28 import org.apache.rat.Defaults;
29 import org.apache.rat.ReportConfiguration;
30 import org.apache.rat.config.AddLicenseHeaders;
31 import org.apache.rat.config.ReportFormat;
32 import org.apache.rat.report.claim.ClaimStatistic;
33
34 import java.io.File;
35 import java.io.FileInputStream;
36 import java.io.FileNotFoundException;
37 import java.io.FileOutputStream;
38 import java.io.IOException;
39 import java.io.InputStream;
40 import java.io.OutputStreamWriter;
41 import java.io.Writer;
42 import java.nio.charset.Charset;
43
44
45
46
47 @Mojo(name = "check", defaultPhase = LifecyclePhase.VALIDATE)
48 public class RatCheckMojo extends AbstractRatMojo {
49
50
51
52 @Parameter(property = "rat.outputFile", defaultValue = "${project.build.directory}/rat.txt")
53 private File reportFile;
54
55
56
57
58
59
60
61 @Parameter(property = "rat.outputStyle", defaultValue = "plain")
62 private String reportStyle;
63
64
65
66
67 @Parameter(property = "rat.numUnapprovedLicenses", defaultValue = "0")
68 private int numUnapprovedLicenses;
69
70
71
72
73
74 @Parameter(property = "rat.addLicenseHeaders", defaultValue = "false")
75 private String addLicenseHeaders;
76
77
78
79
80
81
82 @Parameter(property = "rat.copyrightMessage")
83 private String copyrightMessage;
84
85
86
87
88
89
90
91 @Parameter(property = "rat.ignoreErrors", defaultValue = "false")
92 private boolean ignoreErrors;
93
94
95
96
97
98
99
100 @Parameter(property = "rat.consoleOutput", defaultValue = "false")
101 private boolean consoleOutput;
102
103 private ClaimStatistic getRawReport()
104 throws MojoExecutionException, MojoFailureException {
105 Writer fw = null;
106 try {
107 fw = new OutputStreamWriter(
108 new FileOutputStream(reportFile),
109 Charset.forName("UTF-8"));
110 final ClaimStatistic statistic = createReport(fw, getStyleSheet());
111 fw.close();
112 fw = null;
113 return statistic;
114 } catch (IOException e) {
115 throw new MojoExecutionException(e.getMessage(), e);
116 } finally {
117 IOUtils.closeQuietly(fw);
118 }
119 }
120
121
122
123
124
125
126
127
128 private InputStream getStyleSheet() throws MojoExecutionException {
129 if (reportStyle == null || ReportFormat.PLAIN.is(reportStyle)) {
130 return Defaults.getPlainStyleSheet();
131 } else if (ReportFormat.XML.is(reportStyle)) {
132 return null;
133 } else {
134 try {
135 return new FileInputStream(reportStyle);
136 } catch (FileNotFoundException e) {
137 throw new MojoExecutionException(
138 "Unable to find report stylesheet: " + reportStyle, e);
139 }
140 }
141 }
142
143
144
145
146
147
148
149 public void execute() throws MojoExecutionException, MojoFailureException {
150 if (skip) {
151 getLog().info("RAT will not execute since it is configured to be skipped via system property 'rat.skip'.");
152 return;
153 }
154
155 final File parent = reportFile.getParentFile();
156 if (!parent.mkdirs() && !parent.isDirectory()) {
157 throw new MojoExecutionException("Could not create report parent directory " + parent);
158 }
159
160 final ClaimStatistic report = getRawReport();
161 check(report);
162 }
163
164 protected void check(ClaimStatistic statistics)
165 throws MojoFailureException {
166 if (numUnapprovedLicenses > 0) {
167 getLog().info("You requested to accept " + numUnapprovedLicenses + " files with unapproved licenses.");
168 }
169
170 int numApproved = statistics.getNumApproved();
171 getLog().info("Rat check: Summary over all files. Unapproved: " + statistics.getNumUnApproved() +
172 ", unknown: " + statistics.getNumUnknown() +
173 ", generated: " + statistics.getNumGenerated() +
174 ", approved: " + numApproved +
175 (numApproved > 0 ? " licenses." : " license."));
176
177 if (numUnapprovedLicenses < statistics.getNumUnApproved()) {
178 if (consoleOutput) {
179 try {
180 getLog().warn(createReport(Defaults.getUnapprovedLicensesStyleSheet()).trim());
181 } catch (MojoExecutionException e) {
182 getLog().warn("Unable to print the files with unapproved licenses to the console.");
183 }
184 }
185
186 final String seeReport = " See RAT report in: " + reportFile;
187 if (!ignoreErrors) {
188 throw new RatCheckException("Too many files with unapproved license: " + statistics.getNumUnApproved() + seeReport);
189 } else {
190 getLog().warn("Rat check: " + statistics.getNumUnApproved() + " files with unapproved licenses." + seeReport);
191 }
192 }
193 }
194
195 @Override
196 protected ReportConfiguration getConfiguration()
197 throws MojoFailureException, MojoExecutionException {
198 final ReportConfiguration configuration = super.getConfiguration();
199
200 if (AddLicenseHeaders.FORCED.name().equalsIgnoreCase(addLicenseHeaders)) {
201 configuration.setAddingLicenses(true);
202 configuration.setAddingLicensesForced(true);
203 configuration.setCopyrightMessage(copyrightMessage);
204 } else if (AddLicenseHeaders.TRUE.name().equalsIgnoreCase(addLicenseHeaders)) {
205 configuration.setAddingLicenses(true);
206 configuration.setCopyrightMessage(copyrightMessage);
207 } else if (AddLicenseHeaders.FALSE.name().equalsIgnoreCase(addLicenseHeaders)) {
208
209 } else {
210 throw new MojoFailureException("Invalid value for addLicenseHeaders: Expected " + AddLicenseHeaders.getValuesForHelp() + ", got "
211 + addLicenseHeaders);
212 }
213 return configuration;
214 }
215 }