Selenium with NUnit

Your guide to run Selenium Webdriver tests with NUnit on BrowserStack.

Introduction

BrowserStack gives you instant access to our Selenium Grid of 3000+ real devices and desktop browsers. Running your Selenium tests with NUnit on BrowserStack is quick. This guide will help you to:

1. Run your first test
2. Integrate your tests with BrowserStack
3. Mark tests as passed or failed
4. Debug your app

Prerequisites

• You need to have BrowserStack Username and Access key, which you can find in your account settings. If you have not created an account yet, you can sign up for a Free Trial or purchase a plan.
• Before you can start running your Selenium tests with NUnit, install NUnit and NUnit3TestAdapter using NuGet Gallery.
• Visual Studio is installed.

Run your first test

To run Selenium tests with NUnit on BrowserStack Automate, follow the below steps:

1. Clone the nunit-browserstack repo on GitHub with BrowserStack’s sample test, using the following command:

    git clone https://github.com/browserstack/nunit-browserstack.git
   

2. Open the solution NUnit-BrowserStack.sln in Visual Studio.

3. Update App.config file within nunit-browserstack/NUnit-BrowserStack/ directory with your BrowserStack Username and Access Key.

     <?xml version="1.0" encoding="utf-8" ?>
      <configuration>
        <configSections>
          <sectionGroup name="capabilities">
            <section name="parallel" type="System.Configuration.AppSettingsSection, System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
          </sectionGroup>
   
          <sectionGroup name="environments">
            <section name="chrome" type="System.Configuration.AppSettingsSection, System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
            <section name="firefox" type="System.Configuration.AppSettingsSection, System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
            <section name="safari" type="System.Configuration.AppSettingsSection, System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
            <section name="edge" type="System.Configuration.AppSettingsSection, System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
          </sectionGroup>
        </configSections>
   
        <appSettings>
          <add key="user" value="YOUR_USERNAME" />
          <add key="key" value="YOUR_ACCESS_KEY" />
          <add key="server" value="hub.browserstack.com" />
        </appSettings>
   
        <capabilities>
          <parallel>
            <add key="browserstack.debug" value="true" />
          </parallel>
        </capabilities>
   
        <environments>
          <chrome>
            <add key="browser" value="chrome" />
          </chrome>
          <firefox>
            <add key="browser" value="firefox" />
          </firefox>
          <safari>
            <add key="browser" value="safari" />
          </safari>
          <edge>
            <add key="browser" value="edge" />
          </edge>
        </environments>
      </configuration>
   

4. Run your first test on BrowserStack using the following steps:

   1. Build the solution in Visual Studio
   2. Run the test with fixture parallel from Test Explorer

5. View your test results on the BrowserStack Automate dashboard.

Details of your first test

Following is the sample NUnit test case that you ran above. The test searches for “BrowserStack” on Google, and checks if the title of the resulting page is “BrowserStack - Google Search”.

  using NUnit.Framework;
  using OpenQA.Selenium;

  namespace BrowserStack
  {
    [TestFixture("parallel", "chrome")]
    [TestFixture("parallel", "firefox")]
    [TestFixture("parallel", "safari")]
    [TestFixture("parallel", "edge")]
    [Parallelizable(ParallelScope.Fixtures)]
    public class ParallelTest : SingleTest
    {
      public ParallelTest(string profile, string environment) : base(profile, environment) { }
    }
  }

Integrate your tests with BrowserStack

The integration of your test with BrowserStack is working with the help of BrowserStackNUnitTest.cs file which contains the methods to configure and create the connection with BrowserStack as shown below:

[TestFixture]
public class BrowserStackNUnitTest
{
  protected IWebDriver driver;
  protected string profile;
  protected string environment;
  private Local browserStackLocal;

  public BrowserStackNUnitTest(string profile, string environment)
  {
    this.profile = profile;
    this.environment = environment;
  }

  [SetUp]
  public void Init()
  {
    NameValueCollection caps = ConfigurationManager.GetSection("capabilities/" + profile) as NameValueCollection;
    NameValueCollection settings = ConfigurationManager.GetSection("environments/" + environment) as NameValueCollection;

    DesiredCapabilities capability = new DesiredCapabilities();

    foreach (string key in caps.AllKeys)
    {
      capability.SetCapability(key, caps[key]);
    }

    foreach (string key in settings.AllKeys)
    {
      capability.SetCapability(key, settings[key]);
    }

    String username = Environment.GetEnvironmentVariable("BROWSERSTACK_USERNAME");
    if(username == null)
    {
      username = ConfigurationManager.AppSettings.Get("user");
    }

    String accesskey = Environment.GetEnvironmentVariable("BROWSERSTACK_ACCESS_KEY");
    if (accesskey == null)
    {
      accesskey = ConfigurationManager.AppSettings.Get("key");
    }

    capability.SetCapability("browserstack.user", username);
    capability.SetCapability("browserstack.key", accesskey);

    String appId = Environment.GetEnvironmentVariable("BROWSERSTACK_APP_ID");
    if (appId != null)
    {
      capability.SetCapability("app", appId);
    }

    if (capability.GetCapability("browserstack.local") != null && capability.GetCapability("browserstack.local").ToString() == "true")
    {
      browserStackLocal = new Local();
      List<KeyValuePair<string, string>> bsLocalArgs = new List<KeyValuePair<string, string>>() {
        new KeyValuePair<string, string>("key", accesskey)
      };
      browserStackLocal.start(bsLocalArgs);
    }

    driver = new RemoteWebDriver(new Uri("http://"+ ConfigurationManager.AppSettings.Get("server") +"/wd/hub/"), capability);
  }

  [TearDown]
  public void Cleanup()
  {
    driver.Quit();
    if (browserStackLocal != null)
    {
      browserStackLocal.stop();
    }
  }
}

Mark tests as passed or failed

BrowserStack provides a comprehensive REST API to access and update information about your tests. Shown below is a sample code snippet which allows you to mark your tests as passed or failed based on the assertions in your NUnit test cases.

namespace RestApi {
  class ChangeSessionStatus {
    static void Main(string[] args) {
      string reqString = "{\"status\":\"passed\", \"reason\":\"\"}";

      byte[] requestData = Encoding.UTF8.GetBytes(reqString);
      Uri myUri = new Uri(string.Format("https://www.browserstack.com/automate/sessions/<session-id>.json"));
      WebRequest myWebRequest = HttpWebRequest.Create(myUri);
      HttpWebRequest myHttpWebRequest = (HttpWebRequest)myWebRequest;
      myWebRequest.ContentType = "application/json";
      myWebRequest.Method = "PUT";
      myWebRequest.ContentLength = requestData.Length;
      using (Stream st = myWebRequest.GetRequestStream())st.Write(requestData, 0, requestData.Length);

      NetworkCredential myNetworkCredential = new NetworkCredential("YOUR_USERNAME", "YOUR_ACCESS_KEY");
      CredentialCache myCredentialCache = new CredentialCache();
      myCredentialCache.Add(myUri, "Basic", myNetworkCredential);
      myHttpWebRequest.PreAuthenticate = true;
      myHttpWebRequest.Credentials = myCredentialCache;

      myWebRequest.GetResponse().Close();
    }
  }
}

You can find the full reference to our REST API.

Debug your app

BrowserStack provides a range of debugging tools to help you quickly identify and fix bugs you discover through your automated tests.

Text logs

Text Logs are a comprehensive record of your test. They are used to identify all the steps executed in the test and troubleshoot errors for the failed step. Text Logs are accessible from the Automate dashboard or via our REST API.

Visual logs

Visual Logs automatically capture the screenshots generated at every Selenium command run through your JUnit tests. Visual Logs help with debugging the exact step and the page where failure occurred. They also help identify any layout or design related issues with your web pages on different browsers.

Visual Logs are disabled by default. In order to enable Visual Logs you will need to set browserstack.debug capability to true.

<capabilities>
  <single>
    <add key="browserstack.debug" value="true" />
  </single>
</capabilities>

Sample Visual Logs from Automate Dashboard:

Video recording

Every test run on the BrowserStack Selenium grid is recorded exactly as it is executed on our remote machine. This feature is particularly helpful whenever a browser test fails. You can access videos from Automate Dashboard for each session. You can also download the videos from the Dashboard or retrieve a link to download the video using our REST API.

<capabilities>
  <single>
    <add key="browserstack.video" value="false" />
  </single>
</capabilities>

In addition to these logs BrowserStack also provides Raw Logs, Network Logs, Console Logs, Selenium Logs, Appium Logs and Interactive session. You can find the complete details to enable all the debugging options.

Next steps

Once you have successfully run your first test on BrowserStack, you might want to do one of the following:

• Run multiple tests in parallel to speed up the build execution
• Migrate existing tests to BrowserStack
• Test on private websites that are hosted on your internal networks
• Select browsers and devices where you want to test
• Set up your CI/CD: Jenkins, Bamboo, TeamCity, Azure, CircleCI, BitBucket, TravisCI, GitHub Actions