fix bug where GPL-2.0 failed to match GPL-2.0-only #42
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -89,7 +89,7 @@ func (n *node) isLicense() bool { | |
| return n.role == licenseNode | ||
| } | ||
|
|
||
| // license returns the value of the license field. | ||
| // See also reconstructedLicenseString() | ||
| func (n *node) license() *string { | ||
| if !n.isLicense() { | ||
|
|
@@ -167,7 +167,7 @@ func (n *node) reconstructedLicenseString() *string { | |
| return nil | ||
| } | ||
|
|
||
| // sortLicenses sorts an array of license and license reference nodes alphabetically based | ||
| // on their reconstructedLicenseString() representation. The sort function does not expect | ||
| // expression nodes, but if one is in the nodes list, it will sort to the end. | ||
| func sortLicenses(nodes []*node) { | ||
|
|
@@ -186,29 +186,51 @@ func sortLicenses(nodes []*node) { | |
|
|
||
| // ---------------------- Comparator Methods ---------------------- | ||
|
|
||
| // licensesAreCompatible returns true if two licenses are compatible; otherwise, false. | ||
| // Two licenses are compatible if they are the same license or if they are in the same | ||
| // license group and they meet one of the following rules: | ||
| // | ||
| // * both licenses have the `hasPlus` flag set to true | ||
| // * the first license has the `hasPlus` flag and the second license is in the first license's range or greater | ||
| // * the second license has the `hasPlus` flag and the first license is in the second license's range or greater | ||
| // * both licenses are in the same range | ||
| func (nodes *nodePair) licensesAreCompatible() bool { | ||
| // checking ranges is expensive, so check for simple cases first | ||
| if !nodes.firstNode.isLicense() || !nodes.secondNode.isLicense() { | ||
| return false | ||
| } | ||
| if !nodes.exceptionsAreCompatible() { | ||
|
There was a problem hiding this comment. @dangoor This is the check for exceptions. It is handled before checking ranges. |
||
| return false | ||
| } | ||
| if nodes.licensesExactlyEqual() { | ||
| return true | ||
| } | ||
|
|
||
| // simple cases don't apply, so check license ranges | ||
| // NOTE: Ranges are organized into groups (referred to as license groups) of the same base license (e.g. GPL). | ||
| // Groups have sub-groups of license versions (referred to as the range) where each member is considered | ||
| // to be the same version (e.g. {GPL-2.0, GPL-2.0-only}). The sub-groups are in ascending order within | ||
| // the license group, such that the first sub-group is considered to be less than the second sub-group, | ||
| // and so on. (e.g. {{GPL-1.0}, {GPL-2.0, GPL-2.0-only}} implies {GPL-1.0} < {GPL-2.0, GPL-2.0-only}). | ||
| if nodes.secondNode.hasPlus() { | ||
| if nodes.firstNode.hasPlus() { | ||
| // first+, second+ just need to be in same range group | ||
| return nodes.rangesAreCompatible() | ||
| } | ||
| // first, second+ requires first to be in range of second | ||
| return nodes.identifierInRange() | ||
| } | ||
| // else secondNode does not have plus | ||
| if nodes.firstNode.hasPlus() { | ||
| // first+, second requires second to be in range of first | ||
| revNodes := &nodePair{firstNode: nodes.secondNode, secondNode: nodes.firstNode} | ||
| return revNodes.identifierInRange() | ||
| } | ||
| // first, second requires both to be in same range group | ||
| return nodes.rangesEqual() | ||
|
There was a problem hiding this comment. This is the change that fixes the bug. It makes sure that if neither license Previously, it checked that the licenses were exactly the same. (e.g. |
||
| } | ||
|
|
||
| // licenseRefsAreCompatible returns true if two license references are compatible; otherwise, false. | ||
| func (nodes *nodePair) licenseRefsAreCompatible() bool { | ||
| if !nodes.firstNode.isLicenseRef() || !nodes.secondNode.isLicenseRef() { | ||
| return false | ||
|
|
@@ -222,13 +244,9 @@ func (nodes *nodePair) licenseRefsAreCompatible() bool { | |
| return compatible | ||
| } | ||
|
|
||
| // licenseRefsAreCompatible returns true if two licenses are in the same license group (e.g. all "GPL" licenses are in the same | ||
| // license group); otherwise, false. | ||
| func (nodes *nodePair) rangesAreCompatible() bool { | ||
| firstNode := *nodes.firstNode | ||
| secondNode := *nodes.secondNode | ||
|
|
||
|
|
@@ -238,7 +256,7 @@ func (nodes *nodePair) rangesAreCompatible() bool { | |
| // When both licenses allow later versions (i.e. hasPlus==true), being in the same license | ||
| // group is sufficient for compatibility, as long as, any exception is also compatible | ||
| // Example: All Apache licenses (e.g. Apache-1.0, Apache-2.0) are in the same license group | ||
| return sameLicenseGroup(firstRange, secondRange) | ||
|
There was a problem hiding this comment. I assume exception compatibility is still handled elsewhere? |
||
| } | ||
|
|
||
| // identifierInRange returns true if the (first) simple license is in range of the (second) | ||
|
|
@@ -247,14 +265,7 @@ func (nodes *nodePair) identifierInRange() bool { | |
| simpleLicense := nodes.firstNode | ||
| plusLicense := nodes.secondNode | ||
|
|
||
| return compareGT(simpleLicense, plusLicense) || compareEQ(simpleLicense, plusLicense) | ||
| } | ||
|
|
||
| // exceptionsAreCompatible returns true if neither license has an exception or they have | ||
|
|
@@ -274,10 +285,15 @@ func (nodes *nodePair) exceptionsAreCompatible() bool { | |
| } | ||
|
|
||
| return *nodes.firstNode.exception() == *nodes.secondNode.exception() | ||
| } | ||
|
|
||
| // rangesEqual returns true if the licenses are in the same range; otherwise, false | ||
| // (e.g. GPL-2.0-only == GPL-2.0) | ||
| func (nodes *nodePair) rangesEqual() bool { | ||
| return compareEQ(nodes.firstNode, nodes.secondNode) | ||
| } | ||
|
|
||
| // licensesExactlyEqual returns true if the licenses are the same; otherwise, false | ||
| func (nodes *nodePair) licensesExactlyEqual() bool { | ||
| return strings.EqualFold(*nodes.firstNode.reconstructedLicenseString(), *nodes.secondNode.reconstructedLicenseString()) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
very helpful comment!