Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/buraksenyurt/resistance
It is a library containing functions that create a chaotic environment for durability tests in web app environments.
https://github.com/buraksenyurt/resistance
chaos-engineering distributed-systems dotnet-core resiliency
Last synced: 2 months ago
JSON representation
It is a library containing functions that create a chaotic environment for durability tests in web app environments.
- Host: GitHub
- URL: https://github.com/buraksenyurt/resistance
- Owner: buraksenyurt
- License: mit
- Created: 2024-08-19T16:25:45.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-23T21:49:00.000Z (4 months ago)
- Last Synced: 2024-10-13T01:41:48.781Z (2 months ago)
- Topics: chaos-engineering, distributed-systems, dotnet-core, resiliency
- Language: C#
- Homepage: https://www.nuget.org/packages/Resistance/
- Size: 45.9 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Resistance
It is a library containing functions that create a chaotic environment for durability tests in web app environments.
In distributed systems, it is important that the whole is durable. The functions in this package can be added to an Asp.Net Runtime Middleware line. The following situations can be simulated in server or service environments.
## Simulation Scenarios
- Latency: Generating delays in service response times. For example delaying the response by 500 to 2500 milliseconds.
- Resource Race: Simulating receiving too many requests.
- Outage: Providing service interruption for certain periods of time. For example, a service outage of ten seconds in every minute.
- Network Failure: It ensures that HTTP 500 is returned based on a certain percentage of service calls.
- Data Inconsistency: Data corruption on the response body. For example, adding text-based information to the body of every second response.
## Usage
By default, all simulation behaviors are disabled. These values can be enabled via appSettings. For more detailed settings, the Middleware function is used.
```json
{
"ResistanceFlags": {
"NetworkFailureIsActive": true,
"LatencyIsActive": false,
"ResourceRaceIsActive": true,
"OutageIsActive": false,
"DataInconsistencyIsActive": false
}
}
```
Code example;
```csharp
// For appSettings based options
builder.Services.Configure(builder.Configuration.GetSection("ResistanceFlags"));
app.UseResistance(new ResistanceOptions
{
// Network Failure (HTTP 500 Internal Service Error with %25 probility)
NetworkFailureProbability = NetworkFailureProbability.Percent25,
// For 5 requests coming from the same IP every 10 seconds, the HTTP 429 Too Many Requests scenario is generated.
ResourceRacePeriod = new ResourceRacePeriod
{
DueTime = TimeSpan.FromSeconds(5),
Period = TimeSpan.FromSeconds(5),
RequestLimit = 5
},
// Manipulating response data with %50 probability
DataInconsistencyProbability = DataInconsistencyProbability.Percent20,
// Produce HTTP 503 Service Unavailable 10 seconds per minute
OutagePeriod = new OutagePeriod
{
Duration = TimeSpan.FromSeconds(10),
Frequency = TimeSpan.FromMinutes(1)
},
// Latency 500 millisecdons - 2500 milliseconds
LatencyPeriod = new LatencyPeriod
{
MinDelayMs = TimeSpan.FromMilliseconds(500),
MaxDelayMs = TimeSpan.FromMilliseconds(2500)
}
});
```
## Test App
Resistance.Test Api application can be used to test Nuget package. After referencing the package from Nuget repo, tests can be performed with Swagger interface or Postman, simple Curl command or Resistance.TestClient console application(Suggested).
```bash
dotnet run
# The port address may differ
curl -X 'GET' \
'http://localhost:5225/getSalary' \
-H 'accept: */*'
```
For example, when the Network Failure behavior is enabled, one of the expected results should be as follows.
The tests performed with the Console application are as follows.
### Outage Test
The service is down for 10 seconds every minute.
### Network Failure Test
HTTP 500 Internal Service Error error is returned with a 25% probability.
### Latency Test
There will be a delay in service response times.
### Data Inconsistency Test
Service response data is manipulated with a certain probability value.
### Resource Race Test
The service returns HTTP code 429, indicating that it has received too many requests. For 5 requests coming from the same IP every 10 seconds, the HTTP 429 Too Many Requests scenario is generated.
