SLM-85: Added tests using supertest that spin up and test the express application #222
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,7 +63,8 @@ | |
| "json", | ||
| "node", | ||
| "ts" | ||
| ], | ||
| "testRunner": "jest-jasmine2" | ||
|
There was a problem hiding this comment. We need to include the jasmine runner to be able to use
|
||
| }, | ||
| "nodemonConfig": { | ||
| "ignore": [ | ||
|
|
@@ -168,8 +169,9 @@ | |
| "nock": "^13.1.3", | ||
| "nodemon": "^2.0.13", | ||
| "prettier": "^2.4.1", | ||
| "redis-mock": "^0.56.3", | ||
| "sass": "^1.42.1", | ||
| "supertest": "^6.2.2", | ||
| "ts-jest": "^27.0.5", | ||
| "typescript": "^4.4.4" | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| import SuperTestWrapper from '../../fixtures/SuperTestWrapper' | ||
| import assertThat from '../../fixtures/supertest-assertions' | ||
|
|
||
| describe('Select envelope size', () => { | ||
| const superTest = new SuperTestWrapper() | ||
|
|
||
| beforeEach(async () => { | ||
|
There was a problem hiding this comment. I've added a test that requires the user to be authenticated. The test spec itself could do with some more functional tests adding (ie. submitting the envelope size etc), but I wanted to make sure we could send requests as an authenticated user |
||
| await superTest.authenticateAsLegalSenderUser() | ||
| }) | ||
|
|
||
| it('should redirect to request a link given user is not authenticated', async () => { | ||
| await superTest.unauthenticated() | ||
|
|
||
| const response = await superTest.request // | ||
| .get('/barcode/pdf/select-envelope-size') | ||
|
|
||
| assertThat(response).isOk().hasPageId('request-link').hasNoErrors() | ||
| }) | ||
|
|
||
| it('should redirect to find recipient by prison number given no recipients have been added', async () => { | ||
| superTest.request.redirects(2) // two redirects happen with this request/response | ||
|
|
||
| const response = await superTest.request // | ||
| .get('/barcode/pdf/select-envelope-size') | ||
|
|
||
| assertThat(response).isOk().hasPageId('find-recipient-by-prison-number').hasNoErrors() | ||
| }) | ||
| }) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| // eslint-disable-next-line import/no-extraneous-dependencies | ||
| import request from 'supertest' | ||
| // eslint-disable-next-line import/no-extraneous-dependencies | ||
| import nock from 'nock' | ||
| import express from 'express' | ||
| import app from '../../index' | ||
| import config from '../../config' | ||
| import mockHmppsAuth from './mock-hmpps-auth' | ||
|
|
||
| jest.mock('redis', () => jest.requireActual('redis-mock')) | ||
|
|
||
| export default class SuperTestWrapper { | ||
|
There was a problem hiding this comment. This is the main class you are going to use when writing supertest tests - basically new up a |
||
| request: request.SuperAgentTest | ||
|
|
||
| constructor() { | ||
| const application: express.Application = app() | ||
| this.request = request.agent(application) | ||
| this.request // | ||
| .set('Content-Type', 'application/x-www-form-urlencoded') | ||
| .redirects(1) | ||
| } | ||
|
|
||
| authenticateAsLegalSenderUser = async () => { | ||
| mockHmppsAuth() | ||
| const mockedSendLegalMailApi = nock(config.apis.sendLegalMail.url) | ||
| mockedSendLegalMailApi.post('/link/verify', { secret: 'some-secret' }).reply(201, { | ||
| token: | ||
| 'eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiJkZTE3NGM0Yi0xY2M2LTQxYWYtYTczYi01ZTE2YmI5YzE1ZWIiLCJzdWIiOiJtaWtlLmhhbG1hQGRpZ2l0YWwuanVzdGljZS5nb3YudWsiLCJleHAiOjQ3ODc1Njk3MjF9.WTqNajHRgZCbNe0g20lK5a7s_5-VeWD-FViu6gTgQaEsavimH_wEz1wZ4sj5osCDkCaLIgjYxGFt_p2IAsr7x0pI5b3CenN4_EMrz2pVVxAXOEEI8Q8QVfTy-iBGyO9W95rFGtmxbdsmYpr7LIr6DxJDUCCrCoeH8f4Dl-4QfKLUn-x_9_Bfum1rtAJ38B5pwiwhlzxeHD58C5XIc7swURGpCA97gtog7kEbyrCDF5AkIM4oYC1ViTMfDypnIJaDAU2ggxkaV5EkiIOB386POjUXkePQDnPajX3C-ugbJlKUPHp9z0CL_ngw5iK3wf9mEy2mWi9VHbUnyqVzfhrbIJK2PKQ0Fb8ZJIZhlB_rD68bgpaKskJwGy3lCMqDV5hiK5rUMsw_6n0asdYIhOvrEkXHrwmR4eRfobkLmtXGGRBswWuMhVXbYxBfZPU4PSkReTnbGRxSub-_UmMIvI_CXXaMdyRv0ixG4R3R7HfgLyZiTffN0p8nKmzKDXWWmPVJ', | ||
| }) | ||
|
|
||
| await this.request.get('/link/verify-link?secret=some-secret') | ||
| nock.cleanAll() | ||
| } | ||
|
|
||
| unauthenticated = async () => { | ||
| mockHmppsAuth() | ||
| await this.request.get('/link/request-link?force=true') // log out legal sender user | ||
|
There was a problem hiding this comment. The easiest way to be unauthenticated is to hit the Legal Sender sign out link - it doesnt matter whether you were previously logged in as a LS or not; it will log you out 👍 |
||
| nock.cleanAll() | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| // eslint-disable-next-line import/no-extraneous-dependencies | ||
| import nock from 'nock' | ||
| import config from '../../config' | ||
|
|
||
| export default function mockHmppsAuth() { | ||
| const mockedHmppsAuthApi = nock(config.apis.hmppsAuth.url) | ||
| mockedHmppsAuthApi.post('/oauth/token').reply(201, { | ||
| access_token: | ||
| 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImRwcy1jbGllbnQta2V5In0.eyJzdWIiOiJzZW5kLWxlZ2FsLW1haWwtdG8tcHJpc29ucy1jbGllbnQiLCJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsicmVhZCIsIndyaXRlIl0sImF1dGhfc291cmNlIjoibm9uZSIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6OTA5MC9hdXRoL2lzc3VlciIsImV4cCI6MTY0NjY3NDEzMywiYXV0aG9yaXRpZXMiOlsiUk9MRV9TTE1fRU1BSUxfTElOSyIsIlJPTEVfU0xNX1NDQU5fQkFSQ09ERSIsIlJPTEVfU0xNX0NSRUFURV9CQVJDT0RFIl0sImp0aSI6Im1lMk5QcXUzME52MnRncEdGM1hNZ2FIcUpMcyIsImNsaWVudF9pZCI6InNlbmQtbGVnYWwtbWFpbC10by1wcmlzb25zLWNsaWVudCJ9.n2HPheK6qtXHPQLbqmGiDCFMUQK67Nel7GtWZl_rUbe5TOkx27rs2CU8OkgixsUWCD5mfdyoZj23kvMYbiZ3ZDMeOAefKp7FerA3EP81bTVLOKOFUPo_sKFe7jKzNcC4tjcFgeniZ4BS7o0pzK6Lg7iJiEn7rgLuQx1-7XbODK2Y3ylo_0BBvEpkZCdqoC4jvWX8zkKNqmB7_cWyUsiXTpgoHXSizZMECjIU0IoiQeWWKDaUgBqOGCexzMBkT_Prt5qq-hIhZsATllMqb4qTiFPPB5J0aP9xWNivJvGZR83RnjczkJk-a7tQ77SFeODWvURVaKd6w-IKZQYcOHav1Q', | ||
| expires_in: 3599, | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| import * as superagent from 'superagent' | ||
| // eslint-disable-next-line import/no-extraneous-dependencies | ||
| import cheerio, { CheerioAPI } from 'cheerio' | ||
|
|
||
| export default function assertThat(response: superagent.Response) { | ||
| return new SupertestAssertions(response) | ||
| } | ||
|
|
||
| class SupertestAssertions { | ||
|
There was a problem hiding this comment. This is effectively our DSL for making assertions. All methods are chainable and is modelled heavily on assertJ (mainly because I couldnt work out how to write my own Also, in most assertion methods I have a try/catch with a |
||
| private $: CheerioAPI | ||
|
|
||
| constructor(private readonly response: superagent.Response) { | ||
| this.$ = cheerio.load(response.text) | ||
| } | ||
|
|
||
| isOk = (): SupertestAssertions => { | ||
| this.hasStatusCode(200) | ||
| return this | ||
| } | ||
|
|
||
| isNotFound = (): SupertestAssertions => { | ||
| this.hasStatusCode(404) | ||
| return this | ||
| } | ||
|
|
||
| hasPageId = (expected: string): SupertestAssertions => { | ||
| const actual = this.$('#pageId').attr('data-qa') | ||
| try { | ||
| expect(actual).toBe(expected) | ||
| } catch (err) { | ||
| fail(`Expected pageId value to be ${expected} but was ${actual}`) | ||
| } | ||
| return this | ||
| } | ||
|
|
||
| hasNoErrors = (): SupertestAssertions => { | ||
| const actual = this.$('.govuk-error-summary__list').length | ||
| try { | ||
| expect(actual).toBe(0) | ||
| } catch (err) { | ||
| fail(`Expected page to have 0 error messages but had ${actual}`) | ||
| } | ||
| return this | ||
| } | ||
|
|
||
| hasError = (expected: string): SupertestAssertions => { | ||
| this.hasAllErrors(expected) | ||
| return this | ||
| } | ||
|
|
||
| hasAllErrors = (...expected: string[]): SupertestAssertions => { | ||
| const actual = this.$('.govuk-error-summary__list').text() | ||
|
There was a problem hiding this comment. Minor point - might be better to split this by newlines before testing? Meh. |
||
| try { | ||
| expected.forEach(expectedMessage => expect(actual).toContain(expectedMessage)) | ||
| } catch (err) { | ||
| fail(`Expected page to have error[s] containing all of [${expected}] but it did not`) | ||
| } | ||
| return this | ||
| } | ||
|
|
||
| hasStatusCode = (expected: number) => { | ||
| const actual = this.response.statusCode | ||
| try { | ||
| expect(actual).toBe(expected) | ||
| } catch (err) { | ||
| fail(`Expected a status code of ${expected} but was ${actual}`) | ||
| } | ||
| } | ||
| } | ||
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| // eslint-disable-next-line import/no-extraneous-dependencies | ||
| import nock from 'nock' | ||
| import config from '../../config' | ||
| import mockHmppsAuth from '../fixtures/mock-hmpps-auth' | ||
| import assertThat from '../fixtures/supertest-assertions' | ||
| import SuperTestWrapper from '../fixtures/SuperTestWrapper' | ||
|
|
||
| describe('Request Link', () => { | ||
| const superTest = new SuperTestWrapper() | ||
| let mockedSendLegalMailApi: nock.Scope | ||
|
|
||
| beforeEach(() => { | ||
| mockHmppsAuth() | ||
| mockedSendLegalMailApi = nock(config.apis.sendLegalMail.url) | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| nock.cleanAll() | ||
| }) | ||
|
|
||
| it('should render page to request a link', async () => { | ||
| const response = await superTest.request // | ||
|
There was a problem hiding this comment. Does the There was a problem hiding this comment. No, it's just a way I can shoehorn my desire to lay out the code into a more readable manner (IMHO) rather than being at the whim of the draconian prettier rules 😁 Without the comment markers prettier would force me to do: That's no so bad, but there are other cases below where I chain more method calls: If prettier had it's way it would force me to do: Horrible 🤮 |
||
| .get('/link/request-link') | ||
|
|
||
| assertThat(response).isOk().hasPageId('request-link').hasNoErrors() | ||
| }) | ||
|
|
||
| it('should redirect to email-sent page', async () => { | ||
| mockedSendLegalMailApi.post('/link/email', { email: '[email protected]' }).reply(201) | ||
|
|
||
| const response = await superTest.request // | ||
| .post('/link/request-link') | ||
| .send({ email: '[email protected]' }) | ||
|
|
||
| assertThat(response).isOk().hasPageId('email-sent').hasNoErrors() | ||
| }) | ||
|
|
||
| it('should redirect to request-link page with errors given non CJSM address', async () => { | ||
| mockedSendLegalMailApi.post('/link/email', { email: '[email protected]' }).reply(400, { | ||
| status: 400, | ||
| errorCode: { | ||
| code: 'INVALID_CJSM_EMAIL', | ||
| userMessage: `Enter an email address which ends with 'cjsm.net'`, | ||
| }, | ||
| }) | ||
|
|
||
| const response = await superTest.request // | ||
| .post('/link/request-link') | ||
| .send({ email: '[email protected]' }) | ||
|
|
||
| assertThat(response).isOk().hasPageId('request-link').hasError('email address in the correct format') | ||
| }) | ||
|
|
||
| it('should redirect to request-link page with errors given email address too long', async () => { | ||
| mockedSendLegalMailApi.post('/link/email', { email: '[email protected]' }).reply(400, { | ||
| status: 400, | ||
| errorCode: { | ||
| code: 'EMAIL_TOO_LONG', | ||
| userMessage: `The email address can have a maximum length of 254`, | ||
| }, | ||
| }) | ||
|
|
||
| const response = await superTest.request // | ||
| .post('/link/request-link') | ||
| .send({ email: '[email protected]' }) | ||
|
|
||
| assertThat(response).isOk().hasPageId('request-link').hasError('email address in the correct format') | ||
| }) | ||
|
|
||
| it('should redirect to request-link page with errors given unhandled API failure', async () => { | ||
| mockedSendLegalMailApi.post('/link/email', { email: '[email protected]' }).reply(404) | ||
|
|
||
| const response = await superTest.request // | ||
| .post('/link/request-link') | ||
| .send({ email: '[email protected]' }) | ||
|
|
||
| assertThat(response).isOk().hasPageId('request-link').hasError('error generating your sign in link') | ||
| }) | ||
|
|
||
| it('should redirect to request-link page with errors given validation errors', async () => { | ||
| const response = await superTest.request // | ||
| .post('/link/request-link') | ||
| .send({ email: 'an invalid email address' }) | ||
|
|
||
| assertThat(response).isOk().hasPageId('request-link').hasError('email address in the correct format') | ||
| }) | ||
| }) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The span in the markup with the pageId has been changed, so these mocks (for pages that are not in our codebase) need to change