2018-10-04 14:37:37 +01:00
---
2020-12-15 17:17:25 -08:00
id: 587d8250367417b2b2512c5d
2021-08-11 01:45:12 +09:00
title: Run Functional Tests Using a Headless Browser
2018-10-04 14:37:37 +01:00
challengeType: 2
2019-08-05 09:17:33 -07:00
forumTopicId: 301595
2021-01-13 03:31:00 +01:00
dashedName: run-functional-tests-using-a-headless-browser
2018-10-04 14:37:37 +01:00
---
2020-11-27 19:02:05 +01:00
# --description--
2020-11-26 18:05:42 +00:00
2021-04-29 06:13:38 -04:00
As a reminder, this project is being built upon the following starter project on [Replit ](https://replit.com/github/freeCodeCamp/boilerplate-mochachai ), or cloned from [GitHub ](https://github.com/freeCodeCamp/boilerplate-mochachai/ ).
2020-11-26 18:05:42 +00:00
2021-08-11 01:45:12 +09:00
On the page there's an input form. It sends data to the `PUT /travellers` endpoint as an AJAX request.
When the request successfully completes, the client code appends a `<div>` containing the information in the response to the DOM.
Here's an example of how to use Zombie.js to interact with the form:
2020-11-26 18:05:42 +00:00
2020-12-15 17:17:25 -08:00
```js
2021-08-11 01:45:12 +09:00
test('Submit the surname "Polo" in the HTML form', function (done) {
browser.fill('surname', 'Polo').then(() => {
browser.pressButton('submit', () => {
browser.assert.success();
browser.assert.text('span#name ', 'Marco');
browser.assert.text('span#surname ', 'Polo');
browser.assert.elements('span#dates ', 1);
done();
});
2020-12-15 17:17:25 -08:00
});
2021-08-11 01:45:12 +09:00
});
2020-12-15 17:17:25 -08:00
```
2020-11-26 18:05:42 +00:00
2021-08-11 01:45:12 +09:00
First, the `fill` method of the `browser` object fills the `surname` field of the form with the value `'Polo'` . `fill` returns a promise, so `then` is chained off of it.
Within the `then` callback, the `pressButton` method of the `browser` object is used to invoke the form's `submit` event listener. The `pressButton` method is asynchronous.
2020-11-26 18:05:42 +00:00
2020-12-15 17:17:25 -08:00
Then, once a response is received from the AJAX request, a few assertions are made confirming:
2020-11-26 18:05:42 +00:00
2020-12-15 17:17:25 -08:00
1. The status of the response is `200`
2. The text within the `<span id='name'></span>` element matches `'Marco'`
3. The text within the `<span id='surname'></span>` element matches `'Polo'`
2021-03-31 01:18:01 -07:00
4. There is `1` `<span id='dates'></span>` element.
2020-11-26 18:05:42 +00:00
2020-12-15 17:17:25 -08:00
Finally, the `done` callback is invoked, which is needed due to the asynchronous test.
2020-11-26 18:05:42 +00:00
2020-12-15 17:17:25 -08:00
# --instructions--
2020-11-26 18:05:42 +00:00
2021-08-11 01:45:12 +09:00
Within `tests/2_functional-tests.js` , in the `'Submit the surname "Colombo" in the HTML form'` test (`// #5` ), automate the following:
2020-11-26 18:05:42 +00:00
2021-08-11 01:45:12 +09:00
1. Fill in the form with the surname `Colombo`
2. Press the submit button
2020-11-26 18:05:42 +00:00
2021-08-11 01:45:12 +09:00
And within the `pressButton` callback:
2020-11-26 18:05:42 +00:00
2021-08-11 01:45:12 +09:00
1. Assert that status is OK `200`
2. Assert that the text inside the element `span#name` is `'Cristoforo'`
3. Assert that the text inside the element `span#surname` is `'Colombo'`
4. Assert that the element(s) `span#dates` exist and their count is `1`
2020-11-26 18:05:42 +00:00
2021-02-01 10:52:11 -03:00
Do not forget to remove the `assert.fail()` call.
2020-11-26 18:05:42 +00:00
2020-11-27 19:02:05 +01:00
# --hints--
All tests should pass.
```js
(getUserInput) =>
2021-08-11 01:45:12 +09:00
$.get(getUserInput('url') + '/_api/get-tests?type=functional& n=5').then(
2020-11-27 19:02:05 +01:00
(data) => {
assert.equal(data.state, 'passed');
},
(xhr) => {
throw new Error(xhr.responseText);
}
);
```
You should assert that the headless browser request succeeded.
2018-10-04 14:37:37 +01:00
2020-11-27 19:02:05 +01:00
```js
(getUserInput) =>
2021-08-11 01:45:12 +09:00
$.get(getUserInput('url') + '/_api/get-tests?type=functional& n=5').then(
2020-11-27 19:02:05 +01:00
(data) => {
assert.equal(data.assertions[0].method, 'browser.success');
},
(xhr) => {
throw new Error(xhr.responseText);
}
);
```
2020-11-26 18:05:42 +00:00
2021-08-11 01:45:12 +09:00
You should assert that the text inside the element `span#name` is `'Cristoforo'` .
2018-10-04 14:37:37 +01:00
2020-11-27 19:02:05 +01:00
```js
(getUserInput) =>
2021-08-11 01:45:12 +09:00
$.get(getUserInput('url') + '/_api/get-tests?type=functional& n=5').then(
2020-11-27 19:02:05 +01:00
(data) => {
assert.equal(data.assertions[1].method, 'browser.text');
assert.match(data.assertions[1].args[0], /('|")span#name \1/);
2020-12-15 17:17:25 -08:00
assert.match(data.assertions[1].args[1], /('|")Cristoforo\1/);
2020-11-27 19:02:05 +01:00
},
(xhr) => {
throw new Error(xhr.responseText);
}
);
2018-10-04 14:37:37 +01:00
```
2021-08-11 01:45:12 +09:00
You should assert that the text inside the element `span#surname` is `'Colombo'` .
2018-10-04 14:37:37 +01:00
2020-11-27 19:02:05 +01:00
```js
(getUserInput) =>
2021-08-11 01:45:12 +09:00
$.get(getUserInput('url') + '/_api/get-tests?type=functional& n=5').then(
2020-11-27 19:02:05 +01:00
(data) => {
assert.equal(data.assertions[2].method, 'browser.text');
assert.match(data.assertions[2].args[0], /('|")span#surname \1/);
2020-12-15 17:17:25 -08:00
assert.match(data.assertions[2].args[1], /('|")Colombo\1/);
2020-11-27 19:02:05 +01:00
},
(xhr) => {
throw new Error(xhr.responseText);
}
);
```
2020-11-26 18:05:42 +00:00
2021-08-11 01:45:12 +09:00
You should assert that the element `span#dates` exist and its count is 1.
2018-10-04 14:37:37 +01:00
2020-11-27 19:02:05 +01:00
```js
(getUserInput) =>
2021-08-11 01:45:12 +09:00
$.get(getUserInput('url') + '/_api/get-tests?type=functional& n=5').then(
2020-11-27 19:02:05 +01:00
(data) => {
2021-05-10 22:12:40 -06:00
assert.equal(data.assertions[3].method, 'browser.elements');
2020-11-27 19:02:05 +01:00
assert.match(data.assertions[3].args[0], /('|")span#dates \1/);
assert.equal(data.assertions[3].args[1], 1);
},
(xhr) => {
throw new Error(xhr.responseText);
}
);
```
2018-10-04 14:37:37 +01:00
2020-11-27 19:02:05 +01:00
# --solutions--
2018-10-04 14:37:37 +01:00
```js
2019-10-14 21:00:42 +05:30
/**
Backend challenges don't need solutions,
because they would need to be tested against a full working project.
Please check our contributing guidelines to learn more.
*/
2018-10-04 14:37:37 +01:00
```