refactor(Repository): Add RepositoryProvenance attribute
#10575
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
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 |
|---|---|---|
|
|
@@ -20,24 +20,25 @@ | |
| package org.ossreviewtoolkit.model | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonInclude | ||
| import com.fasterxml.jackson.core.JsonParser | ||
| import com.fasterxml.jackson.databind.DeserializationContext | ||
| import com.fasterxml.jackson.databind.JsonNode | ||
| import com.fasterxml.jackson.databind.annotation.JsonDeserialize | ||
| import com.fasterxml.jackson.databind.deser.std.StdDeserializer | ||
| import com.fasterxml.jackson.module.kotlin.treeToValue | ||
|
|
||
| import org.ossreviewtoolkit.model.config.RepositoryConfiguration | ||
| import org.ossreviewtoolkit.utils.ort.ORT_REPO_CONFIG_FILENAME | ||
|
|
||
| /** | ||
| * A description of the source code repository that was used as input for ORT. | ||
| */ | ||
| @JsonDeserialize(using = RepositoryDeserializer::class) | ||
| data class Repository( | ||
| /** | ||
| * Provenance wrapper for original VCS information, if present. | ||
| */ | ||
| val provenance: RepositoryProvenance, | ||
|
|
||
| /** | ||
| * A map of nested repositories, for example Git submodules or Git-Repo modules. The key is the path to the | ||
|
|
@@ -57,24 +58,75 @@ data class Repository( | |
| */ | ||
| @JvmField | ||
| val EMPTY = Repository( | ||
| provenance = RepositoryProvenance( | ||
| vcsInfo = VcsInfo.EMPTY, | ||
| resolvedRevision = HashAlgorithm.SHA1.emptyValue | ||
| ), | ||
| nestedRepositories = emptyMap(), | ||
| config = RepositoryConfiguration() | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Return the path of [vcs] relative to [Repository.provenance], or null if [vcs] is neither [Repository.provenance] | ||
| * nor contained in [nestedRepositories]. | ||
| */ | ||
| fun getRelativePath(vcs: VcsInfo): String? { | ||
| fun VcsInfo.matches(other: VcsInfo) = type == other.type && url == other.url && revision == other.revision | ||
|
|
||
| val normalizedVcs = vcs.normalize() | ||
|
|
||
| if (provenance.vcsInfo.matches(normalizedVcs)) return "" | ||
|
|
||
| return nestedRepositories.entries.find { (_, nestedVcs) -> nestedVcs.normalize().matches(normalizedVcs) }?.key | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * A custom deserializer for [Repository] to support the legacy "vcs" and "vcsProcessed" attributes. | ||
| */ | ||
| private class RepositoryDeserializer : StdDeserializer<Repository>(Repository::class.java) { | ||
| override fun deserialize(p: JsonParser, ctxt: DeserializationContext): Repository { | ||
| val node = p.codec.readTree<JsonNode>(p) | ||
| val parsedProvenance = when { | ||
| node.has("vcs") -> { | ||
| // Parse [vcs] and [vcsProcessed] attributes. | ||
| val vcs = jsonMapper.treeToValue<VcsInfo>(node["vcs"]) | ||
| val vcsProcess = jsonMapper.treeToValue<VcsInfo>(node["vcs_processed"]) | ||
|
|
||
| // Fall back to [vcsProcessed], if [vcs] is empty. | ||
| val vcsInfo = vcsProcess | ||
|
|
||
| // Get the [vcs]'s revision. | ||
| // Fall back to [vcsProcessed], if [vcs] has empty revision. | ||
| val resolvedRevision = vcs.revision.ifEmpty { | ||
| vcsProcess.revision.ifEmpty { | ||
| HashAlgorithm.SHA1.emptyValue | ||
| } | ||
| } | ||
|
Comment on lines
+100
to
+106
There was a problem hiding this comment. The EvaluatedModelReporterFunTests are currently failing, since the I assume I would need to iterate over the other nodes in the file and get the Since there is a @sschuberth @mnonnenmacher Before I continue on this hunch, could you way in on the issue? |
||
|
|
||
| // Build a RepositoryProvenance from the parsed VcsInfo fields. | ||
| RepositoryProvenance(vcsInfo, resolvedRevision) | ||
| } | ||
|
|
||
| else -> { | ||
| // Parse the [provenance], if no legacy fields are present. | ||
| jsonMapper.treeToValue<RepositoryProvenance>(node["provenance"]) | ||
| } | ||
| } | ||
|
|
||
| val nestedRepositories = if (node.has("nested_repositories")) { | ||
| jsonMapper.treeToValue<Map<String, VcsInfo>>(node["nested_repositories"]) | ||
| } else { | ||
| emptyMap() | ||
| } | ||
|
|
||
| val config = if (node.has("config")) { | ||
| jsonMapper.treeToValue<RepositoryConfiguration>(node["config"]) | ||
| } else { | ||
| RepositoryConfiguration() | ||
| } | ||
|
|
||
| return Repository(provenance = parsedProvenance, nestedRepositories, config) | ||
| } | ||
| } | ||
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.