licenses,
+ final Document document) {
Objects.requireNonNull(reader, "Reader may not be null");
- Objects.requireNonNull(license, "License may not be null");
+ Objects.requireNonNull(licenses, "Licenses may not be null");
if (numberOfRetainedHeaderLine < 0) {
throw new ConfigurationException("numberOfRetainedHeaderLine may not be less than zero");
}
this.reader = reader instanceof BufferedReader ? (BufferedReader) reader : new BufferedReader(reader);
this.numberOfRetainedHeaderLines = numberOfRetainedHeaderLine;
- this.license = license;
- this.document = name;
- }
-
- /**
- * @return {@code true} if the header check is complete.
- */
- public boolean isFinished() {
- return finished;
+ this.licenses = licenses;
+ this.document = document;
}
/**
* Read the input and perform the header check.
- *
+ *
* @throws RatHeaderAnalysisException on IO Exception.
*/
public void read() throws RatHeaderAnalysisException {
- if (!finished) {
- final StringBuilder headers = new StringBuilder();
- headerLinesToRead = numberOfRetainedHeaderLines;
- try {
- while (readLine(headers)) {
- // do nothing
+ try {
+ final IHeaders headers = readHeader(reader, numberOfRetainedHeaderLines);
+ licenses.stream().filter(lic -> lic.matches(headers)).forEach(document.getMetaData()::reportOnLicense);
+ if (document.getMetaData().detectedLicense()) {
+ if (document.getMetaData().licenses().anyMatch(
+ lic -> ILicenseFamily.GENTERATED_CATEGORY.equals(lic.getLicenseFamily().getFamilyCategory()))) {
+ document.getMetaData().setDocumentType(Document.Type.GENERATED);
}
- if (license.finalizeState().asBoolean()) {
- document.getMetaData().reportOnLicense(license);
- } else {
- document.getMetaData().reportOnLicense(UnknownLicense.INSTANCE);
- document.getMetaData().set(new MetaData.Datum(MetaData.RAT_URL_HEADER_SAMPLE, headers.toString()));
- }
- } catch (IOException e) {
- throw new RatHeaderAnalysisException("Cannot read header for " + document, e);
- }
- license.reset();
- }
- finished = true;
- }
-
- boolean readLine(StringBuilder headers) throws IOException {
- String line = reader.readLine();
- boolean result = line != null;
- if (result) {
- if (headerLinesToRead-- > 0) {
- headers.append(line);
- headers.append('\n');
- }
- switch (license.matches(line)) {
- case t:
- result = false;
- break;
- case f:
- case i:
- result = true;
- break;
+ } else {
+ document.getMetaData().reportOnLicense(UnknownLicense.INSTANCE);
+ document.getMetaData().setSampleHeader(headers.raw());
}
+ } catch (IOException e) {
+ throw new RatHeaderAnalysisException("Cannot read header for " + document, e);
+ } finally {
+ licenses.forEach(ILicense::reset);
}
- return result;
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/IHeaderMatcher.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/IHeaderMatcher.java
index a4aacf8f6..7e70ec29a 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/IHeaderMatcher.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/IHeaderMatcher.java
@@ -18,6 +18,9 @@
*/
package org.apache.rat.analysis;
+import org.apache.rat.ImplementationException;
+import org.apache.rat.config.parameters.Description;
+import org.apache.rat.config.parameters.DescriptionBuilder;
import org.apache.rat.configuration.builders.AllBuilder;
import org.apache.rat.configuration.builders.AnyBuilder;
import org.apache.rat.configuration.builders.CopyrightBuilder;
@@ -28,80 +31,45 @@
import org.apache.rat.configuration.builders.TextBuilder;
/**
- * Performs explicit checks against a line from the header of a file.
- * For implementations that need to check multiple lines the implementation must cache the earlier lines.
+ * Performs explicit checks against a line from the header of a file. For
+ * implementations that need to check multiple lines the implementation must
+ * cache the earlier lines.
*/
public interface IHeaderMatcher {
- /**
- * The state of the matcher.
- *
- * - {@code t} - The matcher has located a match.
- * - {@code f} - The matcher has determined that it will not match the
- * document.
- * - {@code i} - The matcher can not yet determine if a matche is made or
- * not.
- *
- */
- enum State {
- t("true"), f("false"), i("indeterminent");
-
- private final String desc;
-
- State(String desc) {
- this.desc = desc;
- }
-
- public boolean asBoolean() {
- switch (this) {
- case t : return true;
- case f : return false;
- default:
- case i : throw new IllegalStateException( "'asBoolean' should never be called on an indeterminate state");
- }
- }
-
- @Override
- public String toString() {
- return super.toString()+" "+desc;
- }
- }
-
/**
* Get the identifier for this matcher.
- * All matchers must have unique identifiers
+ *
+ * All matchers must have unique identifiers
+ *
*
* @return the Identifier for this matcher.
*/
String getId();
/**
- * Resets this state {@code State.i}.
- * If text is being cached this method should clear that cache.
+ * Resets this state of this matcher to its initial state in preparation for
+ * use with another document scan. In most cases this method does not need to
+ * do anything.
*/
- void reset();
+ default void reset() {
+ // does nothing.
+ }
/**
- * Attempts to match {@code line} and returns the State after
- * the match is attempted.
+ * Attempts to match text in the IHeaders instance.
*
- * @param line next line of text, not null
- * @return the new state after the matching was attempted.
- */
- State matches(String line);
-
- /**
- * Gets the final state for this matcher. This is called after the EOF on the
- * input. At this point there should be no matchers in an {@code State.i} state.
+ * @param headers the representations of the headers to check
+ * @return {@code true} if the matcher matches the text, {@code false} otherwise.
*/
- State finalizeState();
-
+ boolean matches(IHeaders headers);
+
/**
- * Gets the the current state of the matcher. All matchers should be
- * in {@code State.i} at the start.
- *
- * @return the current state of the matcher.
+ * Generates the component Description.
+ * @return the component description.
*/
- State currentState();
+ default Description getDescription() {
+ return DescriptionBuilder.build(this);
+ }
/**
* An IHeaderMatcher builder.
@@ -110,10 +78,39 @@ public String toString() {
interface Builder {
/**
* Build the IHeaderMatcher.
+ *
+ * Implementations of this interface should return a specific child class of IHeaderMatcher.
+ *
* @return a new IHeaderMatcher.
*/
IHeaderMatcher build();
+ /**
+ * Gets the class that is build by this builder.
+ * @return The class that is build by this builder.
+ */
+ default Class builtClass() throws SecurityException {
+ try {
+ return this.getClass().getMethod("build").getReturnType();
+ } catch (NoSuchMethodException | SecurityException e) {
+ throw new IllegalStateException("the 'build' method of the Builder interface must always be public");
+ }
+ }
+
+ /**
+ * Gets the Description for this builder.
+ * @return The description of the builder
+ */
+ default Description getDescription() {
+ Class clazz = builtClass();
+ if (clazz == IHeaderMatcher.class) {
+ throw new ImplementationException(String.format(
+ "Class %s must implement buildClass() method to return a child class of IHeaderMatcher",
+ this.getClass()));
+ }
+ return DescriptionBuilder.buildMap(clazz);
+ }
+
/**
* @return an instance of the standard TextBuilder.
* @see TextBuilder
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/IHeaders.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/IHeaders.java
new file mode 100644
index 000000000..be807574b
--- /dev/null
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/IHeaders.java
@@ -0,0 +1,38 @@
+package org.apache.rat.analysis;
+/*
+ * 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. *
+ */
+
+/**
+ * The processed headers from a file.
+ */
+public interface IHeaders {
+ /**
+ * Gets raw header as found in the document.
+ * @return the raw header as read from the file.
+ */
+ public String raw();
+
+ /**
+ * Gets the pruned header. This is the header with all non letter
+ * and non number characters removed and the string converted to lower case.
+ * @return The pruned header.
+ */
+ public String pruned();
+
+}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/LicenseCollection.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/LicenseCollection.java
deleted file mode 100644
index 57ee9de3d..000000000
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/LicenseCollection.java
+++ /dev/null
@@ -1,134 +0,0 @@
-/*
- * 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.analysis;
-
-import java.util.Collection;
-import java.util.Collections;
-
-import org.apache.rat.analysis.matchers.AbstractMatcherContainer;
-import org.apache.rat.license.ILicense;
-import org.apache.rat.license.ILicenseFamily;
-
-/**
- * A collection of ILicenses that acts as a single License for purposes of Analysis.
- *
- * This class process each license in turn on each {@code matches(String)} call. When a match is found the
- * ILicenseFamily for the matching license is captured and used as the family for this license. If no matching
- * license has been found the default {@code dummy} license category is used.
- */
-class LicenseCollection extends AbstractMatcherContainer implements ILicense {
-
- private static final ILicenseFamily DEFAULT = ILicenseFamily.builder().setLicenseFamilyCategory("Dummy")
- .setLicenseFamilyName("HeaderMatcherCollection default license family").build();
- private final Collection enclosed;
- private ILicense matchingLicense;
- private State lastState;
-
- /**
- * Constructs the LicenseCollection from the provided ILicense collection.
- * @param enclosed The collection of ILicenses to compose this License implementation from. May not be null.
- */
- public LicenseCollection(Collection enclosed) {
- super(enclosed);
- this.enclosed = Collections.unmodifiableCollection(enclosed);
- this.matchingLicense = null;
- this.lastState = State.i;
- }
-
- @Override
- public String getId() {
- return "Default License Collection";
- }
-
- @Override
- public void reset() {
- enclosed.forEach(ILicense::reset);
- this.lastState = State.i;
- this.matchingLicense = null;
- }
-
- @Override
- public State matches(String line) {
- State dflt = State.f;
- for (ILicense license : enclosed) {
- switch (license.matches(line)) {
- case t:
- this.matchingLicense = license;
- lastState = State.t;
- return State.t;
- case i:
- dflt = State.i;
- break;
- default:
- // do nothing
- break;
- }
- }
- lastState = dflt;
- return dflt;
- }
-
- @Override
- public State currentState() {
- if (lastState == State.t) {
- return lastState;
- }
- for (ILicense license : enclosed) {
- switch (license.currentState()) {
- case t:
- this.matchingLicense = license;
- lastState = State.t;
- return lastState;
- case i:
- lastState = State.i;
- return lastState;
- case f:
- // do nothing;
- break;
- }
- }
- lastState = State.f;
- return lastState;
- }
-
- @Override
- public int compareTo(ILicense arg0) {
- return getLicenseFamily().compareTo(arg0.getLicenseFamily());
- }
-
- @Override
- public ILicenseFamily getLicenseFamily() {
- return matchingLicense == null ? DEFAULT : matchingLicense.getLicenseFamily();
- }
-
- @Override
- public String getNotes() {
- return matchingLicense == null ? null : matchingLicense.getNotes();
- }
-
- @Override
- public String derivedFrom() {
- return matchingLicense == null ? null : matchingLicense.derivedFrom();
- }
-
- @Override
- public String getName() {
- return getLicenseFamily().getFamilyName();
- }
-}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/RatHeaderAnalysisException.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/RatHeaderAnalysisException.java
index 0e713912e..cd1a05c02 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/RatHeaderAnalysisException.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/RatHeaderAnalysisException.java
@@ -15,7 +15,7 @@
* KIND, either express or implied. See the License for the *
* specific language governing permissions and limitations *
* under the License. *
- */
+ */
package org.apache.rat.analysis;
/**
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/RatReportAnalysisResultException.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/RatReportAnalysisResultException.java
index 8ee9274dd..a31417cfd 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/RatReportAnalysisResultException.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/RatReportAnalysisResultException.java
@@ -15,17 +15,17 @@
* KIND, either express or implied. See the License for the *
* specific language governing permissions and limitations *
* under the License. *
- */
+ */
package org.apache.rat.analysis;
import org.apache.rat.api.RatException;
import org.apache.rat.document.RatDocumentAnalysisException;
public class RatReportAnalysisResultException extends RatDocumentAnalysisException {
-
+
private static final long serialVersionUID = 4018716722707721989L;
private static final String MESSAGE = "Could not report results of analysis";
-
+
public RatReportAnalysisResultException() {
super(MESSAGE);
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/UnknownLicense.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/UnknownLicense.java
index 113771b09..1889d86f4 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/UnknownLicense.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/UnknownLicense.java
@@ -25,29 +25,30 @@
/**
* An ILicense implementation that represents an unknown license.
*
- * The UnknownLicense is used during processing to report that a document license can not be determined.
+ * The UnknownLicense is used during processing to report that a document
+ * license can not be determined.
*
*/
public class UnknownLicense implements ILicense {
-
+
/**
* The single instance of this class.
*/
- static final UnknownLicense INSTANCE = new UnknownLicense();
-
- private final ILicenseFamily family ;
-
+ public static final UnknownLicense INSTANCE = new UnknownLicense();
+
+ private final ILicenseFamily family;
+
/**
* Do not allow other constructions.
*/
private UnknownLicense() {
- family = new ILicenseFamilyBuilder().setLicenseFamilyCategory("?????")
+ family = new ILicenseFamilyBuilder().setLicenseFamilyCategory(ILicenseFamily.UNKNOWN_CATEGORY)
.setLicenseFamilyName("Unknown license").build();
}
-
+
@Override
public String getId() {
- return "?????";
+ return ILicenseFamily.UNKNOWN_CATEGORY;
}
@Override
@@ -56,18 +57,8 @@ public void reset() {
}
@Override
- public State matches(String line) {
- return State.f;
- }
-
- @Override
- public State finalizeState() {
- return State.f;
- }
-
- @Override
- public State currentState() {
- return State.f;
+ public boolean matches(IHeaders headers) {
+ return false;
}
@Override
@@ -81,7 +72,7 @@ public ILicenseFamily getLicenseFamily() {
}
@Override
- public String getNotes() {
+ public String getNote() {
return null;
}
@@ -91,7 +82,7 @@ public String getName() {
}
@Override
- public String derivedFrom() {
+ public IHeaderMatcher getMatcher() {
return null;
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/license/FullTextMatchingLicense.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/license/FullTextMatchingLicense.java
index 6ce7ef7b3..aebb19b87 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/license/FullTextMatchingLicense.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/license/FullTextMatchingLicense.java
@@ -36,9 +36,14 @@ public class FullTextMatchingLicense extends BaseLicense {
private String text;
+ /** constructor */
public FullTextMatchingLicense() {
}
+ /**
+ * Set the text to match
+ * @param text the text to match
+ */
public final void setFullText(String text) {
this.text = text;
}
@@ -46,9 +51,9 @@ public final void setFullText(String text) {
@Override
public ILicense.Builder getLicense() {
return ILicense.builder()
- .setLicenseFamilyCategory(getLicenseFamilyCategory())
+ .setFamily(getLicenseFamilyCategory())
.setName(getLicenseFamilyName())
- .setMatcher( new TextBuilder().setText(text) )
- .setNotes(getNotes());
+ .setMatcher( new TextBuilder().setSimpleText(text) )
+ .setNote(getNotes());
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/license/SimplePatternBasedLicense.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/license/SimplePatternBasedLicense.java
index 36363e698..95fb8931a 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/license/SimplePatternBasedLicense.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/license/SimplePatternBasedLicense.java
@@ -50,10 +50,10 @@ public void setPatterns(String[] pPatterns) {
private AbstractBuilder getMatcher() {
if (patterns.length == 1) {
- return new TextBuilder().setText(patterns[0]);
+ return new TextBuilder().setSimpleText(patterns[0]);
} else {
AnyBuilder any = new AnyBuilder();
- Arrays.stream(patterns).map(s -> new TextBuilder().setText(s)).forEach(b-> any.add(b));
+ Arrays.stream(patterns).map(s -> new TextBuilder().setSimpleText(s)).forEach(b-> any.addEnclosed(b));
return any;
}
}
@@ -61,9 +61,9 @@ private AbstractBuilder getMatcher() {
@Override
public ILicense.Builder getLicense() {
return ILicense.builder()
- .setLicenseFamilyCategory(getLicenseFamilyCategory())
+ .setFamily(getLicenseFamilyCategory())
.setName(getLicenseFamilyName())
.setMatcher( getMatcher() )
- .setNotes(getNotes());
+ .setNote(getNotes());
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AbstractHeaderMatcher.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AbstractHeaderMatcher.java
index 64e2cc696..c97f88644 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AbstractHeaderMatcher.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AbstractHeaderMatcher.java
@@ -22,16 +22,24 @@
import org.apache.commons.lang3.StringUtils;
import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.ConfigComponent;
+import org.apache.rat.config.parameters.Description;
+import org.apache.rat.config.parameters.DescriptionBuilder;
/**
- * An abstract class to simplify IHeaderMatcher creation. This class ensures that the id is set.
+ * An abstract class to simplify IHeaderMatcher creation. This class ensures
+ * that the id is set
*/
public abstract class AbstractHeaderMatcher implements IHeaderMatcher {
+ @ConfigComponent(type = ComponentType.PARAMETER, desc = "The id of the matcher.")
private final String id;
/**
- * Constructs the IHeaderMatcher with an id value. If {@code id} is null then a unique random id is created.
+ * Constructs the IHeaderMatcher with an id value. If {@code id} is null then a
+ * unique random id is created.
+ *
* @param id the Id to use.
*/
protected AbstractHeaderMatcher(String id) {
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AbstractMatcherContainer.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AbstractMatcherContainer.java
index d15dd4258..7847309f9 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AbstractMatcherContainer.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AbstractMatcherContainer.java
@@ -20,39 +20,54 @@
import java.util.ArrayList;
import java.util.Collection;
+import java.util.Collections;
import java.util.Objects;
import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.ConfigComponent;
/**
- * A class that implements IHeaderMatcher as a collection of other IHeaderMatchers.
+ * A class that implements IHeaderMatcher as a collection of other
+ * IHeaderMatchers.
*/
public abstract class AbstractMatcherContainer extends AbstractHeaderMatcher {
- protected final Collection enclosed;
+ /** The collection of enclosed headers */
+ @ConfigComponent(desc = "enclosed Matchers", type = ComponentType.PARAMETER, parameterType = IHeaderMatcher.class, required=true)
+ private final Collection enclosed;
+
+ /** The resource the headers were read from. May be null */
+ @ConfigComponent(desc = "Resource to read matcher definitions from.", type = ComponentType.PARAMETER)
+ private final String resource;
/**
- * Constructs the abstract matcher container.
- * If the {@code id} is not set then a unique random identifier is created.
- * The {@code enclosed} collection is preserved in a new collection that retains the order of
- * of the original collection.
+ * Constructs the abstract matcher container. If the {@code id} is not set then
+ * a unique random identifier is created. The {@code enclosed} collection is
+ * preserved in a new collection that retains the order of of the original
+ * collection.
+ *
* @param id The id for the matcher.
- * @param enclosed the collection of enclosed matchers.
+ * @param enclosed the collection of enclosed matchers.
+ * @param resource the name of the resource if this container was read from a file or URL.
*/
- public AbstractMatcherContainer(String id, Collection enclosed) {
+ public AbstractMatcherContainer(String id, Collection enclosed, String resource) {
super(id);
Objects.requireNonNull(enclosed, "The collection of IHeaderMatcher may not be null");
this.enclosed = new ArrayList<>(enclosed);
+ this.resource = resource;
}
/**
- * Constructs the abstract matcher container with a unique random id.
- * The {@code enclosed} collection is preserved in a new collection that retains the order of
- * of the original collection.
- * @param enclosed the collection of enclosed matchers.
+ * Constructs the abstract matcher container with a unique random id. The
+ * {@code enclosed} collection is preserved in a new collection that retains the
+ * order of of the original collection.
+ *
+ * @param enclosed the collection of enclosed matchers.
+ * @param resource the name of the resource if this container was read from a file or URL.
*/
- public AbstractMatcherContainer(Collection enclosed) {
- this(null, enclosed);
+ public AbstractMatcherContainer(Collection enclosed, String resource) {
+ this(null, enclosed, resource);
}
@Override
@@ -60,9 +75,19 @@ public void reset() {
enclosed.forEach(IHeaderMatcher::reset);
}
- @Override
- public State finalizeState() {
- enclosed.forEach(IHeaderMatcher::finalizeState);
- return currentState();
+ /**
+ * Retrieves the collection of matchers that comprise the children of this matcher.
+ * @return the children of this matcher
+ */
+ public Collection getEnclosed() {
+ return Collections.unmodifiableCollection(enclosed);
+ }
+
+ /**
+ * Get the resource that was provided in the constructor.
+ * @return the resource or {@code null} if none was provided in the constructor.
+ */
+ public String getResource() {
+ return resource;
}
-}
+}
\ No newline at end of file
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AbstractSimpleMatcher.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AbstractSimpleMatcher.java
deleted file mode 100644
index 71852c075..000000000
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AbstractSimpleMatcher.java
+++ /dev/null
@@ -1,74 +0,0 @@
-/*
- * 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.analysis.matchers;
-
-/**
- * An abstract IHeaderMatcher that does simple matching. Implementations need to implement the {@code doMatch(String)}
- * method to perform the actual matching. All handling of the {@code State} is managed by this class. By default the
- * {@code finalizeState()} method will convert {@code State.i} to {@code State.f}.
- */
-public abstract class AbstractSimpleMatcher extends AbstractHeaderMatcher {
- private State lastState;
-
- /**
- * Constructs the AbstractSimpleMatcher with the specified id.
- * If the id is null or an empty string a unique random id will be generated.
- * @param id the Id to use. May be null.
- */
- protected AbstractSimpleMatcher(String id) {
- super(id);
- this.lastState = State.i;
- }
-
- /**
- * Performs the actual match test.
- * @param line the line to check.
- * @return {@code true} if the line matches, {@code false} otherwise.
- */
- abstract protected boolean doMatch(String line);
-
- @Override
- public final State matches(String line) {
- if (lastState == State.t) {
- return lastState;
- }
- if (line != null && doMatch(line)) {
- lastState = State.t;
- }
- return lastState;
- }
-
- @Override
- public void reset() {
- lastState = State.i;
- }
-
- @Override
- public State finalizeState() {
- if (lastState == State.i) {
- lastState = State.f;
- }
- return lastState;
- }
-
- @Override
- public final State currentState() {
- return lastState;
- }
-}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AndMatcher.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AndMatcher.java
index fc64f6e43..51d66b302 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AndMatcher.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/AndMatcher.java
@@ -21,56 +21,47 @@
import java.util.Collection;
import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.analysis.IHeaders;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.ConfigComponent;
/**
- * A matcher that performs a logical {@code AND} across all the contained matchers.
+ * A matcher that performs a logical {@code AND} across all the contained
+ * matchers.
*/
+@ConfigComponent(type = ComponentType.MATCHER, name = "all", desc = "Returns true if all enclosed matchers return true.")
public class AndMatcher extends AbstractMatcherContainer {
/**
* Constructs the AndMatcher with the specified id and enclosed collection.
- * @param id the to use. If null or an empty string a unique random id will be created.
+ *
+ * @param id the to use. If null or an empty string a unique random id will be
+ * created.
* @param enclosed the enclosed collection.
+ * @param resource the name of the resource the collection was read from if any. may be null.
*/
- public AndMatcher(String id, Collection enclosed) {
- super(id, enclosed);
+ public AndMatcher(String id, Collection enclosed, String resource) {
+ super(id, enclosed, resource);
}
/**
- * Constructs the AndMatcher with the a unique random id and the enclosed collection.
+ * Constructs the AndMatcher with the a unique random id and the enclosed
+ * collection.
+ *
* @param enclosed the enclosed collection.
+ * @param resource the name of the resource the collection was read from if any. may be null.
*/
- public AndMatcher(Collection enclosed) {
- this(null, enclosed);
+ public AndMatcher(Collection enclosed, String resource) {
+ this(null, enclosed, resource);
}
@Override
- public State currentState() {
- State dflt = State.t;
- for (IHeaderMatcher matcher : enclosed) {
- switch (matcher.currentState()) {
- case f:
- return State.f;
- case i:
- dflt = State.i;
- break;
- default:
- // do nothing
- break;
+ public boolean matches(IHeaders headers) {
+ for (IHeaderMatcher matcher : getEnclosed()) {
+ if (!matcher.matches(headers)) {
+ return false;
}
}
- return dflt;
- }
-
- @Override
- public State matches(String line) {
- enclosed.stream().filter(x -> x.currentState() == State.i).forEach(x -> x.matches(line));
- return currentState();
- }
-
- @Override
- public State finalizeState() {
- enclosed.forEach(IHeaderMatcher::finalizeState);
- return currentState();
+ return true;
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/CopyrightMatcher.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/CopyrightMatcher.java
index a03798b4d..76953a857 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/CopyrightMatcher.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/CopyrightMatcher.java
@@ -22,6 +22,10 @@
import java.util.regex.Pattern;
import org.apache.commons.lang3.StringUtils;
+import org.apache.rat.ConfigurationException;
+import org.apache.rat.analysis.IHeaders;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.ConfigComponent;
/**
* Matches a typical Copyright header line only based on a regex pattern which
@@ -38,18 +42,20 @@
* copyright 2012 foobar
*
*
- * Note also that the copyright owner is appended to the regex pattern and so can
- * support additional regex but also requires escaping where needed,
- * e.g. use "FooBar \\(www\\.foobar\\.com\\)" or
- * "FooBar \\Q(www.foobar.com)\\E" to match "FooBar
- * (www.foobar.com)"
+ * Note also that the copyright owner is appended to the regex pattern and so
+ * can support additional regex but also requires escaping where needed,
+ * e.g. use "FooBar \\(www\\.foobar\\.com\\)" or "FooBar
+ * \\Q(www.foobar.com)\\E" to match "FooBar (www.foobar.com)"
+ *
+ *
+ * The matcher also accepts "(C)", "(c)", and "©" in place of (or in addition
+ * to) the "Copyright" or "copyright" keyword
*
- * The matcher also accepts "(C)", "(c)", and "©" in place of (or in addition to) the "Copyright" or "copyright"
- * keyword
*/
-public class CopyrightMatcher extends AbstractSimpleMatcher {
+@ConfigComponent(type = ComponentType.MATCHER, name = "copyright", desc = "Matches copyright statements.")
+public class CopyrightMatcher extends AbstractHeaderMatcher {
- private static final String COPYRIGHT_SYMBOL_DEFN = "\\([Cc]\\)|©";
+ private static final String COPYRIGHT_SYMBOL_DEFN = "\\([Cc]\\)|©|\\&[Cc][Oo][Pp][Yy]\\;";
private static final String COPYRIGHT_PATTERN_DEFN = "(\\b)?" + COPYRIGHT_SYMBOL_DEFN + "|Copyright\\b";
private static final Pattern COPYRIGHT_PATTERN = Pattern.compile(COPYRIGHT_PATTERN_DEFN);
private static final String ONE_PART = "\\s+((" + COPYRIGHT_SYMBOL_DEFN + ")\\s+)?%s";
@@ -57,32 +63,61 @@ public class CopyrightMatcher extends AbstractSimpleMatcher {
private final Pattern dateOwnerPattern;
private final Pattern ownerDatePattern;
+ @ConfigComponent(type = ComponentType.PARAMETER, desc = "The initial date of the copyright")
+ private final String start;
+ @ConfigComponent(type = ComponentType.PARAMETER, desc = "The last date the copyright was modifed")
+ private final String end;
+ @ConfigComponent(type = ComponentType.PARAMETER, desc = "The owner of the copyright")
+ private final String owner;
/**
- * Constructs the CopyrightMatcher with the specified start, stop and owner strings and a unique random id..
+ * Constructs the CopyrightMatcher with the specified start, stop and owner
+ * strings and a unique random id..
+ *
* @param start the start date for the copyright may be null.
- * @param stop the stop date for the copyright, may be null. May not be specified if start is not specified.
+ * @param end the stop date for the copyright, may be null. May not be
+ * specified if start is not specified.
* @param owner the owner of the copyright. may be null.
*/
- public CopyrightMatcher(String start, String stop, String owner) {
- this(null, start, stop, owner);
+ public CopyrightMatcher(String start, String end, String owner) {
+ this(null, start, end, owner);
}
+ private static void assertNumber(String label, String value) {
+ try {
+ if (StringUtils.isNotEmpty(value)) {
+ Integer.parseInt(value);
+ }
+ } catch (NumberFormatException e) {
+ throw new ConfigurationException(String.format("'%s' must be numeric (value provided: '%s')", label, value));
+ }
+ }
/**
- * Constructs the CopyrightMatcher with the specified start, stop and owner strings.
+ * Constructs the CopyrightMatcher with the specified start, stop and owner
+ * strings.
+ *
* @param id the id for the matcher.
* @param start the start date for the copyright may be null.
- * @param stop the stop date for the copyright, may be null. May not be specified if start is not specified.
+ * @param end the end date for the copyright, may be null. May not be
+ * specified if start is not specified.
* @param owner the owner of the copyright. may be null.
*/
- public CopyrightMatcher(String id, String start, String stop, String owner) {
+ public CopyrightMatcher(String id, String start, String end, String owner) {
super(id);
+ if (StringUtils.isBlank(start) && !StringUtils.isBlank(end)) {
+ throw new ConfigurationException("'end' may not be set if 'start' is not set.");
+ }
+ assertNumber("start", start);
+ assertNumber("end", end);
+ this.start = start;
+ this.end = end;
+ this.owner = owner;
String dateDefn = "";
if (StringUtils.isNotEmpty(start)) {
- if (StringUtils.isNotEmpty(stop)) {
- dateDefn = String.format("%s\\s*-\\s*%s", start.trim(), stop.trim());
+ if (StringUtils.isNotEmpty(end)) {
+ dateDefn = String.format("%s\\s*-\\s*%s", this.start, this.end);
} else {
- dateDefn = start.trim();
+ dateDefn = this.start;
}
}
if (StringUtils.isEmpty(owner)) {
@@ -104,13 +139,38 @@ public CopyrightMatcher(String id, String start, String stop, String owner) {
}
}
+ /**
+ * Gets the start date of the copyright.
+ * @return the start date of the copyright or {@code null} if not set
+ */
+ public String getStart() {
+ return start;
+ }
+
+ /**
+ * Gets the end date of the copyright.
+ * @return the end date of the copyright or {@code null} if not set
+ */
+ public String getEnd() {
+ return end;
+ }
+
+ /**
+ * Gets the owner of the copyright.
+ * @return the owner of the copyright or {@code null} if not set
+ */
+ public String getOwner() {
+ return owner;
+ }
+
@Override
- protected boolean doMatch(String line) {
- String lowerLine = line.toLowerCase();
- if (lowerLine.contains("copyright") || lowerLine.contains("(c)") || line.contains("©")) {
- Matcher matcher = COPYRIGHT_PATTERN.matcher(line);
+ public boolean matches(IHeaders headers) {
+ String lowerLine = headers.raw().toLowerCase();
+ if (lowerLine.contains("copyright") || lowerLine.contains("(c)") || lowerLine.contains("©") ||
+ lowerLine.contains("©")) {
+ Matcher matcher = COPYRIGHT_PATTERN.matcher(headers.raw());
if (matcher.find()) {
- String buffer = line.substring(matcher.end());
+ String buffer = headers.raw().substring(matcher.end());
matcher = dateOwnerPattern.matcher(buffer);
if (matcher.find() && matcher.start() == 0) {
return true;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/FullTextMatcher.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/FullTextMatcher.java
index ece1118f1..1d08fe7c5 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/FullTextMatcher.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/FullTextMatcher.java
@@ -19,7 +19,8 @@
package org.apache.rat.analysis.matchers;
import java.util.Locale;
-import java.util.Objects;
+
+import org.apache.rat.analysis.IHeaders;
/**
* Accumulates all letters and numbers contained inside the header and compares
@@ -31,48 +32,34 @@
* US-ASCII charset are being matched.
*
*/
-public class FullTextMatcher extends AbstractSimpleMatcher {
-
- // Number of match characters assumed to be present on first line
- private static final int DEFAULT_INITIAL_LINE_LENGTH = 20;
+public class FullTextMatcher extends SimpleTextMatcher {
private final String fullText;
- private final String firstLine;
-
- private boolean seenFirstLine;
-
- private final StringBuilder buffer = new StringBuilder();
-
/**
- * Constructs the full text matcher with a unique random id and the specified text to match.
- * @param fullText the text to match
+ * Constructs the full text matcher with a unique random id and the specified
+ * text to match.
+ *
+ * @param simpleText the text to match
*/
- public FullTextMatcher(String fullText) {
- this(null, fullText);
+ public FullTextMatcher(String simpleText) {
+ this(null, simpleText);
}
/**
* Constructs the full text matcher for the specified text.
+ *
* @param id the id for the matcher
- * @param fullText the text to match
+ * @param simpleText the text to match
*/
- public FullTextMatcher(String id, String fullText) {
- super(id);
- Objects.requireNonNull(fullText, "fullText may not be null");
- int offset = fullText.indexOf('\n');
- if (offset == -1) {
- offset = Math.min(DEFAULT_INITIAL_LINE_LENGTH, fullText.length());
- }
- firstLine = prune(fullText.substring(0, offset)).toLowerCase(Locale.ENGLISH);
- this.fullText = prune(fullText).toLowerCase(Locale.ENGLISH);
- buffer.setLength(0);
- seenFirstLine = false;
+ public FullTextMatcher(String id, String simpleText) {
+ super(id, simpleText);
+ this.fullText = prune(simpleText).toLowerCase(Locale.ENGLISH);
}
/**
* Removes everything except letter or digit from text.
- *
+ *
* @param text The text to remove extra chars from.
* @return the pruned text.
*/
@@ -89,44 +76,10 @@ public static String prune(String text) {
}
@Override
- public boolean doMatch(String line) {
- final String inputToMatch = prune(line).toLowerCase(Locale.ENGLISH);
- if (seenFirstLine) { // Accumulate more input
- buffer.append(inputToMatch);
- } else {
- int offset = inputToMatch.indexOf(firstLine);
- if (offset >= 0) {
- // we have a match, save the text starting with the match
- buffer.append(inputToMatch.substring(offset));
- seenFirstLine = true;
- // Drop out to check whether full text is matched
- } else {
- // we assume that the first line must appear in a single line
- return false; // no more to do here
- }
- }
-
- if (buffer.length() >= fullText.length()) { // we have enough data to match
- if (buffer.toString().contains(fullText)) {
- return true;
- }
- // buffer contains first line but does not contain full text
- // It's possible that the buffer contains the first line again
- int offset = buffer.substring(1).indexOf(firstLine);
- if (offset >= 0) { // first line found again
- buffer.delete(0, offset); // reset buffer to the new start
- } else { // buffer does not even contain first line, so cannot be used to match full text
- reset();
- }
+ public boolean matches(IHeaders headers) {
+ if (headers.pruned().length() >= fullText.length()) { // we have enough data to match
+ return headers.pruned().contains(fullText);
}
return false;
}
-
- @Override
- public void reset() {
- super.reset();
- buffer.setLength(0);
- seenFirstLine = false;
- }
-
}
\ No newline at end of file
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/NotMatcher.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/NotMatcher.java
index 8678f9257..2f00c9a5c 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/NotMatcher.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/NotMatcher.java
@@ -18,27 +18,28 @@
*/
package org.apache.rat.analysis.matchers;
+import java.util.Arrays;
+import java.util.List;
import java.util.Objects;
import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.analysis.IHeaders;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.ConfigComponent;
+
/**
* An IHeaderMatcher that reverses the result of an enclosed matcher.
*/
+@ConfigComponent(type = ComponentType.MATCHER, name = "not", desc = "Negates the enclosed matcher.")
public class NotMatcher extends AbstractHeaderMatcher {
+ @ConfigComponent(desc = "enclosed Matcher", type = ComponentType.PARAMETER, parameterType = IHeaderMatcher.class, required=true)
private final IHeaderMatcher enclosed;
- /**
- * Create the matcher with the enclosed matcher.
- * @param enclosed the enclosed matcher
- */
- public NotMatcher(IHeaderMatcher enclosed) {
- this(null, enclosed);
- }
-
/**
* Create the matcher with the enclosed matcher and id.
- * @param id the id for this matcher.
+ *
+ * @param id the id for this matcher. May be null
* @param enclosed the enclosed matcher
*/
public NotMatcher(String id, IHeaderMatcher enclosed) {
@@ -47,33 +48,17 @@ public NotMatcher(String id, IHeaderMatcher enclosed) {
this.enclosed = enclosed;
}
- @Override
- public State matches(String line) {
- enclosed.matches(line);
- return currentState();
- }
-
- @Override
- public void reset() {
- enclosed.reset();
+ public IHeaderMatcher getEnclosed() {
+ return enclosed;
}
@Override
- public State finalizeState() {
- enclosed.finalizeState();
- return currentState();
+ public boolean matches(IHeaders headers) {
+ return !enclosed.matches(headers);
}
@Override
- public State currentState() {
- switch (enclosed.currentState()) {
- case t:
- return State.f;
- case f:
- return State.t;
- default:
- case i:
- return State.i;
- }
+ public void reset() {
+ enclosed.reset();
}
-}
+}
\ No newline at end of file
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/OrMatcher.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/OrMatcher.java
index 9b7bbae8a..4e2685850 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/OrMatcher.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/OrMatcher.java
@@ -21,75 +21,43 @@
import java.util.Collection;
import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.analysis.IHeaders;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.ConfigComponent;
/**
* A matcher that performs a logical {@code OR} across all the contained matchers.
*/
+@ConfigComponent(type = ComponentType.MATCHER, name = "any", desc = "Returns true if at least one of the enclosed matchers returns true.")
public class OrMatcher extends AbstractMatcherContainer {
- private State lastState;
-
/**
* Constructs the matcher from the enclosed matchers.
+ *
* @param enclosed the enclosed matchers.
*/
- public OrMatcher(Collection enclosed) {
- this(null, enclosed);
+ public OrMatcher(Collection enclosed, String resource) {
+ this(null, enclosed, resource);
}
/**
* Constructs the matcher with the specified id from the enclosed matchers.
+ *
* @param id the id to use.
* @param enclosed the enclosed matchers.
*/
- public OrMatcher(String id, Collection enclosed) {
- super(id, enclosed);
- lastState = State.i;
+ public OrMatcher(String id, Collection enclosed, String resource) {
+ super(id, enclosed, resource);
}
@Override
- public State matches(String line) {
- if (lastState == State.t) {
- return State.t;
- }
- for (IHeaderMatcher matcher : enclosed) {
- switch (matcher.matches(line)) {
- case t:
- lastState = State.t;
- return lastState;
- case f:
- case i:
- lastState = State.i;
+ public boolean matches(IHeaders headers) {
+ for (IHeaderMatcher matcher : getEnclosed()) {
+ if (matcher.matches(headers)) {
+ return true;
}
- }
- return lastState;
- }
- @Override
- public State currentState() {
- if (lastState == State.t) {
- return lastState;
}
- for (IHeaderMatcher matcher : enclosed) {
- switch (matcher.currentState()) {
- case t:
- lastState = State.t;
- return lastState;
- case i:
- lastState = State.i;
- return lastState;
- case f:
- // do nothing;
- break;
- }
- }
- lastState = State.f;
- return lastState;
- }
-
- @Override
- public void reset() {
- super.reset();
- lastState = State.i;
+ return false;
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SPDXMatcherFactory.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SPDXMatcherFactory.java
index 5766b5257..223680189 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SPDXMatcherFactory.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SPDXMatcherFactory.java
@@ -26,12 +26,14 @@
import org.apache.commons.lang3.StringUtils;
import org.apache.rat.ConfigurationException;
-import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.analysis.IHeaders;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.ConfigComponent;
/**
- * Defines a factory to produce matchers for an SPDX tag. SPDX tag is of the format
- * {@code SPDX-License-Identifier: short-name} where {@code short-name} matches
- * the regex pattern [A-Za-z0-9\.\-]+
+ * Defines a factory to produce matchers for an SPDX tag. SPDX tag is of the
+ * format {@code SPDX-License-Identifier: short-name} where {@code short-name}
+ * matches the regex pattern [A-Za-z0-9\.\-]+
*
* SPDX identifiers are specified by the Software Package Data Exchange(R) also
* known as SPDX(R) project from the Linux foundation.
@@ -52,7 +54,8 @@ public class SPDXMatcherFactory {
public static final SPDXMatcherFactory INSTANCE = new SPDXMatcherFactory();
/**
- * The regular expression to locate the SPDX license identifier in the text stream
+ * The regular expression to locate the SPDX license identifier in the text
+ * stream
*/
private static Pattern groupSelector = Pattern.compile(".*SPDX-License-Identifier:\\s([A-Za-z0-9\\.\\-]+)");
@@ -67,16 +70,17 @@ public class SPDXMatcherFactory {
private SPDXMatcherFactory() {
lastLine = null;
- };
+ }
/**
- * Creates the spdx matcher.
- * @param spdxId the spdx name to match.
- * @return a spdx matcher.
+ * Creates the SPDX matcher.
+ *
+ * @param spdxId the SPDX name to match.
+ * @return a SPDX matcher.
*/
- public IHeaderMatcher create(String spdxId) {
+ public Match create(String spdxId) {
if (StringUtils.isBlank(spdxId)) {
- throw new ConfigurationException("'spdx' type matcher requires a name");
+ throw new ConfigurationException("'SPDX' type matcher requires a name");
}
Match matcher = matchers.get(spdxId);
if (matcher == null) {
@@ -88,13 +92,16 @@ public IHeaderMatcher create(String spdxId) {
/**
* Each matcher calls this method to present the line it is working on.
+ *
* @param line The line the caller is looking at.
* @param caller the Match that is calling this method.
* @return true if the caller matches the text.
*/
private boolean check(String line, Match caller) {
- // if the line has not been seen yet see if we can extract the SPDX id from the line.
- // if so then see if that name has been registered. If so then we have a match and set
+ // if the line has not been seen yet see if we can extract the SPDX id from the
+ // line.
+ // if so then see if that name has been registered. If so then we have a match
+ // and set
// lastMatch.
if ((lastLine == null || !lastLine.equals(line)) && line.contains("SPDX-License-Identifier")) {
Matcher matcher = groupSelector.matcher(line);
@@ -108,12 +115,18 @@ private boolean check(String line, Match caller) {
return (lastMatch != null) && caller.spdxId.equals(lastMatch.spdxId);
}
- public class Match extends AbstractSimpleMatcher {
-
+ @ConfigComponent(type = ComponentType.MATCHER, name = "spdx", desc = "Matches SPDX enclosed license identifier.")
+ public class Match extends AbstractHeaderMatcher {
+ @ConfigComponent(type = ComponentType.PARAMETER, name = "name", desc = "The SPDX identifier string")
String spdxId;
+
+ public String getName() {
+ return spdxId;
+ }
+
/**
* Constructor.
- *
+ *
* @param spdxId A regular expression that matches the @{short-name} of the SPDX
* Identifier.
*/
@@ -124,15 +137,14 @@ public class Match extends AbstractSimpleMatcher {
}
@Override
- protected boolean doMatch(String line) {
- return SPDXMatcherFactory.this.check(line, this);
+ public boolean matches(IHeaders headers) {
+ return SPDXMatcherFactory.this.check(headers.raw(), this);
}
-
+
@Override
public void reset() {
super.reset();
SPDXMatcherFactory.this.lastMatch = null;
-
}
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SimpleRegexMatcher.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SimpleRegexMatcher.java
index 641f7ab43..991de867c 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SimpleRegexMatcher.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SimpleRegexMatcher.java
@@ -20,32 +20,38 @@
import java.util.regex.Pattern;
+import org.apache.rat.analysis.IHeaders;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.ConfigComponent;
+
/**
* A simple regular expression matching IHeaderMatcher
*/
-public class SimpleRegexMatcher extends AbstractSimpleMatcher {
+@ConfigComponent(type = ComponentType.MATCHER, name = "regex", desc = "Performs a regex match using the enclosed the text")
+public class SimpleRegexMatcher extends AbstractHeaderMatcher {
+
+ @ConfigComponent(type = ComponentType.PARAMETER, desc = "The pattern to match", name="expr", parameterType = String.class)
private final Pattern pattern;
/**
- * Constructs a regex pattern matcher with a unique random id and the specified Regex pattern.
- * @param pattern the pattern to match. Pattern will only match a single line from the input stream.
- */
- public SimpleRegexMatcher(Pattern pattern) {
- this(null, pattern);
- }
-
- /**
- * Constructs a regex pattern matcher with a unique random id and the specified Regex pattern.
- * @param id the id for this matcher
- * @param pattern the pattern to match. Pattern will only match a single line from the input stream.
+ * Constructs a regex pattern matcher with a unique random id and the specified
+ * Regex pattern.
+ *
+ * @param id the id for this matcher, may be null
+ * @param pattern the pattern to match. Pattern will only match a single line
+ * from the input stream.
*/
public SimpleRegexMatcher(String id, Pattern pattern) {
super(id);
this.pattern = pattern;
}
+ public String getPattern() {
+ return pattern.pattern();
+ }
+
@Override
- public boolean doMatch(String line) {
- return pattern.matcher(line).find();
+ public boolean matches(IHeaders headers) {
+ return pattern.matcher(headers.raw()).find();
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SimpleTextMatcher.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SimpleTextMatcher.java
index f7ae6ef90..509ea929a 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SimpleTextMatcher.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SimpleTextMatcher.java
@@ -19,36 +19,50 @@
package org.apache.rat.analysis.matchers;
import org.apache.commons.lang3.StringUtils;
+import org.apache.rat.analysis.IHeaders;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.ConfigComponent;
/**
* A simple text matching IHeaderMatcher implementation.
*/
-public class SimpleTextMatcher extends AbstractSimpleMatcher {
- private final String pattern;
+@ConfigComponent(type = ComponentType.MATCHER, name = "text", desc = "Matches the enclosed text")
+public class SimpleTextMatcher extends AbstractHeaderMatcher {
+
+ @ConfigComponent(type = ComponentType.PARAMETER, name = "simpleText", desc = "The text to match", required=true)
+ private final String simpleText;
/**
* Constructs the simple text matcher for the simple string.
- * @param pattern The pattern to match. Will only match a single line from the input stream.
+ *
+ * @param simpleText The pattern to match. Will only match a single line from
+ * the input stream.
*/
- public SimpleTextMatcher(String pattern) {
- this(null, pattern);
+ public SimpleTextMatcher(String simpleText) {
+ this(null, simpleText);
}
/**
* Constructs the simple text matcher for the simple string.
+ *
* @param id The id for this matcher.
- * @param pattern The pattern to match. Will only match a single line from the input stream.
+ * @param simpleText The pattern to match. Will only match a single line from
+ * the input stream.
*/
- public SimpleTextMatcher(String id, String pattern) {
+ public SimpleTextMatcher(String id, String simpleText) {
super(id);
- if (StringUtils.isBlank(pattern)) {
- throw new IllegalArgumentException("Pattern may not be null, empty or blank");
+ if (StringUtils.isBlank(simpleText)) {
+ throw new IllegalArgumentException("Simple text may not be null, empty or blank");
}
- this.pattern = pattern;
+ this.simpleText = simpleText;
+ }
+
+ public String getSimpleText() {
+ return this.simpleText;
}
@Override
- public boolean doMatch(String line) {
- return line.contains(pattern);
+ public boolean matches(IHeaders headers) {
+ return headers.raw().contains(simpleText);
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/annotation/ApacheV2LicenseAppender.java b/apache-rat-core/src/main/java/org/apache/rat/annotation/ApacheV2LicenseAppender.java
index 8c4ccf7d0..34c6dec84 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/annotation/ApacheV2LicenseAppender.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/annotation/ApacheV2LicenseAppender.java
@@ -36,6 +36,7 @@ public class ApacheV2LicenseAppender extends AbstractLicenseAppender {
/**
* Create a license appender with the standard ASF license header.
+ * @param log The log to use during processing.
*/
public ApacheV2LicenseAppender(final Log log) {
super(log);
@@ -45,7 +46,8 @@ public ApacheV2LicenseAppender(final Log log) {
* Create a license appender with the given copyright line. This should be of
* the form "Copyright 2008 Foo"
*
- * @param copyright copyright line.
+ * @param log The log to use during processing.
+ * @param copyright copyright line to add to the headers.
*/
public ApacheV2LicenseAppender(final Log log, String copyright) {
super(log);
diff --git a/apache-rat-core/src/main/java/org/apache/rat/api/Document.java b/apache-rat-core/src/main/java/org/apache/rat/api/Document.java
index 9cf8d1413..71f8a47f5 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/api/Document.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/api/Document.java
@@ -24,7 +24,26 @@
import org.apache.rat.document.CompositeDocumentException;
+/**
+ * The representation of a document being scanned.
+ */
public interface Document {
+ /**
+ * An enumeraton of document types.
+ */
+ enum Type {
+ /** A generated document. */
+ GENERATED,
+ /** An unknown document type. */
+ UNKNOWN,
+ /** An archive type document. */
+ ARCHIVE,
+ /** A notice document (e.g. LICENSE file) */
+ NOTICE,
+ /** A binary file */
+ BINARY,
+ /** A standard document */
+ STANDARD}
/**
* @return the name of the current document.
@@ -42,19 +61,19 @@ public interface Document {
/**
* Streams the document's contents.
- * @return not null
+ * @return a non null input stream of the document.
* @throws IOException when stream could not be opened
*/
InputStream inputStream() throws IOException;
/**
* Gets data describing this resource.
- * @return not null
+ * @return a non null MetaData object.
*/
MetaData getMetaData();
/**
- * Is this a composite document?
+ * Tests if this a composite document.
* @return true if composite, false otherwise
*/
boolean isComposite();
diff --git a/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java b/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java
index 201f7f783..4acbbe3d4 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java
@@ -18,340 +18,128 @@
*/
package org.apache.rat.api;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Iterator;
-import java.util.List;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.SortedSet;
+import java.util.TreeSet;
+import java.util.stream.Stream;
-import org.apache.commons.lang3.StringUtils;
import org.apache.rat.license.ILicense;
+import org.apache.rat.license.ILicenseFamily;
/**
* Data about the document under test..
*/
public class MetaData {
- public static final String RAT_BASE_URL = "http://org/apache/rat/meta-data";
-
- // Document Categories
- public static final String RAT_URL_DOCUMENT_CATEGORY = RAT_BASE_URL + "#FileCategory";
- public static final String RAT_DOCUMENT_CATEGORY_VALUE_GENERATED = "GEN ";
- public static final String RAT_DOCUMENT_CATEGORY_VALUE_UNKNOWN = "?????";
- public static final String RAT_DOCUMENT_CATEGORY_VALUE_ARCHIVE = "archive";
- public static final String RAT_DOCUMENT_CATEGORY_VALUE_NOTICE = "notice";
- public static final String RAT_DOCUMENT_CATEGORY_VALUE_BINARY = "binary";
- public static final String RAT_DOCUMENT_CATEGORY_VALUE_STANDARD = "standard";
- public static final Datum RAT_DOCUMENT_CATEGORY_DATUM_GENERATED = new Datum(RAT_URL_DOCUMENT_CATEGORY, RAT_DOCUMENT_CATEGORY_VALUE_GENERATED);
- public static final Datum RAT_DOCUMENT_CATEGORY_DATUM_UNKNOWN = new Datum(RAT_URL_DOCUMENT_CATEGORY, RAT_DOCUMENT_CATEGORY_VALUE_UNKNOWN);
- public static final Datum RAT_DOCUMENT_CATEGORY_DATUM_ARCHIVE = new Datum(RAT_URL_DOCUMENT_CATEGORY, RAT_DOCUMENT_CATEGORY_VALUE_ARCHIVE);
- public static final Datum RAT_DOCUMENT_CATEGORY_DATUM_NOTICE = new Datum(RAT_URL_DOCUMENT_CATEGORY, RAT_DOCUMENT_CATEGORY_VALUE_NOTICE);
- public static final Datum RAT_DOCUMENT_CATEGORY_DATUM_BINARY = new Datum(RAT_URL_DOCUMENT_CATEGORY, RAT_DOCUMENT_CATEGORY_VALUE_BINARY);
- public static final Datum RAT_DOCUMENT_CATEGORY_DATUM_STANDARD = new Datum(RAT_URL_DOCUMENT_CATEGORY, RAT_DOCUMENT_CATEGORY_VALUE_STANDARD);
-
- // Header Categories
- public static final String RAT_URL_HEADER_CATEGORY = RAT_BASE_URL + "#HeaderCategory";
-
- // License Family Categories
- public static final String RAT_URL_LICENSE_FAMILY_CATEGORY= RAT_BASE_URL + "#LicenseFamilyCategory";
- // Shortcuts used in report output, must be exactly 5 characters
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN = "GEN ";
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN = "?????";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_ASL = "AL ";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_OASIS = "OASIS";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD = "W3CD ";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C = "W3C ";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO = "DOJO ";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_TMF = "TMF ";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL1 ="GPL1 ";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL2 ="GPL2 ";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL3 = "GPL3 ";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_MIT = "MIT ";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_CDDL1 = "CDDL1";
-
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GEN = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY, RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN);
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_UNKNOWN = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY, RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_ASL = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY, RAT_LICENSE_FAMILY_CATEGORY_VALUE_ASL);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_OASIS = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY, RAT_LICENSE_FAMILY_CATEGORY_VALUE_OASIS);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3CD = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY, RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3C = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY, RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_DOJO = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY, RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_TMF = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY, RAT_LICENSE_FAMILY_CATEGORY_VALUE_TMF);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL1 = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY,RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL1);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL2 = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY,RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL2);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL3 = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY,RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL3);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_MIT = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY,RAT_LICENSE_FAMILY_CATEGORY_VALUE_MIT);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_CDLL1 = new Datum(RAT_URL_LICENSE_FAMILY_CATEGORY,RAT_LICENSE_FAMILY_CATEGORY_VALUE_CDDL1);
-
- // License Family Standard Names
- public static final String RAT_URL_LICENSE_FAMILY_NAME= RAT_BASE_URL + "#LicenseFamilyName";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT = "W3C Software Copyright";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_NAME_VALUE_W3C_DOCUMENT_COPYRIGHT = "W3C Document Copyright";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE = "OASIS Open License";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE = "Modified BSD License";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0 = "Apache License Version 2.0";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_1 =
- "GNU General Public License, version 1";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_2 =
- "GNU General Public License, version 2";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_3 =
- "GNU General Public License, version 3";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_NAME_VALUE_MIT =
- "The MIT License";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_NAME_VALUE_CDDL1 =
- "COMMON DEVELOPMENT AND DISTRIBUTION LICENSE Version 1.0";
- @Deprecated
- public static final String RAT_LICENSE_FAMILY_NAME_VALUE_ACADEMIC_FREE_LICENSE_VERSION_2_1 = "Academic Free License, Version 2.1";
-
- public static final String RAT_LICENSE_FAMILY_NAME_VALUE_UNKNOWN = "?????";
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_NAME_DATUM_W3C_SOFTWARE_COPYRIGHT
- = new Datum(RAT_URL_LICENSE_FAMILY_NAME, RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_NAME_DATUM_W3C_DOCUMENT_COPYRIGHT
- = new Datum(RAT_URL_LICENSE_FAMILY_NAME, RAT_LICENSE_FAMILY_NAME_VALUE_W3C_DOCUMENT_COPYRIGHT);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_NAME_DATUM_OASIS_OPEN_LICENSE
- = new Datum(RAT_URL_LICENSE_FAMILY_NAME, RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_NAME_DATUM_MODIFIED_BSD_LICENSE
- = new Datum(RAT_URL_LICENSE_FAMILY_NAME, RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_NAME_DATUM_APACHE_LICENSE_VERSION_2_0
- = new Datum(RAT_URL_LICENSE_FAMILY_NAME, RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0);
- @Deprecated
- public static final Datum
- RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_1 = new Datum(RAT_URL_LICENSE_FAMILY_NAME, RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_1);
- @Deprecated
- public static final Datum
- RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_2 = new Datum(RAT_URL_LICENSE_FAMILY_NAME, RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_2);
- @Deprecated
- public static final Datum
- RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_3 = new Datum(RAT_URL_LICENSE_FAMILY_NAME, RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_3);
- @Deprecated
- public static final Datum
- RAT_LICENSE_FAMILY_NAME_DATUM_MIT = new Datum(RAT_URL_LICENSE_FAMILY_NAME, RAT_LICENSE_FAMILY_NAME_VALUE_MIT);
- @Deprecated
- public static final Datum
- RAT_LICENSE_FAMILY_NAME_DATUM_CDDL1 = new Datum(RAT_URL_LICENSE_FAMILY_NAME, RAT_LICENSE_FAMILY_NAME_VALUE_CDDL1);
- @Deprecated
- public static final Datum RAT_LICENSE_FAMILY_NAME_DATUM_ACADEMIC_FREE_LICENSE_VERSION_2_1
- = new Datum(RAT_URL_LICENSE_FAMILY_NAME, RAT_LICENSE_FAMILY_NAME_VALUE_ACADEMIC_FREE_LICENSE_VERSION_2_1);
+ /** The list of matched licenses */
+ private final SortedSet matchedLicenses;
+ /** The list of License Family Categories that are approved */
+ private final Set approvedLicenses;
- public static final Datum RAT_LICENSE_FAMILY_NAME_DATUM_UNKNOWN
- = new Datum(RAT_URL_LICENSE_FAMILY_NAME, RAT_LICENSE_FAMILY_NAME_VALUE_UNKNOWN);
-
- // Header sample
- public static final String RAT_URL_HEADER_SAMPLE = RAT_BASE_URL + "#HeaderSample";
-
- // License Approval
- public static final String RAT_URL_APPROVED_LICENSE = RAT_BASE_URL + "#ApprovedLicense";
- public static final String RAT_APPROVED_LICENSE_VALUE_TRUE = Boolean.TRUE.toString();
- public static final String RAT_APPROVED_LICENSE_VALUE_FALSE = Boolean.FALSE.toString();
- public static final Datum RAT_APPROVED_LICENSE_DATUM_TRUE = new Datum(RAT_URL_APPROVED_LICENSE, RAT_APPROVED_LICENSE_VALUE_TRUE);
- public static final Datum RAT_APPROVED_LICENSE_DATUM_FALSE = new Datum(RAT_URL_APPROVED_LICENSE, RAT_APPROVED_LICENSE_VALUE_FALSE);
- @Deprecated
- public static final Datum RAT_APPROVED_LICENSE_DATIM_TRUE = RAT_APPROVED_LICENSE_DATUM_TRUE;
- @Deprecated
- public static final Datum RAT_APPROVED_LICENSE_DATIM_FALSE = RAT_APPROVED_LICENSE_DATUM_FALSE;
-
- /**
- * Only likely to be a small quantity of data
- * so trade some performance for simplicity.
- */
- private final List data;
+ private Document.Type documentType;
+ private String sampleHeader;
/**
* Create metadata without a content type.
*/
public MetaData() {
- this.data = new ArrayList<>(16);
+ this.matchedLicenses = new TreeSet<>();
+ this.approvedLicenses = new HashSet<>();
}
-
+
/**
- * Add the license information to the metadata.
- * @param license the license to add metadata for.
+ * Determines if a matching license has been detected.
+ * @return true if there is a matching license.
*/
- public void reportOnLicense(ILicense license) {
-
- if (StringUtils.isNotBlank(license.getNotes())) {
- set(new MetaData.Datum(MetaData.RAT_URL_HEADER_SAMPLE, license.getNotes()));
- }
- set(new MetaData.Datum(MetaData.RAT_URL_HEADER_CATEGORY, license.getLicenseFamily().getFamilyCategory()));
- set(new MetaData.Datum(MetaData.RAT_URL_LICENSE_FAMILY_CATEGORY, license.getLicenseFamily().getFamilyCategory()));
- set(new MetaData.Datum(MetaData.RAT_URL_LICENSE_FAMILY_NAME, license.getLicenseFamily().getFamilyName()));
+ public boolean detectedLicense() {
+ return !matchedLicenses.isEmpty();
}
-
/**
- * Gets all data.
- * @return unmodifiable view of the meta data.
+ * Sets the set of approved licenses.
+ * @param approvedLicenseFamilies the set of approved license families.
*/
- public Collection getData() {
- return Collections.unmodifiableCollection(data);
+ public void setApprovedLicenses(Set approvedLicenseFamilies) {
+ licenses().filter(lic -> approvedLicenseFamilies.contains(lic.getLicenseFamily()))
+ .forEach(lic -> approvedLicenses.add(lic.getId()));
}
-
+
/**
- * Adds a new datum.
- * Existing data with the same name are not replaced.
- * @param datum datum to add.
- * @see #set(org.apache.rat.api.MetaData.Datum)
+ * Gets the stream of licenses that have been matched.
+ * @return the stream of licenses that have been matched.
*/
- public void add(final Datum datum) {
- data.add(datum);
+ public Stream licenses() {
+ return matchedLicenses.stream();
}
-
+
/**
- * Puts in a new datum replacing any existing data.
- * Any current data matching the name are removed.
- * @param datum not null
- * @see #add(org.apache.rat.api.MetaData.Datum)
+ * Gets the stream of approved licenses that have been matched.
+ * @return the stream of approved licenses that have been matched.
*/
- public void set(final Datum datum) {
- clear(datum.getName());
- add(datum);
+ public Stream approvedLicenses() {
+ return licenses().filter(this::isApproved);
}
-
+
/**
- * Gets the first datum matching the given name.
- * @param name not null
- * @return the matching datum first added when there is any matching data,
- * null otherwise
+ * Determine if the license is an approved license.
+ * @param license the license to check;
+ * @return {@code true} if the license is in the list of approved licenses, {@code false} otherwise.
*/
- public Datum get(final String name) {
- Datum result = null;
- for (Datum next : data) {
- if (name.equals(next.getName())) {
- result = next;
- break;
- }
- }
- return result;
+ public boolean isApproved(ILicense license) {
+ return approvedLicenses.contains(license.getId());
}
-
+
/**
- * Gets the value of the first datum matching the given name.
- * @param name not null
- * @return the value of the matchin datum first added when there is any matching data,
- * null otherwise
+ * Gets the stream of unapproved licenses that have been matched.
+ * @return the stream of unapproved licenses that have been matched.
*/
- public String value(final String name) {
- final Datum datum = get(name);
- final String result;
- if (datum == null) {
- result = null;
- } else {
- result = datum.getValue();
- }
- return result;
+ public Stream unapprovedLicenses() {
+ return licenses().filter(lic -> !isApproved(lic));
}
-
+
/**
- * Removes all data matching the given name.
- * @param name not null
- * @return true if any data match, false otherwise
+ * Sets the sample header. This is the header that was collected during processing.
+ * @param sampleHeader the sample header to use.
*/
- public boolean clear(final String name) {
- boolean dataRemoved = false;
- for (final Iterator it = data.iterator();it.hasNext();) {
- final Datum datum = it.next();
- if (datum.getName().equals(name)) {
- it.remove();
- dataRemoved = true;
- }
- }
- return dataRemoved;
+ public void setSampleHeader(String sampleHeader) {
+ this.sampleHeader = sampleHeader;
}
-
+
/**
- * Clears all data.
+ * Gets the sample header.
+ * @return the smaple header.
*/
- public void clear() {
- data.clear();
+ public String getSampleHeader() {
+ return sampleHeader;
}
-
+
+ /**
+ * Sets the document type.
+ * @param type the document type for the document being recorded.
+ */
+ public void setDocumentType(Document.Type type) {
+ this.documentType = type;
+ }
+
/**
- * A datum.
+ * Gets the document type.
+ * @return the document type of the document that was recorded.
*/
- public static final class Datum {
- private final String name;
- private final String value;
-
- /**
- * Constructs a datum.
- * @param name not null
- * @param value not null
- */
- public Datum(final String name, final String value) {
- super();
- this.name = name;
- this.value = value;
- }
-
- /**
- * Gets the name of the data type.
- * To avoid collisions, it is recommended that URLs are used.
- * @return not null
- */
- public String getName() {
- return name;
- }
-
- /**
- * Data type value.
- * @return not null
- */
- public String getValue() {
- return value;
- }
+ public Document.Type getDocumentType() {
+ return this.documentType;
+ }
- /**
- * Constructs a String with all attributes
- * in name = value format.
- *
- * @return a String representation
- * of this object.
- */
- @Override
- public String toString()
- {
- return "Datum [ "
- + "name ='" + this.name + "',"
- + "value ='" + this.value + " "
- + "']";
- }
+ /**
+ * Add the license information to the metadata.
+ * @param license the license to add metadata for.
+ */
+ public void reportOnLicense(ILicense license) {
+ this.matchedLicenses.add(license);
+ }
+
+ @Override
+ public String toString() {
+ return String.format( "MetaData[%s license, %s approved]", matchedLicenses.size(), approvedLicenses.size());
}
}
-
\ No newline at end of file
diff --git a/apache-rat-core/src/main/java/org/apache/rat/api/RatException.java b/apache-rat-core/src/main/java/org/apache/rat/api/RatException.java
index 9d5c2c3a0..019a21124 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/api/RatException.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/api/RatException.java
@@ -19,9 +19,20 @@
package org.apache.rat.api;
public class RatException extends Exception {
+
+ public static RatException asRatException(Exception e) {
+ return e instanceof RatException ? (RatException) e : new RatException(e);
+ }
private static final long serialVersionUID = 4940711222435919034L;
+ public static RatException makeInstance(Exception e) {
+ if (e instanceof RatException) {
+ return (RatException) e;
+ }
+ return new RatException(e);
+ }
+
public RatException() {
super();
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/config/AddLicenseHeaders.java b/apache-rat-core/src/main/java/org/apache/rat/config/AddLicenseHeaders.java
index 523aa6eb0..b64361b95 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/config/AddLicenseHeaders.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/config/AddLicenseHeaders.java
@@ -23,8 +23,11 @@
* Value of addLicenseHeaders configuration option.
*/
public enum AddLicenseHeaders {
- TRUE, //
- FALSE, //
+ /** Add license headers to a *.new file*/
+ TRUE,
+ /** Do not add headers */
+ FALSE,
+ /** Add headers and overwrite the old file */
FORCED;
private static final char SEPARATOR = '|';
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/TextCaptureBuilder.java b/apache-rat-core/src/main/java/org/apache/rat/config/parameters/ComponentType.java
similarity index 59%
rename from apache-rat-core/src/main/java/org/apache/rat/configuration/builders/TextCaptureBuilder.java
rename to apache-rat-core/src/main/java/org/apache/rat/config/parameters/ComponentType.java
index 8ad765974..bdddbb576 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/TextCaptureBuilder.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/config/parameters/ComponentType.java
@@ -16,11 +16,18 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.rat.configuration.builders;
+package org.apache.rat.config.parameters;
-/**
- * A marker interface for builders that accept text plain text to match.
+/**
+ * Types of components
*/
-public interface TextCaptureBuilder {
- T setText(String text);
-}
+public enum ComponentType {
+ /** A License, the top level component. May not be used as a child of any component type. */
+ LICENSE,
+ /** A Matcher */
+ MATCHER,
+ /** A Parameter for example the "id" parameter found in every component */
+ PARAMETER,
+ /** A parameter that is supplied by the environment. Currently systems using builders have to handle seting this. For example the list of matchers for the "MatcherRefBuilder" */
+ BULID_PARAMETER
+}
\ No newline at end of file
diff --git a/apache-rat-core/src/main/java/org/apache/rat/config/parameters/ConfigComponent.java b/apache-rat-core/src/main/java/org/apache/rat/config/parameters/ConfigComponent.java
new file mode 100644
index 000000000..c13260432
--- /dev/null
+++ b/apache-rat-core/src/main/java/org/apache/rat/config/parameters/ConfigComponent.java
@@ -0,0 +1,61 @@
+/*
+ * 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.config.parameters;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * An annotation that marks a configuration component.
+ *
+ */
+@Target({ElementType.FIELD, ElementType.TYPE, ElementType.METHOD})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface ConfigComponent {
+ /**
+ * The common name for the component. If not specified the name of the field or class is used.
+ * @return the component name.
+ */
+ String name() default "";
+
+ /**
+ * The description of the component.
+ * @return the component description.
+ */
+ String desc() default "";
+ /**
+ * The component type
+ * @return the component type.
+ */
+ ComponentType type();
+
+ /**
+ * For collections defines the enclosed type.
+ * @return the enclosed type.
+ */
+ Class parameterType() default void.class;
+
+ /**
+ * if {@code true} this component can be child of the containing component
+ * @return {@code true} if this component can be child of the containing component
+ */
+ boolean required() default false;
+}
\ No newline at end of file
diff --git a/apache-rat-core/src/main/java/org/apache/rat/config/parameters/Description.java b/apache-rat-core/src/main/java/org/apache/rat/config/parameters/Description.java
new file mode 100644
index 000000000..bbf01f3f1
--- /dev/null
+++ b/apache-rat-core/src/main/java/org/apache/rat/config/parameters/Description.java
@@ -0,0 +1,363 @@
+/*
+ * 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.config.parameters;
+
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Map;
+import java.util.TreeMap;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.rat.BuilderParams;
+import org.apache.rat.ConfigurationException;
+import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.utils.Log;
+
+/**
+ * A description of a component.
+ */
+public class Description {
+ /** The type of component this describes */
+ private final ComponentType type;
+ /**
+ * The common name for the component. Set by ConfigComponent.name() or
+ * class/field name.
+ */
+ private final String name;
+ /** The description for the component */
+ private final String desc;
+ /** The class of the getter/setter parameter */
+ private final Class childClass;
+ /** True if the getter/setter expects a collection of childClass objects */
+ private final boolean isCollection;
+ /** True if this component is required. */
+ private final boolean required;
+ /**
+ * A map of name to Description for all the components that are children of the
+ * described component.
+ */
+ private final Map children;
+
+ public static Predicate typePredicate(ComponentType type) {
+ return (d) -> d.getType() == type;
+ }
+
+ /**
+ * Constructor.
+ *
+ * @param type the type of the component.
+ * @param name the name of the component.
+ * @param desc the description of the component.
+ * @param isCollection true if the getter/setter expects a collection
+ * @param childClass the class for expected for the getter/setter.
+ * @param children the collection of descriptions for all the components that
+ * are children of the described component.
+ */
+ public Description(ComponentType type, String name, String desc, boolean isCollection, Class childClass,
+ Collection children, boolean required) {
+ this.type = type;
+ this.name = name;
+ this.desc = desc;
+ this.isCollection = isCollection;
+ this.required = required;
+ if (type == ComponentType.BULID_PARAMETER) {
+ Method m;
+ try {
+ m = BuilderParams.class.getMethod(name);
+ } catch (NoSuchMethodException | SecurityException e) {
+ throw new ConfigurationException(String.format("'%s' is not a valid BuildParams method", name));
+ }
+ this.childClass = m.getReturnType();
+ } else {
+ this.childClass = childClass;
+ }
+ this.children = new TreeMap<>();
+ if (children != null) {
+ children.forEach(d -> {
+ this.children.put(d.name, d);
+ });
+ }
+ }
+
+ /**
+ * Constructor
+ *
+ * @param configComponent the configuration component
+ * @param isCollection the collection flag.
+ * @param childClass the type of object that the method getter/setter expects.
+ * @param children the collection of descriptions for all the components that
+ * are children the described component.
+ */
+ public Description(ConfigComponent configComponent, boolean isCollection, Class childClass,
+ Collection children) {
+ this(configComponent.type(), configComponent.name(), configComponent.desc(), isCollection, childClass, children,
+ configComponent.required());
+ }
+
+ /**
+ * Get the canBeChild flag.
+ *
+ * @return {@code true} if this item can be a child of the containing item.
+ */
+ public boolean isRequired() {
+ return required;
+ }
+
+ /**
+ * Gets the type of the component.
+ *
+ * @return the component type.
+ */
+ public ComponentType getType() {
+ return type;
+ }
+
+ /**
+ * Get the isCollection flag.
+ *
+ * @return true if this is a collection.
+ */
+ public boolean isCollection() {
+ return isCollection;
+ }
+
+ /**
+ * Get the class of the objects for the getter/setter methods.
+ *
+ * @return the getter/setter param class.
+ */
+ public Class getChildType() {
+ return childClass;
+ }
+
+ /**
+ * Gets the common name for the matcher. (e.g. 'text', 'spdx', etc.) May not be
+ * null.
+ *
+ * @return The common name for the item being inspected.
+ */
+ public String getCommonName() {
+ return name;
+ }
+
+ /**
+ * Gets the description of descriptive text for the component. May be an empty
+ * string or null.
+ *
+ * @return the descriptive text;
+ */
+ public String getDescription() {
+ return desc;
+ }
+
+ /**
+ * Retrieve the value of a the described parameter from the specified object.
+ *
+ * If the parameter is a collection return {@code null}.
+ *
+ * @param log the Log to log issues to.
+ * @param object the object that contains the value.
+ * @return the string value.
+ */
+ public String getParamValue(Log log, Object object) {
+ if (isCollection) {
+ return null;
+ }
+ try {
+ Object val = getter(object.getClass()).invoke(object);
+ return val == null ? null : val.toString();
+ } catch (IllegalArgumentException | IllegalAccessException | InvocationTargetException | NoSuchMethodException
+ | SecurityException e) {
+ log.error(System.err.format("Can not retrieve value for '%s' from %s%n", name, object.getClass().getName()),
+ e);
+ return null;
+ }
+ }
+
+ /**
+ * Gets a map of the parameters that the object contains. For example Copyright
+ * has 'start', 'stop', and 'owner' parameters. Some IHeaderMatchers have simple
+ * text values (e.g. 'regex' or 'text' types) these should list an unnamed
+ * parameter (empty string) with the text value.
+ *
+ * @return the map of parameters to the objects that represent them.
+ */
+ public Map getChildren() {
+ return children;
+ }
+
+ /**
+ * Get all the children of a specific type
+ *
+ * @param type the type to return
+ * @return the collection of children of the specified type.
+ */
+ public Collection childrenOfType(ComponentType type) {
+ return filterChildren(d -> d.getType() == type);
+ }
+
+ /**
+ * Get a filtered collection of the child descriptions.
+ *
+ * @param filter the filter to apply to the child descriptions.
+ * @return the collection of children that matche the filter..
+ */
+ public Collection filterChildren(Predicate filter) {
+ return children.values().stream().filter(filter).collect(Collectors.toList());
+ }
+
+ /**
+ * Generate a method name for this description.
+ *
+ * @param prefix the start of the method name (e.g. "set", "get" )
+ * @return the method name.
+ */
+ public String methodName(String prefix) {
+ return prefix + StringUtils.capitalize(name);
+ }
+
+ /**
+ * Returns the getter for the component in the specified class.
+ *
+ * @param clazz the Class to get the getter from.
+ * @return the getter Method.
+ * @throws NoSuchMethodException if the class does not have the getter.
+ * @throws SecurityException if the getter can not be accessed.
+ */
+ public Method getter(Class clazz) throws NoSuchMethodException, SecurityException {
+ return clazz.getMethod(methodName("get"));
+ }
+
+ /**
+ * Returns the setter for the component in the specified class. Notes:
+ *
+ * - License can not be set in components. They are top level components.
+ * - Matcher expects an "add" method that accepts an
+ * IHeaderMatcher.Builder.
+ * - Parameter expects a {@code set(String)} method.
+ * - Unlabeled expects a {@code set(String)} method.
+ * - BuilderParam expects a {@code set} method that takes a
+ * {@code childeClass} argument.
+ *
+ *
+ * @param clazz the Class to get the getter from, generally a Builder class..
+ * @return the getter Method.
+ * @throws NoSuchMethodException if the class does not have the getter.
+ * @throws SecurityException if the getter can not be accessed.
+ */
+ public Method setter(Class clazz) throws NoSuchMethodException, SecurityException {
+ String methodName = methodName(isCollection ? "add" : "set");
+ switch (type) {
+ case LICENSE:
+ throw new NoSuchMethodException("Can not set a License as a child");
+ case MATCHER:
+ return clazz.getMethod(methodName, IHeaderMatcher.Builder.class);
+ case PARAMETER:
+ return clazz.getMethod(methodName,
+ IHeaderMatcher.class.isAssignableFrom(childClass) ? IHeaderMatcher.Builder.class : childClass);
+ case BULID_PARAMETER:
+ return clazz.getMethod(methodName, childClass);
+ }
+ // should not happen
+ throw new IllegalStateException("Type " + type + " not valid.");
+ }
+
+ private void callSetter(Log log, Description description, IHeaderMatcher.Builder builder, String value) {
+ try {
+ description.setter(builder.getClass()).invoke(builder, value);
+ } catch (NoSuchMethodException e) {
+ String msg = String.format("No setter for '%s' on %s", description.getCommonName(),
+ builder.getClass().getCanonicalName());
+ log.error(msg);
+ throw new ConfigurationException(msg);
+ } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException | SecurityException e) {
+ String msg = String.format("Unable to call setter for '%s' on %s", description.getCommonName(),
+ builder.getClass().getCanonicalName());
+ log.error(msg, e);
+ throw new ConfigurationException(msg, e);
+ }
+ }
+
+ /**
+ * Sets the children of values in the builder. Sets the parameters to the values
+ * specified in the map. Only children that accept string arguments should be
+ * specified.
+ *
+ * @param log The log to write messages to.
+ * @param builder The Matcher builder to set the values in.
+ * @param attributes a Map of parameter names to values.
+ */
+ public void setChildren(Log log, IHeaderMatcher.Builder builder, Map attributes) {
+ attributes.entrySet().forEach(entry -> setChild(log, builder, entry.getKey(), entry.getValue()));
+ }
+
+ /**
+ * Sets the child value in the builder.
+ *
+ * @param log The log to write messages to.
+ * @param builder The Matcher builder to set the values in.
+ * @param name the name of the child to set
+ * @param value the value of the parameter.
+ */
+ public void setChild(Log log, IHeaderMatcher.Builder builder, String name, String value) {
+ Description d = getChildren().get(name);
+ if (d == null) {
+ log.error(String.format("%s does not define a ConfigComponent for a member %s.",
+ builder.getClass().getCanonicalName(), name));
+ } else {
+ callSetter(log, d, builder, value);
+ }
+ }
+
+ @Override
+ public String toString() {
+ String childList = children.isEmpty() ? ""
+ : String.join(", ",
+ children.values().stream().map(Description::getCommonName).collect(Collectors.toList()));
+
+ return String.format("Description[%s t:%s c:%s %s children: [%s]] ", name, type, isCollection, childClass,
+ childList);
+ }
+
+ /**
+ * Write a description with indentation.
+ *
+ * @param indent the number of spaces to indent.
+ * @return the string with the formatted data.
+ */
+ public String toString(int indent) {
+ char[] spaces = new char[indent];
+ Arrays.fill(spaces, ' ');
+ String padding = String.copyValueOf(spaces);
+ String top = String.format("%sDescription[ t:%s n:%s c:%s %s%n%s %s] ", padding, type, name, isCollection,
+ childClass, padding, desc);
+ if (children.isEmpty()) {
+ return top;
+ }
+ StringBuilder sb = new StringBuilder(top);
+ for (Description child : children.values()) {
+ sb.append(System.lineSeparator()).append(child.toString(indent + 2));
+ }
+ return sb.toString();
+ }
+}
\ No newline at end of file
diff --git a/apache-rat-core/src/main/java/org/apache/rat/config/parameters/DescriptionBuilder.java b/apache-rat-core/src/main/java/org/apache/rat/config/parameters/DescriptionBuilder.java
new file mode 100644
index 000000000..8bd97e252
--- /dev/null
+++ b/apache-rat-core/src/main/java/org/apache/rat/config/parameters/DescriptionBuilder.java
@@ -0,0 +1,140 @@
+/*
+ * 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.config.parameters;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.rat.ConfigurationException;
+import org.apache.rat.ImplementationException;
+import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.license.ILicense;
+
+/**
+ * Builds Description objects for the various Component instances.
+ */
+public class DescriptionBuilder {
+ /* do not instantiate */
+ private DescriptionBuilder() {}
+
+ /**
+ * Create the description for the object.
+ * The object must have a ConfigComponent annotation or null will be returned.
+ * @param obj the object to process.
+ * @return the Description of the object.
+ */
+ public static Description build(Object obj) {
+ if (obj instanceof ILicense) {
+ ILicense license = (ILicense)obj;
+ Class clazz = obj.getClass();
+ ConfigComponent configComponent = clazz.getAnnotation(ConfigComponent.class);
+ if (configComponent == null || configComponent.type() != ComponentType.LICENSE) {
+ throw new ConfigurationException(String.format("Licenses must have License type specified in ConfigComponent annotation. Annotation missing or incorrect in %s", clazz));
+ }
+ List children = getConfigComponents(obj.getClass());
+ return new Description(ComponentType.LICENSE, license.getId(), license.getName(), false, null, children, false);
+ }
+ return buildMap(obj.getClass());
+ }
+
+ private static String fixupMethodName(Method method) {
+ String name = method.getName();
+ if (name.startsWith("get") || name.startsWith("set") || name.startsWith("add")) {
+ if (name.length() > 3) {
+ String retval = name.substring(3,4).toLowerCase();
+ if (name.length() > 4) {
+ retval+=name.substring(4);
+ }
+ return retval;
+ }
+ }
+ throw new ImplementationException(String.format("'%s' is not a recognized method name", name));
+ }
+ /**
+ * Build the list of descriptions for children of the class.
+ * @param clazz
+ * @return the Descriptions. of the child elements.
+ */
+ private static List getConfigComponents(Class clazz) {
+ if (clazz == null || clazz == String.class || clazz == Object.class) {
+ return Collections.emptyList();
+ }
+ List result = new ArrayList<>();
+ for (Field field : clazz.getDeclaredFields()) {
+ ConfigComponent configComponent = field.getAnnotation(ConfigComponent.class);
+ if (configComponent != null) {
+ String name = StringUtils.isBlank(configComponent.name()) ? field.getName() : configComponent.name();
+ Class childClazz = configComponent.parameterType() == void.class ? field.getType()
+ : configComponent.parameterType();
+ boolean isCollection = Iterable.class.isAssignableFrom(field.getType());
+
+ Description desc = new Description(configComponent.type(), name, configComponent.desc(), isCollection,
+ childClazz, getConfigComponents(childClazz), configComponent.required());
+ result.add(desc);
+ }
+ }
+ for (Method method : clazz.getDeclaredMethods()) {
+ ConfigComponent configComponent = method.getAnnotation(ConfigComponent.class);
+ if (configComponent != null) {
+ String name = StringUtils.isBlank(configComponent.name()) ? fixupMethodName(method) : configComponent.name();
+ Class childClazz = configComponent.parameterType() == void.class ? method.getReturnType()
+ : configComponent.parameterType();
+ boolean isCollection = Iterable.class.isAssignableFrom(method.getReturnType());
+
+ Description desc = new Description(configComponent.type(), name, configComponent.desc(), isCollection,
+ childClazz, getConfigComponents(childClazz), configComponent.required());
+ result.add(desc);
+ }
+ }
+ result.addAll(getConfigComponents(clazz.getSuperclass()));
+ Arrays.stream(clazz.getInterfaces()).forEach(c -> result.addAll(getConfigComponents(c)));
+ return result;
+ }
+
+ private static ConfigComponent findConfigComponent(Class clazz) {
+ if (clazz == null || clazz == String.class || clazz == Object.class) {
+ return null;
+ }
+ ConfigComponent configComponent = clazz.getAnnotation(ConfigComponent.class);
+ return configComponent == null ? findConfigComponent(clazz.getSuperclass()) : configComponent;
+ }
+ /**
+ * Create a description for a class.
+ * @param clazz the class to build the description for.
+ * @return the Description of the class or null if no ConfigComponent annotation was found on the class.
+ */
+ public static Description buildMap(Class clazz) {
+ if (clazz == IHeaderMatcher.class) {
+ throw new ImplementationException("'clazz' parameter must not be IHeaderMatcher.class but may be a child of it");
+ }
+ ConfigComponent configComponent = findConfigComponent(clazz);
+ if (configComponent == null) {
+ return null;
+ }
+ List children = getConfigComponents(clazz);
+
+ return new Description(configComponent, false, null, children);
+ }
+}
\ No newline at end of file
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/LicenseReader.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/LicenseReader.java
index 428137072..91fbec282 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/LicenseReader.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/LicenseReader.java
@@ -23,6 +23,7 @@
import org.apache.rat.license.ILicense;
import org.apache.rat.license.ILicenseFamily;
+import org.apache.rat.utils.Log;
/**
* An interface describing the methods of a LicenseReader.
@@ -41,7 +42,7 @@ public interface LicenseReader {
* @return A collection of ILicense.
*/
SortedSet readLicenses();
-
+
/**
* Reads the configuration and extracts instances of ILicenseFamily.
*
@@ -56,4 +57,10 @@ public interface LicenseReader {
* empty list if none specified.
*/
SortedSet approvedLicenseId();
+
+ /**
+ * Sets the logger to use during parsing.
+ * @param log the log to use.
+ */
+ void setLog(Log log);
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherBuilderTracker.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherBuilderTracker.java
index 447ad82e3..93a2cb61f 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherBuilderTracker.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherBuilderTracker.java
@@ -19,6 +19,8 @@
package org.apache.rat.configuration;
import java.lang.reflect.InvocationTargetException;
+import java.util.Collection;
+import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
@@ -34,7 +36,8 @@
*/
public class MatcherBuilderTracker {
- private static MatcherBuilderTracker INSTANCE;
+ /** The instance of the BuildTracker. */
+ public static MatcherBuilderTracker INSTANCE;
private final Map> matcherBuilders;
@@ -64,9 +67,9 @@ public static void addBuilder(String className, String name) {
public static AbstractBuilder getMatcherBuilder(String name) {
Class clazz = instance().matcherBuilders.get(name);
if (clazz == null) {
- StringBuilder sb = new StringBuilder("\nValid builders\n");
- instance().matcherBuilders.keySet().forEach(x -> sb.append(x).append("\n"));
- sb.append("ERROR MSG\n");
+ StringBuilder sb = new StringBuilder(System.lineSeparator()).append("Valid builders").append(System.lineSeparator());
+ instance().matcherBuilders.keySet().forEach(x -> sb.append(x).append(System.lineSeparator()));
+ sb.append("ERROR MSG").append(System.lineSeparator());
throw new ConfigurationException(sb.append("No matcher builder named ").append(name).toString());
}
try {
@@ -81,6 +84,15 @@ public static AbstractBuilder getMatcherBuilder(String name) {
private MatcherBuilderTracker() {
matcherBuilders = new HashMap<>();
}
+
+
+ /**
+ * Gets a collection of classes that are recognized as builders.
+ * @return the collection of builder classes
+ */
+ public Collection> getClasses() {
+ return Collections.unmodifiableCollection(matcherBuilders.values());
+ }
private void addBuilderImpl(String className, String name) {
Objects.requireNonNull(className, "className may not be null");
@@ -93,7 +105,6 @@ private void addBuilderImpl(String className, String name) {
if (AbstractBuilder.class.isAssignableFrom(clazz)) {
@SuppressWarnings("unchecked")
Class candidate = (Class) clazz;
- // String name = attributes.get(AttributeName.name);
if (StringUtils.isBlank(name)) {
name = candidate.getSimpleName();
if (!name.endsWith("Builder")) {
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherReader.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherReader.java
index d6e42253d..43e235a26 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherReader.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherReader.java
@@ -35,4 +35,5 @@ public interface MatcherReader {
* Reads the configuration and MatcherBuilder classes and adds them to Readers.
*/
void readMatcherBuilders();
+
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfig.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfig.java
new file mode 100644
index 000000000..178ffd039
--- /dev/null
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfig.java
@@ -0,0 +1,109 @@
+/*
+ * 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.configuration;
+
+import java.util.Arrays;
+
+/**
+ * Configuration definitions for XMLConfiguration reader and writer.
+ */
+public class XMLConfig {
+
+ /** id attribute name */
+ public final static String ATT_ID = "id";
+ /** name attribute name */
+ public final static String ATT_NAME = "name";
+ /** license reference attribute name */
+ public final static String ATT_LICENSE_REF = "license_ref";
+ /** class name attribute name */
+ public final static String ATT_CLASS_NAME = "class";
+ /** resource file name attribute name. */
+ public final static String ATT_RESOURCE = "resource";
+ /** root of the configuration file */
+ public final static String ROOT = "rat-config";
+ /** families element name */
+ public final static String FAMILIES = "families";
+ /** licenses element name */
+ public final static String LICENSES = "licenses";
+ /** license element name */
+ public final static String LICENSE = "license";
+ /** approved element name */
+ public final static String APPROVED = "approved";
+ /** family element name */
+ public final static String FAMILY = "family";
+ /** note element name */
+ public final static String NOTE = "note";
+ /** matchers element name */
+ public final static String MATCHERS = "matchers";
+ /** matcher element name */
+ public final static String MATCHER = "matcher";
+
+ /** License property names that should be children */
+ static final String[] LICENSE_CHILDREN = { "note", "matcher" };
+ /**
+ * License property names that should not be displayed contents should be placed
+ * inline
+ */
+ static final String[] LICENSE_INLINE = { "matcher" };
+
+ /**
+ * Matcher properties that should be directly inlined Entries are matcher node
+ * name / property name pairs. A matcher may only have one inline node and then
+ * only if there is no other non-property node.
+ */
+ static final String[][] INLINE_NODES = { { "any", "enclosed" }, { "all", "enclosed" }, { "not", "enclosed" },
+ { "text", "simpleText" } };
+
+ private XMLConfig() {
+ // do not instantiate
+ }
+
+ /**
+ * Returns true if the specified child node should be placed inline in the XML
+ * document.
+ *
+ * @param parent the parent node name.
+ * @param child the child node name.
+ * @return true if the child should be inlined.
+ */
+ public static boolean isInlineNode(String parent, String child) {
+ return Arrays.stream(INLINE_NODES).filter(s -> s[0].equals(parent) && s[1].equals(child)).findAny().isPresent();
+ }
+
+ /**
+ * Returns true if the child should be a child node of a license node, as
+ * opposed to a attribute of the license.
+ *
+ * @param child the name of the child node.
+ * @return true if the child should be a child node.
+ */
+ public static boolean isLicenseChild(String child) {
+ return Arrays.stream(LICENSE_CHILDREN).filter(s -> s.equals(child)).findAny().isPresent();
+ }
+
+ /**
+ * Return true if the child should be inlined in the parent node.
+ *
+ * @param child the name of the child node.
+ * @return true if the child should be inlined.
+ */
+ public static boolean isLicenseInline(String child) {
+ return Arrays.stream(LICENSE_INLINE).filter(s -> s.equals(child)).findAny().isPresent();
+ }
+}
\ No newline at end of file
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
index b05711b07..fdacc1a6f 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
@@ -19,86 +19,58 @@
package org.apache.rat.configuration;
import java.io.IOException;
+import java.io.Reader;
import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
import java.net.URL;
+import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
import java.util.Map;
import java.util.SortedSet;
import java.util.TreeSet;
+import java.util.function.BiPredicate;
import java.util.function.Consumer;
+import java.util.stream.Collectors;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
-import org.apache.commons.beanutils.MethodUtils;
import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.tuple.ImmutablePair;
+import org.apache.commons.lang3.tuple.Pair;
+import org.apache.rat.BuilderParams;
import org.apache.rat.ConfigurationException;
+import org.apache.rat.ImplementationException;
import org.apache.rat.analysis.IHeaderMatcher;
-import org.apache.rat.analysis.matchers.FullTextMatcher;
-import org.apache.rat.analysis.matchers.SimpleTextMatcher;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.Description;
+import org.apache.rat.config.parameters.DescriptionBuilder;
import org.apache.rat.configuration.builders.AbstractBuilder;
-import org.apache.rat.configuration.builders.ChildContainerBuilder;
-import org.apache.rat.configuration.builders.MatcherRefBuilder;
-import org.apache.rat.configuration.builders.TextCaptureBuilder;
import org.apache.rat.license.ILicense;
import org.apache.rat.license.ILicenseFamily;
import org.apache.rat.license.LicenseFamilySetFactory;
import org.apache.rat.license.LicenseSetFactory;
+import org.apache.rat.utils.DefaultLog;
+import org.apache.rat.utils.Log;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
+import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
/**
* A class that reads the XML configuration file format.
- *
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- * {@code ...}
- * {@code ... }
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- * {@code }
- *
*/
-
public class XMLConfigurationReader implements LicenseReader, MatcherReader {
- private final static String ATT_ID = "id";
- private final static String ATT_NAME = "name";
- private final static String ATT_DERIVED_FROM = "derived_from";
- private final static String ATT_LICENSE_REF = "license_ref";
- private final static String ATT_CLASS_NAME = "class";
-
- private final static String ROOT = "rat-config";
- private final static String FAMILIES = "families";
- private final static String LICENSES = "licenses";
- private final static String LICENSE = "license";
- private final static String APPROVED = "approved";
- private final static String FAMILY = "family";
- private final static String NOTE = "note";
- private final static String MATCHERS = "matchers";
- private final static String MATCHER = "matcher";
-
+ private Log log;
private Document document;
private final Element rootElement;
private final Element familiesElement;
@@ -107,7 +79,9 @@ public class XMLConfigurationReader implements LicenseReader, MatcherReader {
private final Element matchersElement;
private final SortedSet licenses;
+
private final Map matchers;
+ private final BuilderParams builderParams;
private final SortedSet licenseFamilies;
private final SortedSet approvedFamilies;
@@ -120,20 +94,40 @@ public XMLConfigurationReader() {
} catch (ParserConfigurationException e) {
throw new IllegalStateException("No XML parser defined", e);
}
- rootElement = document.createElement(ROOT);
+ rootElement = document.createElement(XMLConfig.ROOT);
document.appendChild(rootElement);
- familiesElement = document.createElement(FAMILIES);
+ familiesElement = document.createElement(XMLConfig.FAMILIES);
rootElement.appendChild(familiesElement);
- licensesElement = document.createElement(LICENSES);
+ licensesElement = document.createElement(XMLConfig.LICENSES);
rootElement.appendChild(licensesElement);
- approvedElement = document.createElement(APPROVED);
+ approvedElement = document.createElement(XMLConfig.APPROVED);
rootElement.appendChild(approvedElement);
- matchersElement = document.createElement(MATCHERS);
+ matchersElement = document.createElement(XMLConfig.MATCHERS);
rootElement.appendChild(matchersElement);
licenses = LicenseSetFactory.emptyLicenseSet();
licenseFamilies = LicenseFamilySetFactory.emptyLicenseFamilySet();
approvedFamilies = new TreeSet<>();
matchers = new HashMap<>();
+ builderParams = new BuilderParams() {
+ @Override
+ public Map matcherMap() {
+ return matchers;
+ }
+
+ @Override
+ public SortedSet licenseFamilies() {
+ return licenseFamilies;
+ }
+ };
+ }
+
+ @Override
+ public void setLog(Log log) {
+ this.log = log;
+ }
+
+ public Log getLog() {
+ return log == null ? DefaultLog.INSTANCE : log;
}
@Override
@@ -142,8 +136,29 @@ public void addLicenses(URL url) {
}
/**
- * Read the urls and create a single document to process.
+ * Read xml from a reader.
*
+ * @param reader the reader to read XML from.
+ */
+ public void read(Reader reader) {
+ DocumentBuilder builder;
+ try {
+ builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
+ } catch (ParserConfigurationException e) {
+ throw new ConfigurationException("Unable to create DOM builder", e);
+ }
+
+ try {
+ add(builder.parse(new InputSource(reader)));
+ } catch (SAXException | IOException e) {
+ throw new ConfigurationException("Unable to read inputSource", e);
+ }
+
+ }
+
+ /**
+ * Read the urls and extract the DOM information to create new objects.
+ *
* @param urls The URLs to read.
*/
public void read(URL... urls) {
@@ -164,7 +179,7 @@ public void read(URL... urls) {
/**
* Applies the {@code consumer} to each node in the {@code list}
- *
+ *
* @param list the NodeList to process
* @param consumer the consumer to apply to each node in the list.
*/
@@ -176,25 +191,23 @@ private void nodeListConsumer(NodeList list, Consumer consumer) {
/**
* Merge the new document into the document that this reader processes.
- *
+ *
* @param newDoc the Document to merge.
*/
public void add(Document newDoc) {
- nodeListConsumer(newDoc.getElementsByTagName(FAMILIES),
- nl -> nodeListConsumer( nl.getChildNodes(),
+ nodeListConsumer(newDoc.getElementsByTagName(XMLConfig.FAMILIES), nl -> nodeListConsumer(nl.getChildNodes(),
n -> familiesElement.appendChild(rootElement.getOwnerDocument().adoptNode(n.cloneNode(true)))));
- nodeListConsumer(newDoc.getElementsByTagName(LICENSE),
+ nodeListConsumer(newDoc.getElementsByTagName(XMLConfig.LICENSE),
n -> licensesElement.appendChild(rootElement.getOwnerDocument().adoptNode(n.cloneNode(true))));
- nodeListConsumer(newDoc.getElementsByTagName(APPROVED),
- nl -> nodeListConsumer( nl.getChildNodes(),
+ nodeListConsumer(newDoc.getElementsByTagName(XMLConfig.APPROVED), nl -> nodeListConsumer(nl.getChildNodes(),
n -> approvedElement.appendChild(rootElement.getOwnerDocument().adoptNode(n.cloneNode(true)))));
- nodeListConsumer(newDoc.getElementsByTagName(MATCHERS),
+ nodeListConsumer(newDoc.getElementsByTagName(XMLConfig.MATCHERS),
n -> matchersElement.appendChild(rootElement.getOwnerDocument().adoptNode(n.cloneNode(true))));
}
/**
* Get a map of Node attribute names to values.
- *
+ *
* @param node The node to process
* @return the map of attributes on the node
*/
@@ -208,87 +221,246 @@ private Map attributes(Node node) {
return result;
}
+ private void callSetter(Description desc, IHeaderMatcher.Builder builder, Object value) {
+ try {
+ desc.setter(builder.getClass()).invoke(builder, value);
+ } catch (NoSuchMethodException | IllegalAccessException | IllegalArgumentException | InvocationTargetException
+ | SecurityException e) {
+ throw new ConfigurationException(e.getMessage(), e);
+ }
+ }
+
+ private void processBuilderParams(Description description, IHeaderMatcher.Builder builder) {
+ for (Description desc : description.childrenOfType(ComponentType.BULID_PARAMETER)) {
+ Method m = builderParams.get(desc.getCommonName());
+ try {
+ callSetter(desc, builder, m.invoke(builderParams));
+ } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
+ ImplementationException.makeInstance(e);
+ }
+ }
+ }
+
/**
- * Create a text matcher. Will construct a FullTextMatcher or a
- * SimpleTextMatcher depending on the complexity of the text.
+ * Processes a list of children by passing each child node and the description
+ * of the child (if any) to the BiPredicate. If there is not a child description
+ * for the node it is ignored. If the node is processed it is removed from list
+ * of children.
*
- * @param id the id for the Matcher.
- * @param txt the text to match
- * @return the IHeaderMatcher that matches the text.
+ * @param description the Description of the node being processed
+ * @param children the child nodes of that node.
+ * @param childProcessor the function that handles the processing of the child
+ * node.
*/
- public static IHeaderMatcher createTextMatcher(String id, String txt) {
- boolean complex = txt.contains(" ") | txt.contains("\\t") | txt.contains("\\n") | txt.contains("\\r")
- | txt.contains("\\f") | txt.contains("\\v");
- return complex ? new FullTextMatcher(id, txt) : new SimpleTextMatcher(id, txt);
+ private void processChildren(Description description, List children,
+ BiPredicate childProcessor) {
+ Iterator iter = children.iterator();
+ while (iter.hasNext()) {
+ Node child = iter.next();
+ Description childDescription = description.getChildren().get(child.getNodeName());
+ if (childDescription != null) {
+ if (childProcessor.test(child, childDescription)) {
+ iter.remove();
+ }
+ }
+ }
}
- private AbstractBuilder parseMatcher(Node matcherNode) {
- AbstractBuilder builder = MatcherBuilderTracker.getMatcherBuilder(matcherNode.getNodeName());
-
- NamedNodeMap nnm = matcherNode.getAttributes();
- for (int i = 0; i < nnm.getLength(); i++) {
- Node n = nnm.item(i);
- String methodName = "set" + StringUtils.capitalize(n.getNodeName());
- try {
- MethodUtils.invokeExactMethod(builder, methodName, n.getNodeValue());
- } catch (NoSuchMethodException e) {
- throw new ConfigurationException(
- String.format("'%s' does not have a setter '%s' that takes a String argument",
- matcherNode.getNodeName(), methodName));
- } catch (IllegalAccessException | InvocationTargetException | DOMException e) {
- throw new ConfigurationException(e);
+ private BiPredicate matcherChildNodeProcessor(AbstractBuilder builder, Description description) {
+ return (child, childDescription) -> {
+ switch (childDescription.getType()) {
+ case LICENSE:
+ case BULID_PARAMETER:
+ throw new ConfigurationException(String.format(
+ "%s may not be used as an enclosed matcher. %s '%s' found in '%s'", childDescription.getType(),
+ childDescription.getType(), childDescription.getCommonName(), description.getCommonName()));
+ case MATCHER:
+ AbstractBuilder b = parseMatcher(child);
+ callSetter(b.getDescription(), builder, b);
+ return true;
+ case PARAMETER:
+ if (!XMLConfig.isInlineNode(description.getCommonName(), childDescription.getCommonName())
+ || childDescription.getChildType() == String.class) {
+ callSetter(childDescription, builder, child.getTextContent());
+ } else {
+ callSetter(childDescription, builder, parseMatcher(child));
+ }
+ return true;
}
+ return false;
+ };
+ }
+
+ private void setValue(Description description, Description childDescription, IHeaderMatcher.Builder builder,
+ Node child) {
+ if (childDescription.getChildType() == String.class) {
+ callSetter(description, builder, child.getTextContent());
+ } else {
+ callSetter(description, builder, parseMatcher(child));
}
- if (builder instanceof ChildContainerBuilder) {
- ChildContainerBuilder ccb = (ChildContainerBuilder) builder;
- nodeListConsumer(matcherNode.getChildNodes(), x -> {
- if (x.getNodeType() == Node.ELEMENT_NODE) {
- ccb.add(parseMatcher(x));
+ }
+
+ /**
+ * Process the ELEEMENT_NODEs children of the parent whos names match child
+ * descriptions. All children children are processed with the childProcessor. If
+ * the childProcessor handles the node it is not included in the resulting list.
+ *
+ * @param description the Description of the parent node.
+ * @param parent the node being processed
+ * @param childProcessor the BiProcessor to handle process each child. if the
+ * processor handles the child it must return {@code true}.
+ * @return A Pair comprising a boolean flag indicating children were found, and
+ * a list of all child nodes that were not processed by the childProcessor.
+ */
+ private Pair> processChildNodes(Description description, Node parent,
+ BiPredicate childProcessor) {
+ boolean foundChildren = false;
+ List children = new ArrayList<>();
+ // check XML child nodes.
+ if (parent.hasChildNodes()) {
+
+ nodeListConsumer(parent.getChildNodes(), (n) -> {
+ if (n.getNodeType() == Node.ELEMENT_NODE) {
+ children.add(n);
}
});
+ foundChildren = !children.isEmpty();
+ if (foundChildren) {
+ processChildren(description, children, childProcessor);
+ }
}
- if (builder instanceof TextCaptureBuilder) {
- ((TextCaptureBuilder) builder).setText(matcherNode.getTextContent().trim());
- }
+ return new ImmutablePair>(foundChildren, children);
+ }
- if (builder instanceof MatcherRefBuilder) {
- ((MatcherRefBuilder) builder).setMatchers(matchers);
+ private AbstractBuilder parseMatcher(Node matcherNode) {
+ final AbstractBuilder builder = MatcherBuilderTracker.getMatcherBuilder(matcherNode.getNodeName());
+ if (builder == null) {
+ throw new ConfigurationException(String.format("No builder found for: %s", matcherNode.getNodeName()));
}
+ try {
+ final Description description = DescriptionBuilder.buildMap(builder.builtClass());
+
+ processBuilderParams(description, builder);
+// for (Description desc : description.childrenOfType(Component.Type.BuilderParam)) {
+// Method m = builderParams.get(desc.getCommonName());
+// try {
+// callSetter(desc, builder, m.invoke(builderParams));
+// } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
+// ImplementationException.makeInstance(e);
+// }
+// }
+
+ // process the attributes
+ description.setChildren(getLog(), builder, attributes(matcherNode));
+
+ // check XML child nodes.
+ Pair> pair = processChildNodes(description, matcherNode,
+ matcherChildNodeProcessor(builder, description));
+ boolean foundChildren = pair.getLeft();
+ List children = pair.getRight();
+
+ // check for inline nodes that can accept child nodes.
+ List childDescriptions = description.getChildren().values().stream()
+ .filter(d -> XMLConfig.isInlineNode(description.getCommonName(), d.getCommonName()))
+ .collect(Collectors.toList());
+
+ for (Description childDescription : childDescriptions) {
+ if (XMLConfig.isInlineNode(description.getCommonName(), childDescription.getCommonName())) {
+ // can only process text inline if there were not child nodes.
+ if (childDescription.getChildType() == String.class) {
+ if (!foundChildren) {
+ callSetter(childDescription, builder, matcherNode.getTextContent());
+ }
+ } else {
+ Iterator iter = children.iterator();
+ while (iter.hasNext()) {
+ Node child = iter.next();
+ callSetter(childDescription, builder, parseMatcher(child));
+ iter.remove();
+ }
+ }
- if (builder.hasId()) {
- builder = new DelegatingBuilder(builder) {
- @Override
- public IHeaderMatcher build() {
- IHeaderMatcher result = delegate.build();
- matchers.put(result.getId(), result);
- return result;
+ } else {
+ processChildren(description, children, (child, childD) -> {
+ if (childD.getChildType().equals(description.getChildType())) {
+ setValue(childDescription, childD, builder, child);
+ return true;
+ }
+ return false;
+ });
}
- };
+
+ }
+
+ if (!children.isEmpty()) {
+ children.forEach(n -> getLog().warn(String.format("unrecognised child node '%s' in node '%s'%n",
+ n.getNodeName(), matcherNode.getNodeName())));
+ }
+
+ } catch (DOMException e) {
+ throw new ConfigurationException(e);
}
- return builder;
+ return builder.hasId() ? new IDRecordingBuilder(matchers, builder) : builder;
+ }
+
+ private BiPredicate licenseChildNodeProcessor(ILicense.Builder builder,
+ Description description) {
+ return (child, childDescription) -> {
+ switch (childDescription.getType()) {
+ case LICENSE:
+ throw new ConfigurationException(String.format(
+ "%s may not be enclosed in another license. %s '%s' found in '%s'", childDescription.getType(),
+ childDescription.getType(), childDescription.getCommonName(), description.getCommonName()));
+ case BULID_PARAMETER:
+ break;
+ case MATCHER:
+ AbstractBuilder b = parseMatcher(child);
+ callSetter(b.getDescription(), builder, b);
+ return true;
+ case PARAMETER:
+ if ((!XMLConfig.isLicenseChild(childDescription.getCommonName()))
+ || childDescription.getChildType() == String.class) {
+ callSetter(childDescription, builder, child.getTextContent());
+ } else {
+ callSetter(childDescription, builder, parseMatcher(child));
+ }
+ return true;
+ }
+ return false;
+ };
}
private ILicense parseLicense(Node licenseNode) {
- Map attributes = attributes(licenseNode);
ILicense.Builder builder = ILicense.builder();
-
- builder.setLicenseFamilyCategory(attributes.get(FAMILY));
- builder.setName(attributes.get(ATT_NAME));
- builder.setId(attributes.get(ATT_ID));
-
- StringBuilder notesBuilder = new StringBuilder();
- nodeListConsumer(licenseNode.getChildNodes(), x -> {
- if (x.getNodeType() == Node.ELEMENT_NODE) {
- if (x.getNodeName().equals(NOTE)) {
- notesBuilder.append(x.getTextContent()).append("\n");
- } else {
- builder.setMatcher(parseMatcher(x));
+ Description description = builder.getDescription();
+
+ processBuilderParams(description, builder);
+
+ description.setChildren(getLog(), builder, attributes(licenseNode));
+
+ Pair> pair = processChildNodes(description, licenseNode,
+ licenseChildNodeProcessor(builder, description));
+ List children = pair.getRight();
+
+ // check for inline nodes that can accept child nodes.
+ List childDescriptions = description.getChildren().values().stream()
+ .filter(d -> XMLConfig.isLicenseInline(d.getCommonName())).collect(Collectors.toList());
+ for (Description childDescription : childDescriptions) {
+ Iterator iter = children.iterator();
+ while (iter.hasNext()) {
+ Node child = iter.next();
+ if (MatcherBuilderTracker.getMatcherBuilder(child.getNodeName()) != null) {
+ callSetter(childDescription, builder, parseMatcher(child));
+ iter.remove();
}
}
- });
- builder.setDerivedFrom(StringUtils.defaultIfBlank(attributes.get(ATT_DERIVED_FROM), null));
- builder.setNotes(StringUtils.defaultIfBlank(notesBuilder.toString().trim(), null));
- return builder.build(licenseFamilies);
+ }
+
+ if (!children.isEmpty()) {
+ children.forEach(n -> getLog().warn(String.format("unrecognised child node '%s' in node '%s'%n",
+ n.getNodeName(), licenseNode.getNodeName())));
+ }
+ return builder.build();
}
@Override
@@ -296,60 +468,62 @@ public SortedSet readLicenses() {
readFamilies();
readMatcherBuilders();
if (licenses.isEmpty()) {
- nodeListConsumer(document.getElementsByTagName(LICENSE), x -> licenses.add(parseLicense(x)));
+ nodeListConsumer(document.getElementsByTagName(XMLConfig.LICENSE), x -> licenses.add(parseLicense(x)));
document = null;
}
return Collections.unmodifiableSortedSet(licenses);
}
-
@Override
public SortedSet readFamilies() {
if (licenseFamilies.isEmpty()) {
- nodeListConsumer(document.getElementsByTagName(FAMILIES),
+ nodeListConsumer(document.getElementsByTagName(XMLConfig.FAMILIES),
x -> nodeListConsumer(x.getChildNodes(), this::parseFamily));
- nodeListConsumer(document.getElementsByTagName(APPROVED),
+ nodeListConsumer(document.getElementsByTagName(XMLConfig.APPROVED),
x -> nodeListConsumer(x.getChildNodes(), this::parseApproved));
}
return Collections.unmodifiableSortedSet(licenseFamilies);
}
-
+
private ILicenseFamily parseFamily(Map attributes) {
- if (attributes.containsKey(ATT_ID)) {
+ if (attributes.containsKey(XMLConfig.ATT_ID)) {
ILicenseFamily.Builder builder = ILicenseFamily.builder();
- builder.setLicenseFamilyCategory(attributes.get(ATT_ID));
- builder.setLicenseFamilyName(StringUtils.defaultIfBlank(attributes.get(ATT_NAME), attributes.get(ATT_ID)));
+ builder.setLicenseFamilyCategory(attributes.get(XMLConfig.ATT_ID));
+ builder.setLicenseFamilyName(
+ StringUtils.defaultIfBlank(attributes.get(XMLConfig.ATT_NAME), attributes.get(XMLConfig.ATT_ID)));
return builder.build();
}
return null;
}
private void parseFamily(Node familyNode) {
- if (FAMILY.equals(familyNode.getNodeName())) {
+ if (XMLConfig.FAMILY.equals(familyNode.getNodeName())) {
ILicenseFamily result = parseFamily(attributes(familyNode));
if (result == null) {
- throw new ConfigurationException(String.format("families/family tag requires %s attribute", ATT_ID));
+ throw new ConfigurationException(
+ String.format("families/family tag requires %s attribute", XMLConfig.ATT_ID));
}
licenseFamilies.add(result);
}
}
private void parseApproved(Node approvedNode) {
- if (FAMILY.equals(approvedNode.getNodeName())) {
+ if (XMLConfig.FAMILY.equals(approvedNode.getNodeName())) {
Map attributes = attributes(approvedNode);
- if (attributes.containsKey(ATT_LICENSE_REF)) {
- approvedFamilies.add(attributes.get(ATT_LICENSE_REF));
- } else if (attributes.containsKey(ATT_ID)) {
+ if (attributes.containsKey(XMLConfig.ATT_LICENSE_REF)) {
+ approvedFamilies.add(attributes.get(XMLConfig.ATT_LICENSE_REF));
+ } else if (attributes.containsKey(XMLConfig.ATT_ID)) {
ILicenseFamily target = parseFamily(attributes);
licenseFamilies.add(target);
approvedFamilies.add(target.getFamilyCategory());
} else {
- throw new ConfigurationException(
- String.format("family tag requires %s or %s attribute", ATT_LICENSE_REF, ATT_ID));
+ throw new ConfigurationException(String.format("family tag requires %s or %s attribute",
+ XMLConfig.ATT_LICENSE_REF, XMLConfig.ATT_ID));
}
}
}
+ ////////////////////////////////////////// MatcherReader methods
@Override
public SortedSet approvedLicenseId() {
if (licenses.isEmpty()) {
@@ -365,15 +539,15 @@ public SortedSet approvedLicenseId() {
private void parseMatcherBuilder(Node classNode) {
Map attributes = attributes(classNode);
- if (attributes.get(ATT_CLASS_NAME) == null) {
- throw new ConfigurationException("matcher must have a " + ATT_CLASS_NAME + " attribute");
+ if (attributes.get(XMLConfig.ATT_CLASS_NAME) == null) {
+ throw new ConfigurationException("matcher must have a " + XMLConfig.ATT_CLASS_NAME + " attribute");
}
- MatcherBuilderTracker.addBuilder(attributes.get(ATT_CLASS_NAME), attributes.get(ATT_NAME));
+ MatcherBuilderTracker.addBuilder(attributes.get(XMLConfig.ATT_CLASS_NAME), attributes.get(XMLConfig.ATT_NAME));
}
@Override
public void readMatcherBuilders() {
- nodeListConsumer(document.getElementsByTagName(MATCHER), this::parseMatcherBuilder);
+ nodeListConsumer(document.getElementsByTagName(XMLConfig.MATCHER), this::parseMatcherBuilder);
}
@Override
@@ -381,14 +555,35 @@ public void addMatchers(URL url) {
read(url);
}
+ ////////////// Helper classes
/**
* An abstract builder that delegates to another abstract builder.
*/
- abstract static class DelegatingBuilder extends AbstractBuilder {
- protected final AbstractBuilder delegate;
+ static class IDRecordingBuilder extends AbstractBuilder {
+ private final AbstractBuilder delegate;
+ private final Map matchers;
- DelegatingBuilder(AbstractBuilder delegate) {
+ IDRecordingBuilder(final Map matchers, final AbstractBuilder delegate) {
this.delegate = delegate;
+ this.matchers = matchers;
+ setId(delegate.getId());
+ }
+
+ @Override
+ public IHeaderMatcher build() {
+ IHeaderMatcher result = delegate.build();
+ matchers.put(result.getId(), result);
+ return result;
+ }
+
+ @Override
+ public Class builtClass() throws SecurityException {
+ return delegate.builtClass();
+ }
+
+ @Override
+ public Description getDescription() {
+ return delegate.getDescription();
}
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationWriter.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationWriter.java
new file mode 100644
index 000000000..1beb45f6d
--- /dev/null
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationWriter.java
@@ -0,0 +1,296 @@
+/*
+ * 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.configuration;
+
+import java.io.IOException;
+import java.io.Writer;
+import java.lang.reflect.InvocationTargetException;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.Optional;
+import java.util.Set;
+import java.util.SortedSet;
+import java.util.UUID;
+import java.util.function.Predicate;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.rat.ImplementationException;
+import org.apache.rat.ReportConfiguration;
+import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.api.RatException;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.Description;
+import org.apache.rat.configuration.builders.MatcherRefBuilder;
+import org.apache.rat.license.ILicense;
+import org.apache.rat.license.ILicenseFamily;
+import org.apache.rat.license.LicenseSetFactory.LicenseFilter;
+import org.apache.rat.report.xml.writer.IXmlWriter;
+import org.apache.rat.report.xml.writer.impl.base.XmlWriter;
+
+/**
+ * A class that writes the XML configuration file format.
+ */
+public class XMLConfigurationWriter {
+ private ReportConfiguration configuration;
+ private Set matchers;
+ private Set licenseChildren;
+
+ /**
+ * Constructor
+ * @param configuration the configuration to write.
+ */
+ public XMLConfigurationWriter(ReportConfiguration configuration) {
+ this.configuration = configuration;
+ this.matchers = new HashSet<>();
+ licenseChildren = new HashSet<>(Arrays.asList(XMLConfig.LICENSE_CHILDREN));
+ }
+
+ private Predicate attributeFilter(Description parent) {
+ return d -> {
+ if (d.getType() == ComponentType.PARAMETER) {
+ switch (parent.getType()) {
+ case MATCHER:
+ return !XMLConfig.isInlineNode(parent.getCommonName(), d.getCommonName());
+ case LICENSE:
+ return !licenseChildren.contains(d.getCommonName());
+ default:
+ return true;
+ }
+ }
+ return false;
+ };
+ }
+
+ /**
+ * Writes the configuration to the specified writer.
+ * @param plainWriter a writer to write the XML to.
+ * @throws RatException on error.
+ */
+ public void write(Writer plainWriter) throws RatException {
+ write(new XmlWriter(plainWriter));
+ }
+
+ /**
+ * Writes the configuration to an IXmlWriter instance.
+ * @param writer the IXmlWriter to write to.
+ * @throws RatException on error.
+ */
+ public void write(IXmlWriter writer) throws RatException {
+ if (configuration.listFamilies() != LicenseFilter.NONE || configuration.listLicenses() != LicenseFilter.NONE) {
+ try {
+ writer.openElement(XMLConfig.ROOT);
+
+ // write Families section
+ SortedSet families = configuration.getLicenseFamilies(configuration.listFamilies());
+ if (!families.isEmpty()) {
+ writer.openElement(XMLConfig.FAMILIES);
+ for (ILicenseFamily family : families) {
+ writeFamily(writer, family);
+ }
+ writer.closeElement(); // FAMILIES
+ }
+
+ // write licenses section
+ SortedSet licenses = configuration.getLicenses(configuration.listLicenses());
+ if (!licenses.isEmpty()) {
+ writer.openElement(XMLConfig.LICENSES);
+ for (ILicense license : licenses) {
+ writeDescription(writer, license.getDescription(), license);
+ }
+ writer.closeElement();// LICENSES
+ }
+
+ // write approved section
+ writer.openElement(XMLConfig.APPROVED);
+ for (String family : configuration.getApprovedLicenseCategories()) {
+ writer.openElement(XMLConfig.APPROVED).attribute(XMLConfig.ATT_LICENSE_REF, family.trim())
+ .closeElement();
+ }
+ writer.closeElement(); // APPROVED
+
+ // write matchers section
+ MatcherBuilderTracker tracker = MatcherBuilderTracker.INSTANCE;
+ writer.openElement(XMLConfig.MATCHERS);
+ for (Class clazz : tracker.getClasses()) {
+ writer.openElement(XMLConfig.MATCHER).attribute(XMLConfig.ATT_CLASS_NAME, clazz.getCanonicalName())
+ .closeElement();
+ }
+ writer.closeElement(); // MATCHERS
+
+ writer.closeElement(); // ROOT
+ } catch (IOException e) {
+ throw new RatException(e);
+ }
+ }
+ }
+
+ private void writeFamily(IXmlWriter writer, ILicenseFamily family) throws RatException {
+ try {
+ writer.openElement(XMLConfig.FAMILY).attribute(XMLConfig.ATT_ID, family.getFamilyCategory().trim())
+ .attribute(XMLConfig.ATT_NAME, family.getFamilyName());
+ writer.closeElement();
+ } catch (IOException e) {
+ throw new RatException(e);
+ }
+ }
+
+ private void writeDescriptions(IXmlWriter writer, Collection descriptions, IHeaderMatcher component)
+ throws RatException {
+ for (Description description : descriptions) {
+ writeDescription(writer, description, component);
+ }
+ }
+
+ private void writeChildren(IXmlWriter writer, Description description, IHeaderMatcher component)
+ throws RatException {
+ writeAttributes(writer, description.filterChildren(attributeFilter(component.getDescription())), component);
+ writeDescriptions(writer, description.filterChildren(attributeFilter(component.getDescription()).negate()),
+ component);
+ }
+
+ private void writeAttributes(IXmlWriter writer, Collection descriptions, IHeaderMatcher component)
+ throws RatException {
+ for (Description d : descriptions) {
+ try {
+ writeAttribute(writer, d, component);
+ } catch (IOException e) {
+ throw new RatException(e);
+ }
+ }
+ }
+
+ private void writeComment(IXmlWriter writer, Description description) throws IOException {
+ if (StringUtils.isNotBlank(description.getDescription())) {
+ writer.comment(description.getDescription());
+ }
+ }
+
+ private void writeAttribute(IXmlWriter writer, Description description, IHeaderMatcher component)
+ throws IOException {
+ String paramValue = description.getParamValue(configuration.getLog(), component);
+ if (paramValue != null) {
+ writer.attribute(description.getCommonName(), paramValue);
+ }
+ }
+
+ /* package private for testing */
+ @SuppressWarnings("unchecked")
+ void writeDescription(IXmlWriter writer, Description description, IHeaderMatcher component) throws RatException {
+ try {
+ switch (description.getType()) {
+ case MATCHER:
+ // see if id was registered
+ Optional id = description.childrenOfType(ComponentType.PARAMETER).stream()
+ .filter(i -> XMLConfig.ATT_ID.equals(i.getCommonName())).findFirst();
+
+ // id will not be present in matcherRef
+ if (id.isPresent()) {
+ String matcherId = id.get().getParamValue(configuration.getLog(), component);
+ // if we have seen the ID before just put a reference to the other one.
+ if (matchers.contains(matcherId.toString())) {
+ component = new MatcherRefBuilder.IHeaderMatcherProxy(matcherId.toString(), null);
+ description = component.getDescription();
+ } else {
+ matchers.add(matcherId.toString());
+ }
+ // remove the matcher id if it is a UUID
+ try {
+ UUID.fromString(matcherId);
+ description.getChildren().remove(XMLConfig.ATT_ID);
+ } catch (IllegalArgumentException expected) {
+ if (description.getCommonName().equals("spdx")) {
+ description.getChildren().remove(XMLConfig.ATT_ID);
+ }
+ }
+ }
+
+ // if resource only list the resource not the contents of the matcher
+ Optional resource = description.childrenOfType(ComponentType.PARAMETER).stream()
+ .filter(i -> XMLConfig.ATT_RESOURCE.equals(i.getCommonName())).findFirst();
+ if (resource.isPresent()) {
+ String resourceStr = resource.get().getParamValue(configuration.getLog(), component);
+ if (StringUtils.isNotBlank(resourceStr)) {
+ description.getChildren().remove("enclosed");
+ }
+ }
+ writeComment(writer, description);
+ writer.openElement(description.getCommonName());
+ writeChildren(writer, description, component);
+ writer.closeElement();
+ break;
+ case LICENSE:
+ writer.openElement(XMLConfig.LICENSE);
+ writeChildren(writer, description, component);
+ writer.closeElement();
+ break;
+ case PARAMETER:
+ if ("id".equals(description.getCommonName())) {
+ try {
+ String paramId = description.getParamValue(configuration.getLog(), component);
+ // if a UUID skip it.
+ if (paramId != null) {
+ UUID.fromString(paramId.toString());
+ return;
+ }
+ } catch (IllegalArgumentException expected) {
+ // do nothing.
+ }
+ }
+ if (description.getChildType() == String.class) {
+
+ boolean inline = XMLConfig.isInlineNode(component.getDescription().getCommonName(),
+ description.getCommonName());
+ String s = description.getParamValue(configuration.getLog(), component);
+ if (StringUtils.isNotBlank(s)) {
+ if (!inline) {
+ writer.openElement(description.getCommonName());
+ }
+ writer.content(description.getParamValue(configuration.getLog(), component));
+ if (!inline) {
+ writer.closeElement();
+ }
+ }
+ } else {
+ try {
+ if (description.isCollection()) {
+ for (IHeaderMatcher matcher : (Collection) description
+ .getter(component.getClass()).invoke(component)) {
+ writeDescription(writer, matcher.getDescription(), matcher);
+ }
+ } else {
+ IHeaderMatcher matcher = (IHeaderMatcher) description.getter(component.getClass())
+ .invoke(component);
+ writeDescription(writer, matcher.getDescription(), matcher);
+ }
+ } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException
+ | NoSuchMethodException | SecurityException | RatException e) {
+ throw new ImplementationException(e);
+ }
+ }
+ break;
+ case BULID_PARAMETER:
+ // ignore;
+ break;
+ }
+ } catch (IOException e) {
+ throw new RatException(e);
+ }
+ }
+}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/AbstractBuilder.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/AbstractBuilder.java
index 7d546a03a..897e8e4d0 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/AbstractBuilder.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/AbstractBuilder.java
@@ -39,28 +39,29 @@ protected AbstractBuilder() {
* @param id the id to use.
* @return this builder for chaining.
*/
- public final AbstractBuilder setId(String id) {
+ public AbstractBuilder setId(String id) {
this.id = id;
return this;
}
/**
+ * Returns true if this builder has an ID specified.
* @return {@code true} if the id is not null and not blank.
*/
public final boolean hasId() {
return !StringUtils.isBlank(id);
}
-
+
/**
+ * Gets the ID as specified in the builder.
* @return the id as specified in the builder.
*/
- protected String getId() {
+ public final String getId() {
return id;
}
-
+
@Override
public String toString() {
- return String.format( "%s with id %s", this.getClass(), id);
+ return String.format("%s with id %s", this.getClass(), id);
}
-
}
\ No newline at end of file
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/AllBuilder.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/AllBuilder.java
index 9c0980e5f..91235246d 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/AllBuilder.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/AllBuilder.java
@@ -18,7 +18,6 @@
*/
package org.apache.rat.configuration.builders;
-import org.apache.rat.analysis.IHeaderMatcher;
import org.apache.rat.analysis.matchers.AndMatcher;
/**
@@ -27,7 +26,7 @@
public class AllBuilder extends ChildContainerBuilder {
@Override
- public IHeaderMatcher build() {
- return new AndMatcher(getId(), getChildren());
+ public AndMatcher build() {
+ return new AndMatcher(getId(), getEnclosed(), resource);
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/AnyBuilder.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/AnyBuilder.java
index 6ecb73e97..929f41661 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/AnyBuilder.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/AnyBuilder.java
@@ -18,7 +18,6 @@
*/
package org.apache.rat.configuration.builders;
-import org.apache.rat.analysis.IHeaderMatcher;
import org.apache.rat.analysis.matchers.OrMatcher;
/**
@@ -27,7 +26,7 @@
public class AnyBuilder extends ChildContainerBuilder {
@Override
- public IHeaderMatcher build() {
- return new OrMatcher(getId(), getChildren());
+ public OrMatcher build() {
+ return new OrMatcher(getId(), getEnclosed(), resource);
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/ChildContainerBuilder.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/ChildContainerBuilder.java
index d67264b42..bb23e2b57 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/ChildContainerBuilder.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/ChildContainerBuilder.java
@@ -26,24 +26,25 @@
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collection;
+import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import org.apache.commons.lang3.StringUtils;
import org.apache.rat.ConfigurationException;
import org.apache.rat.analysis.IHeaderMatcher;
-import org.apache.rat.analysis.IHeaderMatcher.Builder;
/**
* Constructs a builder that contains other builders.
*/
public abstract class ChildContainerBuilder extends AbstractBuilder {
- /**
- * The list of builders that will build the enclosed matchers.
- */
+ /** The list of builders that will build the enclosed matchers. */
protected final List children = new ArrayList<>();
+ /** The resource the builders came from if it was read from a resource */
+ protected String resource;
+
/**
* Empty default constructor.
*/
@@ -52,58 +53,64 @@ protected ChildContainerBuilder() {
/**
* Reads a text file. Each line becomes a text matcher in the resulting list.
- *
+ *
* @param resourceName the name of the resource to read.
* @return a List of Matchers, one for each non-empty line in the input file.
*/
public AbstractBuilder setResource(String resourceName) {
- URL url = this.getClass().getResource(resourceName);
- try (final InputStream in = url.openStream()) {
- BufferedReader buffer = new BufferedReader(new InputStreamReader(in, StandardCharsets.UTF_8));
- String txt;
- while (null != (txt = buffer.readLine())) {
- txt = txt.trim();
- if (StringUtils.isNotBlank(txt)) {
- children.add(Builder.text().setText(txt));
- }
+ URL url = this.getClass().getResource(resourceName);
+ try (final InputStream in = url.openStream()) {
+ BufferedReader buffer = new BufferedReader(new InputStreamReader(in, StandardCharsets.UTF_8));
+ String txt;
+ while (null != (txt = buffer.readLine())) {
+ txt = txt.trim();
+ if (StringUtils.isNotBlank(txt)) {
+ children.add(new TextBuilder().setSimpleText(txt));
}
- return this;
- } catch (IOException e) {
- throw new ConfigurationException("Unable to read matching text file: " + resourceName, e);
}
+ this.resource = resourceName;
+ return this;
+ } catch (IOException e) {
+ throw new ConfigurationException("Unable to read matching text file: " + resourceName, e);
+ }
}
-
+
/**
* Adds a builder to the list of builders.
+ *
* @param child the child builder to add.
* @return this for chaining.
*/
- public AbstractBuilder add(IHeaderMatcher.Builder child) {
+ public AbstractBuilder addEnclosed(IHeaderMatcher.Builder child) {
children.add(child);
return this;
}
-
+
/**
* Adds a collection of builders to the list of child builders.
+ *
* @param children the children to add.
* @return this for chaining.
*/
- public AbstractBuilder add(Collection children) {
+ public AbstractBuilder addEnclosed(Collection children) {
this.children.addAll(children);
return this;
}
+ public List getEnclosedBuilders() {
+ return Collections.unmodifiableList(children);
+ }
/**
* @return the list of child builders for this builder.
*/
- public List getChildren() {
+ public List getEnclosed() {
return children.stream().map(IHeaderMatcher.Builder::build).collect(Collectors.toList());
}
-
+
@Override
public String toString() {
- StringBuilder sb = new StringBuilder(this.getClass().getSimpleName()).append( ":");
- children.stream().map(Object::toString).forEach( x -> sb.append("\n").append(x));
+ StringBuilder sb = new StringBuilder(this.getClass().getSimpleName()).append(":");
+ children.stream().map(Object::toString).forEach(x -> sb.append(System.lineSeparator()).append(x));
return sb.toString();
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/CopyrightBuilder.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/CopyrightBuilder.java
index f38220ade..e74b270f3 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/CopyrightBuilder.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/CopyrightBuilder.java
@@ -18,7 +18,6 @@
*/
package org.apache.rat.configuration.builders;
-import org.apache.rat.analysis.IHeaderMatcher;
import org.apache.rat.analysis.matchers.CopyrightMatcher;
/**
@@ -60,10 +59,10 @@ public CopyrightBuilder setOwner(String owner) {
}
@Override
- public IHeaderMatcher build() {
+ public CopyrightMatcher build() {
return new CopyrightMatcher(getId(), start, end, owner);
}
-
+
@Override
public String toString() {
return String.format("Copyright Builder: s:%s e:%s o:%s", start, end, owner);
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/MatcherRefBuilder.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/MatcherRefBuilder.java
index 17918096a..06624ffb3 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/MatcherRefBuilder.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/MatcherRefBuilder.java
@@ -20,22 +20,32 @@
import java.util.Map;
+import org.apache.rat.ConfigurationException;
import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.analysis.IHeaders;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.ConfigComponent;
/**
* A reference matching Matcher builder.
*
- * This class stores a matcher id as a reference to the matcher. It also has a map of matcher ids to the matcher
- * instances. When build is called the matcher reference is looked up in the map. If it is found then it is returned
- * value from the {@code build()} call. If the reference is not located then a IHeaderMatcherProxy is returned.
- * the IHeaderMatcherProxy is resolved in a later configuration construction phase.
+ * This class stores a matcher id as a reference to the matcher. It also has a
+ * map of matcher ids to the matcher instances. When {@code build()} is called the matcher
+ * reference is looked up in the map. If it is found then its value is returned
+ * from the {@code build()} call. If the reference is not located then a
+ * IHeaderMatcherProxy is returned. the IHeaderMatcherProxy is resolved in a
+ * later configuration construction phase.
*/
public class MatcherRefBuilder extends AbstractBuilder {
private String referenceId;
private Map matchers;
+ /** the reference id attribute */
+ public static final String ATT_REF_ID = "refId";
+
/**
* Constructs the MatcherReferenceBuilder using the provided reference id.
+ *
* @param refId the reverence to the matcher id.
* @return this builder for chaining.
*/
@@ -44,43 +54,74 @@ public MatcherRefBuilder setRefId(String refId) {
return this;
}
+ @Override
+ public Class builtClass() {
+ return IHeaderMatcherProxy.class;
+ }
+
/**
* Set the Map of matcher ids to matcher instances.
+ *
* @param matchers the Map of ids to instances.
* @return this builder for chaining.
*/
- public MatcherRefBuilder setMatchers(Map matchers) {
+ public MatcherRefBuilder setMatcherMap(Map matchers) {
this.matchers = matchers;
return this;
}
@Override
public IHeaderMatcher build() {
+ if (matchers == null) {
+ throw new ConfigurationException("'matchers' not set");
+ }
IHeaderMatcher result = matchers.get(referenceId);
return result != null ? result : new IHeaderMatcherProxy(referenceId, matchers);
}
@Override
public String toString() {
- return "MathcerRefBuilder: "+referenceId;
+ return "MathcerRefBuilder: " + referenceId;
}
-
+
/**
- * A class that is a proxy to the actual matcher. It retrieves the actual matcher from the map of
- * matcher ids to matcher instances one the first use of the matcher. This allows earlier read matchers
- * to reference later constructed matchers as long as all the matchers are constructed before the earlier one is
- * used.
+ * A class that is a proxy to the actual matcher. It retrieves the actual
+ * matcher from the map of matcher ids to matcher instances on the first use of
+ * the matcher. This allows earlier read matchers to reference later constructed
+ * matchers as long as all the matchers are constructed before the earlier one
+ * is used.
*/
- private class IHeaderMatcherProxy implements IHeaderMatcher {
+ @ConfigComponent(type = ComponentType.MATCHER, name = "matcherRef", desc = "A pointer to another Matcher")
+ public static class IHeaderMatcherProxy implements IHeaderMatcher {
+
+ @ConfigComponent(type = ComponentType.PARAMETER, name = "refId", desc = "Reference to an existing matcher")
private final String proxyId;
private IHeaderMatcher wrapped;
+
+ @ConfigComponent(type = ComponentType.BULID_PARAMETER, name = "matcherMap", desc = "Map of matcher names to matcher instances")
private Map matchers;
- private IHeaderMatcherProxy(String proxyId, Map matchers) {
+ /**
+ * Constuctor. The matchers map should be a reference to an object that will be
+ * updated by later processing of matcher definitions.
+ *
+ * @param proxyId the id of the matcher to find.
+ * @param matchers a mapping of matchers that have been found.
+ */
+ public IHeaderMatcherProxy(String proxyId, Map matchers) {
this.proxyId = proxyId;
this.matchers = matchers;
}
+ /**
+ * Get the reference ID that this proxy is using.
+ *
+ * @return the reference id that points to the actual matcher.
+ */
+ public String getRefId() {
+ return proxyId;
+ }
+
private void checkProxy() {
if (wrapped == null) {
wrapped = matchers.get(proxyId);
@@ -104,21 +145,9 @@ public void reset() {
}
@Override
- public State matches(String line) {
- checkProxy();
- return wrapped.matches(line);
- }
-
- @Override
- public State currentState() {
- checkProxy();
- return wrapped.currentState();
- }
-
- @Override
- public State finalizeState() {
+ public boolean matches(IHeaders header) {
checkProxy();
- return wrapped.finalizeState();
+ return wrapped.matches(header);
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/NotBuilder.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/NotBuilder.java
index 61e264b8b..a5d444875 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/NotBuilder.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/NotBuilder.java
@@ -26,17 +26,31 @@
* A builder for the NotMatcher.
*/
public class NotBuilder extends ChildContainerBuilder {
-
+
@Override
- public IHeaderMatcher build() {
- if (children.size() != 1) {
+ public NotMatcher build() {
+ if (children.isEmpty()) {
throw new ConfigurationException("'not' type matcher requires one and only one enclosed matcher");
}
return new NotMatcher(getId(), children.get(0).build());
}
-
+
@Override
public String toString() {
- return String.format( "NotBuilder: %s", !children.isEmpty() ? children.get(0) : null );
+ return String.format("NotBuilder: %s", !children.isEmpty() ? children.get(0) : null);
+ }
+
+ /**
+ * Sets the enclosed matcher. Prior to this call the builder is invalid and the {@code build()} will fail.
+ * @param enclosed The matcher to negate.
+ * @return this.
+ */
+ public NotBuilder setEnclosed(IHeaderMatcher.Builder enclosed) {
+ if (children.isEmpty()) {
+ children.add(enclosed);
+ } else {
+ children.set(0, enclosed);
+ }
+ return this;
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/RegexBuilder.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/RegexBuilder.java
index a132ba6c6..df12c2e78 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/RegexBuilder.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/RegexBuilder.java
@@ -21,7 +21,6 @@
import java.util.regex.Pattern;
import org.apache.rat.ConfigurationException;
-import org.apache.rat.analysis.IHeaderMatcher;
import org.apache.rat.analysis.matchers.SimpleRegexMatcher;
/**
@@ -32,9 +31,8 @@ public class RegexBuilder extends AbstractBuilder {
private Pattern pattern;
/**
- * Sets the regex expression.
- * This method compiles the string into a pattern and may throw any exception thrown by the
- * {@code Pattern.compile(String)} method.
+ * Sets the regex expression. This method compiles the string into a pattern and
+ * may throw any exception thrown by the {@code Pattern.compile(String)} method.
* @param exp the expression as a string.
* @return this builder for chaining.
* @see Pattern#compile(String)
@@ -45,16 +43,16 @@ public RegexBuilder setExpr(String exp) {
}
@Override
- public IHeaderMatcher build() {
+ public SimpleRegexMatcher build() {
if (null == pattern) {
throw new ConfigurationException("'regex' type matcher requires an expression");
}
- return new SimpleRegexMatcher(pattern);
+ return new SimpleRegexMatcher(getId(), pattern);
}
-
+
@Override
public String toString() {
- return String.format("RegexBuilder: %s", pattern==null? null: pattern.pattern());
+ return String.format("RegexBuilder: %s", pattern == null ? null : pattern.pattern());
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/SpdxBuilder.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/SpdxBuilder.java
index 42530147d..c0ad37207 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/SpdxBuilder.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/SpdxBuilder.java
@@ -20,7 +20,8 @@
import java.util.Objects;
-import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.rat.ConfigurationException;
import org.apache.rat.analysis.matchers.SPDXMatcherFactory;
/**
@@ -31,23 +32,41 @@ public class SpdxBuilder extends AbstractBuilder {
private String name;
/**
- * sets the name for the SPDX matcher
- * @param name
- * @return
+ * Sets the name for the SPDX matcher. This is the same as the identifier in the SPDX license list.
+ *
+ * @param name The text that follows the colon ':' in the SPDX tag.
+ * @return this builder.
+ * @see SPDX license list
*/
public SpdxBuilder setName(String name) {
- Objects.requireNonNull(name, "name must not be null");
+ Objects.requireNonNull(name, "SPDX name must not be null");
this.name = name;
+ super.setId("SPDX:" + name);
return this;
}
+ /**
+ * Set the id for the matcher.
+ *
+ * @param id the id to use.
+ * @return this builder.
+ */
@Override
- public IHeaderMatcher build() {
+ public AbstractBuilder setId(String id) {
+ if (StringUtils.isNotBlank(id)) {
+ throw new ConfigurationException("'id' is not supported for SPDX matchers. "
+ + "SPXD matchers always have 'SPDX:' as their id");
+ }
+ return this;
+ }
+
+ @Override
+ public SPDXMatcherFactory.Match build() {
return SPDXMatcherFactory.INSTANCE.create(name);
}
-
+
@Override
public String toString() {
- return "SpdxBuilder: "+name;
+ return "SpdxBuilder: " + name;
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/TextBuilder.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/TextBuilder.java
index 456afe03b..9b9fe10de 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/TextBuilder.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/TextBuilder.java
@@ -18,31 +18,33 @@
*/
package org.apache.rat.configuration.builders;
-import java.util.Objects;
-
import org.apache.commons.lang3.StringUtils;
import org.apache.rat.ConfigurationException;
-import org.apache.rat.analysis.IHeaderMatcher;
import org.apache.rat.analysis.matchers.FullTextMatcher;
import org.apache.rat.analysis.matchers.SimpleTextMatcher;
/**
- * Builds text based matcher based on the complexity of the text to match.
+ * Builds text matcher. The specific implementation is based on the complexity of the text to match.
*/
-public class TextBuilder extends AbstractBuilder implements TextCaptureBuilder {
+public class TextBuilder extends AbstractBuilder {
private String text;
- @SuppressWarnings("unchecked")
- @Override
- public TextBuilder setText(String text) {
- Objects.requireNonNull(text, "text may not be null");
- this.text = text;
+ /**
+ * Sets the text to match.
+ * @param text the text to match
+ * @return this builder.
+ */
+ public TextBuilder setSimpleText(String text) {
+ this.text = text.trim();
+ if (StringUtils.isBlank(text)) {
+ throw new ConfigurationException("'text' may not be null");
+ }
return this;
}
@Override
- public IHeaderMatcher build() {
+ public SimpleTextMatcher build() {
if (StringUtils.isBlank(text)) {
throw new ConfigurationException("text value is required");
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/document/ToNameTransformer.java b/apache-rat-core/src/main/java/org/apache/rat/document/ToNameTransformer.java
index 860e8a914..ccfb359b3 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/document/ToNameTransformer.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/document/ToNameTransformer.java
@@ -20,7 +20,7 @@
import org.apache.commons.collections4.Transformer;
import org.apache.rat.api.Document;
-
+@Deprecated // since 0.17 - Not used in the codebase.
public class ToNameTransformer implements Transformer {
private static final Transformer TO_NAME_TRANSFORMER = new ToNameTransformer();
diff --git a/apache-rat-core/src/main/java/org/apache/rat/header/ArrayCharFilter.java b/apache-rat-core/src/main/java/org/apache/rat/header/ArrayCharFilter.java
index 762f8255f..9b3ee888f 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/header/ArrayCharFilter.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/header/ArrayCharFilter.java
@@ -17,7 +17,7 @@
* under the License. *
*/
package org.apache.rat.header;
-
+@Deprecated // since 0.17
class ArrayCharFilter implements CharFilter {
private final char[] filtered;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/header/CharFilter.java b/apache-rat-core/src/main/java/org/apache/rat/header/CharFilter.java
index 76011e371..13f28d528 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/header/CharFilter.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/header/CharFilter.java
@@ -17,7 +17,7 @@
* under the License. *
*/
package org.apache.rat.header;
-
+@Deprecated // since 0.17
interface CharFilter {
/**
diff --git a/apache-rat-core/src/main/java/org/apache/rat/header/FilteringSequenceFactory.java b/apache-rat-core/src/main/java/org/apache/rat/header/FilteringSequenceFactory.java
index ac5d31aa6..2c852a570 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/header/FilteringSequenceFactory.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/header/FilteringSequenceFactory.java
@@ -21,7 +21,7 @@
import java.io.IOException;
import java.io.Reader;
import java.nio.CharBuffer;
-
+@Deprecated // since 0.17
class FilteringSequenceFactory {
private static final int BUFFER_CAPACITY = 5000;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java b/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java
index f55fa8345..bf979ee0f 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java
@@ -20,6 +20,7 @@
import java.util.regex.Pattern;
+@Deprecated // since 0.17
public class HeaderBean {
private Pattern headerPattern;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java b/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java
index ac720bf44..4c887d238 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java
@@ -33,6 +33,7 @@
* Note: use only from a single thread.
*
*/
+@Deprecated // since 0.17
public class HeaderMatcher {
private final FilteringSequenceFactory factory;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/header/LineNumberReader.java b/apache-rat-core/src/main/java/org/apache/rat/header/LineNumberReader.java
index d5f150b78..e7f046a01 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/header/LineNumberReader.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/header/LineNumberReader.java
@@ -29,6 +29,7 @@
* This implementation is compatible with the latter variant,
* thus providing upwards compatibility for RAT.
*/
+@Deprecated // since 0.17
public class LineNumberReader {
private final Reader parent;
private boolean previousCharWasCR = false;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/ILicense.java b/apache-rat-core/src/main/java/org/apache/rat/license/ILicense.java
index 4d30ff2d7..2d6acbb0f 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/ILicense.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/ILicense.java
@@ -19,7 +19,6 @@
package org.apache.rat.license;
import java.util.Comparator;
-import java.util.Objects;
import java.util.SortedSet;
import org.apache.rat.analysis.IHeaderMatcher;
@@ -29,35 +28,56 @@
*/
public interface ILicense extends IHeaderMatcher, Comparable {
/**
+ * Gets the license family.
+ *
* @return the ILicenseFamily implementation for this license.
*/
ILicenseFamily getLicenseFamily();
/**
- * @return the notes associated with this license. May be null or empty.
+ * Gets the note associated with the license.
+ *
+ * @return the note associated with this license. May be null or empty.
*/
- String getNotes();
+ String getNote();
/**
- * @return the id of a license that this license is derived from. May be null.
- */
- String derivedFrom();
-
- /**
- * Returns the name of this license. If no name was specified then the name of the family is returned.
+ * Returns the name of this license. If no name was specified then the name of
+ * the family is returned.
+ *
* @return the name of this license.
*/
String getName();
/**
+ * Gets the name of the family that this license if part of.
+ *
+ * @return the name of the license family that this license is part of.
+ */
+ default String getFamilyName() {
+ return getLicenseFamily().getFamilyName();
+ }
+
+ /**
+ * Get the header matcher for this license.
+ *
+ * @return the header matcher for this license.
+ */
+ IHeaderMatcher getMatcher();
+
+ /**
+ * Gets a builder for licenses.
+ *
* @return An ILicense.Builder instance.
*/
static ILicense.Builder builder() {
- return new Builder();
+ return new SimpleLicense.Builder();
}
/**
- * @return The comparator for used to sort Licenses.
+ * Gets the comparator for comparing licenses.
+ *
+ * @return The comparator for used for sorting Licenses.
*/
static Comparator getComparator() {
return Comparator.comparing(IHeaderMatcher::getId);
@@ -66,106 +86,76 @@ static Comparator getComparator() {
/**
* A builder for ILicense instances.
*/
- class Builder {
-
- private IHeaderMatcher.Builder matcher;
-
- private String notes;
-
- private String derivedFrom;
-
- private String name;
-
- private String id;
-
- private final ILicenseFamily.Builder licenseFamily = ILicenseFamily.builder();
+ interface Builder extends IHeaderMatcher.Builder {
/**
* Sets the matcher from a builder.
+ *
* @param matcher the builder for the matcher for the license.
* @return this builder for chaining.
*/
- public Builder setMatcher(IHeaderMatcher.Builder matcher) {
- this.matcher = matcher;
- return this;
- }
+ Builder setMatcher(IHeaderMatcher.Builder matcher);
/**
* Sets the matcher.
+ *
* @param matcher the matcher for the license.
* @return this builder for chaining.
*/
- public Builder setMatcher(IHeaderMatcher matcher) {
- this.matcher = ()->matcher;
- return this;
- }
+ Builder setMatcher(IHeaderMatcher matcher);
/**
- * Sets the notes for the license.
- * If called multiple times the notes are concatenated to create a single note.
+ * Sets the notes for the license. If called multiple times the notes are
+ * concatenated to create a single note.
+ *
* @param notes the notes for the license.
* @return this builder for chaining.
*/
- public Builder setNotes(String notes) {
- this.notes = notes;
- return this;
- }
+ Builder setNote(String notes);
/**
- * Sets the ID of the license.
- * If the ID is not set then the ID of the license family is used.
+ * Sets the ID of the license. If the ID is not set then the ID of the license
+ * family is used.
+ *
* @param id the ID for the license
* @return this builder for chaining.
*/
- public Builder setId(String id) {
- this.id = id;
- return this;
- }
+ Builder setId(String id);
/**
- * Sets the derived from fields in the license.
- * @param derivedFrom the family category of the license this license was derived from.
+ * Set the family category for this license. The category must be unique across
+ * all licenses and must be 5 characters. If more than 5 characters are provided
+ * then only the first 5 are taken. If fewer than 5 characters are provided the
+ * category is padded with spaces.
+ *
+ * @param licenseFamilyCategory the family category for the license.
* @return this builder for chaining.
*/
- public Builder setDerivedFrom(String derivedFrom) {
- this.derivedFrom = derivedFrom;
- return this;
- }
+ Builder setFamily(String licenseFamilyCategory);
/**
- * Set the family category for this license.
- * The category must be unique across all licenses and must be 5 characters. If more than
- * 5 characters are provided then only the first 5 are taken. If fewer than 5 characters are provided
- * the category is padded with spaces.
- * @param licenseFamilyCategory the family category for the license.
+ * Sets the name of the license. If the name is not set then the name of the
+ * license family is used.
+ *
+ * @param name the name for the license
* @return this builder for chaining.
*/
- public Builder setLicenseFamilyCategory(String licenseFamilyCategory) {
- this.licenseFamily.setLicenseFamilyCategory(licenseFamilyCategory);
- this.licenseFamily.setLicenseFamilyName("License Family for searching");
- return this;
- }
+ public Builder setName(String name);
/**
- * Sets the name of the license.
- * If the name is not set then the name of the license family is used.
- * @param name the name for the license
- * @return this builder for chaining.
+ * Sets the set of license families to use duirng build.
+ *
+ * @param licenseFamilies the license families to use
+ * @return this builder.
*/
- public Builder setName(String name) {
- this.name = name;
- return this;
- }
+ public Builder setLicenseFamilies(SortedSet licenseFamilies);
/**
- * @param licenseFamilies the set of defined license families.
+ * Builds the license.
+ *
* @return A new License implementation.
*/
- public ILicense build(SortedSet licenseFamilies) {
- Objects.requireNonNull(matcher, "Matcher must not be null");
- ILicenseFamily family = LicenseFamilySetFactory.search(licenseFamily.build(), licenseFamilies);
- Objects.requireNonNull(family, "License family "+licenseFamily.getCategory()+" not found.");
- return new SimpleLicense(family, matcher.build(), derivedFrom, notes, name, id);
- }
+ @Override
+ public ILicense build();
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/ILicenseFamily.java b/apache-rat-core/src/main/java/org/apache/rat/license/ILicenseFamily.java
index 501a59e89..5161cf1b4 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/ILicenseFamily.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/ILicenseFamily.java
@@ -22,17 +22,27 @@
* The definition of the license family.
*/
public interface ILicenseFamily extends Comparable {
+
+ /** The category for generated files */
+ static final String GENTERATED_CATEGORY = "GEN ";
+
+ /** The category for unknown licenses */
+ static final String UNKNOWN_CATEGORY = "?????";
+
/**
+ * Gets the family name.
* @return the license family name.
*/
String getFamilyName();
/**
+ * Gets the family category.
* @return the license family category.
*/
String getFamilyCategory();
/**
+ * Gets the Builder for license families.
* @return A builder for an ILicenseFamily.
*/
static ILicenseFamily.Builder builder() {
@@ -40,8 +50,9 @@ static ILicenseFamily.Builder builder() {
}
/**
- * Convert a potential category string into a category string of exactly 5 characters either by truncating
- * the string or appending spaces as necessary.
+ * Convert a potential category string into a category string of exactly 5
+ * characters either by truncating the string or appending spaces as necessary.
+ *
* @param cat the string to convert.
* @return a string of exactly 5 characters.
*/
@@ -59,27 +70,31 @@ default int compareTo(ILicenseFamily other) {
*/
interface Builder {
/**
- * Sets the license family category. Will trim or extends the string with spaces to ensure that it is
- * exactly 5 characters.
+ * Sets the license family category. Will trim or extends the string with spaces
+ * to ensure that it is exactly 5 characters.
+ *
* @param licenseFamilyCategory the category string
* @return this builder for chaining.
*/
Builder setLicenseFamilyCategory(String licenseFamilyCategory);
/**
- * Sets the license family name.
+ * Sets the license family name.
+ *
* @param licenseFamilyName the name string
* @return this builder for chaining.
*/
Builder setLicenseFamilyName(String licenseFamilyName);
-
+
/**
* Gets the category that this builder is building.
+ *
* @return the category that this builder is building.
*/
String getCategory();
/**
+ * Builds the defined license family.
* @return a new ILicenseFamily instance.
*/
ILicenseFamily build();
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/LicenseFamilySetFactory.java b/apache-rat-core/src/main/java/org/apache/rat/license/LicenseFamilySetFactory.java
index 464987933..6e60798c9 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/LicenseFamilySetFactory.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/LicenseFamilySetFactory.java
@@ -58,14 +58,14 @@ public static SortedSet emptyLicenseFamilySet() {
*/
public SortedSet getFamilies(LicenseFilter filter) {
switch (filter) {
- case all:
+ case ALL:
return Collections.unmodifiableSortedSet(families);
- case approved:
+ case APPROVED:
SortedSet result = emptyLicenseFamilySet();
families.stream().filter(x -> approvedLicenses.contains(x.getFamilyCategory()))
.forEach(result::add);
return result;
- case none:
+ case NONE:
default:
return Collections.emptySortedSet();
}
@@ -80,14 +80,14 @@ public SortedSet getFamilies(LicenseFilter filter) {
public SortedSet getFamilyIds(LicenseFilter filter) {
SortedSet result = new TreeSet<>();
switch (filter) {
- case all:
+ case ALL:
families.stream().map(ILicenseFamily::getFamilyCategory)
.forEach(result::add);
break;
- case approved:
+ case APPROVED:
result.addAll(approvedLicenses);
break;
- case none:
+ case NONE:
default:
// do nothing
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/LicenseSetFactory.java b/apache-rat-core/src/main/java/org/apache/rat/license/LicenseSetFactory.java
index 40bbe20ee..7752b4712 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/LicenseSetFactory.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/LicenseSetFactory.java
@@ -15,44 +15,52 @@
* KIND, either express or implied. See the License for the *
* specific language governing permissions and limitations *
* under the License. *
- */package org.apache.rat.license;
+ */
+package org.apache.rat.license;
import java.util.Collection;
import java.util.Collections;
import java.util.SortedSet;
import java.util.TreeSet;
+import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.analysis.IHeaders;
+
/**
- * Class to take a set of ILicenses and collection of approved license categories and extract Subsets.
+ * Class to take a set of ILicenses and collection of approved license
+ * categories and extract Subsets.
*/
public class LicenseSetFactory {
-
+
/**
* An enum that defines the types of Licenses to extract.
*/
public enum LicenseFilter {
/** All defined licenses are returned */
- all,
+ ALL,
/** Only approved licenses are returned */
- approved,
+ APPROVED,
/** No licenses are returned */
- none;
-
- /**
- * Converts from a String to an enum value.
- * @param s String representation.
- * @return given licenseFilter for the given String representation.
- */
+ NONE;
+
+ /**
+ * Converts from a String to an enum value.
+ *
+ * @param s String representation.
+ * @return given licenseFilter for the given String representation.
+ */
static public LicenseFilter fromText(String s) {
- return LicenseFilter.valueOf(s.toLowerCase());
+ return LicenseFilter.valueOf(s.toUpperCase());
}
}
private final SortedSet licenses;
private final Collection approvedLicenses;
-
+
/**
- * Constructs a factory with the specified set of Licenses and the approved license collection.
+ * Constructs a factory with the specified set of Licenses and the approved
+ * license collection.
+ *
* @param licenses the set of defined licenses.
* @param approvedLicenses the list of approved licenses.
*/
@@ -60,9 +68,10 @@ public LicenseSetFactory(SortedSet licenses, Collection approv
this.licenses = licenses;
this.approvedLicenses = approvedLicenses;
}
-
+
/**
* Create an empty sorted Set with proper comparator.
+ *
* @return An empty sorted set of ILicense objects.
*/
public static SortedSet emptyLicenseSet() {
@@ -71,72 +80,74 @@ public static SortedSet emptyLicenseSet() {
/**
* Create a sorted set of licenses families from the collection.
+ *
* @param licenses the collection of all licenses.
* @return a SortedSet of license families from the collection.
*/
private static SortedSet extractFamily(Collection licenses) {
SortedSet result = new TreeSet<>();
- licenses.stream().map( ILicense::getLicenseFamily ).forEach(result::add);
+ licenses.stream().map(ILicense::getLicenseFamily).forEach(result::add);
return result;
}
/**
* Gets the License objects based on the filter.
+ *
* @param filter the types of LicenseFamily objects to return.
* @return a SortedSet of ILicense objects.
*/
public SortedSet getLicenses(LicenseFilter filter) {
switch (filter) {
- case all:
+ case ALL:
return Collections.unmodifiableSortedSet(licenses);
- case approved:
+ case APPROVED:
SortedSet result = LicenseSetFactory.emptyLicenseSet();
licenses.stream().filter(x -> approvedLicenses.contains(x.getLicenseFamily().getFamilyCategory()))
.forEach(result::add);
return result;
- case none:
+ case NONE:
default:
return Collections.emptySortedSet();
}
}
-
+
/**
* Gets the LicenseFamily objects based on the filter.
+ *
* @param filter the types of LicenseFamily objects to return.
* @return a SortedSet of ILicenseFamily objects.
*/
public SortedSet getLicenseFamilies(LicenseFilter filter) {
switch (filter) {
- case all:
+ case ALL:
return extractFamily(licenses);
- case approved:
+ case APPROVED:
SortedSet result = LicenseFamilySetFactory.emptyLicenseFamilySet();
licenses.stream().map(ILicense::getLicenseFamily)
- .filter(x -> approvedLicenses.contains(x.getFamilyCategory()))
- .forEach(result::add);
+ .filter(x -> approvedLicenses.contains(x.getFamilyCategory())).forEach(result::add);
return result;
- case none:
+ case NONE:
default:
return Collections.emptySortedSet();
}
}
-
+
/**
* Gets the categories of LicenseFamily objects based on the filter.
+ *
* @param filter the types of LicenseFamily objects to return.
* @return a SortedSet of ILicenseFamily categories.
*/
public SortedSet getLicenseFamilyIds(LicenseFilter filter) {
SortedSet result = new TreeSet<>();
switch (filter) {
- case all:
- licenses.stream().map(x -> x.getLicenseFamily().getFamilyCategory())
- .forEach(result::add);
+ case ALL:
+ licenses.stream().map(x -> x.getLicenseFamily().getFamilyCategory()).forEach(result::add);
break;
- case approved:
+ case APPROVED:
result.addAll(approvedLicenses);
break;
- case none:
+ case NONE:
default:
// do nothing
}
@@ -145,7 +156,7 @@ public SortedSet getLicenseFamilyIds(LicenseFilter filter) {
/**
* Search a SortedSet of licenses for the matching license id.
- *
+ *
* @param licenseId the id to search for.
* @param licenses the SortedSet of licenses to search.
* @return the matching license or {@code null} if not found.
@@ -154,65 +165,55 @@ public static ILicense search(String licenseId, SortedSet licenses) {
ILicenseFamily searchFamily = ILicenseFamily.builder().setLicenseFamilyCategory(licenseId)
.setLicenseFamilyName("searching proxy").build();
ILicense target = new ILicense() {
-
+
@Override
public String getId() {
return licenseId;
}
-
+
@Override
public void reset() {
// do nothing
}
-
+
@Override
- public State matches(String line) {
- return State.f;
+ public boolean matches(IHeaders headers) {
+ return false;
}
-
+
@Override
public int compareTo(ILicense arg0) {
return searchFamily.compareTo(arg0.getLicenseFamily());
}
-
+
@Override
public ILicenseFamily getLicenseFamily() {
return searchFamily;
}
-
- @Override
- public String getNotes() {
- return null;
- }
-
+
@Override
- public String derivedFrom() {
+ public String getNote() {
return null;
}
-
+
@Override
public String getName() {
return searchFamily.getFamilyName();
}
-
- @Override
- public State finalizeState() {
- return State.f;
- }
-
+
@Override
- public State currentState() {
- return State.f;
+ public IHeaderMatcher getMatcher() {
+ return null;
}
-
+
};
return search(target, licenses);
}
/**
* Search a SortedSet of licenses for the matching license.
- *
- * @param target the license to search for.
+ *
+ * @param target the license to search for. Must not be null.
* @param licenses the SortedSet of licenses to search.
* @return the matching license or {@code null} if not found.
*/
@@ -220,5 +221,4 @@ public static ILicense search(ILicense target, SortedSet licenses) {
SortedSet part = licenses.tailSet(target);
return (!part.isEmpty() && part.first().compareTo(target) == 0) ? part.first() : null;
}
-
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
index 18e4f7609..f8a3c7b7e 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
@@ -18,59 +18,64 @@
*/
package org.apache.rat.license;
+import java.util.ArrayList;
+import java.util.List;
import java.util.Objects;
+import java.util.SortedSet;
import org.apache.commons.lang3.StringUtils;
+import org.apache.rat.ConfigurationException;
+import org.apache.rat.ImplementationException;
import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.analysis.IHeaders;
+import org.apache.rat.config.parameters.ComponentType;
+import org.apache.rat.config.parameters.ConfigComponent;
+import org.apache.rat.config.parameters.Description;
+import org.apache.rat.config.parameters.DescriptionBuilder;
/**
* A simple implementation of ILicense.
*/
-class SimpleLicense implements ILicense {
+@ConfigComponent(type = ComponentType.LICENSE)
+public class SimpleLicense implements ILicense {
+ @ConfigComponent(type = ComponentType.BULID_PARAMETER, desc = "The defined license families.", name = "licenseFamilies")
private ILicenseFamily family;
+
+ @ConfigComponent(type = ComponentType.PARAMETER, desc = "The matcher for this license.", required = true)
private IHeaderMatcher matcher;
- private String derivedFrom;
- private String notes;
+ @ConfigComponent(type = ComponentType.PARAMETER, desc = "The notes about this license.")
+ private String note;
+ @ConfigComponent(type = ComponentType.PARAMETER, desc = "The name of this license.")
private String name;
+ @ConfigComponent(type = ComponentType.PARAMETER, desc = "The ID for this license.")
private String id;
- SimpleLicense(ILicenseFamily family, IHeaderMatcher matcher, String derivedFrom, String notes, String name, String id) {
+ SimpleLicense(ILicenseFamily family, IHeaderMatcher matcher, String notes, String name, String id) {
Objects.requireNonNull(matcher, "Matcher must not be null");
- Objects.requireNonNull(family, "Family must not be null");
+ Objects.requireNonNull(family, "Family must not be null");
this.family = family;
this.matcher = matcher;
- this.derivedFrom = derivedFrom;
- this.notes = notes;
+ this.note = notes;
this.name = StringUtils.defaultIfBlank(name, family.getFamilyName());
this.id = StringUtils.defaultIfBlank(id, family.getFamilyCategory().trim());
}
@Override
public String toString() {
- return String.format( "%s:%s", getId(), getName());
+ return String.format("%s:%s", getId(), getName());
}
- public ILicenseFamily getFamily() {
- return family;
- }
-
- public void setFamily(ILicenseFamily family) {
- this.family = family;
+ @ConfigComponent(type = ComponentType.PARAMETER, desc = "The license family cagetory for this license.", required = true)
+ public String getFamily() {
+ return family.getFamilyCategory();
}
+ @Override
public IHeaderMatcher getMatcher() {
return matcher;
}
- public void setMatcher(IHeaderMatcher matcher) {
- this.matcher = matcher;
- }
-
- public void setDerivedFrom(String derivedFrom) {
- this.derivedFrom = derivedFrom;
- }
-
@Override
public String getId() {
return id;
@@ -82,19 +87,9 @@ public void reset() {
}
@Override
- public State matches(String line) {
+ public boolean matches(IHeaders line) {
return matcher.matches(line);
}
-
- @Override
- public State finalizeState() {
- return matcher.finalizeState();
- }
-
- @Override
- public State currentState() {
- return matcher.currentState();
- }
@Override
public ILicenseFamily getLicenseFamily() {
@@ -107,17 +102,134 @@ public int compareTo(ILicense other) {
}
@Override
- public String getNotes() {
- return notes;
+ public String getNote() {
+ return note;
}
- @Override
- public String derivedFrom() {
- return derivedFrom;
- }
-
@Override
public String getName() {
return name;
}
-}
+
+ @Override
+ public Description getDescription() {
+ return DescriptionBuilder.build(this);
+ }
+
+ public static class Builder implements ILicense.Builder {
+
+ private SortedSet licenseFamilies;
+
+ private IHeaderMatcher.Builder matcher;
+
+ private List notes = new ArrayList<>();
+
+ private String name;
+
+ private String id;
+
+ private String familyCategory;
+
+ /**
+ * Sets the matcher from a builder.
+ *
+ * @param matcher the builder for the matcher for the license.
+ * @return this builder for chaining.
+ */
+ @Override
+ public Builder setMatcher(IHeaderMatcher.Builder matcher) {
+ this.matcher = matcher;
+ return this;
+ }
+
+ /**
+ * Sets the matcher.
+ *
+ * @param matcher the matcher for the license.
+ * @return this builder for chaining.
+ */
+ @Override
+ public Builder setMatcher(IHeaderMatcher matcher) {
+ this.matcher = () -> matcher;
+ return this;
+ }
+
+ /**
+ * Sets the notes for the license. If called multiple times the notes are
+ * concatenated to create a single note.
+ *
+ * @param note the note for the license.
+ * @return this builder.
+ */
+ @Override
+ public Builder setNote(String note) {
+ if (StringUtils.isNotBlank(note)) {
+ this.notes.add(note);
+ }
+ return this;
+ }
+
+ /**
+ * Sets the ID of the license. If the ID is not set then the ID of the license
+ * family is used.
+ *
+ * @param id the ID for the license
+ * @return this builder for chaining.
+ */
+ @Override
+ public Builder setId(String id) {
+ this.id = id;
+ return this;
+ }
+
+ /**
+ * Set the family category for this license. The category must be unique across
+ * all licenses and must be 5 characters. If more than 5 characters are provided
+ * then only the first 5 are taken. If fewer than 5 characters are provided the
+ * category is padded with spaces.
+ *
+ * @param licenseFamilyCategory the family category for the license.
+ * @return this builder for chaining.
+ */
+ @Override
+ public Builder setFamily(String licenseFamilyCategory) {
+ this.familyCategory = licenseFamilyCategory;
+ return this;
+ }
+
+ /**
+ * Sets the name of the license. If the name is not set then the name of the
+ * license family is used.
+ *
+ * @param name the name for the license
+ * @return this builder for chaining.
+ */
+ @Override
+ public Builder setName(String name) {
+ this.name = name;
+ return this;
+ }
+
+ @Override
+ public Builder setLicenseFamilies(SortedSet licenseFamilies) {
+ this.licenseFamilies = licenseFamilies;
+ return this;
+ }
+
+ @Override
+ public SimpleLicense build() {
+ if (matcher == null) {
+ throw new ConfigurationException("'matcher' must not be null");
+ }
+ if (licenseFamilies == null) {
+ throw new ImplementationException("'licenseFamilies' must not be null");
+ }
+ ILicenseFamily family = LicenseFamilySetFactory.search(familyCategory, licenseFamilies);
+ if (family == null) {
+ throw new ConfigurationException(String.format("License family '%s' not found.", familyCategory));
+ }
+
+ return new SimpleLicense(family, matcher.build(), String.join(System.lineSeparator(), notes), name, id);
+ }
+ }
+}
\ No newline at end of file
diff --git a/apache-rat-core/src/main/java/org/apache/rat/policy/DefaultPolicy.java b/apache-rat-core/src/main/java/org/apache/rat/policy/DefaultPolicy.java
index bec67c468..fcb1bc62d 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/policy/DefaultPolicy.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/policy/DefaultPolicy.java
@@ -23,19 +23,20 @@
import java.util.SortedSet;
import org.apache.rat.api.Document;
-import org.apache.rat.api.MetaData;
import org.apache.rat.document.IDocumentAnalyser;
import org.apache.rat.license.ILicenseFamily;
import org.apache.rat.license.LicenseFamilySetFactory;
/**
- * A default Document Analyser that determines if the matched license is in the set of approved licenses.
+ * A default Document Analyser that determines if the matched license is in the
+ * set of approved licenses.
*/
public class DefaultPolicy implements IDocumentAnalyser {
private final SortedSet approvedLicenseFamilies;
/**
* Constructor with the list of approved license families.
+ *
* @param approvedLicenseFamilies the approved license families.
*/
public DefaultPolicy(final Collection approvedLicenseFamilies) {
@@ -44,7 +45,8 @@ public DefaultPolicy(final Collection approvedLicenseFamilies) {
}
/**
- * adds an ILicenseFamily to the list of approved licenses.
+ * Adds an ILicenseFamily to the list of approved licenses.
+ *
* @param approvedLicense license to be approved.
*/
public void add(ILicenseFamily approvedLicense) {
@@ -54,34 +56,17 @@ public void add(ILicenseFamily approvedLicense) {
@Override
public void analyse(final Document document) {
if (document != null) {
- boolean approval;
- if (document.getMetaData().value(MetaData.RAT_URL_HEADER_CATEGORY) != null) {
- ILicenseFamily licenseFamily = ILicenseFamily.builder()
- .setLicenseFamilyCategory(
- document.getMetaData().value(MetaData.RAT_URL_HEADER_CATEGORY))
- .setLicenseFamilyName(document.getMetaData().value(MetaData.RAT_URL_LICENSE_FAMILY_NAME))
- .build();
- approval = approvedLicenseFamilies.contains(licenseFamily);
- reportLicenseApprovalClaim(document, approval);
- }
+ document.getMetaData().setApprovedLicenses(getApprovedLicenseFamilies());
}
}
/**
- * Report if the document as either having approved license or not.
- * @param document the document to approve.
- * @param isAcceptable {@code true} if the license is an approved one, {@code false} otherwise.
- */
- public void reportLicenseApprovalClaim(final Document document, final boolean isAcceptable) {
- document.getMetaData().set(
- isAcceptable ? MetaData.RAT_APPROVED_LICENSE_DATUM_TRUE : MetaData.RAT_APPROVED_LICENSE_DATUM_FALSE);
- }
-
- /**
- * Gets an unmodifiable reference to the SortedSet of approved licenses that this policy is holding.
+ * Gets an unmodifiable reference to the SortedSet of approved licenses that
+ * this policy is holding.
+ *
* @return sorted set of license family definitions.
*/
- public SortedSet getApprovedLicenseNames() {
+ public SortedSet getApprovedLicenseFamilies() {
return Collections.unmodifiableSortedSet(approvedLicenseFamilies);
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/ConfigurationReport.java b/apache-rat-core/src/main/java/org/apache/rat/report/ConfigurationReport.java
new file mode 100644
index 000000000..8e9d82b10
--- /dev/null
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/ConfigurationReport.java
@@ -0,0 +1,52 @@
+/*
+ * 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.report;
+
+import org.apache.rat.ReportConfiguration;
+import org.apache.rat.api.RatException;
+import org.apache.rat.configuration.XMLConfigurationWriter;
+import org.apache.rat.license.LicenseSetFactory.LicenseFilter;
+import org.apache.rat.report.xml.writer.IXmlWriter;
+
+/**
+ * A report that dumps the ReportConfiguration into the XML output.
+ */
+public class ConfigurationReport extends AbstractReport {
+
+ private final ReportConfiguration configuration;
+ private final IXmlWriter writer;
+
+ /**
+ * Constructor.
+ *
+ * @param writer The writer to write the XML data to.
+ * @param configuration the configuration to dump
+ */
+ public ConfigurationReport(IXmlWriter writer, ReportConfiguration configuration) {
+ this.configuration = configuration;
+ this.writer = writer;
+ }
+
+ @Override
+ public void startReport() throws RatException {
+ if (configuration.listFamilies() != LicenseFilter.NONE || configuration.listLicenses() != LicenseFilter.NONE) {
+ new XMLConfigurationWriter(configuration).write(writer);
+ }
+ }
+}
\ No newline at end of file
diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/claim/ClaimStatistic.java b/apache-rat-core/src/main/java/org/apache/rat/report/claim/ClaimStatistic.java
index 578e8f673..3f08d7f7f 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/report/claim/ClaimStatistic.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/claim/ClaimStatistic.java
@@ -19,100 +19,62 @@
package org.apache.rat.report.claim;
+import java.util.HashMap;
import java.util.Map;
+import org.apache.rat.api.Document;
+
/**
* This class provides a numerical overview about
* the report.
*/
public class ClaimStatistic {
- private Map documentCategoryMap, licenseFamilyCodeMap, licenseFamilyNameMap;
- private int numApproved, numUnApproved, numGenerated, numUnknown;
-
- /**
- * @return Returns the number of files with approved licenses.
- */
- public int getNumApproved() {
- return numApproved;
- }
-
- /**
- * Sets the number of files with approved licenses.
- * @param pNumApproved number of files with approved licenses.
- */
- public void setNumApproved(int pNumApproved) {
- numApproved = pNumApproved;
- }
-
- /**
- * @return Returns the number of files with unapproved licenses.
- * Note: This might include files with unknown
- * licenses.
- * @see #getNumUnknown()
- */
- public int getNumUnApproved() {
- return numUnApproved;
- }
-
- /**
- * Sets the number of files with unapproved licenses.
- * @param pNumUnApproved number of files with unapproved licenses.
- */
- public void setNumUnApproved(int pNumUnApproved) {
- numUnApproved = pNumUnApproved;
- }
-
- /**
- * @return Returns the number of generated files.
- */
- public int getNumGenerated() {
- return numGenerated;
- }
+ /** The counter types */
+ public enum Counter {
+ /** count of approved files */
+ APPROVED,
+ /** count of unapproved files */
+ UNAPPROVED,
+ /** count of generated files */
+ GENERATED,
+ /** count of unknown files */
+ UNKNOWN };
+
+ private final Map licenseFamilyNameMap = new HashMap<>();
+ private final Map licenseFamilyCodeMap = new HashMap<>();
+ private final Map documentCategoryMap = new HashMap<>();
+ private final Map counterMap = new HashMap<>();
- /**
- * Sets the number of generated files.
- * @param pNumGenerated the number of generated files.
- */
- public void setNumGenerated(int pNumGenerated) {
- numGenerated = pNumGenerated;
- }
/**
- * @return Returns the number of files, which are neither
- * generated nor have a known license header.
- */
- public int getNumUnknown() {
- return numUnknown;
- }
-
- /**
- * Sets the number of files, which are neither
- * generated nor have a known license header.
- * @param pNumUnknown set number of files.
+ * Returns the counts for the counter.
+ * @param counter the counter to get the value for.
+ * @return Returns the number of files with approved licenses.
*/
- public void setNumUnknown(int pNumUnknown) {
- numUnknown = pNumUnknown;
+ public int getCounter(Counter counter) {
+ int[] count = counterMap.get(counter);
+ return count == null ? 0 : count[0];
}
/**
- * Sets a map with the file types. The map keys
+ * @return Returns a map with the file types. The map keys
* are file type names and the map values
* are integers with the number of resources matching
* the file type.
- * @param pDocumentCategoryMap doc-category map.
*/
- public void setDocumentCategoryMap(Map pDocumentCategoryMap) {
- documentCategoryMap = pDocumentCategoryMap;
+ public Map getCounterMap() {
+ return counterMap;
}
+
/**
* @return Returns a map with the file types. The map keys
* are file type names and the map values
* are integers with the number of resources matching
* the file type.
*/
- public Map getDocumentCategoryMap() {
+ public Map getDocumentCategoryMap() {
return documentCategoryMap;
}
@@ -122,39 +84,18 @@ public Map getDocumentCategoryMap() {
* the map values are integers with the number of resources
* matching the license family code.
*/
- public Map getLicenseFileCodeMap() {
+ public Map getLicenseFamilyCodeMap() {
return licenseFamilyCodeMap;
}
- /**
- * Sets a map with the license family codes. The map
- * keys are instances of license family category names and
- * the map values are integers with the number of resources
- * matching the license family code.
- * @param pLicenseFamilyCodeMap license family map.
- */
- public void setLicenseFileCodeMap(Map pLicenseFamilyCodeMap) {
- licenseFamilyCodeMap = pLicenseFamilyCodeMap;
- }
-
/**
* @return Returns a map with the license family codes. The map
* keys are the names of the license families and
* the map values are integers with the number of resources
* matching the license family name.
*/
- public Map getLicenseFileNameMap() {
+ public Map getLicenseFileNameMap() {
return licenseFamilyNameMap;
}
- /**
- * Sets map with the license family codes. The map
- * keys are the name of the license families and
- * the map values are integers with the number of resources
- * matching the license family name.
- * @param pLicenseFamilyNameMap license family-name map.
- */
- public void setLicenseFileNameMap(Map pLicenseFamilyNameMap) {
- licenseFamilyNameMap = pLicenseFamilyNameMap;
- }
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/AbstractClaimReporter.java b/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/AbstractClaimReporter.java
index ee059b649..ad56a97aa 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/AbstractClaimReporter.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/AbstractClaimReporter.java
@@ -19,9 +19,12 @@
package org.apache.rat.report.claim.impl;
+import java.util.stream.Collectors;
+
import org.apache.rat.api.Document;
import org.apache.rat.api.MetaData;
import org.apache.rat.api.RatException;
+import org.apache.rat.license.ILicense;
import org.apache.rat.report.AbstractReport;
@@ -32,23 +35,26 @@
*/
public abstract class AbstractClaimReporter extends AbstractReport {
/**
- * Empty default implementation.
- * @param documentCategoryName name of the category
+ * Increment the document type counter.
+ * The default implementations does nothing.
+ * @param type The document type counter to increment.
*/
- protected void handleDocumentCategoryClaim(String documentCategoryName) {
+ protected void handleDocumentCategoryClaim(Document.Type type) {
// Does nothing
}
/**
- * Empty default implementation.
- * @param licenseApproved name of the approved license
+ * Increment the approved license claim.
+ * The default implementation does nothing.
+ * @param metadata The metadata for the document
*/
- protected void handleApprovedLicenseClaim(String licenseApproved) {
+ protected void handleApprovedLicenseClaim(MetaData metadata) {
// Does nothing
}
/**
- * Empty default implementation.
+ * Increment the license family counter
+ * The default implementation does nothing.
* @param licenseFamilyName name of the license family
*/
protected void handleLicenseFamilyNameClaim(String licenseFamilyName) {
@@ -56,63 +62,20 @@ protected void handleLicenseFamilyNameClaim(String licenseFamilyName) {
}
/**
- * Empty default implementation.
- * @param headerCategory name of the header category
+ * Increment the license category count.
+ * The default implementation does nothing.
+ * @param license the license to record the category for.
*/
- protected void handleHeaderCategoryClaim(String headerCategory) {
+ protected void handleHeaderCategoryClaim(ILicense license) {
// Does nothing
}
- private void writeDocumentClaim(Document subject) {
- final MetaData metaData = subject.getMetaData();
- writeHeaderCategory(metaData);
- writeLicenseFamilyName(metaData);
- writeDocumentCategory(metaData);
- writeApprovedLicenseClaim(metaData);
- }
-
- private void writeApprovedLicenseClaim(final MetaData metaData) {
- final MetaData.Datum approvedLicenseDatum = metaData.get(MetaData.RAT_URL_APPROVED_LICENSE);
- if (approvedLicenseDatum != null) {
- final String approvedLicense = approvedLicenseDatum.getValue();
- if (approvedLicense != null) {
- handleApprovedLicenseClaim(approvedLicense);
- }
- }
- }
-
- private void writeHeaderCategory(final MetaData metaData) {
- final MetaData.Datum headerCategoryDatum = metaData.get(MetaData.RAT_URL_HEADER_CATEGORY);
- if (headerCategoryDatum != null) {
- final String headerCategory = headerCategoryDatum.getValue();
- if (headerCategory != null) {
- handleHeaderCategoryClaim(headerCategory);
- }
- }
- }
-
- private void writeLicenseFamilyName(final MetaData metaData) {
- final MetaData.Datum licenseFamilyNameDatum = metaData.get(MetaData.RAT_URL_LICENSE_FAMILY_NAME);
- if (licenseFamilyNameDatum != null) {
- final String licenseFamilyName = licenseFamilyNameDatum.getValue();
- if (licenseFamilyName != null) {
- handleLicenseFamilyNameClaim(licenseFamilyName);
- }
- }
- }
-
- private void writeDocumentCategory(final MetaData metaData) {
- final MetaData.Datum documentCategoryDatum = metaData.get(MetaData.RAT_URL_DOCUMENT_CATEGORY);
- if (documentCategoryDatum != null) {
- final String documentCategory = documentCategoryDatum.getValue();
- if (documentCategory != null) {
- handleDocumentCategoryClaim(documentCategory);
- }
- }
- }
-
@Override
public void report(Document subject) throws RatException {
- writeDocumentClaim(subject);
+ final MetaData metaData = subject.getMetaData();
+ metaData.licenses().forEach(this::handleHeaderCategoryClaim);
+ metaData.licenses().map(lic -> lic.getLicenseFamily().getFamilyName()).collect(Collectors.toSet()).forEach(this::handleLicenseFamilyNameClaim);
+ handleDocumentCategoryClaim(metaData.getDocumentType());
+ handleApprovedLicenseClaim(metaData);
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/ClaimAggregator.java b/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/ClaimAggregator.java
index cef444589..598d4a16b 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/ClaimAggregator.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/ClaimAggregator.java
@@ -19,84 +19,80 @@
package org.apache.rat.report.claim.impl;
+import java.util.Map;
+
+import org.apache.rat.api.Document;
import org.apache.rat.api.MetaData;
import org.apache.rat.api.RatException;
+import org.apache.rat.license.ILicense;
+import org.apache.rat.license.ILicenseFamily;
import org.apache.rat.report.claim.ClaimStatistic;
-
-import java.util.HashMap;
-import java.util.Map;
-
+import org.apache.rat.report.claim.ClaimStatistic.Counter;
/**
- * The aggregator is used to create a numerical statistic
- * of claims.
+ * The aggregator is used to create a numerical statistic of claims.
*/
public class ClaimAggregator extends AbstractClaimReporter {
private final ClaimStatistic statistic;
- private final Map numsByLicenseFamilyName = new HashMap<>();
- private final Map numsByLicenseFamilyCode = new HashMap<>();
- private final Map numsByFileType = new HashMap<>();
- private int numApproved, numUnApproved, numGenerated, numUnknown;
- public ClaimAggregator(ClaimStatistic pStatistic) {
- statistic = pStatistic;
+ /**
+ * Constructor.
+ * @param statistic The statistic to store the statistics in.
+ */
+ public ClaimAggregator(ClaimStatistic statistic) {
+ this.statistic = statistic;
}
-
- private void incMapValue(Map pMap, String pKey) {
- final Integer num = pMap.get(pKey);
- final int newNum;
+
+ private void incMapValue(Map map, T key, int value) {
+ final int[] num = map.get(key);
+
if (num == null) {
- newNum = 1;
+ map.put(key, new int[] { value });
} else {
- newNum = num + 1;
+ num[0] += value;
}
- pMap.put(pKey, newNum);
}
-
+
@Override
- protected void handleDocumentCategoryClaim(String documentCategoryName) {
- incMapValue(numsByFileType, documentCategoryName);
+ protected void handleDocumentCategoryClaim(Document.Type documentType) {
+ incMapValue(statistic.getDocumentCategoryMap(), documentType, 1);
}
@Override
- protected void handleApprovedLicenseClaim(String licenseApproved) {
- if (MetaData.RAT_APPROVED_LICENSE_VALUE_TRUE.equals(licenseApproved)) {
- numApproved++;
+ protected void handleApprovedLicenseClaim(MetaData metadata) {
+ incValueMap(statistic.getCounterMap(), ClaimStatistic.Counter.APPROVED, (int) metadata.approvedLicenses().count());
+ incValueMap(statistic.getCounterMap(), ClaimStatistic.Counter.UNAPPROVED,
+ (int) metadata.unapprovedLicenses().count());
+ }
+
+ private void incValueMap(Map map, Counter key, int value) {
+ final int[] num = map.get(key);
+
+ if (num == null) {
+ map.put(key, new int[] { value });
} else {
- numUnApproved++;
+ num[0] += value;
}
}
@Override
protected void handleLicenseFamilyNameClaim(String licenseFamilyName) {
- incMapValue(numsByLicenseFamilyName, licenseFamilyName);
+ incMapValue(statistic.getLicenseFileNameMap(), licenseFamilyName, 1);
}
@Override
- protected void handleHeaderCategoryClaim(String headerCategory) {
-
- if (MetaData.RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN.equals(headerCategory)) {
- numGenerated++;
- incMapValue(numsByLicenseFamilyCode, MetaData.RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN);
- } else if (MetaData.RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN.equals(headerCategory)) {
- numUnknown++;
- incMapValue(numsByLicenseFamilyCode, MetaData.RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN);
+ protected void handleHeaderCategoryClaim(ILicense license) {
+ String category = license.getLicenseFamily().getFamilyCategory();
+ if (category.equals(ILicenseFamily.GENTERATED_CATEGORY)) {
+ incValueMap(statistic.getCounterMap(), Counter.GENERATED, 1);
+ } else if (category.equals(ILicenseFamily.UNKNOWN_CATEGORY)) {
+ incValueMap(statistic.getCounterMap(), Counter.UNKNOWN, 1);
}
- }
-
- public void fillClaimStatistic(ClaimStatistic pStatistic) {
- pStatistic.setDocumentCategoryMap(numsByFileType);
- pStatistic.setLicenseFileCodeMap(numsByLicenseFamilyCode);
- pStatistic.setLicenseFileNameMap(numsByLicenseFamilyName);
- pStatistic.setNumApproved(numApproved);
- pStatistic.setNumGenerated(numGenerated);
- pStatistic.setNumUnApproved(numUnApproved);
- pStatistic.setNumUnknown(numUnknown);
+ incMapValue(statistic.getLicenseFamilyCodeMap(), category, 1);
}
@Override
public void endReport() throws RatException {
super.endReport();
- fillClaimStatistic(statistic);
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/xml/SimpleXmlClaimReporter.java b/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/xml/SimpleXmlClaimReporter.java
index 43185931c..b0c4a4a94 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/xml/SimpleXmlClaimReporter.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/xml/SimpleXmlClaimReporter.java
@@ -15,123 +15,83 @@
* 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.impl.xml;
+import java.io.IOException;
+import java.util.Calendar;
+import java.util.Iterator;
+
+import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.time.DateFormatUtils;
import org.apache.rat.api.Document;
import org.apache.rat.api.MetaData;
import org.apache.rat.api.RatException;
+import org.apache.rat.license.ILicense;
import org.apache.rat.report.AbstractReport;
import org.apache.rat.report.xml.writer.IXmlWriter;
-import org.apache.rat.report.xml.writer.impl.base.XmlWriter;
-
-import java.io.IOException;
-import java.util.Calendar;
public class SimpleXmlClaimReporter extends AbstractReport {
private static final String RAT_REPORT = "rat-report";
private static final String TIMESTAMP = "timestamp";
- private static final String LICENSE_APPROVAL_PREDICATE = "license-approval";
- private static final String LICENSE_FAMILY_PREDICATE = "license-family";
- private static final String HEADER_SAMPLE_PREDICATE = "header-sample";
- private static final String HEADER_TYPE_PREDICATE = "header-type";
- private static final String FILE_TYPE_PREDICATE = "type";
+ private static final String RESOURCE = "resource";
+ private static final String LICENSE = "license";
+ private static final String APPROVAL = "approval";
+ private static final String FAMILY = "family";
+ private static final String NOTES = "notes";
+ private static final String SAMPLE = "sample";
+ private static final String TYPE = "type";
+ private static final String ID = "id";
private final IXmlWriter writer;
private static final String NAME = "name";
- private boolean firstTime = true;
public SimpleXmlClaimReporter(final IXmlWriter writer) {
this.writer = writer;
}
-
- /**
- * Writes a single claim to the XML file.
- * @param pPredicate The claims predicate.
- * @param pObject The claims object.
- * @param pLiteral Whether to write the object as an element (true),
- * or an attribute (false).
- * @throws IOException An I/O error occurred while writing the claim.
- * @throws RatException Another error occurred while writing the claim.
- */
- protected void writeClaim(String pPredicate, String pObject, boolean pLiteral)
- throws IOException, RatException {
- if (pLiteral) {
- writer.openElement(pPredicate).content(pObject).closeElement();
- } else {
- writer.openElement(pPredicate).attribute(NAME, pObject).closeElement();
- }
- }
-
@Override
public void report(final Document subject) throws RatException {
try {
- if (firstTime) {
- firstTime = false;
- } else {
- writer.closeElement();
- }
- writer.openElement("resource").attribute(NAME, subject.getName());
writeDocumentClaims(subject);
} catch (IOException e) {
- throw new RatException("XML writing failure: " + e.getMessage()
- + " subject: " + subject, e);
- }
- }
-
- private void writeDocumentClaims(final Document subject) throws IOException, RatException {
- final MetaData metaData = subject.getMetaData();
- writeHeaderSample(metaData);
- writeHeaderCategory(metaData);
- writeLicenseFamilyName(metaData);
- writeApprovedLicense(metaData);
- writeDocumentCategory(metaData);
- }
-
- private void writeApprovedLicense(final MetaData metaData) throws IOException, RatException {
- final String approvedLicense = metaData.value(MetaData.RAT_URL_APPROVED_LICENSE);
- if (approvedLicense != null) {
- writeClaim(LICENSE_APPROVAL_PREDICATE, approvedLicense, false);
+ throw new RatException("XML writing failure: " + e.getMessage() + " subject: " + subject, e);
}
}
- private void writeLicenseFamilyName(final MetaData metaData) throws IOException, RatException {
- final String licenseFamilyName = metaData.value(MetaData.RAT_URL_LICENSE_FAMILY_NAME);
- if (licenseFamilyName != null) {
- writeClaim(LICENSE_FAMILY_PREDICATE, licenseFamilyName, false);
+ private void writeLicenseClaims(ILicense license, MetaData metaData) throws IOException {
+ writer.openElement(LICENSE).attribute(ID, license.getId()).attribute(NAME, license.getName())
+ .attribute(APPROVAL, Boolean.valueOf(metaData.isApproved(license)).toString())
+ .attribute(FAMILY, license.getLicenseFamily().getFamilyCategory());
+ if (StringUtils.isNotBlank(license.getNote())) {
+ writer.openElement(NOTES).cdata(license.getNote()).closeElement();
}
+ writer.closeElement();
}
- private void writeHeaderCategory(final MetaData metaData) throws IOException, RatException {
- final String headerCategory = metaData.value(MetaData.RAT_URL_HEADER_CATEGORY);
- if (headerCategory != null) {
- writeClaim(HEADER_TYPE_PREDICATE, headerCategory, false);
- }
- }
-
- private void writeHeaderSample(final MetaData metaData) throws IOException, RatException {
- final String sample = metaData.value(MetaData.RAT_URL_HEADER_SAMPLE);
- if (sample != null) {
- writeClaim(HEADER_SAMPLE_PREDICATE, sample, true);
+ private void writeDocumentClaims(final Document subject) throws IOException {
+ final MetaData metaData = subject.getMetaData();
+ writer.openElement(RESOURCE).attribute(NAME, subject.getName()).attribute(TYPE,
+ metaData.getDocumentType().toString());
+ for (Iterator iter = metaData.licenses().iterator(); iter.hasNext();) {
+ writeLicenseClaims(iter.next(), metaData);
}
+ writeHeaderSample(metaData);
+ writer.closeElement();
}
- private void writeDocumentCategory(final MetaData metaData) throws IOException, RatException {
- final String documentCategory = metaData.value(MetaData.RAT_URL_DOCUMENT_CATEGORY);
- if (documentCategory != null) {
- writeClaim(FILE_TYPE_PREDICATE, documentCategory, false);
+ private void writeHeaderSample(final MetaData metaData) throws IOException {
+ final String sample = metaData.getSampleHeader();
+ if (StringUtils.isNotBlank(sample)) {
+ writer.openElement(SAMPLE).cdata(sample).closeElement();
}
}
@Override
public void startReport() throws RatException {
try {
- writer.openElement(RAT_REPORT)
- .attribute(TIMESTAMP,
- DateFormatUtils.ISO_8601_EXTENDED_DATETIME_TIME_ZONE_FORMAT
- .format(Calendar.getInstance()));
+ writer.openElement(RAT_REPORT).attribute(TIMESTAMP,
+ DateFormatUtils.ISO_8601_EXTENDED_DATETIME_TIME_ZONE_FORMAT.format(Calendar.getInstance()));
} catch (IOException e) {
throw new RatException("Cannot open start element", e);
}
@@ -140,9 +100,9 @@ public void startReport() throws RatException {
@Override
public void endReport() throws RatException {
try {
- writer.closeDocument();
+ writer.closeElement();
} catch (IOException e) {
- throw new RatException("Cannot close last element", e);
+ throw new RatException("Cannot close start element: "+RAT_REPORT, e);
}
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/claim/util/ClaimReporterMultiplexer.java b/apache-rat-core/src/main/java/org/apache/rat/report/claim/util/ClaimReporterMultiplexer.java
index 572d7b9cb..dead792e6 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/report/claim/util/ClaimReporterMultiplexer.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/claim/util/ClaimReporterMultiplexer.java
@@ -15,49 +15,66 @@
* 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.util;
+import java.util.List;
+
import org.apache.rat.api.Document;
import org.apache.rat.api.RatException;
import org.apache.rat.document.IDocumentAnalyser;
import org.apache.rat.document.RatDocumentAnalysisException;
import org.apache.rat.report.RatReport;
-import java.util.List;
-
-
+/**
+ * Executes a RatReport that multiplexes the running of multiple RatReports
+ */
public class ClaimReporterMultiplexer implements RatReport {
+
private final IDocumentAnalyser analyser;
private final List reporters;
+ private final boolean dryRun;
- public ClaimReporterMultiplexer(final IDocumentAnalyser pAnalyser, final List reporters) {
- analyser = pAnalyser;
+ /**
+ * A multiplexer to run multiple claim reports.
+ * @param dryRun true if this is a dry run.
+ * @param analyser the analyser to use.
+ * @param reporters the reports to execute.
+ */
+ public ClaimReporterMultiplexer(final boolean dryRun, final IDocumentAnalyser analyser,
+ final List reporters) {
+ this.analyser = analyser;
this.reporters = reporters;
+ this.dryRun = dryRun;
}
+ @Override
public void report(Document document) throws RatException {
- if (analyser != null) {
- try {
- analyser.analyse(document);
- } catch (RatDocumentAnalysisException e) {
- throw new RatException(e.getMessage(), e);
+ if (!dryRun) {
+ if (analyser != null) {
+ try {
+ analyser.analyse(document);
+ } catch (RatDocumentAnalysisException e) {
+ throw new RatException(e.getMessage(), e);
+ }
+ }
+ for (RatReport report : reporters) {
+ report.report(document);
}
}
- for (RatReport report : reporters) {
- report.report(document);
- }
}
+ @Override
public void startReport() throws RatException {
for (RatReport report : reporters) {
report.startReport();
- }
+ }
}
+ @Override
public void endReport() throws RatException {
for (RatReport report : reporters) {
report.endReport();
- }
+ }
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/claim/util/LicenseAddingReport.java b/apache-rat-core/src/main/java/org/apache/rat/report/claim/util/LicenseAddingReport.java
index eb0dd83e6..1ca5e16e2 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/report/claim/util/LicenseAddingReport.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/claim/util/LicenseAddingReport.java
@@ -15,34 +15,31 @@
* 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.util;
import java.io.File;
import java.io.IOException;
+import org.apache.rat.analysis.UnknownLicense;
import org.apache.rat.annotation.AbstractLicenseAppender;
import org.apache.rat.annotation.ApacheV2LicenseAppender;
-import org.apache.rat.api.MetaData;
-import org.apache.rat.api.MetaData.Datum;
import org.apache.rat.api.RatException;
import org.apache.rat.report.AbstractReport;
import org.apache.rat.utils.Log;
-
public class LicenseAddingReport extends AbstractReport {
private final AbstractLicenseAppender appender;
public LicenseAddingReport(final Log log, String pCopyrightMsg, boolean pForced) {
- appender = pCopyrightMsg == null ? new ApacheV2LicenseAppender(log) : new ApacheV2LicenseAppender(log,pCopyrightMsg);
+ appender = pCopyrightMsg == null ? new ApacheV2LicenseAppender(log)
+ : new ApacheV2LicenseAppender(log, pCopyrightMsg);
appender.setForce(pForced);
}
@Override
public void report(org.apache.rat.api.Document document) throws RatException {
- final Datum licenseHeader = document.getMetaData().get(MetaData.RAT_URL_HEADER_CATEGORY);
- if (licenseHeader == null
- || MetaData.RAT_LICENSE_FAMILY_CATEGORY_DATUM_UNKNOWN.getValue().equals(licenseHeader.getValue())) {
+ if (document.getMetaData().licenses().anyMatch(lic -> lic.equals(UnknownLicense.INSTANCE))) {
final File file = new File(document.getName());
if (file.isFile()) {
try {
diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlReportFactory.java b/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlReportFactory.java
index b88dbff60..1e5c17d6e 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlReportFactory.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlReportFactory.java
@@ -24,6 +24,7 @@
import org.apache.rat.document.impl.util.DocumentAnalyserMultiplexer;
import org.apache.rat.license.LicenseSetFactory.LicenseFilter;
import org.apache.rat.policy.DefaultPolicy;
+import org.apache.rat.report.ConfigurationReport;
import org.apache.rat.report.RatReport;
import org.apache.rat.report.claim.ClaimStatistic;
import org.apache.rat.report.claim.impl.ClaimAggregator;
@@ -55,17 +56,23 @@ public static RatReport createStandardReport(IXmlWriter writer,
if (statistic != null) {
reporters.add(new ClaimAggregator(statistic));
}
- if (configuration.isAddingLicenses()) {
+ if (configuration.isAddingLicenses() && !configuration.isDryRun()) {
reporters.add(new LicenseAddingReport(configuration.getLog(), configuration.getCopyrightMessage(), configuration.isAddingLicensesForced()));
}
+
+ if (configuration.listFamilies() != LicenseFilter.NONE || configuration.listLicenses() != LicenseFilter.NONE) {
+
+ reporters.add(new ConfigurationReport(writer, configuration));
+ }
+
reporters.add(new SimpleXmlClaimReporter(writer));
final IDocumentAnalyser analyser =
- DefaultAnalyserFactory.createDefaultAnalyser(configuration.getLog(), configuration.getLicenses(LicenseFilter.all));
- final DefaultPolicy policy = new DefaultPolicy(configuration.getLicenseFamilies(LicenseFilter.approved));
+ DefaultAnalyserFactory.createDefaultAnalyser(configuration.getLog(), configuration.getLicenses(LicenseFilter.ALL));
+ final DefaultPolicy policy = new DefaultPolicy(configuration.getLicenseFamilies(LicenseFilter.APPROVED));
final IDocumentAnalyser[] analysers = {analyser, policy};
DocumentAnalyserMultiplexer analysisMultiplexer = new DocumentAnalyserMultiplexer(analysers);
- return new ClaimReporterMultiplexer(analysisMultiplexer, reporters);
+ return new ClaimReporterMultiplexer(configuration.isDryRun(), analysisMultiplexer, reporters);
}
}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java b/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java
index cad0768cc..89fa00dc0 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java
@@ -49,6 +49,16 @@ public interface IXmlWriter extends AutoCloseable {
*/
IXmlWriter openElement(CharSequence elementName) throws IOException;
+ /**
+ * Writes a comment
+ *
+ * @param text the comment text
+ * @return this object
+ * @throws OperationNotAllowedException
+ * if called after the first element has been closed
+ */
+ IXmlWriter comment(CharSequence text) throws IOException;
+
/**
* Writes an attribute of an element.
* Note that this is only allowed directly after {@link #openElement(CharSequence)}
@@ -66,8 +76,8 @@ public interface IXmlWriter extends AutoCloseable {
/**
* Writes content.
- * Calling this method will automatically
- * Note that this method does not use CDATA.
+ * Note that this method does not support CDATA.
+ * This method automatically escapes characters.
*
* @param content the content to write
* @return this object
@@ -77,6 +87,19 @@ public interface IXmlWriter extends AutoCloseable {
*/
IXmlWriter content(CharSequence content) throws IOException;
+ /**
+ * Writes CDATA content.
+ * This method DOES NOT automatically escapes characters.
+ * It will removed enclosed CDATA closing strings (e.g. {@code ]]>}
+ *
+ * @param content the content to write
+ * @return this object
+ * @throws OperationNotAllowedException
+ * if called before any call to {@link #openElement}
+ * or after the first element has been closed
+ */
+ IXmlWriter cdata(CharSequence content) throws IOException;
+
/**
* Closes the last element written.
*
diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/impl/base/XmlWriter.java b/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/impl/base/XmlWriter.java
index 36365a024..2495947d0 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/impl/base/XmlWriter.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/impl/base/XmlWriter.java
@@ -469,6 +469,18 @@ public IXmlWriter openElement(final CharSequence elementName) throws IOException
currentAttributes.clear();
return this;
}
+
+ @Override
+ public IXmlWriter comment(final CharSequence text) throws IOException {
+ if (inElement) {
+ writer.write('>');
+ }
+ inElement = false;
+ writer.write("");
+ return this;
+ }
/**
* Writes an attribute of an element. Note that this is only allowed directly
@@ -514,17 +526,7 @@ private void writeAttributeContent(CharSequence content) throws IOException {
writeEscaped(content, true);
}
- /**
- * Writes content. Calling this method will automatically Note that this method
- * does not use CDATA.
- *
- * @param content the content to write
- * @return this object
- * @throws OperationNotAllowedException if called before any call to
- * {@link #openElement} or after the first element has been closed
- */
- @Override
- public IXmlWriter content(CharSequence content) throws IOException {
+ private void prepareForData() throws IOException {
if (elementNames.isEmpty()) {
if (elementsWritten) {
throw new OperationNotAllowedException("Root element has already been closed.");
@@ -534,15 +536,30 @@ public IXmlWriter content(CharSequence content) throws IOException {
if (inElement) {
writer.write('>');
}
- writeBodyContent(content);
+ }
+
+ @Override
+ public IXmlWriter content(CharSequence content) throws IOException {
+ prepareForData();
+ writeEscaped(content, false);
inElement = false;
return this;
}
- private void writeBodyContent(final CharSequence content) throws IOException {
- writeEscaped(content, false);
+ @Override
+ public IXmlWriter cdata(CharSequence content) throws IOException {
+ prepareForData();
+ StringBuilder sb = new StringBuilder(content);
+ int found;
+ while (-1 != (found = sb.indexOf("]]>"))) {
+ sb.replace(found, found + 3, "");
+ }
+ writer.write(String.format("", sb.toString()));
+ inElement = false;
+ return this;
}
+
private void writeEscaped(final CharSequence content, boolean isAttributeContent) throws IOException {
final int length = content.length();
for (int i = 0; i < length; i++) {
diff --git a/apache-rat-core/src/main/java/org/apache/rat/utils/Log.java b/apache-rat-core/src/main/java/org/apache/rat/utils/Log.java
index 5201bdcbe..4557704fa 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/utils/Log.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/utils/Log.java
@@ -59,51 +59,105 @@ public enum Level {
*/
void log(Level level, String message);
+ /**
+ * Write a log message at the specified level.
+ * @param level the level to write the message at.
+ * @param message the mesage to write.
+ */
default void log(Level level, Object message) {
log(level, message == null ? "NULL" : message.toString());
}
+ /**
+ * Write a message at DEBUG level.
+ * @param message the message to write.
+ */
default void debug(Object message) {
log(Level.DEBUG, message);
}
+ /**
+ * Write a message at INFO level.
+ * @param message the message to write.
+ */
default void info(Object message) {
log(Level.INFO, message);
}
+ /**
+ * Write a message at WARN level.
+ * @param message the message to write.
+ */
default void warn(Object message) {
log(Level.WARN, message);
}
+ /**
+ * Write a message at ERROR level.
+ * @param message the message to write.
+ */
default void error(Object message) {
log(Level.ERROR, message);
}
- default void log(Level level, String message, Throwable t) {
+
+ /**
+ * Write a log message and report throwable stack trace at the specified log level.
+ * @param level the level to report at
+ * @param message the message for the log
+ * @param throwable the throwable
+ */
+ default void log(Level level, String message, Throwable throwable) {
StringWriter writer = new StringWriter(500);
PrintWriter pWriter = new PrintWriter(writer);
pWriter.print(message);
pWriter.print(System.lineSeparator());
- t.printStackTrace(pWriter);
+ throwable.printStackTrace(pWriter);
log(level, writer.toString());
}
- default void log(Level level, Object message, Throwable t){
- log(level, message == null ? "NULL" : message.toString(), t);
+ /**
+ * Write a log message and report throwable stack trace at the specified log level.
+ * @param level the level to report at
+ * @param message the message for the log
+ * @param throwable the throwable
+ */
+ default void log(Level level, Object message, Throwable throwable){
+ log(level, message == null ? "NULL" : message.toString(), throwable);
}
- default void debug(Object message, Throwable t) {
- log(Level.DEBUG, message, t);
+ /**
+ * Write a debug message and report throwable stack trace.
+ * @param message the message for the log
+ * @param throwable the throwable
+ */
+ default void debug(Object message, Throwable throwable) {
+ log(Level.DEBUG, message, throwable);
}
- default void info(Object message, Throwable t) {
- log(Level.INFO, message, t);
+ /**
+ * Write an info message and report throwable stack trace.
+ * @param message the message for the log
+ * @param throwable the throwable
+ */
+ default void info(Object message, Throwable throwable) {
+ log(Level.INFO, message, throwable);
}
- default void warn(Object message, Throwable t) {
- log(Level.WARN, message, t);
+ /**
+ * Write a warn message and report throwable stack trace.
+ * @param message the message for the log
+ * @param throwable the throwable
+ */
+ default void warn(Object message, Throwable throwable) {
+ log(Level.WARN, message, throwable);
}
- default void error(Object message, Throwable t) {
- log(Level.ERROR, message, t);
+ /**
+ * Write an error message and report throwable stack trace.
+ * @param message the message for the log
+ * @param throwable the throwable
+ */
+ default void error(Object message, Throwable throwable) {
+ log(Level.ERROR, message, throwable);
}
}
diff --git a/apache-rat-core/src/main/resources/org/apache/rat/default.xml b/apache-rat-core/src/main/resources/org/apache/rat/default.xml
index 9041f7495..ce884abf7 100644
--- a/apache-rat-core/src/main/resources/org/apache/rat/default.xml
+++ b/apache-rat-core/src/main/resources/org/apache/rat/default.xml
@@ -56,18 +56,15 @@
-
+
Modified CDDL1 license
-
- The contents of this file are subject to the terms of
+ The contents of this file are subject to the terms of
the Common Development and Distribution License (the
"License") You may not use this file except in compliance
with the License.
-
-
+
http://dojotoolkit.org/community/licensing.shtml
@@ -158,17 +155,19 @@
may
be prepared copied published and distributed
+ owner="OASIS Open"/>
-
+
TMF854 Version 1.0
+
+
+
@@ -181,8 +180,7 @@
http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
-
+
diff --git a/apache-rat-core/src/main/resources/org/apache/rat/missing-headers.xsl b/apache-rat-core/src/main/resources/org/apache/rat/missing-headers.xsl
index a5df2b49e..d75e4e764 100644
--- a/apache-rat-core/src/main/resources/org/apache/rat/missing-headers.xsl
+++ b/apache-rat-core/src/main/resources/org/apache/rat/missing-headers.xsl
@@ -21,7 +21,7 @@
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
Files with missing headers:
-
+
diff --git a/apache-rat-core/src/main/resources/org/apache/rat/plain-rat.xsl b/apache-rat-core/src/main/resources/org/apache/rat/plain-rat.xsl
index 2ea353faf..da01cbbe1 100644
--- a/apache-rat-core/src/main/resources/org/apache/rat/plain-rat.xsl
+++ b/apache-rat-core/src/main/resources/org/apache/rat/plain-rat.xsl
@@ -26,24 +26,24 @@ Summary
-------
Generated at:
-Notes:
-Binaries:
-Archives:
-Standards:
+Notes:
+Binaries:
+Archives:
+Standards:
-Apache Licensed:
-Generated Documents:
+Apache Licensed:
+Generated Documents:
JavaDocs are generated, thus a license header is optional.
Generated files do not require license headers.
- Unknown Licenses
-
+ Unknown Licenses
+
*****************************************************
Files with unapproved licenses:
-
+
@@ -51,44 +51,60 @@ Files with unapproved licenses:
*****************************************************
-
+
Archives:
-
+
+
+
*****************************************************
- Files with Apache License headers will be marked AL
- Binary files (which do not require any license headers) will be marked B
- Compressed archives will be marked A
- Notices, licenses etc. will be marked N
+ Documents with unapproved licenses will start with a '!'
+ The next character identifies the document type.
+
+ char type
+ A Archive file
+ B Binary file
+ G Generated file
+ N Notice file
+ S Standard file
+ U Unknown file.
+
+
- !
+ !
-
-
- N
- A
- B
-
- !!!!!
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+ (Unapproved)
+
+
+
+
+
+
*****************************************************
-
+
Printing headers for text files without a valid license header...
-
+
=====================================================
== File:
=====================================================
-
+
diff --git a/apache-rat-core/src/main/resources/org/apache/rat/rat-config.xsd b/apache-rat-core/src/main/resources/org/apache/rat/rat-config.xsd
new file mode 100644
index 000000000..a9f54f758
--- /dev/null
+++ b/apache-rat-core/src/main/resources/org/apache/rat/rat-config.xsd
@@ -0,0 +1,181 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/apache-rat-core/src/main/resources/org/apache/rat/rat-report.xsd b/apache-rat-core/src/main/resources/org/apache/rat/rat-report.xsd
new file mode 100644
index 000000000..7061d9258
--- /dev/null
+++ b/apache-rat-core/src/main/resources/org/apache/rat/rat-report.xsd
@@ -0,0 +1,47 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/apache-rat-core/src/main/resources/org/apache/rat/unapproved-licenses.xsl b/apache-rat-core/src/main/resources/org/apache/rat/unapproved-licenses.xsl
index 040909b4c..b82b6a148 100644
--- a/apache-rat-core/src/main/resources/org/apache/rat/unapproved-licenses.xsl
+++ b/apache-rat-core/src/main/resources/org/apache/rat/unapproved-licenses.xsl
@@ -20,8 +20,9 @@
-Files with unapproved licenses:
-
+Generated at:
+Files with unapproved licenses:
+
diff --git a/apache-rat-core/src/test/java/org/apache/rat/DefaultsTest.java b/apache-rat-core/src/test/java/org/apache/rat/DefaultsTest.java
index ad4ebe5c9..fe7f31e51 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/DefaultsTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/DefaultsTest.java
@@ -29,6 +29,7 @@
import org.apache.rat.license.ILicense;
import org.apache.rat.license.LicenseSetFactory.LicenseFilter;
+import org.apache.rat.utils.DefaultLog;
import org.junit.jupiter.api.Test;
@@ -38,9 +39,9 @@ public class DefaultsTest {
@Test
public void defaultConfigTest() {
- Defaults defaults = Defaults.builder().build();
+ Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
- Set licenses = defaults.getLicenses(LicenseFilter.all);
+ Set licenses = defaults.getLicenses(LicenseFilter.ALL);
Set names = new TreeSet<>();
licenses.forEach(x -> names.add(x.getLicenseFamily().getFamilyCategory()));
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportConfigurationTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportConfigurationTest.java
index 30acdc4cc..93256025f 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportConfigurationTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportConfigurationTest.java
@@ -51,7 +51,7 @@
import org.apache.rat.ReportConfiguration.NoCloseOutputStream;
import org.apache.rat.analysis.IHeaderMatcher;
import org.apache.rat.config.AddLicenseHeaders;
-import org.apache.rat.configuration.ConfigurationReaderTest;
+import org.apache.rat.configuration.XMLConfigurationReaderTest;
import org.apache.rat.license.ILicense;
import org.apache.rat.license.ILicenseFamily;
import org.apache.rat.license.LicenseSetFactory.LicenseFilter;
@@ -89,9 +89,9 @@ public void testAddAndRemoveApproveLicenseCategories() {
expected.add("TheCa");
SortedSet result = underTest.getApprovedLicenseCategories();
assertThat(expected).hasSize(result.size()).containsAll(result);
- SortedSet families = underTest.getLicenseFamilies(LicenseFilter.approved);
+ SortedSet families = underTest.getLicenseFamilies(LicenseFilter.APPROVED);
assertThat(expected).hasSize(families.size());
- SortedSet licenses = underTest.getLicenses(LicenseFilter.approved);
+ SortedSet licenses = underTest.getLicenses(LicenseFilter.APPROVED);
assertThat(expected).hasSize(licenses.size());
underTest.addLicense(new TestingLicense("ACat"));
@@ -99,9 +99,9 @@ public void testAddAndRemoveApproveLicenseCategories() {
expected.add("ACat ");
result = underTest.getApprovedLicenseCategories();
assertThat(expected).hasSize(result.size()).containsAll(result);
- families = underTest.getLicenseFamilies(LicenseFilter.approved);
+ families = underTest.getLicenseFamilies(LicenseFilter.APPROVED);
assertThat(expected).hasSize(families.size());
- licenses = underTest.getLicenses(LicenseFilter.approved);
+ licenses = underTest.getLicenses(LicenseFilter.APPROVED);
assertThat(expected).hasSize(licenses.size());
String[] cats = { "Spot ", "Felix" };
@@ -111,18 +111,18 @@ public void testAddAndRemoveApproveLicenseCategories() {
expected.addAll(Arrays.asList(cats));
result = underTest.getApprovedLicenseCategories();
assertThat(expected).hasSize(result.size()).containsAll(result);
- families = underTest.getLicenseFamilies(LicenseFilter.approved);
+ families = underTest.getLicenseFamilies(LicenseFilter.APPROVED);
assertThat(expected).hasSize(families.size());
- licenses = underTest.getLicenses(LicenseFilter.approved);
+ licenses = underTest.getLicenses(LicenseFilter.APPROVED);
assertThat(expected).hasSize(licenses.size());
underTest.removeApprovedLicenseCategory("Spot ");
expected.remove("Spot ");
result = underTest.getApprovedLicenseCategories();
assertThat(expected).hasSize(result.size()).containsAll(result);
- families = underTest.getLicenseFamilies(LicenseFilter.approved);
+ families = underTest.getLicenseFamilies(LicenseFilter.APPROVED);
assertThat(expected).hasSize(families.size());
- licenses = underTest.getLicenses(LicenseFilter.approved);
+ licenses = underTest.getLicenses(LicenseFilter.APPROVED);
assertThat(expected).hasSize(licenses.size());
cats[0] = "TheCa";
@@ -130,27 +130,27 @@ public void testAddAndRemoveApproveLicenseCategories() {
expected.removeAll(Arrays.asList(cats));
result = underTest.getApprovedLicenseCategories();
assertThat(expected).hasSize(result.size()).containsAll(result);
- families = underTest.getLicenseFamilies(LicenseFilter.approved);
+ families = underTest.getLicenseFamilies(LicenseFilter.APPROVED);
assertThat(expected).hasSize(families.size());
- licenses = underTest.getLicenses(LicenseFilter.approved);
+ licenses = underTest.getLicenses(LicenseFilter.APPROVED);
assertThat(expected).hasSize(licenses.size()); }
@Test
public void testRemoveBeforeAddApproveLicenseCategories() {
underTest.addLicense( new TestingLicense("TheCat"));
assertThat(underTest.getApprovedLicenseCategories()).isEmpty();
- assertThat(underTest.getLicenseFamilies(LicenseFilter.approved)).isEmpty();
- assertThat(underTest.getLicenses(LicenseFilter.approved)).isEmpty();
+ assertThat(underTest.getLicenseFamilies(LicenseFilter.APPROVED)).isEmpty();
+ assertThat(underTest.getLicenses(LicenseFilter.APPROVED)).isEmpty();
underTest.removeApprovedLicenseCategory("TheCat");
assertThat(underTest.getApprovedLicenseCategories()).isEmpty();
- assertThat(underTest.getLicenseFamilies(LicenseFilter.approved)).isEmpty();
- assertThat(underTest.getLicenses(LicenseFilter.approved)).isEmpty();
+ assertThat(underTest.getLicenseFamilies(LicenseFilter.APPROVED)).isEmpty();
+ assertThat(underTest.getLicenses(LicenseFilter.APPROVED)).isEmpty();
underTest.addApprovedLicenseCategory("TheCat");
assertThat(underTest.getApprovedLicenseCategories()).isEmpty();
- assertThat(underTest.getLicenseFamilies(LicenseFilter.approved)).isEmpty();
- assertThat(underTest.getLicenses(LicenseFilter.approved)).isEmpty();
+ assertThat(underTest.getLicenseFamilies(LicenseFilter.APPROVED)).isEmpty();
+ assertThat(underTest.getLicenses(LicenseFilter.APPROVED)).isEmpty();
}
private ILicense testingLicense(String category, String name) {
@@ -163,18 +163,18 @@ private ILicense testingLicense(String category, String name) {
public void testAddLicense() {
List expected = new ArrayList<>();
- assertThat(underTest.getLicenses(LicenseFilter.all)).isEmpty();
+ assertThat(underTest.getLicenses(LicenseFilter.ALL)).isEmpty();
ILicense lic1 = testingLicense("TheCat", "TheName");
expected.add(lic1);
underTest.addLicense(lic1);
- SortedSet result = underTest.getLicenses(LicenseFilter.all);
+ SortedSet result = underTest.getLicenses(LicenseFilter.ALL);
assertThat(expected).hasSize(result.size()).containsAll(result);
ILicense[] lics = { testingLicense("Spot", "Data's cat"), testingLicense("Felix", "Cartoon cat") };
expected.addAll(Arrays.asList(lics));
underTest.addLicenses(Arrays.asList(lics));
- result = underTest.getLicenses(LicenseFilter.all);
+ result = underTest.getLicenses(LicenseFilter.ALL);
assertThat(expected).hasSize(result.size()).containsAll(result);
}
@@ -208,46 +208,46 @@ public void directoryFilterTest() {
@Test
public void licenseFamiliesTest() {
- assertThat(underTest.getLicenseFamilies(LicenseFilter.all)).isEmpty();
- assertThat(underTest.getLicenseFamilies(LicenseFilter.approved)).isEmpty();
- assertThat(underTest.getLicenseFamilies(LicenseFilter.none)).isEmpty();
+ assertThat(underTest.getLicenseFamilies(LicenseFilter.ALL)).isEmpty();
+ assertThat(underTest.getLicenseFamilies(LicenseFilter.APPROVED)).isEmpty();
+ assertThat(underTest.getLicenseFamilies(LicenseFilter.NONE)).isEmpty();
ILicense[] lics = { testingLicense("TheCat", "TheName"), testingLicense("Spot", "Data's cat"),
testingLicense("Felix", "Cartoon cat") };
underTest.addLicenses(Arrays.asList(lics));
- assertThat(underTest.getLicenseFamilies(LicenseFilter.all)).hasSize(lics.length);
- assertThat(underTest.getLicenseFamilies(LicenseFilter.approved)).isEmpty();
- assertThat(underTest.getLicenseFamilies(LicenseFilter.none)).isEmpty();
+ assertThat(underTest.getLicenseFamilies(LicenseFilter.ALL)).hasSize(lics.length);
+ assertThat(underTest.getLicenseFamilies(LicenseFilter.APPROVED)).isEmpty();
+ assertThat(underTest.getLicenseFamilies(LicenseFilter.NONE)).isEmpty();
underTest.addApprovedLicenseCategory(lics[1].getLicenseFamily());
- assertThat(underTest.getLicenseFamilies(LicenseFilter.all)).hasSize(lics.length);
- SortedSet result = underTest.getLicenseFamilies(LicenseFilter.approved);
+ assertThat(underTest.getLicenseFamilies(LicenseFilter.ALL)).hasSize(lics.length);
+ SortedSet result = underTest.getLicenseFamilies(LicenseFilter.APPROVED);
assertThat(result).hasSize(1);
assertThat(result.first()).isEqualTo(lics[1].getLicenseFamily());
- assertThat(underTest.getLicenseFamilies(LicenseFilter.none)).isEmpty();
+ assertThat(underTest.getLicenseFamilies(LicenseFilter.NONE)).isEmpty();
}
@Test
public void licensesTest() {
- assertThat(underTest.getLicenses(LicenseFilter.all)).isEmpty();
- assertThat(underTest.getLicenses(LicenseFilter.approved)).isEmpty();
- assertThat(underTest.getLicenses(LicenseFilter.none)).isEmpty();
+ assertThat(underTest.getLicenses(LicenseFilter.ALL)).isEmpty();
+ assertThat(underTest.getLicenses(LicenseFilter.APPROVED)).isEmpty();
+ assertThat(underTest.getLicenses(LicenseFilter.NONE)).isEmpty();
ILicense[] lics = { testingLicense("TheCat", "TheName"), testingLicense("Spot", "Data's cat"),
testingLicense("Felix", "Cartoon cat") };
underTest.addLicenses(Arrays.asList(lics));
- assertThat(underTest.getLicenses(LicenseFilter.all)).hasSize(lics.length);
- assertThat(underTest.getLicenses(LicenseFilter.approved)).isEmpty();
- assertThat(underTest.getLicenses(LicenseFilter.none)).isEmpty();
+ assertThat(underTest.getLicenses(LicenseFilter.ALL)).hasSize(lics.length);
+ assertThat(underTest.getLicenses(LicenseFilter.APPROVED)).isEmpty();
+ assertThat(underTest.getLicenses(LicenseFilter.NONE)).isEmpty();
underTest.addApprovedLicenseCategory(lics[1].getLicenseFamily());
- assertThat(underTest.getLicenses(LicenseFilter.all)).hasSize(lics.length);
- SortedSet result = underTest.getLicenses(LicenseFilter.approved);
+ assertThat(underTest.getLicenses(LicenseFilter.ALL)).hasSize(lics.length);
+ SortedSet result = underTest.getLicenses(LicenseFilter.APPROVED);
assertThat(result).hasSize(1);
assertThat(result.first()).isEqualTo(lics[1]);
- assertThat(underTest.getLicenseFamilies(LicenseFilter.none)).isEmpty();
+ assertThat(underTest.getLicenseFamilies(LicenseFilter.NONE)).isEmpty();
}
@Test
@@ -415,14 +415,14 @@ public void familyDuplicateOptionsTest() {
// verify default second setting ignores change
underTest.addFamily(ILicenseFamily.builder().setLicenseFamilyCategory("CAT").setLicenseFamilyName("name2"));
assertTrue(log.captured.toString().contains("CAT"));
- assertEquals("name", underTest.getLicenseFamilies(LicenseFilter.all).stream()
+ assertEquals("name", underTest.getLicenseFamilies(LicenseFilter.ALL).stream()
.filter(s -> s.getFamilyCategory().equals("CAT ")).map(s -> s.getFamilyName()).findFirst().get());
underTest.familyDuplicateOption(Options.OVERWRITE);
// verify second setting ignores change
underTest.addFamily(ILicenseFamily.builder().setLicenseFamilyCategory("CAT").setLicenseFamilyName("name2"));
assertTrue(log.captured.toString().contains("CAT"));
- assertEquals("name2", underTest.getLicenseFamilies(LicenseFilter.all).stream()
+ assertEquals("name2", underTest.getLicenseFamilies(LicenseFilter.ALL).stream()
.filter(s -> s.getFamilyCategory().equals("CAT ")).map(s -> s.getFamilyName()).findFirst().get());
// verify fail throws exception
@@ -440,20 +440,24 @@ public void logLicenseCollisionTest() {
IHeaderMatcher matcher = Mockito.mock(IHeaderMatcher.class);
when(matcher.getId()).thenReturn("Macher ID");
underTest.addFamily(family);
- underTest.addLicense(ILicense.builder().setId("ID").setName("license name").setLicenseFamilyCategory(family.getFamilyCategory())
- .setMatcher( matcher ).build(underTest.getLicenseFamilies(LicenseFilter.all)));
+ underTest.addLicense(ILicense.builder().setId("ID").setName("license name").setFamily(family.getFamilyCategory())
+ .setMatcher( matcher )
+ .setLicenseFamilies(underTest.getLicenseFamilies(LicenseFilter.ALL))
+ .build());
// verify default collistion logs WARN
- underTest.addLicense(ILicense.builder().setId("ID").setName("license name2").setLicenseFamilyCategory(family.getFamilyCategory())
- .setMatcher( matcher ).build(underTest.getLicenseFamilies(LicenseFilter.all)));
+ underTest.addLicense(ILicense.builder().setId("ID").setName("license name2").setFamily(family.getFamilyCategory())
+ .setMatcher( matcher ).setLicenseFamilies(underTest.getLicenseFamilies(LicenseFilter.ALL))
+ .build());
assertTrue(log.captured.toString().contains("WARN"));
log.clear();
underTest.logLicenseCollisions(Level.ERROR);
// verify second setting changes logs issue
- underTest.addLicense(ILicense.builder().setId("ID").setName("license name2").setLicenseFamilyCategory(family.getFamilyCategory())
- .setMatcher( matcher ).build(underTest.getLicenseFamilies(LicenseFilter.all)));
+ underTest.addLicense(ILicense.builder().setId("ID").setName("license name2").setFamily(family.getFamilyCategory())
+ .setMatcher( matcher ).setLicenseFamilies(underTest.getLicenseFamilies(LicenseFilter.ALL))
+ .build());
assertTrue(log.captured.toString().contains("ERROR"));
}
@@ -465,8 +469,9 @@ public void licenseDuplicateOptionsTest() {
IHeaderMatcher matcher = Mockito.mock(IHeaderMatcher.class);
when(matcher.getId()).thenReturn("Macher ID");
underTest.addFamily(family);
- Function makeLicense = s -> ILicense.builder().setId("ID").setName(s).setLicenseFamilyCategory(family.getFamilyCategory())
- .setMatcher( matcher ).build(underTest.getLicenseFamilies(LicenseFilter.all));
+ Function makeLicense = s -> ILicense.builder().setId("ID").setName(s).setFamily(family.getFamilyCategory())
+ .setMatcher( matcher ).setLicenseFamilies(underTest.getLicenseFamilies(LicenseFilter.ALL))
+ .build();
underTest.addLicense(makeLicense.apply("license name"));
@@ -474,19 +479,19 @@ public void licenseDuplicateOptionsTest() {
underTest.addLicense(makeLicense.apply("license name2"));
assertTrue(log.captured.toString().contains("WARN"));
assertEquals("license name",
- underTest.getLicenses(LicenseFilter.all).stream().map(ILicense::getName).findFirst().get());
+ underTest.getLicenses(LicenseFilter.ALL).stream().map(ILicense::getName).findFirst().get());
underTest.licenseDuplicateOption(Options.OVERWRITE);
underTest.addLicense(makeLicense.apply("license name2"));
assertEquals("license name2",
- underTest.getLicenses(LicenseFilter.all).stream().map(ILicense::getName).findFirst().get());
+ underTest.getLicenses(LicenseFilter.ALL).stream().map(ILicense::getName).findFirst().get());
// verify fail throws exception
underTest.licenseDuplicateOption(Options.FAIL);
assertThrows( IllegalArgumentException.class, ()-> underTest.addLicense(makeLicense.apply("another name")));
-
}
+
/**
* Validates that the configuration contains the default approved licenses.
@@ -501,8 +506,8 @@ public static void validateDefaultApprovedLicenses(ReportConfiguration config) {
* @param config The configuration to test.
*/
public static void validateDefaultApprovedLicenses(ReportConfiguration config, int additionalIdCount) {
- assertThat(config.getApprovedLicenseCategories()).hasSize(ConfigurationReaderTest.EXPECTED_IDS.length + additionalIdCount);
- for (String s : ConfigurationReaderTest.EXPECTED_IDS) {
+ assertThat(config.getApprovedLicenseCategories()).hasSize(XMLConfigurationReaderTest.EXPECTED_IDS.length + additionalIdCount);
+ for (String s : XMLConfigurationReaderTest.EXPECTED_IDS) {
assertThat(config.getApprovedLicenseCategories()).contains(ILicenseFamily.makeCategory(s));
}
}
@@ -513,11 +518,11 @@ public static void validateDefaultApprovedLicenses(ReportConfiguration config, i
* @param config the configuration to test.
*/
public static void validateDefaultLicenseFamilies(ReportConfiguration config, String...additionalIds) {
- assertThat(config.getLicenseFamilies(LicenseFilter.all)).hasSize(ConfigurationReaderTest.EXPECTED_IDS.length + additionalIds.length);
+ assertThat(config.getLicenseFamilies(LicenseFilter.ALL)).hasSize(XMLConfigurationReaderTest.EXPECTED_IDS.length + additionalIds.length);
List expected = new ArrayList<>();
- expected.addAll(Arrays.asList(ConfigurationReaderTest.EXPECTED_IDS));
+ expected.addAll(Arrays.asList(XMLConfigurationReaderTest.EXPECTED_IDS));
expected.addAll(Arrays.asList(additionalIds));
- for (ILicenseFamily family : config.getLicenseFamilies(LicenseFilter.all)) {
+ for (ILicenseFamily family : config.getLicenseFamilies(LicenseFilter.ALL)) {
assertThat(expected).contains(family.getFamilyCategory().trim());
}
}
@@ -527,11 +532,11 @@ public static void validateDefaultLicenseFamilies(ReportConfiguration config, St
* @param config the configuration to test.
*/
public static void validateDefaultLicenses(ReportConfiguration config, String...additionalLicenses) {
- assertThat(config.getLicenses(LicenseFilter.all)).hasSize(ConfigurationReaderTest.EXPECTED_LICENSES.length + additionalLicenses.length);
+ assertThat(config.getLicenses(LicenseFilter.ALL)).hasSize(XMLConfigurationReaderTest.EXPECTED_LICENSES.length + additionalLicenses.length);
List expected = new ArrayList<>();
- expected.addAll(Arrays.asList(ConfigurationReaderTest.EXPECTED_LICENSES));
+ expected.addAll(Arrays.asList(XMLConfigurationReaderTest.EXPECTED_LICENSES));
expected.addAll(Arrays.asList(additionalLicenses));
- for (ILicense license : config.getLicenses(LicenseFilter.all)) {
+ for (ILicense license : config.getLicenses(LicenseFilter.ALL)) {
assertThat(expected).contains(license.getId());
}
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index 8632e0294..db9e8bd2a 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -18,33 +18,43 @@
*/
package org.apache.rat;
-
-
+import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.io.File;
+import java.io.FileInputStream;
import java.io.FilenameFilter;
import java.io.IOException;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
+import javax.xml.xpath.XPath;
+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.junit.jupiter.api.Disabled;
+import org.apache.rat.testhelpers.TextUtils;
+import org.apache.rat.testhelpers.XmlUtils;
import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+import org.w3c.dom.Document;
+import org.w3c.dom.NodeList;
public class ReportTest {
+ @TempDir
+ File tempDirectory;
+
@Test
public void parseExclusionsForCLIUsage() {
final FilenameFilter filter = Report
.parseExclusions(Arrays.asList("", " # foo/bar", "foo", "##", " ./foo/bar"));
assertNotNull(filter);
}
-
+
@Test
public void testDefaultConfiguration() throws ParseException, IOException {
String[] empty = {};
@@ -55,10 +65,10 @@ public void testDefaultConfiguration() throws ParseException, IOException {
@Test
public void testOutputOption() throws Exception {
- CommandLine cl = new DefaultParser().parse(Report.buildOptions(), new String[]{ "-o", "target/test" });
+ File output = new File(tempDirectory, "test");
+ CommandLine cl = new DefaultParser().parse(Report.buildOptions(), new String[] { "-o", output.getCanonicalPath()});
ReportConfiguration config = Report.createConfiguration("target/test-classes/elements", cl);
- Reporter.report(config);
- File output = new File("target/test");
+ new Reporter(config).output();
assertTrue(output.exists());
String content = FileUtils.readFileToString(output, StandardCharsets.UTF_8);
assertTrue(content.contains("2 Unknown Licenses"));
@@ -68,22 +78,104 @@ public void testOutputOption() throws Exception {
@Test
public void testDefaultOutput() throws Exception {
-
+ File output = new File(tempDirectory,"sysout");
+ output.delete();
PrintStream origin = System.out;
- try {
- File output = new File("target/sysout");
- System.setOut(new PrintStream(output));
- CommandLine cl = new DefaultParser().parse(Report.buildOptions(), new String[]{});
+ try (PrintStream out = new PrintStream(output)){
+ System.setOut(out);
+ CommandLine cl = new DefaultParser().parse(Report.buildOptions(), new String[] {});
ReportConfiguration config = Report.createConfiguration("target/test-classes/elements", cl);
- Reporter.report(config);
- assertTrue(output.exists());
- String content = FileUtils.readFileToString(output, StandardCharsets.UTF_8);
- assertTrue(content.contains("2 Unknown Licenses"));
- assertTrue(content.contains("target/test-classes/elements/Source.java"));
- assertTrue(content.contains("target/test-classes/elements/sub/Empty.txt"));
+ new Reporter(config).output();
} finally {
System.setOut(origin);
}
+ assertTrue(output.exists());
+ String content = FileUtils.readFileToString(output, StandardCharsets.UTF_8);
+ TextUtils.isMatching("Notes: 2$", content);
+ TextUtils.isMatching("Binaries: 2$", content);
+ TextUtils.isMatching("Archives: 1$", content);
+ TextUtils.isMatching("Standards: 8$", content);
+ TextUtils.isMatching("Apache Licensed: 5$", content);
+ TextUtils.isMatching("Generated Documents 1$", content);
+ TextUtils.isMatching("^2 Unknown licenses", content);
+ assertTrue(content.contains(" S target/test-classes/elements/ILoggerFactory.java"));
+ assertTrue(content.contains(" B target/test-classes/elements/Image.png"));
+ assertTrue(content.contains(" N target/test-classes/elements/LICENSE"));
+ assertTrue(content.contains(" N target/test-classes/elements/NOTICE"));
+ assertTrue(content.contains("!S target/test-classes/elements/Source.java"));
+ assertTrue(content.contains(" S target/test-classes/elements/Text.txt"));
+ assertTrue(content.contains(" S target/test-classes/elements/TextHttps.txt"));
+ assertTrue(content.contains(" S target/test-classes/elements/Xml.xml"));
+ assertTrue(content.contains(" S target/test-classes/elements/buildr.rb"));
+ assertTrue(content.contains(" A target/test-classes/elements/dummy.jar"));
+ assertTrue(content.contains(" B target/test-classes/elements/plain.json"));
+ assertTrue(content.contains("!S target/test-classes/elements/sub/Empty.txt"));
+ assertTrue(content.contains(" S target/test-classes/elements/tri.txt"));
+ assertTrue(content.contains(" G target/test-classes/elements/generated.txt"));
}
+ @Test
+ public void testXMLOutput() throws Exception {
+ File output = new File(tempDirectory,"sysout");
+ output.delete();
+ PrintStream origin = System.out;
+ try (PrintStream out = new PrintStream(output)){
+ System.setOut(out);
+ CommandLine cl = new DefaultParser().parse(Report.buildOptions(), new String[] { "-x" });
+ ReportConfiguration config = Report.createConfiguration("target/test-classes/elements", cl);
+ new Reporter(config).output();
+ } finally {
+ System.setOut(origin);
+ }
+ assertTrue(output.exists());
+ Document doc = XmlUtils.toDom(new FileInputStream(output));
+ XPath xPath = XPathFactory.newInstance().newXPath();
+
+ NodeList nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource/license[@approval='false']");
+ assertEquals(2, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource/license[@id='AL']");
+ assertEquals(5, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource/license[@id='MIT']");
+ assertEquals(1, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource/license[@id='BSD-3']");
+ assertEquals(1, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource/license[@id='TMF']");
+ assertEquals(1, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource/license[@id='?????']");
+ assertEquals(2, nodeList.getLength());
+
+ // GENERATED, UNKNOWN, ARCHIVE, NOTICE, BINARY, STANDARD
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource[@type='STANDARD']");
+ assertEquals(8, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource[@type='ARCHIVE']");
+ assertEquals(1, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource[@type='BINARY']");
+ assertEquals(2, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource[@type='GENERATED']");
+ assertEquals(1, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource[@type='UNKNOWN']");
+ assertEquals(0, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource[@type='NOTICE']");
+ assertEquals(2, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource/sample");
+ assertEquals(1, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath, "/rat-report/resource[@type='GENERATED']/license/notes");
+ assertEquals(1, nodeList.getLength());
+
+ nodeList = XmlUtils.getNodeList(doc, xPath,
+ "/rat-report/resource[@name='target/test-classes/elements/Source.java']/sample");
+ assertEquals(1, nodeList.getLength());
+ }
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTransformerTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTransformerTest.java
index 8dc5d24c1..1cfed1fb3 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTransformerTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTransformerTest.java
@@ -55,7 +55,7 @@ public static Stream transformers() {
List lst = new ArrayList<>();
lst.add(Arguments.of("plain-rat.xsl", new String[] { "Notes: 2$", "Binaries: 2$", "Archives: 1$",
- "Standards: 7$", "Apache Licensed: 4$", "Generated Documents: 0$", "2 Unknown Licenses" }));
+ "Standards: 8$", "Apache Licensed: 5$", "Generated Documents: 1$", "2 Unknown Licenses" }));
lst.add(Arguments.of("unapproved-licenses.xsl", new String[] { "Files with unapproved licenses",
"src/test/resources/elements/Source.java", "src/test/resources/elements/sub/Empty.txt" }));
lst.add(Arguments.of("missing-headers.xsl", new String[] { "Files with missing headers",
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 d675b6994..eb02d090a 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
@@ -24,18 +24,19 @@
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
-import java.util.regex.Pattern;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathFactory;
import org.apache.commons.io.filefilter.HiddenFileFilter;
+import org.apache.rat.api.Document.Type;
+import org.apache.rat.license.ILicenseFamily;
import org.apache.rat.test.utils.Resources;
+import org.apache.rat.testhelpers.TextUtils;
import org.apache.rat.testhelpers.XmlUtils;
import org.apache.rat.utils.DefaultLog;
import org.apache.rat.walker.DirectoryWalker;
-import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.w3c.dom.Document;
import org.w3c.dom.NodeList;
@@ -45,9 +46,43 @@
*/
public class ReporterTest {
+ /**
+ * Finds a node via xpath on the document. And then checks family, approval and
+ * type of elements of the node.
+ *
+ * @param doc The document to check/
+ * @param xpath the XPath instance to use.
+ * @param resource the xpath statement to locate the node.
+ * @param id the expected family for the node (may be null)
+ * @param approval the expected approval value (may be null)
+ * @param type the type of resource located.
+ * @throws Exception on XPath error.
+ */
+ public static void checkNode(Document doc, XPath xpath, String resource, LicenseInfo licenseInfo, String type,
+ boolean hasSample) throws Exception {
+ XmlUtils.getNode(doc, xpath, String.format("/rat-report/resource[@name='%s'][@type='%s']", resource, type));
+ if (licenseInfo != null) {
+ XmlUtils.getNode(doc, xpath,
+ String.format("/rat-report/resource[@name='%s'][@type='%s']/license[@id='%s'][@family='%s']",
+ resource, type, licenseInfo.id, licenseInfo.family));
+ XmlUtils.getNode(doc, xpath,
+ String.format("/rat-report/resource[@name='%s'][@type='%s']/license[@id='%s'][@approval='%s']",
+ resource, type, licenseInfo.id, Boolean.toString(licenseInfo.approval)));
+ if (licenseInfo.hasNotes) {
+ XmlUtils.getNode(doc, xpath,
+ String.format("/rat-report/resource[@name='%s'][@type='%s']/license[@id='%s']/notes", resource,
+ type, licenseInfo.id));
+ }
+ }
+ if (hasSample) {
+ XmlUtils.getNode(doc, xpath,
+ String.format("/rat-report/resource[@name='%s'][@type='%s']/sample", resource, type));
+ }
+ }
+
@Test
public void xmlReportTest() throws Exception {
- Defaults defaults = Defaults.builder().build();
+ Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
ByteArrayOutputStream out = new ByteArrayOutputStream();
final String elementsPath = Resources.getResourceDirectory("elements/Source.java");
@@ -56,29 +91,38 @@ public void xmlReportTest() throws Exception {
configuration.setFrom(defaults);
configuration.setReportable(new DirectoryWalker(new File(elementsPath), HiddenFileFilter.HIDDEN));
configuration.setOut(() -> out);
- Reporter.report(configuration);
+ new Reporter(configuration).output();
Document doc = XmlUtils.toDom(new ByteArrayInputStream(out.toByteArray()));
-
+
XPath xPath = XPathFactory.newInstance().newXPath();
XmlUtils.getNode(doc, xPath, "/rat-report[@timestamp]");
- XmlUtils.checkNode(doc, xPath, "src/test/resources/elements/ILoggerFactory.java", "MIT", "true", "standard");
- XmlUtils.checkNode(doc, xPath, "src/test/resources/elements/Image.png", null, null, "binary");
- XmlUtils.checkNode(doc, xPath, "src/test/resources/elements/LICENSE", null, null, "notice");
- XmlUtils.checkNode(doc, xPath, "src/test/resources/elements/NOTICE", null, null, "notice");
- XmlUtils.checkNode(doc, xPath, "src/test/resources/elements/Source.java", "?????", "false", "standard");
- XmlUtils.checkNode(doc, xPath, "src/test/resources/elements/Text.txt", "AL", "true", "standard");
- XmlUtils.checkNode(doc, xPath, "src/test/resources/elements/TextHttps.txt", "AL", "true", "standard");
- XmlUtils.checkNode(doc, xPath, "src/test/resources/elements/Xml.xml", "AL", "true", "standard");
- XmlUtils.checkNode(doc, xPath, "src/test/resources/elements/buildr.rb", "AL", "true", "standard");
- XmlUtils.checkNode(doc, xPath, "src/test/resources/elements/dummy.jar", null, null, "archive");
- XmlUtils.checkNode(doc, xPath, "src/test/resources/elements/plain.json", null, null, "binary");
- XmlUtils.checkNode(doc, xPath, "src/test/resources/elements/sub/Empty.txt", "?????", "false", "standard");
-
+ LicenseInfo apacheLic = new LicenseInfo("AL", true, false);
+ checkNode(doc, xPath, "src/test/resources/elements/ILoggerFactory.java", new LicenseInfo("MIT", true, false),
+ "STANDARD", false);
+ checkNode(doc, xPath, "src/test/resources/elements/Image.png", null, "BINARY", false);
+ checkNode(doc, xPath, "src/test/resources/elements/LICENSE", null, "NOTICE", false);
+ checkNode(doc, xPath, "src/test/resources/elements/NOTICE", null, "NOTICE", false);
+ checkNode(doc, xPath, "src/test/resources/elements/Source.java", new LicenseInfo("?????", false, false),
+ "STANDARD", true);
+ checkNode(doc, xPath, "src/test/resources/elements/Text.txt", apacheLic, "STANDARD", false);
+ checkNode(doc, xPath, "src/test/resources/elements/TextHttps.txt", apacheLic, "STANDARD", false);
+ checkNode(doc, xPath, "src/test/resources/elements/Xml.xml", apacheLic, "STANDARD", false);
+ checkNode(doc, xPath, "src/test/resources/elements/buildr.rb", apacheLic, "STANDARD", false);
+ checkNode(doc, xPath, "src/test/resources/elements/dummy.jar", null, "ARCHIVE", false);
+ checkNode(doc, xPath, "src/test/resources/elements/plain.json", null, "BINARY", false);
+ checkNode(doc, xPath, "src/test/resources/elements/sub/Empty.txt", new LicenseInfo("?????", false, false),
+ "STANDARD", false);
+ checkNode(doc, xPath, "src/test/resources/elements/tri.txt", apacheLic, "STANDARD", false);
+ checkNode(doc, xPath, "src/test/resources/elements/tri.txt", new LicenseInfo("BSD-3", true, false), "STANDARD",
+ false);
+ checkNode(doc, xPath, "src/test/resources/elements/tri.txt", new LicenseInfo("TMF", "BSD-3", true, false),
+ "STANDARD", false);
+ checkNode(doc, xPath, "src/test/resources/elements/generated.txt", new LicenseInfo("GEN", true, true),
+ "GENERATED", false);
NodeList nodeList = (NodeList) xPath.compile("/rat-report/resource").evaluate(doc, XPathConstants.NODESET);
- assertEquals(12, nodeList.getLength());
-
+ assertEquals(14, nodeList.getLength());
}
private static final String NL = System.getProperty("line.separator");
@@ -88,9 +132,21 @@ public void xmlReportTest() throws Exception {
"-------" + NL + //
"Generated at: ";
+ private String documentOut(boolean approved, Type type, String name) {
+ return String.format("^\\Q%s%s %s\\E$", approved ? " " : "!", type.name().substring(0, 1), name);
+ }
+
+ private String licenseOut(String family, String name) {
+ return licenseOut(family, family, name);
+ }
+
+ private String licenseOut(String family, String id, String name) {
+ return String.format("\\s+\\Q%s\\E\\s+\\Q%s\\E\\s+\\Q%s\\E$", family, id, name);
+ }
+
@Test
- public void plainReportWithArchivesAndUnapprovedLicenses() throws Exception {
- Defaults defaults = Defaults.builder().build();
+ public void plainReportTest() throws Exception {
+ Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
ByteArrayOutputStream out = new ByteArrayOutputStream();
final String elementsPath = Resources.getResourceDirectory("elements/Source.java");
@@ -98,43 +154,91 @@ public void plainReportWithArchivesAndUnapprovedLicenses() throws Exception {
configuration.setFrom(defaults);
configuration.setReportable(new DirectoryWalker(new File(elementsPath), HiddenFileFilter.HIDDEN));
configuration.setOut(() -> out);
- Reporter.report(configuration);
+ new Reporter(configuration).output();
out.flush();
String document = out.toString();
- assertTrue(document.startsWith(HEADER), "'Generated at' is present in " + document );
-
- // final int generatedAtLineEnd = document.indexOf(NL, HEADER.length());
- find("^Notes: 2$", document);
- find("^Binaries: 2$", document);
- find("^Archives: 1$", document);
- find("^Standards: 7$", document);
- find("^Apache Licensed: 4$", document);
- find("^Generated Documents: 0$", document);
- find("^2 Unknown Licenses$", document);
- find("^Files with unapproved licenses:\\s+"
- + "src/test/resources/elements/Source.java\\s+"
- + "src/test/resources/elements/sub/Empty.txt\\s",
+ assertTrue(document.startsWith(HEADER), "'Generated at' is not present in " + document);
+
+ TextUtils.assertPatternInOutput("^Notes: 2$", document);
+ TextUtils.assertPatternInOutput("^Binaries: 2$", document);
+ TextUtils.assertPatternInOutput("^Archives: 1$", document);
+ TextUtils.assertPatternInOutput("^Standards: 8$", document);
+ TextUtils.assertPatternInOutput("^Apache Licensed: 5$", document);
+ TextUtils.assertPatternInOutput("^Generated Documents: 1$", document);
+ TextUtils.assertPatternInOutput("^2 Unknown Licenses$", document);
+ TextUtils.assertPatternInOutput(
+ "^Files with unapproved licenses:\\s+" + "\\Qsrc/test/resources/elements/Source.java\\E\\s+"
+ + "\\Qsrc/test/resources/elements/sub/Empty.txt\\E\\s",
+ document);
+ TextUtils.assertPatternInOutput(documentOut(true, Type.ARCHIVE, "src/test/resources/elements/dummy.jar"),
+ document);
+ TextUtils.assertPatternInOutput(
+ documentOut(true, Type.STANDARD, "src/test/resources/elements/ILoggerFactory.java")
+ + licenseOut("MIT", "The MIT License"),
+ document);
+ TextUtils.assertPatternInOutput(documentOut(true, Type.BINARY, "src/test/resources/elements/Image.png"),
+ document);
+ TextUtils.assertPatternInOutput(documentOut(true, Type.NOTICE, "src/test/resources/elements/LICENSE"),
+ document);
+ TextUtils.assertPatternInOutput(documentOut(true, Type.NOTICE, "src/test/resources/elements/NOTICE"), document);
+ TextUtils.assertPatternInOutput(documentOut(false, Type.STANDARD, "src/test/resources/elements/Source.java")
+ + licenseOut("?????", "Unknown license (Unapproved)"), document);
+ TextUtils.assertPatternInOutput(documentOut(true, Type.STANDARD, "src/test/resources/elements/Text.txt")
+ + licenseOut("AL", "Apache License Version 2.0"), document);
+ TextUtils.assertPatternInOutput(documentOut(true, Type.STANDARD, "src/test/resources/elements/Xml.xml")
+ + licenseOut("AL", "Apache License Version 2.0"), document);
+ TextUtils.assertPatternInOutput(documentOut(true, Type.STANDARD, "src/test/resources/elements/buildr.rb")
+ + licenseOut("AL", "Apache License Version 2.0"), document);
+ TextUtils.assertPatternInOutput(documentOut(true, Type.STANDARD, "src/test/resources/elements/TextHttps.txt")
+ + licenseOut("AL", "Apache License Version 2.0"), document);
+ TextUtils.assertPatternInOutput(documentOut(true, Type.BINARY, "src/test/resources/elements/plain.json"),
document);
- find("^Archives:\\s+" + "\\+ src/test/resources/elements/dummy.jar\\s*", document);
- find("MIT\\s+src/test/resources/elements/ILoggerFactory.java", document);
- find("B\\s+src/test/resources/elements/Image.png", document);
- find("N\\s+src/test/resources/elements/LICENSE", document);
- find("N\\s+src/test/resources/elements/NOTICE", document);
- find("!\\Q?????\\E\\s+src/test/resources/elements/Source.java", document);
- find("AL\\s+src/test/resources/elements/Text.txt", document);
- find("AL\\s+src/test/resources/elements/TextHttps.txt", document);
- find("AL\\s+src/test/resources/elements/Xml.xml", document);
- find("AL\\s+src/test/resources/elements/buildr.rb", document);
- find("A\\s+src/test/resources/elements/dummy.jar", document);
- find("B\\s+src/test/resources/elements/plain.json", document);
- find("!\\Q?????\\E\\s+src/test/resources/elements/sub/Empty.txt", document);
- find("== File: src/test/resources/elements/sub/Empty.txt", document);
+ TextUtils.assertPatternInOutput(documentOut(true, Type.STANDARD, "src/test/resources/elements/tri.txt")
+ + licenseOut("AL", "Apache License Version 2.0") + licenseOut("BSD-3", "BSD 3 clause")
+ + licenseOut("BSD-3", "TMF", "The Telemanagement Forum License"), document);
+ TextUtils.assertPatternInOutput(documentOut(false, Type.STANDARD, "src/test/resources/elements/sub/Empty.txt")
+ + licenseOut("?????", "Unknown license (Unapproved)"), document);
+ }
+
+ @Test
+ public void UnapprovedLicensesReportTest() throws Exception {
+ Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
+ ByteArrayOutputStream out = new ByteArrayOutputStream();
+
+ final String elementsPath = Resources.getResourceDirectory("elements/Source.java");
+ final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.INSTANCE);
+ configuration.setFrom(defaults);
+ configuration.setReportable(new DirectoryWalker(new File(elementsPath), HiddenFileFilter.HIDDEN));
+ configuration.setOut(() -> out);
+ configuration.setStyleSheet(this.getClass().getResource("/org/apache/rat/unapproved-licenses.xsl"));
+ new Reporter(configuration).output();
+
+ out.flush();
+ String document = out.toString();
+
+ assertTrue(document.startsWith("Generated at: "), "'Generated at' is not present in " + document);
+
+ TextUtils.assertPatternInOutput("\\Qsrc/test/resources/elements/Source.java\\E$", document);
+ TextUtils.assertPatternInOutput("\\Qsrc/test/resources/elements/sub/Empty.txt\\E", document);
}
- private void find(String pattern, String document) {
- assertTrue(
- Pattern.compile(pattern, Pattern.MULTILINE).matcher(document).find(), () ->String.format("Could not find '%s'", pattern));
+ private class LicenseInfo {
+ String id;
+ String family;
+ boolean approval;
+ boolean hasNotes;
+
+ LicenseInfo(String id, boolean approval, boolean hasNotes) {
+ this(id, id, approval, hasNotes);
+ }
+
+ 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/AnalyserFactoryTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/AnalyserFactoryTest.java
index 3d5f87ec6..ca8bd0e4a 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/AnalyserFactoryTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/AnalyserFactoryTest.java
@@ -18,16 +18,13 @@
*/
package org.apache.rat.analysis;
-
+import static org.junit.Assert.assertTrue;
import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.when;
+import static org.junit.jupiter.api.Assertions.assertTrue;
import java.io.StringWriter;
import java.util.Arrays;
-import org.apache.rat.analysis.IHeaderMatcher.State;
import org.apache.rat.document.IDocumentAnalyser;
import org.apache.rat.document.impl.MonolithicFileDocument;
import org.apache.rat.license.ILicense;
@@ -38,16 +35,9 @@
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
-
public class AnalyserFactoryTest {
- private static ILicense MATCHES_NOTHING_MATCHER = mock(ILicense.class);
-
- static {
- when(MATCHES_NOTHING_MATCHER.matches(any())).thenReturn(State.f);
- when(MATCHES_NOTHING_MATCHER.currentState()).thenReturn(State.f);
- when(MATCHES_NOTHING_MATCHER.finalizeState()).thenReturn(State.f);
- }
+ private static ILicense MATCHES_NOTHING_MATCHER = UnknownLicense.INSTANCE;
private StringWriter out;
private SimpleXmlClaimReporter reporter;
@@ -56,35 +46,41 @@ public class AnalyserFactoryTest {
@BeforeEach
public void setUp() throws Exception {
out = new StringWriter();
- final XmlWriter writer = new XmlWriter(out);
- reporter = new SimpleXmlClaimReporter(writer);
- analyser = DefaultAnalyserFactory.createDefaultAnalyser(DefaultLog.INSTANCE, Arrays.asList(MATCHES_NOTHING_MATCHER));
+ reporter = new SimpleXmlClaimReporter(new XmlWriter(out));
+ analyser = DefaultAnalyserFactory.createDefaultAnalyser(DefaultLog.INSTANCE,
+ Arrays.asList(MATCHES_NOTHING_MATCHER));
}
@Test
public void standardTypeAnalyser() throws Exception {
+ String[] expected = {
+ ""
+ + ""
+ + "" };
+
final MonolithicFileDocument document = new MonolithicFileDocument(
Resources.getResourceFile("/elements/Text.txt"));
analyser.analyse(document);
reporter.report(document);
- assertEquals( //
- "/*\n"
- + " * Licensed to the Apache Software Foundation (ASF) under one\n"
- + " * or more contributor license agreements. See the NOTICE file\n"
- + " * distributed with this work for additional information\n"
- + " * regarding copyright ownership. The ASF licenses this file\n"
- + " * to you under the Apache License, Version 2.0 (the \"License\");\n"
- + " * you may not use this file except in compliance with the License.\n"
- + " * You may obtain a copy of the License at\n" + " *\n"
- + " * http://www.apache.org/licenses/LICENSE-2.0\n" + " *\n"
- + " * Unless required by applicable law or agreed to in writing,\n"
- + " * software distributed under the License is distributed on an\n"
- + " * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n"
- + " * KIND, either express or implied. See the License for the\n"
- + " * specific language governing permissions and limitations\n" + " * under the License. \n"
- + " */\n" + "\n" + " \n"
- + "",
- out.toString(), "Open standard element");
+ String result = out.toString();
+ for (String exp : expected ) {
+ assertTrue(result.contains(exp), () -> exp);
+ }
}
@Test
@@ -93,8 +89,8 @@ public void noteTypeAnalyser() throws Exception {
Resources.getResourceFile("/elements/LICENSE"));
analyser.analyse(document);
reporter.report(document);
- assertEquals("",
- out.toString(), "Open note element");
+ assertEquals("", out.toString(),
+ "Open note element");
}
@Test
@@ -103,9 +99,8 @@ public void binaryTypeAnalyser() throws Exception {
Resources.getResourceFile("/elements/Image.png"));
analyser.analyse(document);
reporter.report(document);
- assertEquals(
- "",
- out.toString(), "Open binary element");
+ assertEquals("", out.toString(),
+ "Open binary element");
}
@Test
@@ -114,8 +109,8 @@ public void archiveTypeAnalyser() throws Exception {
Resources.getResourceFile("/elements/dummy.jar"));
analyser.analyse(document);
reporter.report(document);
- assertEquals(
- "", out.toString(), "Open archive element");
+ assertEquals("", out.toString(),
+ "Open archive element");
}
@Test
@@ -124,7 +119,7 @@ public void archiveTypeAnalyserIntelliJ() throws Exception {
Resources.getResourceFile("/elements/dummy.jar"));
analyser.analyse(document);
reporter.report(document);
- assertEquals(
- "", out.toString(), "Open archive element");
+ assertEquals("", out.toString(),
+ "Open archive element");
}
}
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 e231ad097..8dcfdf371 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
@@ -19,10 +19,8 @@
package org.apache.rat.analysis;
-import static org.junit.jupiter.api.Assertions.assertTrue;
-import static org.junit.jupiter.api.Assertions.assertFalse;
-
import java.io.StringReader;
+import java.util.Arrays;
import org.apache.rat.api.Document;
import org.apache.rat.license.ILicense;
@@ -37,9 +35,7 @@ public class HeaderCheckWorkerTest {
public void isFinished() throws Exception {
final Document subject = new TestingLocation("subject");
ILicense matcher = new TestingLicense();
- HeaderCheckWorker worker = new HeaderCheckWorker(new StringReader(""), matcher, subject);
- assertFalse(worker.isFinished());
+ HeaderCheckWorker worker = new HeaderCheckWorker(new StringReader(""), Arrays.asList(matcher), subject);
worker.read();
- assertTrue(worker.isFinished());
}
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/AbstractLicenseTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/AbstractLicenseTest.java
index ad17c909b..0e0e1a807 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/AbstractLicenseTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/AbstractLicenseTest.java
@@ -18,10 +18,7 @@
*/
package org.apache.rat.analysis.license;
-
import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertNotNull;
-import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
@@ -29,21 +26,19 @@
import java.io.IOException;
import java.io.StringReader;
-import org.apache.commons.lang3.StringUtils;
import org.apache.rat.Defaults;
-import org.apache.rat.analysis.IHeaderMatcher.State;
-import org.apache.rat.analysis.matchers.FullTextMatcher;
+import org.apache.rat.analysis.HeaderCheckWorker;
+import org.apache.rat.analysis.IHeaders;
import org.apache.rat.api.MetaData;
import org.apache.rat.license.ILicense;
-import org.apache.rat.license.ILicenseFamily;
import org.apache.rat.license.LicenseSetFactory;
import org.apache.rat.license.LicenseSetFactory.LicenseFilter;
import org.apache.rat.testhelpers.TestingLicense;
+import org.apache.rat.utils.DefaultLog;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
-
/**
* Test to see if short form license information will be recognized correctly.
*
@@ -55,21 +50,19 @@ abstract public class AbstractLicenseTest {
private Defaults defaults;
protected MetaData data;
-
protected AbstractLicenseTest() {
}
-
@BeforeEach
public void setup() {
data = new MetaData();
- defaults = Defaults.builder().build();
+ defaults = Defaults.builder().build(DefaultLog.INSTANCE);
}
protected ILicense extractCategory(String id) {
TestingLicense testingLicense = new TestingLicense();
testingLicense.setId(id);
- ILicense result = LicenseSetFactory.search(testingLicense, defaults.getLicenses(LicenseFilter.all));
+ ILicense result = LicenseSetFactory.search(testingLicense, defaults.getLicenses(LicenseFilter.ALL));
if (result == null) {
fail("No licenses for id: " + id);
}
@@ -78,71 +71,53 @@ protected ILicense extractCategory(String id) {
@ParameterizedTest
@MethodSource("parameterProvider")
- public void testMatchProcessing(String id, String familyPattern, String name, String notes, String[][] targets) throws IOException {
+ public void testMatchProcessing(String id, String familyPattern, String name, String notes, String[][] targets)
+ throws IOException {
ILicense license = extractCategory(id);
- String family = ILicenseFamily.makeCategory(familyPattern);
- try {
- for (String[] target : targets) {
- if (processText(license, target[TEXT])) {
- data.reportOnLicense(license);
- assertNotNull(data.get(MetaData.RAT_URL_HEADER_CATEGORY),"No URL HEADER CATEGORY");
- assertEquals(family,
- data.get(MetaData.RAT_URL_HEADER_CATEGORY).getValue(), license.toString());
- assertNotNull(data.get(MetaData.RAT_URL_LICENSE_FAMILY_CATEGORY), "No URL LICENSE FAMILY CATEGORY");
- assertEquals(family,
- data.get(MetaData.RAT_URL_LICENSE_FAMILY_CATEGORY).getValue(), license.toString());
- if (StringUtils.isNotBlank(notes)) {
- assertNotNull(data.get(MetaData.RAT_URL_HEADER_SAMPLE), "No URL HEADER SAMPLE");
- assertEquals(FullTextMatcher.prune(notes),
- FullTextMatcher.prune(data.get(MetaData.RAT_URL_HEADER_SAMPLE).getValue()), license.toString());
- } else {
- assertNull(data.get(MetaData.RAT_URL_HEADER_SAMPLE), "URL HEADER SAMPLE was not null");
- }
- assertNotNull(data.get(MetaData.RAT_URL_LICENSE_FAMILY_NAME), "No URL LICENSE FAMILY NAME");
- assertEquals(name,
- data.get(MetaData.RAT_URL_LICENSE_FAMILY_NAME).getValue(), license.toString());
- data.clear();
- } else {
- fail(license + " was not matched by " + target[NAME]);
- }
- license.reset();
+ try {
+ for (String[] target : targets) {
+ if (processText(license, target[TEXT])) {
+ data.reportOnLicense(license);
+ assertEquals(1, data.licenses().count());
+ assertEquals(license, data.licenses().findFirst().get());
+ } else {
+ fail(license + " was not matched by " + target[NAME]);
}
- } finally {
license.reset();
}
-
+ } finally {
+ license.reset();
+ }
}
private boolean processText(ILicense license, String text) throws IOException {
try (BufferedReader in = new BufferedReader(new StringReader(text))) {
- String line;
- while (null != (line = in.readLine())) {
- if (license.matches(line) == State.t) {
- return true;
- }
- }
- return license.finalizeState().asBoolean();
+ IHeaders headers = HeaderCheckWorker.readHeader(in,
+ HeaderCheckWorker.DEFAULT_NUMBER_OF_RETAINED_HEADER_LINES);
+ return license.matches(headers);
}
}
@ParameterizedTest
@MethodSource("parameterProvider")
- public void testEmbeddedStrings(String id, String family, String name, String notes, String[][] targets) throws IOException {
+ public void testEmbeddedStrings(String id, String family, String name, String notes, String[][] targets)
+ throws IOException {
String formats[] = { "%s", "now is not the time %s for copyright", "#%s", "##%s", "## %s", "##%s##", "## %s ##",
"/*%s*/", "/* %s */" };
ILicense license = extractCategory(id);
- try {
- for (String[] target : targets) {
- for (String fmt : formats) {
- boolean found = processText(license, String.format(fmt, target[TEXT]));
- license.reset();
- assertTrue(found, ()->String.format("%s %s did not match pattern '%s' for target string %s", id,
- name, fmt, target[NAME]));
- }
+ try {
+ for (String[] target : targets) {
+ for (String fmt : formats) {
+ boolean found = processText(license, String.format(fmt, target[TEXT]));
+ license.reset();
+ assertTrue(found, () -> String.format("%s %s did not match pattern '%s' for target string %s", id,
+ name, fmt, target[NAME]));
}
- } finally {
- license.reset();
}
+ } finally {
+ license.reset();
+ }
}
+
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/ApacheSoftwareLicenseTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/ApacheSoftwareLicenseTest.java
index e1c00e522..ef7692ad8 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/ApacheSoftwareLicenseTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/ApacheSoftwareLicenseTest.java
@@ -66,18 +66,4 @@ public class ApacheSoftwareLicenseTest extends AbstractLicenseTest {
public static Stream parameterProvider() {
return Stream.of(Arguments.of(id, id, name, null, targets));
}
-
-//
-// @Test(timeout = 2000) // may need to be adjusted if many more files are added
-// public void goodFiles() throws Exception {
-// IHeaderMatcher matcher = new MultiplexLicense("goodFiles", AbstractMatcherTest.extractCategory(category));
-// DirectoryScanner.testFilesInDir("appliedAL20/good", matcher, true);
-// }
-//
-// @Test(timeout = 2000) // may need to be adjusted if many more files are added
-// public void badFiles() throws Exception {
-// IHeaderMatcher matcher = new MultiplexLicense("badFiles", AbstractMatcherTest.extractCategory(category));
-// DirectoryScanner.testFilesInDir("appliedAL20/bad", matcher, false);
-// }
-
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/AppliedApacheSoftwareLicenseTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/AppliedApacheSoftwareLicenseTest.java
index 7f2df2119..64b44444d 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/AppliedApacheSoftwareLicenseTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/AppliedApacheSoftwareLicenseTest.java
@@ -25,7 +25,6 @@
public class AppliedApacheSoftwareLicenseTest extends AbstractLicenseTest {
private static String ID = "ASL";
- private static String NAME = "Applied Apache License Version 2.0";
private static String[][] targets = { { "simple", "/*\n" + " * Copyright 2012-2013 FooBar.\n" + " *\n"
+ " * Licensed under the Apache License, Version 2.0 (the \"License\");\n"
+ " * you may not use this file except in compliance with the License.\n" + " *\n"
@@ -39,19 +38,4 @@ public class AppliedApacheSoftwareLicenseTest extends AbstractLicenseTest {
public static Stream parameterProvider() {
return Stream.of(Arguments.of(ID, ApacheSoftwareLicenseTest.id, ApacheSoftwareLicenseTest.name, null, targets));
}
-
- /*
-
-
- @Test(timeout = 2000) // may need to be adjusted if many more files are added
- public void goodFiles() throws Exception {
- DirectoryScanner.testFilesInDir("appliedAL20/good", license, true);
- }
-
- @Test(timeout = 2000) // may need to be adjusted if many more files are added
- public void baddFiles() throws Exception {
- DirectoryScanner.testFilesInDir("appliedAL20/bad", license, false);
- }
- */
-
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/CDDL1LicenseTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/CDDL1LicenseTest.java
index d0008085f..49c66663a 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/CDDL1LicenseTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/CDDL1LicenseTest.java
@@ -43,7 +43,7 @@ public class CDDL1LicenseTest extends AbstractLicenseTest {
{ "spdx-space", "SPDX-License-Identifier: CDDL-1.0" } };
public static Stream parameterProvider() {
- return Stream.of(Arguments.of( id, id, name, null, targets));
+ return Stream.of(Arguments.of(id, id, name, null, targets));
}
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/DirectoryScanner.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/DirectoryScanner.java
index 57eb1b9a5..887169b77 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/DirectoryScanner.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/DirectoryScanner.java
@@ -24,8 +24,8 @@
import java.io.BufferedReader;
import java.io.File;
-import org.apache.commons.io.IOUtils;
-import org.apache.rat.analysis.IHeaderMatcher.State;
+import org.apache.rat.analysis.HeaderCheckWorker;
+import org.apache.rat.analysis.IHeaders;
import org.apache.rat.license.ILicense;
import org.apache.rat.test.utils.Resources;
import org.junit.jupiter.api.Test;
@@ -48,18 +48,13 @@ public static void testFilesInDir(String directory, ILicense license, boolean ex
fail("No files found under " + directory);
}
for (File f : resourceFiles) {
- BufferedReader br = null;
- try {
- boolean result = false;
- br = Resources.getBufferedReader(f);
- String line;
- while (!result && (line = br.readLine()) != null) {
- result = license.matches(line) == State.t;
- }
+ try (BufferedReader br = Resources.getBufferedReader(f)) {
+ IHeaders headers = HeaderCheckWorker.readHeader(br,
+ HeaderCheckWorker.DEFAULT_NUMBER_OF_RETAINED_HEADER_LINES);
+ boolean result = license.matches(headers);
assertEquals(expected, result, f.toString());
} finally {
license.reset();
- IOUtils.closeQuietly(br);
}
}
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/GPLLicenseTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/GPLLicenseTest.java
index 7d0a51eae..31c53a6ba 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/GPLLicenseTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/GPLLicenseTest.java
@@ -29,15 +29,17 @@
public class GPLLicenseTest extends AbstractLicenseTest {
- private static Arguments GPL1 = Arguments.of( "GPL1", "GPL1", "GNU General Public License, version 1", null,
+ private static Arguments GPL1 = Arguments.of("GPL1", "GPL1", "GNU General Public License, version 1", null,
new String[][] {
- { "fulltext", "This program is free software; you can redistribute it and/or modify\n "
- + "it under the terms of the GNU General Public License as published by\n "
- + "the Free Software Foundation; either version 1, or (at your option)\n " + "any later version." },
- { "spdx-tab", "SPDX-License-Identifier:\tGPL-1.0-only" },
- { "spdx-space", "SPDX-License-Identifier: GPL-1.0-only" }, } );
+ { "fulltext",
+ "This program is free software; you can redistribute it and/or modify\n "
+ + "it under the terms of the GNU General Public License as published by\n "
+ + "the Free Software Foundation; either version 1, or (at your option)\n "
+ + "any later version." },
+ { "spdx-tab", "SPDX-License-Identifier:\tGPL-1.0-only" },
+ { "spdx-space", "SPDX-License-Identifier: GPL-1.0-only" }, });
- private static Arguments GPL2 = Arguments.of( "GPL2", "GPL2", "GNU General Public License, version 2", null,
+ private static Arguments GPL2 = Arguments.of("GPL2", "GPL2", "GNU General Public License, version 2", null,
new String[][] {
{ "fulltext",
"This program is free software; you can redistribute it and/or\n"
@@ -45,9 +47,9 @@ public class GPLLicenseTest extends AbstractLicenseTest {
+ "as published by the Free Software Foundation; either version 2\n"
+ "of the License, or (at your option) any later version." },
{ "spdx-tab", "SPDX-License-Identifier:\tGPL-2.0-only" },
- { "spdx-space", "SPDX-License-Identifier: GPL-2.0-only" }, } );
+ { "spdx-space", "SPDX-License-Identifier: GPL-2.0-only" }, });
- private static Arguments GPL3 = Arguments.of( "GPL3", "GPL3", "GNU General Public License, version 3", null,
+ private static Arguments GPL3 = Arguments.of("GPL3", "GPL3", "GNU General Public License, version 3", null,
new String[][] {
{ "fulltext",
"This program is free software: you can redistribute it and/or modify\n"
@@ -55,8 +57,7 @@ public class GPLLicenseTest extends AbstractLicenseTest {
+ " the Free Software Foundation, either version 3 of the License, or\n"
+ " (at your option) any later version." },
{ "spdx-tab", "SPDX-License-Identifier:\tGPL-3.0-only" },
- { "spdx-space", "SPDX-License-Identifier: GPL-3.0-only" }, } );
-
+ { "spdx-space", "SPDX-License-Identifier: GPL-3.0-only" }, });
public static Stream parameterProvider() {
return Stream.of(GPL1, GPL2, GPL3);
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/GeneratedLicenseTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/GeneratedLicenseTest.java
index b8232440a..431db58d1 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/GeneratedLicenseTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/GeneratedLicenseTest.java
@@ -46,6 +46,6 @@ public class GeneratedLicenseTest extends AbstractLicenseTest {
{ "generated by", "This class was generated by" }, { "javadoc", "Generated by javadoc" } };
public static Stream parameterProvider() {
- return Stream.of(Arguments.of( id, id, name, notes, targets));
+ return Stream.of(Arguments.of(id, id, name, notes, targets));
}
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/W3CLicenseTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/W3CLicenseTest.java
index 2fde04c0c..bdec2fd69 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/W3CLicenseTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/W3CLicenseTest.java
@@ -22,23 +22,22 @@
import org.junit.jupiter.params.provider.Arguments;
-
public class W3CLicenseTest extends AbstractLicenseTest {
private static String W3C_note = "Note that W3C requires a NOTICE.\n" + "All modifications require notes.\n"
+ "See http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231.";
- private static Arguments W3C = Arguments.of( "W3C", "W3C", "W3C Software Copyright", W3C_note,
+ private static Arguments W3C = Arguments.of("W3C", "W3C", "W3C Software Copyright", W3C_note,
new String[][] { { "fulltext", "http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231" },
{ "spdx-tab", "SPDX-License-Identifier:\tW3C" },
- { "spdx-space", "SPDX-License-Identifier: W3C" }, } );
+ { "spdx-space", "SPDX-License-Identifier: W3C" }, });
private static String W3CD_note = "Note that W3CD does not allow modifications.\n"
+ "See http://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231.";
- private static Arguments W3CD = Arguments.of("W3CD", "W3CD","W3C Document Copyright", W3CD_note, new String[][] {
- { "fulltext", "http://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231" }, } );
+ private static Arguments W3CD = Arguments.of("W3CD", "W3CD", "W3C Document Copyright", W3CD_note,
+ new String[][] { { "fulltext", "http://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231" }, });
public static Stream parameterProvider() {
return Stream.of(W3C, W3CD);
}
-
+
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/AbstractMatcherTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/AbstractMatcherTest.java
new file mode 100644
index 000000000..3b38d0502
--- /dev/null
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/AbstractMatcherTest.java
@@ -0,0 +1,65 @@
+/*
+ * 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.analysis.matchers;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.util.Locale;
+
+import org.apache.rat.analysis.IHeaderMatcher;
+import org.apache.rat.analysis.IHeaders;
+
+public class AbstractMatcherTest {
+
+ private IHeaders dummyHeader = makeHeaders(null, null);
+
+ protected void assertValues(IHeaderMatcher target, boolean... values) {
+ for (int i = 0; i < values.length; i++) {
+ final int idx = i;
+ assertEquals(values[i], target.matches(dummyHeader), () -> String.format("Position %s", idx));
+ }
+ }
+
+ public static IHeaders makeHeaders(String raw, String pruned) {
+ return new IHeaders() {
+
+ @Override
+ public String raw() {
+ if (raw == null) {
+ throw new UnsupportedOperationException("Should not be called");
+ }
+ return raw;
+ }
+
+ @Override
+ public String pruned() {
+ if (pruned == null) {
+ throw new UnsupportedOperationException("Should not be called");
+ }
+ return FullTextMatcher.prune(pruned).toLowerCase(Locale.ENGLISH);
+ }
+
+ @Override
+ public String toString() {
+ return "AbstractMatcherTest";
+ }
+ };
+ }
+
+}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/AndMatcherTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/AndMatcherTest.java
index a8ac49994..d374f7d36 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/AndMatcherTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/AndMatcherTest.java
@@ -18,61 +18,22 @@
*/
package org.apache.rat.analysis.matchers;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-
import java.util.Arrays;
import org.apache.rat.analysis.IHeaderMatcher;
-import org.apache.rat.analysis.IHeaderMatcher.State;
import org.apache.rat.testhelpers.TestingMatcher;
import org.junit.jupiter.api.Test;
-
-public class AndMatcherTest {
-
- private void assertValues(IHeaderMatcher target, State hello, State world, State finalize) {
- assertEquals(State.i, target.currentState());
- assertEquals(hello, target.matches("hello"));
- assertEquals(hello, target.currentState());
- assertEquals(world, target.matches("world"));
- assertEquals(world, target.currentState());
- assertEquals(finalize, target.finalizeState());
- assertEquals(finalize, target.currentState());
- }
+public class AndMatcherTest extends AbstractMatcherTest {
@Test
public void trueTest() {
- IHeaderMatcher one = new TestingMatcher("one", true);
- IHeaderMatcher two = new TestingMatcher("two", false, true);
- AndMatcher target = new AndMatcher("Testing", Arrays.asList(one, two));
- assertValues(target, State.i, State.t, State.t);
- target.reset();
- assertEquals(State.i, one.currentState());
- assertEquals(State.i, two.currentState());
- assertEquals(State.i, target.currentState());
- }
- @Test
- public void falseTest() {
- IHeaderMatcher one = new TestingMatcher("one", true);
- IHeaderMatcher two = new TestingMatcher("two", false, false);
- AndMatcher target = new AndMatcher("Testing", Arrays.asList(one, two));
- assertValues(target, State.i, State.i, State.f);
- target.reset();
- assertEquals(State.i, one.currentState());
- assertEquals(State.i, two.currentState());
- assertEquals(State.i, target.currentState());
- }
-
- @Test
- public void indeterminentTest() {
- IHeaderMatcher one = new TestingMatcher("one", false, false);
- IHeaderMatcher two = new TestingMatcher("two", false, false);
- AndMatcher target = new AndMatcher("Testing", Arrays.asList(one, two));
- assertValues(target, State.i, State.i, State.f);
+ IHeaderMatcher one = new TestingMatcher("one", true, true, false, false);
+ // only need 2 entries because when one is false two test does not get called.
+ IHeaderMatcher two = new TestingMatcher("two", true, false);
+ AndMatcher target = new AndMatcher("Testing", Arrays.asList(one, two), null);
+ assertValues(target, true, false, false, false);
target.reset();
- assertEquals(State.i, one.currentState());
- assertEquals(State.i, two.currentState());
- assertEquals(State.i, target.currentState());
}
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/CopyrightMatcherTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/CopyrightMatcherTest.java
index 32f6820ee..7ae264716 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/CopyrightMatcherTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/CopyrightMatcherTest.java
@@ -20,6 +20,7 @@
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
import java.util.ArrayList;
import java.util.Arrays;
@@ -28,7 +29,7 @@
import java.util.Set;
import java.util.stream.Stream;
-import org.apache.rat.analysis.IHeaderMatcher.State;
+import org.apache.rat.analysis.IHeaders;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
@@ -37,7 +38,7 @@ public class CopyrightMatcherTest {
private final static int NAME = 0;
private final static int TEXT = 1;
// to be added
- private static String[] prefix = { "Copyright", "©", "(C)", "(c)" };
+ private static String[] prefix = { "Copyright", "©", "(C)", "(c)", "©" };
private final static String[] D = { "-d", " 1990-1991" };
private final static String[] DO = { "-d-o", " 1990-1991 an owner" };
@@ -52,27 +53,24 @@ public class CopyrightMatcherTest {
private static final int TOTAL_TESTS = prefix.length * 9;
static Arguments startStopOwner = Arguments.of("start-stop-owner", "1990", "1991", "an owner",
- expandResults( DO, OD, DOS, ODS) , expandResults( D, S, O, OS, SO ));
- static Arguments startOwner = Arguments.of( "start-owner", "1990", null, "an owner",
- expandResults( OS, SO, OD, ODS ), expandResults( D, DO, DOS, S, O ) );
- static Arguments start = Arguments.of("start", "1990", null, null, expandResults(D, DO, DOS, S, SO ),
- expandResults(OD, ODS, O, OS ) );
- static Arguments owner = Arguments.of("owner", null, null, "an owner", expandResults( O, OD, ODS, OS ),
-expandResults( DO, DOS, S, D, SO ) );
- static Arguments nada = Arguments.of("nada", null, null, null, expandResults( D, DO, DOS, S, SO ),
- expandResults( OD, ODS, O, OS ) );
+ expandResults(DO, OD, DOS, ODS), expandResults(D, S, O, OS, SO));
+ static Arguments startOwner = Arguments.of("start-owner", "1990", null, "an owner", expandResults(OS, SO, OD, ODS),
+ expandResults(D, DO, DOS, S, O));
+ static Arguments start = Arguments.of("start", "1990", null, null, expandResults(D, DO, DOS, S, SO),
+ expandResults(OD, ODS, O, OS));
+ static Arguments owner = Arguments.of("owner", null, null, "an owner", expandResults(O, OD, ODS, OS),
+ expandResults(DO, DOS, S, D, SO));
+ static Arguments nada = Arguments.of("nada", null, null, null, expandResults(D, DO, DOS, S, SO),
+ expandResults(OD, ODS, O, OS));
-
-
public static Stream parameterProvider() {
- return Stream.of( startStopOwner, startOwner, start, owner, nada);
+ return Stream.of(startStopOwner, startOwner, start, owner, nada);
}
- private static String[][] expandResults( String[]...args) {
+ private static String[][] expandResults(String[]... args) {
List arry = new ArrayList<>();
for (String pfx : prefix) {
- Arrays.stream(args).map(origin -> new String[] { pfx + origin[0], pfx + origin[1] })
- .forEach(arry::add);
+ Arrays.stream(args).map(origin -> new String[] { pfx + origin[0], pfx + origin[1] }).forEach(arry::add);
}
return arry.toArray(new String[arry.size()][2]);
}
@@ -84,36 +82,32 @@ private static void verify(String testName, String[][] pass, String[][] fail) {
Set failSet = new HashSet();
Arrays.stream(fail).forEach(s -> failSet.add(s[0]));
for (String s : passSet) {
- assertFalse(failSet.contains(s), ()->String.format("%s is in both pass and fail sets for %s", s, testName));
+ assertFalse(failSet.contains(s),
+ () -> String.format("%s is in both pass and fail sets for %s", s, testName));
}
}
@ParameterizedTest
@MethodSource("parameterProvider")
- public void testPass(String testName, String start, String stop, String owner, String[][] pass,
- String[][] fail) {
+ public void testPass(String testName, String start, String stop, String owner, String[][] pass, String[][] fail) {
verify(testName, pass, fail);
CopyrightMatcher matcher = new CopyrightMatcher(start, stop, owner);
for (String[] target : pass) {
- assertEquals(State.i, matcher.currentState(), ()->String.format("%s:%s failed", testName, target[NAME]));
- assertEquals(State.t, matcher.matches(target[TEXT]), ()->String.format("%s:%s failed", testName, target[NAME]));
+ IHeaders headers = AbstractMatcherTest.makeHeaders(target[TEXT], null);
+ assertTrue(matcher.matches(headers), () -> String.format("%s:%s failed", testName, target[NAME]));
matcher.reset();
- assertEquals(State.i, matcher.currentState(),()->String.format("%s:%s failed", testName, target[NAME]));
}
}
@ParameterizedTest
@MethodSource("parameterProvider")
- public void testFail(String testName, String start, String stop, String owner, String[][] pass,
- String[][] fail) {
+ public void testFail(String testName, String start, String stop, String owner, String[][] pass, String[][] fail) {
verify(testName, pass, fail);
CopyrightMatcher matcher = new CopyrightMatcher(start, stop, owner);
for (String[] target : fail) {
- assertEquals( State.i, matcher.currentState(), ()->String.format("%s:%s passed", testName, target[NAME]));
- assertEquals( State.i, matcher.matches(target[TEXT]), ()->String.format("%s:%s passed", testName, target[NAME]));
- assertEquals( State.f, matcher.finalizeState(), ()->String.format("%s:%s passed", testName, target[NAME]));
+ IHeaders headers = AbstractMatcherTest.makeHeaders(target[TEXT], null);
+ assertFalse(matcher.matches(headers), String.format("%s:%s passed", testName, target[NAME]));
matcher.reset();
- assertEquals( State.i, matcher.currentState(), ()->String.format("%s:%s passed", testName, target[NAME]));
}
}
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/FullTextMatcherTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/FullTextMatcherTest.java
index 03a3251c9..dbdccda58 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/FullTextMatcherTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/FullTextMatcherTest.java
@@ -18,59 +18,25 @@
*/
package org.apache.rat.analysis.matchers;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-
-import org.apache.rat.analysis.IHeaderMatcher.State;
-
public class FullTextMatcherTest {
FullTextMatcher target = new FullTextMatcher("Hello world");
-
+
@BeforeEach
public void setup() {
target.reset();
}
-
+
@Test
public void testMatch() {
- assertEquals( State.i, target.currentState());
- assertEquals( State.i, target.matches("what in the world"));
- assertEquals( State.i, target.currentState());
- assertEquals( State.t, target.matches("hello world"));
- assertEquals( State.t, target.currentState());
- assertEquals( State.t, target.finalizeState());
- assertEquals( State.t, target.currentState());
- target.reset();
- assertEquals( State.i, target.currentState());
- }
-
- @Test
- public void testNoMatch() {
- assertEquals( State.i, target.currentState());
- assertEquals( State.i, target.matches("what in the world"));
- assertEquals( State.i, target.currentState());
- assertEquals( State.i, target.matches("hello there"));
- assertEquals( State.i, target.currentState());
- assertEquals( State.f, target.finalizeState());
- assertEquals( State.f, target.currentState());
- target.reset();
- assertEquals( State.i, target.currentState());
- }
-
- @Test
- public void testTrueIsAlwaysTrue() {
- assertEquals( State.i, target.currentState());
- assertEquals( State.t, target.matches("hello world"));
- assertEquals( State.t, target.currentState());
- assertEquals( State.t, target.matches("A non matching line"));
- assertEquals( State.t, target.currentState());
- assertEquals( State.t, target.finalizeState());
- assertEquals( State.t, target.currentState());
- target.reset();
- assertEquals( State.i, target.currentState());
+ assertFalse(target.matches(AbstractMatcherTest.makeHeaders(null, "what in the world")));
+ assertTrue(target.matches(AbstractMatcherTest.makeHeaders(null, "hello world")));
+ assertTrue(target.matches(AbstractMatcherTest.makeHeaders(null, "HELLO world")));
}
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/NotMatcherTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/NotMatcherTest.java
index 806b6573d..d1965b251 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/NotMatcherTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/NotMatcherTest.java
@@ -18,46 +18,17 @@
*/
package org.apache.rat.analysis.matchers;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-
import org.apache.rat.analysis.IHeaderMatcher;
-import org.apache.rat.analysis.IHeaderMatcher.State;
import org.apache.rat.testhelpers.TestingMatcher;
import org.junit.jupiter.api.Test;
-public class NotMatcherTest {
-
- private void assertValues(IHeaderMatcher target, State hello, State world, State finalize) {
- assertEquals(State.i, target.currentState());
- assertEquals( hello, target.matches("hello"), "hello match");
- assertEquals( hello, target.currentState(), "hello current");
- assertEquals(world, target.matches("world"), "world match");
- assertEquals( world, target.currentState(), "world current");
- assertEquals(finalize, target.finalizeState(), "finalize match");
- assertEquals(finalize, target.currentState(), "finalize current");
- }
+public class NotMatcherTest extends AbstractMatcherTest {
@Test
- public void testTrue() {
- IHeaderMatcher one = new TestingMatcher("one", true);
+ public void test() {
+ IHeaderMatcher one = new TestingMatcher("one", true, false);
NotMatcher target = new NotMatcher("Testing", one);
- assertValues(target, State.f, State.f, State.f);
-
- one = new TestingMatcher("one", false, true);
- target = new NotMatcher("Testing", one);
- assertValues(target, State.i, State.f, State.f);
- target.reset();
- assertEquals(State.i, target.currentState());
+ assertValues(target, false, true);
}
- @Test
- public void testFalse() {
- TestingMatcher one = new TestingMatcher("one", false, false);
- one.finalState = State.t;
- NotMatcher target = new NotMatcher("Testing", one);
- assertValues(target, State.i, State.i, State.f);
- target.reset();
- assertEquals(State.i, target.currentState());
-
- }
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/OrMatcherTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/OrMatcherTest.java
index 81478b37b..d9cc62da2 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/OrMatcherTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/OrMatcherTest.java
@@ -18,60 +18,20 @@
*/
package org.apache.rat.analysis.matchers;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-
import java.util.Arrays;
import org.apache.rat.analysis.IHeaderMatcher;
-import org.apache.rat.analysis.IHeaderMatcher.State;
import org.apache.rat.testhelpers.TestingMatcher;
import org.junit.jupiter.api.Test;
-public class OrMatcherTest {
-
- private void assertValues(IHeaderMatcher target, State hello, State world, State finalize) {
- assertEquals(State.i, target.currentState());
- assertEquals( hello, target.matches("hello"), "hello match");
- assertEquals( hello, target.currentState(), "hello current");
- assertEquals(world, target.matches("world"), "world match");
- assertEquals( world, target.currentState(), "world current");
- assertEquals(finalize, target.finalizeState(), "finalize match");
- assertEquals(finalize, target.currentState(), "finalize current");
- }
+public class OrMatcherTest extends AbstractMatcherTest {
@Test
public void trueTest() {
- IHeaderMatcher one = new TestingMatcher("one", false, false);
- IHeaderMatcher two = new TestingMatcher("two", false, true);
- OrMatcher target = new OrMatcher("Testing", Arrays.asList(one, two));
- assertValues(target, State.i, State.t, State.t);
- target.reset();
- assertEquals(State.i, one.currentState());
- assertEquals(State.i, two.currentState());
- assertEquals(State.i, target.currentState());
- }
-
- @Test
- public void falseTest() {
- IHeaderMatcher one = new TestingMatcher("one", false, false);
- IHeaderMatcher two = new TestingMatcher("two", false, false);
- OrMatcher target = new OrMatcher("Testing", Arrays.asList(one, two));
- assertValues(target, State.i, State.i, State.f);
- target.reset();
- assertEquals(State.i, one.currentState());
- assertEquals(State.i, two.currentState());
- assertEquals(State.i, target.currentState());
- }
-
- @Test
- public void indeterminentTest() {
- IHeaderMatcher one = new TestingMatcher("one", false, false);
- IHeaderMatcher two = new TestingMatcher("two", false, false);
- OrMatcher target = new OrMatcher("Testing", Arrays.asList(one, two));
- assertValues(target, State.i, State.i, State.f);
+ IHeaderMatcher one = new TestingMatcher("one", false, false, true, true);
+ IHeaderMatcher two = new TestingMatcher("two", false, true, false, true);
+ OrMatcher target = new OrMatcher("Testing", Arrays.asList(one, two), null);
+ assertValues(target, false, true, true, true);
target.reset();
- assertEquals(State.i, one.currentState());
- assertEquals(State.i, two.currentState());
- assertEquals(State.i, target.currentState());
}
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SPDXMatcherTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SPDXMatcherTest.java
index 124ed357b..819cdc694 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SPDXMatcherTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SPDXMatcherTest.java
@@ -18,10 +18,10 @@
*/
package org.apache.rat.analysis.matchers;
-import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
import org.apache.rat.analysis.IHeaderMatcher;
-import org.apache.rat.analysis.IHeaderMatcher.State;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
@@ -36,51 +36,8 @@ public void setup() {
@Test
public void testMatch() {
- assertEquals(State.i, target.currentState());
- assertEquals(State.i, target.matches("SPDX-License-Identifier: Apache-2"));
- assertEquals(State.i, target.currentState());
- assertEquals(State.t, target.matches("SPDX-License-Identifier: hello"));
- assertEquals(State.t, target.currentState());
- assertEquals(State.t, target.finalizeState());
- assertEquals(State.t, target.currentState());
+ assertFalse(target.matches(AbstractMatcherTest.makeHeaders("SPDX-License-Identifier: Apache-2", null)));
+ assertTrue(target.matches(AbstractMatcherTest.makeHeaders("SPDX-License-Identifier: hello", null)));
target.reset();
- assertEquals(State.i, target.currentState());
- }
-
- @Test
- public void testNoMatch() {
- assertEquals(State.i, target.currentState());
- assertEquals(State.i, target.matches("SPDX-License-Identifier: Apache-2"));
- assertEquals(State.i, target.currentState());
- assertEquals(State.i, target.matches("SPDX-License-Identifier: MIT"));
- assertEquals(State.i, target.currentState());
- assertEquals(State.f, target.finalizeState());
- assertEquals(State.f, target.currentState());
- target.reset();
- assertEquals(State.i, target.currentState());
- }
-
- @Test
- public void testTrueIsAlwaysTrue() {
- assertEquals(State.i, target.currentState());
- assertEquals(State.t, target.matches("SPDX-License-Identifier: hello"));
- assertEquals(State.t, target.currentState());
- assertEquals(State.t, target.matches("SPDX-License-Identifier: Apache-2"));
- assertEquals(State.t, target.currentState());
- assertEquals(State.t, target.finalizeState());
- assertEquals(State.t, target.currentState());
- target.reset();
- assertEquals(State.i, target.currentState());
- }
-
- @Test
- public void testResetClearsLastMatch() {
-
- assertEquals(State.i, target.currentState());
- assertEquals(State.t, target.matches("SPDX-License-Identifier: hello"));
- assertEquals(State.t, target.currentState());
- target.reset();
- assertEquals(State.i, target.currentState());
- assertEquals(State.i, target.matches("Something weird"));;
}
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SimpleCopyrightTests.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SimpleCopyrightTests.java
index b836f6470..6a12f9a0a 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SimpleCopyrightTests.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SimpleCopyrightTests.java
@@ -18,26 +18,19 @@
*/
package org.apache.rat.analysis.matchers;
-import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
-import org.apache.rat.analysis.IHeaderMatcher.State;
import org.junit.jupiter.api.Test;
public class SimpleCopyrightTests {
- CopyrightMatcher target = new CopyrightMatcher(null,null,null);
-
+ CopyrightMatcher target = new CopyrightMatcher(null, null, null);
+
@Test
public void testTrueIsAlwaysTrue() {
-
- assertEquals( State.i, target.currentState());
- assertEquals( State.t, target.matches("hello Copyright 1999"));
- assertEquals( State.t, target.currentState());
- assertEquals( State.t, target.matches("A non matching line"));
- assertEquals( State.t, target.currentState());
- assertEquals( State.t, target.finalizeState());
- assertEquals( State.t, target.currentState());
+ assertTrue(target.matches(AbstractMatcherTest.makeHeaders("hello Copyright 1999", null)));
+ assertFalse(target.matches(AbstractMatcherTest.makeHeaders("A non matching line", null)));
target.reset();
- assertEquals( State.i, target.currentState());
}
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SimpleRegexMatcherTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SimpleRegexMatcherTest.java
index 53dee7607..e4d2c5b68 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SimpleRegexMatcherTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SimpleRegexMatcherTest.java
@@ -18,60 +18,26 @@
*/
package org.apache.rat.analysis.matchers;
-import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Test;
-
import static org.junit.jupiter.api.Assertions.assertEquals;
import java.util.regex.Pattern;
-import org.apache.rat.analysis.IHeaderMatcher.State;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
public class SimpleRegexMatcherTest {
- SimpleRegexMatcher target = new SimpleRegexMatcher(Pattern.compile("hello\\sworld"));
-
+ SimpleRegexMatcher target = new SimpleRegexMatcher(null, Pattern.compile("hello\\sworld"));
+
@BeforeEach
public void setup() {
target.reset();
}
-
- @Test
- public void testMatch() {
- assertEquals( State.i, target.currentState());
- assertEquals( State.i, target.matches("what in the world"));
- assertEquals( State.i, target.currentState());
- assertEquals( State.t, target.matches("hello world"));
- assertEquals( State.t, target.currentState());
- assertEquals( State.t, target.finalizeState());
- assertEquals( State.t, target.currentState());
- target.reset();
- assertEquals( State.i, target.currentState());
- }
@Test
- public void testNoMatch() {
- assertEquals( State.i, target.currentState());
- assertEquals( State.i, target.matches("what in the world"));
- assertEquals( State.i, target.currentState());
- assertEquals( State.i, target.matches("hello there"));
- assertEquals( State.i, target.currentState());
- assertEquals( State.f, target.finalizeState());
- assertEquals( State.f, target.currentState());
- target.reset();
- assertEquals( State.i, target.currentState());
- }
-
- @Test
- public void testTrueIsAlwaysTrue() {
- assertEquals( State.i, target.currentState());
- assertEquals( State.t, target.matches("hello world"));
- assertEquals( State.t, target.currentState());
- assertEquals( State.t, target.matches("A non matching line"));
- assertEquals( State.t, target.currentState());
- assertEquals( State.t, target.finalizeState());
- assertEquals( State.t, target.currentState());
+ public void test() {
+ assertEquals(false, target.matches(AbstractMatcherTest.makeHeaders("what in the world", null)));
+ assertEquals(true, target.matches(AbstractMatcherTest.makeHeaders("hello world", null)));
target.reset();
- assertEquals( State.i, target.currentState());
}
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SimpleTextMatcherTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SimpleTextMatcherTest.java
index 2ad73d6bf..610a0746f 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SimpleTextMatcherTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/matchers/SimpleTextMatcherTest.java
@@ -18,9 +18,9 @@
*/
package org.apache.rat.analysis.matchers;
-import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
-import org.apache.rat.analysis.IHeaderMatcher.State;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
@@ -35,54 +35,9 @@ public void setup() {
@Test
public void testMatch() {
- assertEquals(State.i, target.currentState());
- assertEquals(State.i, target.matches("what in the world"));
- assertEquals(State.i, target.currentState());
- assertEquals(State.t, target.matches("hello world"));
- assertEquals(State.t, target.currentState());
- assertEquals(State.t, target.finalizeState());
- assertEquals(State.t, target.currentState());
+ assertFalse(target.matches(AbstractMatcherTest.makeHeaders("what in the world", null)));
+ assertTrue(target.matches(AbstractMatcherTest.makeHeaders("hello world", null)));
target.reset();
- assertEquals(State.i, target.currentState());
}
- @Test
- public void testNoMatch() {
- assertEquals(State.i, target.currentState());
- assertEquals(State.i, target.matches("what in the world"));
- assertEquals(State.i, target.currentState());
- assertEquals(State.i, target.matches("hell o'there"));
- assertEquals(State.i, target.currentState());
- assertEquals(State.f, target.finalizeState());
- assertEquals(State.f, target.currentState());
- target.reset();
- assertEquals(State.i, target.currentState());
- }
-
- @Test
- public void testTrueIsAlwaysTrue() {
- assertEquals(State.i, target.currentState());
- assertEquals(State.t, target.matches("hello world"));
- assertEquals(State.t, target.currentState());
- assertEquals(State.t, target.matches("A non matching line"));
- assertEquals(State.t, target.currentState());
- assertEquals(State.t, target.finalizeState());
- assertEquals(State.t, target.currentState());
- target.reset();
- assertEquals(State.i, target.currentState());
- }
-
- @Test
- public void testIndeterminent() {
- target = new SimpleTextMatcher("not a match");
- assertEquals(State.i, target.currentState());
- assertEquals(State.i, target.matches("hello world"));
- assertEquals(State.i, target.currentState());
- assertEquals(State.i, target.matches("A non matching line"));
- assertEquals(State.i, target.currentState());
- assertEquals(State.f, target.finalizeState());
- assertEquals(State.f, target.currentState());
- target.reset();
- assertEquals(State.i, target.currentState());
- }
}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/annotation/TestLicenseAppender.java b/apache-rat-core/src/test/java/org/apache/rat/annotation/TestLicenseAppender.java
index 92ea98325..a6b6040b9 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/annotation/TestLicenseAppender.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/annotation/TestLicenseAppender.java
@@ -39,10 +39,9 @@
import org.junit.jupiter.api.io.TempDir;
public class TestLicenseAppender {
-
- @TempDir
+
+ @TempDir
private File baseTempFolder;
-
private static final String FIRST_LICENSE_LINE = " Licensed to the Apache Software Foundation (ASF) under one";
@@ -57,44 +56,39 @@ private interface NewFileReader {
private String getTemporaryFileWithName(String fileName) throws IOException {
if (fileName != null) {
- return new File(baseTempFolder,fileName).getAbsolutePath();
+ return new File(baseTempFolder, fileName).getAbsolutePath();
}
return File.createTempFile("tla", null, baseTempFolder).getAbsolutePath();
}
- private static void createTestFile(String fileName,
- FileCreator creator)
- throws IOException {
+ private static void createTestFile(String fileName, FileCreator creator) throws IOException {
try (FileWriter w = new FileWriter(fileName)) {
creator.createFile(w);
}
}
- private void commonTestTemplate(String relativeName,
- FileCreator creator,
- NewFileReader reader)
- throws IOException {
+ private void commonTestTemplate(String relativeName, FileCreator creator, NewFileReader reader) throws IOException {
String name = getTemporaryFileWithName(relativeName);
-
- createTestFile(name, creator);
- ApacheV2LicenseAppender appender =
- new ApacheV2LicenseAppender(DefaultLog.INSTANCE);
- appender.append(new File(name));
+ createTestFile(name, creator);
- try (BufferedReader r = new BufferedReader(new FileReader(name + ".new"))){
- reader.readFile(r);
- }
- FileUtils.delete( new File(name+".new"));
- FileUtils.delete( new File(name));
+ ApacheV2LicenseAppender appender = new ApacheV2LicenseAppender(DefaultLog.INSTANCE);
+ appender.append(new File(name));
+
+ try (BufferedReader r = new BufferedReader(new FileReader(name + ".new"))) {
+ reader.readFile(r);
+ }
+ FileUtils.delete(new File(name + ".new"));
+ FileUtils.delete(new File(name));
}
- private static NewFileReader checkLines(final String ... lines) {
+ private static NewFileReader checkLines(final String... lines) {
return new NewFileReader() {
+ @Override
public void readFile(BufferedReader r) throws IOException {
- for (int i=0; i\n");
- writer.write("\n");
- }
- },
- checkLines(firstLine, secondLine, thirdLine));
+ @Override
+ public void createFile(Writer writer) throws IOException {
+ writer.write(firstLine + "\n");
+ writer.write("\n");
+ writer.write("\n");
+ writer.write("\n");
+ }
+ }, checkLines(firstLine, secondLine, thirdLine));
}
@Test
@@ -179,13 +169,12 @@ public void addLicenseToXMLWithoutDecl() throws IOException {
final String secondLine = "");
- writer.write("## This is the second header\n");
- }
- },
- new NewFileReader() {
- public void readFile(BufferedReader r) throws IOException {
- String line = r.readLine();
- assertEquals(
- "");
+ writer.write("## This is the second header\n");
+ }
+ }, new NewFileReader() {
+ @Override
+ public void readFile(BufferedReader r) throws IOException {
+ String line = r.readLine();
+ assertEquals("
-package elements;
+
+
+
+
+
+
+
+
+
+
+
-
\ No newline at end of file
+ ]]>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/apache-rat-core/src/test/resources/elements/generated.txt b/apache-rat-core/src/test/resources/elements/generated.txt
new file mode 100644
index 000000000..8b438ec79
--- /dev/null
+++ b/apache-rat-core/src/test/resources/elements/generated.txt
@@ -0,0 +1,3 @@
+DO NOT EDIT THIS FILE - it is machine generated
+
+Not really but just for testing.
\ No newline at end of file
diff --git a/apache-rat-core/src/test/resources/elements/tri.txt b/apache-rat-core/src/test/resources/elements/tri.txt
new file mode 100644
index 000000000..0c5a393a6
--- /dev/null
+++ b/apache-rat-core/src/test/resources/elements/tri.txt
@@ -0,0 +1,6 @@
+Licensed under the Apache License, Version 2.0 (the "License")
+This file is not TMF854 Version 1.0
+This file is not Copyright TeleManagement Forum
+this file does not match SPDX-License-Identifier: BSD-3-Clause
+
+This file should be detected under three licenses.
\ No newline at end of file
diff --git a/apache-rat-core/src/test/resources/org/apache/rat/MatcherContainerResource.txt b/apache-rat-core/src/test/resources/org/apache/rat/MatcherContainerResource.txt
new file mode 100644
index 000000000..008412298
--- /dev/null
+++ b/apache-rat-core/src/test/resources/org/apache/rat/MatcherContainerResource.txt
@@ -0,0 +1,2 @@
+The text to match
+more text to match
\ No newline at end of file
diff --git a/apache-rat-plugin/pom.xml b/apache-rat-plugin/pom.xml
index 9dda6d3c1..26b1ad31d 100644
--- a/apache-rat-plugin/pom.xml
+++ b/apache-rat-plugin/pom.xml
@@ -87,13 +87,8 @@
src/it/**/src.apt
- src/test/resources/unit/it2/src.txt
- src/test/resources/unit/it3/src.apt
- src/test/resources/unit/it4/*.html
- src/test/resources/unit/RAT-335-GitIgnore/*
- src/test/resources/unit/RAT-335-GitIgnore/**/*
+ src/test/resources/unit/**
**/*.iml
- src/test/resources/unit/RAT-343/*
src/it/CustomLicense/src/**/
diff --git a/apache-rat-plugin/src/it/it1/verify.groovy b/apache-rat-plugin/src/it/it1/verify.groovy
index cdf9899c7..f4aef443e 100644
--- a/apache-rat-plugin/src/it/it1/verify.groovy
+++ b/apache-rat-plugin/src/it/it1/verify.groovy
@@ -20,4 +20,6 @@ assert f.exists()
content = f.text
-assert content.contains( 'YAL src.apt' )
\ No newline at end of file
+assert content.contains( ' G src.apt' )
+assert content.contains( ' YAL MyLicense Yet another license' )
+assert content.contains( ' GEN Not Not ');
diff --git a/apache-rat-plugin/src/it/it4_RAT-168/pom.xml b/apache-rat-plugin/src/it/it4_RAT-168/pom.xml
index 471eeb3a4..c570d26ac 100644
--- a/apache-rat-plugin/src/it/it4_RAT-168/pom.xml
+++ b/apache-rat-plugin/src/it/it4_RAT-168/pom.xml
@@ -33,5 +33,15 @@
+
+
+
+
+ org.apache.maven.plugins
+ maven-clean-plugin
+ 3.3.2
+
+
+