Convert a stream to a byte array: retarget net10.0, add ReadExactly, CopyTo and the reverse direction (#2219)

Retargets both projects from net7.0 to net10.0 and moves the packages to current
stable versions (BenchmarkDotNet 0.15.8, Microsoft.NET.Test.Sdk 18.10.1, xunit 2.9.3,
xunit.runner.visualstudio 4.0.0, coverlet.collector 10.0.1).

Adds UseReadExactly() and UseCopyTo() to ConvertStreamToByteArray, which are the two
calls the article now recommends, and UseMemoryStreamConstructor() and
UseWritableMemoryStream() for the reverse direction. Four xunit tests cover them, and
UseReadExactly and UseCopyTo also join ConvertMethodsBenchmark so the published
benchmark measures the recommended methods.

Build is clean and tests run 9 of 9 on SDK 10.0.302.

Author: vladimir-pecanac-main

csharp-intermediate-topics/HowToConvertAStreamToAByteArray/HowToConvertAStreamToAByteArray/ConvertMethodsBenchmark.cs

@@ -18,6 +18,20 @@ public void Setup()
            _convertStreamToByteArray = new ConvertStreamToByteArray();
         }
 
+        [Benchmark]
+        public void UseReadExactly()
+        {
+            using var _benchmarkStream = new FileStream(_sampleFilePath, FileMode.Open, FileAccess.Read);
+            _convertStreamToByteArray.UseReadExactly(_benchmarkStream);
+        }
+
+        [Benchmark]
+        public void UseCopyTo()
+        {
+            using var _benchmarkStream = new FileStream(_sampleFilePath, FileMode.Open, FileAccess.Read);
+            _convertStreamToByteArray.UseCopyTo(_benchmarkStream);
+        }
+
         [Benchmark]
         public void UseStreamDotReadMethod()
         {

csharp-intermediate-topics/HowToConvertAStreamToAByteArray/HowToConvertAStreamToAByteArray/ConvertStreamToByteArray.cs

@@ -2,6 +2,23 @@
 {
     public class ConvertStreamToByteArray
     {
+        public byte[] UseReadExactly(Stream stream)
+        {
+            var bytes = new byte[stream.Length];
+            stream.ReadExactly(bytes);
+
+            return bytes;
+        }
+
+        public byte[] UseCopyTo(Stream stream)
+        {
+            using var memoryStream = new MemoryStream();
+            stream.CopyTo(memoryStream);
+
+            return memoryStream.ToArray();
+        }
+
+
         public byte[] UseStreamDotReadMethod(Stream stream)
         {
             byte[] bytes;
@@ -73,5 +90,19 @@ public byte[] UseBufferedStream(Stream stream)
 
             return bytes;
         }
+
+        public Stream UseMemoryStreamConstructor(byte[] bytes)
+        {
+            return new MemoryStream(bytes);
+        }
+
+        public Stream UseWritableMemoryStream(byte[] bytes)
+        {
+            var stream = new MemoryStream();
+            stream.Write(bytes, 0, bytes.Length);
+            stream.Position = 0;
+
+            return stream;
+        }
     }
 }

csharp-intermediate-topics/HowToConvertAStreamToAByteArray/HowToConvertAStreamToAByteArray/HowToConvertAStreamToAByteArray.csproj

@@ -2,13 +2,13 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net10.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>disable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="BenchmarkDotNet" Version="0.13.5" />
+    <PackageReference Include="BenchmarkDotNet" Version="0.15.8" />
   </ItemGroup>
 
 </Project>

csharp-intermediate-topics/HowToConvertAStreamToAByteArray/Tests/ConvertMethodsTest.cs

@@ -57,5 +57,47 @@ public void GivenAStream_WhenConvertingWithStreamReader_ThenReturnsAByteArray()
 
             Assert.Equal(_expected, result);
         }
+
+        [Fact]
+        public void GivenAStream_WhenConvertingWithReadExactly_ThenReturnsAByteArray()
+        {
+            var result = _converter.UseReadExactly(_stream);
+
+            Assert.Equal(_expected, result);
+        }
+
+        [Fact]
+        public void GivenAStream_WhenConvertingWithCopyTo_ThenReturnsAByteArray()
+        {
+            var result = _converter.UseCopyTo(_stream);
+
+            Assert.Equal(_expected, result);
+        }
+
+        [Fact]
+        public void GivenAByteArray_WhenWrappingInAMemoryStreamConstructor_ThenStreamReadsBackTheSameBytes()
+        {
+            var result = _converter.UseMemoryStreamConstructor(_expected);
+
+            Assert.Equal(_expected.Length, result.Length);
+            Assert.Equal(_expected, ReadToEnd(result));
+        }
+
+        [Fact]
+        public void GivenAByteArray_WhenWritingToAnExpandableMemoryStream_ThenStreamReadsBackTheSameBytes()
+        {
+            var result = _converter.UseWritableMemoryStream(_expected);
+
+            Assert.Equal(_expected.Length, result.Length);
+            Assert.Equal(_expected, ReadToEnd(result));
+        }
+
+        private static byte[] ReadToEnd(Stream stream)
+        {
+            using var memoryStream = new MemoryStream();
+            stream.CopyTo(memoryStream);
+
+            return memoryStream.ToArray();
+        }
     }
 }

csharp-intermediate-topics/HowToConvertAStreamToAByteArray/Tests/Tests.csproj

@@ -1,21 +1,21 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net10.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>disable</Nullable>
 
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
-    <PackageReference Include="xunit" Version="2.4.2" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.10.1" />
+    <PackageReference Include="xunit" Version="2.9.3" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="4.0.0">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="3.1.2">
+    <PackageReference Include="coverlet.collector" Version="10.0.1">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>