aft-ui-selenium

Automated Functional Testing (AFT) package supporting Selenium-based UI testing with support for BrowserStack, Sauce Labs and Local Selenium Grid testing

Usage no npm install needed!

<script type="module">
  import aftUiSelenium from 'https://cdn.skypack.dev/aft-ui-selenium';
</script>

README

AFT-UI-Selenium

Automated Functional Testing (AFT) package providing Selenium-based SeleniumFacet extends AbstractFacet Plugins and BrowserStack, Sauce Labs and Selenium Grid ISession Plugins extending the aft-ui package. This enables testing using BrowserStack's, Sauce Labs's or a Local Selenium Grid for any Browser application tests.

Installation

> npm i aft-ui-selenium

Page Object Model (POM)

the POM is a standard design pattern used in UI and layout testing. AFT-UI supports this model via Sessions and Facets where the Session is an object extending from ISession and is responsible for managing the UI container (browser, mobile view, etc.)and the Facet is an object extending from AbstractFacet and is responsible for managing logical collections of sub-facets and elements in the UI. For example: aft-ui-pom The above would use a POM design like:

Session - SeleniumSession

  • Page Facet - SeleniumFacet
    • logo element - WebElement
    • Breadcrumbs Facet - SeleniumFacet
      • breadcrumb links - WebElement[]
    • avatar element - WebElement
    • Nav Facet - SeleniumFacet
      • nav elements - WebElement[]
    • Tabs Facet - SeleniumFacet
      • Tab Facet 1 - SeleniumFacet
      • Tab Facet 2 - SeleniumFacet
        • Table Facet - SeleniumFacet
          • header elements - WebElement[]
          • cell elements - WebElement[]
      • Tab Facet 3 - SeleniumFacet
    • media element - WebElement

Creating your own Facets for use in testing

Take the following as an example of how one could interact with the following page https://the-internet.herokuapp.com/login

Step 1: create the Page Facet

/**
 * represents the login page object containing widgets encapsulating
 * the functionality of the website
 */
export class HerokuLoginPage extends SeleniumFacet {
    /* the locator can also be specified in options */
    readonly locator: Locator = By.css('html');
    /* facets contained in this page */
    private content(): Promise<HerokuContentFacet> {
        return this.getFacet(HerokuContentWidget);
    }
    private messages(): Promise<HerokuMessagesFacet> {
        return this.getFacet(HerokuMessagesWidget, {maxWaitMs: 20000});
    }
    async navigateTo(): Promise<void> {
        await this.session.goTo('https://the-internet.herokuapp.com/login');
    }
    /* action functions */
    async login(user: string, pass: string): Promise<void> {
        await this.content().then((c) => c.login(user, pass));
    }
    async hasMessage(): Promise<boolean> {
        return await this.messages().then((m) => m.hasMessage());
    }
    async getMessage(): Promise<string> {
        return await this.messages().then((m) => m.getMessage());
    }
}

Step 2: create the content and messages Facets

/**
 * represents the content of the login page including the 
 * username and password fields and the login button
 */
export class HerokuContentFacet extends SeleniumFacet {
    readonly locator: Locator = By.id("content");
    /**
     * function will get the Facet's root element using
     * the Facet.locator (By.id("content")) and then will
     * call {findElement(By.id("username"))} from that
     * ```
     * <html>
     *   ...
     *   <div id="content">
     *     <input id="username" />
     *   </div>
     *   ...
     * </html>
     * ```
     */
    private async usernameInput(): Promise<WebElement> {
        return await this.getElement({locator: By.id("username")});
    }
    private async passwordInput(): Promise<WebElement> {
        return await this.getElement({locator: By.id("password")});
    }
    private async loginButton(): Promise<IFacet> {
        return await this.getElement({locator: By.css("button.radius")});
    }
    /* action functions */
    async login(user: string, pass: string): Promise<void> {
        await this.usernameInput().then((input) => input.sendKeys(user));
        await this.passwordInput().then((input) => input.sendKeys(pass));
        return await this.clickLoginButton();
    }
    async clickLoginButton(): Promise<void> {
        await this.loginButton().then((button) => button.click());
    }
}

/**
 * represents the results message content shown on successful 
 * or failed login.
 */
export class HerokuMessagesFacet extends SeleniumFacet {
    readonly locator: Locator = By.id("flash-messages");
    private async message(): Promise<WebElement> {
        return this.getElement({locator: By.id("flash")});
    }
    /* action functions */
    async hasMessage(): Promise<boolean> {
        return await this.message()
        .then((message) => {
            return message !== undefined;
        }).catch((err: Error) => {
            return false;
        });
    }
    async getMessage(): Promise<string> {
        if (await this.hasMessage()) {
            return await this.message().then(m => m.getText());
        }
        return null;
    }
}

Step 3: use them to interact with the web application

await browserShould({description: 'can access websites using AFT and Page Widgets and Facets',
    testCases: ['C3456', 'C2345', 'C1234'],
    expect: async (tw: BrowserTestWrapper) => {
        let loginPage: HerokuLoginPage = await tw.session.getFacet(HerokuLoginPage);
        await tw.logMgr.step('navigate to LoginPage...');
        await loginPage.navigateTo();
        await tw.logMgr.step('login');
        await loginPage.login("tomsmith", "SuperSecretPassword!");
        await tw.logMgr.step('wait for message to appear...')
        await wait.untilTrue(() => loginPage.hasMessage(), 20000);
        await tw.logMgr.step('get message...');
        let message: string = await loginPage.getMessage();
        return expect(message).toContain("You logged into a secure area!");
    }
});

aftconfig.json keys and values supported by aft-ui-selenium package

  • browserstacksessiongeneratorplugin - only required if referencing browserstack-session-generator-plugin in the pluginNames array of the sessiongeneratorpluginmanager section of your aftconfig.json file
    • user - [REQUIRED] the BrowserStack username for the account to be used
    • key - [REQUIRED] the BrowserStack accesskey for the account to be used
    • platform - required if not set in the sessiongeneratorpluginmanager section of your aftconfig.json file
    • resolution - a string containing a valid resolution for your BrowserStack session like: 1024x768 (defaults to no value so BrowserStack will choose)
    • local - a boolean value indicating if sessions should connect via an already running BrowserStack Local VPN (defaults to false)
    • localIdentifier - a string containing the BrowserStack Local localIdentifier to use when connecting to a Local VPN instance. only required if local is set to true and your Local VPN instance is using a localIdentifier
    • url - an alternative url for BrowserStack's grid hub (defaults to https://hub-cloud.browserstack.com/wd/hub/ if not specified)
    • capabilities - an object containing keys and values to be used when creating your BrowserStack Session. this can be used to override default capabilities or to add additional ones (defaults to none)
  • saucelabssessiongeneratorplugin - only required if referencing saucelabs-session-generator-plugin in the pluginNames array of the sessiongeneratorpluginmanager section of your aftconfig.json file
    • username - [REQUIRED] the Sauce Labs username for the account to be used
    • accesskey - [REQUIRED] the Sauce Labs accesskey for the account to be used
    • platform - required if not set in the sessiongeneratorpluginmanager section of your aftconfig.json file
    • resolution - a string containing a valid resolution for your Sauce Labs session like: 1024x768 (defaults to no value so Sauce Labs will choose)
    • tunnel - a boolean value indicating if sessions should connect via an already running Sauce Labs tunnel VPN (defaults to false)
    • tunnelId - a string containing the Sauce Labs tunnelIdentifier to use when connecting to a tunnel VPN instance. only required if tunnel is set to true and your tunnel VPN instance is using a tunnelIdentifier
    • url - an alternative url for Sauce Labs' grid hub (defaults to https://ondemand.us-east-1.saucelabs.com/wd/hub/ if not specified)
    • capabilities - an object containing keys and values to be used when creating your Sauce Labs Session. this can be used to override default capabilities or to add additional ones (defaults to none)
  • seleniumgridsessiongeneratorplugin - only required if referencing selenium-grid-session-generator-plugin in the pluginNames array of the sessiongeneratorpluginmanager section of your aftconfig.json file
    • platform - required if not set in the sessiongeneratorpluginmanager section of your aftconfig.json file
    • url - [REQUIRED] the url of your running Selenium Grid instance
    • capabilities - an object containing keys and values to be used when creating your Browser Session