From 534b94e5ec5ea0595681782453420fa4a84d6787 Mon Sep 17 00:00:00 2001 From: Vincent Latombe Date: Mon, 16 Dec 2019 17:43:41 +0100 Subject: [PATCH] Fixes issue #312: Don't overwrite existing license file When using organizeLicensesByDependencies=true, if you have several dependencies with the same license, and the same dependency appears in the dependency tree with different versions/types, then the cached file will be copied several times over to the destination, which can already exist. --- src/it/ISSUE-312/child1/pom.xml | 32 +++ src/it/ISSUE-312/child2/pom.xml | 32 +++ src/it/ISSUE-312/child3/pom.xml | 56 +++++ .../child3/src/licenses/local/apache20.txt | 202 ++++++++++++++++++ src/it/ISSUE-312/invoker.properties | 1 + src/it/ISSUE-312/pom.xml | 27 +++ src/it/ISSUE-312/postbuild.groovy | 31 +++ .../license/AbstractDownloadLicensesMojo.java | 11 +- 8 files changed, 388 insertions(+), 4 deletions(-) create mode 100644 src/it/ISSUE-312/child1/pom.xml create mode 100644 src/it/ISSUE-312/child2/pom.xml create mode 100644 src/it/ISSUE-312/child3/pom.xml create mode 100644 src/it/ISSUE-312/child3/src/licenses/local/apache20.txt create mode 100644 src/it/ISSUE-312/invoker.properties create mode 100644 src/it/ISSUE-312/pom.xml create mode 100644 src/it/ISSUE-312/postbuild.groovy diff --git a/src/it/ISSUE-312/child1/pom.xml b/src/it/ISSUE-312/child1/pom.xml new file mode 100644 index 000000000..963d1e2ab --- /dev/null +++ b/src/it/ISSUE-312/child1/pom.xml @@ -0,0 +1,32 @@ + + + 4.0.0 + + org.codehaus.mojo.license.test.ISSUE-312 + parent + 1.0 + + + child1 + + + commons-logging + commons-logging + 1.2 + + + org.apache.commons + commons-lang3 + 3.8 + test-jar + + + + + Apache License 1.0 + https://www.apache.org/licenses/LICENSE-1.0 + + + + diff --git a/src/it/ISSUE-312/child2/pom.xml b/src/it/ISSUE-312/child2/pom.xml new file mode 100644 index 000000000..36adf45f3 --- /dev/null +++ b/src/it/ISSUE-312/child2/pom.xml @@ -0,0 +1,32 @@ + + + 4.0.0 + + org.codehaus.mojo.license.test.ISSUE-312 + parent + 1.0 + + + child2 + + + commons-logging + commons-logging + 1.1.3 + test-jar + + + org.apache.commons + commons-lang3 + 3.9 + + + + + + Apache License 2.0 + https://www.apache.org/licenses/LICENSE-2.0.txt + + + diff --git a/src/it/ISSUE-312/child3/pom.xml b/src/it/ISSUE-312/child3/pom.xml new file mode 100644 index 000000000..b64462c5b --- /dev/null +++ b/src/it/ISSUE-312/child3/pom.xml @@ -0,0 +1,56 @@ + + + 4.0.0 + + org.codehaus.mojo.license.test.ISSUE-312 + parent + 1.0 + + child3 + + + ${project.groupId} + child1 + ${project.version} + + + ${project.groupId} + child1 + ${project.version} + pom + + + ${project.groupId} + child2 + ${project.version} + + + + + + org.codehaus.mojo + license-maven-plugin + + + + download-licenses + + generate-resources + + true + xmlOutput + + + + https?://www.apache.org/licenses/LICENSE-2.0.txt + file://${project.basedir}/src/licenses/local/apache20.txt + + + + + + + + + diff --git a/src/it/ISSUE-312/child3/src/licenses/local/apache20.txt b/src/it/ISSUE-312/child3/src/licenses/local/apache20.txt new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/src/it/ISSUE-312/child3/src/licenses/local/apache20.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/src/it/ISSUE-312/invoker.properties b/src/it/ISSUE-312/invoker.properties new file mode 100644 index 000000000..9ffe81614 --- /dev/null +++ b/src/it/ISSUE-312/invoker.properties @@ -0,0 +1 @@ +invoker.goals=clean package -X diff --git a/src/it/ISSUE-312/pom.xml b/src/it/ISSUE-312/pom.xml new file mode 100644 index 000000000..cfa491981 --- /dev/null +++ b/src/it/ISSUE-312/pom.xml @@ -0,0 +1,27 @@ + + + 4.0.0 + org.codehaus.mojo.license.test.ISSUE-312 + parent + 1.0 + Test ISSUE-312 + pom + + child1 + child2 + child3 + + + + + + org.codehaus.mojo + license-maven-plugin + @project.version@ + + + + + diff --git a/src/it/ISSUE-312/postbuild.groovy b/src/it/ISSUE-312/postbuild.groovy new file mode 100644 index 000000000..11bda6143 --- /dev/null +++ b/src/it/ISSUE-312/postbuild.groovy @@ -0,0 +1,31 @@ +/* + * #%L + * License Maven Plugin + * %% + * Copyright (C) 2008 - 2011 CodeLutin, Codehaus, Tony Chemit, Tony chemit + * %% + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Lesser Public License for more details. + * + * You should have received a copy of the GNU General Lesser Public + * License along with this program. If not, see + * . + * #L% + */ + + +def asl2 = new File(basedir, 'child3/target/generated-resources/licenses/org.apache.commons.commons-lang3_apache_license,_version_2.0.txt') +assert asl2.exists() +assert asl2.text.contains('Version 2.0, January 2004'); + +def licensesXml = new File(basedir, 'child3/target/generated-resources/licenses.xml'); +assert licensesXml.exists() +assert licensesXml.text.contains('org.apache.commons.commons-lang3_apache_license,_version_2.0.txt') +assert licensesXml.text.contains('https://www.apache.org/licenses/LICENSE-2.0.txt') diff --git a/src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java b/src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java index 5939e7306..bb95d771d 100644 --- a/src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java @@ -1106,9 +1106,9 @@ private ProjectLicenseInfo createDependencyProject( LicensedArtifact depMavenPro * license (if available) and the remote filename of the license. * * @param depProject the project containing the license - * @param licenseUrl the license url + * @param url the license url * @param licenseName the license name - * @param string + * @param licenseFileName the file name where to save the license * @return A filename to be used for the downloaded license file * @throws URISyntaxException */ @@ -1127,7 +1127,7 @@ private FileNameEntry getLicenseFileName( ProjectLicenseInfo depProject, final S return new FileNameEntry( new File( licensesOutputDirectory, new File( licenseFileName ).getName() ), false, null ); } - licenseFileName = String.format( "%s.%s%s", depProject.getGroupId(), depProject.getArtifactId(), + licenseFileName = String.format( "%s.%s%s.txt", depProject.getGroupId(), depProject.getArtifactId(), licenseName != null ? "_" + licenseName : "" ).replaceAll( "\\s+", "_" ); @@ -1233,7 +1233,10 @@ else if ( license.getUrl() != null ) final File byDepsFile = fileNameEntry.getFile(); if ( cachedResult.isSuccess() && !cachedFile.equals( byDepsFile ) ) { - Files.copy( cachedFile.toPath(), byDepsFile.toPath() ); + if ( ! byDepsFile.exists() ) + { + Files.copy( cachedFile.toPath(), byDepsFile.toPath() ); + } byDepsResult = cachedResult.withFile( byDepsFile ); } else