Skip to content

Overhaul Apache RAT #4569

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.

Sign up for GitHub

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

Merged
dsmiley merged 8 commits into from
Jul 7, 2026
Merged

Overhaul Apache RAT #4569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
05d7cb5
Redo Apache RAT.
dsmiley Jun 29, 2026
7f40e42
Exclude .gradle
dsmiley Jul 3, 2026
3e4e614
Merge branch 'main' into rat-overhaul
dsmiley Jul 4, 2026
c0840cc
smokeTestRelease.py: Remove --test-alt-java support
dsmiley Jul 4, 2026
1806d65
changelog
dsmiley Jul 4, 2026
65bfdb9
Merge branch 'smokeTestRelease_removeAltJava' into rat-overhaul
dsmiley Jul 4, 2026
3e365d0
smokeTestRelease.py: run rat.
dsmiley Jul 4, 2026
aedf8db
Merge branch 'main' into rat-overhaul
dsmiley Jul 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions changelog/unreleased/PR#4608-smokeTestRelease_removeAltJava.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: >
smokeTestRelease.py: Remove --test-alt-java support
type: other
authors:
- name: David Smiley
links:
- name: PR#4608
url: https://github.com/apache/solr/pull/4608
19 changes: 13 additions & 6 deletions dev-tools/scripts/smokeTestRelease.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -640,16 +640,23 @@ def verifySrcUnpacked(java, artifact, unpackPath, version, testArgs):
print(' %s' % line.strip())
raise RuntimeError('source release has WARs...')

validateCmd = './gradlew --no-daemon check -p solr/documentation'
logDir = '%s/build' % unpackPath
os.makedirs(logDir, exist_ok=True)

validateCmd = './gradlew rat'
print(' run "%s"' % validateCmd)
java.run_java(validateCmd, '%s/rat.log' % logDir)

Comment on lines +646 to +649

@dsmiley dsmiley Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

run "rat". It was surprising we weren't already running this tool in the smoketester given it's role.

validateCmd = './gradlew :solr:documentation:check'
print(' run "%s"' % validateCmd)
java.run_java(validateCmd, '%s/validate.log' % unpackPath)
java.run_java(validateCmd, '%s/documentation.log' % logDir)

print(" run tests w/ Java %s and testArgs='%s'..." % (java.version, testArgs))
java.run_java('./gradlew --no-daemon test %s' % testArgs, '%s/test.log' % unpackPath)
java.run_java('./gradlew test %s' % testArgs, '%s/test.log' % logDir)
print(" run integration tests w/ Java %s" % java.version)
java.run_java('./gradlew --no-daemon integrationTest -Dversion.release=%s' % version, '%s/itest.log' % unpackPath)
java.run_java('./gradlew integrationTest -Dversion.release=%s' % version, '%s/itest.log' % logDir)
print(" build binary release w/ Java %s" % java.version)
java.run_java('./gradlew --no-daemon dev -Dversion.release=%s' % version, '%s/assemble.log' % unpackPath)
java.run_java('./gradlew dev -Dversion.release=%s' % version, '%s/assemble.log' % logDir)
testSolrExample("%s/solr/packaging/build/dev" % unpackPath, java.java_home, False)

testChangelogMd('.', version)
Expand Down Expand Up @@ -981,7 +988,7 @@ def make_java_config(parser):
parser.error('JAVA_HOME must be set')
if cygwin:
java_home = subprocess.check_output('cygpath -u "%s"' % java_home, shell=True).decode('utf-8').strip()
cmd_prefix = 'export JAVA_HOME="%s" PATH="%s/bin:$PATH" JAVACMD="%s/bin/java"' % \
cmd_prefix = 'export JAVA_HOME="%s" PATH="%s/bin:$PATH" JAVACMD="%s/bin/java" GRADLE_OPTS="-Dorg.gradle.daemon=false"' % \

@dsmiley dsmiley Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I set the gradle daemon setting here to remove the repetitiveness above

(java_home, java_home, java_home)
s = subprocess.check_output('%s; java -version' % cmd_prefix,
shell=True, stderr=subprocess.STDOUT).decode('utf-8')
Expand Down
31 changes: 22 additions & 9 deletions gradle.lockfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,29 @@
# Manual edits can break the build and are not advised.
# This file is expected to be part of source control.
# To regenerate this file, run: ./gradlew :dependencies --write-locks
commons-cli:commons-cli:1.5.0=ratDeps
commons-io:commons-io:2.11.0=ratDeps
com.github.albfernandez:juniversalchardet:2.5.0=ratDeps
com.github.cliftonlabs:json-simple:3.0.2=ratDeps
commons-beanutils:commons-beanutils:1.9.4=ratDeps
commons-codec:commons-codec:1.19.0=ratDeps
commons-collections:commons-collections:3.2.2=ratDeps
commons-io:commons-io:2.21.0=ratDeps
junit:junit:3.8.1=javacc
net.java.dev.javacc:javacc:7.0.13=javacc
org.apache.commons:commons-collections4:4.4=ratDeps
org.apache.commons:commons-compress:1.21=ratDeps
org.apache.commons:commons-lang3:3.12.0=ratDeps
org.apache.rat:apache-rat-api:0.15=ratDeps
org.apache.rat:apache-rat-core:0.15=ratDeps
org.apache.rat:apache-rat-tasks:0.15=ratDeps
org.apache.rat:apache-rat:0.15=ratDeps
org.apache.commons:commons-collections4:4.5.0=ratDeps
org.apache.commons:commons-compress:1.28.0=ratDeps
org.apache.commons:commons-csv:1.14.1=ratDeps
org.apache.commons:commons-digester3:3.2=ratDeps
org.apache.commons:commons-lang3:3.20.0=ratDeps
org.apache.commons:commons-text:1.15.0=ratDeps
org.apache.rat:apache-rat-core:0.18=ratDeps
org.apache.rat:apache-rat-tasks:0.18=ratDeps
org.apache.rat:apache-rat-tools:0.18=ratDeps
org.apache.rat:apache-rat:0.18=ratDeps
org.apache.tika:tika-core:3.2.3=ratDeps
org.apache.tika:tika-parser-text-module:3.2.3=ratDeps
org.apache.velocity.tools:velocity-tools-generic:3.1=ratDeps
org.apache.velocity:velocity-engine-core:2.4.1=ratDeps
org.eclipse.jdt:ecj:3.46.0=ecjDeps
org.slf4j:slf4j-api:2.0.17=ratDeps
org.slf4j:slf4j-simple:2.0.17=ratDeps
empty=
3 changes: 2 additions & 1 deletion gradle/libs.versions.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ apache-kafka = "3.9.2"
apache-log4j = "2.26.0"
apache-lucene = "10.4.0"
apache-opennlp = "2.5.10"
apache-rat = "0.15"
apache-rat = "0.18"
apache-tika = "3.3.1"
apache-tomcat = "6.0.53"
apache-zookeeper = "3.9.5"
Expand Down Expand Up @@ -509,6 +509,7 @@ semver4j-semver4j = { module = "org.semver4j:semver4j", version.ref = "semver4j"
slf4j-api = { module = "org.slf4j:slf4j-api", version.ref = "slf4j" }
slf4j-jcloverslf4j = { module = "org.slf4j:jcl-over-slf4j", version.ref = "slf4j" }
slf4j-jultoslf4j = { module = "org.slf4j:jul-to-slf4j", version.ref = "slf4j" }
slf4j-simple = { module = "org.slf4j:slf4j-simple", version.ref = "slf4j" }
spotbugs-annotations = { module = "com.github.spotbugs:spotbugs-annotations", version.ref = "spotbugs" }
squareup-okhttp3-mockwebserver = { module = "com.squareup.okhttp3:mockwebserver" }
squareup-okhttp3-okhttp = { module = "com.squareup.okhttp3:okhttp", version.ref = "squareup-okhttp3-okhttp" }
Expand Down
63 changes: 63 additions & 0 deletions gradle/validation/rat-config.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
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.
-->

<!--
Custom RAT license families supplementing the built-in defaults.
-->
<rat-config>
<families>
<family id="MIT" name="The MIT License"/>
<family id="BSD4" name="Original BSD License (with advertising clause)"/>
<family id="BSD-modi" name="Modified BSD License"/>
<family id="GEN" name="Generated"/>
</families>

<licenses>
<!-- BSD 4-clause: presence of advertising clause is a policy violation -->
<license family="BSD4" id="BSD4" name="BSD 4-Clause (advertising clause)">
<text>All advertising materials</text>
</license>

<!-- Various BSD-like third-party libraries with non-standard copyright headers -->
<license family="BSD-modi" id="BSD-modi" name="Modified BSD License">
<any>
<text>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</text> <!-- d3.js -->
<text>THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS</text> <!-- highlight.js -->
</any>
</license>

<!-- Inline MIT comment used by ui-grid bundled assets -->
<license family="MIT" id="MIT-uigrid" name="MIT (ui-grid)">
<text> ; License: MIT</text>
</license>

<!-- Machine-generated source files that carry no license header -->
<license family="GEN" id="GEN" name="Generated">
<any>
<!-- none so far -->

@janhoy janhoy Jul 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why include it if there are no rules?

@dsmiley dsmiley Jul 3, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There used to be some but all were old or part of Lucene. I thought it best to leave this here ready to easily add one if needed; it's minor. Of course, we actually do have generated source but I haven't looked at why we don't need this. For some I known we exclude categorically because it's not committed. For committed like a query parser or two, I think it's intermixed with human authored stuff so it gets a license. I think.

</any>
</license>
</licenses>

<approved>
<family license_ref="BSD-modi"/>
<family license_ref="GEN"/>
<!-- MIT is already approved by the default config; MIT-uigrid inherits that. -->
<!-- BSD4 is intentionally absent: matching files are policy violations. -->
</approved>
</rat-config>
Loading
Loading