Aggregate (multiple) assertion functionality

[YevgeniyShunevych]

Implementation

The aggregate (multiple) assertion functionality should be implemented to be able to invoke several Should.* assertions, collect the failed results and produce a single exception containing a set of failed assertions.

Implement 2 strategies of aggregate assertion:

• Atata default/native.
• Using NUnit's Assert.Multiple and other related methods.

Every failed assertion in the scope of aggregate one is written to log.

Additions to AtataContext

The actual main aggregate assertion method:

public void AggregateAssert(Action action, string assertionScopeName = null);

AggregateAssertionException

Implement AggregateAssertionException that represents one or more errors that occur during an aggregate assertion. This is the default aggregate assertion exception type that can be replaced with custom one thru AtataContextBuilder.

Should have a constructor with IEnumerable<AssertionResult> results argument to build the aggregate message based on the list of results.

Additions to AtataContextBuilder

Add methods for configuring aggregate assertion functionality:

public AtataContextBuilder UseAggregateAssertionExceptionType(Type exceptionType);

public AtataContextBuilder UseAggregateAssertionExceptionType<TException>()
    where TException : Exception;

public AtataContextBuilder UseAggregateAssertionStrategy(IAggregateAssertionStrategy strategy);

public AtataContextBuilder UseAggregateAssertionStrategy<TAggregateAssertionStrategy>()
    where TAggregateAssertionStrategy : IAggregateAssertionStrategy, new();

public AtataContextBuilder UseNUnitAggregateAssertionStrategy();

When using NUnit, it is recommended to invoke UseNUnitAggregateAssertionStrategy() during AtataContext configuration in order to enable NUnit's built-in multiple assert functionality. For other testing frameworks (xUnit, MSTest) the native Atata assertion functionality will work well by default.

Additions to PageObject<TOwner>

Below 2 methods provide aggregate assertion directly to the page object with support of fluent interface:

public TOwner AggregateAssert(Action<TOwner> action);

public TOwner AggregateAssert<TComponent>(Func<TOwner, TComponent> componentSelector, Action<TComponent> action);

Under the hood, the methods use AtataContext.AggregateAssert method.

Usage

Aggregate assert page object

Go.To<SomeUserPage>().
    AggregateAssert(x => x.
        ContactDetails.FirstName.Should.Equal("John").
        ContactDetails.LastName.Should.Equal("Smith"));

Or:

Go.To<SomeUserPage>().
    AggregateAssert(x =>
    {
        x.ContactDetails.FirstName.Should.Equal("John");
        x.ContactDetails.LastName.Should.Equal("Smith");
    });

Aggregate assert component

Go.To<SomeUserPage>().
    AggregateAssert(_ => _.ContactDetails, x =>
    {
        x.FirstName.Should.Equal("John");
        x.LastName.Should.Equal("Smith");
    });

Aggregate assert section

AtataContext.Current.AggregateAssert(() =>
{
    Go.To<SomeUserPage>().
        ContactDetails.FirstName.Should.Equal("John").
        ContactDetails.LastName.Should.Equal("Smith");

    // Do other assertions...
});