-
Notifications
You must be signed in to change notification settings - Fork 2.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add RAT check using Gradle #1157
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,6 +22,7 @@ configure(rootProject) { | |
"forbiddenApisTest", | ||
"licenses", | ||
"javadoc", | ||
"rat", | ||
]} | ||
} | ||
} | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,266 @@ | ||
/* | ||
* 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. | ||
*/ | ||
|
||
import groovy.xml.NamespaceBuilder | ||
|
||
configure(rootProject) { | ||
configurations { | ||
rat | ||
} | ||
|
||
dependencies { | ||
rat "org.apache.rat:apache-rat" | ||
} | ||
} | ||
|
||
allprojects { | ||
task("rat", type: RatTask) { | ||
group = 'Verification' | ||
description = 'Runs Apache Rat checks.' | ||
} | ||
|
||
if (project == rootProject) { | ||
rat { | ||
includes += [ | ||
"buildSrc/**/*.java", | ||
"lucene/tools/forbiddenApis/**", | ||
"lucene/tools/prettify/**", | ||
// "dev-tools/**" | ||
] | ||
excludes += [ | ||
// Unclear if this needs ASF header, depends on how much was copied from ElasticSearch | ||
"**/ErrorReportingTestListener.java" | ||
] | ||
} | ||
} | ||
|
||
if (project.path == ":lucene:analysis:common") { | ||
rat { | ||
srcExcludes += [ | ||
"**/*.aff", | ||
"**/*.dic", | ||
"**/charfilter/*.htm*", | ||
"**/*LuceneResourcesWikiPage.html" | ||
] | ||
} | ||
} | ||
|
||
if (project.path == ":lucene:analysis:kuromoji") { | ||
rat { | ||
srcExcludes += [ | ||
// whether rat detects this as binary or not is platform dependent?! | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is one of the reasons I'd rather have our own check - we don't have to rely on a black box (or look inside rat's code to figure out what it does). |
||
"**/bocchan.utf-8" | ||
] | ||
} | ||
} | ||
|
||
if (project.path == ":lucene:analysis:opennlp") { | ||
rat { | ||
excludes += [ | ||
"src/tools/test-model-data/*.txt", | ||
] | ||
} | ||
} | ||
|
||
if (project.path == ":lucene:highlighter") { | ||
rat { | ||
srcExcludes += [ | ||
"**/CambridgeMA.utf8" | ||
] | ||
} | ||
} | ||
|
||
if (project.path == ":lucene:suggest") { | ||
rat { | ||
srcExcludes += [ | ||
"**/Top50KWiki.utf8", | ||
"**/stop-snowball.txt" | ||
] | ||
} | ||
} | ||
|
||
if (project.path == ":lucene:tools") { | ||
rat { | ||
includes += [ | ||
"forbiddenApis/**", | ||
"prettify/**", | ||
// If/when :lucene:tools becomes a gradle project, then the following line will fail | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think there will be lucene:tools anymore once we depart from ant - I don't think there is any relevant code in there that should stay. |
||
// It is safe to remove it, but also remove the check for lucene/tools in rootProject above | ||
"javadoc/ecj.javadocs.prefs" | ||
] | ||
} | ||
} | ||
|
||
|
||
if (project.path == ":solr:core") { | ||
rat { | ||
srcExcludes += [ | ||
"**/htmlStripReaderTest.html" | ||
] | ||
} | ||
} | ||
|
||
if (project.path == ":solr:webapp") { | ||
rat { | ||
includes = [ "**" ] | ||
excludes += [ | ||
"web/img/**", | ||
"*.iml", | ||
"build.gradle", | ||
"build/**", | ||
] | ||
} | ||
} | ||
} | ||
|
||
// Structure inspired by existing task from Apache Kafka, heavily modified since then. | ||
class RatTask extends DefaultTask { | ||
@Input | ||
List<String> includes = [ | ||
"*.xml", | ||
"src/tools/**" | ||
] | ||
|
||
@Input | ||
List<String> excludes = [] | ||
|
||
@Input | ||
List<String> srcExcludes = [ | ||
"**/TODO", | ||
"**/*.txt", | ||
"**/*.iml", | ||
"**/*.gradle", | ||
"build/**" | ||
] | ||
|
||
@OutputFile | ||
def xmlReport = new File(new File(project.buildDir, 'rat'), 'rat-report.xml') | ||
|
||
def generateXmlReport() { | ||
def uri = 'antlib:org.apache.rat.anttasks' | ||
def ratClasspath = project.rootProject.configurations.rat.asPath | ||
ant.taskdef(resource: 'org/apache/rat/anttasks/antlib.xml', uri: uri, classpath: ratClasspath) | ||
|
||
def rat = NamespaceBuilder.newInstance(ant, uri) | ||
rat.report(format: 'xml', reportFile: xmlReport, addDefaultLicenseMatchers: true) { | ||
ant.fileset(dir: "${project.projectDir}") { | ||
includes.each { pattern -> ant.include(name: pattern) } | ||
excludes.each { pattern -> ant.exclude(name: pattern) } | ||
} | ||
|
||
if (project.plugins.findPlugin(JavaPlugin)) { | ||
[ | ||
project.sourceSets.main.java.srcDirs, | ||
project.sourceSets.test.java.srcDirs, | ||
].flatten().each { srcLocation -> | ||
ant.fileset(dir: srcLocation, erroronmissingdir: false) { | ||
srcExcludes.each { pattern -> ant.exclude(name: pattern) } | ||
} | ||
} | ||
|
||
[ | ||
project.sourceSets.main.resources.srcDirs | ||
].flatten().each { srcLocation -> | ||
ant.fileset(dir: srcLocation, erroronmissingdir: false) { | ||
ant.include(name: "META-INF/**") | ||
} | ||
} | ||
} | ||
|
||
// The license rules below were manually copied from lucene/common-build.xml, there is currently no mechanism to sync them | ||
|
||
// BSD 4-clause stuff (is disallowed below) | ||
substringMatcher(licenseFamilyCategory: "BSD4 ", licenseFamilyName: "Original BSD License (with advertising clause)") { | ||
pattern(substring: "All advertising materials") | ||
} | ||
|
||
// BSD-like stuff | ||
substringMatcher(licenseFamilyCategory: "BSD ", licenseFamilyName: "Modified BSD License") { | ||
// brics automaton | ||
pattern(substring: "Copyright (c) 2001-2009 Anders Moeller") | ||
// snowball | ||
pattern(substring: "Copyright (c) 2001, Dr Martin Porter") | ||
// UMASS kstem | ||
pattern(substring: "THIS SOFTWARE IS PROVIDED BY UNIVERSITY OF MASSACHUSETTS AND OTHER CONTRIBUTORS") | ||
// Egothor | ||
pattern(substring: "Egothor Software License version 1.00") | ||
// JaSpell | ||
pattern(substring: "Copyright (c) 2005 Bruno Martins") | ||
// d3.js | ||
pattern(substring: "THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS") | ||
// highlight.js | ||
pattern(substring: "THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS") | ||
} | ||
|
||
// MIT-like | ||
substringMatcher(licenseFamilyCategory: "MIT ", licenseFamilyName:"Modified BSD License") { | ||
// ICU license | ||
pattern(substring: "Permission is hereby granted, free of charge, to any person obtaining a copy") | ||
} | ||
|
||
// Apache | ||
substringMatcher(licenseFamilyCategory: "AL ", licenseFamilyName: "Apache") { | ||
pattern(substring: "Licensed to the Apache Software Foundation (ASF) under") | ||
// this is the old - school one under some files | ||
pattern(substring: 'Licensed under the Apache License, Version 2.0 (the "License")') | ||
} | ||
|
||
substringMatcher(licenseFamilyCategory: "GEN ", licenseFamilyName: "Generated") { | ||
// svg files generated by gnuplot | ||
pattern(substring: "Produced by GNUPLOT") | ||
// snowball stemmers generated by snowball compiler | ||
pattern(substring: "This file was generated automatically by the Snowball to Java compiler") | ||
// parsers generated by antlr | ||
pattern(substring: "ANTLR GENERATED CODE") | ||
} | ||
|
||
approvedLicense(familyName: "Apache") | ||
approvedLicense(familyName: "The MIT License") | ||
approvedLicense(familyName: "Modified BSD License") | ||
approvedLicense(familyName: "Generated") | ||
} | ||
} | ||
|
||
def printUnknownFiles() { | ||
def ratXml = new XmlParser().parse(xmlReport) | ||
def errors = [] | ||
ratXml.resource.each { resource -> | ||
if (resource.'license-approval'.@name[0] == "false") { | ||
errors << "Unknown license: ${resource.@name}" | ||
} | ||
} | ||
if (errors) { | ||
throw new GradleException("Found " + errors.size() + " file(s) with errors:\n" + | ||
errors.collect{ msg -> " - ${msg}" }.join("\n")) | ||
} | ||
} | ||
|
||
@TaskAction | ||
def rat() { | ||
def origEncoding = System.getProperty("file.encoding") | ||
madrob marked this conversation as resolved.
Show resolved
Hide resolved
|
||
try { | ||
generateXmlReport() | ||
printUnknownFiles() | ||
} finally { | ||
if (System.getProperty("file.encoding") != origEncoding) { | ||
throw new GradleException("Insane: rat changed file.encoding to ${System.getProperty('file.encoding')}?") | ||
} | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -72,6 +72,7 @@ org.apache.opennlp:opennlp-tools=1.9.1 | |
org.apache.pdfbox:*=2.0.17 | ||
org.apache.pdfbox:jempbox=1.8.16 | ||
org.apache.poi:*=4.1.1 | ||
org.apache.rat:apache-rat:0.11 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Did you run gradlew precommit? :) Because I think the lock update file isn't included in the patch. |
||
org.apache.tika:*=1.23 | ||
org.apache.velocity.tools:*=3.0 | ||
org.apache.xmlbeans:xmlbeans=3.1.0 | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The idea was but I changed a whole bunch of stuff along the way. There are similarities and the attribution is there but I think we can consider it our own.