Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-06 22:40:14 -05:00
Code Issues Activity

Extracted basic request/response tests in e2e comments test file

Browse source 
no issue

- removes some repetition making tests more compact and easier to read
This commit is contained in:
Kevin Ansfield 2024-10-03 10:52:11 +01:00
parent a2d44c8778
commit d65f07e4fd
1 changed files with 42 additions and 67 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

109
ghost/core/test/e2e-api/members-comments/comments.test.js
View file

@ -130,6 +130,41 @@ function escapeRegExp(string) {
return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
}
/**
* @param {string} method
* @param {string} url
* @param {number} status
* @param {Array} [errors]
* @returns {any} ExpectRequest
*/
function testBasicErrorResponse(method, url, status, errors) {
if (!errors) {
errors = [{id: anyUuid}];
}
return membersAgent[method](url)
.expectStatus(status)
.matchHeaderSnapshot({etag: anyEtag})
.matchBodySnapshot({errors});
}
/**
* @param {string} method
* @param {string} url
* @param {number} status
* @returns {any} ExpectRequest
*/
function testBasicEmptyResponse(method, url, status) {
return membersAgent[method](url)
.expectStatus(status)
.matchHeaderSnapshot({etag: anyEtag})
.expectEmptyBody();
}
/**
* @param {string} url
* @param {Object} commentsMatcher
*/
function testGetComments(url, commentsMatcher) {
return membersAgent
.get(url)
@ -385,17 +420,7 @@ describe('Comments API', function () {
member_id: fixtureManager.get('members', 2).id
});
await membersAgent
.post(`/api/comments/${comment.get('id')}/like/`)
.expectStatus(401)
.matchHeaderSnapshot({
etag: anyEtag
})
.matchBodySnapshot({
errors: [{
id: anyUuid
}]
});
await testBasicErrorResponse('post', `/api/comments/${comment.get('id')}/like/`, 401);
});
it('cannot unlike a comment', async function () {
@ -407,18 +432,7 @@ describe('Comments API', function () {
member_id: fixtureManager.get('members', 0).id
});
// Create a temporary comment
await membersAgent
.delete(`/api/comments/${comment.get('id')}/like/`)
.expectStatus(401)
.matchHeaderSnapshot({
etag: anyEtag
})
.matchBodySnapshot({
errors: [{
id: anyUuid
}]
});
await testBasicErrorResponse('delete', `/api/comments/${comment.get('id')}/like/`, 401);
});
});
@ -595,17 +609,7 @@ describe('Comments API', function () {
});
// Comment was already liked above
await membersAgent
.post(`/api/comments/${comment.get('id')}/like/`)
.expectStatus(400)
.matchHeaderSnapshot({
etag: anyEtag
})
.matchBodySnapshot({
errors: [{
id: anyUuid
}]
});
await testBasicErrorResponse('post', `/api/comments/${comment.get('id')}/like/`, 400);
});
it('Can like a reply', async function () {
@ -688,13 +692,7 @@ describe('Comments API', function () {
});
// Unlike
await membersAgent
.delete(`/api/comments/${comment.get('id')}/like/`)
.expectStatus(204)
.matchHeaderSnapshot({
etag: anyEtag
})
.expectEmptyBody();
await testBasicEmptyResponse('delete', `/api/comments/${comment.get('id')}/like/`, 204);
// Check not liked
await testGetComments(`/api/comments/${comment.get('id')}/`, [commentMatcher])
@ -709,18 +707,7 @@ describe('Comments API', function () {
member_id: loggedInMember.id
});
// Remove like
await membersAgent
.delete(`/api/comments/${comment.get('id')}/like/`)
//.expectStatus(404)
.matchHeaderSnapshot({
etag: anyEtag
})
.matchBodySnapshot({
errors: [{
id: anyErrorId
}]
});
await testBasicErrorResponse('delete', `/api/comments/${comment.get('id')}/like/`, 404);
});
it('Can report a comment', async function () {
@ -729,13 +716,7 @@ describe('Comments API', function () {
html: '<p>This is a message</p><p></p><p>New line</p>'
});
await membersAgent
.post(`/api/comments/${comment.get('id')}/report/`)
.expectStatus(204)
.matchHeaderSnapshot({
etag: anyEtag
})
.expectEmptyBody();
await testBasicEmptyResponse('post', `/api/comments/${comment.get('id')}/report/`, 204);
// Check report
const reports = await models.CommentReport.findAll({filter: 'comment_id:\'' + comment.get('id') + '\''});
@ -761,13 +742,7 @@ describe('Comments API', function () {
member_id: loggedInMember.id
});
await membersAgent
.post(`/api/comments/${comment.get('id')}/report/`)
.expectStatus(204)
.matchHeaderSnapshot({
etag: anyEtag
})
.expectEmptyBody();
await testBasicEmptyResponse('post', `/api/comments/${comment.get('id')}/report/`, 204);
// Check report should be the same (no extra created)
const reports = await models.CommentReport.findAll({filter: 'comment_id:\'' + comment.get('id') + '\''});