xUnitV3LoadFramework 1.0.0.86

🚀 xUnitV3LoadFramework

xUnitV3LoadFramework is a robust and user-friendly load testing framework built to seamlessly integrate with xUnit and powered by Akka.NET actors. It allows developers to efficiently define, execute, and analyze parallel load test scenarios, making load testing a natural part of your automated testing workflow.

🌟 Features

Hybrid Execution Model

• Channel-based Workers: Fixed worker pools with pre-allocated channels for consistent performance
• Task-based Workers: Dynamic task creation for flexible workload handling
• Automatic Optimization: Framework automatically selects optimal worker counts based on system resources

Comprehensive Metrics

• Latency Percentiles: P50, P95, P99 latency measurements
• Throughput Analysis: Requests per second with real-time monitoring
• Resource Utilization: Memory usage, worker thread tracking, GC pressure
• Queue Time Tracking: Average and maximum queue times

xUnit v3 Integration

• Native Test Framework: Seamless integration with xUnit v3 test discovery and execution
• Attribute-based Configuration: Simple [Load] attributes for test configuration
• Test Result Integration: Load test results integrated with xUnit test results

Actor-based Architecture

• Akka.NET Foundation: Built on proven actor model for reliability and scalability
• Message-driven Processing: Asynchronous message passing for high throughput
• Fault Tolerance: Supervisor hierarchies for robust error handling

📊 Performance Highlights

• High Throughput: Tested up to 500,000 requests with sustained performance
• Low Latency: Sub-millisecond overhead for test execution framework
• Resource Efficient: Optimized memory usage and GC pressure management
• Scalable: Automatic scaling based on available system resources

🔧 System Requirements

• .NET 8.0+
• xUnit v3 (preview)
• Akka.NET 1.5.41+
• Minimum 4GB RAM for high-load scenarios
• Multi-core CPU recommended for optimal performance

⚡ Installation

Install via NuGet package manager:

dotnet add package xUnitV3LoadFramework

🚦 Quick Start

Defining a Load Test

Use the Load attribute (inheriting from FactAttribute) to configure concurrency level, duration, interval, and execution order.

Running Your Load Test

Execute your tests using the standard xUnit command:

dotnet test

📝 Usage Examples

Basic Load Test Example

Here's a clear example demonstrating how to define and execute load tests using the Specification base class and the [Load] attribute:

using xUnitV3LoadFramework.Attributes;
using xUnitV3LoadFramework.Extensions;
using xUnitV3LoadFramework.Extensions.Framework;
using System;

[assembly: TestFramework(typeof(LoadTestFramework))]

namespace xUnitLoadDemo;

public class ExampleLoadSpecification : Specification
{
    protected override void EstablishContext()
    {
        Console.WriteLine(">> Setup phase");
    }

    protected override void Because()
    {
        Console.WriteLine(">> Action phase");
    }

    [Load(order: 1, concurrency: 2, duration: 5000, interval: 500)]
    public void should_run_load_scenario_1()
    {
        Console.WriteLine(">> Running Load 1");
    }

    [Load(order: 2, concurrency: 3, duration: 7000, interval: 300)]
    public void should_run_load_scenario_2()
    {
        Console.WriteLine(">> Running Load 2");
    }
}

API Load Testing Example

public class ApiLoadTests : Specification
{
    [Load(order: 1, concurrency: 100, duration: 30000, interval: 1000)]
    public async Task<bool> When_testing_api_endpoint()
    {
        using var client = new HttpClient();
        var response = await client.GetAsync("https://api.example.com/health");
        return response.IsSuccessStatusCode;
    }
}

Each [Load] attribute defines:

• order: the test execution order
• concurrency: number of parallel executions
• duration: how long to run (in milliseconds)
• interval: delay between each wave of execution (in milliseconds)

Run your tests using:

dotnet test

📖 Documentation

Getting Started

• Quick Start Guide
• Load Attribute Configuration
• Writing Effective Tests

Architecture & Design

• Actor System Overview
• Hybrid Load Worker Design

User Guides

• Performance Optimization
• Monitoring & Metrics

API Reference

• Load Attributes
• Core Classes
• Actors
• Messages
• Models

Best Practices

• Load Test Design
• Resource Management
• Troubleshooting

Advanced Topics

• Migration from xUnit v2
• Custom Extensions
• Performance Tuning
• CI/CD Integration

Examples & Scenarios

• Database Load Testing
• API Load Testing
• Transactional Scenarios
• Real-world Examples

For comprehensive documentation, visit the docs folder.

Examples: examples

🤝 Contributing

Your contributions and feedback are always welcome!

• Submit issues or suggestions via GitHub Issues.
• Open pull requests following our Contributing Guidelines.

📜 License

This project is licensed under the MIT License.

📫 Contact

For questions, suggestions, or feedback, please open an issue or contact directly:

• Vasyl Vdovychenko
  LinkedIn | Email