Implement PhysicalFileResultAssertions. Improve the rest assertions.

Author: faddiv

src/FluentAssertions.AspNetCore.Mvc/ActionResultAssertions.cs

@@ -98,6 +98,13 @@ public FileResultAssertions BeFileResult()
         /// <summary>
         /// Asserts that the subject is an <see cref="FileResult"/>.
         /// </summary>
+        /// <param name="reason">
+        /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
+        /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
+        /// </param>
+        /// <param name="reasonArgs">
+        /// Zero or more objects to format using the placeholders in <see cref="reason" />.
+        /// </param>
         public FileResultAssertions BeFileResult(string reason, params object[] reasonArgs)
         {
             Execute.Assertion
@@ -119,6 +126,13 @@ public FileContentResultAssertions BeFileContentResult()
         /// <summary>
         /// Asserts that the subject is an <see cref="FileContentResult"/>.
         /// </summary>
+        /// <param name="reason">
+        /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
+        /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
+        /// </param>
+        /// <param name="reasonArgs">
+        /// Zero or more objects to format using the placeholders in <see cref="reason" />.
+        /// </param>
         public FileContentResultAssertions BeFileContentResult(string reason, params object[] reasonArgs)
         {
             Execute.Assertion
@@ -141,6 +155,13 @@ internal FileStreamResultAssertions BeFileStreamResult()
         /// <summary>
         /// Asserts that the subject is an <see cref="FileStreamResult"/>.
         /// </summary>
+        /// <param name="reason">
+        /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
+        /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
+        /// </param>
+        /// <param name="reasonArgs">
+        /// Zero or more objects to format using the placeholders in <see cref="reason" />.
+        /// </param>
         internal FileStreamResultAssertions BeFileStreamResult(string reason, params object[] reasonArgs)
         {
             Execute.Assertion
@@ -179,6 +200,34 @@ public JsonResultAssertions BeJsonResult(string reason, params object[] reasonAr
             return new JsonResultAssertions(Subject as JsonResult);
         }
 
+        /// <summary>
+        /// Asserts that the subject is an <see cref="PhysicalFileResult"/>.
+        /// </summary>
+        internal PhysicalFileResultAssertions BePhysicalFileResult()
+        {
+            return BePhysicalFileResult(string.Empty, null);
+        }
+
+        /// <summary>
+        /// Asserts that the subject is an <see cref="FileStreamResult"/>.
+        /// </summary>
+        /// <param name="reason">
+        /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
+        /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
+        /// </param>
+        /// <param name="reasonArgs">
+        /// Zero or more objects to format using the placeholders in <see cref="reason" />.
+        /// </param>
+        internal PhysicalFileResultAssertions BePhysicalFileResult(string reason, params object[] reasonArgs)
+        {
+            Execute.Assertion
+                .BecauseOf(reason, reasonArgs)
+                .ForCondition(Subject is PhysicalFileResult)
+                .FailWith(Constants.CommonFailMessage, typeof(PhysicalFileResult).Name, Subject.GetType().Name);
+
+            return new PhysicalFileResultAssertions(Subject as PhysicalFileResult);
+        }
+
         /// <summary>
         /// Asserts that the subject is a <see cref="RedirectToRouteResult"/>.
         /// </summary>

src/FluentAssertions.AspNetCore.Mvc/FileContentResultAssertions.cs

@@ -40,7 +40,7 @@ public FileContentResultAssertions(FileContentResult fileResult)
         #region Public Methods
 
         /// <summary>
-        ///     Asserts that the file contents is the expected file contents.
+        ///     Asserts that the file contents is the expected bytes.
         /// </summary>
         /// <param name="expectedFileContents">The expected file contents.</param>
         /// <param name="reason">

src/FluentAssertions.AspNetCore.Mvc/FileResultAssertions.cs

@@ -31,7 +31,7 @@ public FileResultAssertions(FileResult fileResult)
         #region Public Methods
 
         /// <summary>
-        ///     Asserts that the content type is the expected content type.
+        ///     Asserts that the content type is the expected string.
         /// </summary>
         /// <param name="expectedContentType">The expected content type.</param>
         /// <param name="reason">
@@ -77,7 +77,7 @@ public FileResultAssertions WithEntityTag(EntityTagHeaderValue expectedEntityTag
         }
 
         /// <summary>
-        ///     Asserts that the file download name is the expected value.
+        ///     Asserts that the file download name is the expected string.
         /// </summary>
         /// <param name="expectedFileDownloadName">The expected file download name.</param>
         /// <param name="reason">
@@ -100,7 +100,7 @@ public FileResultAssertions WithFileDownloadName(string expectedFileDownloadName
         }
 
         /// <summary>
-        ///     Asserts that the last modified is the expected value.
+        ///     Asserts that the last modified is the expected DateTimeOffset.
         /// </summary>
         /// <param name="expectedFileDownloadName">The expected last modified value.</param>
         /// <param name="reason">

src/FluentAssertions.AspNetCore.Mvc/PhysicalFileResultAssertions.cs

@@ -0,0 +1,65 @@
+using FluentAssertions.Execution;
+using Microsoft.AspNetCore.Mvc;
+using System;
+using System.Diagnostics;
+
+namespace FluentAssertions.AspNetCore.Mvc
+{
+    /// <summary>
+    ///     Contains a number of methods to assert that a <see cref="PhysicalFileResult" /> is in the expected state.
+    /// </summary>
+    [DebuggerNonUserCode]
+    public class PhysicalFileResultAssertions : FileResultAssertions
+    {
+        #region Public Constructors
+
+        public PhysicalFileResultAssertions(PhysicalFileResult fileResult)
+            : base(fileResult)
+        {
+        }
+
+        #endregion
+
+        #region Public Properties
+
+        /// <summary>
+        ///     The <see cref="PhysicalFileResult.FileName">FileName</see> on the <see cref="PhysicalFileResult"/>
+        /// </summary>
+        public string FileName => PhysicalFileResultSubject.FileName;
+
+        #endregion Private Properties
+
+        #region Private Properties
+
+        private PhysicalFileResult PhysicalFileResultSubject => (PhysicalFileResult)Subject;
+
+        #endregion Private Properties
+
+        #region Public Methods
+
+        /// <summary>
+        ///     Asserts that the file name is the expected string.
+        /// </summary>
+        /// <param name="expectedFileName">The expected file name.</param>
+        /// <param name="reason">
+        ///     A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
+        ///     is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
+        /// </param>
+        /// <param name="reasonArgs">
+        ///     Zero or more objects to format using the placeholders in <see cref="reason" />.
+        /// </param>
+        public FileResultAssertions WithFileName(string expectedFileName, string reason = "",
+            params object[] reasonArgs)
+        {
+            var actualFileName = PhysicalFileResultSubject.FileName;
+
+            Execute.Assertion
+                .ForCondition(string.Equals(expectedFileName, actualFileName, StringComparison.OrdinalIgnoreCase))
+                .BecauseOf(reason, reasonArgs)
+                .FailWith(FailureMessages.CommonFailMessage, "PhysicalFileResult.FileName", expectedFileName, actualFileName);
+            return this;
+        }
+
+        #endregion
+    }
+}

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

@@ -103,6 +103,25 @@ public void BeFileStreamResult_GivenNotFileStreamResult_ShouldFail()
                 .WithMessage("Expected ActionResult to be \"FileStreamResult\", but found \"ViewResult\"");
         }
 
+        [Fact]
+        public void BePhysicalFileResult_GivenPhysicalFileResult_ShouldPass()
+        {
+            ActionResult result = TestDataGenerator.CreatePhysicalFileResult();
+
+            result.Should()
+                .BePhysicalFileResult();
+        }
+
+        [Fact]
+        public void BePhysicalFileResult_GivenNotPhysicalFileResult_ShouldFail()
+        {
+            ActionResult result = new ViewResult();
+            Action a = () => result.Should().BePhysicalFileResult();
+
+            a.Should().Throw<Exception>()
+                .WithMessage("Expected ActionResult to be \"PhysicalFileResult\", but found \"ViewResult\"");
+        }
+
         [Fact]
         public void BeJson_GivenJson_ShouldPass()
         {

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

@@ -1,7 +1,6 @@
 using FluentAssertions.AspNetCore.Mvc.Tests.Helpers;
 using Microsoft.AspNetCore.Mvc;
 using System;
-using System.Text;
 using Xunit;
 
 namespace FluentAssertions.AspNetCore.Mvc.Tests

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

@@ -1,9 +1,8 @@
-using FluentAssertions.Mvc.Tests.Helpers;
+using FluentAssertions.AspNetCore.Mvc.Tests.Helpers;
+using FluentAssertions.Mvc.Tests.Helpers;
 using Microsoft.AspNetCore.Mvc;
-using System;
-using System.Collections.Generic;
 using Microsoft.Net.Http.Headers;
-using System.Text;
+using System;
 using Xunit;
 
 namespace FluentAssertions.AspNetCore.Mvc.Tests
@@ -13,17 +12,19 @@ public class FileResultAssertions_Tests
         [Fact]
         public void WithContentType_GivenExpectedValue_ShouldPass()
         {
-            ActionResult result = new FileContentResult(Array.Empty<byte>(), "text/plain");
+            var actualValue = "text/plain";
+            var expectedValue = string.Copy(actualValue);
+            ActionResult result = TestDataGenerator.CreateFileContentResult(contentType: actualValue);
 
-            result.Should().BeFileResult().WithContentType("text/plain");
+            result.Should().BeFileResult().WithContentType(expectedValue);
         }
 
         [Fact]
         public void WithContentType_GivenUnexpected_ShouldFail()
         {
             var actualValue = "text/css";
             var expectedValue = "text/plain";
-            ActionResult result = new FileContentResult(Array.Empty<byte>(), actualValue);
+            ActionResult result = TestDataGenerator.CreateFileContentResult(contentType: actualValue);
             var failureMessage = FailureMessageHelper.Format(FailureMessages.CommonFailMessage, "FileResult.ContentType", expectedValue, actualValue);
 
             Action a = () => result.Should().BeFileResult().WithContentType(expectedValue);
@@ -35,10 +36,8 @@ public void WithContentType_GivenUnexpected_ShouldFail()
         [Fact]
         public void WithFileDownloadName_GivenExpectedValue_ShouldPass()
         {
-            ActionResult result = new FileContentResult(Array.Empty<byte>(), "text/plain")
-            {
-                FileDownloadName = "file.txt"
-            };
+            var result = TestDataGenerator.CreateFileContentResult();
+            result.FileDownloadName = "file.txt";
 
             result.Should().BeFileResult().WithFileDownloadName("file.txt");
         }
@@ -47,11 +46,9 @@ public void WithFileDownloadName_GivenExpectedValue_ShouldPass()
         public void WithFileDownloadName_GivenUnexpected_ShouldFail()
         {
             var actualValue = "file2.txt";
-            var expectedValue = "file1.txt";
-            ActionResult result = new FileContentResult(Array.Empty<byte>(), "text/plain")
-            {
-                FileDownloadName = actualValue
-            };
+            var expectedValue = "file1.txt"; 
+            var result = TestDataGenerator.CreateFileContentResult();
+            result.FileDownloadName = actualValue;
             var failureMessage = FailureMessageHelper.Format(FailureMessages.CommonFailMessage, "FileResult.FileDownloadName", expectedValue, actualValue);
 
             Action a = () => result.Should().BeFileResult().WithFileDownloadName(expectedValue);
@@ -63,10 +60,8 @@ public void WithFileDownloadName_GivenUnexpected_ShouldFail()
         [Fact]
         public void WithLastModified_GivenExpectedValue_ShouldPass()
         {
-            ActionResult result = new FileContentResult(Array.Empty<byte>(), "text/plain")
-            {
-                LastModified = DateTimeOffset.Parse("2009-06-15T13:45:30.0000000-07:00")
-            };
+            var result = TestDataGenerator.CreateFileContentResult();
+            result.LastModified = DateTimeOffset.Parse("2009-06-15T13:45:30.0000000-07:00");
 
             result.Should().BeFileResult().WithLastModified(DateTimeOffset.Parse("2009-06-15T13:45:30.0000000-07:00"));
         }
@@ -76,10 +71,8 @@ public void WithLastModified_GivenUnexpected_ShouldFail()
         {
             var actualValue = DateTimeOffset.Parse("2009-06-15T13:45:30.0000000-07:00");
             var expectedValue = DateTimeOffset.Parse("2010-07-16T14:46:31.0000000-06:00");
-            ActionResult result = new FileContentResult(Array.Empty<byte>(), "text/plain")
-            {
-                LastModified = actualValue
-            };
+            var result = TestDataGenerator.CreateFileContentResult();
+            result.LastModified = actualValue;
             var failureMessage = "Expected \"FileResult.LastModified\" to be '<2010-07-16 14:46:31 -6h>' but found '<2009-06-15 13:45:30 -7h>'";
 
             Action a = () => result.Should().BeFileResult().WithLastModified(expectedValue);
@@ -94,10 +87,8 @@ public void WithEntityTag_GivenExpectedValue_ShouldPass()
         {
             var actualValue = new EntityTagHeaderValue("\"sha256 value 1\"");
             var expectedValue = new EntityTagHeaderValue("\"sha256 value 1\"");
-            ActionResult result = new FileContentResult(Array.Empty<byte>(), "text/plain")
-            {
-                EntityTag = actualValue
-            };
+            var result = TestDataGenerator.CreateFileContentResult();
+            result.EntityTag = actualValue;
 
             result.Should().BeFileResult().WithEntityTag(expectedValue);
         }
@@ -107,10 +98,8 @@ public void WithEntityTag_GivenUnexpected_ShouldFail()
         {
             var actualValue = new EntityTagHeaderValue("\"sha256 value 1\"", true);
             var expectedValue = new EntityTagHeaderValue("\"sha256 value 2\"", false);
-            ActionResult result = new FileContentResult(Array.Empty<byte>(), "text/plain")
-            {
-                EntityTag = actualValue
-            };
+            var result = TestDataGenerator.CreateFileContentResult();
+            result.EntityTag = actualValue;
             var failureMessage = "Expected \"FileResult.EntityTag\" to be '\"sha256 value 2\"' but found 'W/\"sha256 value 1\"'";
 
             Action a = () => result.Should().BeFileResult().WithEntityTag(expectedValue);

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

@@ -6,21 +6,26 @@ namespace FluentAssertions.AspNetCore.Mvc.Tests.Helpers
 {
     public static class TestDataGenerator
     {
-        public static FileContentResult CreateFileContentResult(string content = "")
+        public static FileContentResult CreateFileContentResult(string content = "", string contentType = "text/plain")
         {
-            return CreateFileContentResult(CreateBytes(content));
+            return CreateFileContentResult(CreateBytes(content), contentType);
         }
 
-        public static FileContentResult CreateFileContentResult(byte[] fileContents)
+        public static FileContentResult CreateFileContentResult(byte[] fileContents, string contentType = "text/plain")
         {
-            return new FileContentResult(fileContents, "text/plain");
+            return new FileContentResult(fileContents, contentType);
         }
 
         public static FileStreamResult CreateFileStreamResult(string content = "")
         {
             return CreateFileStreamResult(CreateStream(content));
         }
 
+        public static PhysicalFileResult CreatePhysicalFileResult(string fileName = "c:\\temp.txt")
+        {
+            return new PhysicalFileResult(fileName, "text/plain");
+        }
+
         public static FileStreamResult CreateFileStreamResult(Stream stream)
         {
             return new FileStreamResult(stream, "text/plain");