141 lines
3.5 KiB
Markdown
141 lines
3.5 KiB
Markdown
---
|
|
id: 587d824f367417b2b2512c5a
|
|
title: Run Functional Tests on an API Response using Chai-HTTP III - PUT method
|
|
challengeType: 2
|
|
forumTopicId: 301590
|
|
dashedName: run-functional-tests-on-an-api-response-using-chai-http-iii---put-method
|
|
---
|
|
|
|
# --description--
|
|
|
|
As a reminder, this project is being built upon the following starter project on [Repl.it](https://repl.it/github/freeCodeCamp/boilerplate-mochachai), or cloned from [GitHub](https://github.com/freeCodeCamp/boilerplate-mochachai/).
|
|
|
|
In the next example we'll see how to send data in a request payload (body). We are going to test a PUT request. The `'/travellers'` endpoint accepts a JSON object taking the structure:
|
|
|
|
```json
|
|
{
|
|
"surname": [last name of a traveller of the past]
|
|
}
|
|
```
|
|
|
|
The route responds with :
|
|
|
|
```json
|
|
{
|
|
"name": [first name], "surname": [last name], "dates": [birth - death years]
|
|
}
|
|
```
|
|
|
|
See the server code for more details.
|
|
|
|
# --instructions--
|
|
|
|
Within `tests/2_functional-tests.js`, alter the `'send {surname: "Colombo"}'` test (`// #3`):
|
|
|
|
Send the following JSON response as a payload:
|
|
|
|
```json
|
|
{
|
|
"surname": "Colombo"
|
|
}
|
|
```
|
|
|
|
Check for the following, within the `request.end` callback:
|
|
|
|
1. `status`
|
|
2. `type`
|
|
3. `body.name`
|
|
4. `body.surname`
|
|
|
|
Follow the assertion order above - we rely on it. Be sure to remove `assert.fail()`, once complete.
|
|
|
|
# --hints--
|
|
|
|
All tests should pass.
|
|
|
|
```js
|
|
(getUserInput) =>
|
|
$.get(getUserInput('url') + '/_api/get-tests?type=functional&n=2').then(
|
|
(data) => {
|
|
assert.equal(data.state, 'passed');
|
|
},
|
|
(xhr) => {
|
|
throw new Error(xhr.responseText);
|
|
}
|
|
);
|
|
```
|
|
|
|
You should test for 'res.status' to be 200.
|
|
|
|
```js
|
|
(getUserInput) =>
|
|
$.get(getUserInput('url') + '/_api/get-tests?type=functional&n=2').then(
|
|
(data) => {
|
|
assert.equal(data.assertions[0].method, 'equal');
|
|
assert.equal(data.assertions[0].args[0], 'res.status');
|
|
assert.equal(data.assertions[0].args[1], '200');
|
|
},
|
|
(xhr) => {
|
|
throw new Error(xhr.responseText);
|
|
}
|
|
);
|
|
```
|
|
|
|
You should test for 'res.type' to be 'application/json'.
|
|
|
|
```js
|
|
(getUserInput) =>
|
|
$.get(getUserInput('url') + '/_api/get-tests?type=functional&n=2').then(
|
|
(data) => {
|
|
assert.equal(data.assertions[1].method, 'equal');
|
|
assert.equal(data.assertions[1].args[0], 'res.type');
|
|
assert.match(data.assertions[1].args[1], /('|")application\/json\1/);
|
|
},
|
|
(xhr) => {
|
|
throw new Error(xhr.responseText);
|
|
}
|
|
);
|
|
```
|
|
|
|
You should test for 'res.body.name' to be 'Cristoforo'.
|
|
|
|
```js
|
|
(getUserInput) =>
|
|
$.get(getUserInput('url') + '/_api/get-tests?type=functional&n=2').then(
|
|
(data) => {
|
|
assert.equal(data.assertions[2].method, 'equal');
|
|
assert.equal(data.assertions[2].args[0], 'res.body.name');
|
|
assert.match(data.assertions[2].args[1], /('|")Cristoforo\1/);
|
|
},
|
|
(xhr) => {
|
|
throw new Error(xhr.responseText);
|
|
}
|
|
);
|
|
```
|
|
|
|
You should test for 'res.body.surname' to be 'Colombo'.
|
|
|
|
```js
|
|
(getUserInput) =>
|
|
$.get(getUserInput('url') + '/_api/get-tests?type=functional&n=2').then(
|
|
(data) => {
|
|
assert.equal(data.assertions[3].method, 'equal');
|
|
assert.equal(data.assertions[3].args[0], 'res.body.surname');
|
|
assert.match(data.assertions[3].args[1], /('|")Colombo\1/);
|
|
},
|
|
(xhr) => {
|
|
throw new Error(xhr.responseText);
|
|
}
|
|
);
|
|
```
|
|
|
|
# --solutions--
|
|
|
|
```js
|
|
/**
|
|
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.
|
|
*/
|
|
```
|