Implement FileStreamResultAssertions. (+ nicer documentation comments)

Author: faddiv

src/FluentAssertions.AspNetCore.Mvc/ActionResultAssertions.cs

@@ -1,6 +1,7 @@
 using FluentAssertions.Execution;
 using FluentAssertions.Primitives;
 using Microsoft.AspNetCore.Mvc;
+using System;
 using System.Diagnostics;
 
 namespace FluentAssertions.AspNetCore.Mvc
@@ -108,15 +109,15 @@ public FileResultAssertions BeFileResult(string reason, params object[] reasonAr
         }
 
         /// <summary>
-        /// Asserts that the subject is an <see cref="FileResult"/>.
+        /// Asserts that the subject is an <see cref="FileContentResult"/>.
         /// </summary>
         public FileContentResultAssertions BeFileContentResult()
         {
             return BeFileContentResult(string.Empty, null);
         }
 
         /// <summary>
-        /// Asserts that the subject is an <see cref="FileResult"/>.
+        /// Asserts that the subject is an <see cref="FileContentResult"/>.
         /// </summary>
         public FileContentResultAssertions BeFileContentResult(string reason, params object[] reasonArgs)
         {
@@ -128,6 +129,28 @@ public FileContentResultAssertions BeFileContentResult(string reason, params obj
             return new FileContentResultAssertions(Subject as FileContentResult);
         }
 
+        /// <summary>
+        /// Asserts that the subject is an <see cref="FileStreamResult"/>.
+        /// </summary>
+        internal FileStreamResultAssertions BeFileStreamResult()
+        {
+            return BeFileStreamResult(string.Empty, null);
+
+        }
+
+        /// <summary>
+        /// Asserts that the subject is an <see cref="FileStreamResult"/>.
+        /// </summary>
+        internal FileStreamResultAssertions BeFileStreamResult(string reason, params object[] reasonArgs)
+        {
+            Execute.Assertion
+                .BecauseOf(reason, reasonArgs)
+                .ForCondition(Subject is FileStreamResult)
+                .FailWith(Constants.CommonFailMessage, typeof(FileStreamResult).Name, Subject.GetType().Name);
+
+            return new FileStreamResultAssertions(Subject as FileStreamResult);
+        }
+
         /// <summary>
         /// Asserts that the subject is an <see cref="JsonResult"/>.
         /// </summary>

src/FluentAssertions.AspNetCore.Mvc/FileContentResultAssertions.cs

@@ -1,6 +1,7 @@
 using FluentAssertions.Execution;
 using Microsoft.AspNetCore.Mvc;
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 
 namespace FluentAssertions.AspNetCore.Mvc
 {
@@ -19,6 +20,17 @@ public FileContentResultAssertions(FileContentResult fileResult)
 
         #endregion
 
+        #region Public Properties
+
+        /// <summary>
+        ///     The <see cref="FileContentResult.FileContents">FileContents</see> on the <see cref="FileContentResult"/>.
+        /// </summary>
+        [SuppressMessage("Performance", "CA1819:Properties should not return arrays",
+            Justification = "It needs to return the same instance as FileContentResult")]
+        public byte[] FileContents => FileContentResultSubject.FileContents;
+
+        #endregion Private Properties
+
         #region Private Properties
 
         private FileContentResult FileContentResultSubject => (FileContentResult)Subject;

src/FluentAssertions.AspNetCore.Mvc/FileStreamResultAssertions.cs

@@ -0,0 +1,39 @@
+using FluentAssertions.Execution;
+using Microsoft.AspNetCore.Mvc;
+using System.Diagnostics;
+using System.IO;
+
+namespace FluentAssertions.AspNetCore.Mvc
+{
+    /// <summary>
+    ///     Contains a number of methods to assert that a <see cref="FileStreamResult" /> is in the expected state.
+    /// </summary>>
+    [DebuggerNonUserCode]
+    public class FileStreamResultAssertions : FileResultAssertions
+    {
+        #region Public Constructors
+
+        public FileStreamResultAssertions(FileStreamResult fileResult) 
+            : base(fileResult)
+        {
+        }
+
+        #endregion
+
+        #region Public Properties
+
+        /// <summary>
+        ///     The <see cref="FileStreamResult.FileStream">FileStream</see> on the <see cref="FileStreamResult"/>
+        /// </summary>
+        public Stream FileStream => FileStreamResultSubject.FileStream;
+
+        #endregion
+
+        #region Private Properties
+
+        private FileStreamResult FileStreamResultSubject => (FileStreamResult)Subject;
+
+        #endregion Private Properties
+
+    }
+}

src/FluentAssertions.AspNetCore.Mvc/JsonResultAssertions.cs

@@ -29,12 +29,12 @@ public JsonResultAssertions(JsonResult subject) : base(subject)
         #region Public Properties
 
         /// <summary>
-        ///     The serializer settings of the JsonResult.
+        ///     The <see cref="JsonResult.SerializerSettings"/> on the <see cref="JsonResult"/>.
         /// </summary>
         public JsonSerializerSettings SerializerSettings => JsonResultSubject.SerializerSettings;
 
         /// <summary>
-        ///     The value on the JsonResult
+        ///     The <see cref="JsonResult.Value">Value</see> on the <see cref="JsonResult"/>.
         /// </summary>
         public object Value => JsonResultSubject.Value;
 

tests/FluentAssertions.AspNetCore.Mvc.Tests/ActionResultAssertions_Tests.cs

@@ -1,3 +1,4 @@
+using FluentAssertions.AspNetCore.Mvc.Tests.Helpers;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Routing;
 using System;
@@ -48,7 +49,7 @@ public void BeEmpty_GivenNotEmpty_ShouldPass()
         [Fact]
         public void BeFileResult_GivenFileResult_ShouldPass()
         {
-            ActionResult result = new FileContentResult(Array.Empty<byte>(), "text/plain");
+            ActionResult result = TestDataGenerator.CreateFileContentResult();
 
             result.Should()
                 .BeFileResult();
@@ -67,7 +68,7 @@ public void BeFileResult_GivenNotFileResult_ShouldFail()
         [Fact]
         public void BeFileContentResult_GivenFileContentResult_ShouldPass()
         {
-            ActionResult result = new FileContentResult(Array.Empty<byte>(), "text/plain");
+            ActionResult result = TestDataGenerator.CreateFileContentResult();
 
             result.Should()
                 .BeFileContentResult();
@@ -83,6 +84,25 @@ public void BeFileContentResult_GivenNotFileContentResult_ShouldFail()
                 .WithMessage("Expected ActionResult to be \"FileContentResult\", but found \"ViewResult\"");
         }
 
+        [Fact]
+        public void BeFileStreamResult_GivenFileStreamResult_ShouldPass()
+        {
+            ActionResult result = TestDataGenerator.CreateFileStreamResult();
+
+            result.Should()
+                .BeFileStreamResult();
+        }
+
+        [Fact]
+        public void BeFileStreamResult_GivenNotFileStreamResult_ShouldFail()
+        {
+            ActionResult result = new ViewResult();
+            Action a = () => result.Should().BeFileStreamResult();
+
+            a.Should().Throw<Exception>()
+                .WithMessage("Expected ActionResult to be \"FileStreamResult\", but found \"ViewResult\"");
+        }
+
         [Fact]
         public void BeJson_GivenJson_ShouldPass()
         {

tests/FluentAssertions.AspNetCore.Mvc.Tests/FileContentResultAssertions_Tests.cs

@@ -1,4 +1,5 @@
-using Microsoft.AspNetCore.Mvc;
+using FluentAssertions.AspNetCore.Mvc.Tests.Helpers;
+using Microsoft.AspNetCore.Mvc;
 using System;
 using System.Text;
 using Xunit;
@@ -8,11 +9,11 @@ namespace FluentAssertions.AspNetCore.Mvc.Tests
     public class FileContentResultAssertions_Tests
     {
         [Fact]
-        public void WithContentType_GivenExpectedValue_ShouldPass()
+        public void WithFileContents_GivenExpectedValue_ShouldPass()
         {
-            var actualBytes = Encoding.ASCII.GetBytes("Test 1");
-            var expectedBytes = Encoding.ASCII.GetBytes("Test 1");
-            ActionResult result = new FileContentResult(actualBytes, "text/plain");
+            var actualBytes = TestDataGenerator.CreateBytes("Test 1");
+            var expectedBytes = TestDataGenerator.CreateBytes("Test 1");
+            ActionResult result = TestDataGenerator.CreateFileContentResult(actualBytes);
 
             result.Should()
                 .BeFileContentResult()
@@ -26,12 +27,12 @@ public void WithContentType_GivenExpectedValue_ShouldPass()
         [InlineData(
             "Test 1a", "Test 2a"
             , "Expected \"FileContentResult.FileContents[5]\" to be 0x32, but found 0x31.")]
-        public void WithContentType_GivenUnexpectedValue_ShouldFail(
+        public void WithFileContents_GivenUnexpectedValue_ShouldFail(
             string actual, string expected, string failureMessage)
         {
-            var actualBytes = actual != null ? Encoding.ASCII.GetBytes(actual) : null;
-            var expectedBytes = expected != null ? Encoding.ASCII.GetBytes(expected) : null;
-            ActionResult result = new FileContentResult(actualBytes, "text/plain");
+            var actualBytes = TestDataGenerator.CreateBytes(actual);
+            var expectedBytes = TestDataGenerator.CreateBytes(expected);
+            ActionResult result = TestDataGenerator.CreateFileContentResult(actualBytes);
 
             Action a = () => result.Should()
                 .BeFileContentResult()
@@ -41,5 +42,14 @@ public void WithContentType_GivenUnexpectedValue_ShouldFail(
                 .WithMessage(failureMessage);
         }
 
+        [Fact]
+        public void FileContents_GivenFileContentResult_ShouldHaveTheSameFileContents()
+        {
+            var result = TestDataGenerator.CreateFileContentResult();
+
+            result.Should()
+                .BeFileContentResult()
+                .FileContents.Should().BeSameAs(result.FileContents);
+        }
     }
 }

tests/FluentAssertions.AspNetCore.Mvc.Tests/FileStreamResultAssertions_Tests.cs

@@ -0,0 +1,23 @@
+using FluentAssertions.AspNetCore.Mvc.Tests.Helpers;
+using Microsoft.AspNetCore.Mvc;
+using System;
+using System.IO;
+using System.Text;
+using Xunit;
+
+namespace FluentAssertions.AspNetCore.Mvc.Tests
+{
+    public class FileStreamResultAssertions_Tests
+    {
+        [Fact]
+        public void FileStream_GivenFileStreamResult_ShouldHaveTheSameStream()
+        {
+            var result = TestDataGenerator.CreateFileStreamResult();
+
+            result.Should()
+                .BeFileStreamResult()
+                .FileStream
+                .Should().BeSameAs(result.FileStream);
+        }
+    }
+}

tests/FluentAssertions.AspNetCore.Mvc.Tests/Helpers/TestDataGenerator.cs

@@ -0,0 +1,44 @@
+using Microsoft.AspNetCore.Mvc;
+using System.IO;
+using System.Text;
+
+namespace FluentAssertions.AspNetCore.Mvc.Tests.Helpers
+{
+    public static class TestDataGenerator
+    {
+        public static FileContentResult CreateFileContentResult(string content = "")
+        {
+            return CreateFileContentResult(CreateBytes(content));
+        }
+
+        public static FileContentResult CreateFileContentResult(byte[] fileContents)
+        {
+            return new FileContentResult(fileContents, "text/plain");
+        }
+
+        public static FileStreamResult CreateFileStreamResult(string content = "")
+        {
+            return CreateFileStreamResult(CreateStream(content));
+        }
+
+        public static FileStreamResult CreateFileStreamResult(Stream stream)
+        {
+            return new FileStreamResult(stream, "text/plain");
+        }
+
+        public static Stream CreateStream(string content = "")
+        {
+            var memoryStream = new MemoryStream();
+            var bytes = CreateBytes(content);
+            memoryStream.Write(bytes, 0, bytes.Length);
+            memoryStream.Seek(0, SeekOrigin.Begin);
+            return memoryStream;
+        }
+
+        public static byte[] CreateBytes(string content = "")
+        {
+            var bytes = Encoding.UTF8.GetBytes(content);
+            return bytes;
+        }
+    }
+}