Include licence and notice files in shipped jars #20058

dreis2211 · 2020-02-07T11:41:36Z

Hi,

this PR includes the LICENSE.txt file in the META-INF directory when a jar is built. This should fix #15643 .

Let me know what you think.
Cheers,
Christoph

Closes spring-projectsgh-15643

snicoll

Thanks for the PR.

I wonder if we should also include a notice.txt. And maybe add a test for this?

snicoll · 2020-02-10T15:10:18Z

buildSrc/src/main/java/org/springframework/boot/build/ConventionsPlugin.java

@@ -127,6 +127,7 @@ private void applyJavaConventions(Project project) {
 			});
 			project.getTasks().withType(Jar.class, (jar) -> {
 				project.afterEvaluate((evaluated) -> {
+					jar.metaInf((metaInf) -> metaInf.from(project.getRootProject().file("LICENSE.txt")));


I am not sure if we want to ship our license or something a bit more complete as the one Spring Framework use.

Let me know if I can help with something. Seems to be outside of my control at the moment, though!?

I don't think the Framework one matches our needs as it includes information about CGLib and ASM which Framework jarjars. The file in the root of our repo looks like a better fit to me for most of our modules at least. We may need to do something different for spring-boot-configuration-processor as it shades some JSON stuff.

I don't think the Framework one matches our needs as it includes information about CGLib and ASM which Framework jarjars.

I didn't literally mean that file but more something with more details than just our license. I was actually referring to the bottom of the file. Not feeling strongly about it though.

dreis2211 · 2020-02-10T18:37:43Z

I've added a test, @snicoll . Deciding what LICENSE.txt and/or if a notice.txt should be added, seems to be outside of my hands at the moment, but I'm happy to add anything after you made a decision.

snicoll · 2020-02-11T07:53:51Z

Thanks Christoph. I've added this one for team attention so that we figure it out during our next meeting.

wilkinsona · 2020-02-12T16:33:07Z

We discussed this today and concluded that:

We should include a LICENSE.txt file in the deployed jars with the same contents as the file in the root of the repo
Rather than using the file in the root of the repo, we'd like to use a file in src/main/resources of the buildSrc plugins.
We should include a NOTICE.txt file in the deployed jars. The file should have the following contents:

Spring Boot ${version}
Copyright (c) 2012-${currentYear} Pivotal, Inc.

This product is licensed to you under the Apache License, Version 2.0
(the "License"). You may not use this product except in compliance with
the License.

@dreis2211 If the offer still stands, would you like to update this PR to reflect the above?

dreis2211 · 2020-02-12T16:34:34Z

Sure, @wilkinsona . Give me a minute or two.

dreis2211 · 2020-02-12T17:31:54Z

Okay it was an hour, but it should be done now. Let me know if this is what you had in mind.

BTW: I have a bit of trouble to run the tests in buildSrc from IDEA which makes it quite a bit harder to debug them. Is there any trick to it?

wilkinsona · 2020-02-18T14:05:50Z

BTW: I have a bit of trouble to run the tests in buildSrc from IDEA which makes it quite a bit harder to debug them. Is there any trick to it?

Sorry, I'm not sure how IDEA handle's buildSrc. In Eclipse, I've just imported it alongside all the other modules and can then run its tests as usual.

snicoll · 2020-02-18T14:09:21Z

No problem here either but I am on 2020.1 EAP. As long as you delegate to Gradle, it should just work(tm).

wilkinsona

Thanks very much, @dreis2211. This is pretty much exactly what I had in mind. I've left one comment/suggestion about how the LICENSE.txt and NOTICE.txt text resources are dealt with.

wilkinsona · 2020-02-18T14:09:10Z

buildSrc/src/main/java/org/springframework/boot/build/ConventionsPlugin.java

+			String noticeContent = FileCopyUtils.copyToString(new InputStreamReader(notice, StandardCharsets.UTF_8))
+					.replace("${version}", project.getVersion().toString())
+					.replace("${currentYear}", Integer.toString(Year.now().getValue()));
+			metaInf.from(project.getResources().getText().fromString(noticeContent),


I think this'll break up-to-date checking for the jar. Creating a text resource from a string results in the creation of a temporary file with a random name. As that random name varies from build-to-build, the jar tasks will never be considered up-to-date as it'll look like its inputs have changed.

We had this problem when adding the classpath index support to BootJar. The solution was to get the text resource's file and rename it before adding it to the copy spec rather than as part of the spec.

I will take a look how it was done there and report back

Thanks. I should have linked to the relevant code earlier. It is the following:

spring-boot/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/BootJar.java

Lines 113 to 119 in 16111f1

private File createClasspathIndex(List<String> dependencies) {

String content = dependencies.stream().collect(Collectors.joining("\n", "", "\n"));

File source = getProject().getResources().getText().fromString(content).asFile();

File indexFile = new File(source.getParentFile(), "classpath.idx");

source.renameTo(indexFile);

return indexFile;

}

This will result in a NOTICE.txt and LICENSE.txt file beneath each project's build directory. An alternative could be to access the files in buildSrc/src/main/resources directly from the filesystem.

I tried that and that didn't work. Will take a look again.

After the latest changes I get the following:

./gradlew :spring-boot-project:spring-boot-properties-migrator:jar BUILD SUCCESSFUL in 1s 9 actionable tasks: 9 up-to-date

Previously, I got the following:

./gradlew :spring-boot-project:spring-boot-properties-migrator:jar BUILD SUCCESSFUL in 1s 9 actionable tasks: 2 executed, 7 up-to-date

Thanks for the good catch, @wilkinsona

wilkinsona · 2020-02-18T17:16:29Z

It's just occurred to me that the suggestion to use ${currentYear} was a bad one as it'll break the repeatability of the build. We should probably just hardcode it and update as needed. We can make that amendment as part of merging.

See gh-20058

wilkinsona · 2020-02-19T10:12:27Z

Thanks very much, @dreis2211.

dreis2211 · 2020-02-19T10:16:39Z

Thanks for the proper review, @wilkinsona

Include licence files in shipped jars

ea790d5

Closes spring-projectsgh-15643

spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Feb 7, 2020

snicoll reviewed Feb 10, 2020

View reviewed changes

snicoll added the for: team-attention An issue we'd like other members of the team to review label Feb 10, 2020

Add test for adding license file to jar

22c2034

wilkinsona self-assigned this Feb 12, 2020

wilkinsona removed the for: team-attention An issue we'd like other members of the team to review label Feb 12, 2020

Include NOTICE and LICENSE file from buildSrc resources

6e199fd

wilkinsona requested changes Feb 18, 2020

View reviewed changes

Prevent legal files from changing up-to-date status

1151f5e

wilkinsona added type: task A general task and removed status: waiting-for-triage An issue we've not yet triaged labels Feb 18, 2020

wilkinsona added this to the 2.3.x milestone Feb 18, 2020

wilkinsona mentioned this pull request Feb 18, 2020

Include licence files in shipped jars #15643

Closed

wilkinsona added the for: merge-with-amendments Needs some changes when we merge label Feb 18, 2020

wilkinsona changed the title ~~Include licence files in shipped jars~~ Include licence and notice files in shipped jars Feb 19, 2020

wilkinsona approved these changes Feb 19, 2020

View reviewed changes

wilkinsona modified the milestones: 2.3.x, 2.3.0.M3 Feb 19, 2020

wilkinsona pushed a commit that referenced this pull request Feb 19, 2020

Include LICENCE and NOTICE files in shipped jars

e34cf89

See gh-20058

wilkinsona added a commit that referenced this pull request Feb 19, 2020

Polish "Include LICENCE and NOTICE files in shipped jars"

8128f30

See gh-20058

wilkinsona closed this in d733665 Feb 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Include licence and notice files in shipped jars #20058

Include licence and notice files in shipped jars #20058

dreis2211 commented Feb 7, 2020

snicoll left a comment

snicoll Feb 10, 2020

dreis2211 Feb 10, 2020

wilkinsona Feb 12, 2020 •

edited

snicoll Feb 12, 2020

dreis2211 commented Feb 10, 2020 •

edited

snicoll commented Feb 11, 2020

wilkinsona commented Feb 12, 2020

dreis2211 commented Feb 12, 2020

dreis2211 commented Feb 12, 2020

wilkinsona commented Feb 18, 2020

snicoll commented Feb 18, 2020

wilkinsona left a comment

wilkinsona Feb 18, 2020

dreis2211 Feb 18, 2020

wilkinsona Feb 18, 2020

dreis2211 Feb 18, 2020

dreis2211 Feb 18, 2020

wilkinsona commented Feb 18, 2020

wilkinsona commented Feb 19, 2020

dreis2211 commented Feb 19, 2020

	private File createClasspathIndex(List<String> dependencies) {
	String content = dependencies.stream().collect(Collectors.joining("\n", "", "\n"));
	File source = getProject().getResources().getText().fromString(content).asFile();
	File indexFile = new File(source.getParentFile(), "classpath.idx");
	source.renameTo(indexFile);
	return indexFile;
	}

Include licence and notice files in shipped jars #20058

Include licence and notice files in shipped jars #20058

Conversation

dreis2211 commented Feb 7, 2020

snicoll left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wilkinsona Feb 12, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dreis2211 commented Feb 10, 2020 • edited

snicoll commented Feb 11, 2020

wilkinsona commented Feb 12, 2020

dreis2211 commented Feb 12, 2020

dreis2211 commented Feb 12, 2020

wilkinsona commented Feb 18, 2020

snicoll commented Feb 18, 2020

wilkinsona left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wilkinsona commented Feb 18, 2020

wilkinsona commented Feb 19, 2020

dreis2211 commented Feb 19, 2020

wilkinsona Feb 12, 2020 •

edited

dreis2211 commented Feb 10, 2020 •

edited