HeadlessTestingFramework 11.3.9.1

HeadlessTestingFramework

A comprehensive touch input simulator, gesture recognizer test helpers, tree traversal utilities, and headless screen recorder for testing Avalonia controls.

Installation

dotnet add package HeadlessTestingFramework

Features

• Touch Simulation - Simulate tap, drag, swipe, pinch, and multi-touch gestures
• Keyboard Simulation - Key presses, shortcuts, text input
• Mouse Simulation - Clicks, drag-and-drop, wheel scroll
• Gesture Recognition - Trigger actual Avalonia gesture recognizers
• Tree Navigation - Find controls with fluent API, XPath queries, or type-safe methods
• Tree Validation - Assert visual tree structure with chainable rules
• Tree Comparison - Diff two visual trees for changes
• Appium-like API - Selenium/Appium-style testing with familiar patterns
• Screen Recording - Capture frames during tests for visual regression

Quick Start

using Avalonia.HeadlessTestingFramework;

[AvaloniaFact]
public void Button_Click_Test()
{
    var window = new Window { Content = new Button { Name = "MyButton" } };
    window.Show();
    
    var button = window.FindFirst<Button>();
    var simulator = new TouchInputSimulator();
    
    bool clicked = false;
    button.Click += (s, e) => clicked = true;
    
    simulator.Tap(button, new Point(10, 10));
    
    Assert.True(clicked);
}

Which API Should I Use?

⚠️ Important: Gesture Handler Registration

When testing gesture events (Pinch, Scroll, etc.), handlers must be registered BEFORE window.Show():

// ✅ CORRECT
var control = new MyControl();
Gestures.AddPinchHandler(control, handler);  // Register FIRST
var window = new Window { Content = control };
window.Show();  // Show AFTER

// ❌ WRONG - events won't fire
var window = new Window { Content = control };
window.Show();  // Show FIRST
Gestures.AddPinchHandler(control, handler);  // Too late!

Documentation

📖 Full API Documentation - Complete reference with examples

The full documentation includes:

• Detailed API reference for all components
• Code examples for common scenarios
• Appium compatibility matrix
• Migration guides from Selenium/Appium
• Troubleshooting tips

Core Components

Requirements

• .NET 6.0, .NET 8.0, .NET 10.0, or .NET Standard 2.0
• Avalonia 11.x

License

MIT License - see LICENSE.TXT for details.