PuppeteerSharp.Contrib.PageObjects 5.0.0

PuppeteerSharp.Contrib.PageObjects

PuppeteerSharp.Contrib.PageObjects is a library for writing browser tests using the page object pattern with the Puppeteer Sharp API.

Content

• Installation
• Page Objects
• Element Objects
• Selector Attributes
• XPath Attributes
• Extensions for Page
• Extensions for ElementHandle
• Samples
• Further Reading

Installation

NuGet
Package Manager	PM>	Install-Package PuppeteerSharp.Contrib.PageObjects -Version 5.0.0
.NET CLI	>	dotnet add package PuppeteerSharp.Contrib.PageObjects --version 5.0.0
PackageReference		<PackageReference Include="PuppeteerSharp.Contrib.PageObjects" Version="5.0.0" />
Paket CLI	>	paket add PuppeteerSharp.Contrib.PageObjects --version 5.0.0

Page Objects

A page object wraps a PuppeteerSharp.Page and should encapsulate the way tests interact with a web page.

Create page objects by inheriting PageObject and declare properties decorated with [Selector] or [XPath] attributes.

public class GitHubStartPage : PageObject
{
    [Selector("h1")]
    public virtual Task<ElementHandle> Heading { get; }

    [Selector(".HeaderMenu")]
    public virtual Task<GitHubHeaderMenu> HeaderMenu { get; }
}

Element Objects

An element object wraps an PuppeteerSharp.ElementHandle and should encapsulate the way tests interact with an element of a web page.

Create element objects by inheriting ElementObject and declare properties decorated with [Selector] or [XPath] attributes.

public class GitHubHeaderMenu : ElementObject
{
    [Selector("input.header-search-input")]
    public virtual Task<ElementHandle> SearchInput { get; }

    public async Task<GitHubSearchPage> Search(string text)
    {
        var input = await SearchInput;
        if (await input.IsHiddenAsync()) await Page.ClickAsync(".octicon-three-bars");
        await input.TypeAsync(text);
        await input.PressAsync(Key.Enter);

        return await Page.WaitForNavigationAsync<GitHubSearchPage>();
    }
}

Selector Attributes

[Selector] attributes can be applied to properties on a PageObject or ElementObject.

Properties decorated with a [Selector] attribute must be a:

• public
• virtual
• asynchronous
• getter

that returns:

• Task<ElementHandle>
• Task<ElementHandle[]>
• Task<ElementObject> or
• Task<ElementObject[]>

Example:

[Selector("#foo")]
public virtual Task<ElementHandle> SelectorForElementHandle { get; }

[Selector(".bar")]
public virtual Task<ElementHandle[]> SelectorForElementHandleArray { get; }

[Selector("#foo")]
public virtual Task<FooElementObject> SelectorForElementObject { get; }

[Selector(".bar")]
public virtual Task<BarElementObject[]> SelectorForElementObjectArray { get; }

XPath Attributes

[XPath] attributes can be applied to properties on a PageObject or ElementObject.

Properties decorated with a [XPath] attribute must be a:

• public
• virtual
• asynchronous
• getter

that returns:

• Task<ElementHandle[]> or
• Task<ElementObject[]>

Example:

[XPath("//div")]
public virtual Task<ElementHandle[]> XPathForElementHandleArray { get; }

[XPath("//div")]
public virtual Task<FooElementObject[]> XPathForElementObjectArray { get; }

Extensions for Page

Where T is a PageObject:

• GoBackAsync<T>
• GoForwardAsync<T>
• GoToAsync<T>
• ReloadAsync<T>
• WaitForNavigationAsync<T>
• WaitForResponseAsync<T>

Where T is an ElementObject:

• QuerySelectorAllAsync<T>
• QuerySelectorAsync<T>
• WaitForSelectorAsync<T>
• WaitForXPathAsync<T>
• XPathAsync<T>

Extensions for ElementHandle

Where T is an ElementObject:

• QuerySelectorAllAsync<T>
• QuerySelectorAsync<T>
• WaitForSelectorAsync<T>
• XPathAsync<T>

Samples

A sample project with NUnit is located in the samples folder:

• PageObjects.cs contains the page and element objects
• PuppeteerSharpRepoPageObjectTests.cs contains the tests using the page object pattern

Further Reading

• https://martinfowler.com/bliki/PageObject.html