-
Notifications
You must be signed in to change notification settings - Fork 308
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(analyzer): Split package manager dependency classes across f…
…iles Increase the overview. Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
- Loading branch information
1 parent
89467d9
commit fdd90ca
Showing
4 changed files
with
117 additions
and
69 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,71 @@ | ||
/* | ||
* Copyright (C) 2022 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.analyzer | ||
|
||
import kotlin.contracts.contract | ||
|
||
import org.apache.logging.log4j.kotlin.logger | ||
|
||
import org.ossreviewtoolkit.model.AnalyzerResult | ||
import org.ossreviewtoolkit.model.PackageLinkage | ||
import org.ossreviewtoolkit.model.Project | ||
|
||
internal data class PackageManagerDependency( | ||
val packageManager: String, | ||
val definitionFile: String, | ||
val scope: String, | ||
val linkage: PackageLinkage | ||
) { | ||
fun findProjects(analyzerResult: AnalyzerResult): List<Project> = | ||
analyzerResult.projects.filter { it.definitionFilePath == definitionFile }.also { projects -> | ||
if (projects.isEmpty()) { | ||
logger.warn { "Could not find any project for definition file '$definitionFile'." } | ||
} | ||
|
||
projects.forEach { verify(it) } | ||
} | ||
|
||
fun verify(project: Project?) { | ||
contract { | ||
returns() implies (project != null) | ||
} | ||
|
||
requireNotNull(project) { | ||
"Could not find a project for the definition file '$definitionFile'." | ||
} | ||
|
||
require(project.id.type == packageManager) { | ||
"The project '${project.id.toCoordinates()}' from definition file '$definitionFile' uses the wrong " + | ||
"package manager '${project.id.type}', expected is '$packageManager'." | ||
} | ||
|
||
requireNotNull(project.scopeNames) { | ||
"The project '${project.id.toCoordinates()}' from definition file '$definitionFile' does not use a " + | ||
"dependency graph." | ||
} | ||
|
||
if (scope !in project.scopeNames.orEmpty()) { | ||
logger.warn { | ||
"The project '${project.id.toCoordinates()}' from definition file '$definitionFile' does not contain " + | ||
"the requested scope '$scope'." | ||
} | ||
} | ||
} | ||
} |
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,43 @@ | ||
/* | ||
* Copyright (C) 2022 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.analyzer | ||
|
||
import org.ossreviewtoolkit.model.DependencyNode | ||
import org.ossreviewtoolkit.model.Identifier | ||
import org.ossreviewtoolkit.model.Issue | ||
import org.ossreviewtoolkit.model.PackageLinkage | ||
|
||
sealed class ResolvableDependencyNode : DependencyNode | ||
|
||
class ProjectScopeDependencyNode( | ||
override val id: Identifier, | ||
override val linkage: PackageLinkage, | ||
override val issues: List<Issue>, | ||
private val dependencies: Sequence<DependencyNode> | ||
) : ResolvableDependencyNode() { | ||
override fun <T> visitDependencies(block: (Sequence<DependencyNode>) -> T): T = block(dependencies) | ||
} | ||
|
||
class DependencyNodeDelegate(private val node: DependencyNode) : ResolvableDependencyNode() { | ||
override val id: Identifier = node.id | ||
override val linkage = node.linkage | ||
override val issues = node.issues | ||
override fun <T> visitDependencies(block: (Sequence<DependencyNode>) -> T): T = node.visitDependencies(block) | ||
} |