Skip to content

Commit c020867

Browse files
feat(DTFS2-7052): changing variables to use plural
1 parent 15743c0 commit c020867

File tree

4 files changed

+56
-56
lines changed

4 files changed

+56
-56
lines changed

src/modules/geospatial/geospatial.controller.test.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ describe('GeospatialController', () => {
1212
let controller: GeospatialController;
1313

1414
const valueGenerator = new RandomValueGenerator();
15-
const { getAddressByPostcodeResponse, getAddressByPostcodeMultipleResponse } = new GetGeospatialAddressesGenerator(valueGenerator).generate({
15+
const { getAddressesByPostcodeResponse, getAddressesByPostcodeMultipleResponse } = new GetGeospatialAddressesGenerator(valueGenerator).generate({
1616
numberToGenerate: 2,
1717
});
1818

@@ -33,21 +33,21 @@ describe('GeospatialController', () => {
3333
const postcode = GEOSPATIAL.EXAMPLES.POSTCODE;
3434

3535
it('returns a single address for the postcode when the service returns a single address', async () => {
36-
when(geospatialServiceGetAddressesByPostcode).calledWith(postcode).mockResolvedValueOnce(getAddressByPostcodeResponse[0]);
36+
when(geospatialServiceGetAddressesByPostcode).calledWith(postcode).mockResolvedValueOnce(getAddressesByPostcodeResponse[0]);
3737

3838
const response = await controller.getAddressesByPostcode({ postcode });
3939

4040
expect(geospatialServiceGetAddressesByPostcode).toHaveBeenCalledTimes(1);
41-
expect(response).toEqual(getAddressByPostcodeResponse[0]);
41+
expect(response).toEqual(getAddressesByPostcodeResponse[0]);
4242
});
4343

4444
it('returns multiple addresses for the postcode when the service returns multiple addresses', async () => {
45-
when(geospatialServiceGetAddressesByPostcode).calledWith(postcode).mockResolvedValueOnce(getAddressByPostcodeMultipleResponse);
45+
when(geospatialServiceGetAddressesByPostcode).calledWith(postcode).mockResolvedValueOnce(getAddressesByPostcodeMultipleResponse);
4646

4747
const response = await controller.getAddressesByPostcode({ postcode });
4848

4949
expect(geospatialServiceGetAddressesByPostcode).toHaveBeenCalledTimes(1);
50-
expect(response).toEqual(getAddressByPostcodeMultipleResponse);
50+
expect(response).toEqual(getAddressesByPostcodeMultipleResponse);
5151
});
5252

5353
it('returns an empty response for the postcode when the service returns an empty response', async () => {

src/modules/geospatial/geospatial.service.test.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,42 +30,42 @@ describe('GeospatialService', () => {
3030

3131
describe('getAddressesByPostcode', () => {
3232
const {
33-
getAddressByPostcodeResponse,
34-
getAddressByPostcodeMultipleResponse,
35-
getAddressOrdnanceSurveyResponse,
36-
getAddressOrdnanceSurveyMultipleResponse,
37-
getAddressOrdnanceSurveyEmptyResponse,
33+
getAddressesByPostcodeResponse,
34+
getAddressesByPostcodeMultipleResponse,
35+
getAddressesOrdnanceSurveyResponse,
36+
getAddressesOrdnanceSurveyMultipleMatchingAddressesResponse,
37+
getAddressesOrdnanceSurveyEmptyResponse,
3838
} = new GetGeospatialAddressesGenerator(valueGenerator).generate({
3939
numberToGenerate: 2,
4040
});
41-
const postcode = getAddressByPostcodeResponse[0][0].postalCode;
41+
const postcode = getAddressesByPostcodeResponse[0][0].postalCode;
4242

4343
it('returns a single address from the backend service', async () => {
44-
when(ordnanceSurveyServiceGetAddressesByPostcode).calledWith(postcode).mockResolvedValueOnce(getAddressOrdnanceSurveyResponse[0]);
44+
when(ordnanceSurveyServiceGetAddressesByPostcode).calledWith(postcode).mockResolvedValueOnce(getAddressesOrdnanceSurveyResponse[0]);
4545

4646
const response = await service.getAddressesByPostcode(postcode);
4747

48-
expect(response).toEqual(getAddressByPostcodeResponse[0]);
48+
expect(response).toEqual(getAddressesByPostcodeResponse[0]);
4949
});
5050

5151
it('returns multiple addressess from the backend service', async () => {
52-
when(ordnanceSurveyServiceGetAddressesByPostcode).calledWith(postcode).mockResolvedValueOnce(getAddressOrdnanceSurveyMultipleResponse);
52+
when(ordnanceSurveyServiceGetAddressesByPostcode).calledWith(postcode).mockResolvedValueOnce(getAddressesOrdnanceSurveyMultipleMatchingAddressesResponse);
5353

5454
const response = await service.getAddressesByPostcode(postcode);
5555

56-
expect(response).toEqual(getAddressByPostcodeMultipleResponse);
56+
expect(response).toEqual(getAddressesByPostcodeMultipleResponse);
5757
});
5858

5959
it('can handle empty backend response', async () => {
60-
when(ordnanceSurveyServiceGetAddressesByPostcode).calledWith(postcode).mockResolvedValueOnce(getAddressOrdnanceSurveyEmptyResponse[0]);
60+
when(ordnanceSurveyServiceGetAddressesByPostcode).calledWith(postcode).mockResolvedValueOnce(getAddressesOrdnanceSurveyEmptyResponse[0]);
6161

6262
const response = await service.getAddressesByPostcode(postcode);
6363

6464
expect(response).toEqual([]);
6565
});
6666

6767
it('returns addressLine1 formatted correctly even if middle value is missing', async () => {
68-
const [modifiedOrdnanceSurveyResponse] = structuredClone(getAddressOrdnanceSurveyResponse);
68+
const [modifiedOrdnanceSurveyResponse] = structuredClone(getAddressesOrdnanceSurveyResponse);
6969
modifiedOrdnanceSurveyResponse.results[0].DPA.BUILDING_NUMBER = null;
7070
const address = modifiedOrdnanceSurveyResponse.results[0].DPA;
7171
when(ordnanceSurveyServiceGetAddressesByPostcode).calledWith(postcode).mockResolvedValueOnce(modifiedOrdnanceSurveyResponse);

test/geospatial/get-address-by-postcode.api-test.ts

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ describe('GET /geospatial/addresses/postcode?postcode=', () => {
1212
let api: Api;
1313

1414
const {
15-
ordnanceSurveyPath,
16-
mdmPath,
17-
getAddressByPostcodeResponse,
18-
getAddressByPostcodeMultipleResponse,
19-
getAddressOrdnanceSurveyResponse,
20-
getAddressOrdnanceSurveyEmptyResponse,
21-
getAddressOrdnanceSurveyMultipleResponse,
15+
ordnanceSurveyPaths,
16+
mdmPaths,
17+
getAddressesByPostcodeResponse,
18+
getAddressesByPostcodeMultipleResponse,
19+
getAddressesOrdnanceSurveyResponse,
20+
getAddressesOrdnanceSurveyEmptyResponse,
21+
getAddressesOrdnanceSurveyMultipleMatchingAddressesResponse,
2222
ordnanceSurveyAuthErrorResponse,
2323
} = new GetGeospatialAddressesGenerator(valueGenerator).generate({
2424
postcode: GEOSPATIAL.EXAMPLES.POSTCODE,
@@ -44,42 +44,42 @@ describe('GET /geospatial/addresses/postcode?postcode=', () => {
4444
// MDM auth tests
4545
withClientAuthenticationTests({
4646
givenTheRequestWouldOtherwiseSucceed: () => {
47-
requestToGetAddressesByPostcode(ordnanceSurveyPath[0]).reply(200, getAddressOrdnanceSurveyResponse[0]);
47+
requestToGetAddressesByPostcode(ordnanceSurveyPaths[0]).reply(200, getAddressesOrdnanceSurveyResponse[0]);
4848
},
49-
makeRequestWithoutAuth: (incorrectAuth?: IncorrectAuthArg) => api.getWithoutAuth(mdmPath[0], incorrectAuth?.headerName, incorrectAuth?.headerValue),
49+
makeRequestWithoutAuth: (incorrectAuth?: IncorrectAuthArg) => api.getWithoutAuth(mdmPaths[0], incorrectAuth?.headerName, incorrectAuth?.headerValue),
5050
});
5151

5252
it('returns a 200 response with the address if it is returned by Ordnance Survey API', async () => {
53-
requestToGetAddressesByPostcode(ordnanceSurveyPath[0]).reply(200, getAddressOrdnanceSurveyResponse[0]);
53+
requestToGetAddressesByPostcode(ordnanceSurveyPaths[0]).reply(200, getAddressesOrdnanceSurveyResponse[0]);
5454

55-
const { status, body } = await api.get(mdmPath[0]);
55+
const { status, body } = await api.get(mdmPaths[0]);
5656

5757
expect(status).toBe(200);
58-
expect(body).toStrictEqual(getAddressByPostcodeResponse[0]);
58+
expect(body).toStrictEqual(getAddressesByPostcodeResponse[0]);
5959
});
6060

6161
it('returns a 200 response with the addresses if they are returned by Ordnance Survey API', async () => {
62-
requestToGetAddressesByPostcode(ordnanceSurveyPath[0]).reply(200, getAddressOrdnanceSurveyMultipleResponse);
62+
requestToGetAddressesByPostcode(ordnanceSurveyPaths[0]).reply(200, getAddressesOrdnanceSurveyMultipleMatchingAddressesResponse);
6363

64-
const { status, body } = await api.get(mdmPath[0]);
64+
const { status, body } = await api.get(mdmPaths[0]);
6565

6666
expect(status).toBe(200);
67-
expect(body).toStrictEqual(getAddressByPostcodeMultipleResponse);
67+
expect(body).toStrictEqual(getAddressesByPostcodeMultipleResponse);
6868
});
6969

7070
it('returns an empty 200 response if Ordnance Survey API returns a 200 without results', async () => {
71-
requestToGetAddressesByPostcode(ordnanceSurveyPath[0]).reply(200, getAddressOrdnanceSurveyEmptyResponse[0]);
71+
requestToGetAddressesByPostcode(ordnanceSurveyPaths[0]).reply(200, getAddressesOrdnanceSurveyEmptyResponse[0]);
7272

73-
const { status, body } = await api.get(mdmPath[0]);
73+
const { status, body } = await api.get(mdmPaths[0]);
7474

7575
expect(status).toBe(200);
7676
expect(body).toStrictEqual([]);
7777
});
7878

7979
it('returns a 500 response if Ordnance Survey API returns a status code 401', async () => {
80-
requestToGetAddressesByPostcode(ordnanceSurveyPath[0]).reply(401);
80+
requestToGetAddressesByPostcode(ordnanceSurveyPaths[0]).reply(401);
8181

82-
const { status, body } = await api.get(mdmPath[0]);
82+
const { status, body } = await api.get(mdmPaths[0]);
8383

8484
expect(status).toBe(500);
8585
expect(body).toStrictEqual({
@@ -89,9 +89,9 @@ describe('GET /geospatial/addresses/postcode?postcode=', () => {
8989
});
9090

9191
it('returns a 500 response if Ordnance Survey API returns a status code 404', async () => {
92-
requestToGetAddressesByPostcode(ordnanceSurveyPath[0]).reply(404);
92+
requestToGetAddressesByPostcode(ordnanceSurveyPaths[0]).reply(404);
9393

94-
const { status, body } = await api.get(mdmPath[0]);
94+
const { status, body } = await api.get(mdmPaths[0]);
9595

9696
expect(status).toBe(500);
9797
expect(body).toStrictEqual({
@@ -101,9 +101,9 @@ describe('GET /geospatial/addresses/postcode?postcode=', () => {
101101
});
102102

103103
it('returns a 500 response if Ordnance Survey API times out', async () => {
104-
requestToGetAddressesByPostcode(ordnanceSurveyPath[0]).delay(TIME_EXCEEDING_ORDNANCE_SURVEY_TIMEOUT).reply(200, getAddressOrdnanceSurveyResponse[0]);
104+
requestToGetAddressesByPostcode(ordnanceSurveyPaths[0]).delay(TIME_EXCEEDING_ORDNANCE_SURVEY_TIMEOUT).reply(200, getAddressesOrdnanceSurveyResponse[0]);
105105

106-
const { status, body } = await api.get(mdmPath[0]);
106+
const { status, body } = await api.get(mdmPaths[0]);
107107

108108
expect(status).toBe(500);
109109
expect(body).toStrictEqual({
@@ -113,9 +113,9 @@ describe('GET /geospatial/addresses/postcode?postcode=', () => {
113113
});
114114

115115
it('returns a 500 response if Ordnance Survey API returns error', async () => {
116-
requestToGetAddressesByPostcode(ordnanceSurveyPath[0]).reply(401, ordnanceSurveyAuthErrorResponse);
116+
requestToGetAddressesByPostcode(ordnanceSurveyPaths[0]).reply(401, ordnanceSurveyAuthErrorResponse);
117117

118-
const { status, body } = await api.get(mdmPath[0]);
118+
const { status, body } = await api.get(mdmPaths[0]);
119119

120120
expect(status).toBe(500);
121121
expect(body).toStrictEqual({

test/support/generator/get-geospatial-addresses-generator.ts

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -189,13 +189,13 @@ export class GetGeospatialAddressesGenerator extends AbstractGenerator<AddressVa
189189

190190
return {
191191
requests,
192-
ordnanceSurveyPath: ordnanceSurveyPaths,
193-
mdmPath: mdmPaths,
194-
getAddressByPostcodeResponse: getAddressesByPostcodeResponse,
195-
getAddressByPostcodeMultipleResponse: getAddressesByPostcodeMultipleResponse,
196-
getAddressOrdnanceSurveyResponse: getAddressesOrdnanceSurveyResponse,
197-
getAddressOrdnanceSurveyEmptyResponse: getAddressesOrdnanceSurveyEmptyResponse,
198-
getAddressOrdnanceSurveyMultipleResponse: getAddressesOrdnanceSurveyMultipleMatchingAddressesResponse,
192+
ordnanceSurveyPaths,
193+
mdmPaths,
194+
getAddressesByPostcodeResponse,
195+
getAddressesByPostcodeMultipleResponse,
196+
getAddressesOrdnanceSurveyResponse,
197+
getAddressesOrdnanceSurveyEmptyResponse,
198+
getAddressesOrdnanceSurveyMultipleMatchingAddressesResponse,
199199
ordnanceSurveyAuthErrorResponse,
200200
};
201201
}
@@ -219,12 +219,12 @@ interface GenerateOptions {
219219

220220
interface GenerateResult {
221221
requests: GetAddressesByPostcodeQueryDto[];
222-
ordnanceSurveyPath: string[];
223-
mdmPath: string[];
224-
getAddressByPostcodeResponse: GetAddressesResponse[];
225-
getAddressByPostcodeMultipleResponse: GetAddressesResponse;
226-
getAddressOrdnanceSurveyResponse: GetAddressesOrdnanceSurveyResponse[];
227-
getAddressOrdnanceSurveyMultipleResponse: GetAddressesOrdnanceSurveyResponse;
228-
getAddressOrdnanceSurveyEmptyResponse: GetAddressesOrdnanceSurveyResponse;
222+
ordnanceSurveyPaths: string[];
223+
mdmPaths: string[];
224+
getAddressesByPostcodeResponse: GetAddressesResponse[];
225+
getAddressesByPostcodeMultipleResponse: GetAddressesResponse;
226+
getAddressesOrdnanceSurveyResponse: GetAddressesOrdnanceSurveyResponse[];
227+
getAddressesOrdnanceSurveyMultipleMatchingAddressesResponse: GetAddressesOrdnanceSurveyResponse;
228+
getAddressesOrdnanceSurveyEmptyResponse: GetAddressesOrdnanceSurveyResponse;
229229
ordnanceSurveyAuthErrorResponse: OrdnanceSurveyAuthErrorResponse;
230230
}

0 commit comments

Comments
 (0)