https://github.com/mazharenko/FluentAssertions.Eventual

The extension allows to wait for an assertion to pass
https://github.com/mazharenko/FluentAssertions.Eventual

csharp-sourcegenerator extensions fluentassertions

Last synced: 3 months ago
JSON representation

The extension allows to wait for an assertion to pass

• Host: GitHub
• URL: https://github.com/mazharenko/FluentAssertions.Eventual
• Owner: mazharenko
• License: cc0-1.0
• Created: 2022-07-02T09:09:03.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-01T21:45:00.000Z (8 months ago)
• Last Synced: 2024-06-21T06:40:46.933Z (5 months ago)
• Topics: csharp-sourcegenerator, extensions, fluentassertions
• Language: C#
• Homepage:
• Size: 89.8 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• RSCG_Examples - FluentAssertions.Eventual
• csharp-source-generators - FluentAssertions.Eventual -   - Generates a specialized waiting wrapper for `FluentAssertions` assertions, offering a syntax similar to plain `FluentAssertions`. (Source Generators / Testing)

README

        
[![Nuget package](https://img.shields.io/nuget/v/mazharenko.FluentAssertions.Eventual.svg?label=csharp&logo=nuget)](https://www.nuget.org/packages/mazharenko.FluentAssertions.Eventual/)

[![Nuget package](https://img.shields.io/nuget/v/mazharenko.FluentAssertions.Eventual.FSharp.svg?label=fsharp&logo=nuget)](https://www.nuget.org/packages/mazharenko.FluentAssertions.Eventual.FSharp/)

[![Nuget package](https://img.shields.io/nuget/v/mazharenko.FluentAssertions.Eventual.Generator.svg?label=source%20generator&logo=nuget&labelColor=red)](https://www.nuget.org/packages/mazharenko.FluentAssertions.Eventual.Generator/)

[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](LICENSE)

# Eventual assertions for FluentAssertions

`FluentAssertions.Eventual` is an extension that allows to wait for `FluentAssertions` checks to pass which can be useful when writing end-to-end tests.

## Basic usage

Any `FluentAssertions` checks can be placed under a special `foreach` loop, which will implement the waiting and retry logic.

```csharp

foreach (var _ in EventualAssertions.Attempts(4.Seconds(), 400.Milliseconds()))

{

    button.Should().BeVisible();

}

```

## Source generator usage

When having a custom assertion class for a dynamic by nature subject the class can be decorated by the `[GenerateEventual]` attribute to get a special waiting wrapper generated.

Your code (simplified):

```csharp

[GenerateEventual]

public class ButtonAssertions

{

    [CustomAssertion]

    public AndConstraint BeVisible(string? because = null, params object[] becauseArgs)

    {

        // implementation

    }

}

```

What gets generated (simplified):

```csharp

public static class ButtonAssertions_Eventual_Extensions

{

    public static ButtonAssertions_Eventual Eventually(this ButtonAssertions underlying) { /* ... */ }

    // more generated extensions

}

public class ButtonAssertions_Eventual

{

    // constructor, fields

    [CustomAssertion]

    public AndConstraint BeVisible(string? because = null, params object[] becauseArgs)

    {

        AndConstraint result = default !;

        foreach (var _  in EventualAssertions.Attempts(timeout, delay))

            result = underlying.BeVisible(because, becauseArgs);

        return result;

    }

}

```

Which allows for the following syntax:

```csharp

button.Should().Eventually().BeVisible();

button.Should().Eventually(4.Seconds(), 400.Milliseconds()).BeVisible();

button.Should().EventuallyLong().BeVisible();

```

## More info

Complete interactive README in mybinder:\

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/mazharenko/FluentAssertions.Eventual/HEAD?urlpath=lab/tree/README.ipynb)

Also in nbviewer:\

[![nbviewer](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg)](https://nbviewer.org/github/mazharenko/FluentAssertions.Eventual/tree/HEAD/docs/README.ipynb)