2022-08-24 06:18:08 +03:00
# <img src="/src/icon.png" height="30px"> Verify Headless Browsers
[](https://ci.appveyor.com/project/SimonCropp/verify-headlessbrowsers)
[](https://www.nuget.org/packages/Verify.Playwright/)
[](https://www.nuget.org/packages/Verify.Puppeteer/)
[](https://www.nuget.org/packages/Verify.Selenium/)
Extends [Verify ](https://github.com/VerifyTests/Verify ) to allow verification of Web UIs using headless browsers.
## Playwright Usage
Verification of Web UIs via [Playwright ](https://github.com/microsoft/playwright-sharp ).
### NuGet package
https://nuget.org/packages/Verify.Playwright/
### Enable
Enable VerifyPlaywright once at assembly load time:
<!-- snippet: PlaywrightEnable -->
< a id = 'snippet-playwrightenable' > < / a >
```cs
VerifyPlaywright.Enable(installPlaywright: true);
```
< sup > < a href = '/src/Tests/ModuleInitializer.cs#L12-L16' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-playwrightenable' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
### Instantiate browser
<!-- snippet: PlaywrightBuild -->
< a id = 'snippet-playwrightbuild' > < / a >
```cs
// wait for target server to start
await SocketWaiter.Wait(port: 5000);
2022-08-24 06:19:24 +03:00
2022-08-24 06:18:08 +03:00
playwright = await Playwright.CreateAsync();
browser = await playwright.Chromium.LaunchAsync();
```
< sup > < a href = '/src/Tests/PlaywrightTests.cs#L12-L20' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-playwrightbuild' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
### Page test
The current page state can be verified as follows:
<!-- snippet: PlaywrightPageUsage -->
< a id = 'snippet-playwrightpageusage' > < / a >
```cs
var page = await browser.NewPageAsync();
await page.GotoAsync("http://localhost:5000");
await Verify(page);
```
< sup > < a href = '/src/Tests/PlaywrightTests.cs#L26-L32' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-playwrightpageusage' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
With the state of the element being rendered as a verified files:
<!-- snippet: PlaywrightTests.PageUsage.00.verified.html -->
< a id = 'snippet-PlaywrightTests.PageUsage.00.verified.html' > < / a >
```html
<!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 >
```
< sup > < a href = '/src/Tests/PlaywrightTests.PageUsage.00.verified.html#L1-L21' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-PlaywrightTests.PageUsage.00.verified.html' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
[PlaywrightTests.PageUsage.01.verified.png ](/src/Tests/PlaywrightTests.PageUsage.01.verified.png ):
< img src = "/src/Tests/PlaywrightTests.PageUsage.01.verified.png" width = "400px" >
#### PageScreenshotOptions
<!-- snippet: PageScreenshotOptions -->
< a id = 'snippet-pagescreenshotoptions' > < / a >
```cs
var page = await browser.NewPageAsync();
await page.GotoAsync("http://localhost:5000");
await Verify(page)
.PageScreenshotOptions(
new()
{
Quality = 50,
Type = ScreenshotType.Jpeg
});
```
< sup > < a href = '/src/Tests/PlaywrightTests.cs#L38-L50' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-pagescreenshotoptions' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
### Element test
An element can be verified as follows:
<!-- snippet: PlaywrightElementUsage -->
< a id = 'snippet-playwrightelementusage' > < / a >
```cs
var page = await browser.NewPageAsync();
await page.GotoAsync("http://localhost:5000");
var element = await page.QuerySelectorAsync("#someId");
await Verify(element);
```
< sup > < a href = '/src/Tests/PlaywrightTests.cs#L56-L63' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-playwrightelementusage' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
With the state of the element being rendered as a verified files:
<!-- snippet: PlaywrightTests.ElementUsage.00.verified.html -->
< a id = 'snippet-PlaywrightTests.ElementUsage.00.verified.html' > < / a >
```html
Learn more
```
< sup > < a href = '/src/Tests/PlaywrightTests.ElementUsage.00.verified.html#L1-L1' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-PlaywrightTests.ElementUsage.00.verified.html' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
[PlaywrightTests.ElementUsage.01.verified.png ](/src/Tests/PlaywrightTests.ElementUsage.01.verified.png ):
< img src = "/src/Tests/PlaywrightTests.ElementUsage.01.verified.png" >
#### ElementScreenshotOptions
<!-- snippet: ElementScreenshotOptions -->
< a id = 'snippet-elementscreenshotoptions' > < / a >
```cs
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
});
```
< sup > < a href = '/src/Tests/PlaywrightTests.cs#L69-L82' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-elementscreenshotoptions' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
## Puppeteer Usage
Verification of Web UIs via [Puppeteer ](https://github.com/hardkoded/puppeteer-sharp )
### NuGet package
https://nuget.org/packages/Verify.Puppeteer/
### Enable
Enable VerifyPuppeteer once at assembly load time:
<!-- snippet: PuppeteerEnable -->
< a id = 'snippet-puppeteerenable' > < / a >
```cs
VerifyPuppeteer.Enable();
```
< sup > < a href = '/src/Tests/ModuleInitializer.cs#L18-L22' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-puppeteerenable' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
### Instantiate browser
<!-- snippet: PuppeteerBuild -->
< a id = 'snippet-puppeteerbuild' > < / a >
```cs
// wait for target server to start
await SocketWaiter.Wait(port: 5000);
2022-08-24 06:19:24 +03:00
2022-08-24 06:18:08 +03:00
using (var fetcher = new BrowserFetcher(Product.Chrome))
{
await fetcher.DownloadAsync();
}
2022-08-24 06:19:24 +03:00
2022-08-24 06:18:08 +03:00
browser = await Puppeteer.LaunchAsync(
new()
{
Headless = true
});
```
< sup > < a href = '/src/Tests/PuppeteerTests.cs#L11-L27' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-puppeteerbuild' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
### Page test
The current page state can be verified as follows:
<!-- snippet: PuppeteerPageUsage -->
< a id = 'snippet-puppeteerpageusage' > < / a >
```cs
var page = await browser.NewPageAsync();
page.Viewport.Width = 1024;
page.Viewport.Height = 768;
await page.GoToAsync("http://localhost:5000");
await Verify(page);
```
< sup > < a href = '/src/Tests/PuppeteerTests.cs#L33-L41' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-puppeteerpageusage' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
With the state of the element being rendered as a verified files:
<!-- snippet: PuppeteerTests.PageUsage.00.verified.html -->
< a id = 'snippet-PuppeteerTests.PageUsage.00.verified.html' > < / a >
```html
<!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 >
```
< sup > < a href = '/src/Tests/PuppeteerTests.PageUsage.00.verified.html#L1-L20' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-PuppeteerTests.PageUsage.00.verified.html' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
[PuppeteerTests.PageUsage.01.verified.png ](/src/Tests/PuppeteerTests.PageUsage.01.verified.png ):
< img src = "/src/Tests/PuppeteerTests.PageUsage.01.verified.png" width = "400px" >
### Element test
An element can be verified as follows:
<!-- snippet: PuppeteerElementUsage -->
< a id = 'snippet-puppeteerelementusage' > < / a >
```cs
var page = await browser.NewPageAsync();
await page.GoToAsync("http://localhost:5000");
var element = await page.QuerySelectorAsync("#someId");
await Verify(element);
```
< sup > < a href = '/src/Tests/PuppeteerTests.cs#L47-L54' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-puppeteerelementusage' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
With the state of the element being rendered as a verified files:
<!-- snippet: PuppeteerTests.ElementUsage.00.verified.html -->
< a id = 'snippet-PuppeteerTests.ElementUsage.00.verified.html' > < / a >
```html
Learn more
```
< sup > < a href = '/src/Tests/PuppeteerTests.ElementUsage.00.verified.html#L1-L1' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-PuppeteerTests.ElementUsage.00.verified.html' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
[PuppeteerTests.ElementUsage.01.verified.png ](/src/Tests/PuppeteerTests.ElementUsage.01.verified.png ):
< img src = "/src/Tests/PuppeteerTests.ElementUsage.01.verified.png" >
## Selenium Usage
Verification of Web UIs via [Selenium ](https://www.selenium.dev ).
### NuGet package
https://nuget.org/packages/Verify.Selenium/
### Enable
Enable VerifySelenium once at assembly load time:
<!-- snippet: SeleniumEnable -->
< a id = 'snippet-seleniumenable' > < / a >
```cs
VerifySelenium.Enable();
```
< sup > < a href = '/src/Tests/ModuleInitializer.cs#L6-L10' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-seleniumenable' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
### Instantiate browser
<!-- snippet: SeleniumBuildDriver -->
< a id = 'snippet-seleniumbuilddriver' > < / a >
```cs
// wait for target server to start
await SocketWaiter.Wait(port: 5000);
2022-08-24 06:19:24 +03:00
2022-08-24 06:18:08 +03:00
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");
```
< sup > < a href = '/src/Tests/SeleniumTests.cs#L13-L25' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-seleniumbuilddriver' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
### Page test
The current page state can be verified as follows:
<!-- snippet: SeleniumPageUsage -->
< a id = 'snippet-seleniumpageusage' > < / a >
```cs
await Verify(driver);
```
< sup > < a href = '/src/Tests/SeleniumTests.cs#L31-L35' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-seleniumpageusage' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
With the state of the element being rendered as a verified files:
<!-- snippet: SeleniumTests.PageUsage.00.verified.html -->
< a id = 'snippet-SeleniumTests.PageUsage.00.verified.html' > < / a >
```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 >
```
< sup > < a href = '/src/Tests/SeleniumTests.PageUsage.00.verified.html#L1-L20' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-SeleniumTests.PageUsage.00.verified.html' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
[SeleniumTests.PageUsage.01.verified.png ](/src/Tests/SeleniumTests.PageUsage.01.verified.png ):
< img src = "/src/Tests/SeleniumTests.PageUsage.01.verified.png" width = "400px" >
### Element test
An element can be verified as follows:
<!-- snippet: SeleniumElementUsage -->
< a id = 'snippet-seleniumelementusage' > < / a >
```cs
var element = driver.FindElement(By.Id("someId"));
await Verify(element);
```
< sup > < a href = '/src/Tests/SeleniumTests.cs#L41-L46' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-seleniumelementusage' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
With the state of the element being rendered as a verified files:
<!-- snippet: SeleniumTests.ElementUsage.00.verified.html -->
< a id = 'snippet-SeleniumTests.ElementUsage.00.verified.html' > < / a >
```html
< a id = "someId" class = "btn btn-primary btn-lg" href = "#" role = "button" > Learn more< / a >
```
< sup > < a href = '/src/Tests/SeleniumTests.ElementUsage.00.verified.html#L1-L1' title = 'Snippet source file' > snippet source< / a > | < a href = '#snippet-SeleniumTests.ElementUsage.00.verified.html' title = 'Start of snippet' > anchor< / a > < / sup >
<!-- endSnippet -->
[SeleniumTests.ElementUsage.01.verified.png ](/src/Tests/SeleniumTests.ElementUsage.01.verified.png ):
< img src = "/src/Tests/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 ](https://github.com/VerifyTests/Verify/blob/master/docs/comparer.md ) can to mitigate this.
## Icon
2022-08-24 06:19:24 +03:00
[Crystal ](https://thenounproject.com/term/crystal/1440050/ ) designed by [Monjin Friends ](https://thenounproject.com/monjin.friends ) from [The Noun Project ](https://thenounproject.com ).
