Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/VerifyTests/Verify.Avalonia
Extends Verify to allow verification of Avalonia UIs
https://github.com/VerifyTests/Verify.Avalonia
Last synced: 27 days ago
JSON representation
Extends Verify to allow verification of Avalonia UIs
- Host: GitHub
- URL: https://github.com/VerifyTests/Verify.Avalonia
- Owner: VerifyTests
- License: mit
- Created: 2023-08-19T01:16:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-29T21:49:43.000Z (8 months ago)
- Last Synced: 2024-05-01T09:37:51.637Z (8 months ago)
- Language: C#
- Homepage:
- Size: 903 KB
- Stars: 31
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license.txt
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
- awesome-avalonia - Verify.Avalonia - Extends Verify to allow verification of Avalonia UIs using headless testing. (Libraries & Extensions / Generic)
README
# 
Verify.Avalonia
[](https://github.com/orgs/VerifyTests/discussions)
[](https://ci.appveyor.com/project/SimonCropp/verify-avalonia)
[](https://www.nuget.org/packages/Verify.Avalonia/)
Extends [Verify](https://github.com/VerifyTests/Verify) to allow verification of [Avalonia UIs](https://avaloniaui.net/).
## Getting Started
The test project needs a `ModuleInitializer` and an Avalonia application with a `Style`.
```cs
[assembly: AvaloniaTestApplication(typeof(VerifyAvaloniaSetupApplication))]
public class VerifyAvaloniaSetupApplication : Application
{
[ModuleInitializer]
public static void Init()
{
VerifyImageMagick.RegisterComparers(.24);
VerifierSettings.InitializePlugins();
}
public static AppBuilder BuildAvaloniaApp() =>
AppBuilder
.Configure()
.UseSkia()
.UseHeadless(
new()
{
UseHeadlessDrawing = false
});
public VerifyAvaloniaSetupApplication() =>
Styles.Add(new FluentTheme());
}
```
snippet source | anchor
And add the following NuGet packages:
- https://nuget.org/packages/Verify.Avalonia/
- https://nuget.org/packages/Avalonia.Headless.XUnit/
- https://nuget.org/packages/Avalonia.Themes.Fluent/
- https://nuget.org/packages/Avalonia.Skia/
## More details
**See [Milestones](../../milestones?state=closed) for release notes.**
**Currently only supported in XUnit since [AvaloniaTestAttribute results in incorrect TestContext.Test.MethodName in NUnit](https://github.com/AvaloniaUI/Avalonia/issues/12590)**
Leverages [Avalonia Headless Testing](https://docs.avaloniaui.net/docs/next/concepts/headless).
See [Headless Testing with XUnit](https://docs.avaloniaui.net/docs/next/concepts/headless/headless-xunit) and [Headless Testing with NUnit](https://docs.avaloniaui.net/docs/next/concepts/headless/headless-nunit) for more information.
### ModuleInitializer
```cs
[ModuleInitializer]
public static void Init()
{
VerifyImageMagick.RegisterComparers(.097);
VerifyAvalonia.Initialize();
}
```
snippet source | anchor
This sample uses [Verify.ImageMagick](https://github.com/VerifyTests/Verify.ImageMagick) to ignore small rendering differences that are expected between different operating systems.
Other [comparers](https://github.com/VerifyTests/Verify/blob/main/docs/comparer.md) options:
* https://github.com/VerifyTests/Verify.ImageHash
* https://github.com/VerifyTests/Verify.ImageMagick
* https://github.com/VerifyTests/Verify.Phash
* https://github.com/VerifyTests/Verify.ImageSharp.Compare
### Verify.CommunityToolkit.Mvvm
Many Avalonia projects use [CommunityToolkit.Mvvm](https://learn.microsoft.com/en-us/dotnet/communitytoolkit/mvvm/). To ensure proper serialization of MVVM commands, use [Verify.CommunityToolkit.Mvvm](https://github.com/VerifyTests/Verify.CommunityToolkit.Mvvm).
### InternalsVisibleTo
Ensure tests projects have InternalsVisibleTo configured in the target app so tests can use generated controls by name.
```
snippet source | anchor
### Initialize AvaloniaTestApplication
The `[AvaloniaTestApplication]` attribute wires the tests in the current project with the specific application. It needs to be defined once per project in any file. Verify.Avalonia requires that `UseHeadlessDrawing` is disabled and `.UseSkia()` is set.
```cs
[assembly: AvaloniaTestApplication(typeof(TestAppBuilder))]
public static class TestAppBuilder
{
public static AppBuilder BuildAvaloniaApp() =>
AppBuilder.Configure()
.UseSkia()
.UseHeadless(
new()
{
UseHeadlessDrawing = false
});
}
```
snippet source | anchor
### Test
```cs
[SuppressMessage("Performance", "CA1822:Mark members as static")]
public class CalculatorTests
{
[AvaloniaFact]
public Task Should_Add_Numbers()
{
var window = new MainWindow
{
DataContext = new MainWindowViewModel()
};
window.Show();
// Set values to the input boxes
window.FirstOperandInput.Text = "10";
window.SecondOperandInput.Text = "20";
// Raise click event on the button:
window.AddButton.Focus();
window.KeyPressQwerty(PhysicalKey.Enter, RawInputModifiers.None);
Assert.Equal("30", window.ResultBox.Text);
return Verify(window);
}
}
```
snippet source | anchor
### Result in the following snapshots
#### Image
[Should_Add_Numbers.verified.verified.png](/src/XUnitTests/CalculatorTests.Should_Add_Numbers.verified.png):
#### Text
```txt
{
Type: MainWindow,
SizeToContent: WidthAndHeight,
Title: Simple Calculator,
CanResize: false,
Content: {
Type: StackPanel,
Spacing: 10.0,
Width: 280.0,
Height: 175.0,
Margin: 10,
HorizontalAlignment: Left,
Children: [
{
Type: TextBox,
Text: 10,
Watermark: Operand 1,
Name: FirstOperandInput
},
{
Type: TextBox,
Text: 20,
Watermark: Operand 2,
Name: SecondOperandInput
},
{
Type: UniformGrid,
Columns: 4,
Children: [
{
Type: Button,
Command: MainWindowViewModel.Add(),
Content: +,
Name: AddButton
},
{
Type: Button,
Command: MainWindowViewModel.Subtract(),
Content: -,
Name: SubtractButton
},
{
Type: Button,
Command: MainWindowViewModel.Multiply(),
Content: *,
Name: MultiplyButton
},
{
Type: Button,
Command: MainWindowViewModel.Divide(),
Content: /,
Name: DivideButton
}
]
},
{
Type: StackPanel,
Spacing: 10.0,
Orientation: Horizontal,
Children: [
{
Type: TextBlock,
Text: Result:
},
{
Type: TextBlock,
Text: 30,
Name: ResultBox
}
]
}
]
},
Background: LightGray,
Width: 300.0,
Height: 195.0,
IsVisible: true,
DataContext: {
FirstOperand: 10.0,
SecondOperand: 20.0,
Result: 30,
AddCommand: MainWindowViewModel.Add(),
SubtractCommand: MainWindowViewModel.Subtract(),
MultiplyCommand: MainWindowViewModel.Multiply(),
DivideCommand: MainWindowViewModel.Divide()
}
}
```
snippet source | anchor