feat(nuget)!: Split the (technology) namespace from the name #6046

sschuberth · 2022-11-07T20:56:40Z

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.

Note
This is a breaking change as IDs that refer to NuGet packages, like in package curations, probably need to be adjusted to accommodate for the proper namespace.

sschuberth · 2022-11-08T09:14:56Z

See this for more context. Even if this would be a quite massive breaking change for existing NuGet curations, I believe it's the right thing to do, and afterwards writing (generic) NuGet curations would be much easier / possible. What do you thing @oss-review-toolkit/core-devs?

sschuberth · 2022-11-08T09:45:38Z

analyzer/src/main/kotlin/managers/utils/NuGetSupport.kt

-private fun getIdentifier(name: String, version: String) =
-    Identifier(type = "NuGet", namespace = "", name = name, version = version)
+internal fun getIdentifier(name: String, version: String): Identifier {
+    val namespace = name.split('.', limit = 3).toMutableList()


Maybe the splitting here should be made more strict and also require PascalCase as described in the linked article.

codecov · 2023-09-04T10:14:26Z

Codecov Report

Patch coverage: 78.53% and no project coverage change.

Comparison is base (3fac582) 68.01% compared to head (22dbf21) 68.02%.

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #6046   +/-   ##
=========================================
  Coverage     68.01%   68.02%           
  Complexity     2023     2023           
=========================================
  Files           339      343    +4     
  Lines         16719    16723    +4     
  Branches       2371     2371           
=========================================
+ Hits          11371    11375    +4     
- Misses         4363     4364    +1     
+ Partials        985      984    -1

Flag	Coverage Δ
funTest-docker	`69.40% <78.53%> (+0.06%)`	⬆️
funTest-non-docker	`36.46% <ø> (ø)`
test	`35.51% <4.76%> (-0.60%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
...gers/nuget/src/main/kotlin/utils/NuGetInspector.kt	`68.00% <ø> (-8.13%)`	⬇️
...rs/python/src/main/kotlin/utils/PythonInspector.kt	`67.67% <ø> (-3.20%)`	⬇️
...nagers/python/src/main/kotlin/utils/PythonUtils.kt	`57.89% <57.89%> (ø)`
...src/main/kotlin/utils/PythonInspectorExtensions.kt	`77.27% <77.27%> (ø)`
.../src/main/kotlin/utils/NuGetInspectorExtensions.kt	`83.75% <83.75%> (ø)`
...managers/nuget/src/main/kotlin/utils/NuGetUtils.kt	`100.00% <100.00%> (ø)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

sschuberth · 2023-09-04T10:30:02Z

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

@@ -197,6 +197,13 @@ private fun List<NuGetInspector.PackageData>.toPackageReferences(): Set<PackageR
        )
    }

+internal fun getIdentifierWithNamespace(name: String, version: String): Identifier {


@mnonnenmacher am I correct to assume that public access to this would be required here in order for GenerateAspNetCoreCurationsTask et al to make use of the new logic? Or would you simply duplicate this small piece of code?

I think it would be better to make it public just in case there are changes in the future. Otherwise the copy might get out of sync.

Separate generic Python utilities from those specific to `PythonInspector` by moving them to a dedicated file. Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>

Move funtions that build the bridge between PythonInspector's and ORT's models to a dedicated file in order for `PythonInspector` to be independent of ORT's model for a cleaner separation. Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>

Move funtions that build the bridge between NuGetInspector's and ORT's models to a dedicated file in order for `NuGetInspector` to be independent of ORT's model for a cleaner separation. Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>

plugins/package-managers/python/src/main/kotlin/utils/PythonInspectorExtensions.kt

plugins/package-managers/nuget/src/main/kotlin/utils/NuGetUtils.kt

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 <sschuberth@gmail.com>

ORT core changed the way to refer to NuGet packages [1]. Adapt for that when generating new NuGet curations. Existing NuGet curations will be migrated separately. [1]: oss-review-toolkit/ort#6046 Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>

This adopts to [1]. [1]: oss-review-toolkit/ort#6046 Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>

This adopts to [1] by having run ort migrate --nuget-ids ort-config [1]: oss-review-toolkit/ort#6046 Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>

Update a NuGet identifier to use a namespace as the analyzer would find it since [1]. [1]: #6046 Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.io>

sschuberth force-pushed the nuget-namespaces branch 2 times, most recently from af515d3 to 1c48e14 Compare November 7, 2022 21:03

sschuberth commented Nov 8, 2022

View reviewed changes

sschuberth force-pushed the nuget-namespaces branch from 1c48e14 to 2235c00 Compare September 4, 2023 09:57

sschuberth changed the title ~~NuGetSupport: Properly split the (technology) namespace from the name~~ feat(nuget)!: Split the (technology) namespace from the name Sep 4, 2023

sschuberth added release notes labels Sep 4, 2023

sschuberth force-pushed the nuget-namespaces branch from 2235c00 to 5975140 Compare September 4, 2023 10:14

sschuberth commented Sep 4, 2023

View reviewed changes

sschuberth force-pushed the nuget-namespaces branch from 5975140 to 9d05fa0 Compare September 4, 2023 10:44

sschuberth force-pushed the nuget-namespaces branch from 9d05fa0 to 1a6a4fe Compare September 13, 2023 14:15

sschuberth added 3 commits September 13, 2023 16:43

refactor(python): Move PythonInspector unrelated utilities out

c27c15a

Separate generic Python utilities from those specific to `PythonInspector` by moving them to a dedicated file. Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>

sschuberth force-pushed the nuget-namespaces branch from 1a6a4fe to 0871063 Compare September 13, 2023 15:19

sschuberth marked this pull request as ready for review September 13, 2023 15:20

sschuberth requested a review from a team as a code owner September 13, 2023 15:20

sschuberth requested a review from mnonnenmacher September 13, 2023 15:20

fviernau reviewed Sep 13, 2023

View reviewed changes

plugins/package-managers/python/src/main/kotlin/utils/PythonInspectorExtensions.kt Show resolved Hide resolved

plugins/package-managers/nuget/src/main/kotlin/utils/NuGetUtils.kt Show resolved Hide resolved

fviernau requested changes Sep 13, 2023

View reviewed changes

plugins/package-managers/nuget/src/main/kotlin/utils/NuGetUtils.kt Show resolved Hide resolved

sschuberth force-pushed the nuget-namespaces branch from 0871063 to 19fe1ec Compare September 13, 2023 16:04

sschuberth requested a review from fviernau September 13, 2023 16:04

sschuberth force-pushed the nuget-namespaces branch 2 times, most recently from ccea3a1 to 9864317 Compare September 13, 2023 16:37

sschuberth force-pushed the nuget-namespaces branch from 9864317 to 22dbf21 Compare September 13, 2023 16:40

fviernau approved these changes Sep 13, 2023

View reviewed changes

sschuberth merged commit 229c0fb into main Sep 13, 2023
21 checks passed

sschuberth deleted the nuget-namespaces branch September 13, 2023 19:49

sschuberth added a commit to oss-review-toolkit/ort-config that referenced this pull request Sep 21, 2023

refactor(curations): Migrate to NuGet IDs with namespaces

71880ee

This adopts to [1]. [1]: oss-review-toolkit/ort#6046 Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>

sschuberth mentioned this pull request Sep 21, 2023

refactor(curations): Migrate to NuGet IDs with namespaces oss-review-toolkit/ort-config#136

Merged

sschuberth added a commit to oss-review-toolkit/ort-config that referenced this pull request Sep 21, 2023

refactor(curations): Migrate to NuGet IDs with namespaces

f95ce00

This adopts to [1]. [1]: oss-review-toolkit/ort#6046 Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>

mnonnenmacher added a commit that referenced this pull request Sep 21, 2023

test(advisor): Update a NuGet identifier

87d9e0f

Update a NuGet identifier to use a namespace as the analyzer would find it since [1]. [1]: #6046 Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.io>

mnonnenmacher added a commit that referenced this pull request Sep 21, 2023

test(advisor): Update a NuGet identifier

79f6577

Update a NuGet identifier to use a namespace as the analyzer would find it since [1]. [1]: #6046 Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.io>

mnonnenmacher added a commit that referenced this pull request Sep 21, 2023

test(advisor): Update a NuGet identifier

2a7d3f5

Update a NuGet identifier to use a namespace as the analyzer would find it since [1]. [1]: #6046 Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.io>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(nuget)!: Split the (technology) namespace from the name #6046

feat(nuget)!: Split the (technology) namespace from the name #6046

sschuberth commented Nov 7, 2022 •

edited

Loading

sschuberth commented Nov 8, 2022

sschuberth Nov 8, 2022

codecov bot commented Sep 4, 2023 •

edited

Loading

sschuberth Sep 4, 2023 •

edited

Loading

This comment was marked as outdated.

mnonnenmacher Sep 13, 2023

feat(nuget)!: Split the (technology) namespace from the name #6046

feat(nuget)!: Split the (technology) namespace from the name #6046

Conversation

sschuberth commented Nov 7, 2022 • edited Loading

sschuberth commented Nov 8, 2022

sschuberth Nov 8, 2022

Choose a reason for hiding this comment

codecov bot commented Sep 4, 2023 • edited Loading

Codecov Report

sschuberth Sep 4, 2023 • edited Loading

Choose a reason for hiding this comment

This comment was marked as outdated.

mnonnenmacher Sep 13, 2023

Choose a reason for hiding this comment

sschuberth commented Nov 7, 2022 •

edited

Loading

codecov bot commented Sep 4, 2023 •

edited

Loading

sschuberth Sep 4, 2023 •

edited

Loading