Skip to content
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

🐛 fix Unlicense detection #4145

Merged
merged 3 commits into from
Jun 6, 2024
Merged

🐛 fix Unlicense detection #4145

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96a4d30
fix unlicense detection
spencerschrock Jun 5, 2024
b56174f
Merge branch 'main' into fix-unlicense
spencerschrock Jun 6, 2024
2ea480f
remove part of comment which is no longer relevant
spencerschrock Jun 6, 2024
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
44 changes: 18 additions & 26 deletions checks/raw/license.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,17 +160,10 @@ func License(c *checker.CheckRequest) (checker.LicenseData, error) {

// scorecard search stops at first candidate (isLicenseFile) license file found
if path != (checker.LicenseFile{}) {
//
// now it is time to "map it back" in the case of the
// Spdx Identifier for "UNLICENSE" which was mapped to "UN"
// for the regex group match and this check.
// grab what is needed before clobbering the Spdx Identifier
// Aside from 'UN', these settings (Name, Key) match GH repo API
// for when the Spdx Identifier cannot be determined.
path.LicenseInformation.Name = fsfOsiApprovedLicenseCiMap[strings.ToUpper(path.LicenseInformation.SpdxID)].Name
if strings.ToUpper(path.LicenseInformation.SpdxID) == "UN" {
path.LicenseInformation.SpdxID = "UNLICENSE"
} else if path.LicenseInformation.SpdxID == "" {
// these settings (Name, Key) match GH repo API
// for when the Spdx Identifier cannot be determined.
if path.LicenseInformation.SpdxID == "" {
path.LicenseInformation.SpdxID = "NOASSERTION"
path.LicenseInformation.Name = "Other"
}
Expand Down Expand Up @@ -226,19 +219,7 @@ func setCiMap() {
defer ciMapMutex.Unlock()
if len(fsfOsiApprovedLicenseCiMap) == 0 {
for key, entry := range fsfOsiApprovedLicenseMap {
// Special case, the unlicense, in the map is
// called 'The Unlicense' with the Spdx id 'Unlicense'.
// For the regex's 'un' will match the [pre|suf]Spdx
// regex group (just as it would match '0BSD'), but
// 'un' will not "hit" in the map with key 'Unlicense'
// so change to 'UN' for 'unlicense' for 'isLicenseFile()'
// TODO: make this general (pass a key map for changing these
// special cases). For now this is the only one.
if strings.ToUpper(key) == "UNLICENSE" {
fsfOsiApprovedLicenseCiMap["UN"] = entry
} else {
fsfOsiApprovedLicenseCiMap[strings.ToUpper(key)] = entry
}
fsfOsiApprovedLicenseCiMap[strings.ToUpper(key)] = entry
}
}
}
Expand All @@ -261,12 +242,23 @@ func getSpdxID(matches []string) string {
// value, preSpdx takes precedence.
// (e.g., 0BSD-LICENSE-GPL-2.0.txt)
// TODO: decide if that is OK or should "fail"
var id string
if matches[reGroupIdxs["preSpdx"]] != "" {
return matches[reGroupIdxs["preSpdx"]]
id = matches[reGroupIdxs["preSpdx"]]
} else if matches[reGroupIdxs["sufSpdx"]] != "" {
return matches[reGroupIdxs["sufSpdx"]]
id = matches[reGroupIdxs["sufSpdx"]]
}
return ""
// Special case, the unlicense, in the map is
// called 'The Unlicense' with the Spdx id 'Unlicense'.
// For the regex's 'un' will match the [pre|suf]Spdx
// regex group (just as it would match '0BSD'), but
// 'un' will not "hit" in the map with key 'Unlicense'
// so change to 'UN' for 'unlicense' for 'isLicenseFile()
if strings.EqualFold(id, "UN") {
id = "UNLICENSE"
}

return id
}

func getExt(filename string, matches []string) string {
Expand Down
Loading