This is an automated email from the ASF dual-hosted git repository. kezhenxu94 pushed a commit to branch deps in repository https://gitbox.apache.org/repos/asf/skywalking-eyes.git
commit 2bbe2c875bd19249e994e470b059548aa77a2db9 Author: kezhenxu94 <[email protected]> AuthorDate: Sun Dec 27 11:37:26 2020 +0800 Resolve Apache-2.0, BSD-3-Clause, and MIT licenses --- .licenserc.yaml | 1 + license-eye/README.adoc | 2 +- .../Apache-2.0-ASF.txt | 0 .../Apache-2.0.txt | 0 license-eye/assets/lcs-templates/Apache-2.0.txt | 181 +++++++++++++++++++-- license-eye/assets/lcs-templates/BSD-3-Clause.txt | 27 +++ license-eye/assets/lcs-templates/MIT.txt | 19 +++ license-eye/commands/deps_resolve.go | 3 +- license-eye/go.sum | 1 + license-eye/pkg/deps/golang.go | 11 +- license-eye/pkg/deps/result.go | 2 +- license-eye/pkg/header/config.go | 4 +- license-eye/pkg/license/identifier.go | 35 ++++ license-eye/pkg/license/norm.go | 39 +++++ 14 files changed, 306 insertions(+), 19 deletions(-) diff --git a/.licenserc.yaml b/.licenserc.yaml index 0e5aab6..db09875 100644 --- a/.licenserc.yaml +++ b/.licenserc.yaml @@ -69,6 +69,7 @@ header: # `header` section is configurations for source codes license header. - '**/go.sum' - 'LICENSE' - 'NOTICE' + - '**/assets/header-templates/**' - '**/assets/lcs-templates/**' - '**/assets/languages.yaml' - '**/assets/assets.gen.go' diff --git a/license-eye/README.adoc b/license-eye/README.adoc index d22ade3..9118635 100644 --- a/license-eye/README.adoc +++ b/license-eye/README.adoc @@ -195,7 +195,7 @@ include::assets/styles.yaml[tags=SlashAsterisk] == Contribution - If you find any file type should be supported by the aforementioned configurations but is not listed there, feel free to link:https://github.com/apache/skywalking-eyes/pulls[open a pull request] to add the configuration into the 2 files. -- If you find the license template of an SPDX ID is not supported, feel free to link:https://github.com/apache/skywalking-eyes/pulls[open a pull request] to add it into link:assets/lcs-templates[the template folder]. +- If you find the license template of an SPDX ID is not supported, feel free to link:https://github.com/apache/skywalking-eyes/pulls[open a pull request] to add it into link:assets/header-templates[the template folder]. == License diff --git a/license-eye/assets/lcs-templates/Apache-2.0-ASF.txt b/license-eye/assets/header-templates/Apache-2.0-ASF.txt similarity index 100% rename from license-eye/assets/lcs-templates/Apache-2.0-ASF.txt rename to license-eye/assets/header-templates/Apache-2.0-ASF.txt diff --git a/license-eye/assets/lcs-templates/Apache-2.0.txt b/license-eye/assets/header-templates/Apache-2.0.txt similarity index 100% copy from license-eye/assets/lcs-templates/Apache-2.0.txt copy to license-eye/assets/header-templates/Apache-2.0.txt diff --git a/license-eye/assets/lcs-templates/Apache-2.0.txt b/license-eye/assets/lcs-templates/Apache-2.0.txt index 83cfa23..dd5b3a5 100644 --- a/license-eye/assets/lcs-templates/Apache-2.0.txt +++ b/license-eye/assets/lcs-templates/Apache-2.0.txt @@ -1,13 +1,174 @@ -Copyright [year] [owner] + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ -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 + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -http://www.apache.org/licenses/LICENSE-2.0 + 1. Definitions. -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. + "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. diff --git a/license-eye/assets/lcs-templates/BSD-3-Clause.txt b/license-eye/assets/lcs-templates/BSD-3-Clause.txt new file mode 100644 index 0000000..3d387bc --- /dev/null +++ b/license-eye/assets/lcs-templates/BSD-3-Clause.txt @@ -0,0 +1,27 @@ +Copyright (c) [year] [owner]. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of the copyright holder nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/license-eye/assets/lcs-templates/MIT.txt b/license-eye/assets/lcs-templates/MIT.txt new file mode 100644 index 0000000..a45b07f --- /dev/null +++ b/license-eye/assets/lcs-templates/MIT.txt @@ -0,0 +1,19 @@ +Copyright (c) [year] [owner] + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next paragraph) +shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/license-eye/commands/deps_resolve.go b/license-eye/commands/deps_resolve.go index 96ca6ca..f4d492f 100644 --- a/license-eye/commands/deps_resolve.go +++ b/license-eye/commands/deps_resolve.go @@ -35,8 +35,7 @@ var ResolveCommand = &cobra.Command{ } for _, result := range report.Resolved { - logger.Log.Debugln("Resolved:", result.Dependency) - logger.Log.Debugln("License:", result.LicenseFilePath) + logger.Log.Debugln("Pkg: ", result.Dependency, " License:", result.LicenseSpdxID) } logger.Log.Debugln("Skipped:", len(report.Skipped)) diff --git a/license-eye/go.sum b/license-eye/go.sum index 3143ee6..2da1b0f 100644 --- a/license-eye/go.sum +++ b/license-eye/go.sum @@ -290,6 +290,7 @@ golang.org/x/tools v0.0.0-20191112195655-aa38f8e97acc/go.mod h1:b+2E5dAYhXwXZwtn golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e h1:aZzprAO9/8oim3qStq3wc1Xuxx4QmAGriC4VU4ojemQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20201224043029-2b0845dc783e h1:4nW4NLDYnU28ojHaHO8OVxFHk/aQ33U01a9cjED+pzE= +golang.org/x/tools v0.0.0-20201226215659-b1c90890d22a h1:pdfjQ7VswBeGam3EpuEJ4e8EAb7JgaubV570LO/SIQM= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898 h1:/atklqdjdhuosWIl6AIbOeHJjicWYPqR9bpxqxYG2pA= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/license-eye/pkg/deps/golang.go b/license-eye/pkg/deps/golang.go index cea090f..99f4fe2 100644 --- a/license-eye/pkg/deps/golang.go +++ b/license-eye/pkg/deps/golang.go @@ -24,6 +24,7 @@ import ( "regexp" "github.com/apache/skywalking-eyes/license-eye/internal/logger" + "github.com/apache/skywalking-eyes/license-eye/pkg/license" "golang.org/x/mod/modfile" "golang.org/x/tools/go/packages" ) @@ -79,7 +80,7 @@ func (resolver *GoModeResolver) ResolvePackages(pkgNames []string, report *Repor packages.Visit(requiredPkgs, func(p *packages.Package) bool { err := resolver.ResolvePackageLicense(p, report) if err != nil { - logger.Log.Warnln("Failed to resolve the license of dependency:", p.Name, err) + logger.Log.Warnln("Failed to resolve the license of dependency:", p.PkgPath, err) } return true }, nil) @@ -123,11 +124,15 @@ func (resolver *GoModeResolver) ResolvePackageLicense(p *packages.Package, repor if err != nil { return err } + identifier, err := license.Identify(string(content)) + if err != nil { + return err + } report.Resolve(&Result{ Dependency: p.PkgPath, - LicenseContent: string(content), LicenseFilePath: licenseFilePath, - LicenseSpdxID: "", // TODO: identify the SPDX ID + LicenseContent: string(content), + LicenseSpdxID: []string{identifier}, }) return nil } diff --git a/license-eye/pkg/deps/result.go b/license-eye/pkg/deps/result.go index bfea534..abf8669 100644 --- a/license-eye/pkg/deps/result.go +++ b/license-eye/pkg/deps/result.go @@ -28,7 +28,7 @@ type Result struct { Dependency string LicenseFilePath string LicenseContent string - LicenseSpdxID string + LicenseSpdxID []string } // Report is a collection of resolved Result. diff --git a/license-eye/pkg/header/config.go b/license-eye/pkg/header/config.go index df2d630..219a388 100644 --- a/license-eye/pkg/header/config.go +++ b/license-eye/pkg/header/config.go @@ -137,12 +137,12 @@ func (config *ConfigHeader) GetLicenseContent() string { func readLicenseFromSpdx(config *ConfigHeader) (string, error) { spdxID, owner := config.License.SpdxID, config.License.CopyrightOwner - filename := fmt.Sprintf("assets/lcs-templates/%v.txt", spdxID) + filename := fmt.Sprintf("assets/header-templates/%v.txt", spdxID) if spdxID == "Apache-2.0" && ASFNames.MatchString(owner) { // Note that the Apache Software Foundation uses a different source header that is related to our use of a CLA. // Our instructions for our project's source headers are here (https://www.apache.org/legal/src-headers.html#headers). - filename = "assets/lcs-templates/Apache-2.0-ASF.txt" + filename = "assets/header-templates/Apache-2.0-ASF.txt" } content, err := assets.Asset(filename) diff --git a/license-eye/pkg/license/identifier.go b/license-eye/pkg/license/identifier.go new file mode 100644 index 0000000..9751607 --- /dev/null +++ b/license-eye/pkg/license/identifier.go @@ -0,0 +1,35 @@ +package license + +import ( + "fmt" + "path/filepath" + "strings" + + "github.com/apache/skywalking-eyes/license-eye/assets" +) + +const templatesDir = "assets/lcs-templates" + +// Identify identifies the Spdx ID of the given license content +func Identify(content string) (string, error) { + content = Normalize(content) + + templates, err := assets.AssetDir(templatesDir) + if err != nil { + return "", err + } + + for _, template := range templates { + t, err := assets.Asset(filepath.Join(templatesDir, template)) + if err != nil { + return "", err + } + license := string(t) + license = Normalize(license) + if license == content { + return strings.TrimSuffix(template, filepath.Ext(template)), nil + } + } + + return "", fmt.Errorf("cannot identify license content") +} diff --git a/license-eye/pkg/license/norm.go b/license-eye/pkg/license/norm.go index 6cd5612..1e723f3 100644 --- a/license-eye/pkg/license/norm.go +++ b/license-eye/pkg/license/norm.go @@ -30,9 +30,11 @@ var ( // meanings, according to the matching guide in https://spdx.dev/license-list/matching-guidelines. // The order matters. normalizers = []Normalizer{ + VariablesNormalizer, OneLineNormalizer, FlattenSpaceNormalizer, SubstantiveTextsNormalizer, + FlattenSpaceNormalizer, strings.ToLower, strings.TrimSpace, } @@ -116,6 +118,34 @@ var ( {regexp.MustCompile(`(?i)\b(the )?Apache Software Foundation( \(ASF\))?`), "the ASF"}, } + + variables = []struct { + regexp *regexp.Regexp + replacement string + }{ + // BSD-3-Clause + { + regexp.MustCompile(`(?im)(^(Copyright \(c\)) (\d{4}) (.+?) (All rights reserved\.)?$\n?)+`), + "$2 [year] [owner]. $5", + }, + { + regexp.MustCompile(`(?i)(neither the name of) (.+?) (nor the names of)`), + "$1 the copyright holder $3", + }, + // MIT + { // remove optional header + regexp.MustCompile(`(?im)^The MIT License \(MIT\)$`), + "", + }, + { + regexp.MustCompile(`(?im)^(Copyright \(c\)) (\d{4}) (.+?)$`), + "$1 [year] [owner]", + }, + { + regexp.MustCompile(`(?im)\(including the next paragraph\)`), + "", + }, + } ) // NormalizePattern applies a chain of Normalizers to the license pattern to make it cleaner for identification. @@ -169,3 +199,12 @@ func CommentIndicatorNormalizer(text string) string { func FlattenSpaceNormalizer(text string) string { return flattenSpace.ReplaceAllString(text, " ") } + +// VariablesNormalizer replace the variables actual value into variable name. +func VariablesNormalizer(text string) string { + for _, v := range variables { + text = v.regexp.ReplaceAllString(text, v.replacement) + } + + return text +}
