util-wdio-helpers

Common helper utilities for our e2e and behavioral tests.

Usage

Import the Base class into all your WebDriverIO Page Objects

import { Page } from '@doodlescheduling/util-wdio-helpers';

class MyPageObject extends Page {
  async open() {
    await super.open('my-page-url');
  }

  // your custom page object methods/getters
}

Now you can use some of the helpers on the Base Class in your e2e/behavioral tests. For example, clearing the cookie consent banner:

import { MyPageObject } from './page-objects/my-page';

describe('My Page', () => {
  beforeAll(() => {
    MyPageObject.open();
    MyPageObject.disableCookiePopup();
    MyPageObject.waitPageReady();
  });

  test('it should do something', () => {
    // ...
  });
});

Mocking users in tests

The mockUserToken function is designed to mock a response for obtaining a user token. This is particularly useful in testing scenarios where you want to simulate the retrieval of a user token without making actual network requests.

The mock function has an optional response parameter, allowing you to customize the user token that will be returned in the mocked response. If no response is provided, the function defaults to using a predefined premium user token.

Here is an example of usage in your test suite:

import { mockUserToken, premiumUserToken } from '@doodlescheduling/util-wdio-helpers';

describe('My Page', () => {
  before(() => {
    await mockUserToken(premiumUserToken);
  });

  test('it should do something', () => {
    // ...
  });
});

In addition to mock function, the module is also exporting some predefined fixtures you can use like freeUserToken, premiumUserToken and anonymousUserToken.