SpecFlow Automated App Testing

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

This example project can be used with Visual Studio, or via terminal: dotnet test.

SpecFlow is an open-source .NET utility which allows you to write tests using Cucumber-compatible Gherkin syntax.

Installation

We'll assume you are using Visual Studio to run your tests.
Here are the steps to set up the required environment for your SpecFlow tests:

Add NuGet Packages: Appium.WebDriver, NUnit, SpecFlow
For more information, please see the SpecFlow documentation.

In the example below, we'll create a calculator test that enters 2 numbers in 2 input fields and validates the sum.

The app used in the example is a demo app we created at TestingBot and runs on both iOS and Android.

SpecFlow Example

First, we'll create the feature file feature.feature:

Feature: Calculator

Scenario Outline: Can do simple math
    Given I am using the calculator
    When I add inputA for "5"
    When I add inputB for "10"
    Then I should see the sum "15"

Now we need to define the logic behind these steps:

SingleStep.cs

using NUnit.Framework;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.Android;
using TechTalk.SpecFlow;

namespace testingbot_specflow
{
    [Binding]
    public class SingleStep
    {
        private AppiumDriver<AndroidElement> _driver;
        readonly TestingBotDriver _tbDriver;

        public SingleStep()
        {
            _tbDriver = (TestingBotDriver) ScenarioContext.Current["tbDriver"];
        }

        [Given(@"I am using the calculator")]
        public void GivenIAmOnTheGooglePage()
        {
            _driver = _tbDriver.Init();
            _driver.LaunchApp();
        }

        [When(@"I add inputA for ""(.*)""")]
        public void WhenIAddA(string amount)
        {
            AndroidElement inputA = _driver.FindElementById("inputA");
            inputA.SendKeys(amount);
        }

        [When(@"I add inputB for ""(.*)""")]
        public void WhenIAddB(string amount)
        {
            AndroidElement inputB = _driver.FindElementById("inputB");
            inputB.SendKeys(amount);
        }

        [Then(@"I should see the sum ""(.*)""")]
        public void ThenIShouldSeeTitle(string sum)
        {
            Assert.That(_driver.FindElementByXPath("//android.widget.EditText[@content-desc=\"sum\"]").Text, Is.EqualTo(sum));
        }
    }
}

Finally, we'll need to create the TestingBotDriver:

using System;
using OpenQA.Selenium;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.Android;
using OpenQA.Selenium.Appium.Enums;
using TechTalk.SpecFlow;

namespace testingbot_specflow
{
    [Binding]
    public sealed class testingbot_specflow
    {
        private TestingBotDriver tbDriver;

        [BeforeScenario]
        public void BeforeScenario()
        {
            tbDriver = new TestingBotDriver(ScenarioContext.Current);
            ScenarioContext.Current["tbDriver"] = tbDriver;
        }

        [AfterScenario]
        public void AfterScenario()
        {
            tbDriver.Cleanup();
        }
    }

    public class TestingBotDriver
    {
        private AppiumDriver<AndroidElement> driver;
        private ScenarioContext current;

        public TestingBotDriver(ScenarioContext current)
        {
            this.current = current;
        }

        public AppiumDriver<AndroidElement> Init()
        {
            AppiumOptions appiumOptions = new AppiumOptions();
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.DeviceName, "Galaxy S9");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.PlatformName, "Android");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.PlatformVersion, "9.0");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.App, "tb://...");

            String key = "TB_KEY";
            String secret = "TB_SECRET";

            appiumOptions.AddAdditionalCapability("key", key);
            appiumOptions.AddAdditionalCapability("secret", secret);

            AppiumDriver<AndroidElement> driver = new AndroidDriver<AndroidElement>(
                new Uri("https://hub.testingbot.com/wd/hub"),
                appiumOptions
            );
            return driver;
        }

        public void Cleanup()
        {
            if (driver != null)
            {
                driver.Quit();
            }
        }
    }
}

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 System;
using OpenQA.Selenium;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.Android;
using OpenQA.Selenium.Appium.Enums;
using TechTalk.SpecFlow;

namespace testingbot_specflow
{
    [Binding]
    public sealed class testingbot_specflow
    {
        private TestingBotDriver tbDriver;

        [BeforeScenario]
        public void BeforeScenario()
        {
            tbDriver = new TestingBotDriver(ScenarioContext.Current);
            ScenarioContext.Current["tbDriver"] = tbDriver;
        }

        [AfterScenario]
        public void AfterScenario()
        {
            tbDriver.Cleanup();
        }
    }

    public class TestingBotDriver
    {
        private AppiumDriver<AndroidElement> driver;
        private ScenarioContext current;

        public TestingBotDriver(ScenarioContext current)
        {
            this.current = current;
        }

        public AppiumDriver<AndroidElement> Init()
        {
            AppiumOptions appiumOptions = new AppiumOptions();
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.DeviceName, "Galaxy S10");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.PlatformName, "Android");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.PlatformVersion, "10.0");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.App, "tb://...");
            appiumOptions.AddAdditionalCapability("realDevice", true);
            appiumOptions.AddAdditionalCapability("key", Environment.GetEnvironmentVariable("TB_KEY"));
            appiumOptions.AddAdditionalCapability("secret", Environment.GetEnvironmentVariable("TB_SECRET"));

            AppiumDriver<AndroidElement> driver = new AndroidDriver<AndroidElement>(
                new Uri("https://hub.testingbot.com/wd/hub"),
                appiumOptions
            );
            return driver;
        }

        public void Cleanup()
        {
            if (driver != null)
            {
                driver.Quit();
            }
        }
    }
}

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 System;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.Enums;
using OpenQA.Selenium.Appium.iOS;
using TechTalk.SpecFlow;

namespace testingbot_specflow
{
    [Binding]
    public sealed class testingbot_specflow
    {
        private TestingBotDriver tbDriver;

        [BeforeScenario]
        public void BeforeScenario()
        {
            tbDriver = new TestingBotDriver(ScenarioContext.Current);
            ScenarioContext.Current["tbDriver"] = tbDriver;
        }

        [AfterScenario]
        public void AfterScenario()
        {
            tbDriver.Cleanup();
        }
    }

    public class TestingBotDriver
    {
        private IOSDriver<IOSElement> driver;
        private ScenarioContext current;

        public TestingBotDriver(ScenarioContext current)
        {
            this.current = current;
        }

        public IOSDriver<IOSElement> Init()
        {
            AppiumOptions appiumOptions = new AppiumOptions();
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.DeviceName, "iPhone 11");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.PlatformName, "iOS");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.PlatformVersion, "13.5");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.App, "tb://...");
            appiumOptions.AddAdditionalCapability("realDevice", true);
            appiumOptions.AddAdditionalCapability("key", Environment.GetEnvironmentVariable("TB_KEY"));
            appiumOptions.AddAdditionalCapability("secret", Environment.GetEnvironmentVariable("TB_SECRET"));

            IOSDriver<IOSElement> driver = new IOSDriver<IOSElement>(
                new Uri("https://hub.testingbot.com/wd/hub"),
                appiumOptions
            );
            return driver;
        }

        public void Cleanup()
        {
            if (driver != null)
            {
                driver.Quit();
            }
        }
    }
}

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 System;
using OpenQA.Selenium;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.Android;
using OpenQA.Selenium.Appium.Enums;
using TechTalk.SpecFlow;

namespace testingbot_specflow
{
    [Binding]
    public sealed class testingbot_specflow
    {
        private TestingBotDriver tbDriver;

        [BeforeScenario]
        public void BeforeScenario()
        {
            tbDriver = new TestingBotDriver(ScenarioContext.Current);
            ScenarioContext.Current["tbDriver"] = tbDriver;
        }

        [AfterScenario]
        public void AfterScenario()
        {
            tbDriver.Cleanup();
        }
    }

    public class TestingBotDriver
    {
        private AppiumDriver<AndroidElement> driver;
        private ScenarioContext current;

        public TestingBotDriver(ScenarioContext current)
        {
            this.current = current;
        }

        public AppiumDriver<AndroidElement> Init()
        {
            AppiumOptions appiumOptions = new AppiumOptions();
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.DeviceName, "Galaxy S9");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.PlatformName, "Android");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.PlatformVersion, "9.0");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.App, "tb://...");
            appiumOptions.AddAdditionalCapability("key", Environment.GetEnvironmentVariable("TB_KEY"));
            appiumOptions.AddAdditionalCapability("secret", Environment.GetEnvironmentVariable("TB_SECRET"));

            AppiumDriver<AndroidElement> driver = new AndroidDriver<AndroidElement>(
                new Uri("https://hub.testingbot.com/wd/hub"),
                appiumOptions
            );
            return driver;
        }

        public void Cleanup()
        {
            if (driver != null)
            {
                driver.Quit();
            }
        }
    }
}

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 System;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.Enums;
using OpenQA.Selenium.Appium.iOS;
using TechTalk.SpecFlow;

namespace testingbot_specflow
{
    [Binding]
    public sealed class testingbot_specflow
    {
        private TestingBotDriver tbDriver;

        [BeforeScenario]
        public void BeforeScenario()
        {
            tbDriver = new TestingBotDriver(ScenarioContext.Current);
            ScenarioContext.Current["tbDriver"] = tbDriver;
        }

        [AfterScenario]
        public void AfterScenario()
        {
            tbDriver.Cleanup();
        }
    }

    public class TestingBotDriver
    {
        private IOSDriver<IOSElement> driver;
        private ScenarioContext current;

        public TestingBotDriver(ScenarioContext current)
        {
            this.current = current;
        }

        public IOSDriver<IOSElement> Init()
        {
            AppiumOptions appiumOptions = new AppiumOptions();
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.DeviceName, "iPhone 11");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.PlatformName, "iOS");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.PlatformVersion, "13.5");
            appiumOptions.AddAdditionalCapability(MobileCapabilityType.App, "tb://...");
            appiumOptions.AddAdditionalCapability("key", Environment.GetEnvironmentVariable("TB_KEY"));
            appiumOptions.AddAdditionalCapability("secret", Environment.GetEnvironmentVariable("TB_SECRET"));

            IOSDriver<IOSElement> driver = new IOSDriver<IOSElement>(
                new Uri("https://hub.testingbot.com/wd/hub"),
                appiumOptions
            );
            return driver;
        }

        public void Cleanup()
        {
            if (driver != null)
            {
                driver.Quit();
            }
        }
    }
}

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:

IOSDriver<IOSElement> driver = new IOSDriver<IOSElement>(
    new Uri("http://localhost:4444/wd/hub"),
    appiumOptions
);

After:

IOSDriver<IOSElement> driver = new IOSDriver<IOSElement>(
    new Uri("https://hub.testingbot.com/wd/hub"),
    appiumOptions
);

Configuring Capabilities

Capabilities are key-value pairs that allows you to customize your tests on TestingBot.
Appium provides its own set of capabilities which you can specify.
TestingBot also provide its own Custom Capabilities, to customize tests ran on the TestingBot platform.

You can use the drop-down menus below to see how to configure your tests to run on a specific mobile device:

1. Select a Device Type

2. Select a Device Name

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 System;
using OpenQA.Selenium;
using OpenQA.Selenium.Remote;

namespace SeleniumTest {
  class Program {
    static void Main(string[] args) {
      IWebDriver driver;
      DesiredCapabilities capability = DesiredCapabilities.Firefox();
      capability.SetCapability("key", "key");
      capability.SetCapability("secret", "secret");
      capability.SetCapability("version", "latest-1");
      driver = new RemoteWebDriver(
        new Uri("http://localhost:4445/wd/hub/"), capability
      );
      driver.Navigate().GoToUrl("https://www.google.com/ncr");
      Console.WriteLine(driver.Title);

      IWebElement query = driver.FindElement(By.Name("q"));
      query.SendKeys("TestingBot");
      query.Submit();
      Console.WriteLine(driver.Title);

      driver.Quit();
    }
  }
}

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.

Please see our PNUnit documentation for parallel testing.

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()
    {
        bool passed = TestContext.CurrentContext.Result.Status == TestStatus.Passed;
        try
        {
            // Logs the result to TestingBot
            ((IJavaScriptExecutor)driver).ExecuteScript("tb:test-result=" + (passed ? "passed" : "failed"));
        }
        finally
        {
            // Terminates the remote webdriver session
            driver.Quit();
        }
    }

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)
newCommandTimeout: How long (in seconds) Appium will wait for a new command from the client before assuming the client quit and ending the session

Cross Browser Testing

Live Testing

Visual Testing

Smart-TV Testing

Automated App Testing

Live App Testing

Codeless Automation

Headless Testing

Automation Frameworks