Xamarin.Forms - UI Test


Xamarin.Forms - UI Test

Xamarin.Forms code runs on multiple platforms - each one has its own filesystem. This means that reading and writing files are most easily done using the native file APIs on each platform. Alternatively, embedded resources are a simpler solution to distribute data files with an app.


Xamarin.UITest is a C# testing framework using NUnit for UI Acceptance Tests on iOS and Android apps. It integrates tightly with Xamarin.iOS and Xamarin.Android projects, Xamarin.UITest is the Automation Library that allows the NUnit tests to execute on Android and iOS devices. The tests interact with the user interface as a user would - entering text, tapping buttons, and gestures - such as swipes.

Like Appium and Robot Framework, Xamarin.UITest is among the best open-source, cross-platform UI testing framework. It is a more straightforward choice when it comes to automating Android and iOS apps built with Xamarin.Forms. 

Follow the Arrange-Act-Assert pattern

Arrange - The test will set up conditions and initialize things so that the test can be actioned.

Act - The test will interact with the application, enter text, pushing buttons, and so on.

Assert - The test examines the results of the actions run in the Act step to determine correctness. For example, the application may verify that a particular error message is displayed.


  • Visual Studio 2017 or later (Windows or Mac)

Setting up a Xamarin.Forms Project

Start by creating a new Xamarin.Forms project. You wíll learn more by going through the steps yourself.
Create a new or existing Xamarin forms(.Net standard) Project. With Android and iOS Platform. 

Xamarin.Forms - UI Test

Add UI Test Project

Now, add the UI Test project to your existing Xamarin.forms project. Go to your solution add a new project select Xamarin UI Project refer to the following screenshot.

Xamarin.Forms - UI Test

Name your UI Test project then click on create to add.

Xamarin.Forms - UI Test

Use AutomationId

  1. AutomationId should be added to all UI controls that are required for UI testing.
  2. AutomationId is a Dependency Property that can also be set with a binding expression.
  3. InvalidOperationException will be thrown if an attempt is made to set the AutomationId property of an element more than once.
  4. AutomationId and X:Name are different. You must set AutomationId for all controls.

Ex: AutomationId="EntryPhoneNumber"

Create a UI

Here, I'm going to create a simple UI for UI Testing.


<?xml version="1.0" encoding="utf-8"?>
<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
             mc:Ignorable="d" x:Class="XamarinApp.MainPage">


    <StackLayout Margin="0,50,0,0" VerticalOptions="StartAndExpand">
        <Image VerticalOptions="Center" Source="xamarinmonkeysbanner.png"/>

        <Entry AutomationId="EntryPhoneNumber" Placeholder="Enter Phone Number" x:Name="entryPhoneNumber"/>
        <Button AutomationId="ValidateButton" Text="Validate" Clicked="PhoneNumberValidate"/>
        <Label AutomationId="ResultLabel" x:Name="lblResult"/>

Configure App

Here, you need to configure both iOS and Android App paths as you can see in the below code,


public static IApp StartApp(Platform platform) {
    if (platform == Platform.Android) {
        return ConfigureApp.Android.Debug().ApkFile("../../../XamarinApp.Android/bin/Debug/com.companyname.xamarinapp.apk").StartApp();
    return ConfigureApp.iOS.AppBundle("../../../XamarinApp.iOS/bin/iPhoneSimulator/Debug/XamarinApp.iOS.app").StartApp();


You can specify your APK path. Go to your Android project debug/bin folder you can find the com.companyname.xamarinapp.apk file. You can copy the file path and set the ApkFile.

Xamarin.Forms - UI Test


The device can be specified using the DeviceSerial method,



Specify the iOS IPA path. Go to your iOS debug/bin folder you can find the AppName.iOS file. You can copy the file path from here and set the AppBundle.

Xamarin.Forms - UI Test


iOS Enable Test Cloud

To run tests on iOS, the Xamarin Test Cloud Agent NuGet package must be added to the project. Once it's been added, add the following code into the AppDelegate.FinishedLaunching method.

Xamarin Test Cloud Agent NuGet package

Xamarin.Forms - UI Test


public override bool FinishedLaunching(UIApplication app, NSDictionary options)
    LoadApplication(new App());
    return base.FinishedLaunching(app, options);

Set Compiler Variable

Set compiler variable to your iOS app. Go to the project option in the Compiler section set define symbols. "ENABLE_TEST_CLOUD" refer to the below screenshot.

Xamarin.Forms - UI Test

Write UI Test

Now, I'm going to write the Automation UI Test for PhoneNumber validation. See the below code,

public class Tests
    IApp app;
    Platform platform;

    public Tests(Platform platform)
        this.platform = platform;

    public void BeforeEachTest()
        app = AppInitializer.StartApp(platform);

    public void PhoneNumberValidateTest()
        app.WaitForElement(c => c.Marked("EntryPhoneNumber"));
        app.EnterText(c => c.Marked("EntryPhoneNumber"),"1234567890");

        app.Tap(c => c.Marked("ValidateButton"));
        AppResult[] results = app.WaitForElement(c => c.Marked("ResultLabel"));


Xamarin.Forms - UI Test

The test method has been passed.

Download full source from Github



I hope you learned how to test Xamarin UI Elements Xamarin.Forms.
Thanks for reading. Please share your comments and feedback. 

Happy Coding :)