Add Basic ObjectAssertions.

Author: faddiv

src/FluentAssertions.AspNetCore.Mvc/ActionResultAssertions.cs

@@ -325,6 +325,27 @@ public StatusCodeResultAssertions BeStatusCodeResult(string reason = "", params
             return new StatusCodeResultAssertions(Subject as StatusCodeResult);
         }
 
+        /// <summary>
+        /// Asserts that the subject is a <see cref="ObjectResult"/>.
+        /// </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 <paramref name="reason"/>.
+        /// </param>
+        [CustomAssertion]
+        public ObjectResultAssertions BeObjectResult(string reason = "", params object[] reasonArgs)
+        {
+            Execute.Assertion
+                .BecauseOf(reason, reasonArgs)
+                .ForCondition(Subject is ObjectResult)
+                .FailWith(FailureMessages.CommonTypeFailMessage, typeof(ObjectResult), Subject.GetType());
+
+            return new ObjectResultAssertions(Subject as ObjectResult);
+        }
+
         /// <summary>
         /// Asserts that the subject is an <see cref="OkResult"/>.
         /// </summary>

src/FluentAssertions.AspNetCore.Mvc/ObjectResultAssertions.cs

@@ -0,0 +1,24 @@
+using Microsoft.AspNetCore.Mvc;
+using System.Diagnostics;
+
+namespace FluentAssertions.AspNetCore.Mvc
+{
+    /// <summary>
+    /// Contains a number of methods to assert that a <see cref="ObjectResult"/> is in the expected state.
+    /// </summary>
+    [DebuggerNonUserCode]
+    public class ObjectResultAssertions : ObjectResultAssertionsBase<ObjectResult, ObjectResultAssertions>
+    {
+        #region Public Constructors
+        /// <summary>
+        ///     Initializes a new instance of the <see cref="ObjectResultAssertions" /> class.
+        /// </summary>
+        /// <param name="subject">The object to test assertion on</param>
+        public ObjectResultAssertions(ObjectResult subject)
+            : base(subject)
+        {
+
+        }
+        #endregion
+    }
+}

src/FluentAssertions.AspNetCore.Mvc/ObjectResultAssertionsBase.cs

@@ -0,0 +1,73 @@
+using FluentAssertions.Execution;
+using FluentAssertions.Primitives;
+using Microsoft.AspNetCore.Mvc;
+using System.Diagnostics;
+
+namespace FluentAssertions.AspNetCore.Mvc
+{
+    /// <summary>
+    /// Base class for <see cref="ObjectResultAssertions"/>.
+    /// </summary>
+    [DebuggerNonUserCode]
+    public class ObjectResultAssertionsBase<TObjectResult, TObjectResultAssertion> : ObjectAssertions
+        where TObjectResult : ObjectResult
+        where TObjectResultAssertion : ObjectResultAssertionsBase<TObjectResult, TObjectResultAssertion>
+    {
+        #region Public Constructors
+        /// <summary>
+        ///     Initializes a new instance of the <see cref="ObjectResultAssertions" /> class.
+        /// </summary>
+        /// <param name="subject">The object to test assertion on</param>
+        public ObjectResultAssertionsBase(TObjectResult subject)
+            : base(subject)
+        {
+
+        }
+        #endregion
+
+        #region Public Properties
+
+        /// <summary>
+        ///     The value on the ObjectResult
+        /// </summary>
+        public object Value => ObjectResultSubject.Value;
+
+        #endregion
+
+        #region Protected Properties
+
+        /// <inheritdoc />
+        protected override string Identifier => typeof(TObjectResult).Name;
+        /// <summary>
+        /// The <see cref="ReferenceTypeAssertions{TSubject, TAssertions}.Subject"/> casted to the correct type.
+        /// </summary>
+        protected TObjectResult ObjectResultSubject => (TObjectResult)Subject;
+
+        #endregion
+
+        #region Public Methods
+        /// <summary>
+        ///     Asserts the value is of the expected type.
+        /// </summary>
+        /// <typeparam name="TValue">The expected type.</typeparam>
+        /// <returns>The typed value.</returns>
+        public TValue ValueAs<TValue>()
+        {
+            var value = ObjectResultSubject.Value;
+
+            if (value == null)
+                Execute.Assertion
+                    .WithDefaultIdentifier($"{Identifier}.Value")
+                    .FailWith(FailureMessages.CommonNullWasSuppliedFailMessage, typeof(TValue));
+
+            Execute.Assertion
+                .ForCondition(value is TValue)
+                .WithDefaultIdentifier($"{Identifier}.Value")
+                .FailWith(FailureMessages.CommonTypeFailMessage, typeof(TValue), value.GetType());
+
+            return (TValue)value;
+        }
+        #endregion
+
+    }
+}

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

@@ -282,6 +282,26 @@ public void BeStatusCodeResult_GivenNotStatusCodeResult_ShouldFail()
                 .WithMessage(failureMessage);
         }
 
+        [Fact]
+        public void BeObjectResult_GivenObjectResult_ShouldPass()
+        {
+            ActionResult result = new ObjectResult("TestValue");
+
+            result.Should().BeObjectResult();
+        }
+
+        [Fact]
+        public void BeObjectResult_GivenNotObjectResult_ShouldFail()
+        {
+            ActionResult result = new ViewResult();
+            var failureMessage = FailureMessageHelper.ExpectedContextTypeXButFoundY("result", typeof(ObjectResult), typeof(ViewResult));
+
+            Action a = () => result.Should().BeObjectResult(Reason, ReasonArgs);
+
+            a.Should().Throw<Exception>()
+                .WithMessage(failureMessage);
+        }
+
         [Fact]
         public void BeOkResult_GivenOk_ShouldPass()
         {

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

@@ -0,0 +1,52 @@
+using System;
+using FluentAssertions.Mvc.Tests.Helpers;
+using Microsoft.AspNetCore.Mvc;
+using Xunit;
+
+namespace FluentAssertions.AspNetCore.Mvc.Tests
+{
+    public class ObjectResultAssertions_Tests
+    {
+        private const string TestValue = "testValue";
+        [Fact]
+        public void Value_GivenObjectResult_ShouldHaveTheSameValue()
+        {
+            var result = new ObjectResult(TestValue);
+            result.Should().BeObjectResult().Value.Should().BeSameAs(TestValue);
+        }
+
+        [Fact]
+        public void ValueAs_GivenObjectResult_ShouldHaveTheSameValue()
+        {
+            var result = new ObjectResult(TestValue);
+
+            result.Should().BeObjectResult().ValueAs<string>().Should().BeSameAs(TestValue);
+        }
+
+        [Fact]
+        public void ValueAs_GivenWrongType_ShouldFail()
+        {
+            var result = new ObjectResult(TestValue);
+            string failureMessage = FailureMessageHelper.ExpectedContextTypeXButFoundY(
+                "ObjectResult.Value", typeof(int), typeof(string));
+
+            Action a = () => result.Should().BeObjectResult().ValueAs<int>().Should().Be(2);
+
+            a.Should().Throw<Exception>()
+                .WithMessage(failureMessage);
+        }
+
+        [Fact]
+        public void ValueAs_Null_ShouldFail()
+        {
+            ActionResult result = new ObjectResult(null);
+            string failureMessage = FailureMessageHelper.ExpectedContextTypeXButFoundNull(
+                "ObjectResult.Value", typeof(object));
+
+            Action a = () => result.Should().BeObjectResult().ValueAs<object>();
+
+            a.Should().Throw<Exception>()
+                .WithMessage(failureMessage);
+        }
+    }
+}