diff --git a/Directory.Packages.props b/Directory.Packages.props index eba94e254..14ef5c80e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -39,7 +39,6 @@ vstest 17.8 version NuGetFrameworksVersion is defined here https://github.com/microsoft/vstest/blob/9a0c41811637edf4afe0e265e08fdd1cb18109ed/eng/Versions.props#L94C1-L94C1 --> - diff --git a/README.md b/README.md index cea37fcfc..39aa23b69 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,8 @@ Coverlet supports only SDK-style projects https://docs.microsoft.com/en-us/visua ```bash dotnet add package coverlet.collector ``` - -N.B. You **MUST** add package only to test projects and if you create xunit test projects (`dotnet new xunit`) you'll find the reference already present in `csproj` file because Coverlet is the default coverage tool for every .NET Core and >= .NET 6 applications, you've only to update to last version if needed. Do not add `coverlet.collector` and `coverlet.msbuild` package in a test project. +> [!NOTE] +> You **MUST** add package only to test projects and if you create xunit test projects (`dotnet new xunit`) you will find the reference already present in `csproj` file because Coverlet is the default coverage tool for every .NET Core and >= *.NET 8* applications, you've only to update to last version if needed. Add `coverlet.collector` *OR* `coverlet.msbuild` package in a test project. ### Usage (coverlet.collector) @@ -61,11 +61,11 @@ See [documentation](Documentation/VSTestIntegration.md) for advanced usage. #### Requirements (coverlet.collector) -* _You need to be running .NET 6.0 SDK v6.0.316 or newer_ -* _You need to reference version 17.5.0 and above of Microsoft.NET.Test.Sdk_ +* _You need to be running .NET 8.0 SDK v8.0.112 or newer_ +* _You need to reference version 17.12.0 and above of Microsoft.NET.Test.Sdk_ ```xml - + ``` ### MSBuild Integration (suffers of possible [known issue](https://github.com/coverlet-coverage/coverlet/blob/master/Documentation/KnownIssues.md#1-vstest-stops-process-execution-earlydotnet-test)) @@ -120,7 +120,7 @@ See [documentation](Documentation/GlobalTool.md) for advanced usage. .NET global tools rely on a .NET Core runtime installed on your machine https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools#what-could-go-wrong -.NET Coverlet global tool requires _.NET Core 2.2 and above_ +.NET Coverlet global tool requires _.NET 8.0 or above_ ## How It Works diff --git a/src/coverlet.core/Coverage.cs b/src/coverlet.core/Coverage.cs index 3cc80c4c8..918d8aedf 100644 --- a/src/coverlet.core/Coverage.cs +++ b/src/coverlet.core/Coverage.cs @@ -6,11 +6,11 @@ using System.IO; using System.Linq; using System.Runtime.Serialization; +using System.Text.Json; +using System.Text.Json.Nodes; using Coverlet.Core.Abstractions; using Coverlet.Core.Helpers; using Coverlet.Core.Instrumentation; -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; namespace Coverlet.Core { @@ -60,6 +60,14 @@ internal class Coverage public string Identifier { get; } + readonly JsonSerializerOptions _options = new() + { + PropertyNameCaseInsensitive = true, + DictionaryKeyPolicy = JsonNamingPolicy.CamelCase, + IncludeFields = true, + WriteIndented = true + }; + public Coverage(string moduleOrDirectory, CoverageParameters parameters, ILogger logger, @@ -313,7 +321,7 @@ public CoverageResult GetCoverageResult() { _logger.LogInformation($"MergeWith: '{_parameters.MergeWith}'."); string json = _fileSystem.ReadAllText(_parameters.MergeWith); - coverageResult.Merge(JsonConvert.DeserializeObject(json)); + coverageResult.Merge(JsonSerializer.Deserialize(json, _options)); } else { @@ -366,8 +374,8 @@ private void CalculateCoverage() var documents = result.Documents.Values.ToList(); if (_parameters.UseSourceLink && result.SourceLink != null) { - JToken jObject = JObject.Parse(result.SourceLink)["documents"]; - Dictionary sourceLinkDocuments = JsonConvert.DeserializeObject>(jObject.ToString()); + JsonNode jObject = JsonNode.Parse(result.SourceLink)["documents"]; + Dictionary sourceLinkDocuments = JsonSerializer.Deserialize>(jObject.ToString()); foreach (Document document in documents) { document.Path = GetSourceLinkUrl(sourceLinkDocuments, document.Path); @@ -480,9 +488,9 @@ internal string GetSourceLinkUrl(Dictionary sourceLinkDocuments, { string key = sourceLinkDocument.Key; if (Path.GetFileName(key) != "*") continue; - +#pragma warning disable IDE0057 IReadOnlyList rootMapping = _sourceRootTranslator.ResolvePathRoot(key.Substring(0, key.Length - 1)); - +#pragma warning restore IDE0057 foreach (string keyMapping in rootMapping is null ? [key] : new List(rootMapping.Select(m => m.OriginalPath))) { string directoryDocument = Path.GetDirectoryName(document); @@ -494,8 +502,9 @@ internal string GetSourceLinkUrl(Dictionary sourceLinkDocuments, { if (!directoryDocument.StartsWith(sourceLinkRoot + Path.DirectorySeparatorChar)) continue; - +#pragma warning disable IDE0057 relativePath = directoryDocument.Substring(sourceLinkRoot.Length + 1); +#pragma warning restore IDE0057 } if (relativePathOfBestMatch.Length == 0) diff --git a/src/coverlet.core/CoverageResult.cs b/src/coverlet.core/CoverageResult.cs index 7b002053c..c3a92ee29 100644 --- a/src/coverlet.core/CoverageResult.cs +++ b/src/coverlet.core/CoverageResult.cs @@ -3,6 +3,7 @@ using System.Collections.Generic; using System.Linq; +using System.Text.Json.Serialization; using Coverlet.Core.Enums; using Coverlet.Core.Instrumentation; @@ -22,6 +23,7 @@ internal class Branches : List { } internal class Method { + [JsonConstructor] internal Method() { Lines = []; diff --git a/src/coverlet.core/Exceptions.cs b/src/coverlet.core/Exceptions.cs index d65b22096..365df85f3 100644 --- a/src/coverlet.core/Exceptions.cs +++ b/src/coverlet.core/Exceptions.cs @@ -5,25 +5,17 @@ namespace Coverlet.Core.Exceptions { - [Serializable] public class CoverletException : Exception { public CoverletException() { } public CoverletException(string message) : base(message) { } public CoverletException(string message, System.Exception inner) : base(message, inner) { } - protected CoverletException( - System.Runtime.Serialization.SerializationInfo info, - System.Runtime.Serialization.StreamingContext context) : base(info, context) { } } - [Serializable] internal class CecilAssemblyResolutionException : CoverletException { public CecilAssemblyResolutionException() { } public CecilAssemblyResolutionException(string message) : base(message) { } public CecilAssemblyResolutionException(string message, System.Exception inner) : base(message, inner) { } - protected CecilAssemblyResolutionException( - System.Runtime.Serialization.SerializationInfo info, - System.Runtime.Serialization.StreamingContext context) : base(info, context) { } } } diff --git a/src/coverlet.core/Helpers/InstrumentationHelper.cs b/src/coverlet.core/Helpers/InstrumentationHelper.cs index 0b1b3439c..e6e3f0702 100644 --- a/src/coverlet.core/Helpers/InstrumentationHelper.cs +++ b/src/coverlet.core/Helpers/InstrumentationHelper.cs @@ -415,8 +415,10 @@ private static string GetIncludeModuleKeysForValidFilters(char escapeSymbol, str } private static string CreateRegexExcludePattern(IEnumerable filters, char escapeSymbol) - //only look for module filters here, types will be filtered out when instrumenting + //only look for module filters here, types will be filtered out when instrumenting +#pragma warning disable IDE0057 // Use range operator => CreateRegexPattern(filters, escapeSymbol, filter => filter.Substring(filter.IndexOf(']') + 1) == "*"); +#pragma warning restore IDE0057 // Use range operator private static string CreateRegexIncludePattern(IEnumerable filters, char escapeSymbol) => CreateRegexPattern(filters, escapeSymbol); @@ -424,8 +426,10 @@ private static string CreateRegexIncludePattern(IEnumerable filters, cha private static string CreateRegexPattern(IEnumerable filters, char escapeSymbol, Func filterPredicate = null) { IEnumerable filteredFilters = filterPredicate != null ? filters.Where(filterPredicate) : filters; +#pragma warning disable IDE0057 // Use range operator IEnumerable regexPatterns = filteredFilters.Select(x => $"{escapeSymbol}{WildcardToRegex(x.Substring(1, x.IndexOf(']') - 1)).Trim('^', '$')}{escapeSymbol}"); +#pragma warning restore IDE0057 // Use range operator return string.Join("|", regexPatterns); } diff --git a/src/coverlet.core/Instrumentation/CecilAssemblyResolver.cs b/src/coverlet.core/Instrumentation/CecilAssemblyResolver.cs index 649b6c369..ecef745e2 100644 --- a/src/coverlet.core/Instrumentation/CecilAssemblyResolver.cs +++ b/src/coverlet.core/Instrumentation/CecilAssemblyResolver.cs @@ -5,12 +5,12 @@ using System.Collections.Generic; using System.IO; using System.Linq; +using System.Text.Json; using Coverlet.Core.Abstractions; using Coverlet.Core.Exceptions; using Microsoft.Extensions.DependencyModel; using Microsoft.Extensions.DependencyModel.Resolution; using Mono.Cecil; -using Newtonsoft.Json.Linq; using NuGet.Versioning; namespace Coverlet.Core.Instrumentation @@ -296,29 +296,32 @@ public RuntimeConfigurationReader(string runtimeConfigFile) { string jsonString = File.ReadAllText(_runtimeConfigFile); - var jsonLoadSettings = new JsonLoadSettings() + var documentOptions = new JsonDocumentOptions { - CommentHandling = CommentHandling.Ignore + CommentHandling = JsonCommentHandling.Skip }; - var configuration = JObject.Parse(jsonString, jsonLoadSettings); + using var configuration = JsonDocument.Parse(jsonString, documentOptions); - JToken rootElement = configuration.Root; - JToken runtimeOptionsElement = rootElement["runtimeOptions"]; + JsonElement rootElement = configuration.RootElement; + JsonElement runtimeOptionsElement = rootElement.GetProperty("runtimeOptions"); - if (runtimeOptionsElement?["framework"] != null) + if (runtimeOptionsElement.TryGetProperty("framework", out JsonElement frameworkElement)) { - return [(runtimeOptionsElement["framework"]["name"]?.Value(), runtimeOptionsElement["framework"]["version"]?.Value())]; + return new List<(string, string)> + { + (runtimeOptionsElement.GetProperty("framework").GetProperty("name").GetString(), runtimeOptionsElement.GetProperty("framework").GetProperty("version").GetString()) + }; } - if (runtimeOptionsElement?["frameworks"] != null) + if (runtimeOptionsElement.TryGetProperty("frameworks", out JsonElement frameworksElement)) { - return runtimeOptionsElement["frameworks"].Select(x => (x["name"]?.Value(), x["version"]?.Value())).ToList(); + return frameworksElement.EnumerateArray().Select(x => (x.GetProperty("name").GetString(), x.GetProperty("version").GetString())).ToList(); } - if (runtimeOptionsElement?["includedFrameworks"] != null) + if (runtimeOptionsElement.TryGetProperty("includedFrameworks", out JsonElement runtimeoptionselement)) { - return runtimeOptionsElement["includedFrameworks"].Select(x => (x["name"]?.Value(), x["version"]?.Value())).ToList(); + return runtimeoptionselement.EnumerateArray().Select(x => (x.GetProperty("name").GetString(), x.GetProperty("version").GetString())).ToList(); } throw new InvalidOperationException($"Unable to read runtime configuration from {_runtimeConfigFile}."); diff --git a/src/coverlet.core/Reporters/JsonReporter.cs b/src/coverlet.core/Reporters/JsonReporter.cs index e684e8c8a..62be3373a 100644 --- a/src/coverlet.core/Reporters/JsonReporter.cs +++ b/src/coverlet.core/Reporters/JsonReporter.cs @@ -1,8 +1,9 @@ // Copyright (c) Toni Solarin-Sodara // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Text.Encodings.Web; +using System.Text.Json; using Coverlet.Core.Abstractions; -using Newtonsoft.Json; namespace Coverlet.Core.Reporters { @@ -16,7 +17,13 @@ internal class JsonReporter : IReporter public string Report(CoverageResult result, ISourceRootTranslator _) { - return JsonConvert.SerializeObject(result.Modules, Formatting.Indented); + var options = new JsonSerializerOptions + { + Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping, + IncludeFields = true, + WriteIndented = true, + }; + return JsonSerializer.Serialize(result.Modules, options); } } } diff --git a/src/coverlet.core/coverlet.core.csproj b/src/coverlet.core/coverlet.core.csproj index f3e16e3f1..bce9fe7c9 100644 --- a/src/coverlet.core/coverlet.core.csproj +++ b/src/coverlet.core/coverlet.core.csproj @@ -1,25 +1,30 @@ - + Library - netstandard2.0 + netstandard2.0;net8.0 false + $(NoWarn);IDE0057 - - - - + + + + - - + + + + + + + + + - - - diff --git a/src/coverlet.msbuild.tasks/coverlet.msbuild.targets b/src/coverlet.msbuild.tasks/coverlet.msbuild.targets index e8bbfac20..0defe0138 100644 --- a/src/coverlet.msbuild.tasks/coverlet.msbuild.targets +++ b/src/coverlet.msbuild.tasks/coverlet.msbuild.targets @@ -6,7 +6,7 @@ <_CoverletSdkNETCoreSdkVersion>$(NETCoreSdkVersion) <_CoverletSdkNETCoreSdkVersion Condition="$(_CoverletSdkNETCoreSdkVersion.Contains('-'))">$(_CoverletSdkNETCoreSdkVersion.Split('-')[0]) - <_CoverletSdkMinVersionWithDependencyTarget>6.0.100 + <_CoverletSdkMinVersionWithDependencyTarget>8.0.100 <_CoverletSourceRootTargetName>CoverletGetPathMap <_CoverletSourceRootTargetName Condition="'$([System.Version]::Parse($(_CoverletSdkNETCoreSdkVersion)).CompareTo($([System.Version]::Parse($(_CoverletSdkMinVersionWithDependencyTarget)))))' >= '0' ">InitializeSourceRootMappedPaths diff --git a/test/coverlet.core.tests/Coverage/CoverageTests.cs b/test/coverlet.core.tests/Coverage/CoverageTests.cs index 86a306269..f99dbb4e6 100644 --- a/test/coverlet.core.tests/Coverage/CoverageTests.cs +++ b/test/coverlet.core.tests/Coverage/CoverageTests.cs @@ -1,16 +1,17 @@ -// Copyright (c) Toni Solarin-Sodara +// Copyright (c) Toni Solarin-Sodara // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Collections; using System.Collections.Generic; using System.IO; +using System.Text.Encodings.Web; +using System.Text.Json; +using System.Text.Json.Serialization; using Coverlet.Core.Abstractions; using Coverlet.Core.Helpers; using Coverlet.Core.Instrumentation; using Coverlet.Core.Symbols; using Moq; -using Newtonsoft.Json; using Xunit; namespace Coverlet.Core.Tests @@ -18,6 +19,16 @@ namespace Coverlet.Core.Tests public partial class CoverageTests { private readonly Mock _mockLogger = new(); + readonly JsonSerializerOptions _options = new() + { + Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping, + IncludeFields = true, + WriteIndented = true, + Converters = + { + new BranchDictionaryConverterFactory() + } + }; [Fact] public void TestCoverage() @@ -90,7 +101,7 @@ public void TestCoverageWithTestAssembly() new SourceRootTranslator(module, _mockLogger.Object, new FileSystem(), new AssemblyAdapter()), new CecilSymbolHelper()); coverage.PrepareModules(); - string result = JsonConvert.SerializeObject(coverage.GetCoverageResult(), Formatting.Indented, new BranchDictionaryConverter()); + string result = JsonSerializer.Serialize(coverage.GetCoverageResult(), _options); Assert.Contains("coverlet.core.tests.dll", result); @@ -129,7 +140,7 @@ public void TestCoverageMergeWithParameter() var coverage = new Coverage(Path.Combine(directory.FullName, Path.GetFileName(module)), parameters, _mockLogger.Object, instrumentationHelper, new FileSystem(), new SourceRootTranslator(_mockLogger.Object, new FileSystem()), new CecilSymbolHelper()); coverage.PrepareModules(); - string result = JsonConvert.SerializeObject(coverage.GetCoverageResult(), Formatting.Indented, new BranchDictionaryConverter()); + string result = JsonSerializer.Serialize(coverage.GetCoverageResult(), _options); Assert.Contains("DeepThought.cs", result); @@ -170,7 +181,7 @@ public void TestCoverageMergeWithWrongParameter() var coverage = new Coverage(Path.Combine(directory.FullName, Path.GetFileName(module)), parameters, _mockLogger.Object, instrumentationHelper, new FileSystem(), new SourceRootTranslator(_mockLogger.Object, new FileSystem()), new CecilSymbolHelper()); coverage.PrepareModules(); - JsonConvert.SerializeObject(coverage.GetCoverageResult()); + string result = JsonSerializer.Serialize(coverage.GetCoverageResult(), _options); _mockLogger.Verify(l => l.LogInformation(It.Is(v => v.Equals("MergeWith: file 'FileDoesNotExist.json' does not exist.")), It.IsAny()), Times.Once); @@ -220,36 +231,43 @@ public void GetSourceLinkUrl_ReturnsOriginalDocument_WhenNoMatch() } } - public class BranchDictionaryConverter : JsonConverter + public class BranchDictionaryConverterFactory : JsonConverterFactory { - public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) + public override bool CanConvert(Type typeToConvert) { - Type type = value.GetType(); - var keys = (IEnumerable)type.GetProperty("Keys")?.GetValue(value, null); - var values = (IEnumerable)type.GetProperty("Values")?.GetValue(value, null); - IEnumerator valueEnumerator = values.GetEnumerator(); - - writer.WriteStartArray(); - foreach (object key in keys) - { - valueEnumerator.MoveNext(); - - writer.WriteStartArray(); - serializer.Serialize(writer, key); - serializer.Serialize(writer, valueEnumerator.Current); - writer.WriteEndArray(); - } - writer.WriteEndArray(); + return typeof(Dictionary).IsAssignableFrom(typeToConvert); } - - public override object ReadJson(JsonReader reader, Type objectType, object existingValue, Newtonsoft.Json.JsonSerializer serializer) + public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options) { - throw new NotImplementedException(); + Type[] genericArgs = typeToConvert.GetGenericArguments(); + Type keyType = genericArgs[0]; + Type valueType = genericArgs[1]; + + JsonConverter converter = (JsonConverter)Activator.CreateInstance( + typeof(BranchDictionaryConverter<,>).MakeGenericType(new Type[] { keyType, valueType })); + + return converter; } + } +} - public override bool CanConvert(Type objectType) +public class BranchDictionaryConverter : JsonConverter> +{ + public override Dictionary Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + throw new NotImplementedException(); + } + + public override void Write(Utf8JsonWriter writer, Dictionary value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + + foreach (KeyValuePair pair in value) { - return typeof(Dictionary).IsAssignableFrom(objectType); + writer.WritePropertyName(pair.Key.ToString()); + JsonSerializer.Serialize(writer, pair.Value, options); } + + writer.WriteEndObject(); } } diff --git a/test/coverlet.core.tests/coverlet.core.tests.csproj b/test/coverlet.core.tests/coverlet.core.tests.csproj index ff6c28869..96a1fd922 100644 --- a/test/coverlet.core.tests/coverlet.core.tests.csproj +++ b/test/coverlet.core.tests/coverlet.core.tests.csproj @@ -1,4 +1,4 @@ - + diff --git a/test/coverlet.integration.determisticbuild/coverlet.integration.determisticbuild.csproj b/test/coverlet.integration.determisticbuild/coverlet.integration.determisticbuild.csproj index 38d1c8820..2fbb5f2b1 100644 --- a/test/coverlet.integration.determisticbuild/coverlet.integration.determisticbuild.csproj +++ b/test/coverlet.integration.determisticbuild/coverlet.integration.determisticbuild.csproj @@ -3,7 +3,7 @@ - net6.0 + net8.0 false coverletsample.integration.determisticbuild NU1604;NU1701 diff --git a/test/coverlet.integration.template/nuget.config b/test/coverlet.integration.template/nuget.config index fbcef1011..765346e53 100644 --- a/test/coverlet.integration.template/nuget.config +++ b/test/coverlet.integration.template/nuget.config @@ -2,6 +2,6 @@ - + diff --git a/test/coverlet.integration.tests/DeterministicBuild.cs b/test/coverlet.integration.tests/DeterministicBuild.cs index 9c8a181db..e04d40428 100644 --- a/test/coverlet.integration.tests/DeterministicBuild.cs +++ b/test/coverlet.integration.tests/DeterministicBuild.cs @@ -30,7 +30,6 @@ public class DeterministicBuild : BaseTest, IDisposable public DeterministicBuild(ITestOutputHelper output) { _buildConfiguration = TestUtils.GetAssemblyBuildConfiguration().ToString(); - //_buildTargetFramework = TestUtils.GetAssemblyTargetFramework(); _output = output; _type = output.GetType(); _testMember = _type.GetField("test", BindingFlags.Instance | BindingFlags.NonPublic); @@ -38,7 +37,10 @@ public DeterministicBuild(ITestOutputHelper output) private void CreateDeterministicTestPropsFile() { - var deterministicTestProps = new XDocument(); + string propsFile = Path.Combine(_testProjectPath, PropsFileName); + File.Delete(propsFile); + + XDocument deterministicTestProps = new(); deterministicTestProps.Add( new XElement("Project", new XElement("PropertyGroup", @@ -47,7 +49,7 @@ private void CreateDeterministicTestPropsFile() _testProjectTfm = XElement.Load(Path.Combine(_testProjectPath, "coverlet.integration.determisticbuild.csproj"))!. Descendants("PropertyGroup")!.Single().Element("TargetFramework")!.Value; - deterministicTestProps.Save(Path.Combine(_testProjectPath, PropsFileName)); + deterministicTestProps.Save(Path.Combine(propsFile)); } private protected void AssertCoverage(string standardOutput = "", bool checkDeterministicReport = true) diff --git a/test/coverlet.integration.tests/DotnetTool.cs b/test/coverlet.integration.tests/DotnetTool.cs index 91e989f02..c37e1156d 100644 --- a/test/coverlet.integration.tests/DotnetTool.cs +++ b/test/coverlet.integration.tests/DotnetTool.cs @@ -1,4 +1,4 @@ -// Copyright (c) Toni Solarin-Sodara +// Copyright (c) Toni Solarin-Sodara // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System.IO; diff --git a/test/coverlet.integration.tests/coverlet.integration.tests.csproj b/test/coverlet.integration.tests/coverlet.integration.tests.csproj index 4c8cc9c50..e08143035 100644 --- a/test/coverlet.integration.tests/coverlet.integration.tests.csproj +++ b/test/coverlet.integration.tests/coverlet.integration.tests.csproj @@ -17,13 +17,12 @@ + all runtime; build; native; contentfiles; analyzers - - diff --git a/test/coverlet.msbuild.tasks.tests/coverlet.msbuild.tasks.tests.csproj b/test/coverlet.msbuild.tasks.tests/coverlet.msbuild.tasks.tests.csproj index f363d52ac..8cb949dee 100644 --- a/test/coverlet.msbuild.tasks.tests/coverlet.msbuild.tasks.tests.csproj +++ b/test/coverlet.msbuild.tasks.tests/coverlet.msbuild.tasks.tests.csproj @@ -20,7 +20,7 @@ - +