forked from oss-review-toolkit/ort
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(model): Extends the model to capture Snippets from snippet scanners
Snippet scanners such as ScanOSS [1] and FossID [2] can identify code snippets potentially coming from a third party source. To do so, they scan the Internet for source code and build a Knowledge Base (KB). Then, the source code to check for snippets is scanned and compared against this KB. Snippet Findings are not License nor Copyright findings as a human operator needs to review them and either accept or flag them as false positives. Therefore, this commit adds a new property ORT data model in the `ScanSummary` to carry these snippet findings. This model has been created by comparing the results from FossID and ScanOSS and trying to find a common abstraction. This is currently the minimal model required to handle snippets. Further properties such as matched lines (present in both results) will be added in the future. Blackduck [3] is another scanner considered for integration in ORT [4] which supports snippets. However since it does not deliver snippets through its API, it was not considered when designing the snippet Data model for ORT. Fixes: oss-review-toolkit#3265. [1]: https://www.scanoss.com/ [2]: https://fossid.com/ [3]: https://www.synopsys.com/software-integrity/security-testing/software-composition-analysis.html [4]: oss-review-toolkit#4632 Signed-off-by: Nicolas Nobelis <nicolas.nobelis@bosch.io>
- Loading branch information
Showing
4 changed files
with
78 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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 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 |
---|---|---|
@@ -0,0 +1,63 @@ | ||
/* | ||
* Copyright (C) 2023 The ORT Project Authors (see <https://github.com/oss-review-toolkit/ort/blob/main/NOTICE>) | ||
* | ||
* 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 | ||
* | ||
* https://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. | ||
* | ||
* SPDX-License-Identifier: Apache-2.0 | ||
* License-Filename: LICENSE | ||
*/ | ||
|
||
package org.ossreviewtoolkit.model.utils | ||
|
||
import org.ossreviewtoolkit.utils.spdx.SpdxExpression | ||
|
||
/** | ||
* A class representing a snippet finding. A snippet finding is a code snippet of [artifact] and [version], with the | ||
* following [licenses], matching the code being scanned. | ||
* It is meant to be reviewed by an operator as it could be a false positive. | ||
*/ | ||
data class SnippetFinding( | ||
/** | ||
* The author/vendor of the component the code snippet is commit from. | ||
*/ | ||
val author: String, | ||
/** | ||
* The artifact name of the component the code snippet is commit from. | ||
*/ | ||
val artifact: String, | ||
/** | ||
* The version of the component the code snippet is commit from. | ||
*/ | ||
val version: String, | ||
/** | ||
* The license(s) of the component the code snippet is commit from. | ||
*/ | ||
val licenses: Set<SpdxExpression>, | ||
/** | ||
* The matching score between the code being scanned and the code snippet. This is scanner specific (e.g. for | ||
* ScanOSS this is a percentage). | ||
*/ | ||
val score: Float | ||
) : Comparable<SnippetFinding> { | ||
companion object { | ||
private val COMPARATOR = | ||
compareBy<SnippetFinding>( | ||
{ it.author }, | ||
{ it.artifact }, | ||
{ it.version }, | ||
{ it.licenses.toString() } | ||
).thenByDescending { it.score } | ||
} | ||
|
||
override fun compareTo(other: SnippetFinding) = COMPARATOR.compare(this, other) | ||
} |
This file contains 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 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