Selenium.Spotfire 1.0.0

Spotfire Selenium Helpers

The goal of this project is to make automating Spotfire through Web Player using Selenium and .NET easier. There are several use cases, with different parts of the project focusing on each:

• Automating tasks that use Spotfire Web Player - e.g. opening an analytic and exporting data.
• Running tests against Spotfire analytics - e.g. to automate a test for a specific analytic template.
• Comparing the output of different Spotfire environments - e.g. to automate testing of a new version of Spotfire.

Three NuGet packages are available:

• Spotfire.Selenium - Classes to automate Spotfire through Selenium and Chrome.
• Spotfire.Selenium.TestHelpers - Helpers for all types of tests
• Spotfire.Selenium.MSTest - Support for the creation of MSTest based unit tests.

Note, this project does not contain any Spotfire software, it can only be used to automate an existing Spotfire installation.

Installation

Installed through NuGet.org.

For example, at the package manager console on Visual Studio, enter following command to install the automation package:

PM> Install-Package Selenium.Spotfire

For example, at the package manager console on Visual Studio, enter following command to install the test helper package:

PM> Install-Package Selenium.Spotfire.TestHelpers

For example, at the package manager console on Visual Studio, enter following command to install the MSTest helper package:

PM> Install-Package Selenium.Spotfire.MSTest

Usage

The starting point for automating Spotfire, or running an automated test, is to instantiate a 'driver'. The driver controls an instance of the Chrome browser interacting with Spotfire. Two different drivers are provided:

• Spotfire.Selenium.SpotfireDriver - A general-purpose driver with features for controlling Spotfire.
• Spotfire.Selenium.MSTest.SpotfireTestDriver - A special purpose driver that includes features to help with unit testing.

Both driver classes implement the Disposeable pattern to help ensure that Chrome is closed automatically.

// Create a driver, ensuring that it gets cleaned up automatically
using (SpotfireDriver spotfire = SpotfireDriver.GetDriverForSpotfire())
{
    // Open a file from Spotfire
    spotfire.OpenSpotfireAnalysis("https://SpotfireServer", "/path to the file");
    IReadOnlyCollection<string> pages = spotfire.GetPages();

    // Move to the first page
    spotfire.SetPage(pages.ElementAt(0));
}

The general pattern for using the driver classes is:

• Create a driver using the GetDriverForSpotfire method.
• Open a Spotfire analysis.
• Interact with the analysis.
• Dispose of the driver.

Further information

The project is hosted on GitHub - you can view the full documentation there.