percy-playwright-dotnet

Percy visual testing for .NET Playwright.

Development

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-sdk7-0-400
$ dotnet --list-sdks

Run tests:

npm run test

Installation

npm install @percy/cli (requires Node 14+):

$ npm install --save-dev @percy/cli

Install the PercyIO.Playwright package (for example, with .NET CLI):

$ dotnet add package PercyIO.Playwright

Usage

This is an example test using the Percy.Snapshot method.

using PercyIO.Playwright;

// ... other test code

var playwright = await Microsoft.Playwright.Playwright.CreateAsync();
var browser = await playwright.Chromium.LaunchAsync(new BrowserTypeLaunchOptions { Headless = false });
var page = await browser.NewPageAsync();
await page.GotoAsync("http://example.com");
​
// take a snapshot
Percy.Snapshot(page, ".NET example");

// snapshot options using an anonymous object
Percy.Snapshot(page, ".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(page, ".NET typed options", snapshotOptions);

Running the above normally will result in the following log:

[percy] Percy is not running, disabling snapshots

When running with percy exec, and your project's PERCY_TOKEN, a new Percy build will be created and snapshots will be uploaded to your project.

$ 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!

Configuration

void Percy.Snapshot(IPage page, string name, object? options)

• page (required) - A playwright page instance
• name (required) - The snapshot name; must be unique to each snapshot
• options - An object containing various snapshot options (see per-snapshot configuration options)

Running Percy on Automate

Percy.Screenshot(driver, name, options) [ needs @percy/cli 1.28.8+ ];

This is an example test using the Percy.Screenshot method.

// ... other test code
// import
using PercyIO.Playwright;
class Program
{
  static void Main(string[] args)
  {

    // Add caps here
    string cdpUrl = "wss://cdp.browserstack.com/playwright?caps=" + Uri.EscapeDataString(capsJson);
    var playwright = await Playwright.CreateAsync();
    browser = await playwright.Chromium.ConnectAsync(cdpUrl);
    page = await browser.NewPageAsync();

    // navigate to webpage
    await page.GotoAsync("http://example.com");

    // take screenshot
    Percy.Screenshot(page, "dotnet screenshot-1");

    // other code
  }
}

• page (required) - A Playwright page instance
• name (required) - The screenshot name; must be unique to each screenshot
• options (optional) - There are various options supported by Percy.Screenshot to server further functionality.
  • fullPage - Boolean value by default it falls back to false, Takes full page screenshot [From CLI v1.27.6+]
  • freezeAnimatedImage - Boolean value by default it falls back to false, you can pass true and percy will freeze image based animations.
  • freezeImageBySelectors - List of selectors. Images will be freezed which are passed using selectors. For this to work freezeAnimatedImage must be set to true.
  • freezeImageByXpaths - List of xpaths. Images will be freezed which are passed using xpaths. For this to work freezeAnimatedImage must be set to true.
  • percyCSS - Custom CSS to be added to DOM before the screenshot being taken. Note: This gets removed once the screenshot is taken.
  • ignoreRegionXpaths - List of xpaths. elements in the DOM can be ignored using xpath
  • ignoreRegionSelectors - List of selectors. elements in the DOM can be ignored using selectors.
  • customIgnoreRegions - List of custom objects. elements can be ignored using custom boundaries. Just passing a simple object for it like below.
    • Refer to example -

      • List<object> ignoreCustomElement = new List<object>();
        var region1 = new Dictionary<string, int>();
        region1.Add("top", 10);
        region1.Add("bottom", 120);
        region1.Add("right", 10);
        region1.Add("left", 10);
        ignoreCustomElement.Add(region1);
        region1.Add("custom_ignore_regions", ignoreCustomElement);
        

  • considerRegionXpaths - List of xpaths. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using xpaths.
  • considerRegionSelectors - List of selectors. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using selectors.
  • customConsiderRegions - List of custom objects. elements can be considered for diffing and will be ignored by Intelli Ignore using custom boundaries
    • Refer to example -

      • List<object> considerCustomElement = new List<object>();
        var region2 = new Dictionary<string, int>();
        region2.Add("top", 10);
        region2.Add("bottom", 120);
        region2.Add("right", 10);
        region2.Add("left", 10);
        considerCustomElement.Add(region2);
        region2.Add("custom_consider_regions", considerCustomElement);
        

      • Parameters:
        • top (int): Top coordinate of the consider region.
        • bottom (int): Bottom coordinate of the consider region.
        • left (int): Left coordinate of the consider region.
        • right (int): Right coordinate of the consider region.
  • regions parameter that allows users to apply snapshot options to specific areas of the page. This parameter is an array where each object defines a custom region with configurations.
    • Parameters:

      • elementSelector (optional, only one of the following must be provided, if this is not provided then full page will be considered as region)

        • boundingBox (object): Defines the coordinates and size of the region.
          • x (number): X-coordinate of the region.
          • y (number): Y-coordinate of the region.
          • width (number): Width of the region.
          • height (number): Height of the region.
        • elementXpath (string): The XPath selector for the element.
        • elementCSS (string): The CSS selector for the element.

      • algorithm (mandatory)

        • Specifies the snapshot comparison algorithm.
        • Allowed values: standard, layout, ignore, intelliignore.

      • configuration (required for standard and intelliignore algorithms, ignored otherwise)

        • diffSensitivity (number): Sensitivity level for detecting differences.
        • imageIgnoreThreshold (number): Threshold for ignoring minor image differences.
        • carouselsEnabled (boolean): Whether to enable carousel detection.
        • bannersEnabled (boolean): Whether to enable banner detection.
        • adsEnabled (boolean): Whether to enable ad detection.

      • assertion (optional)

        • Defines assertions to apply to the region.
        • diffIgnoreThreshold (number): The threshold for ignoring minor differences.

Example Usage for regions

var region = new Percy.Region
{
    elementSelector = new Percy.Region.RegionElementSelector
    {
        elementCSS = ".ad-banner"
    },
    algorithm = "intelliignore",
    configuration = new Percy.Region.RegionConfiguration
    {
        diffSensitivity = 2,
        imageIgnoreThreshold = 0.2,
        carouselsEnabled = true,
        bannersEnabled = true,
        adsEnabled = true
    },
    assertion = new Percy.Region.RegionAssertion
    {
        diffIgnoreThreshold = 0.4
    }
};

 // or we can use CreateRegion function

  var diffSensitivity = 3;
  var carouselsEnabled = true;
  var algorithm = "intelliignore";
  var diffIgnoreThreshold = 0.5;

  var region = Percy.CreateRegion(
      algorithm: algorithm,
      diffSensitivity: diffSensitivity,
      carouselsEnabled: carouselsEnabled,
      diffIgnoreThreshold: diffIgnoreThreshold
  );

  var options = new Dictionary<string, object>
  {
    {"regions", new List<Percy.Region> { region }},
  };

  Percy.Snapshot(page, "snapshot_2", options);

Creating Percy on automate build

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