Skip to main content
Version: Next

The Test Function

The test function is the main function in Vest that holds your validation logic. It accepts the following arguments:

NameTypeOptionalDescription
nameStringNoThe name of the value or field that is validated.
messageStringYesAn error message to display to the user in case of a failure.
callbackFunctionNoThe actual validation logic for the given test.
keyStringYesA unique key used to retain test value when reordering dynamic tests.

A test can either be synchronous or asynchronous, and it can either have a severity of error or of warn.

How to fail a test?

There are two ways to fail a test:

Throwing an exception (using enforce)

Just like in most unit testing frameworks, a validation fails whenever the test body throws an exception.

// const username = 'Gina.Vandervort';
// const password = 'Q3O';

test('username', 'Should be at least 3 characters long', () => {
enforce(username).longerThanOrEquals(3);
}); // this test passes

test('password', 'Should be at least 6 characters long', () => {
enforce(password).longerThanOrEquals(6); // an error is thrown here
}); // this test fails
enforce.extend({
isChecked: value => {
return {
pass: !!value.checked,
message: () => 'value must be checked',
};
},
});

/*...*/

/*
tost = { checked: false }
*/

test('tos', () => {
enforce(tos).isChecked(); // will fail with the message: "value must be checked"
});

Returning false

To make it easy to migrate your existing validation logic into Vest, it also supports validations explicitly returning false (and not any other falsy value) to represent failures.

// const username = 'Gina.Vandervort';
// const password = 'Q3O';

test('username', 'Should be at least 3 characters long', () => {
return username.length >= 3; // = true
}); // this test passes

test('password', 'Should be at least 6 characters long', () => {
return password.length >= 6; // = false
}); // this test fails

Rejecting a Promise (Asynchronous Tests)

Asynchronous tests are executed asynchronously and return a Promise. The Promise will be resolved with a boolean value indicating whether the test passed or failed, or rejected with an error.

To fail an asynchronous test, you can either throw an Error in the async function or reject the Promise.

test('email', 'email is already taken', async () => {
const isTaken = await isEmailTaken(data.email);

enforce(isTaken).isFalse();
});

Or with a promise:

test('email', 'email is already taken', () => {
return isEmailTaken(data.email);
});

// returns a promise that rejects if the email is taken
function isEmailTaken(email) {
/*...*/
}

Read more on async tests.