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(reporter): Add authors to concluded license in disclosure document #9600

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −0
Open

fix(reporter): Add authors to concluded license in disclosure document #9600

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions model/src/main/kotlin/licenses/LicenseInfoResolver.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,26 @@
licenseInfo.concludedLicenseInfo.concludedLicense?.also {
originalExpressions += ResolvedOriginalExpression(expression = it, source = LicenseSource.CONCLUDED)
}

licenseInfo.declaredLicenseInfo.authors.takeIf { it.isNotEmpty() && addAuthorsToCopyrights }?.also {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to understand better in which situation this is required. Is it when the concluded license contains licenses which are not present in the declared licenses?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If there is a curation, then in the Disclosure Document only the concluded license is displayed. The scanner stage is skipped for this particular package (option: scanner.excludeConcluded). So the information about the authors and copyrights (locations) comes from the curation file, and not from any lines in some pieces of code. What I saw in the code is is that the declaredLicenses are given these dummy locations (from the curations file), while the concludedLicenses don't get this information. From a logical perspective, as the source of the conclusion comes from the curation file, it would be logic to also add the authors from the curation file as "dummy" locations.

It is required when the ORT Analyzer is not able to pick up a license for a package. In a concrete case, this happened for the SwiftPM Analyzer and package LicensePlist. As this package deals with licenses, there were a mass of false positives found by scancode, so it was decided to skip the scan step and instead write a curation, and add the author in the curation. This way, the license obligation to "include the copyright notice" could be met - if it would work.

locations += ResolvedLicenseLocation(
provenance = UnknownProvenance,
location = UNDEFINED_TEXT_LOCATION,
appliedCuration = null,
matchingPathExcludes = emptyList(),
copyrights = it.mapTo(mutableSetOf()) { author ->

Check warning on line 93 in model/src/main/kotlin/licenses/LicenseInfoResolver.kt

View check run for this annotation

Codecov / codecov/patch

model/src/main/kotlin/licenses/LicenseInfoResolver.kt#L88-L93 

Added lines #L88 - L93 were not covered by tests
val statement = "Copyright (C) $author".takeUnless {
author.contains("Copyright", ignoreCase = true)
} ?: author

Check warning on line 96 in model/src/main/kotlin/licenses/LicenseInfoResolver.kt

View check run for this annotation

Codecov / codecov/patch

model/src/main/kotlin/licenses/LicenseInfoResolver.kt#L95-L96 

Added lines #L95 - L96 were not covered by tests

ResolvedCopyrightFinding(
statement = statement,
location = UNDEFINED_TEXT_LOCATION,
matchingPathExcludes = emptyList()
)

Check warning on line 102 in model/src/main/kotlin/licenses/LicenseInfoResolver.kt

View check run for this annotation

Codecov / codecov/patch

model/src/main/kotlin/licenses/LicenseInfoResolver.kt#L98-L102 

Added lines #L98 - L102 were not covered by tests
Copy link
Member

@mnonnenmacher mnonnenmacher Dec 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move this to a helper function to avoid the duplication.
Also cover this change in the LicenseInfoResolverTest (similar to the existing test "resolve copyrights from authors if enabled").

}
)
}

Check warning on line 105 in model/src/main/kotlin/licenses/LicenseInfoResolver.kt

View check run for this annotation

Codecov / codecov/patch

model/src/main/kotlin/licenses/LicenseInfoResolver.kt#L105 

Added line #L105 was not covered by tests
}
}

Expand Down
Loading