Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CreateAndFake/CreateAndFake
A C# class library that handles mocking, test data generation, and validation.
https://github.com/CreateAndFake/CreateAndFake
clone cloning create data equality fake mock mocking mocks random randomization stubs testing tests
Last synced: 27 days ago
JSON representation
A C# class library that handles mocking, test data generation, and validation.
- Host: GitHub
- URL: https://github.com/CreateAndFake/CreateAndFake
- Owner: CreateAndFake
- License: mpl-2.0
- Created: 2018-03-04T23:18:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-31T07:41:04.000Z (5 months ago)
- Last Synced: 2024-02-24T00:19:32.321Z (4 months ago)
- Topics: clone, cloning, create, data, equality, fake, mock, mocking, mocks, random, randomization, stubs, testing, tests
- Language: C#
- Homepage:
- Size: 747 KB
- Stars: 11
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Lists
- awesome - CreateAndFake/CreateAndFake - A C# class library that handles mocking, test data generation, and validation. (C\#)
README
# Create & Fake
[](https://www.nuget.org/packages/CreateAndFake) [](../../actions?query=workflow%3AIntegration) [](https://codecov.io/gh/CreateAndFake/CreateAndFake/branch/master) [](code_of_conduct.md)
A C# class library that handles mocking, test data generation, and validation. Designed to handle the bulk of test setup quickly and easily so that developers can focus on the behavior to test, making tests easier to develop and maintain:
```c#
// xUnit attributes used to automatically create the parameters.
[Theory, RandomData]
internal static void TestGetMovieDirectors(
[Fake] IStorage db, Endpoint api, [Size(2)] Details[] movies)
{
// Setup fake behavior using randomized movie data (times optional).
db.Find(movies[0].Name).SetupReturn(movies, Times.Once);
// Call code and test for expected result (api is auto-injected with db fake).
api.GetDirectors(movies[0].Name, movies[0].Year).Assert().Is(movies[0].Directors);
// Optionally check all behavior called as expected.
db.VerifyAllCalls();
}
```
By default, all behavior works not by reference but by value even for complex objects. Using the extension methods and attributes are optional as all functionality are present in customizable tools:
```C#
[Fact]
internal static void TestChangingZipCodeUpdatesAddress()
{
// Randomizer uses readable values for some properties like 'FirstName'.
User details = Tools.Randomizer.Create();
// Duplicator creates deep clones.
User copy = Tools.Duplicator.Copy(details);
// Mutator can randomly modify objects too.
details.ZipCode = Tools.Mutator.Variant(details.ZipCode);
// Asserter performs checks based upon value.
Tools.Asserter.IsNot(copy.MailingAddress, details.MailingAddress);
}
```
A key benefit of the library is in how the tools are logically integrated with each other. For example, the `Randomizer` will use stubs for interfaces that have no known implementations in the code. Or the mocks created by the `Faker` utilize value equality in matching arguments.
* `Asserter` - Handles common test scenarios.
* `Faker` - Creates mocks and stubs.
* `Randomizer` - Creates random instances of any type.
* `Duplicator` - Creates deep clones of objects.
* `Mutator` - Mutates objects or creates variants.
* `Valuer` - Compares objects by value.
* `Tester` - Automates common tests.
Visit the [documentation site](https://createandfake.github.io/CreateAndFake/) for more information and how to get started.
## Installation
* Install using:
```
dotnet add package CreateAndFake
```
* Use in a class by adding:
```
using CreateAndFake;
using CreateAndFake.Fluent;
```
## Documentation
The documentation site is located here: https://createandfake.github.io/CreateAndFake/
The raw files can be viewed from the doc folder or built into a local site using Jekyll.
## Contributing
If you're looking to contribute, thanks for your interest. Feel free to submit reports for any issues you can find, or request potential features you'd like to see [here](../../issues). If you wish to contribute code to the project, refer to the contributing guidelines [here](.github/CONTRIBUTING.md) which includes dev environment setup. Please follow the [code of conduct](.github/CODE_OF_CONDUCT.md) when contributing.
## License
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
View the [license](LICENSE.txt) file for more details.
## Acknowledgments
* [xUnit](https://xunit.github.io/): For running tests.
* [Coverlet](https://github.com/tonerdo/coverlet) + [ReportGenerator](https://danielpalme.github.io/ReportGenerator/) + [CodeCov](https://codecov.io/): For test coverage.
* [Bullseye](https://github.com/adamralph/bullseye) + [SimpleExec](https://github.com/adamralph/simple-exec) + [MinVer](https://github.com/adamralph/minver): For project building.
* [GitHub](https://github.com/): For hosting code.
* [Microsoft](https://visualstudio.microsoft.com/vs/features/net-development/): For C# and editors.