Skip to content

Commit 809f458

Browse files
cobyacobya
authored
Update Component Detection to .NET v8 (#1249)
* Initial NET 8 changes * Resolve formatting errors, fix tests * Fix debug log condition * Rollback SDK version * Update csproj refs * Fix integration test build failures * Potential test fix * Set up .NET 6 * Update test csproj
1 parent 8360853 commit 809f458

File tree

269 files changed

+1165
-1213
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

269 files changed

+1165
-1213
lines changed

‎.azdo/release.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ extends:
5454
displayName: Install .NET
5555
inputs:
5656
packageType: 'sdk'
57-
version: '6.0.x'
57+
version: '8.0.x'
5858

5959
# https://eng.ms/docs/cloud-ai-platform/devdiv/one-engineering-system-1es/1es-docs/1es-security-configuration/configuration-guides/pat-burndown-guidance#workarounds-for-tasks-that-do-not-yet-support-wif-service-connection
6060
- task: AzureCLI@2

‎.devcontainer/devcontainer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "https://raw.githubusercontent.com/devcontainers/spec/main/schemas/devContainer.base.schema.json",
33
"name": "Component Detection",
4-
"image": "mcr.microsoft.com/vscode/devcontainers/dotnet:6.0",
4+
"image": "mcr.microsoft.com/vscode/devcontainers/dotnet:8.0",
55
"runArgs": ["--init"],
66
"extensions": [
77
"eamodio.gitlens",

‎.editorconfig

+18
Original file line numberDiff line numberDiff line change
@@ -679,6 +679,24 @@ dotnet_diagnostic.CA1848.severity = suggestion
679679
# JSON002: Probable JSON string detected
680680
dotnet_diagnostic.JSON002.severity = suggestion
681681

682+
# IDE0290: Use primary constructor
683+
dotnet_diagnostic.IDE0290.severity = suggestion
684+
685+
# IDE0305: Simplify collection initialization
686+
dotnet_diagnostic.IDE0305.severity = suggestion
687+
688+
# SYSLIB1045: Convert to 'GeneratedRegexAttribute'.
689+
dotnet_diagnostic.SYSLIB1045.severity = suggestion
690+
691+
# CA1859: Use concrete types when possible for improved performance
692+
dotnet_diagnostic.CA1859.severity = suggestion
693+
694+
# CA1851: Possible multiple enumerations of 'IEnumerable' collection
695+
dotnet_diagnostic.CA1851.severity = suggestion
696+
697+
# CA1861: Avoid constant arrays as arguments
698+
dotnet_diagnostic.CA1861.severity = suggestion
699+
682700
# Workaround for https://github.com/dotnet/roslyn-analyzers/issues/5628
683701
[Program.cs]
684702
dotnet_diagnostic.ca1812.severity = none

‎Directory.Build.props

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Project>
22

33
<PropertyGroup Label="Build">
4-
<TargetFramework>net6.0</TargetFramework>
4+
<TargetFramework>net8.0</TargetFramework>
55
<LangVersion>latest</LangVersion>
66
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
77
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>

‎Directory.Packages.props

+14-15
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,22 @@
99
<PackageVersion Include="CommandLineParser" Version="2.9.1" />
1010
<PackageVersion Include="Docker.DotNet" Version="3.125.15" />
1111
<PackageVersion Include="FluentAssertions" Version="6.12.0" />
12-
<PackageVersion Include="FluentAssertions.Analyzers" Version="0.26.0" />
13-
<PackageVersion Include="Microsoft.Extensions.Caching.Memory" Version="7.0.0" />
14-
<PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="7.0.0" />
15-
<PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="7.0.0" />
16-
<PackageVersion Include="Microsoft.Extensions.Http" Version="7.0.0" />
17-
<PackageVersion Include="Microsoft.Extensions.Logging" Version="7.0.0" />
12+
<PackageVersion Include="FluentAssertions.Analyzers" Version="0.32.0" />
13+
<PackageVersion Include="Microsoft.Extensions.Caching.Memory" Version="8.0.0" />
14+
<PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
15+
<PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.1" />
16+
<PackageVersion Include="Microsoft.Extensions.Http" Version="8.0.0" />
17+
<PackageVersion Include="Microsoft.Extensions.Logging" Version="8.0.0" />
1818
<PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
19-
<PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.8.14" />
19+
<PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.11.20" />
2020
<PackageVersion Include="DotNet.Glob" Version="2.1.1" />
2121
<PackageVersion Include="MinVer" Version="5.0.0" />
2222
<PackageVersion Include="Moq" Version="4.18.4" />
2323
<PackageVersion Include="morelinq" Version="4.2.0" />
2424
<PackageVersion Include="MSTest.TestFramework" Version="3.5.1" />
2525
<PackageVersion Include="MSTest.Analyzers" Version="3.5.1" />
2626
<PackageVersion Include="MSTest.TestAdapter" Version="3.5.1" />
27-
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
27+
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
2828
<PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
2929
<PackageVersion Include="Newtonsoft.Json.Schema" Version="3.0.16" />
3030
<PackageVersion Include="NuGet.ProjectModel" Version="6.10.0" />
@@ -33,26 +33,25 @@
3333
<PackageVersion Include="Polly" Version="8.4.0" />
3434
<PackageVersion Include="SemanticVersioning" Version="2.0.2" />
3535
<PackageVersion Include="Serilog" Version="4.0.0" />
36-
<PackageVersion Include="Serilog.Extensions.Logging" Version="7.0.0" />
36+
<PackageVersion Include="Serilog.Extensions.Logging" Version="8.0.0" />
3737
<PackageVersion Include="Serilog.Sinks.Async" Version="1.5.0" />
3838
<PackageVersion Include="Serilog.Sinks.Console" Version="5.0.1" />
3939
<PackageVersion Include="Serilog.Sinks.File" Version="5.0.0" />
4040
<PackageVersion Include="Serilog.Sinks.Map" Version="1.0.2" />
41-
<PackageVersion Include="Spectre.Console" Version="0.48.0" />
42-
<PackageVersion Include="Spectre.Console.Cli" Version="0.48.0" />
41+
<PackageVersion Include="Spectre.Console" Version="0.49.1" />
42+
<PackageVersion Include="Spectre.Console.Cli" Version="0.49.1" />
4343
<PackageVersion Include="Spectre.Console.Cli.Extensions.DependencyInjection" Version="0.2.0" />
44-
<PackageVersion Include="Spectre.Console.Testing" Version="0.48.0" />
44+
<PackageVersion Include="Spectre.Console.Testing" Version="0.49.1" />
4545
<PackageVersion Include="StyleCop.Analyzers" Version="1.2.0-beta.556" />
4646
<PackageVersion Include="System.Memory" Version="4.5.5" />
4747
<PackageVersion Include="System.Reactive" Version="6.0.1" />
4848
<PackageVersion Include="System.Runtime.Loader" Version="4.3.0" />
49-
<PackageVersion Include="System.Text.Json" Version="6.0.9" />
50-
<PackageVersion Include="System.Threading.Tasks.Dataflow" Version="7.0.0" />
49+
<PackageVersion Include="System.Text.Json" Version="8.0.4" />
50+
<PackageVersion Include="System.Threading.Tasks.Dataflow" Version="8.0.0" />
5151
<PackageVersion Include="Tomlyn.Signed" Version="0.17.0" />
5252
<PackageVersion Include="yamldotnet" Version="15.1.6" />
5353
<PackageVersion Include="Faker.net" Version="2.0.163" />
5454
<PackageVersion Include="Valleysoft.DockerfileModel" Version="1.1.1" />
55-
5655
<!-- Fix security alerts -->
5756
<PackageVersion Include="System.Formats.Asn1" Version="6.0.1" />
5857
</ItemGroup>

‎global.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"sdk": {
3-
"version": "6.0.422",
3+
"version": "8.0.303",
44
"rollForward": "latestMinor"
55
}
66
}

‎src/Microsoft.ComponentDetection.Common/AsyncExecution.cs

+3-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
namespace Microsoft.ComponentDetection.Common;
1+
namespace Microsoft.ComponentDetection.Common;
22

33
using System;
44
using System.Threading;
@@ -21,10 +21,7 @@ public static class AsyncExecution
2121
/// <exception cref="TimeoutException">Thrown when the execution does not complete within the timeout.</exception>
2222
public static async Task<T> ExecuteWithTimeoutAsync<T>(Func<Task<T>> toExecute, TimeSpan timeout, CancellationToken cancellationToken)
2323
{
24-
if (toExecute == null)
25-
{
26-
throw new ArgumentNullException(nameof(toExecute));
27-
}
24+
ArgumentNullException.ThrowIfNull(toExecute);
2825

2926
var work = Task.Run(toExecute);
3027

@@ -48,10 +45,7 @@ public static async Task<T> ExecuteWithTimeoutAsync<T>(Func<Task<T>> toExecute,
4845
/// <exception cref="TimeoutException">Thrown when the execution does not complete within the timeout.</exception>
4946
public static async Task ExecuteVoidWithTimeoutAsync(Action toExecute, TimeSpan timeout, CancellationToken cancellationToken)
5047
{
51-
if (toExecute == null)
52-
{
53-
throw new ArgumentNullException(nameof(toExecute));
54-
}
48+
ArgumentNullException.ThrowIfNull(toExecute);
5549

5650
var work = Task.Run(toExecute, cancellationToken);
5751
var completedInTime = await Task.Run(() => work.Wait(timeout));

‎src/Microsoft.ComponentDetection.Common/Column.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
namespace Microsoft.ComponentDetection.Common;
1+
namespace Microsoft.ComponentDetection.Common;
22

33
public class Column
44
{

‎src/Microsoft.ComponentDetection.Common/CommandLineInvocationService.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ public class CommandLineInvocationService : ICommandLineInvocationService
2020
/// <inheritdoc/>
2121
public async Task<bool> CanCommandBeLocatedAsync(string command, IEnumerable<string> additionalCandidateCommands = null, DirectoryInfo workingDirectory = null, params string[] parameters)
2222
{
23-
additionalCandidateCommands ??= Enumerable.Empty<string>();
24-
parameters ??= Array.Empty<string>();
23+
additionalCandidateCommands ??= [];
24+
parameters ??= [];
2525
var allCommands = new[] { command }.Concat(additionalCandidateCommands);
2626
if (!this.commandLocatableCache.TryGetValue(command, out var validCommand))
2727
{

‎src/Microsoft.ComponentDetection.Common/ComponentComparer.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
namespace Microsoft.ComponentDetection.Common;
1+
namespace Microsoft.ComponentDetection.Common;
22

33
using System.Collections.Generic;
44
using Microsoft.ComponentDetection.Contracts.TypedComponent;

‎src/Microsoft.ComponentDetection.Common/ComponentStream.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
namespace Microsoft.ComponentDetection.Common;
1+
namespace Microsoft.ComponentDetection.Common;
22

33
using System.IO;
44
using Microsoft.ComponentDetection.Contracts;

‎src/Microsoft.ComponentDetection.Common/ComponentStreamEnumerable.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
namespace Microsoft.ComponentDetection.Common;
1+
namespace Microsoft.ComponentDetection.Common;
22

33
using System;
44
using System.Collections;

‎src/Microsoft.ComponentDetection.Common/ComponentStreamEnumerableFactory.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
namespace Microsoft.ComponentDetection.Common;
1+
namespace Microsoft.ComponentDetection.Common;
22

33
using System;
44
using System.Collections.Generic;

‎src/Microsoft.ComponentDetection.Common/DependencyGraph/ComponentRecorder.cs

+8-14
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ namespace Microsoft.ComponentDetection.Common.DependencyGraph;
1616

1717
public class ComponentRecorder : IComponentRecorder
1818
{
19-
private readonly ConcurrentBag<SingleFileComponentRecorder> singleFileRecorders = new ConcurrentBag<SingleFileComponentRecorder>();
19+
private readonly ConcurrentBag<SingleFileComponentRecorder> singleFileRecorders = [];
2020

2121
private readonly bool enableManualTrackingOfExplicitReferences;
2222

@@ -38,7 +38,7 @@ public IEnumerable<DetectedComponent> GetDetectedComponents()
3838
IEnumerable<DetectedComponent> detectedComponents;
3939
if (this.singleFileRecorders == null)
4040
{
41-
return Enumerable.Empty<DetectedComponent>();
41+
return [];
4242
}
4343

4444
detectedComponents = this.singleFileRecorders
@@ -68,7 +68,7 @@ public IEnumerable<string> GetSkippedComponents()
6868
{
6969
if (this.singleFileRecorders == null)
7070
{
71-
return Enumerable.Empty<string>();
71+
return [];
7272
}
7373

7474
return this.singleFileRecorders
@@ -162,25 +162,22 @@ public void RegisterUsage(
162162
bool? isDevelopmentDependency = null,
163163
DependencyScope? dependencyScope = null)
164164
{
165-
if (detectedComponent == null)
166-
{
167-
throw new ArgumentNullException(paramName: nameof(detectedComponent));
168-
}
165+
ArgumentNullException.ThrowIfNull(detectedComponent);
169166

170167
if (detectedComponent.Component == null)
171168
{
172169
throw new ArgumentException(Resources.MissingComponentId);
173170
}
174171

175172
#if DEBUG
176-
if (detectedComponent.DependencyRoots?.Any() ?? false)
173+
if (detectedComponent.DependencyRoots?.Count == 0)
177174
{
178-
this.logger.LogWarning("Detector should not populate DetectedComponent.DependencyRoots!");
175+
this.logger?.LogWarning("Detector should not populate DetectedComponent.DependencyRoots!");
179176
}
180177

181178
if (detectedComponent.DevelopmentDependency.HasValue)
182179
{
183-
this.logger.LogWarning("Detector should not populate DetectedComponent.DevelopmentDependency!");
180+
this.logger?.LogWarning("Detector should not populate DetectedComponent.DevelopmentDependency!");
184181
}
185182
#endif
186183

@@ -195,10 +192,7 @@ public void RegisterUsage(
195192

196193
public void RegisterPackageParseFailure(string skippedComponent)
197194
{
198-
if (skippedComponent == null)
199-
{
200-
throw new ArgumentNullException(paramName: nameof(skippedComponent));
201-
}
195+
ArgumentNullException.ThrowIfNull(skippedComponent);
202196

203197
_ = this.skippedComponentsInternal[skippedComponent] = default;
204198
}

‎src/Microsoft.ComponentDetection.Common/DependencyGraph/DependencyGraph.cs

+9-9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
using System.Collections.Immutable;
55
using System.Linq;
66
using System.Runtime.CompilerServices;
7+
using System.Text;
78
using Microsoft.ComponentDetection.Contracts;
89
using Microsoft.ComponentDetection.Contracts.BcdeModels;
910

@@ -13,6 +14,8 @@ namespace Microsoft.ComponentDetection.Common.DependencyGraph;
1314

1415
internal class DependencyGraph : IDependencyGraph
1516
{
17+
private static readonly CompositeFormat MissingNodeFormat = CompositeFormat.Parse(Resources.MissingNodeInDependencyGraph);
18+
1619
private readonly ConcurrentDictionary<string, ComponentRefNode> componentNodes;
1720

1821
private readonly bool enableManualTrackingOfExplicitReferences;
@@ -27,14 +30,11 @@ public DependencyGraph(bool enableManualTrackingOfExplicitReferences)
2730

2831
public void AddComponent(ComponentRefNode componentNode, string parentComponentId = null)
2932
{
30-
if (componentNode == null)
31-
{
32-
throw new ArgumentNullException(nameof(componentNode));
33-
}
33+
ArgumentNullException.ThrowIfNull(componentNode);
3434

3535
if (string.IsNullOrWhiteSpace(componentNode.Id))
3636
{
37-
throw new ArgumentNullException(nameof(componentNode.Id), "Invalid component node id");
37+
throw new ArgumentNullException(nameof(componentNode), "Invalid component node id");
3838
}
3939

4040
this.componentNodes.AddOrUpdate(componentNode.Id, componentNode, (key, currentNode) =>
@@ -77,10 +77,10 @@ public ICollection<string> GetExplicitReferencedDependencyIds(string componentId
7777

7878
if (!this.componentNodes.TryGetValue(componentId, out var componentRef))
7979
{
80-
throw new ArgumentException(string.Format(Resources.MissingNodeInDependencyGraph, componentId), paramName: nameof(componentId));
80+
throw new ArgumentException(string.Format(null, MissingNodeFormat, componentId), paramName: nameof(componentId));
8181
}
8282

83-
IList<string> explicitReferencedDependencyIds = new List<string>();
83+
IList<string> explicitReferencedDependencyIds = [];
8484

8585
this.GetExplicitReferencedDependencies(componentRef, explicitReferencedDependencyIds, new HashSet<string>());
8686

@@ -129,7 +129,7 @@ public ICollection<string> GetAncestors(string componentId)
129129
if (!this.componentNodes.TryGetValue(componentId, out var componentRef))
130130
{
131131
// this component isn't in the graph, so it has no ancestors
132-
return new List<string>();
132+
return [];
133133
}
134134

135135
// store the component id and the depth we found it at
@@ -189,7 +189,7 @@ private void AddDependency(string componentId, string parentComponentId)
189189

190190
if (!this.componentNodes.TryGetValue(parentComponentId, out var parentComponentRefNode))
191191
{
192-
throw new ArgumentException(string.Format(Resources.MissingNodeInDependencyGraph, parentComponentId), nameof(parentComponentId));
192+
throw new ArgumentException(string.Format(null, MissingNodeFormat, parentComponentId), nameof(parentComponentId));
193193
}
194194

195195
parentComponentRefNode.DependencyIds.Add(componentId);

‎src/Microsoft.ComponentDetection.Common/DependencyScopeComparer.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
namespace Microsoft.ComponentDetection.Common;
1+
namespace Microsoft.ComponentDetection.Common;
22

33
using Microsoft.ComponentDetection.Contracts.BcdeModels;
44

‎src/Microsoft.ComponentDetection.Common/DirectoryItemFacade.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
namespace Microsoft.ComponentDetection.Common;
1+
namespace Microsoft.ComponentDetection.Common;
22

33
using System.Collections.Generic;
44
using System.Diagnostics;

‎src/Microsoft.ComponentDetection.Common/DockerReference/DockerReferenceUtility.cs

+4-1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@
2626
// short-identifier := /[a-f0-9]{6,64}/
2727
namespace Microsoft.ComponentDetection.Common;
2828

29+
using System;
30+
using System.Diagnostics.CodeAnalysis;
2931
using Microsoft.ComponentDetection.Contracts;
3032

3133
public static class DockerReferenceUtility
@@ -120,6 +122,7 @@ public static (string Domain, string Remainder) SplitDockerDomain(string name)
120122
return (domain, remainder);
121123
}
122124

125+
[SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "Explicitly checks for character case.")]
123126
public static DockerReference ParseFamiliarName(string name)
124127
{
125128
if (DockerRegex.AnchoredIdentifierRegexp.IsMatch(name))
@@ -140,7 +143,7 @@ public static DockerReference ParseFamiliarName(string name)
140143
remoteName = remainder;
141144
}
142145

143-
if (remoteName.ToLower() != remoteName)
146+
if (!string.Equals(remoteName.ToLowerInvariant(), remoteName, StringComparison.InvariantCulture))
144147
{
145148
throw new ReferenceNameContainsUppercaseException(name);
146149
}

0 commit comments

Comments
 (0)