Skip to content

Commit 42ca8d3

Browse files
rombirlitomasz-tylenda-sonarsource
rombirli
authored and
tomasz-tylenda-sonarsource
committed
JAVASE-179 License Packaging Standard (#67)
1 parent 6f4c490 commit 42ca8d3

11 files changed

Lines changed: 1871 additions & 3 deletions

‎README.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,16 @@ Requirements: Java 21
3535

3636
To build the plugin and run its unit tests, execute this command from the project's root directory:
3737

38-
mvn clean install
39-
38+
```sh
39+
mvn clean install -DskipLicenseValidation
40+
```
41+
42+
### Update licenses:
43+
When dependencies change, update the committed license files using the `updateLicenses` profile:
44+
```sh
45+
mvn clean package -PupdateLicenses
46+
```
47+
This regenerates licenses in `java-symbolic-execution/java-symbolic-execution-plugin/src/main/resources/licenses/` based on current project dependencies.
4048

4149
#### Ruling Test
4250

‎java-symbolic-execution/java-symbolic-execution-plugin/license-resources/LicenseValidator.java‎

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
/*
2+
* Copyright (C) 2021-2025 SonarSource SA
3+
* All rights reserved
4+
* mailto:info AT sonarsource DOT com
5+
*/
6+
7+
import java.io.IOException;
8+
import java.nio.file.Files;
9+
import java.nio.file.Path;
10+
import java.util.ArrayList;
11+
import java.util.List;
12+
import java.util.Map;
13+
import java.util.stream.Collectors;
14+
import java.util.stream.Stream;
15+
16+
/**
17+
* Validates that generated license files match committed license files.
18+
* Used during Maven verify phase to ensure license files are up-to-date.
19+
*/
20+
public final class LicenseValidator {
21+
22+
private LicenseValidator() {
23+
// Utility class
24+
}
25+
26+
public static void main(String[] args) {
27+
try {
28+
var arguments = parseArguments(args);
29+
var tempLicensesPath = Path.of(arguments.get("temp_licenses"));
30+
var committedLicensesPath = Path.of(arguments.get("committed_licenses"));
31+
32+
validateDirectoriesExist(tempLicensesPath, committedLicensesPath);
33+
34+
var result = compareDirectories(tempLicensesPath, committedLicensesPath);
35+
36+
if (result.hasErrors()) {
37+
printFailureMessage(result);
38+
System.exit(1);
39+
} else {
40+
System.out.println("[SUCCESS] License validation passed - generated files match committed files");
41+
System.exit(0);
42+
}
43+
} catch (IllegalArgumentException e) {
44+
System.err.println("Error: " + e.getMessage());
45+
printUsage();
46+
System.exit(1);
47+
} catch (IOException e) {
48+
System.err.println("Error: " + e.getMessage());
49+
System.exit(1);
50+
}
51+
}
52+
53+
static Map<String, String> parseArguments(String[] args) {
54+
var arguments = new java.util.HashMap<String, String>();
55+
for (var arg : args) {
56+
if (arg.startsWith("--")) {
57+
var parts = arg.substring(2).split("=", 2);
58+
if (parts.length == 2) {
59+
arguments.put(parts[0], parts[1]);
60+
}
61+
}
62+
}
63+
64+
if (!arguments.containsKey("temp_licenses") || !arguments.containsKey("committed_licenses")) {
65+
throw new IllegalArgumentException("Missing required arguments");
66+
}
67+
68+
return arguments;
69+
}
70+
71+
static void validateDirectoriesExist(Path tempLicenses, Path committedLicenses) throws IOException {
72+
if (!Files.exists(tempLicenses)) {
73+
throw new IOException(
74+
"Temporary licenses directory not found: " + tempLicenses + "\n" +
75+
"Please run: mvn clean package -PupdateLicenses"
76+
);
77+
}
78+
if (!Files.exists(committedLicenses)) {
79+
throw new IOException(
80+
"Committed licenses directory not found: " + committedLicenses + "\n" +
81+
"Please run: mvn clean package -PupdateLicenses"
82+
);
83+
}
84+
}
85+
86+
static ValidationResult compareDirectories(Path tempDir, Path committedDir) throws IOException {
87+
var tempFiles = buildFileMap(tempDir);
88+
var committedFiles = buildFileMap(committedDir);
89+
90+
var newFiles = new ArrayList<String>();
91+
var missingFiles = new ArrayList<String>();
92+
var differentFiles = new ArrayList<String>();
93+
94+
// Find new files (in temp but not in committed)
95+
for (var relativePath : tempFiles.keySet()) {
96+
if (!committedFiles.containsKey(relativePath)) {
97+
newFiles.add(relativePath);
98+
}
99+
}
100+
101+
// Find missing files (in committed but not in temp)
102+
for (var relativePath : committedFiles.keySet()) {
103+
if (!tempFiles.containsKey(relativePath)) {
104+
missingFiles.add(relativePath);
105+
}
106+
}
107+
108+
// Find files with different content
109+
for (var relativePath : tempFiles.keySet()) {
110+
if (committedFiles.containsKey(relativePath)) {
111+
var tempFile = tempFiles.get(relativePath);
112+
var committedFile = committedFiles.get(relativePath);
113+
if (Files.mismatch(tempFile, committedFile) != -1L) {
114+
differentFiles.add(relativePath);
115+
}
116+
}
117+
}
118+
119+
newFiles.sort(String::compareTo);
120+
missingFiles.sort(String::compareTo);
121+
differentFiles.sort(String::compareTo);
122+
123+
return new ValidationResult(newFiles, missingFiles, differentFiles);
124+
}
125+
126+
static Map<String, Path> buildFileMap(Path rootDir) throws IOException {
127+
try (Stream<Path> paths = Files.walk(rootDir)) {
128+
return paths
129+
.filter(Files::isRegularFile)
130+
.collect(Collectors.toMap(
131+
path -> rootDir.relativize(path).toString().replace('\\', '/'),
132+
path -> path
133+
));
134+
}
135+
}
136+
137+
static void printFailureMessage(ValidationResult result) {
138+
System.err.println("[FAILURE] License validation failed!");
139+
System.err.println();
140+
141+
if (!result.newFiles().isEmpty()) {
142+
System.err.println("New files in generated licenses (not in committed):");
143+
for (var file : result.newFiles()) {
144+
System.err.println(" + " + file);
145+
}
146+
System.err.println();
147+
}
148+
149+
if (!result.missingFiles().isEmpty()) {
150+
System.err.println("Missing files in generated licenses (present in committed):");
151+
for (var file : result.missingFiles()) {
152+
System.err.println(" - " + file);
153+
}
154+
System.err.println();
155+
}
156+
157+
if (!result.differentFiles().isEmpty()) {
158+
System.err.println("Files with different content:");
159+
for (var file : result.differentFiles()) {
160+
System.err.println(" ~ " + file);
161+
}
162+
System.err.println();
163+
}
164+
165+
System.err.println("To fix this, run: mvn clean package -PupdateLicenses");
166+
}
167+
168+
static void printUsage() {
169+
System.err.println("Usage: LicenseValidator --temp_licenses=<path> --committed_licenses=<path>");
170+
}
171+
172+
record ValidationResult(
173+
List<String> newFiles,
174+
List<String> missingFiles,
175+
List<String> differentFiles
176+
) {
177+
boolean hasErrors() {
178+
return !newFiles.isEmpty() || !missingFiles.isEmpty() || !differentFiles.isEmpty();
179+
}
180+
}
181+
}

‎java-symbolic-execution/java-symbolic-execution-plugin/license-resources/lgpl.txt‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

0 commit comments

Comments
 (0)