Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hassanhabib/internalmock
.NET library to mock internal private static methods in the same class that is the subject of test.
https://github.com/hassanhabib/internalmock
dotnet mock mocking-framework
Last synced: about 7 hours ago
JSON representation
.NET library to mock internal private static methods in the same class that is the subject of test.
- Host: GitHub
- URL: https://github.com/hassanhabib/internalmock
- Owner: hassanhabib
- License: mit
- Created: 2022-04-23T22:03:33.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-12T09:30:51.000Z (9 months ago)
- Last Synced: 2024-11-09T06:19:23.092Z (10 days ago)
- Topics: dotnet, mock, mocking-framework
- Language: C#
- Homepage:
- Size: 103 KB
- Stars: 23
- Watchers: 8
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# InternalMock
[](https://github.com/hassanhabib/InternalMock/actions/workflows/dotnet.yml)
[](https://github.com/hassanhabib/The-Standard)
## Introduction
This is a beta release please use carefully.
This library allows you to mock internal private static methods in your service - please watch the following videos for context:
- [Developing InternalMock Library from Scratch](https://www.youtube.com/watch?v=SuyzK2aWdqI)
- [On The Topic Of Inner Exceptions](https://www.youtube.com/watch?v=t7iBywCu35U)
- [TryCatch Reflection In Depth](https://www.youtube.com/watch?v=694A0qj6uC4)
- [Postfixing Anonymous Functions](https://www.youtube.com/watch?v=nGU8OD7CRdY)
## Architecture
Here's the architecture of the library according to [The Standard](https://github.com/hassanhabib/The-Standard):
## Examples
Let's Assume you have a service that has several functions that don't call any dependencies. Your service is what we call self-sufficient or dead-end service, as the flow stops there and might just be returned from the same service. An example of a service like this is a tax calculation service, you pass the total income, along with some other details and it calculates the taxes for a certain year. It doesn't call any dependencies.
Now, in that very unique scenario we need to find a way to test-drive that our self-sufficient service here can handle a generic `exception` or any other exception of any type. Since there are no dependencies injected, it's impossible to tag an exception the regular way where we do:
```csharp
this.someDependency.Setup(dependency =>
dependency.GetStuff())
.Throws(exception);
```
The solution here is to create inner dependencies. A self-sufficient service can rely on multiple other private static functions to perform certain functions. We can mock these functions without changing the exception handling code as follows:
Let's say our service looks like this:
```csharp
public string RetrieveStudentFullName(string firstName, string lastName)
{
ValidateStudentName(firstName, lastName);
return $"{firstName} {lastName}";
}
```
We can write the test as follows to make the `ValidateStudentName` function throw an exception as follows:
```csharp
[Fact]
public void ShouldThrowServiceExceptionOnRetrieveStudentFullNameIfServiceErrorOccurrs3()
{
// given
var exception = new Exception();
this.studentService.Mock(
methodName: "ValidateStudentName")
.Throws(exception);
// when
Action retrieveStudentFullNameAction = () =>
this.studentService.RetrieveStudentFullName(
firstName: "Hassan",
lastName: "Habib");
// then
Assert.Throws(retrieveStudentFullNameAction);
this.studentService.ClearAllOtherCalls();
}
```
And now we can make that very same test pass by doing the following:
```csharp
public string RetrieveStudentFullName(string firstName, string lastName)
{
try
{
ValidateStudentName(firstName, lastName);
return $"{firstName} {lastName}";
}
catch (Exception exception)
{
throw new StudentServiceException(exception);
}
}
```
## Contact us
For more information contact Hassan Habib: [email protected]
Also join our Standard Community on Discord Community here:
[](https://discord.gg/vdPZ7hS52X)