Skip to content

Notorious-Coding/Notorious-Test

Repository files navigation

Logo

NuGet NuGet Downloads License .NET Build Status GitHub stars

Clean, isolated, and maintainable integration testing for .NET

If you plan to use this NuGet package, let me know in the Tell me if you use that package ! discussion on Github ! Gaining insight into its usage is very important to me!

Summary

🚨 The problem with integration testing in .NET

When testing an application that relies on multiple infrastructures (databases, message buses, blob storage, FTP, SMTP...), the common approach looks like this:

  • Create a WebApplicationFactory and use it as a fixture.
  • Implement IAsyncLifetime to initialize and dispose of infrastructures.
  • Manage each infrastructure (SQL Server, RabbitMQ, Redis, MongoDB, etc.) within Initialize and Dispose.
  • Add specific setup code inside the test constructors.

πŸ‘‰ This works for small projects, but as complexity increases, it becomes a nightmare:

πŸ”₯ The WebApplicationFactory turns into an unmanageable beast.
πŸ”„ Everything needs to be manually refactored and structured β†’ resulting in messy, hard-to-maintain code.
πŸ—οΈ Tests become slow to write and complex to maintain.
⏳ Setup time skyrockets, reducing productivity.

And that’s the real problemβ€”integration tests are meant to ensure the quality of our code. But if they themselves become unmanageable, the enemy of our enemy becomes our enemy.

πŸš€ NotoriousTest: The solution

NotoriousTest introduces a modular and structured approach to isolating and managing your test infrastructures effortlessly.

βœ… Each infrastructure (database, message bus, etc.) is encapsulated in its own class with a proper lifecycle (Init, Reset, Destroy).
βœ… Test environments are composable β†’ you assemble infrastructures like Lego blocks.
βœ… Automatic reset between tests ensures proper isolation.
βœ… No need to bloat your WebApplicationFactory β†’ each infrastructure is cleanly defined.
βœ… Works seamlessly with TestContainers, SQL Server, and more.

πŸ‘‰ The result? A testing framework that is clean, modular, maintainable, and scalable.

Why use NotoriousTest

πŸ”Ή Designed for complex integration tests
Seamlessly manage multiple infrastructures like databases, message buses, blob storage, and more, without turning your test setup into a nightmare.

πŸ”Ή Fully isolated and resettable environments
Ensure clean, independent tests by automatically resetting infrastructures between each runβ€”no leftover data, no hidden side effects.

πŸ”Ή Modular & reusable infrastructure components
Define each infrastructure separately and compose test environments like Lego blocks. No more bloated WebApplicationFactories!

πŸ”Ή Effortless setup & minimal boilerplate
Forget complex test initialization logicβ€”NotoriousTest takes care of instantiating, resetting, and destroying your infrastructures automatically.

πŸ”Ή Compatible with TestContainers & SQL Server
Seamlessly integrates with Dockerized test environments, allowing you to spin up databases, message queues, and more in seconds.

πŸ”Ή Powered by XUnit & Async Support
Leverage the flexibility of XUnit’s dependency injection and fully async infrastructure lifecycles for faster and more scalable tests.

Hello World

Setup

First, install NuGet. Then, install NotoriousTest from the package manager console:

PM> Install-Package NotoriousTest

Or from the .NET CLI as:

dotnet add package NotoriousTest

Define a Basic Infrastructure

An infrastructure represents an external dependency (database, message bus, etc.).

For now, we’ll define an empty infrastructure to illustrate the setup. You can replace MyInfrastructure with any real infrastructure later.

public class MyInfrastructure : AsyncInfrastructure
{
    public override Task Initialize()
    {
        // Setup logic here (e.g., start a database, configure an API)
        Console.WriteLine($"Setup of {nameof(MyInfrastructure)}");
        return Task.CompletedTask;
    }

    public override Task Reset()
    {
        // Reset logic here (e.g., clear data, reset state)
        Console.WriteLine($"Reset of {nameof(MyInfrastructure)}");
        return Task.CompletedTask;
    }

    public override Task Destroy()
    {
        // Cleanup logic here (e.g., shut down services)
        Console.WriteLine($"Shutdown of {nameof(MyInfrastructure)}");
        return Task.CompletedTask;
    }
}

πŸ“Œ What this does:

  • Defines a basic infrastructure with lifecycle methods.
  • This is where you would add setup logic for databases, APIs, queues, etc.

Create a Web Application

Now, let's create a basic web application for our tests.

public class SampleWebApp : WebApplication<Program>
{
    // Override WebApplicationFactory methods.
}

❗ This is a WebApplicationFactory customized for NotoriousTest.

πŸ“Œ What this does:

  • Defines a minimal web application factory for testing.

Create a Test Environment

A test environment groups infrastructures together.

public class MyTestEnvironment : AsyncWebEnvironment
{
    public override async Task ConfigureEnvironmentAsync()
    {
        AddInfrastructure(new MyInfrastructure()); // Register the test infrastructure
        AddWebApplication(new SampleWebApp()); // Register the web app
    }
}

πŸ“Œ What this does:

  • Registers MyInfrastructure and SampleWebApp inside the test environment.
  • Ensures all tests run in a clean and isolated setup.

Write your first test

Now, let's write a basic integration test using our environment.

public class MyIntegrationTests : AsyncIntegrationTest<MyTestEnvironment>
{
    public MyIntegrationTests(MyTestEnvironment environment) : base(environment) { }

    [Fact]
    public async Task ExampleTest()
    {
        // Retrieve the infrastructure
        var infra = await CurrentEnvironment.GetInfrastructureAsync<MyInfrastructure>();

        // Add test logic here (e.g., verify database state, call an API)

        Assert.NotNull(infra); // Basic validation to confirm setup works
    }
}

πŸ“Œ What this does:

  • Retrieves the test infrastructure from the environment.
  • You can add real test logic (API calls, database assertions, etc.).

πŸš€ Running Your First Test

Now, let's run the test:

dotnet test

Expected Output

You should see something like:

Passed! 1 test successful.

If everything works, congrats! πŸŽ‰ You’ve successfully set up NotoriousTest.

Resources & Community

Documentation

  • πŸ“– Core Concepts – Learn how infrastructures and environments work.
  • ⚑ Advanced Features – Discover ordering, reset behaviors, and more. \
  • πŸ”Œ Integrations – See how to integrate SQL Server, TestContainers, and more.
  • πŸ“š Examples – Hands-on use cases with real-world setups.

Changelog

You can find the changelog here.

Contact

Have questions, ideas, or feedback about NotoriousTests? Feel free to reach out! I'd love to hear from you. Here's how you can get in touch:

The discussions tabs is now opened ! Feel free to tell me if you use the package here : #1 !

Other nugets i'm working on

  • NotoriousClient : Notorious Client is meant to simplify the sending of HTTP requests through a fluent builder and an infinitely extensible client system.
  • NotoriousModules : Notorious Modules provide a simple way to separate monolith into standalone modules.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages