Merge branch 'release/6.0.0'

Author: Jericho

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "cake.tool": {
-      "version": "2.1.0",
+      "version": "2.2.0",
       "commands": [
         "dotnet-cake"
       ]

.gitignore

@@ -330,6 +330,7 @@ __pycache__/
 *.pyc
 
 # Cake
+.cake/**
 tools/**
 BuildArtifacts/
 

README.md

@@ -27,7 +27,9 @@ PM> Install-Package HttpMultipartParser
 
 ## .NET framework suport
 
-The parser was built for and tested on NET 4.6.1, NET 4,7,2 and NETSTANDARD 2.0. Versions 2.2.4 was the last version of HttpMultipartParser that supported older .NET platforms such as NET 4.5 and NETSTANDARD 1.3.
+The parser was built for and tested on .NET 4.8, .NET standard 2.1, .NET 5.0 and .NET 6.0.
+Version 5.1.0 was the last version that supported .NET 4.6.1, NET 4.7.2 and .NET standard 2.0.
+Version 2.2.4 was the last version that supported older .NET platforms such as .NET 4.5 and .NET standard 1.3.
 
 ## Usage
 

Source/HttpMultipartParser.Benchmark/HttpMultipartParser.Benchmark.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net5.0</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>

Source/HttpMultipartParser.UnitTests/HttpMultipartParser.UnitTests.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net461;net472;netcoreapp3.1;net5.0</TargetFrameworks>
+    <TargetFrameworks>net48;netcoreapp3.1;net5.0;net6.0</TargetFrameworks>
     <AssemblyName>HttpMultipartParser.UnitTests</AssemblyName>
     <RootNamespace>HttpMultipartParser.UnitTests</RootNamespace>
   </PropertyGroup>

Source/HttpMultipartParser.UnitTests/ParserScenarios/TinyData.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Text;
@@ -231,6 +232,50 @@ public async Task GetParameterValueReturnsNullIfNoParameterFoundAsync()
 			}
 		}
 
+		[Fact]
+		public void GetParameterValueReturnsCorrectlyWithoutComparisonType()
+		{
+			using (Stream stream = TestUtil.StringToStream(_testCase.Request, Encoding.UTF8))
+			{
+				var parser = MultipartFormDataParser.Parse(stream, "boundry", Encoding.UTF8);
+				Assert.NotNull(parser.GetParameterValue("text"));
+				Assert.Null(parser.GetParameterValue("Text"));
+			}
+		}
+
+		[Fact]
+		public async Task GetParameterValueReturnsCorrectlyWithoutComparisonTypeAsync()
+		{
+			using (Stream stream = TestUtil.StringToStream(_testCase.Request, Encoding.UTF8))
+			{
+				var parser = await MultipartFormDataParser.ParseAsync(stream, "boundry", Encoding.UTF8);
+				Assert.NotNull(parser.GetParameterValue("text"));
+				Assert.Null(parser.GetParameterValue("Text"));
+			}
+		}
+
+		[Fact]
+		public void GetParameterValueReturnsCorrectlyWithComparisonType()
+		{
+			using (Stream stream = TestUtil.StringToStream(_testCase.Request, Encoding.UTF8))
+			{
+				var parser = MultipartFormDataParser.Parse(stream, "boundry", Encoding.UTF8);
+				Assert.NotNull(parser.GetParameterValue("text",StringComparison.OrdinalIgnoreCase));
+				Assert.NotNull(parser.GetParameterValue("Text",StringComparison.OrdinalIgnoreCase));
+			}
+		}
+
+		[Fact]
+		public async Task GetParameterValueReturnsCorrectlyWithComparisonTypeAsync()
+		{
+			using (Stream stream = TestUtil.StringToStream(_testCase.Request, Encoding.UTF8))
+			{
+				var parser = await MultipartFormDataParser.ParseAsync(stream, "boundry", Encoding.UTF8);
+				Assert.NotNull(parser.GetParameterValue("text",StringComparison.OrdinalIgnoreCase));
+				Assert.NotNull(parser.GetParameterValue("Text",StringComparison.OrdinalIgnoreCase));
+			}
+		}
+
 		[Fact]
 		public void CanDetectBoundriesWithNewLineInNextBuffer()
 		{

Source/HttpMultipartParser/Extensions.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 
@@ -28,22 +29,24 @@ public static bool HasParameter(this IMultipartFormDataParser parser, string nam
 		/// </summary>
 		/// <param name="parser">The multipart form parser.</param>
 		/// <param name="name">The name of the parameter.</param>
+		/// <param name="comparisonType">One of the enumeration values that specifies how the strings will be compared.</param>
 		/// <returns>The value of the parameter.</returns>
-		public static string GetParameterValue(this IMultipartFormDataParser parser, string name)
+		public static string GetParameterValue(this IMultipartFormDataParser parser, string name, StringComparison comparisonType = StringComparison.Ordinal)
 		{
-			return parser.GetParameterValues(name).FirstOrDefault();
+			return parser.GetParameterValues(name, comparisonType).FirstOrDefault();
 		}
 
 		/// <summary>
 		/// Returns the values of a parameter or an empty enumerable if the parameter doesn't exist.
 		/// </summary>
 		/// <param name="parser">The multipart form parser.</param>
 		/// <param name="name">The name of the parameter.</param>
+		/// <param name="comparisonType">One of the enumeration values that specifies how the strings will be compared.</param>
 		/// <returns>The values of the parameter.</returns>
-		public static IEnumerable<string> GetParameterValues(this IMultipartFormDataParser parser, string name)
+		public static IEnumerable<string> GetParameterValues(this IMultipartFormDataParser parser, string name, StringComparison comparisonType = StringComparison.Ordinal)
 		{
 			return parser.Parameters
-				.Where(p => p.Name == name)
+				.Where(p => p.Name.Equals(name, comparisonType))
 				.Select(p => p.Data);
 		}
 	}

Source/HttpMultipartParser/HttpMultipartParser.csproj

@@ -1,7 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net461;net472;netstandard2.0;net5.0</TargetFrameworks>
+    <TargetFrameworks>net48;netstandard2.1;net5.0;net6.0</TargetFrameworks>
+    <LangVersion>preview</LangVersion>
     <PlatformTarget>anycpu</PlatformTarget>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <OutputType>Library</OutputType>
@@ -13,6 +14,8 @@
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -56,6 +59,10 @@
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="..\..\README.md" Pack="true" PackagePath="" />
+  </ItemGroup>
+
   <ItemGroup>
     <AdditionalFiles Include="$(SolutionDir)stylecop.json" Link="stylecop.json" />
   </ItemGroup>

appveyor.yml

@@ -36,7 +36,7 @@ branches:
 
 # Build cache
 cache:
-  - tools -> build.cake
+  - .cake -> build.cake
 
 # Environment configuration
 image:

build.cake

@@ -1,14 +1,15 @@
 // Install tools.
-#tool dotnet:?package=GitVersion.Tool&version=5.8.2
+#tool dotnet:?package=GitVersion.Tool&version=5.10.3
+#tool dotnet:?package=coveralls.net&version=4.0.0
 #tool nuget:?package=GitReleaseManager&version=0.13.0
-#tool nuget:?package=OpenCover&version=4.7.1221
-#tool nuget:?package=ReportGenerator&version=5.0.4
-#tool nuget:?package=coveralls.io&version=1.4.2
+#tool nuget:?package=ReportGenerator&version=5.1.9
 #tool nuget:?package=xunit.runner.console&version=2.4.1
+#tool nuget:?package=Codecov&version=1.13.0
 
 // Install addins.
 #addin nuget:?package=Cake.Coveralls&version=1.1.0
 #addin nuget:?package=Cake.Git&version=2.0.0
+#addin nuget:?package=Cake.Codecov&version=1.0.1
 
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -28,9 +29,24 @@ if (IsRunningOnUnix()) target = "Run-Unit-Tests";
 var libraryName = "HttpMultipartParser";
 var gitHubRepo = "Http-Multipart-Data-Parser";
 
-var testCoverageFilter = "+[HttpMultipartParser]* -[HttpMultipartParser]HttpMultipartParser.Properties.* -[HttpMultipartParser]HttpMultipartParser.Models.*";
-var testCoverageExcludeByAttribute = "*.ExcludeFromCodeCoverage*";
-var testCoverageExcludeByFile = "*/*Designer.cs;*/*AssemblyInfo.cs";
+var testCoverageFilters = new[]
+{
+	"+[HttpMultipartParser]*",
+	"-[HttpMultipartParser]HttpMultipartParser.Properties.*",
+	"-[HttpMultipartParser]HttpMultipartParser.Models.*",
+	"-[HttpMultipartParser]*System.Text.Json.SourceGeneration*"
+};
+var testCoverageExcludeAttributes = new[]
+{
+	"Obsolete",
+	"GeneratedCodeAttribute",
+	"CompilerGeneratedAttribute",
+	"ExcludeFromCodeCoverageAttribute"
+};
+var testCoverageExcludeFiles = new[]
+ {
+	"**/AssemblyInfo.cs"
+};
 
 var nuGetApiUrl = Argument<string>("NUGET_API_URL", EnvironmentVariable("NUGET_API_URL"));
 var nuGetApiKey = Argument<string>("NUGET_API_KEY", EnvironmentVariable("NUGET_API_KEY"));
@@ -43,6 +59,9 @@ var gitHubUserName = Argument<string>("GITHUB_USERNAME", EnvironmentVariable("GI
 var gitHubPassword = Argument<string>("GITHUB_PASSWORD", EnvironmentVariable("GITHUB_PASSWORD"));
 var gitHubRepoOwner = Argument<string>("GITHUB_REPOOWNER", EnvironmentVariable("GITHUB_REPOOWNER") ?? gitHubUserName);
 
+var coverallsToken = Argument<string>("COVERALLS_REPO_TOKEN", EnvironmentVariable("COVERALLS_REPO_TOKEN"));
+var codecovToken = Argument<string>("CODECOV_TOKEN", EnvironmentVariable("CODECOV_TOKEN"));
+
 var sourceFolder = "./Source/";
 var outputDir = "./artifacts/";
 var codeCoverageDir = $"{outputDir}CodeCoverage/";
@@ -72,7 +91,14 @@ var isBenchmarkProjectPresent = FileExists(benchmarkProject);
 // - when running unit tests on Ubuntu
 // - when calculating code coverage
 // FYI, this will cause an error if the source project and/or the unit test project are not configured to target this desired framework:
-var desiredFramework = IsRunningOnWindows() ? null : "net5.0";
+const string DefaultFramework = "net6.0";
+var desiredFramework = (
+		!IsRunningOnWindows() ||
+		target.Equals("Coverage", StringComparison.OrdinalIgnoreCase) ||
+		target.Equals("Run-Code-Coverage", StringComparison.OrdinalIgnoreCase) ||
+		target.Equals("Generate-Code-Coverage-Report", StringComparison.OrdinalIgnoreCase) ||
+		target.Equals("Upload-Coverage-Result", StringComparison.OrdinalIgnoreCase)
+	) ? DefaultFramework : null;
 
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -225,7 +251,7 @@ Task("Build")
 			AssemblyVersion = versionInfo.MajorMinorPatch,
 			FileVersion = versionInfo.MajorMinorPatch,
 			InformationalVersion = versionInfo.InformationalVersion,
-			ContinuousIntegrationBuild = !BuildSystem.IsLocalBuild
+			ContinuousIntegrationBuild = true
 		}
 	});
 });
@@ -247,26 +273,26 @@ Task("Run-Code-Coverage")
 	.IsDependentOn("Build")
 	.Does(() =>
 {
-	Action<ICakeContext> testAction = ctx => ctx.DotNetTest(unitTestsProject, new DotNetTestSettings
+	var testSettings = new DotNetTestSettings
 	{
 		NoBuild = true,
 		NoRestore = true,
 		Configuration = configuration,
-		Framework = desiredFramework
-	});
-
-	OpenCover(testAction,
-		$"{codeCoverageDir}coverage.xml",
-		new OpenCoverSettings
-		{
-			OldStyle = true,
-			MergeOutput = true,
-			ArgumentCustomization = args => args.Append("-returntargetcode")
-		}
-		.WithFilter(testCoverageFilter)
-		.ExcludeByAttribute(testCoverageExcludeByAttribute)
-		.ExcludeByFile(testCoverageExcludeByFile)
-	);
+		Framework = DefaultFramework,
+
+		// The following assumes that coverlet.msbuild has been added to the unit testing project
+		ArgumentCustomization = args => args
+			.Append("/p:CollectCoverage=true")
+			.Append("/p:CoverletOutputFormat=opencover")
+			.Append($"/p:CoverletOutput={MakeAbsolute(Directory(codeCoverageDir))}/coverage.xml")	// The name of the framework will be inserted between "coverage" and "xml". This is important to know when uploading the XML file to coveralls/codecov and when generating the HTML report
+			.Append($"/p:ExcludeByAttribute={string.Join("%2c", testCoverageExcludeAttributes)}")
+			.Append($"/p:ExcludeByFile={string.Join("%2c", testCoverageExcludeFiles)}")
+			.Append($"/p:Exclude={string.Join("%2c", testCoverageFilters.Where(filter => filter.StartsWith("-")).Select(filter => filter.TrimStart("-", StringComparison.OrdinalIgnoreCase)))}")
+			.Append($"/p:Include={string.Join("%2c", testCoverageFilters.Where(filter => filter.StartsWith("+")).Select(filter => filter.TrimStart("+", StringComparison.OrdinalIgnoreCase)))}")
+			.Append("/p:SkipAutoProps=true")
+    };
+
+    DotNetTest(unitTestsProject, testSettings);
 });
 
 Task("Upload-Coverage-Result")
@@ -275,7 +301,19 @@ Task("Upload-Coverage-Result")
 {
 	try
 	{
-		CoverallsIo($"{codeCoverageDir}coverage.xml");
+		CoverallsNet(new FilePath($"{codeCoverageDir}coverage.{DefaultFramework}.xml"), CoverallsNetReportType.OpenCover, new CoverallsNetSettings()
+		{
+			RepoToken = coverallsToken
+		});
+	}
+	catch (Exception e)
+	{
+		Warning(e.Message);
+	}
+
+	try
+	{
+		Codecov($"{codeCoverageDir}coverage.{DefaultFramework}.xml", codecovToken);
 	}
 	catch (Exception e)
 	{
@@ -288,7 +326,7 @@ Task("Generate-Code-Coverage-Report")
 	.Does(() =>
 {
 	ReportGenerator(
-		new FilePath($"{codeCoverageDir}coverage.xml"),
+		new FilePath($"{codeCoverageDir}coverage.{DefaultFramework}.xml"),
 		codeCoverageDir,
 		new ReportGeneratorSettings() {
 			ClassFilters = new[] { "*.UnitTests*" }
@@ -381,20 +419,19 @@ Task("Publish-MyGet")
 Task("Create-Release-Notes")
 	.Does(() =>
 {
-	var settings = new GitReleaseManagerCreateSettings
-	{
-		Name              = milestone,
-		Milestone         = milestone,
-		Prerelease        = false,
-		TargetCommitish   = "main"
-	};
-
 	if (string.IsNullOrEmpty(gitHubToken))
 	{
 		throw new InvalidOperationException("GitHub token was not provided.");
 	}
 
-	GitReleaseManagerCreate(gitHubToken, gitHubRepoOwner, gitHubRepo, settings);
+	GitReleaseManagerCreate(gitHubToken, gitHubRepoOwner, gitHubRepo, new GitReleaseManagerCreateSettings
+	{
+		Name            = milestone,
+		Milestone       = milestone,
+		Prerelease      = false,
+		TargetCommitish = "main",
+		Verbose         = true
+	});
 });
 
 Task("Publish-GitHub-Release")
@@ -410,7 +447,10 @@ Task("Publish-GitHub-Release")
 		throw new InvalidOperationException("GitHub token was not provided.");
 	}
 
-	GitReleaseManagerClose(gitHubToken, gitHubRepoOwner, gitHubRepo, milestone);
+	GitReleaseManagerClose(gitHubToken, gitHubRepoOwner, gitHubRepo, milestone, new GitReleaseManagerCloseMilestoneSettings
+	{
+		Verbose = true
+	});
 });
 
 Task("Generate-Benchmark-Report")