selenium-sandbox

easily mock a web application accessed through selenium. Contains also an environment for integrating with jest.

Getting started

0. Install

yarn add -D @4c/selenium-sandbox

1. Add the sandbox to your test client

First, we need to instrument our application to use the sandbox environment. Create a module (let's call it injectSandbox.js)

1import sandbox from '@4c/selenium-sandbox/browser';
2
3const store = {
4  widgets: [],
5};
6
7// additional properties and methods that can be accessed from selenium. for example here we are passing a store object
8const context = { store };
9
10sandbox.setupTestContext(context);
11
12sandbox.fetchMock.mock('path:/api/v1/widgets', () => store.widgets);

Note: documentation for fetchMock can be found here

2. Instrument Selenium

Add utilities to an already existing selenium driver (v4):

1import { augmentDriver } from '@4c/selenium-sandbox/webdriver';
2
3const driver = augmentDriver(
4  myBaseSeleniumDriver,
5  'http://sandboxed-app-to-test',
6);

... Alternatively you can use buildDriver to instantiate a reasonably opinionated driver:

1import { buildDriver } from '@4c/selenium-sandbox/webdriver';
2
3const driver = buildDriver(
4  baseUrl: 'http://sandboxed-app-to-test';
5  seleniumAddress: 'localhost:5000/wd/hub';
6  browserName: 'chrome';
7  screenSize: [1024, 768];
8  // optional
9  mobileEmulation: {
10      deviceName: 'iPhone 6/7/8',
11  };
12);

3. Usage

To mock:

1await driver.get('my/page');
2await driver.executeInBrowser(context => {
3  context.store.widgets = [{label: '1', label: '2'}]
4}
5
6const button = await driver.find('//button[text()="Get Widgets"]');
7await driver.click(button);

If a request needs to be mocked before page loading, you can use executeAtStartup instead of executeInBrowser. the code will be stored in storage and executed when the assets are loaded

Note: Since the function passed to executeInBrowser or executeAtStartup needs to be stringified in order to be executed in the remote browser, it cannot access variables defined outside of its body.

You can also access fetchMock from the context to make additional mocks:

1await driver.executeInBrowser(context => {
2  context.fetchMock.mock('path:/api/v1/users', () => ['user1', 'user2'])
3}

Since fetchMock is part of the context, it can be used to make assertions on the requests. There are two helper methods on the driver to facilitate that:

1const request = await driver.getLastRequest();
2invariant(request.headers.Authorization == 'Bearer XXX');
3
4const requests = await driver.getRequests();
5invariant(requests.every((req) => req.headers.Authorization == 'Bearer XXX'));

the driver has also the following utilities methods:

1// more resilient than element.click, will retry several times to avoid flakiness
2await driver.click(element);
3
4// accepts an xpath query and returns the first match. It will wait that all
5// images are loaded and that the element is indeed visible
6await driver.find('//button[text()="Get Widgets"]');
7
8// unlike the base webdriver, allows to pass a path which is concatenated
9// to `baseUrl`
10await driver.get('my/page');
11
12// the name says it all. Useful to make sure the page has finished rendering
13await driver.waitForAllImages();

Jest Support

There is also support for easy integration with Jest.

Environment

add the following line to your jest config:

1{
2  // ...
3  testEnvironment: '@4c/selenium-sandbox/jest/environment.js',
4  setupFilesAfterEnv: ['@4c/selenium-sandbox/jest/setup.js'],
5  testEnvironmentOptions: {
6    baseUrl: 'http://sandboxed-app-to-test',
7    seleniumAddress: 'localhost:5000/wd/hub',
8    browserName: 'chrome',
9    screenSize: [1024, 768],
10    // optional
11    mobileEmulation: {
12        deviceName: 'iPhone 6/7/8',
13    },
14    // optional, default 10000
15    waitTimeout: 50000,
16  },
17}

this will:

• declare a global browser variable as described above
• set a 10s timeout which is a better fit for selenium tests
• add a snapshot serializer specific to fetchMock requests

TypeScript Support

Type definitions come out of the box. For full jest support, you should add the following declaration to be used in your test file:

1import { AugmentedDriver } from '@4c/selenium-sandbox/webdriver';
2
3// define a context type that reflects the context passed in `setupTestContext`
4type Context = {
5  store: {
6    widgets: {}[];
7  };
8};
9
10declare const browser: AugmentedDriver<Context>;