Extends Verify to allow verification of Web UIs using Selenium, Playwright, or Puppeteer

Перейти к файлу

dependabot[bot] 9ed12b803c Bump Microsoft.Playwright from 1.48.0 to 1.49.0 in /src (#597 )		2024-11-22 06:36:10 +00:00
.github	refs or cleanup	2024-03-03 10:49:08 +11:00
src	Bump Microsoft.Playwright from 1.48.0 to 1.49.0 in /src (#597 )	2024-11-22 06:36:10 +00:00
.gitignore	refs	2022-03-04 19:08:39 +11:00
code_of_conduct.md	.	2020-07-25 09:58:52 +10:00
license.txt	Update license.txt	2020-07-25 08:58:03 +10:00
readme.md	PuppeteerSharp 18.0.0	2024-05-21 20:49:29 +10:00

readme.md

Verify Headless Browsers

Extends Verify to allow verification of Web UIs using headless browsers.

See Milestones for release notes.

Playwright Usage

Verification of Web UIs via Playwright.

NuGet package

https://nuget.org/packages/Verify.Playwright/

Enable

Enable VerifyPlaywright once at assembly load time:

[ModuleInitializer]
public static void InitPlaywright() =>
    VerifyPlaywright.Initialize(installPlaywright: true);

^{snippet source | anchor}

Instantiate browser

// wait for target server to start
await SocketWaiter.Wait(port: 5000);

playwright = await Playwright.CreateAsync();
browser = await playwright.Chromium.LaunchAsync();

^{snippet source | anchor}

Page test

The current page state can be verified as follows:

var page = await browser.NewPageAsync();
await page.GotoAsync("http://localhost:5000");
await Verify(page);

^{snippet source | anchor}

With the state of the element being rendered as a verified files:

<!DOCTYPE html><html lang="en"><head>
  <meta charset="utf-8">
  <title>The Title</title>
  <link href="https://getbootstrap.com/docs/4.0/dist/css/bootstrap.min.css" rel="stylesheet">
</head>
<body>
  <div class="jumbotron">
    <h1 class="display-4">The Awareness Of Relative Idealism</h1>
    <p class="lead">
      One hears it stated that a factor within the logical radical priority embodies the
      key principles behind the best practice marginalised certification project. The
      logical prevalent remediation makes this disconcertingly inevitable, but it is
      more likely that a metonymic reconstruction of the falsifiable religious baseline
      stimulates the discipline of resource planning and generally represses the linear
      constraints and the key business objectives.
    </p>
    <a id="someId" class="btn btn-primary btn-lg" href="#" role="button">Learn more</a>
  </div>

</body></html>

^{snippet source | anchor}

PlaywrightTests.PageUsage.01.verified.png:

PageScreenshotOptions

var page = await browser.NewPageAsync();
await page.GotoAsync("http://localhost:5000");
await Verify(page)
    .PageScreenshotOptions(
        new()
        {
            Quality = 50,
            Type = ScreenshotType.Jpeg
        });

^{snippet source | anchor}

Element test

An element can be verified as follows:

var page = await browser.NewPageAsync();
await page.GotoAsync("http://localhost:5000");
var element = await page.QuerySelectorAsync("#someId");
await Verify(element!);

^{snippet source | anchor}

With the state of the element being rendered as a verified files:

Learn more

^{snippet source | anchor}

PlaywrightTests.ElementUsage.01.verified.png:

ElementScreenshotOptions

var page = await browser.NewPageAsync();
await page.GotoAsync("http://localhost:5000");
var element = await page.QuerySelectorAsync("#someId");
await Verify(element!)
    .ElementScreenshotOptions(
        new()
        {
            Quality = 50,
            Type = ScreenshotType.Jpeg
        });

^{snippet source | anchor}

Element test using ILocator

An element can be verified as follows:

var page = await browser.NewPageAsync();
await page.GotoAsync("http://localhost:5000");
var element = page.Locator("#someId");
await Verify(element);

^{snippet source | anchor}

With the state of the element being rendered as a verified files:

Learn more

^{snippet source | anchor}

PlaywrightTests.LocatorUsage.01.verified.png:

LocatorScreenshotOptions

var page = await browser.NewPageAsync();
await page.GotoAsync("http://localhost:5000");
var element = page.Locator("#someId");
await Verify(element)
    .LocatorScreenshotOptions(
        new()
        {
            Quality = 50,
            Type = ScreenshotType.Jpeg
        });

^{snippet source | anchor}

Puppeteer Usage

Verification of Web UIs via Puppeteer

NuGet package

https://nuget.org/packages/Verify.Puppeteer/

Enable

Enable VerifyPuppeteer once at assembly load time:

[ModuleInitializer]
public static void InitPuppeteer() =>
    VerifyPuppeteer.Initialize();

^{snippet source | anchor}

Instantiate browser

// wait for target server to start
await SocketWaiter.Wait(port: 5000);

var fetcher = new BrowserFetcher(SupportedBrowser.Chrome);
await fetcher.DownloadAsync();

browser = await Puppeteer.LaunchAsync(
    new()
    {
        Headless = true
    });

^{snippet source | anchor}

Page test

The current page state can be verified as follows:

var page = await browser.NewPageAsync();
page.Viewport.Width = 1024;
page.Viewport.Height = 768;
await page.GoToAsync("http://localhost:5000");
await Verify(page);

^{snippet source | anchor}

With the state of the element being rendered as a verified files:

<!DOCTYPE html><html lang="en"><head>
  <meta charset="utf-8">
  <title>The Title</title>
  <link href="https://getbootstrap.com/docs/4.0/dist/css/bootstrap.min.css" rel="stylesheet">
</head>
<body>
  <div class="jumbotron">
    <h1 class="display-4">The Awareness Of Relative Idealism</h1>
    <p class="lead">
      One hears it stated that a factor within the logical radical priority embodies the
      key principles behind the best practice marginalised certification project. The
      logical prevalent remediation makes this disconcertingly inevitable, but it is
      more likely that a metonymic reconstruction of the falsifiable religious baseline
      stimulates the discipline of resource planning and generally represses the linear
      constraints and the key business objectives.
    </p>
    <a id="someId" class="btn btn-primary btn-lg" href="#" role="button">Learn more</a>
  </div>

</body></html>

^{snippet source | anchor}

PuppeteerTests.PageUsage.01.verified.png:

Element test

An element can be verified as follows:

var page = await browser.NewPageAsync();
await page.GoToAsync("http://localhost:5000");
var element = await page.QuerySelectorAsync("#someId");
await Verify(element);

^{snippet source | anchor}

With the state of the element being rendered as a verified files:

Learn more

^{snippet source | anchor}

PuppeteerTests.ElementUsage.01.verified.png:

Selenium Usage

Verification of Web UIs via Selenium.

NuGet package

https://nuget.org/packages/Verify.Selenium/

Enable

Enable VerifySelenium once at assembly load time:

[ModuleInitializer]
public static void InitSelenium() =>
    VerifySelenium.Initialize();

^{snippet source | anchor}

Instantiate browser

// wait for target server to start
await SocketWaiter.Wait(port: 5000);

var options = new ChromeOptions();
options.AddArgument("--no-sandbox");
options.AddArgument("--headless");
driver = new(options);
driver.Manage().Window.Size = new(1024, 768);
driver.Navigate().GoToUrl("http://localhost:5000");

^{snippet source | anchor}

Page test

The current page state can be verified as follows:

await Verify(driver);

^{snippet source | anchor}

With the state of the element being rendered as a verified files:

<html lang="en"><head>
  <meta charset="utf-8">
  <title>The Title</title>
  <link href="https://getbootstrap.com/docs/4.0/dist/css/bootstrap.min.css" rel="stylesheet">
</head>
<body>
  <div class="jumbotron">
    <h1 class="display-4">The Awareness Of Relative Idealism</h1>
    <p class="lead">
      One hears it stated that a factor within the logical radical priority embodies the
      key principles behind the best practice marginalised certification project. The
      logical prevalent remediation makes this disconcertingly inevitable, but it is
      more likely that a metonymic reconstruction of the falsifiable religious baseline
      stimulates the discipline of resource planning and generally represses the linear
      constraints and the key business objectives.
    </p>
    <a id="someId" class="btn btn-primary btn-lg" href="#" role="button">Learn more</a>
  </div>

</body></html>

^{snippet source | anchor}

SeleniumTests.PageUsage.01.verified.png:

Element test

An element can be verified as follows:

var element = driver.FindElement(By.Id("someId"));
await Verify(element);

^{snippet source | anchor}

With the state of the element being rendered as a verified files:

<a id="someId" class="btn btn-primary btn-lg" href="#" role="button">Learn more</a>

^{snippet source | anchor}

SeleniumTests.ElementUsage.01.verified.png:

OS specific rendering

The rendering can very slightly between different OS versions. This can make verification on different machines (eg CI) problematic. A custom comparer can to mitigate this.

Icon

Crystal designed by Monjin Friends from The Noun Project.