https://github.com/jfversluis/Plugin.Maui.UITestHelpers

A set of helpers to support UI testing your .NET MAUI app and migration from Xamarin.UITest to Appium
https://github.com/jfversluis/Plugin.Maui.UITestHelpers

android appium dotnet dotnet-maui ios macos maui nunit ui-testing uitest windows xamarin-uitest

Last synced: 30 days ago
JSON representation

A set of helpers to support UI testing your .NET MAUI app and migration from Xamarin.UITest to Appium

• Host: GitHub
• URL: https://github.com/jfversluis/Plugin.Maui.UITestHelpers
• Owner: jfversluis
• License: mit
• Created: 2024-03-11T11:38:21.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-09-04T08:08:44.000Z (3 months ago)
• Last Synced: 2024-11-10T16:52:06.245Z (about 1 month ago)
• Topics: android, appium, dotnet, dotnet-maui, ios, macos, maui, nunit, ui-testing, uitest, windows, xamarin-uitest
• Language: C#
• Homepage:
• Size: 319 KB
• Stars: 15
• Watchers: 3
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-dotnet-maui - Plugin.Maui.UITestHelpers - square)](https://github.com/jfversluis/Plugin.Maui.UITestHelpers/stargazers)|[](https://github.com/jfversluis/Plugin.Maui.UITestHelpers/commits) (Plugins)

README

        
![](https://raw.githubusercontent.com/jfversluis/Plugin.Maui.UITestHelpers/main/nuget.png)

# Plugin.Maui.UITestHelpers

`Plugin.Maui.UITestHelpers` provides a set of helpers to support UI testing your .NET MAUI app with Appium and migration from Xamarin.UITest to Appium. It consists of three packages, see below for more information.

The set of helpers are extracted from the .NET MAUI codebase ([here](https://github.com/dotnet/maui/tree/main/src/TestUtils/src), the folders prefixed UITest) this code can help with writing UI tests with Appium and/or transition your existing Xamarin.UITest tests to Appium.

> [!WARNING]  

> At this time this project is not officially supported and experimental.

> Feel free to let us know your feedback and provide pull requests to make it even better.

> There is no guarantee this will become something more official.

But if you like what you see and help make it better... It might! 

## Install Plugin

This project consists of three packages. please find the details below. All packages are available on NuGet.

| Package Name | Description | NuGet Package |

|----------|------------|---------------|

| Plugin.Maui.UITestHelpers.Core   | Shared, core types that are used across the different projects | [![NuGet Version](https://img.shields.io/nuget/vpre/Plugin.Maui.UITestHelpers.Core)](https://www.nuget.org/packages/Plugin.Maui.UITestHelpers.Core/1.0.0-preview1) |

| Plugin.Maui.UITestHelpers.Appium | This package contains code specific to UI testing with Appium. It's filled with helpers that will make writing UI tests easier, as well as methods that (mostly) mimic Xamarin.UITest to make transitioning your current UI tests easier | [![NuGet Version](https://img.shields.io/nuget/vpre/Plugin.Maui.UITestHelpers.Appium)](https://www.nuget.org/packages/Plugin.Maui.UITestHelpers.Appium/1.0.0-preview1) |

| Plugin.Maui.UITestHelpers.NUnit | This package contains helpers that will make it easier to write UI tests based on NUnit | [![NuGet Version](https://img.shields.io/nuget/vpre/Plugin.Maui.UITestHelpers.NUnit)](https://www.nuget.org/packages/Plugin.Maui.UITestHelpers.NUnit/1.0.0-preview1) |

Install with the dotnet CLI, for example: `dotnet add package Plugin.Maui.UITestHelpers.Appium`, or through the NuGet Package Manager in Visual Studio.

### Supported Platforms

All platforms that are supported by the cross section of the support of Appium and .NET MAUI.

# Acknowledgements

This project could not have came to be without these projects and people, thank you! <3

The original source was extracted from the [.NET MAUI codebase](https://github.com/dotnet/maui) so all credit goes out to that team, namely @sbanni, @mattleibow, @PureWeen, @MartyIX, @jsuarezruiz, @jfversluis and @rmarinho.