Version: 1.3

Test Data Generation

Overview#

Sometimes you want to generate random data that seems realistic. For this we bundle the highly capable open-source Faker library Faker.js which makes it simple to add rich, unique, on-the-fly test data to your scripts. The Faker library allows us to generate a wide variety of syntax-correct data such as random names, numbers, strings and emails.

To start using Faker within your Flood Element script you will need to import the part of the Faker library you'd like to make us of. For example, for basic random data we would use import random at the top of the script:

import { random } from 'faker'

Generating Random Numbers#

The simplest way to generate a random number using Faker is to import the random Faker object at the top of your Flood Element script and then use it as follows:

var randNumber = random.number(99999).toString()

This example generates a 5 digit random number between 0 and 99999.

Generating Person Names#

Generating random first and surnames is just as easy, using the name object:

// put this import statement at the top of your script
import { name } from 'faker'

// Generate different types of names and related data
var randFirstname = name.firstName()
var randSurname = name.lastName()
const randJobTitle = name.jobTitle()
const randPrefix = name.prefix()

Generating Email Addresses and other Web Data#

To generate email addresses and other web related test data, use internet:

// put this import statement at the top of your script
import { internet } from 'faker'

// Generate different types of names and related data
const randEmail = internet.email() // returns 'Timmy_Pacocha@gmail.com'
const randEmailProvider = internet.email('joe', 'smith', 'protonmail.com') // returns 'joe.smith@protonmail.com'

Using fake data in tests#

The easiest way to use Faker data in your test is to generate and use it inline in each step. This works well for simple tests, or when you don't need to access the same values in multiple steps.

step('Write a comment', async (browser: Browser) => {
    await browser.visit('https://example.com/comments', { waitUntil: 'networkidle2' })
    await browser.type(By.css('[name="name"]'), faker.name.findName())
    await browser.type(By.css('[name="comment"]'), faker.lorem.sentences())
    await browser.click(By.css('[type="submit"]'))
    await browser.takeScreenshot()
})

Flood Element's TestData facility makes it simple to use Faker data across multiple steps. You can also generate a large number of fake records to use when running multiple iterations of a test script. This works the same as loading a pre-populated CSV or JSON file, but with the power of randomised values.

import { name, internet } from 'faker'

interface UserData {
    name: string
    email: string
}

// build a fake User
const userFactory = () =>
    <UserData>{
        name: name.findName(),
        email: internet.email(),
    }

// create an Array of 5 fake users
const data = Array.from({ length: 5 }, userFactory)

// load generated data into the test
TestData.fromData<UserData>(data)

This example generates 5 random users with realistic data, and makes them available in the test steps. One UserData record will be provided to the steps per test iteration.

step('Step 1', async (browser: Browser, user: UserData) => {
  ...
  // test your page using the fake UserData record for this iteration
  await browser.type(By.css('[name="name"]'), user.name)

  // you can still use Faker inline for data that doesn't need to be pre-generated
  await browser.type(By.css('[name="comment"]'), faker.lorem.sentences())
  ...
})

Overview#

Generating Random Numbers#

Generating Person Names#

Generating Email Addresses and other Web Data#

Using fake data in tests#

Further reading#