C# Automated App Testing

This guide will help you run mobile automated tests with Appium and C# on the TestingBot device cloud.

TestingBot has created a sample Visual Studio project to help you get started with C# and Appium testing.

Download ZIP

You can import this project into Visual Studio and run the tests directly.

To run your tests with C# and .NET, you need to have the .NET SDK installed on your machine.

On Windows:
- Download the .NET SDK installer and run it.
- Or use the winget command: winget install Microsoft.DotNet.SDK.9
On MacOS: brew install dotnet
On Linux: sudo apt-get install dotnet-sdk-9.0

After installing the .NET SDK, you can create a new NUnit test project using the command line:

dotnet new nunit -n AppiumTest
cd AppiumTest

Next, add the Appium and Selenium WebDriver packages to your project:

dotnet add package Appium.WebDriver
dotnet add package Selenium.WebDriver
dotnet add package Selenium.Support

Replace the contents of UnitTest1.cs with the example code below, then run your tests with:

TB_KEY=... TB_SECRET=... dotnet test

Installation

See our C# App example repository for a simple example on how to run C# tests on Mobile Devices with TestingBot.

Please download the appium-dotnet-driver and add it to your project.

You can use NuGet packages as well, in which case you'll need to install these packages:

Appium.WebDriver
DotNetSeleniumExtras.WaitHelpers
Selenium.WebDriver

Real Device Testing

This will download and install a sample Android app we built. It will add two numbers to a textinput and display the sum of the two numbers.

using NUnit.Framework;
using NUnit.Framework.Interfaces;
using OpenQA.Selenium;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.Android;
using OpenQA.Selenium.Support.UI;
using System;
using System.Collections.Generic;

namespace AppiumNunit
{
    [TestFixture]
    public class AndroidRealDeviceTest
    {
        private AndroidDriver? Driver;

        [Test]
        public void SampleTest()
        {
            var options = new AppiumOptions
            {
                PlatformName = "Android",
                DeviceName = "Galaxy S10",
                PlatformVersion = "10.0",
                App = "https://testingbot.com/appium/sample.apk"
            };
            options.AddAdditionalAppiumOption("tb:options", new Dictionary<string, object>
            {
                ["key"] = Environment.GetEnvironmentVariable("TB_KEY") ?? "",
                ["secret"] = Environment.GetEnvironmentVariable("TB_SECRET") ?? "",
                ["name"] = TestContext.CurrentContext.Test.Name,
                ["realDevice"] = true
            });

            Driver = new AndroidDriver(new Uri("https://hub.testingbot.com/wd/hub"), options, TimeSpan.FromSeconds(120));

            var wait = new WebDriverWait(Driver, TimeSpan.FromSeconds(30));
            var inputA = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("inputA")));
            inputA.SendKeys("10");

            var inputB = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("inputB")));
            inputB.SendKeys("5");

            Assert.Pass();
        }

        [TearDown]
        public void CleanUpAfterEveryTestMethod()
        {
            if (Driver != null)
            {
                var passed = TestContext.CurrentContext.Result.Outcome.Status == TestStatus.Passed;
                ((IJavaScriptExecutor)Driver).ExecuteScript("tb:test-result=" + (passed ? "passed" : "failed"));
                Driver.Dispose();
            }
        }
    }
}

This will download and install a sample iOS app we built. It will add two numbers to a textinput and display the sum of the two numbers.

using NUnit.Framework;
using NUnit.Framework.Interfaces;
using OpenQA.Selenium;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.iOS;
using OpenQA.Selenium.Support.UI;
using System;
using System.Collections.Generic;

namespace AppiumNunit
{
    [TestFixture]
    public class iOSRealDeviceTest
    {
        private IOSDriver? Driver;

        [Test]
        public void SampleTest()
        {
            var options = new AppiumOptions
            {
                PlatformName = "iOS",
                DeviceName = "iPhone 15",
                PlatformVersion = "17.4",
                App = "https://testingbot.com/appium/sample.ipa"
            };
            options.AddAdditionalAppiumOption("tb:options", new Dictionary<string, object>
            {
                ["key"] = Environment.GetEnvironmentVariable("TB_KEY") ?? "",
                ["secret"] = Environment.GetEnvironmentVariable("TB_SECRET") ?? "",
                ["name"] = TestContext.CurrentContext.Test.Name,
                ["realDevice"] = true
            });

            Driver = new IOSDriver(new Uri("https://hub.testingbot.com/wd/hub"), options, TimeSpan.FromSeconds(300));

            var wait = new WebDriverWait(Driver, TimeSpan.FromSeconds(30));
            var inputA = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("inputA")));
            inputA.SendKeys("10");

            var inputB = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("inputB")));
            inputB.SendKeys("5");

            var sum = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("sum")));
            Console.WriteLine(sum.Text);

            Assert.Pass();
        }

        [TearDown]
        public void CleanUpAfterEveryTestMethod()
        {
            if (Driver != null)
            {
                var passed = TestContext.CurrentContext.Result.Outcome.Status == TestStatus.Passed;
                ((IJavaScriptExecutor)Driver).ExecuteScript("tb:test-result=" + (passed ? "passed" : "failed"));
                Driver.Dispose();
            }
        }
    }
}

Simulator/Emulator Testing

This will download and install a sample Android app we built. It will add two numbers to a textinput and display the sum of the two numbers.

using NUnit.Framework;
using NUnit.Framework.Interfaces;
using OpenQA.Selenium;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.Android;
using OpenQA.Selenium.Support.UI;
using System;
using System.Collections.Generic;

namespace AppiumNunit
{
    [TestFixture]
    public class AndroidEmulatorTest
    {
        private AndroidDriver? Driver;

        [Test]
        public void SampleTest()
        {
            var options = new AppiumOptions
            {
                PlatformName = "Android",
                DeviceName = "Galaxy S9",
                PlatformVersion = "9.0",
                App = "https://testingbot.com/appium/sample.apk"
            };
            options.AddAdditionalAppiumOption("tb:options", new Dictionary<string, object>
            {
                ["key"] = Environment.GetEnvironmentVariable("TB_KEY") ?? "",
                ["secret"] = Environment.GetEnvironmentVariable("TB_SECRET") ?? "",
                ["name"] = TestContext.CurrentContext.Test.Name
            });

            Driver = new AndroidDriver(new Uri("https://hub.testingbot.com/wd/hub"), options, TimeSpan.FromSeconds(240));

            var wait = new WebDriverWait(Driver, TimeSpan.FromSeconds(30));
            var inputA = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("inputA")));
            inputA.SendKeys("10");

            var inputB = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("inputB")));
            inputB.SendKeys("5");

            Assert.Pass();
        }

        [TearDown]
        public void CleanUpAfterEveryTestMethod()
        {
            if (Driver != null)
            {
                var passed = TestContext.CurrentContext.Result.Outcome.Status == TestStatus.Passed;
                ((IJavaScriptExecutor)Driver).ExecuteScript("tb:test-result=" + (passed ? "passed" : "failed"));
                Driver.Dispose();
            }
        }
    }
}

This will download and install a sample iOS app we built. It will add two numbers to a textinput and display the sum of the two numbers.

using NUnit.Framework;
using NUnit.Framework.Interfaces;
using OpenQA.Selenium;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.iOS;
using OpenQA.Selenium.Support.UI;
using System;
using System.Collections.Generic;

namespace AppiumNunit
{
    [TestFixture]
    public class iOSSimulatorTest
    {
        private IOSDriver? Driver;

        [Test]
        public void SampleTest()
        {
            var options = new AppiumOptions
            {
                PlatformName = "iOS",
                DeviceName = "iPhone 15",
                PlatformVersion = "17.4",
                App = "https://testingbot.com/appium/sample.zip"
            };
            options.AddAdditionalAppiumOption("tb:options", new Dictionary<string, object>
            {
                ["key"] = Environment.GetEnvironmentVariable("TB_KEY") ?? "",
                ["secret"] = Environment.GetEnvironmentVariable("TB_SECRET") ?? "",
                ["name"] = TestContext.CurrentContext.Test.Name
            });

            Driver = new IOSDriver(new Uri("https://hub.testingbot.com/wd/hub"), options, TimeSpan.FromSeconds(300));

            var wait = new WebDriverWait(Driver, TimeSpan.FromSeconds(30));
            var inputA = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("inputA")));
            inputA.SendKeys("10");

            var inputB = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("inputB")));
            inputB.SendKeys("5");

            var sum = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("sum")));
            Console.WriteLine(sum.Text);

            Assert.Pass();
        }

        [TearDown]
        public void CleanUpAfterEveryTestMethod()
        {
            if (Driver != null)
            {
                var passed = TestContext.CurrentContext.Result.Outcome.Status == TestStatus.Passed;
                ((IJavaScriptExecutor)Driver).ExecuteScript("tb:test-result=" + (passed ? "passed" : "failed"));
                Driver.Dispose();
            }
        }
    }
}

Uploading Your App

Please see our Upload Mobile App documentation to find out how to upload your app to TestingBot for testing.

Specify Browsers & Devices

To run your existing tests on TestingBot, your tests will need to be configured to use the TestingBot remote machines. If the test was running on your local machine or network, you can simply change your existing test like this:

Before:

Driver = new IOSDriver(new Uri("http://localhost:4444/wd/hub"), options, TimeSpan.FromSeconds(300));

After:

Driver = new IOSDriver(new Uri("https://hub.testingbot.com/wd/hub"), options, TimeSpan.FromSeconds(300));

To let TestingBot know on which device you want to run your test on, you need to specify the appium:deviceName, appium:platformVersion, platformName and other optional options in the capabilities field.

To see how to do this, please select a combination of device type and device name in the drop-down menus below.

Testing Internal Websites

We've built TestingBot Tunnel, to provide you with a secure way to run tests against your staged/internal webapps.

Please see our TestingBot Tunnel documentation for more information about this easy to use tunneling solution.

The example below shows how to easily run a C# test with our Tunnel:

1. Download our tunnel and start the tunnel:

java -jar testingbot-tunnel.jar key secret

2. Adjust your test: instead of pointing to 'hub.testingbot.com/wd/hub' like the example above - change it to point to your tunnel's IP address.
Assuming you run the tunnel on the same machine you run your tests, change to 'localhost:4445/wd/hub'. localhost is the machine running the tunnel, 4445 is the default port of the tunnel.

This way your test will go securely through the tunnel to TestingBot and back:

using NUnit.Framework;
using NUnit.Framework.Interfaces;
using OpenQA.Selenium;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.iOS;
using OpenQA.Selenium.Support.UI;
using System;
using System.Collections.Generic;

namespace AppiumNunit
{
    [TestFixture]
    public class iOSTunnelTest
    {
        private IOSDriver? Driver;

        [Test]
        public void SampleTest()
        {
            var options = new AppiumOptions
            {
                PlatformName = "iOS",
                DeviceName = "iPhone 15",
                PlatformVersion = "17.4",
                App = "https://testingbot.com/appium/sample.zip"
            };
            options.AddAdditionalAppiumOption("tb:options", new Dictionary<string, object>
            {
                ["key"] = Environment.GetEnvironmentVariable("TB_KEY") ?? "",
                ["secret"] = Environment.GetEnvironmentVariable("TB_SECRET") ?? "",
                ["name"] = TestContext.CurrentContext.Test.Name
            });

            Driver = new IOSDriver(new Uri("http://localhost:4445/wd/hub"), options, TimeSpan.FromSeconds(300));

            var wait = new WebDriverWait(Driver, TimeSpan.FromSeconds(30));
            var inputA = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("inputA")));
            inputA.SendKeys("10");

            var inputB = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("inputB")));
            inputB.SendKeys("5");

            var sum = wait.Until(d => d.FindElement(MobileBy.AccessibilityId("sum")));
            Console.WriteLine(sum.Text);

            Assert.Pass();
        }

        [TearDown]
        public void CleanUpAfterEveryTestMethod()
        {
            if (Driver != null)
            {
                var passed = TestContext.CurrentContext.Result.Outcome.Status == TestStatus.Passed;
                ((IJavaScriptExecutor)Driver).ExecuteScript("tb:test-result=" + (passed ? "passed" : "failed"));
                Driver.Dispose();
            }
        }
    }
}

Run tests in Parallel

Parallel Testing means running the same test, or multiple tests, simultaneously. This greatly reduces your total testing time.

You can run the same tests on all different browser configurations or run different tests all on the same browser configuration.
TestingBot has a large grid of machines and browsers, which means you can use our service to do efficient parallel testing. It is one of the key features we provide to greatly cut down on your total testing time.

Queuing

Every plan we provide comes with a limit of parallel tests.
If you exceed the number of parallel tests assigned to your account, TestingBot will queue the additional tests (for up to 6 minutes) and run the tests as soon as slots become available.

Mark tests as passed/failed

To see if a test passed or not in our member area, or to send additional meta-data to TestingBot, you can use our API.

Please see the example below on how to notify TestingBot about the test success state:

[TearDown]
public void CleanUp()
{
    if (Driver != null)
    {
        bool passed = TestContext.CurrentContext.Result.Outcome.Status == TestStatus.Passed;
        // Logs the result to TestingBot
        ((IJavaScriptExecutor)Driver).ExecuteScript("tb:test-result=" + (passed ? "passed" : "failed"));
        // Terminates the remote webdriver session
        Driver.Dispose();
    }
}

Preparing your App

You do not need to install any code or plugin to run a test.
Below are some things that are necessary to successfully run a mobile test:

For Android:

Please supply the URL to your .apk or .aab file.
Important: the .apk file needs to be a x86 build (x86 ABI) for Android emulators.

For iOS Real Device:

Please supply the URL to an .ipa file.

For iOS Simulator:

Please supply the URL to a .zip file that contains your .app
The .app needs to be an iOS Simulator build:
- Create a Simulator build:
```
xcodebuild -sdk iphonesimulator -configuration Debug
```
- Zip the .app bundle:
```
zip -r MyApp.zip MyApp.app
```

Additional Options

Appium provides a lot of options to configure your test.

Some important options that might help:

For Android:

appActivity and appPackage: by default, Appium will try to extract the main Activity from your apk. If this fails, you can supply your own with these options.
chromeOptions: additional chromedriver options you can supply.
otherApps: a JSON array of other apps that need to be installed, in URL format.

For Android & iOS:

locale: the language of the simulator/device (ex: fr_CA)

This sets the locale on the entire device/simulator, except on physical iOS devices. For real iOS devices, we will pass -AppleLocale as argument to the app.
newCommandTimeout: How long (in seconds) Appium will wait for a new command from the client before assuming the client quit and ending the session