Skip to content

Commit

Permalink
feat(nuget)!: Split the product / technology namespace from the name
Browse files Browse the repository at this point in the history
Use up to two namespace nodes from the name that identify the company
and product / technology as defined at [1] as the namespace. This allows
to write curations with empty name and version that affect a whole product
/ technology, and to set e.g. a concluded license for all
"Microsoft.AspNetCore" packages.

[1]: https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/names-of-namespaces

Signed-off-by: Sebastian Schuberth <[email protected]>
  • Loading branch information
sschuberth committed Sep 4, 2023
1 parent f454039 commit 5975140
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,13 @@ private fun List<NuGetInspector.PackageData>.toPackageReferences(): Set<PackageR
)
}

internal fun getIdentifierWithNamespace(name: String, version: String): Identifier {
val namespace = name.split('.', limit = 3).toMutableList()
val nameWithoutNamespace = namespace.removeLast()
val namespaceWithoutName = namespace.joinToString(".")
return Identifier(type = TYPE, namespace = namespaceWithoutName, name = nameWithoutNamespace, version = version)
}

internal fun Collection<NuGetInspector.PackageData>.toOrtPackages(): Set<Package> =
groupBy { "${it.name}:${it.version}" }.mapTo(mutableSetOf()) { (_, packages) ->
val pkg = packages.first()
Expand All @@ -206,12 +213,16 @@ internal fun Collection<NuGetInspector.PackageData>.toOrtPackages(): Set<Package
(sha512 ?: sha256 ?: sha1 ?: md5 ?: "").lowercase()
)

val id = Identifier(
type = TYPE,
namespace = pkg.namespace.orEmpty(),
name = pkg.name,
version = pkg.version.orEmpty()
)
val id = if (pkg.namespace.isNullOrEmpty()) {
getIdentifierWithNamespace(pkg.name, pkg.version.orEmpty())
} else {
Identifier(
type = TYPE,
namespace = pkg.namespace,
name = pkg.name,

Check warning on line 222 in plugins/package-managers/nuget/src/main/kotlin/utils/NuGetInspector.kt

View check run for this annotation

Codecov / codecov/patch

plugins/package-managers/nuget/src/main/kotlin/utils/NuGetInspector.kt#L219-L222

Added lines #L219 - L222 were not covered by tests
version = pkg.version.orEmpty()
)
}

val declaredLicenses = mutableSetOf<String>()
val pkgDeclaredLicense = pkg.declaredLicense.orEmpty()
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/*
* Copyright (C) 2020 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.plugins.packagemanagers.nuget.utils

import io.kotest.assertions.assertSoftly
import io.kotest.core.spec.style.WordSpec
import io.kotest.matchers.shouldBe

import org.ossreviewtoolkit.model.Identifier

class NuGetInspectorTest : WordSpec({
"getIdentifierWithNamespace()" should {
"split the namespace from the name" {
assertSoftly {
getIdentifierWithNamespace("SharpCompress", "0.23.0") shouldBe
Identifier("NuGet::SharpCompress:0.23.0")

getIdentifierWithNamespace("System.IO", "4.1.0") shouldBe
Identifier("NuGet:System:IO:4.1.0")
getIdentifierWithNamespace("System.IO.Compression", "4.3.0") shouldBe
Identifier("NuGet:System.IO:Compression:4.3.0")
getIdentifierWithNamespace("System.IO.Compression.ZipFile", "4.0.1") shouldBe
Identifier("NuGet:System.IO:Compression.ZipFile:4.0.1")

getIdentifierWithNamespace(
"Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore",
"2.2.1"
) shouldBe Identifier(
"NuGet:Microsoft.Extensions:Diagnostics.HealthChecks.EntityFrameworkCore:2.2.1"
)

getIdentifierWithNamespace(
"Microsoft.AspNetCore.Components.WebAssembly.Build.BrotliCompression",
"3.1.6"
) shouldBe Identifier(
"NuGet:Microsoft.AspNetCore:Components.WebAssembly.Build.BrotliCompression:3.1.6"
)
}
}
}
})

0 comments on commit 5975140

Please sign in to comment.