Percy for Selenium WebDriver API .NET Bindings
$ dotnet add package PercyIO.SeleniumPercy visual testing for .NET Selenium.
Install/update @percy/cli dev dependency (requires Node 14+):
$ npm install --save-dev @percy/cli
Install dotnet SDK:
$ brew tap isen-ng/dotnet-sdk-versions
$ brew install --cask dotnet-sdk5-0-400
$ dotnet --list-sdks
Install Mono:
$ brew install mono
$ mono --version
Run tests:
npm run test
npm install @percy/cli (requires Node 14+):
$ npm install --save-dev @percy/cli
Install the PercyIO.Selenium package (for example, with .NET CLI):
$ dotnet add package PercyIO.Selenium
This is an example test using the Percy.Snapshot method.
using PercyIO.Selenium;
// ... other test code
FirefoxOptions options = new FirefoxOptions();
FirefoxDriver driver = new FirefoxDriver(options);
driver.Navigate().GoToUrl("http://example.com");
// take a snapshot
Percy.Snapshot(driver, ".NET example");
// snapshot options using an anonymous object
Percy.Snapshot(driver, ".NET anonymous options", new {
widths = new [] { 600, 1200 }
});
// snapshot options using a dictionary-like object
Percy.Options snapshotOptions = new Percy.Options();
snapshotOptions.Add("minHeight", 1280);
Percy.Snapshot(driver, ".NET typed options", snapshotOptions);
Running the above normally will result in the following log:
[percy] Percy is not running, disabling snapshots
When running with , and your project's , a new Percy build will be created and snapshots will be uploaded to your project.
PERCY_TOKEN$ export PERCY_TOKEN=[your-project-token]
$ percy exec -- [your test command]
[percy] Percy has started!
[percy] Created build #1: https://percy.io/[your-project]
[percy] Snapshot taken ".NET example"
[percy] Snapshot taken ".NET anonymous options"
[percy] Snapshot taken ".NET typed options"
[percy] Stopping percy...
[percy] Finalized build #1: https://percy.io/[your-project]
[percy] Done!void Percy.Snapshot(WebDriver driver, string name, object? options)
driver (required) - A selenium-webdriver driver instancename (required) - The snapshot name; must be unique to each snapshotoptions - An object containing various snapshot options (see per-snapshot configuration options)Percy.Screenshot(driver, name, options) [ needs @percy/cli 1.27.0-beta.0+ ];
This is an example test using the Percy.Screenshot method.
// ... other test code
// import
using PercyIO.Selenium;
class Program
{
static void Main(string[] args)
{
// Add caps here
RemoteWebDriver driver = new RemoteWebDriver(
new Uri("https://hub-cloud.browserstack.com/wd/hub"),capabilities);
// navigate to webpage
driver.Navigate().GoToUrl("https://www.percy.io");
// take screenshot
Percy.Screenshot("dotnet screenshot-1");
// quit driver
driver.quit();
}
}driver (required) - A Selenium driver instancename (required) - The screenshot name; must be unique to each screenshotoptions (optional) - There are various options supported by Percy.Screenshot to server further functionality.
freezeAnimation - Boolean value by default it falls back to false, you can pass true and percy will freeze image based animations.percyCSS - Custom CSS to be added to DOM before the screenshot being taken. Note: This gets removed once the screenshot is taken.ignoreRegionXpaths - elements in the DOM can be ignored using xpathignoreRegionSelectors - elements in the DOM can be ignored using selectors.ignoreRegionSeleniumElements - elements can be ignored using selenium_elements.customIgnoreRegions - elements can be ignored using custom boundaries
Description: This class represents a rectangular area on a screen that needs to be ignored for visual diff.
Constructor:
init(self, top, bottom, left, right)
Parameters:
top (int): Top coordinate of the ignore region.
bottom (int): Bottom coordinate of the ignore region.
left (int): Left coordinate of the ignore region.
right (int): Right coordinate of the ignore region.
Raises:ValueError: If top, bottom, left, or right is less than 0 or top is greater than or equal to bottom or left is greater than or equal to right.
valid: Ignore region should be within the boundaries of the screen.
Note: Automate Percy Token starts with auto keyword. The command can be triggered using exec keyword.
$ export PERCY_TOKEN=[your-project-token]
$ percy exec -- [dotnet test command]
[percy] Percy has started!
[percy] [Dotnet example] : Starting automate screenshot ...
[percy] Screenshot taken "Dotnet example"
[percy] Stopping percy...
[percy] Finalized build #1: https://percy.io/[your-project]
[percy] Done!Refer to docs here: Percy on Automate