RAT-541: create testhelpers.data package

apache-rat-core/src/it/java/org/apache/rat/ReportTest.java

@@ -80,15 +80,27 @@
  *      associated with the exception.</li>
  * </ul>
  */
-public class ReportTest {
+class ReportTest {
 
+    /**
+     * Converts an argument lists to an argument array.
+     * @param argsList the list to convert.
+     * @return the array of arguments.
+     */
     private String[] asArgs(final List<String> argsList) {
         return argsList.toArray(new String[0]);
     }
 
+    /**
+     * Runs the commands specified by the `commandLine.txt` file in the `resources/ReportTest/*` directories
+     * and validates the results using the {@code verify.groovy} file in the test directory.
+     * @param testName the name of the test based on the directory the test was found in.
+     * @param commandLineDoc the document that is the command line.
+     * @throws Exception on execution error.
+     */
     @ParameterizedTest(name = "{index} {0}")
-    @MethodSource("args")
-    public void integrationTest(String testName, Document commandLineDoc) throws Exception {
+    @MethodSource("integrationTestData")
+    void integrationTest(String testName, Document commandLineDoc) throws Exception {
         DefaultLog.getInstance().log(Log.Level.INFO, "Running test for " + testName);
         File baseDir = new File(commandLineDoc.getName().getName()).getParentFile();
 
@@ -119,9 +131,11 @@ public void integrationTest(String testName, Document commandLineDoc) throws Exc
 
             File expectedMsg = new File(baseDir, "expected-message.txt");
             if (expectedMsg.exists()) {
-                String msg = IOUtils.readLines(new FileReader(expectedMsg)).get(0).trim();
-                assertThrows(RatDocumentAnalysisException.class, () -> Report.main(asArgs(argsList)),
-                        msg);
+                try (FileReader fr = new FileReader(expectedMsg)) {
+                    String msg = IOUtils.readLines(fr).get(0).trim();
+                    assertThrows(RatDocumentAnalysisException.class, () -> Report.main(asArgs(argsList)),
+                            msg);
+                }
             } else {
                 Report.main(asArgs(argsList));
             }
@@ -142,15 +156,21 @@ public void integrationTest(String testName, Document commandLineDoc) throws Exc
             try {
                 Object value = shell.run(groovyScript, new String[]{outputFile.getAbsolutePath(), logFile.getAbsolutePath()});
                 if (value != null) {
-                    fail(String.format("%s", value));
+                    fail(testName + ": " + value);
                 }
             } catch (AssertionError e) {
-                throw new AssertionError(String.format("%s: %s", testName, e.getMessage()), e);
+                throw new AssertionError(testName + ": " + e.getMessage(), e);
             }
         }
     }
 
-    static Stream<Arguments> args() throws RatException {
+    /**
+     * Reads each directory under the ReportTest directory in the test resources and creates a test from it.
+     * The {@code commandLine.txt} file is parsed to create the command line to execute the tests.
+     * @return a stream of arguments for each test case.
+     * @throws RatException on parsing error.
+     */
+    static Stream<Arguments> integrationTestData() throws RatException {
         List<Arguments> results = new ArrayList<>();
         URL url = ReportTest.class.getResource("/ReportTest");
 
@@ -170,11 +190,11 @@ static Stream<Arguments> args() throws RatException {
         DirectoryWalker walker = new DirectoryWalker(document);
         RatReport report = new RatReport() {
             @Override
-            public void report(Document document)  {
-            if (!document.isIgnored()) {
-                String[] tokens = DocumentName.FSInfo.getDefault().tokenize(document.getName().localized());
-                results.add(Arguments.of(tokens[1], document));
-            }
+            public void report(Document document) {
+                if (!document.isIgnored()) {
+                    String[] tokens = DocumentName.FSInfo.getDefault().tokenize(document.getName().localized());
+                    results.add(Arguments.of(tokens[1], document));
+                }
             }
         };
         walker.run(report);
@@ -185,25 +205,27 @@ public void report(Document document)  {
      * Log that captures output for later review.
      */
     public static class FileLog implements Log {
-
+        /**
+         * The output from the log.
+         */
         private final PrintStream logFile;
 
         /**
-         * The level at which we will write messages
+         * The level at which we will write messages.
          */
         private Level level;
 
+        /**
+         * Constructor to write at level {@code INFO}.
+         * @param logFile the file to write to.
+         * @throws IOException on error.
+         */
         FileLog(File logFile) throws IOException {
             this.logFile = new PrintStream(logFile);
             level = Level.INFO;
         }
 
-        /**
-         * Sets the level.Log messages below the specified level will
-         * not be written to the log.
-         *
-         * @param level the level to use when writing messages.
-         */
+        @Override
         public void setLevel(final Level level) {
             this.level = level;
         }
@@ -220,6 +242,9 @@ public void log(Level level, String msg) {
             }
         }
 
+        /**
+         * Closes the log file.
+         */
         public void close() {
             logFile.close();
         }

apache-rat-core/src/it/resources/ReportTest/RAT_406/commandLine.txt

@@ -1,2 +1,3 @@
 --licenses-denied
 DOJO
+--

apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java

@@ -104,6 +104,10 @@ public enum Processing {
          */
         private final String description;
 
+        /**
+         * Constructor.
+         * @param description the description for this processing strategy
+         */
         Processing(final String description) {
             this.description = description;
         }
@@ -139,7 +143,7 @@ public String desc() {
     /**
      * The IODescriptor that provides the output stream to write the report to.
      */
-    private IODescriptor<OutputStream> out;
+    private IODescriptor<OutputStream> outputDescriptor;
 
     /**
      * The IODescriptor that provides the stylesheet to style the XML output.
@@ -205,6 +209,10 @@ public ReportConfiguration() {
         reportables = new ArrayList<>();
     }
 
+    /**
+     * A serializer/deserializer for a ReportConfiguration.
+     * @return the serializer/deserializer for a ReportConfiguration.
+     */
     public SerDes serDes() {
         return new SerDes();
     }
@@ -227,21 +235,29 @@ public void reportExclusions(final Appendable appendable) {
      * File within the file must be in linux format with a
      * {@code "/"} file separator.
      * @param file the file to process.
+     * @throws ConfigurationException if the file is {@code null}.
      */
     public void addSource(final File file) {
         notNull(file, "File may not be null.");
         sources.add(file);
     }
 
-    private void notNull(final Object o, final String msg) {
-        if (o == null) {
+    /**
+     * Throws ConfigurationException if the object is {@code null}.
+     * @param object the object to test.
+     * @param msg the message to create the exception with.
+     * @throws ConfigurationException if the object is {@code null}.
+     */
+    private void notNull(final Object object, final String msg) {
+        if (object == null) {
             throw new ConfigurationException(msg);
         }
     }
 
     /**
      * Adds a Reportable as a source of files to scan.
      * @param reportable the reportable to process.
+     * @throws ConfigurationException if the reportable is {@code null}.
      */
     public void addSource(final Reportable reportable) {
         notNull(reportable, "Reportable may not be null.");
@@ -257,8 +273,8 @@ public boolean hasSource() {
     }
 
     /**
-     * Gets a builder initialized with any files specified as sources.
-     * @return a configured builder.
+     * Gets a ReportListWalker.Builder initialized with any files specified as sources.
+     * @return a configured ReportListWalker.Builder.
      */
     public ReportableListWalker.Builder getSources() {
         DocumentName name = DocumentName.builder(new File(".")).build();
@@ -527,7 +543,7 @@ public void setStyleSheet(final IODescriptor<InputStream> styleSheet) {
      */
     public void setFrom(final Defaults defaults) {
         licenseSetFactory.add(defaults.getLicenseSetFactory());
-        if (getStyleSheet() == null) {
+        if (getStyleSheetDescriptor() == null) {
             setStyleSheet(StyleSheets.PLAIN.getStyleSheet());
         }
         defaults.getStandardExclusion().forEach(this::addExcludedCollection);
@@ -571,22 +587,22 @@ public void setStyleSheet(final URL styleSheet) {
      * times to provide the stream. Suppliers should prepare streams that are
      * appended to and that can be closed. If an {@code OutputStream} should not be
      * closed consider wrapping it in a {@code CloseShieldOutputStream}
-     * @param out the OutputStream supplier that provides the output stream to write
+     * @param outputDescriptor the OutputStream supplier that provides the output stream to write.
      * the report to. A {@code null} value will use {@code System.out}.
      * @see CloseShieldOutputStream
      */
-    public void setOut(final IODescriptor<OutputStream> out) {
-        this.out = out;
+    public void setOutput(final IODescriptor<OutputStream> outputDescriptor) {
+        this.outputDescriptor = outputDescriptor;
     }
 
     /**
      * Sets the OutputStream supplier to use the specified file. The file may be
      * opened and closed several times. File is deleted first and then may be
      * repeatedly opened in append mode.
-     * @see #setOut(IODescriptor)
+     * @see #setOutput(IODescriptor)
      * @param file The file to create the supplier with.
      */
-    public void setOut(final File file) {
+    public void setOutput(final File file) {
         Objects.requireNonNull(file, "output file should not be null");
         if (file.exists()) {
             try {
@@ -600,7 +616,7 @@ public void setOut(final File file) {
         if (!parent.mkdirs() && !parent.isDirectory()) {
             DefaultLog.getInstance().warn("Unable to create directory: " + file.getParentFile());
         }
-        setOut(IODescriptor.output(file));
+        setOutput(IODescriptor.output(file));
     }
 
     /**
@@ -618,7 +634,7 @@ public IOSupplier<OutputStream> getOutput() {
      * @return the IODescriptor of the output stream to write the report to.
      */
     public IODescriptor<OutputStream> getOutputDescriptor() {
-        return out == null ? SYSTEM_OUT : out;
+        return outputDescriptor == null ? SYSTEM_OUT : outputDescriptor;
     }
 
     /**
@@ -982,7 +998,7 @@ public void serialize(final Appendable appendable) throws IOException {
                         .attribute("archiveProcessing", getArchiveProcessing().name())
                         .attribute("standardProcessing", getStandardProcessing().name())
                         .attribute("stylesheet", styleSheet.name())
-                        .attribute("output", out.name());
+                        .attribute("output", outputDescriptor.name());
                 if (StringUtils.isNotEmpty(copyrightMessage)) {
                     writer.startElement("copyrightMessage").content(copyrightMessage).closeElement();
                 }
@@ -1015,6 +1031,13 @@ public void serialize(final Appendable appendable) throws IOException {
             }
         }
 
+        /**
+         * Reads an input stream as an XML document and parses the report configuration from that.
+         * <em>Note:</em> The reportable objects (Files) in a deserialized ReportConfigurations are not executable.
+         * @param inputStreamSupplier The XML document written by {@link #serialize(Appendable)}
+         * @param workingDirectory the directory to resolve short XSLT and output names from.
+         * @throws IOException on parse error.
+         */
         public void deserialize(final IOSupplier<InputStream> inputStreamSupplier, final DocumentName workingDirectory) throws IOException {
             org.w3c.dom.Document document;
             try (InputStream stream = inputStreamSupplier.get()) {
@@ -1036,14 +1059,14 @@ public void deserialize(final IOSupplier<InputStream> inputStreamSupplier, final
             standardProcessing = Processing.valueOf(attributes.get("standardProcessing"));
             String styleName = attributes.get("stylesheet");
             if (styleName != null) {
-                styleSheet = StyleSheets.getStyleSheet(styleName);
+                styleSheet = StyleSheets.getStyleSheet(styleName, workingDirectory);
             }
             String outputName = attributes.get("output");
             if (outputName != null) {
                 if (outputName.equals(ReportConfiguration.SYSTEM_OUT.name())) {
-                    out = ReportConfiguration.SYSTEM_OUT;
+                    outputDescriptor = ReportConfiguration.SYSTEM_OUT;
                 } else {
-                    out = IODescriptor.output(outputName, workingDirectory);
+                    outputDescriptor = IODescriptor.output(outputName, workingDirectory);
                 }
             }
 

apache-rat-core/src/main/java/org/apache/rat/commandline/Arg.java

@@ -165,7 +165,6 @@ public enum Arg {
             .build()),
             (context, selected) ->
                   context.getConfiguration().addApprovedLicenseIds(context.getParsedOptionValue(selected))
-
     ),
 
     /**
@@ -515,14 +514,14 @@ public enum Arg {
                 if ("x".equals(key)) {
                     // display deprecated message.
                     context.hasOption("x");
-                    context.getConfiguration().setStyleSheet(StyleSheets.getStyleSheet("xml"));
+                    context.getConfiguration().setStyleSheet(StyleSheets.getStyleSheet("xml", context.getWorkingDirectory()));
                 } else {
                     List<String> style = context.getOptionValues(selected);
                     if (style.size() != 1) {
                         DefaultLog.getInstance().error("Please specify a single stylesheet");
                         throw new ConfigurationException("Please specify a single stylesheet");
                     }
-                    context.getConfiguration().setStyleSheet(StyleSheets.getStyleSheet(style.get(0)));
+                    context.getConfiguration().setStyleSheet(StyleSheets.getStyleSheet(style.get(0), context.getWorkingDirectory()));
                 }
             }),
 
@@ -597,7 +596,7 @@ public enum Arg {
                     .build()),
             (context, selected) -> {
                 DocumentName documentName = context.getParsedOptionValue(selected, () -> {
-                    context.getConfiguration().setOut(ReportConfiguration.SYSTEM_OUT);
+                    context.getConfiguration().setOutput(ReportConfiguration.SYSTEM_OUT);
                     return null;
                 });
                 if (documentName != null) {
@@ -606,7 +605,7 @@ public enum Arg {
                     if (!parent.mkdirs() && !parent.isDirectory()) {
                         DefaultLog.getInstance().error("Could not create report parent directory " + documentName);
                     }
-                    context.getConfiguration().setOut(document);
+                    context.getConfiguration().setOutput(document);
                 }
             }),
 

apache-rat-core/src/main/java/org/apache/rat/commandline/Converters.java

@@ -41,12 +41,12 @@ private Converters() {
     }
 
     /**
-     * Creates a File with fully qualified name.
+     * Creates a file with fully qualified name.
      */
     public static final FileConverter FILE_CONVERTER = new FileConverter();
 
     /**
-     * Converts the Converter pattern into a Converter, count pair.
+     * Converts the converter pattern into a pair of Converter and count.
      */
     public static final Converter<Pair<ClaimStatistic.Counter, Integer>, ConfigurationException> COUNTER_CONVERTER = arg -> {
         String[] parts = arg.split(":");
@@ -98,7 +98,7 @@ public void setWorkingDirectory(final DocumentName workingDirectory) {
          * Applies the conversion function to the specified file name.
          * @param fileName the file name to create a file from.
          * @return the DocumentName
-         * @throws NullPointerException if {@code fileName} is null.
+         * @throws NullPointerException if given {@code fileName} is null.
          */
         public DocumentName apply(final String fileName) throws NullPointerException {
             DocumentName.FSInfo fsInfo = workingDirectory.fsInfo();
@@ -117,7 +117,7 @@ public DocumentName apply(final String fileName) throws NullPointerException {
             } else {
                 builder.setBaseName(workingDirectory);
             }
-            return  builder.setName(normalizedFileName).build();
+            return builder.setName(normalizedFileName).build();
         }
     }
 }