Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions NotoriousTest.slnx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@
<File Path="NotoriousTest/LICENSE.txt" />
<File Path="README.md" />
</Folder>
<Folder Name="/Docs/Templates/">
<File Path=".github/ISSUE_TEMPLATE/bug_report.yml" />
<File Path=".github/ISSUE_TEMPLATE/feature_request.yml" />
<File Path=".github/PULL_REQUEST_TEMPLATE.md" />
</Folder>
<Folder Name="/src/" />
<Folder Name="/src/1. Core/">
<Project Path="DoggyDog/DoggyDog.csproj" Id="8408dd70-9d47-4f50-bab4-bcd86e50bc3d" />
Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ __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 !](https://github.com/Notorious-Coding/Notorious-Test/discussions/1) discussion on Github ! Gaining insight into its usage is very important to me!

## Summary
- [Purpose](#purpose)
- [Why should you use Notorious Test ?](#why-should-you-use-notorious-test-)
- [Why should you not use Notorious Test ?](#why-should-you-not-use-notorious-test-)
- [Purpose](#purpose)
- [Hello World](#hello-world)
- [Setup](#setup)
- [Define a Basic Infrastructure](#define-a-basic-infrastructure)
Expand All @@ -29,6 +29,20 @@ If you plan to use this NuGet package, let me know in the [Tell me if you use th
- [Contact](#contact)
- [Other packages i'm working on](#other-nugets-im-working-on)

## Purpose

Notorious Test is a testing framework designed to simplify the setup and management of integration tests in .NET applications.
It provides a structured way to define and manage test environments, allowing developers to focus on writing tests rather than dealing with the complexities of infrastructure setup and teardown.

The concept is simple:

1. Create an **infrastructure** and implement its _initialization_, _reset_, and _destruction_ logic.
2. Add it to an **environment**.
3. Access it directly from your **integration tests**.

**NotoriousTest** will automatically manage the **lifecycle of your infrastructures.**
Even after the tests have crashed unexpectedly, thanks to the DoggyDog 🐶.

## Why should you use Notorious Test ?

Notorious Test, as every software programming tool, is not made for everyone. It is designed to solve a specific problem, and if you don't have that problem, it may not be the right tool for you.
Expand All @@ -52,20 +66,6 @@ If 2 or more of these points apply to you, Notorious Test is probably a good fit
- TestContainers may be sufficient to all you needs.
- You prefer to mock your dependencies rather than using real ones in your tests.

## Purpose

Notorious Test is a testing framework designed to simplify the setup and management of integration tests in .NET applications.
It provides a structured way to define and manage test environments, allowing developers to focus on writing tests rather than dealing with the complexities of infrastructure setup and teardown.

The concept is simple:

1. Create an **infrastructure** and implement its _initialization_, _reset_, and _destruction_ logic.
2. Add it to an **environment**.
3. Access it directly from your **integration tests**.

**NotoriousTest** will automatically manage the **lifecycle of your infrastructures.**
Even after the tests have crashed unexpectedly, thanks to the DoggyDog 🐶.

## Hello World

## Setup
Expand Down
Loading