v1.0.0-alpha.7 - make result assertions more fluent

README.md

@@ -11,20 +11,37 @@ public void MultiplyNumbers() =>
         .WhenIt().Multiply(3, 2)
         .ThenTheResultShouldBe(6);
 
-[Fact]
-public void DivideNumbers() =>
-    GivenA<Calculator>
-        .WhenIt().Divide(6, 3)
-        .ThenTheResultShouldBe(2);
-
 [Fact]
 public void DivideByZero() =>
     GivenA<Calculator>
         .WhenIt(sut => sut.Divide(6, 0))
         .ThenItShouldThrow<DivideByZeroException>();
 ```
 
-Tests that require more detailed setup and assertion will look something like this:
+Each test has its own state that allows you to register variables during arrangement. These variables can then be used in the action and assertment:
+```
+[Fact]
+public void CreateEntity() =>
+    GivenA<Creator>
+        .AndGiven(new EntityParameters("EntityName"))
+        .WhenIt(action => action.Sut.Create(action.GetObject<EntityParameters>()))
+        .ThenTheResult(result => result.Id).ShouldBe(1)
+        .ThenTheResult(result => result.Name).ShouldBe("EntityName");
+```
+
+Variables can be given names to identify them if multiple of the same type are registered:
+```
+[Fact]
+public void CreateEntity_Example2() =>
+    GivenA<Creator>
+        .AndGiven(new EntityParameters("EntityName"), "ParametersToUse")
+        .AndGiven(new EntityParameters("AnotherEntityName"), "SomeOtherParameters")
+        .WhenIt(action => action.Sut.Create(action.GetObject<EntityParameters>("ParametersToUse")))
+        .ThenTheResult(result => result.Id).ShouldBe(1)
+        .ThenTheResult(result => result.Name).ShouldBe("EntityName");
+```
+
+More complex setups and assertions including mocks are possible:
 ```
 [Fact]
 public void ProcessValidParameters() =>
@@ -43,7 +60,7 @@ public void ProcessValidParameters() =>
                 arrangement.Objects.Get<Entity>("entity")
             ))
         .WhenIt(action => action.Sut.Process(action.GetObject<EntityParameters>("parameters")))
-        .ThenItShould(assertion =>
+        .Then(assertion =>
         {
             assertion.Dependencies.GetMock<IValidator>()
                 .Verify(validator => validator.IsValid(assertion.GetObject<EntityParameters>("parameters")),
@@ -61,7 +78,7 @@ public void ProcessValidParameters() =>
 
 Install by running the following:
 ```
-dotnet add package XpressTest --version 1.0.0-alpha.5
+dotnet add package XpressTest --version 1.0.0-alpha.7
 ```
 
 Examples of usage can be seen in the `XpressTest.Examples` project in this repository.

XpressTest.Examples/Tests/CreatorTests.cs

@@ -6,14 +6,45 @@ namespace XpressTest.Examples.Tests;
 public class CreatorTests
 {
     [Fact]
-    public void CreateEntity() =>
+    public void CreateEntity_Example1() =>
         GivenA<Creator>
-            .AndGiven(new EntityParameters("EntityName"), "EntityParameters")
-            .WhenIt(action => action.Sut.Create(action.GetObject<EntityParameters>("EntityParameters")))
-            .ThenItShould(assertion =>
+            .AndGiven(new EntityParameters("EntityName"))
+            .WhenIt(action => action.Sut.Create(action.GetObject<EntityParameters>()))
+            .ThenTheResult(result => result.Id).ShouldBe(1)
+            .ThenTheResult(result => result.Name).ShouldBe("EntityName");
+
+
+    [Fact]
+    public void CreateEntity_Example2() =>
+        GivenA<Creator>
+            .AndGiven(new EntityParameters("EntityName"), "ParametersToUse")
+            .AndGiven(new EntityParameters("AnotherEntityName"), "SomeOtherParameters")
+            .WhenIt(action => action.Sut.Create(action.GetObject<EntityParameters>("ParametersToUse")))
+            .ThenTheResult(result => result.Id).ShouldBe(1)
+            .ThenTheResult(result => result.Name).ShouldBe("EntityName");
+
+    [Fact]
+    public void CreateEntity_Example3() =>
+        GivenA<Creator>
+            .AndGiven(new EntityParameters("EntityName"), "EntityParametersToUse")
+            .AndGiven(new EntityParameters("AnotherEntityName"), "SomeOtherEntityParameters")
+            .WhenIt(action => action.Sut.Create(action.GetObject<EntityParameters>("EntityParametersToUse")))
+            .Then(assertion =>
             {
                 Assert.Equal(1, assertion.Result.Id);
                 Assert.Equal("EntityName", assertion.Result.Name);
             })
             .Test();
+
+    [Fact]
+    public void CreateEntity_Example4()
+    {
+        var parameters = new EntityParameters("EntityName");
+
+        var entity = new Entity(1, "EntityName");
+
+        GivenA<Creator>
+            .WhenIt().Create(parameters)
+            .ThenTheResultShouldBeEquivalentTo(entity);
+    }
 }

XpressTest.Examples/Tests/ParametersProcessorTests.cs

@@ -23,7 +23,7 @@ public void ProcessValidParameters() =>
                     arrangement.Objects.Get<Entity>("entity")
                 ))
             .WhenIt(action => action.Sut.Process(action.GetObject<EntityParameters>("parameters")))
-            .ThenItShould(assertion =>
+            .Then(assertion =>
             {
                 assertion.Dependencies.GetMock<IValidator>()
                     .Verify(validator => validator.IsValid(assertion.GetObject<EntityParameters>("parameters")),
@@ -46,7 +46,7 @@ public void ProcessInvalidParameters() =>
                 false))
             .WithA<ICreator>()
             .WhenIt(action => action.Sut.Process(action.GetObject<EntityParameters>("parameters")))
-            .ThenItShould(assertion =>
+            .Then(assertion =>
             {
                 assertion.Dependencies.GetMock<IValidator>()
                     .Verify(

XpressTest.Examples/Tests/ValidatorTests.cs

@@ -12,8 +12,7 @@ public class ValidatorTests
     [InlineData(null, false)]
     public void ValidateParameters(string name, bool expectedResult) =>
         GivenA<Validator>
-            .AndGiven(new EntityParameters(name), "EntityParameters")
-            .WhenIt(action => action.Sut.IsValid(action.GetObject<EntityParameters>("EntityParameters")))
-            .ThenItShould(assertion => { Assert.Equal(expectedResult, assertion.Result); })
-            .Test();
+            .AndGiven(new EntityParameters(name))
+            .WhenIt(action => action.Sut.IsValid(action.GetObject<EntityParameters>()))
+            .ThenTheResultShouldBe(expectedResult);
 }

XpressTest.Examples/XpressTest.Examples.csproj

@@ -9,7 +9,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
-    <PackageReference Include="XpressTest" Version="1.0.0-alpha.6" />
+    <PackageReference Include="XpressTest" Version="1.0.0-alpha.7" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>

XpressTest/Arrangement.cs

@@ -15,7 +15,11 @@ IDependencyCollection dependencies
 
     public IDependencyCollection Dependencies { get; }
 
+    public T GetObject<T>() => Objects.Get<T>();
+
     public T GetObject<T>(string name) => Objects.Get<T>(name);
-
+
+    public void Add<T>(T obj) => Objects.Add(obj);
+
     public void Add<T>(INamedObject<T> namedObject) => Objects.Add(namedObject);
 }

XpressTest/AsserterComposer.cs

@@ -3,7 +3,7 @@
 public class AsserterComposer<TSut> : IAsserterComposer<TSut>
     where TSut : class
 {
-    public IAsserter<System.Action<IAssertion<TSut, TResult>>> Compose<TResult, TDependency>(
+    public IAsserter<System.Action<IAssertion<TSut, TResult>>, TResult> Compose<TResult, TDependency>(
         IDependency dependency,
         Func<IAction<TSut>, TResult> action, 
         IArrangement arrangement)
@@ -22,10 +22,11 @@ public class AsserterComposer<TSut> : IAsserterComposer<TSut>
             actionExecutor,
             arrangement
         );
-
+        
         var builder = new ResultAsserter<TSut, TResult>(
             sutComposer,
-            sutTesterComposer
+            sutTesterComposer,
+            null
         );
 
         return builder;

XpressTest/Assertion.cs

@@ -23,7 +23,11 @@ IAction<TSut> action
 
     public IDependencyCollection Dependencies => Action.Dependencies;
 
+    public T GetObject<T>() => Objects.Get<T>();
+
     public T GetObject<T>(string name) => Objects.Get<T>(name);
-
+
+    public void Add<T>(T obj) => Objects.Add(obj);
+
     public void Add<T>(INamedObject<T> obj) => Objects.Add(obj);
 }

XpressTest/AssertionExtensions.cs

@@ -1,11 +1,16 @@
-using Xunit;
+using FluentAssertions;
 
 namespace XpressTest;
 
 public static class AssertionExtensions
 {
     public static void ThenTheResultShouldBe<T>(this T actualResult, T expectedResult)
     {
-        Assert.Equal(expectedResult, actualResult);
+        expectedResult.Should().Be(actualResult);
+    }
+
+    public static void ThenTheResultShouldBeEquivalentTo<T>(this T actualResult, T expectedResult)
+    {
+        actualResult.Should().BeEquivalentTo(expectedResult);
     }
 }

XpressTest/DependencyAsserterComposer.cs

@@ -11,7 +11,7 @@ IAsserterComposer<TSut> asserterComposer
         _asserterComposer = asserterComposer;
     }
 
-    public IAsserter<System.Action<IAssertion<TSut, TResult>>> Compose<TResult, TDependency>(
+    public IAsserter<System.Action<IAssertion<TSut, TResult>>, TResult> Compose<TResult, TDependency>(
         TDependency dependencyValue,
         Func<IAction<TSut>, TResult> func,
         IArrangement arrangement

XpressTest/DependencyBuilder.cs

@@ -34,7 +34,7 @@ public IMockDependencyBuilder<TSut, TNewDependency> WithA<TNewDependency>() wher
         );
     }
 
-    public IAsserter<System.Action<IAssertion<TSut, TResult>>> WhenIt<TResult>(Func<IAction<TSut>, TResult> func)
+    public IAsserter<System.Action<IAssertion<TSut, TResult>>, TResult> WhenIt<TResult>(Func<IAction<TSut>, TResult> func)
     {
         return _testComposer.ComposeAsserter(
             _dependency,

XpressTest/GivenA.cs

@@ -11,9 +11,14 @@ public static IMockObjectBuilder<TSut, TObject> AndGivenA<TObject>(string name)
 
     public static IObjectBuilder<TSut> AndGiven<TObject>(TObject obj, string name)
     {
-        return ObjectTestInitialiser<TSut, TObject>.Initialise(obj, name);
+        return NamedObjectTestInitialiser<TSut, TObject>.Initialise(obj, name);
     }
-
+
+    public static IObjectBuilder<TSut> AndGiven<TObject>(TObject obj)
+    {
+        return ObjectTestInitialiser<TSut, TObject>.Initialise(obj);
+    }
+
     public static IMockDependencyBuilder<TSut, TDependency> WithA<TDependency>()
         where TDependency : class
     {

XpressTest/IActor.cs

@@ -2,7 +2,7 @@ namespace XpressTest;
 
 public interface IActor<TSut>
 {
-    IAsserter<System.Action<IAssertion<TSut, TResult>>> WhenIt<TResult>(Func<IAction<TSut>, TResult> func);
-    
+    IAsserter<System.Action<IAssertion<TSut, TResult>>, TResult> WhenIt<TResult>(Func<IAction<TSut>, TResult> func);
+
     IAsserter<System.Action<IArrangement>> WhenIt(System.Action<IAction<TSut>> func);
 }

XpressTest/IArrangement.cs

@@ -6,7 +6,11 @@ public interface IArrangement
 
     IDependencyCollection Dependencies { get; }
 
+    T GetObject<T>();
+
     T GetObject<T>(string name);
-
+
+    void Add<T>(T obj);
+
     void Add<T>(INamedObject<T> namedObject);
 }

XpressTest/IAsserter.cs

@@ -2,5 +2,10 @@ namespace XpressTest;
 
 public interface IAsserter<TAssertion>
 {
-    ITester ThenItShould(TAssertion assertion);
+    ITester Then(TAssertion assertion);
+}
+
+public interface IAsserter<TAssertion, TResult> : IAsserter<TAssertion>, IResultPropertyTargeter<TResult>
+{
+
 }

XpressTest/IAsserterComposer.cs

@@ -2,7 +2,7 @@
 
 public interface IAsserterComposer<TSut>
 {
-    IAsserter<System.Action<IAssertion<TSut, TResult>>> Compose<TResult, TDependency>(
+    IAsserter<System.Action<IAssertion<TSut, TResult>>, TResult> Compose<TResult, TDependency>(
         IDependency dependency,
         Func<IAction<TSut>, TResult> action,
         IArrangement arrangement

XpressTest/IDependencyAsserterComposer.cs

@@ -2,7 +2,7 @@
 
 public interface IDependencyAsserterComposer<TSut>
 {
-    IAsserter<System.Action<IAssertion<TSut, TResult>>> Compose<TResult, TDependency>(
+    IAsserter<System.Action<IAssertion<TSut, TResult>>, TResult> Compose<TResult, TDependency>(
         TDependency dependencyValue,
         Func<IAction<TSut>, TResult> func,
         IArrangement arrangement);

XpressTest/IMockDependencyAsserterComposer.cs

@@ -4,7 +4,7 @@ namespace XpressTest;
 
 public interface IMockDependencyAsserterComposer<TSut>
 {
-    IAsserter<System.Action<IAssertion<TSut, TResult>>> Compose<TResult, TDependency>(
+    IAsserter<System.Action<IAssertion<TSut, TResult>>, TResult> Compose<TResult, TDependency>(
         Mock<TDependency> dependencyMock,
         Func<IAction<TSut>, TResult> func,
         IArrangement arrangement

XpressTest/IObjectCollection.cs

@@ -3,6 +3,10 @@ namespace XpressTest;
 public interface IObjectCollection
 {
     T Get<T>(string name);
-
+
+    T Get<T>();
+
     void Add<T>(INamedObject<T> namedObject);
+
+    void Add<T>(T obj);
 }

XpressTest/IResultPropertyAsserter.cs

@@ -0,0 +1,6 @@
+namespace XpressTest;
+
+public interface IResultPropertyAsserter<TResult, TProperty>
+{
+    IResultPropertyTargeter<TResult> ShouldBe(TProperty expectedValue);
+}

XpressTest/IResultPropertyTargeter.cs

@@ -0,0 +1,8 @@
+namespace XpressTest;
+
+public interface IResultPropertyTargeter<TResult>
+{
+    IResultPropertyAsserter<TResult, TProperty> ThenTheResult<TProperty>(Func<TResult, TProperty> targetFunc);
+
+    void ThenTheResultShouldBe(TResult expectedResult);
+}

XpressTest/ITestComposer.cs

@@ -15,7 +15,7 @@ TDependency dependency
     )
         where TNewDependency : class;
 
-    IAsserter<System.Action<IAssertion<TSut, TResult>>> ComposeMockAsserter<TResult, TDependency>(
+    IAsserter<System.Action<IAssertion<TSut, TResult>>, TResult> ComposeMockAsserter<TResult, TDependency>(
         Mock<TDependency> dependency,
         Func<IAction<TSut>, TResult> func,
         IArrangement arrangement
@@ -29,7 +29,7 @@ IArrangement arrangement
     )
         where TDependency : class;
 
-    IAsserter<System.Action<IAssertion<TSut, TResult>>> ComposeAsserter<TResult, TDependency>(
+    IAsserter<System.Action<IAssertion<TSut, TResult>>, TResult> ComposeAsserter<TResult, TDependency>(
         TDependency dependency,
         Func<IAction<TSut>, TResult> func,
         IArrangement arrangement

XpressTest/MockDependencyAsserterComposer.cs

@@ -13,7 +13,7 @@ IAsserterComposer<TSut> asserterComposer
         _asserterComposer = asserterComposer;
     }
 
-    public IAsserter<System.Action<IAssertion<TSut, TResult>>> Compose<TResult, TDependency>(
+    public IAsserter<System.Action<IAssertion<TSut, TResult>>, TResult> Compose<TResult, TDependency>(
         Mock<TDependency> dependencyMock,
         Func<IAction<TSut>, TResult> func,
         IArrangement arrangement

XpressTest/MockDependencyBuilder.cs

@@ -52,15 +52,15 @@ Func<IArrangement, MockSetup<TDependency, TDependencyResult>> func
          return this;
     }
 
-    public IAsserter<System.Action<IAssertion<TSut, TResult>>> WhenIt<TResult>(Func<IAction<TSut>, TResult> func)
+    public IAsserter<System.Action<IAssertion<TSut, TResult>>, TResult> WhenIt<TResult>(Func<IAction<TSut>, TResult> func)
     {
         return _testComposer.ComposeMockAsserter(
             _dependencyMock,
             func,
             _testComposer.Arrangement
             );
     }
-
+    
     public IAsserter<System.Action<IArrangement>> WhenIt(System.Action<IAction<TSut>> func)
     {
         return _testComposer.ComposeMockAsserter(