arg2 = ImmutablePair.of(Arg.CONFIGURATION_NO_DEFAULTS.find("configuration-no-defaults"), null);
config = generateConfig(arg1, arg2);
reporter = new Reporter(config);
- claimStatistic = reporter.execute();
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(2);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
+ output = reporter.execute();
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(2);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
});
}
@@ -749,25 +759,24 @@ protected void execLicensesApprovedTest(final Option option, String[] args) {
ReportConfiguration config = generateConfig();
Reporter reporter = new Reporter(config);
- ClaimStatistic claimStatistic = reporter.execute();
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(2);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
+ Reporter.Output output = reporter.execute();
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(2);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
config = generateConfig(arg1);
reporter = new Reporter(config);
- claimStatistic = reporter.execute();
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(2);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(2);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(0);
+ output = reporter.execute();
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(2);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(2);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isZero();
});
}
@OptionCollectionTest.TestFunction
protected void licensesApprovedFileTest() {
Option option = Arg.LICENSES_APPROVED_FILE.find("licenses-approved-file");
- File ratDir = configureRatDir(option);
- File outputFile = FileUtils.writeFile(ratDir, "licensesApproved.txt", Collections.singletonList("GPL1"));
+ File outputFile = FileUtils.writeFile(configureRatDir(option), "licensesApproved.txt", Collections.singletonList("GPL1"));
execLicensesApprovedTest(option, new String[]{outputFile.getAbsolutePath()});
}
@@ -793,17 +802,17 @@ protected void scanHiddenDirectoriesTest() {
ReportConfiguration config = generateConfig();
Reporter reporter = new Reporter(config);
- ClaimStatistic claimStatistic = reporter.execute();
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(0);
+ Reporter.Output output = reporter.execute();
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isZero();
config = generateConfig(arg1);
reporter = new Reporter(config);
- claimStatistic = reporter.execute();
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(2);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
+ output = reporter.execute();
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(2);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
});
}
@@ -817,10 +826,11 @@ private void outTest(final Option option) {
ReportConfiguration config = generateConfig(ImmutablePair.of(option, args));
Reporter reporter = new Reporter(config);
- ClaimStatistic claimStatistic = reporter.output();
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(0);
+ Reporter.Output output = reporter.execute();
+ output.format(config);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isZero();
String actualText = TextUtils.readFile(outFile);
TextUtils.assertContainsExactly(1, "Apache License 2.0: 1 ", actualText);
@@ -857,10 +867,11 @@ private void styleSheetTest(final Option option) {
args[0] = sheet.arg();
ReportConfiguration config = generateConfig(ImmutablePair.of(option, args));
Reporter reporter = new Reporter(config);
- ClaimStatistic claimStatistic = reporter.output();
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(0);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
+ Reporter.Output output = reporter.execute();
+ output.format(config);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isZero();
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
String actualText = baos.toString(StandardCharsets.UTF_8);
switch (sheet) {
@@ -878,6 +889,9 @@ private void styleSheetTest(final Option option) {
case UNAPPROVED_LICENSES:
TextUtils.assertContainsExactly(1, "Files with unapproved licenses:" + System.lineSeparator() + " /stylesheet", actualText);
break;
+ case XHTML5:
+ TextUtils.assertPatternInTarget("| Approved<\\/td>\\s+ | \\d+<\\/td>\\s+ | A count of approved licenses.<\\/td>", actualText);
+ break;
default:
fail("No test for stylesheet " + sheet);
break;
@@ -887,10 +901,11 @@ private void styleSheetTest(final Option option) {
args[0] = file.getAbsolutePath();
ReportConfiguration config = generateConfig(ImmutablePair.of(option, args));
Reporter reporter = new Reporter(config);
- ClaimStatistic claimStatistic = reporter.output();
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(0);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
+ Reporter.Output output = reporter.execute();
+ output.format(config);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isZero();
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
String actualText = baos.toString(StandardCharsets.UTF_8);
TextUtils.assertContainsExactly(1, "Hello world", actualText);
@@ -929,15 +944,16 @@ protected void xmlTest() {
ReportConfiguration config = generateConfig(ImmutablePair.of(option, null));
Reporter reporter = new Reporter(config);
- ClaimStatistic claimStatistic = reporter.output();
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(0);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
+ Reporter.Output output = reporter.execute();
+ output.format(config);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isZero();
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
String actualText = baos.toString(StandardCharsets.UTF_8);
TextUtils.assertContainsExactly(1, "", actualText);
- try (InputStream expected = StyleSheets.getStyleSheet("xml").ioSupplier().get();
+ try (InputStream expected = StyleSheets.getStyleSheet("xml", null).ioSupplier().ioSupplier().get();
InputStream actual = config.getStyleSheet().get()) {
assertThat(IOUtils.contentEquals(expected, actual)).as("'xml' does not match").isTrue();
}
@@ -960,12 +976,12 @@ protected void logLevelTest() {
ReportConfiguration config = generateConfig();
Reporter reporter = new Reporter(config);
- reporter.output();
+ reporter.execute();
TextUtils.assertNotContains("DEBUG", baos.toString(StandardCharsets.UTF_8));
config = generateConfig(ImmutablePair.of(option, new String[]{"debug"}));
reporter = new Reporter(config);
- reporter.output();
+ reporter.execute();
TextUtils.assertContains("DEBUG", baos.toString(StandardCharsets.UTF_8));
} catch (IOException | RatException e) {
fail(e.getMessage(), e);
@@ -981,16 +997,11 @@ private void listLicenses(final Option option) {
assertDoesNotThrow(() -> {
configureSourceDir(option);
- File outFile = new File(sourceDir, "out.xml");
- FileUtils.delete(outFile);
- ImmutablePair outputFile = ImmutablePair.of(Arg.OUTPUT_FILE.option(), new String[]{outFile.getAbsolutePath()});
- ImmutablePair stylesheet = ImmutablePair.of(Arg.OUTPUT_STYLE.option(), new String[]{StyleSheets.XML.arg()});
for (LicenseSetFactory.LicenseFilter filter : LicenseSetFactory.LicenseFilter.values()) {
args[0] = filter.name();
- ReportConfiguration config = generateConfig(outputFile, stylesheet, ImmutablePair.of(option, args));
+ ReportConfiguration config = generateConfig(ImmutablePair.of(option, args));
Reporter reporter = new Reporter(config);
- reporter.output();
- Document document = XmlUtils.toDom(new FileInputStream(outFile));
+ Document document = reporter.execute().getDocument();
switch (filter) {
case ALL:
XmlUtils.assertIsPresent(filter.name(), document, xPath, "/rat-report/rat-config/licenses/license[@id='AL2.0']");
@@ -1027,16 +1038,12 @@ private void listFamilies(final Option option) {
assertDoesNotThrow(() -> {
configureSourceDir(option);
- File outFile = new File(sourceDir, "out.xml");
- FileUtils.delete(outFile);
- ImmutablePair outputFile = ImmutablePair.of(Arg.OUTPUT_FILE.option(), new String[]{outFile.getAbsolutePath()});
- ImmutablePair stylesheet = ImmutablePair.of(Arg.OUTPUT_STYLE.option(), new String[]{StyleSheets.XML.arg()});
for (LicenseSetFactory.LicenseFilter filter : LicenseSetFactory.LicenseFilter.values()) {
args[0] = filter.name();
- ReportConfiguration config = generateConfig(outputFile, stylesheet, ImmutablePair.of(option, args));
+ ReportConfiguration config = generateConfig(ImmutablePair.of(option, args));
Reporter reporter = new Reporter(config);
- reporter.output();
- Document document = XmlUtils.toDom(Files.newInputStream(outFile.toPath()));
+ Reporter.Output output = reporter.execute();
+ Document document = output.getDocument();
switch (filter) {
case ALL:
XmlUtils.assertIsPresent(filter.name(), document, xPath, "/rat-report/rat-config/families/family[@id='AL']");
@@ -1088,9 +1095,8 @@ private void archiveTest(final Option option) {
args[0] = proc.name();
ReportConfiguration config = generateConfig(outputFile, stylesheet, ImmutablePair.of(option, args));
Reporter reporter = new Reporter(config);
- reporter.output();
- Document document = XmlUtils.toDom(Files.newInputStream(outFile.toPath()));
+ Document document = reporter.execute().getDocument();
XmlUtils.assertIsPresent(proc.name(), document, xPath, "/rat-report/resource[@name='/dummy.jar']");
switch (proc) {
case ABSENCE:
@@ -1138,9 +1144,9 @@ private void standardTest(final Option option) {
args[0] = proc.name();
ReportConfiguration config = generateConfig(outputFile, stylesheet, ImmutablePair.of(option, args));
Reporter reporter = new Reporter(config);
- reporter.output();
+ Reporter.Output output = reporter.execute();
- Document document = XmlUtils.toDom(Files.newInputStream(outFile.toPath()));
+ Document document = output.getDocument();
XmlUtils.assertIsPresent(proc.name(), document, xPath, testDoc);
XmlUtils.assertIsPresent(proc.name(), document, xPath, missingDoc);
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReporterOptionsTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReporterOptionsTest.java
index ccb82f3c6..4f52a31a5 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReporterOptionsTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReporterOptionsTest.java
@@ -27,7 +27,7 @@
import org.apache.rat.api.RatException;
import org.apache.rat.report.claim.ClaimStatistic;
import org.apache.rat.test.AbstractConfigurationOptionsProvider;
-import org.apache.rat.testhelpers.FileUtils;
+import org.apache.rat.utils.FileUtils;
import org.apache.rat.testhelpers.XmlUtils;
import org.apache.rat.utils.DefaultLog;
import org.apache.rat.utils.Log;
@@ -78,14 +78,14 @@ void testRat362() {
FileUtils.writeFile(testDir, "foo.md");
ReportConfiguration config = OptionCollection.parseCommands(testDir, args, o -> fail("Help called"), true);
Reporter reporter = new Reporter(config);
- ClaimStatistic claimStatistic = reporter.execute();
- XmlUtils.printDocument(System.out, reporter.getDocument());
+ Reporter.Output output = reporter.execute();
+ XmlUtils.printDocument(System.out, output.getDocument());
XPath xpath = XPathFactory.newInstance().newXPath();
- XmlUtils.assertIsPresent(reporter.getDocument(), xpath, "/rat-report/resource[@name='/foo.md']");
- XmlUtils.assertAttributes(reporter.getDocument(), xpath, "/rat-report/resource[@name='/foo.md']",
+ XmlUtils.assertIsPresent(output.getDocument(), xpath, "/rat-report/resource[@name='/foo.md']");
+ XmlUtils.assertAttributes(output.getDocument(), xpath, "/rat-report/resource[@name='/foo.md']",
XmlUtils.mapOf("type", "IGNORED"));
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(0);
- assertThat(claimStatistic.getCounter(ClaimStatistic.Counter.IGNORED)).isEqualTo(2);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(0);
+ assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.IGNORED)).isEqualTo(2);
} catch (IOException | RatException | XPathExpressionException e) {
fail(e);
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java
index d9f11b7ad..ba457fd50 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java
@@ -7,7 +7,7 @@
* "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 *
+ * https://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 *
@@ -19,23 +19,31 @@
package org.apache.rat;
import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.assertj.core.api.Fail.fail;
-import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
+import java.io.IOException;
import java.io.PrintStream;
+import java.lang.reflect.Method;
import java.net.URISyntaxException;
import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
+import java.util.Optional;
import java.util.TreeMap;
+import java.util.UUID;
+import java.util.stream.Stream;
import javax.xml.XMLConstants;
import javax.xml.transform.Source;
+import javax.xml.transform.TransformerException;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.Schema;
@@ -45,25 +53,33 @@
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathFactory;
-import org.apache.commons.cli.CommandLine;
-import org.apache.commons.cli.DefaultParser;
-import org.apache.commons.cli.ParseException;
import org.apache.commons.io.FileUtils;
import org.apache.rat.api.Document.Type;
import org.apache.rat.api.RatException;
+import org.apache.rat.commandline.Arg;
import org.apache.rat.commandline.ArgumentContext;
-import org.apache.rat.commandline.StyleSheets;
import org.apache.rat.document.FileDocument;
import org.apache.rat.document.DocumentName;
import org.apache.rat.license.ILicenseFamily;
-import org.apache.rat.license.LicenseSetFactory;
import org.apache.rat.report.claim.ClaimStatistic;
+import org.apache.rat.report.claim.ClaimStatisticTest;
import org.apache.rat.test.utils.Resources;
+import org.apache.rat.testhelpers.BaseOptionCollection;
import org.apache.rat.testhelpers.TextUtils;
import org.apache.rat.testhelpers.XmlUtils;
+import org.apache.rat.testhelpers.data.ReportTestDataProvider;
+import org.apache.rat.testhelpers.data.TestData;
+import org.apache.rat.testhelpers.data.ValidatorData;
+import org.apache.rat.utils.StandardXmlFactory;
import org.apache.rat.walker.DirectoryWalker;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.io.TempDir;
+import org.junit.jupiter.api.TestInfo;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
import org.w3c.dom.Document;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
@@ -72,22 +88,62 @@
* Tests the output of the Reporter.
*/
public class ReporterTest {
- @TempDir
- File tempDirectory;
+ /**
+ * temporary file. Not using tempDir because it does not
+ * always work.
+ */
+ private static Path tempPath;
+
+ /**
+ * The directory for the test.
+ */
+ private Path testPath;
+
+ /**
+ * Directory for the test data.
+ */
final String basedir;
+ private final OptionCollectionParser collectionParser;
+
ReporterTest() throws URISyntaxException {
basedir = Resources.getExampleResource("exampleData").getPath();
+ collectionParser = new OptionCollectionParser(BaseOptionCollection.builder().build());
}
- @Test
- void testExecute() throws RatException, ParseException {
- File output = new File(tempDirectory, "testExecute");
+ @BeforeAll
+ static void setUp() throws IOException {
+ tempPath = Files.createTempDirectory("ReporterTest");
+ }
- CommandLine cl = new DefaultParser().parse(OptionCollection.buildOptions(), new String[]{"--output-style", "xml", "--output-file", output.getPath(), basedir});
- ArgumentContext ctxt = new ArgumentContext(new File("."), cl);
- ReportConfiguration config = OptionCollection.createConfiguration(ctxt);
- ClaimStatistic statistic = new Reporter(config).execute();
+ @AfterAll
+ static void cleanup() throws IOException {
+ FileUtils.deleteDirectory(tempPath.toFile());
+ }
+
+ @BeforeEach
+ void setUpTest(TestInfo testInfo) {
+ Optional testMethod = testInfo.getTestMethod();
+ this.testPath = tempPath.resolve(testMethod.isPresent() ?
+ testMethod.get().getName() :
+ UUID.randomUUID().toString());
+ File file = testPath.toFile();
+ if (!file.exists()) {
+ if (!file.mkdirs()) {
+ throw new RuntimeException("Unable to create temp directory: " + file.getName());
+ }
+ } else {
+ if (!file.isDirectory()) {
+ throw new RuntimeException(file.getName() + " is NOT a directory.");
+ }
+ }
+ }
+
+ @Test
+ void testExecute() throws RatException {
+ File output = testPath.resolve("output.xml").toFile();
+ ArgumentContext ctxt = collectionParser.parseCommands(new File("."), new String[]{"--output-style", "xml", "--output-file", output.getPath(), basedir});
+ ClaimStatistic statistic = new Reporter(ctxt.getConfiguration()).execute().getStatistic();
assertThat(statistic.getCounter(Type.ARCHIVE)).isEqualTo(1);
assertThat(statistic.getCounter(Type.BINARY)).isEqualTo(2);
@@ -136,13 +192,20 @@ void testExecute() throws RatException, ParseException {
}
@Test
- void testOutputOption() throws Exception {
- File output = new File(tempDirectory, "test");
- CommandLine commandLine = new DefaultParser().parse(OptionCollection.buildOptions(), new String[]{"-o", output.getCanonicalPath(), basedir});
- ArgumentContext ctxt = new ArgumentContext(new File("."), commandLine);
-
+ void testExecuteNoSource() throws ParseException, RatException, TransformerException {
+ File output = testPath.resolve("testExecuteNoSource").toFile();
+ ArgumentContext ctxt = collectionParser.parseCommands(new File("."), new String[]{"--output-style", "xml", "--output-file", output.getPath()});
ReportConfiguration config = OptionCollection.createConfiguration(ctxt);
- new Reporter(config).output();
+ Reporter.Output result = new Reporter(config).execute();
+ assertThat(StandardXmlFactory.serializeDocument(result.getDocument())).isEmpty();
+ ClaimStatisticTest.assertSame(result.getStatistic(), new ClaimStatistic());
+ }
+
+ @Test
+ void testOutputOption() throws Exception {
+ File output = testPath.resolve("output.txt").toFile();
+ ArgumentContext ctxt = collectionParser.parseCommands(new File("."), new String[]{"--output-file", output.getCanonicalPath(), basedir});
+ new Reporter(ctxt.getConfiguration()).execute().format(ctxt.getConfiguration());
assertThat(output.exists()).isTrue();
String content = FileUtils.readFileToString(output, StandardCharsets.UTF_8);
TextUtils.assertPatternInTarget("^! Unapproved:\\s*2 ", content);
@@ -150,18 +213,25 @@ void testOutputOption() throws Exception {
assertThat(content).contains("/sub/Empty.txt");
}
+ @Test
+ void testGetOutputMethod() throws Exception {
+ File output = testPath.resolve("test").toFile();
+ ArgumentContext ctxt = collectionParser.parseCommands(new File("."), new String[]{"--output-file", output.getCanonicalPath(), basedir});
+ ReportConfiguration config = OptionCollection.createConfiguration(ctxt);
+ Reporter reporter = new Reporter(config);
+ Reporter.Output expected = reporter.execute();
+ assertThat(reporter.getOutput()).isEqualTo(expected);
+ }
+
@Test
void testDefaultOutput() throws Exception {
- File output = new File(tempDirectory, "testDefaultOutput");
+ File output = testPath.resolve("captured.txt").toFile();
PrintStream origin = System.out;
try (PrintStream out = new PrintStream(output)) {
System.setOut(out);
- CommandLine commandLine = new DefaultParser().parse(OptionCollection.buildOptions(), new String[]{basedir});
- ArgumentContext ctxt = new ArgumentContext(new File("."), commandLine);
-
- ReportConfiguration config = OptionCollection.createConfiguration(ctxt);
- new Reporter(config).output();
+ ArgumentContext ctxt = collectionParser.parseCommands(new File("."), new String[]{basedir});
+ new Reporter(ctxt.getConfiguration()).execute().format(ctxt.getConfiguration());
} finally {
System.setOut(origin);
}
@@ -209,13 +279,10 @@ void testXMLOutput() throws Exception {
expected.put("/tri.txt", mapOf("encoding", "ISO-8859-1", "mediaType", "text/plain",
"type", "STANDARD"));
- File output = new File(tempDirectory, ".rat/testXMLOutput");
+ File output = testPath.resolve(".rat/testXMLOutput").toFile();
output.getParentFile().mkdir();
- CommandLine commandLine = new DefaultParser().parse(OptionCollection.buildOptions(), new String[]{"--output-style", "xml", "--output-file", output.getPath(), basedir});
- ArgumentContext ctxt = new ArgumentContext(tempDirectory, commandLine);
-
- ReportConfiguration config = OptionCollection.createConfiguration(ctxt);
- new Reporter(config).output();
+ ArgumentContext ctxt = collectionParser.parseCommands(testPath.toFile(), new String[]{"--output-style", "xml", "--output-file", output.getPath(), basedir});
+ new Reporter(ctxt.getConfiguration()).execute().format(ctxt.getConfiguration());
assertThat(output).exists();
Document doc = XmlUtils.toDom(java.nio.file.Files.newInputStream(output.toPath()));
@@ -405,13 +472,8 @@ private Validator initValidator() throws SAXException {
@Test
void xmlReportTest() throws Exception {
- ByteArrayOutputStream out = new ByteArrayOutputStream();
-
ReportConfiguration configuration = initializeConfiguration();
- configuration.setStyleSheet(StyleSheets.XML.getStyleSheet());
- configuration.setOut(new ReportConfiguration.IODescriptor("xmlReportTest", () -> out));
- new Reporter(configuration).output();
- Document doc = XmlUtils.toDom(new ByteArrayInputStream(out.toByteArray()));
+ Document doc = new Reporter(configuration).execute().getDocument();
XPath xPath = XPathFactory.newInstance().newXPath();
@@ -457,10 +519,9 @@ void plainReportTest() throws Exception {
"Generated at: ";
ByteArrayOutputStream out = new ByteArrayOutputStream();
ReportConfiguration configuration = initializeConfiguration();
- configuration.setOut(new ReportConfiguration.IODescriptor("plainReportTest", () -> out));
- new Reporter(configuration).output();
+ configuration.setOut(new ReportConfiguration.IODescriptor<>("plainReportTest", () -> out));
+ new Reporter(configuration).execute().format(configuration);
- out.flush();
String document = out.toString();
TextUtils.assertNotContains("", document);
@@ -473,11 +534,10 @@ void plainReportTest() throws Exception {
void unapprovedLicensesReportTest() throws Exception {
ByteArrayOutputStream out = new ByteArrayOutputStream();
ReportConfiguration configuration = initializeConfiguration();
- configuration.setOut(new ReportConfiguration.IODescriptor("unapprovedLicensesReportTest", () -> out));
+ configuration.setOut(new ReportConfiguration.IODescriptor<>("unapprovedLicensesReportTest", () -> out));
configuration.setStyleSheet(this.getClass().getResource("/org/apache/rat/unapproved-licenses.xsl"));
- new Reporter(configuration).output();
+ new Reporter(configuration).execute().format(configuration);
- out.flush();
String document = out.toString();
TextUtils.assertContains("Generated at: ", document );
@@ -489,44 +549,72 @@ void unapprovedLicensesReportTest() throws Exception {
void listLicensesReportTest() throws Exception {
ByteArrayOutputStream out = new ByteArrayOutputStream();
ReportConfiguration configuration = initializeConfiguration();
- configuration.setOut(new ReportConfiguration.IODescriptor("listLicensesReportTest", () -> out));
+ configuration.setOut(new ReportConfiguration.IODescriptor<>("listLicensesReportTest", () -> out));
configuration.setStyleSheet(StyleSheets.UNAPPROVED_LICENSES.getStyleSheet());
Reporter.listLicenses(configuration, LicenseSetFactory.LicenseFilter.NONE);
out.flush();
String document = out.toString();
-
assertThat(document).contains("Licenses (NONE):");
}
@Test
void counterMaxTest() throws Exception {
ReportConfiguration config = initializeConfiguration();
- Reporter reporter = new Reporter(config);
- reporter.output();
+ Reporter.Output output = new Reporter(config).execute();
assertThat(config.getClaimValidator().hasErrors()).isTrue();
- assertThat(config.getClaimValidator().isValid(ClaimStatistic.Counter.UNAPPROVED, reporter.getClaimsStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)))
+ assertThat(config.getClaimValidator().isValid(ClaimStatistic.Counter.UNAPPROVED, output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)))
.isFalse();
config = initializeConfiguration();
config.getClaimValidator().setMax(ClaimStatistic.Counter.UNAPPROVED, 2);
- reporter = new Reporter(config);
- reporter.output();
+ output = new Reporter(config).execute();
assertThat(config.getClaimValidator().hasErrors()).isFalse();
- assertThat(config.getClaimValidator().isValid(ClaimStatistic.Counter.UNAPPROVED, reporter.getClaimsStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)))
+ assertThat(config.getClaimValidator().isValid(ClaimStatistic.Counter.UNAPPROVED, output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)))
.isTrue();
}
+ static Stream getTestData() {
+ BaseOptionCollection.Builder builder = BaseOptionCollection.builder()
+ .unsupported(Arg.OUTPUT_FILE);
+ return new ReportTestDataProvider().getOptionTests(builder.build()).stream().map(testData ->
+ Arguments.of(testData.getTestName(), testData));
+ }
+
+ @ParameterizedTest( name = "{index} {0}")
+ @MethodSource("getTestData")
+ void testReportData(String name, TestData test) throws Exception {
+ Path invokePath = testPath.resolve(test.getTestName());
+ org.apache.rat.utils.FileUtils.mkDir(invokePath.toFile());
+
+ test.setupFiles(invokePath);
+ ArgumentContext ctxt = collectionParser.parseCommands(invokePath.toFile(),
+ test.getCommandLine(invokePath.toString()));
+ if (test.expectingException()) {
+ assertThatThrownBy(() -> new Reporter(ctxt.getConfiguration()).execute()).as("Expected throws from " + name)
+ .hasMessageContaining(test.getExpectedException().getMessage());
+ ValidatorData data = new ValidatorData(Reporter.Output.builder().configuration(ctxt.getConfiguration()).build(),
+ invokePath.toString());
+ test.getValidator().accept(data);
+ } else {
+ Reporter.Output output = ctxt.getConfiguration() != null ? new Reporter(ctxt.getConfiguration()).execute() :
+ Reporter.Output.builder().build();
+ ValidatorData data = new ValidatorData(output, invokePath.toString());
+ data.getOutput().format(data.getConfiguration());
+ test.getValidator().accept(data);
+ }
+ }
+
private record LicenseInfo(String id, String family, boolean approval, boolean hasNotes) {
- LicenseInfo(String id, boolean approval, boolean hasNotes) {
- this(id, id, approval, hasNotes);
- }
+ LicenseInfo(String id, boolean approval, boolean hasNotes) {
+ this(id, id, approval, hasNotes);
+ }
- private LicenseInfo(String id, String family, boolean approval, boolean hasNotes) {
- this.id = id;
- this.family = ILicenseFamily.makeCategory(family);
- this.approval = approval;
- this.hasNotes = hasNotes;
- }
+ private LicenseInfo(String id, String family, boolean approval, boolean hasNotes) {
+ this.id = id;
+ this.family = ILicenseFamily.makeCategory(family);
+ this.approval = approval;
+ this.hasNotes = hasNotes;
}
+ }
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/HeaderCheckWorkerTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/HeaderCheckWorkerTest.java
index 9583f47ed..a2cff0121 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/HeaderCheckWorkerTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/HeaderCheckWorkerTest.java
@@ -40,11 +40,10 @@
class HeaderCheckWorkerTest {
- /**
- * Create an unmodifiable sorted set from members
- */
+ /** Create an unmodifiable sorted set from members */
private UnmodifiableSortedSet asLicenses(ILicense... licenses) {
- SortedSet inner = new TreeSet<>(List.of(licenses));
+ SortedSet inner = new TreeSet<>();
+ inner.addAll(List.of(licenses));
return (UnmodifiableSortedSet) UnmodifiableSortedSet.unmodifiableSortedSet(inner);
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/commandline/ArgTests.java b/apache-rat-core/src/test/java/org/apache/rat/commandline/ArgTests.java
index 742632c5a..bd8affac4 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/commandline/ArgTests.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/commandline/ArgTests.java
@@ -18,13 +18,8 @@
*/
package org.apache.rat.commandline;
-import org.apache.commons.cli.CommandLine;
-import org.apache.commons.cli.DefaultParser;
-import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.rat.CLIOptionCollection;
-import org.apache.rat.DeprecationReporter;
-import org.apache.rat.OptionCollection;
import org.apache.rat.ReportConfiguration;
import org.apache.rat.document.DocumentName;
import org.junit.jupiter.params.ParameterizedTest;
@@ -37,12 +32,6 @@
public class ArgTests {
- private CommandLine createCommandLine(String[] args) throws ParseException {
- Options opts = OptionCollection.buildOptions();
- return DefaultParser.builder().setDeprecatedHandler(DeprecationReporter.getLogReporter())
- .setAllowPartialMatching(true).build().parse(opts, args);
- }
-
@ParameterizedTest(name = "{0}")
@ValueSource(strings = { "rat.txt", "./rat.txt", "/rat.txt", "target/rat.test" })
public void outputFileNameNoDirectoryTest(String name) throws ParseException {
@@ -62,9 +51,8 @@ public void setOut(File file) {
Path workingPath = localFile.getAbsoluteFile().toPath();
String expected = fsInfo.normalize(workingPath.resolve("./" + fileName).toString());
- CommandLine commandLine = createCommandLine(new String[]{"--output-file", fileName});
OutputFileConfig configuration = new OutputFileConfig();
- ArgumentContext ctxt = new ArgumentContext(localFile, configuration, commandLine);
+ ArgumentContext ctxt = new ArgumentContext(localFile, configuration, CLIOptionCollection.INSTANCE.getOptions(), new String[]{"--output-file", fileName});
Arg.processArgs(ctxt, CLIOptionCollection.INSTANCE);
if (name.equals("/rat.txt")) {
assertThat(fsInfo.normalize(configuration.actual.getAbsolutePath())).isEqualTo(localFileName.getRoot() + "rat.txt");
diff --git a/apache-rat-core/src/test/java/org/apache/rat/config/exclusion/ExclusionProcessorTest.java b/apache-rat-core/src/test/java/org/apache/rat/config/exclusion/ExclusionProcessorTest.java
index 19e2e1542..cf9d1c795 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/config/exclusion/ExclusionProcessorTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/config/exclusion/ExclusionProcessorTest.java
@@ -18,6 +18,9 @@
*/
package org.apache.rat.config.exclusion;
+import java.io.ByteArrayInputStream;
+import java.io.StringWriter;
+import java.nio.charset.StandardCharsets;
import java.nio.file.FileSystems;
import java.nio.file.Path;
import java.util.ArrayList;
@@ -26,6 +29,9 @@
import org.apache.commons.io.FileUtils;
import org.apache.rat.document.DocumentNameMatcher;
import org.apache.rat.document.DocumentName;
+import org.apache.rat.report.xml.writer.XmlWriter;
+import org.apache.rat.utils.StandardXmlFactory;
+import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import java.io.File;
@@ -36,7 +42,8 @@
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
-import org.mockito.Mockito;
+import org.w3c.dom.Document;
+import org.xml.sax.SAXException;
import static java.lang.String.format;
import static org.assertj.core.api.Assertions.assertThat;
@@ -44,6 +51,8 @@
import static org.apache.rat.document.FSInfoTest.UNIX;
import static org.apache.rat.document.FSInfoTest.WINDOWS;
import static org.junit.jupiter.api.Assertions.fail;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.when;
public class ExclusionProcessorTest {
@@ -62,7 +71,7 @@ private String dump(DocumentNameMatcher nameMatcher, DocumentName name) {
private DocumentName mkName(DocumentName baseDir, String pth) throws IOException {
DocumentName result = baseDir.resolve(ExclusionUtils.convertSeparator(pth, "/", baseDir.getDirectorySeparator()));
- DocumentName mocked = Mockito.spy(result);
+ DocumentName mocked = spy(result);
String fn = result.localized(FileSystems.getDefault().getSeparator());
File file = tempDir.resolve(fn.substring(1)).toFile();
@@ -83,7 +92,7 @@ private DocumentName mkName(DocumentName baseDir, String pth) throws IOException
if (!file.createNewFile()) {
fail(() -> "Unable to create file: " + file);
}
- Mockito.when(mocked.asFile()).thenReturn(file);
+ when(mocked.asFile()).thenReturn(file);
return mocked;
}
@@ -264,4 +273,218 @@ private static Stream getDocumentNames() {
return lst.stream();
}
+
+ @Test
+ void addNullIncludedMatcherTest() {
+ ExclusionProcessor underTest = new ExclusionProcessor();
+ assertThat(underTest.getIncludedPaths()).isEmpty();
+ underTest.addIncludedMatcher(null);
+ assertThat(underTest.getIncludedPaths()).isEmpty();
+ underTest.addIncludedMatcher(DocumentNameMatcher.MATCHES_ALL)
+ .addIncludedMatcher(null);
+ assertThat(underTest.getIncludedPaths()).hasSize(1);
+ List actualPaths = underTest.getIncludedPaths().stream().map(DocumentNameMatcher::toString).toList();
+ assertThat(actualPaths).containsExactly(DocumentNameMatcher.MATCHES_ALL.toString());
+ }
+
+ @Test
+ void addNullExcludedMatcherTest() {
+ ExclusionProcessor underTest = new ExclusionProcessor();
+ assertThat(underTest.getExcludedPaths()).isEmpty();
+ underTest.addExcludedMatcher(null);
+ assertThat(underTest.getExcludedPaths()).isEmpty();
+ underTest.addExcludedMatcher(DocumentNameMatcher.MATCHES_ALL)
+ .addExcludedMatcher(null);
+ assertThat(underTest.getExcludedPaths()).hasSize(1);
+ List actualPaths = underTest.getExcludedPaths().stream().map(DocumentNameMatcher::toString).toList();
+ assertThat(actualPaths).containsExactly(DocumentNameMatcher.MATCHES_ALL.toString());
+ }
+
+ @Test
+ void addFileProcessor() {
+ ExclusionProcessor underTest = new ExclusionProcessor();
+ assertThat(underTest.getFileProcessors()).isEmpty();
+ underTest.addFileProcessor(null);
+ assertThat(underTest.getFileProcessors()).isEmpty();
+ underTest.addFileProcessor(StandardCollection.HIDDEN_FILE)
+ .addFileProcessor(null);
+ assertThat(underTest.getFileProcessors()).containsExactly(StandardCollection.HIDDEN_FILE);
+ }
+
+ @Test
+ void addNullIncludedPatternTest() {
+ ExclusionProcessor underTest = new ExclusionProcessor();
+ assertThat(underTest.getIncludedPatterns()).isEmpty();
+ underTest.addIncludedPatterns(null);
+ assertThat(underTest.getIncludedPatterns()).isEmpty();
+ underTest.addIncludedPatterns(Collections.emptyList());
+ assertThat(underTest.getIncludedPatterns()).isEmpty();
+ underTest.addIncludedPatterns(List.of("hello/world"))
+ .addIncludedPatterns(null)
+ .addIncludedPatterns(Collections.emptyList());
+ assertThat(underTest.getIncludedPatterns()).containsExactly("hello/world");
+ }
+
+ @Test
+ void addNullIncludedCollectionTest() {
+ ExclusionProcessor underTest = new ExclusionProcessor();
+ assertThat(underTest.getIncludedCollections()).isEmpty();
+ underTest.addIncludedCollection(null);
+ assertThat(underTest.getIncludedCollections()).isEmpty();
+ underTest.addIncludedCollection(StandardCollection.HIDDEN_FILE)
+ .addIncludedCollection(null);
+ assertThat(underTest.getIncludedCollections()).containsExactly(StandardCollection.HIDDEN_FILE);
+ }
+
+ @Test
+ void addNullExcludedCollectionTest() {
+ ExclusionProcessor underTest = new ExclusionProcessor();
+ assertThat(underTest.getExcludedCollections()).isEmpty();
+ underTest.addExcludedCollection(null);
+ assertThat(underTest.getExcludedCollections()).isEmpty();
+ underTest.addExcludedCollection(StandardCollection.HIDDEN_FILE)
+ .addExcludedCollection(null);
+ assertThat(underTest.getExcludedCollections()).containsExactly(StandardCollection.HIDDEN_FILE);
+ }
+
+ @Test
+ void addNullExcludedPatternTest() {
+ ExclusionProcessor underTest = new ExclusionProcessor();
+ assertThat(underTest.getExcludedPatterns()).isEmpty();
+ underTest.addExcludedPatterns(null);
+ assertThat(underTest.getExcludedPatterns()).isEmpty();
+ underTest.addExcludedPatterns(Collections.emptyList());
+ assertThat(underTest.getExcludedPatterns()).isEmpty();
+ underTest.addExcludedPatterns(List.of("hello/world"))
+ .addExcludedPatterns(null)
+ .addExcludedPatterns(Collections.emptyList());
+ assertThat(underTest.getExcludedPatterns()).containsExactly("hello/world");
+ }
+
+ public static void assertSame(ExclusionProcessor actual, ExclusionProcessor expected) {
+ assertThat(actual.getExcludedCollections()).containsExactlyElementsOf(expected.getExcludedCollections());
+ assertThat(actual.getFileProcessors()).containsExactlyElementsOf(expected.getFileProcessors());
+ assertThat(actual.getIncludedCollections()).containsExactlyElementsOf(expected.getIncludedCollections());
+ assertThat(actual.getExcludedPatterns()).containsExactlyElementsOf(expected.getExcludedPatterns());
+ assertThat(actual.getIncludedPatterns()).containsExactlyElementsOf(expected.getIncludedPatterns());
+
+ // paths only match on name. deserialized paths are not functional.
+ List actualPaths = actual.getExcludedPaths().stream().map(DocumentNameMatcher::toString).toList();
+ List expectedPaths = expected.getExcludedPaths().stream().map(DocumentNameMatcher::toString).toList();
+ assertThat(actualPaths).as("excluded paths").containsExactlyElementsOf(expectedPaths);
+
+ actualPaths = actual.getIncludedPaths().stream().map(DocumentNameMatcher::toString).toList();
+ expectedPaths = expected.getIncludedPaths().stream().map(DocumentNameMatcher::toString).toList();
+ assertThat(actualPaths).as("included paths").containsExactlyElementsOf(expectedPaths);
+ }
+
+ @ParameterizedTest
+ @MethodSource("serdeTestData")
+ void serdeTest(ExclusionProcessor underTest) throws IOException, SAXException {
+ StringWriter stringWriter = new StringWriter();
+ try (XmlWriter writer = new XmlWriter(stringWriter)) {
+ underTest.serde().serialize(writer);
+ }
+ Document document = StandardXmlFactory.documentBuilder().parse(new ByteArrayInputStream(stringWriter.toString().getBytes(StandardCharsets.UTF_8)));
+ ExclusionProcessor actual = new ExclusionProcessor();
+ actual.serde().deserialize(document.getElementsByTagName("ExclusionProcessor").item(0));
+ assertSame(actual, underTest);
+ }
+
+ static List serdeTestData() {
+ List tests = new ArrayList<>();
+ tests.add(new ExclusionProcessor());
+
+ // single exclusions
+ tests.add(new ExclusionProcessor()
+ .addExcludedPatterns(List.of("pattern/**")));
+
+ tests.add(new ExclusionProcessor()
+ .addExcludedCollection(StandardCollection.BAZAAR));
+
+
+ tests.add(new ExclusionProcessor()
+ .addExcludedMatcher(DocumentNameMatcher.MATCHES_ALL));
+
+ // single inclusions
+ tests.add(new ExclusionProcessor()
+ .addIncludedPatterns(List.of("pattern/**")));
+
+ tests.add(new ExclusionProcessor()
+ .addIncludedCollection(StandardCollection.BAZAAR));
+
+ tests.add(new ExclusionProcessor()
+ .addIncludedMatcher(DocumentNameMatcher.MATCHES_NONE));
+
+ // full population
+ tests.add(new ExclusionProcessor()
+ .addExcludedPatterns(List.of("pattern/**", "pattern2/**"))
+ .addExcludedCollection(StandardCollection.BAZAAR)
+ .addExcludedCollection(StandardCollection.MISC)
+ .addExcludedMatcher(DocumentNameMatcher.MATCHES_ALL)
+ .addIncludedPatterns(List.of("**/pattern3", "**/pattern4"))
+ .addIncludedCollection(StandardCollection.ARCH)
+ .addIncludedCollection(StandardCollection.BITKEEPER)
+ .addIncludedMatcher(DocumentNameMatcher.MATCHES_NONE));
+
+ return tests;
+ }
+
+ @Test
+ void reportExclusionsTest() throws IOException {
+ ExclusionProcessor underTest = new ExclusionProcessor()
+ .addExcludedPatterns(List.of("pattern/**", "pattern2/**"))
+ .addExcludedCollection(StandardCollection.BAZAAR)
+ .addExcludedCollection(StandardCollection.MISC)
+ .addFileProcessor(StandardCollection.HIDDEN_FILE)
+ .addExcludedMatcher(DocumentNameMatcher.MATCHES_ALL)
+ .addIncludedPatterns(List.of("**/pattern3", "**/pattern4"))
+ .addIncludedCollection(StandardCollection.ARCH)
+ .addIncludedCollection(StandardCollection.BITKEEPER)
+ .addIncludedMatcher(DocumentNameMatcher.MATCHES_NONE);
+
+ StringWriter writer = new StringWriter();
+ underTest.reportExclusions(writer);
+ String actual = writer.toString();
+
+ assertThat(actual).containsPattern("Excluding patterns:[^$]+\\Qpattern/**\\E")
+ .containsPattern("Excluding patterns:[^$]+\\Qpattern2/**\\E")
+ .containsPattern("Including patterns:[^$]+\\Q**/pattern3\\E")
+ .containsPattern("Including patterns:[^$]+\\Q**/pattern4\\E")
+ .contains("Excluding " + StandardCollection.BAZAAR + " collection.")
+ .contains("Excluding " + StandardCollection.MISC + " collection.")
+ .contains("Including " + StandardCollection.ARCH + " collection.")
+ .contains("Including " + StandardCollection.BITKEEPER + " collection.")
+ .contains("Processing exclude file from " + StandardCollection.HIDDEN_FILE)
+ .contains("Excluding " + DocumentNameMatcher.MATCHES_ALL + ".")
+ .contains("Including " + DocumentNameMatcher.MATCHES_NONE + ".");
+ }
+
+ @Test
+ void getNameMatcherTest() {
+ ExclusionProcessor underTest = new ExclusionProcessor()
+ .addExcludedPatterns(List.of("pattern/**", "pattern2/**"))
+ .addExcludedCollection(StandardCollection.BAZAAR)
+ .addExcludedCollection(StandardCollection.MISC)
+ .addFileProcessor(StandardCollection.HIDDEN_FILE)
+ .addExcludedMatcher(DocumentNameMatcher.MATCHES_ALL)
+ .addIncludedPatterns(List.of("**/pattern3", "**/pattern4"))
+ .addIncludedCollection(StandardCollection.ARCH)
+ .addIncludedCollection(StandardCollection.BITKEEPER)
+ .addIncludedMatcher(DocumentNameMatcher.MATCHES_NONE);
+
+ assertThat(underTest.getLastMatcherBaseDir()).isNull();
+ assertThat(underTest.getLastMatcher()).isNull();
+ DocumentName base = DocumentName.builder(new File(".")).build();
+
+ DocumentNameMatcher matcher = underTest.getNameMatcher(base);
+ assertThat(underTest.getLastMatcherBaseDir()).isEqualTo(base);
+ assertThat(underTest.getLastMatcher()).isEqualTo(matcher);
+
+ DocumentNameMatcher matcher2 = underTest.getNameMatcher(base);
+ assertThat(underTest.getLastMatcherBaseDir()).isEqualTo(base);
+ assertThat(underTest.getLastMatcher()).isEqualTo(matcher);
+ assertThat(underTest.getLastMatcherBaseDir()).isEqualTo(base);
+ assertThat(matcher2).isEqualTo(matcher);
+ }
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/configuration/XMLConfigurationReaderTest.java b/apache-rat-core/src/test/java/org/apache/rat/configuration/XMLConfigurationReaderTest.java
index f0779b31f..10c9759fb 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/configuration/XMLConfigurationReaderTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/configuration/XMLConfigurationReaderTest.java
@@ -52,6 +52,10 @@ public class XMLConfigurationReaderTest {
public static final String[] EXPECTED_LICENSES = {"AL1.0", "AL1.1", "AL2.0", "BSD-3", "DOJO", "TMF", "CDDL1", "ILLUMOS", "GPL1", "GPL2",
"GPL3", "MIT", "OASIS", "W3C", "W3CD"};
+ public static final String[] APPROVED_LICENSES = { "AL1.0", "AL1.1", "AL2.0", "BSD-3", "DOJO", "TMF", "CDDL1", "ILLUMOS",
+ "MIT", "OASIS", "W3C", "W3CD" };
+
+
@Test
void approvedLicenseIdTest() throws URISyntaxException {
XMLConfigurationReader reader = new XMLConfigurationReader();
@@ -59,9 +63,8 @@ void approvedLicenseIdTest() throws URISyntaxException {
assertThat(url).isNotNull();
reader.read(url.toURI());
- Collection readCategories = reader.approvedLicenseId();
- assertThat(readCategories.toArray(new String[readCategories.size()]))
- .containsExactly(APPROVED_IDS);
+ Collection actual = reader.approvedLicenseId();
+ assertThat(actual).containsExactlyInAnyOrder(APPROVED_IDS);
}
@Test
@@ -77,10 +80,12 @@ void LicensesTest() throws URISyntaxException {
void LicenseFamiliesTest() throws URISyntaxException {
XMLConfigurationReader reader = new XMLConfigurationReader();
URL url = XMLConfigurationReaderTest.class.getResource("/org/apache/rat/default.xml");
+ assertThat(url).isNotNull();
reader.read(url.toURI());
- assertThat(reader.readFamilies().stream().map(x -> x.getFamilyCategory().trim()).toArray(String[]::new))
- .containsExactly(EXPECTED_IDS);
+ Collection actual = reader.readFamilies().stream().map(lf -> lf.getFamilyCategory().trim())
+ .toList();
+ assertThat(actual).containsExactlyInAnyOrder(EXPECTED_IDS);
}
private void checkMatcher(String name, Class clazz) {
diff --git a/apache-rat-core/src/test/java/org/apache/rat/report/claim/ClaimStatisticTest.java b/apache-rat-core/src/test/java/org/apache/rat/report/claim/ClaimStatisticTest.java
new file mode 100644
index 000000000..b44f0e189
--- /dev/null
+++ b/apache-rat-core/src/test/java/org/apache/rat/report/claim/ClaimStatisticTest.java
@@ -0,0 +1,152 @@
+/*
+ * 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 *
+ * *
+ * https://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.report.claim;
+
+import org.apache.rat.api.Document;
+import org.junit.jupiter.api.Test;
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.StringWriter;
+import java.nio.charset.StandardCharsets;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class ClaimStatisticTest {
+
+ @Test
+ void counterTests() {
+ ClaimStatistic underTest = new ClaimStatistic();
+ for (ClaimStatistic.Counter counter : ClaimStatistic.Counter.values()) {
+ assertThat(underTest.getCounter(counter)).isZero();
+ underTest.incCounter(counter, 1);
+ assertThat(underTest.getCounter(counter)).isEqualTo(1);
+ underTest.incCounter(counter, -2);
+ assertThat(underTest.getCounter(counter)).isEqualTo(-1);
+ underTest.setCounter(counter, Integer.MAX_VALUE);
+ assertThat(underTest.getCounter(counter)).isEqualTo(Integer.MAX_VALUE);
+ }
+ }
+
+ @Test
+ void typeTests() {
+ ClaimStatistic underTest = new ClaimStatistic();
+ for (Document.Type docType : Document.Type.values()) {
+ assertThat(underTest.getCounter(docType)).isZero();
+ underTest.incCounter(docType, 1);
+ assertThat(underTest.getCounter(docType)).isEqualTo(1);
+ underTest.incCounter(docType, -2);
+ assertThat(underTest.getCounter(docType)).isEqualTo(-1);
+ }
+ }
+
+ @Test
+ void documentTypeTest() {
+ ClaimStatistic underTest = new ClaimStatistic();
+ assertThat(underTest.getDocumentTypes()).isEmpty();
+ underTest.incCounter(Document.Type.NOTICE, 1);
+ underTest.incCounter(Document.Type.BINARY, -1);
+ assertThat(underTest.getDocumentTypes()).containsExactly(Document.Type.BINARY, Document.Type.NOTICE);
+ }
+
+ @Test
+ void licenseCategoryCountTest() {
+ ClaimStatistic underTest = new ClaimStatistic();
+ assertThat(underTest.getLicenseCategoryCount("fam")).isZero();
+ underTest.incLicenseCategoryCount("fam", 1);
+ assertThat(underTest.getLicenseCategoryCount("fam")).isEqualTo(1);
+ underTest.incLicenseCategoryCount("fam", -2);
+ assertThat(underTest.getLicenseCategoryCount("fam")).isEqualTo(-1);
+ underTest.incLicenseCategoryCount("wayToLongAName", 5);
+ assertThat(underTest.getLicenseCategoryCount("wayToLongAName")).isEqualTo(5);
+ }
+
+ @Test
+ void licenseNameCountTest() {
+ ClaimStatistic underTest = new ClaimStatistic();
+ assertThat(underTest.getLicenseNameCount("fam")).isZero();
+ underTest.incLicenseNameCount("fam", 1);
+ assertThat(underTest.getLicenseNameCount("fam")).isEqualTo(1);
+ underTest.incLicenseNameCount("fam", -2);
+ assertThat(underTest.getLicenseNameCount("fam")).isEqualTo(-1);
+ }
+
+ @Test
+ void licenseFamilyCategoriesTest() {
+ ClaimStatistic underTest = new ClaimStatistic();
+ assertThat(underTest.getLicenseFamilyCategories()).isEmpty();
+ underTest.incLicenseCategoryCount("one", 1);
+ underTest.incLicenseCategoryCount("neg", -1);
+ assertThat(underTest.getLicenseFamilyCategories()).containsExactly("neg", "one");
+ underTest.incLicenseCategoryCount("wayToLongAName", 5);
+ assertThat(underTest.getLicenseFamilyCategories()).containsExactly("neg", "one", "wayToLongAName");
+ }
+
+ @Test
+ void licenseFamilyNameTest() {
+ ClaimStatistic underTest = new ClaimStatistic();
+ assertThat(underTest.getLicenseNames()).isEmpty();
+ underTest.incLicenseNameCount("one", 1);
+ underTest.incLicenseNameCount("neg", -1);
+ assertThat(underTest.getLicenseNames()).containsExactly("neg", "one");
+ underTest.incLicenseNameCount("wayToLongAName", 5);
+ assertThat(underTest.getLicenseNames()).containsExactly("neg", "one", "wayToLongAName");
+ }
+
+ /**
+ * Compares two claim statistics for similarity after serialization/deserialization.
+ * @param actual the deserialized verison.
+ * @param expected the original version.
+ */
+ public static void assertSame(final ClaimStatistic actual, final ClaimStatistic expected) {
+
+ assertThat(actual.getLicenseFamilyCategories()).containsExactlyElementsOf(expected.getLicenseFamilyCategories());
+ assertThat(actual.getLicenseNames()).containsExactlyElementsOf(expected.getLicenseNames());
+ assertThat(actual.getDocumentTypes()).containsExactlyElementsOf(expected.getDocumentTypes());
+ for (String cat : expected.getLicenseFamilyCategories()) {
+ assertThat(actual.getLicenseCategoryCount(cat)).isEqualTo(expected.getLicenseCategoryCount(cat));
+ }
+ for (String name : expected.getLicenseNames()) {
+ assertThat(actual.getLicenseNameCount(name)).isEqualTo(expected.getLicenseNameCount(name));
+ }
+ for (Document.Type type : expected.getDocumentTypes()) {
+ assertThat(actual.getCounter(type)).isEqualTo(expected.getCounter(type));
+ }
+ for (ClaimStatistic.Counter counter : ClaimStatistic.Counter.values()) {
+ assertThat(actual.getCounter(counter)).isEqualTo(expected.getCounter(counter));
+ }
+ }
+
+ @Test
+ void serdeRoundTrip() throws IOException {
+ ClaimStatistic underTest = new ClaimStatistic();
+ underTest.incLicenseCategoryCount("familyCagegory", 1);
+ underTest.incCounter(ClaimStatistic.Counter.APPROVED, 2);
+ underTest.incCounter(Document.Type.IGNORED, 3);
+ underTest.incLicenseNameCount("licenseName", 4);
+
+ ClaimStatistic.Serde serde = underTest.serde();
+ StringWriter stringWriter = new StringWriter();
+ serde.serialize(stringWriter);
+ ClaimStatistic actual = new ClaimStatistic();
+ ClaimStatistic.Serde serde2 = actual.serde();
+ serde2.deserialize(() -> new ByteArrayInputStream(stringWriter.toString().getBytes(StandardCharsets.UTF_8)));
+
+ assertSame(actual, underTest);
+ }
+}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/report/xml/writer/impl/base/XmlWriterTest.java b/apache-rat-core/src/test/java/org/apache/rat/report/xml/writer/XmlWriterTest.java
similarity index 98%
rename from apache-rat-core/src/test/java/org/apache/rat/report/xml/writer/impl/base/XmlWriterTest.java
rename to apache-rat-core/src/test/java/org/apache/rat/report/xml/writer/XmlWriterTest.java
index 287db7677..b86ad72f0 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/report/xml/writer/impl/base/XmlWriterTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/report/xml/writer/XmlWriterTest.java
@@ -16,11 +16,8 @@
* specific language governing permissions and limitations *
* under the License. *
*/
-package org.apache.rat.report.xml.writer.impl.base;
+package org.apache.rat.report.xml.writer;
-import org.apache.rat.report.xml.writer.InvalidXmlException;
-import org.apache.rat.report.xml.writer.OperationNotAllowedException;
-import org.apache.rat.report.xml.writer.XmlWriter;
import org.apache.rat.testhelpers.XmlUtils;
import org.junit.jupiter.api.Test;
import org.w3c.dom.Document;
diff --git a/apache-rat-core/src/test/java/org/apache/rat/test/AbstractConfigurationOptionsProvider.java b/apache-rat-core/src/test/java/org/apache/rat/test/AbstractConfigurationOptionsProvider.java
index 84e30dc59..5bee29740 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/test/AbstractConfigurationOptionsProvider.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/test/AbstractConfigurationOptionsProvider.java
@@ -19,6 +19,7 @@
package org.apache.rat.test;
import java.io.FileWriter;
+import java.nio.charset.StandardCharsets;
import java.nio.file.FileSystems;
import java.nio.file.Path;
import org.apache.commons.cli.Option;
@@ -80,7 +81,7 @@ public abstract class AbstractConfigurationOptionsProvider extends AbstractOptio
*/
public static void preserveData(File baseDir, String targetDir) {
final Path recordPath = FileSystems.getDefault().getPath("target", targetDir);
- org.apache.rat.testhelpers.FileUtils.mkDir(recordPath.toFile());
+ org.apache.rat.utils.FileUtils.mkDir(recordPath.toFile());
try {
FileUtils.copyDirectory(baseDir, recordPath.toFile());
} catch (IOException e) {
@@ -232,10 +233,10 @@ protected void inputExcludeParsedScmTest() {
writeFile(".gitignore", Arrays.asList(lines));
File dir = new File(baseDir, "red");
- org.apache.rat.testhelpers.FileUtils.mkDir(dir);
+ org.apache.rat.utils.FileUtils.mkDir(dir);
dir = new File(baseDir, "blue");
dir = new File(dir, "fish");
- org.apache.rat.testhelpers.FileUtils.mkDir(dir);
+ org.apache.rat.utils.FileUtils.mkDir(dir);
assertDoesNotThrow(() -> {
ReportConfiguration config = generateConfig(ImmutablePair.of(option, args));
@@ -815,12 +816,19 @@ private void styleSheetTest(final Option option) {
// run the test
String[] args = {null};
assertDoesNotThrow(() -> {
- for (String sheet : new String[]{"plain-rat", "missing-headers", "unapproved-licenses", file.getAbsolutePath()}) {
+ for (String sheet : new String[]{"plain-rat", "missing-headers", "unapproved-licenses", "stylesheet-" + option.getLongOpt()}) {
args[0] = sheet;
ReportConfiguration config = generateConfig(ImmutablePair.of(option, args));
- try (InputStream expected = StyleSheets.getStyleSheet(sheet).ioSupplier().get();
+ DocumentName base = DocumentName.builder(baseDir).build();
+ DocumentName expectedName = base.resolve(sheet);
+ try (InputStream expected = StyleSheets.getStyleSheet(sheet, base).ioSupplier().get();
InputStream actual = config.getStyleSheet().get()) {
- assertThat(IOUtils.contentEquals(expected, actual)).as(() -> String.format("'%s' does not match", sheet)).isTrue();
+ String expectedStr = IOUtils.toString(expected, StandardCharsets.UTF_8);
+ String actualStr = IOUtils.toString(actual, StandardCharsets.UTF_8);
+ assertThat(actualStr).as(() -> String.format("'%s' does not match '%s': %s != %s",
+ config.getStyleSheetDescriptor().name(),
+ expectedName.getName(),
+ actualStr, expectedStr)).isEqualTo(expectedStr);
}
}
});
@@ -845,7 +853,7 @@ protected void scanHiddenDirectoriesTest() {
protected void xmlTest() {
assertDoesNotThrow(() -> {
ReportConfiguration config = generateConfig(ImmutablePair.of(Arg.OUTPUT_STYLE.find("xml"), null));
- try (InputStream expected = StyleSheets.getStyleSheet("xml").ioSupplier().get();
+ try (InputStream expected = StyleSheets.getStyleSheet("xml", null).ioSupplier().get();
InputStream actual = config.getStyleSheet().get()) {
assertThat(IOUtils.contentEquals(expected, actual)).as("'xml' does not match").isTrue();
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/test/AbstractOptionsProvider.java b/apache-rat-core/src/test/java/org/apache/rat/test/AbstractOptionsProvider.java
index f4a188099..1f55d2ba0 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/test/AbstractOptionsProvider.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/test/AbstractOptionsProvider.java
@@ -170,7 +170,7 @@ public static String[] extractArgs(List> args) {
}
protected File writeFile(final String name, final Iterable lines) {
- return org.apache.rat.testhelpers.FileUtils.writeFile(baseDir, name, lines);
+ return org.apache.rat.utils.FileUtils.writeFile(baseDir, name, lines);
}
final protected DocumentName mkDocName(final String name) {
diff --git a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/BaseOption.java b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/BaseOption.java
new file mode 100644
index 000000000..4a22d9d7e
--- /dev/null
+++ b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/BaseOption.java
@@ -0,0 +1,42 @@
+/*
+ * 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 *
+ * *
+ * https://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.testhelpers;
+
+import org.apache.commons.cli.Option;
+import org.apache.rat.ui.ArgumentTracker;
+import org.apache.rat.ui.UIOption;
+import org.apache.rat.ui.UIOptionCollection;
+import org.apache.rat.utils.CasedString;
+
+public final class BaseOption extends UIOption {
+ BaseOption(final UIOptionCollection collection, Option option) {
+ super(collection, option, new CasedString(CasedString.StringCase.KEBAB, ArgumentTracker.extractKey(option)));
+ }
+ protected String cleanupName(Option option) {
+ return ArgumentTracker.extractKey(option);
+ }
+
+ public String getExample() {
+ return "";
+ }
+
+ public String getText() {
+ return "";
+ }
+}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/BaseOptionCollection.java b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/BaseOptionCollection.java
new file mode 100644
index 000000000..3500c44d0
--- /dev/null
+++ b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/BaseOptionCollection.java
@@ -0,0 +1,42 @@
+/*
+ * 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 *
+ * *
+ * https://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.testhelpers;
+
+import org.apache.rat.ui.UIOptionCollection;
+
+public final class BaseOptionCollection extends UIOptionCollection {
+ private BaseOptionCollection(Builder builder) {
+ super(builder);
+ }
+
+ public static Builder builder() {
+ return new Builder();
+ }
+
+ public static final class Builder extends UIOptionCollection.Builder {
+ private Builder() {
+ super(BaseOption::new);
+ }
+
+ @Override
+ public BaseOptionCollection build() {
+ return new BaseOptionCollection(this);
+ }
+ }
+}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
index 171cacacd..0298eb52c 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
@@ -26,6 +26,7 @@
public class TestingLog implements Log {
private StringBuilder captured = new StringBuilder();
+ private Log.Level level = Log.Level.INFO;
/**
* Clears the captured buffer
@@ -86,12 +87,18 @@ public void assertNotContainsPattern(String pattern) {
@Override
public Level getLevel() {
- return Level.DEBUG;
+ return level;
+ }
+
+ @Override
+ public void setLevel(Level level) {
+ this.level = level;
}
@Override
public void log(Level level, String msg) {
- captured.append(String.format("%s: %s%n", level, msg));
+ if (isEnabled(level))
+ captured.append(String.format("%s: %s%n", level, msg));
}
/**
diff --git a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TextUtils.java b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TextUtils.java
index e90a30b9c..72931b49e 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TextUtils.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TextUtils.java
@@ -40,7 +40,9 @@ public class TextUtils {
*
* @param pattern the pattern to match.
* @param target the string to match.
+ * @deprecated use assertThat(target).containsPattern(pattern)
*/
+ @Deprecated
public static void assertPatternInTarget(String pattern, String target) {
assertThat(isMatching(pattern, target)).as(() -> format("Target does not match string: %s%n%s", pattern, target))
.isTrue();
@@ -51,7 +53,9 @@ public static void assertPatternInTarget(String pattern, String target) {
*
* @param pattern the pattern to match.
* @param target the string to match.
+ * @deprecated use assertThat(target).dosNotContainPattern(pattern)
*/
+ @Deprecated
public static void assertPatternNotInTarget(String pattern, String target) {
assertThat(isMatching(pattern, target)).as(() -> format("Target matches the pattern: %s%n%s", pattern, target))
.isFalse();
@@ -63,7 +67,9 @@ public static void assertPatternNotInTarget(String pattern, String target) {
* @param pattern the pattern to match.
* @param target the string to match.
* @return {@code true} if a regular expression pattern is in a string
+ * @deprecated use assertThat(target).matches(pattern)
*/
+ @Deprecated
public static boolean isMatching(final String pattern, final String target) {
return Pattern.compile(pattern, Pattern.MULTILINE).matcher(target).find();
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/data/AbstractTestDataProvider.java b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/data/AbstractTestDataProvider.java
new file mode 100644
index 000000000..d72ea19b5
--- /dev/null
+++ b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/data/AbstractTestDataProvider.java
@@ -0,0 +1,201 @@
+/*
+ * 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.testhelpers.data;
+
+
+import com.google.common.collect.ImmutableList;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeMap;
+import java.util.TreeSet;
+import java.util.stream.Stream;
+import org.apache.commons.cli.Option;
+import org.apache.commons.lang3.tuple.ImmutablePair;
+import org.apache.rat.OptionCollectionParser;
+import org.apache.rat.commandline.Arg;
+import org.apache.rat.ui.UIOptionCollection;
+import org.apache.rat.ui.ArgumentTracker;
+import org.apache.rat.utils.DefaultLog;
+
+/**
+ * Generates a list of TestData for executing the Report.
+ * Use of this interface ensures consistent testing across the UIs. Each method
+ * tests an Option from {@link OptionCollectionParser} that must be implemented in the UI.
+ */
+public abstract class AbstractTestDataProvider {
+
+ /** The list of exclude args */
+ static final String[] EXCLUDE_ARGS = {"*.foo", "%regex[[A-Z]\\.bar]", "justbaz"};
+ /** the list of include args */
+ static final String[] INCLUDE_ARGS = {"B.bar", "justbaz"};
+ // Sonar suggests List of but we need an Immutable list.
+ public static final ImmutableList> NO_OPTIONS = ImmutableList.of(ImmutablePair.nullPair()); // NOSONAR
+
+ /**
+ * Generates a map of TestData indexed by the testName
+ * @param optionCollection the collection of options for the UI under test.
+ * @return the map of testName to Test Data.
+ */
+ public final Map getOptionTestMap(final UIOptionCollection optionCollection) {
+ Map map = new TreeMap<>();
+ for (TestData test : getOptionTests(optionCollection)) {
+ map.put(test.getTestName(), test);
+ }
+ return map;
+ }
+
+ /**
+ * Generates a list of test data for Option testing.
+ * This is different from UI testing as this is to test
+ * that the command line is properly parsed into a configuration.
+ * @param optionCollection the collection of options for the UI under test.
+ * @return a set of TestData for the tests.
+ */
+ public final Set getOptionTests(final UIOptionCollection optionCollection) {
+ // the optionCollection establishes any changes to the Arg values.
+ List |