Skip to content

Commit 65c18d2

Browse files
SteffanASteffanA
committed
LCS-83: Refractors shared func names
 - checkForAddedObject(s) => checkForReturnedObject(s) - Also removes unneeded auth imports - Note that it looks like current setup doesn't actually gather list coverage? Not sure why?
1 parent c4069fd commit 65c18d2

File tree

4 files changed

+32
-33
lines changed

4 files changed

+32
-33
lines changed

‎server/routes/api/auth.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
const auth = require('../../middleware/auth')
21
const User = require('../../models/User')
32

43
const express = require('express')

‎server/tests/Lists/Lists.test.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ const fs = require('fs'); // For reading local JSON file
99

1010
const {checkForCorrectErrors, createTestUser,
1111
checkValidationResult, convertLeetCodeResToOurObjects,
12-
checkForAddedObject, checkForAddedIDs,
12+
checkForReturnedObject, checkForAddedIDs,
1313
checkAllValidationResults, createOrGetTokenForAdminUser,
14-
checkForAddedObjects, checkForEmptyArray,
14+
checkForReturnedObjects, checkForEmptyArray,
1515
getFakeMongoDBid} = require('../sharedTestFunctions.js')
1616

1717
const BASE_URL = '/api/lists'
@@ -124,7 +124,7 @@ describe('Lists API Tests' , () => {
124124
.send(list)
125125
.end((err, res) => {
126126
if (err) reject(err)
127-
checkForAddedObject(res, dummyFunc, list)
127+
checkForReturnedObject(res, dummyFunc, list)
128128
resolve(res)
129129
})
130130
})
@@ -207,7 +207,7 @@ describe('Lists API Tests' , () => {
207207
.end((err, res) => {
208208
if (err) done(err)
209209
const dummyFunc = () => {}
210-
checkForAddedObject(res, dummyFunc, addedPublicList)
210+
checkForReturnedObject(res, dummyFunc, addedPublicList)
211211
publicListId = res.body._id
212212
done()
213213
})
@@ -221,7 +221,7 @@ describe('Lists API Tests' , () => {
221221
.end((err, res) => {
222222
if (err) done(err)
223223
const dummyFunc = () => {}
224-
checkForAddedObject(res, dummyFunc, addedOwnPrivateList)
224+
checkForReturnedObject(res, dummyFunc, addedOwnPrivateList)
225225
privateOwnListId = res.body._id
226226
done()
227227
})
@@ -234,7 +234,7 @@ describe('Lists API Tests' , () => {
234234
.get(BASE_URL)
235235
.end((err, res) => {
236236
if (err) done(err)
237-
checkForAddedObjects(res, '', done, [addedPublicList])
237+
checkForReturnedObjects(res, '', done, [addedPublicList])
238238
})
239239
})
240240

@@ -243,7 +243,7 @@ describe('Lists API Tests' , () => {
243243
.get(BASE_URL + '/public/id/' + publicListId)
244244
.end((err, res) => {
245245
if (err) done(err)
246-
checkForAddedObject(res, done, addedPublicList)
246+
checkForReturnedObject(res, done, addedPublicList)
247247
})
248248
})
249249

@@ -272,7 +272,7 @@ describe('Lists API Tests' , () => {
272272
.set({'x-auth-token': token})
273273
.end((err, res) => {
274274
if (err) done(err)
275-
checkForAddedObjects(res, '', done, [addedPublicList])
275+
checkForReturnedObjects(res, '', done, [addedPublicList])
276276
})
277277
})
278278

@@ -282,7 +282,7 @@ describe('Lists API Tests' , () => {
282282
.set({'x-auth-token': token})
283283
.end((err, res) => {
284284
if (err) done(err)
285-
checkForAddedObject(res, done, addedOwnPrivateList)
285+
checkForReturnedObject(res, done, addedOwnPrivateList)
286286
})
287287
})
288288

@@ -314,7 +314,7 @@ describe('Lists API Tests' , () => {
314314
.get(BASE_URL + '/public/search/' + term)
315315
.end((err, res) => {
316316
if (err) done(err)
317-
checkForAddedObjects(res, '', done, [addedPublicList])
317+
checkForReturnedObjects(res, '', done, [addedPublicList])
318318
})
319319
})
320320

‎server/tests/Problems/Problems.test.js

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ const fs = require('fs') // For reading local JSON file
99

1010
const {checkForCorrectErrors, createTestUser,
1111
checkValidationResult, convertLeetCodeResToOurObjects,
12-
checkForAddedObject, checkForAddedIDs,
12+
checkForReturnedObject, checkForAddedIDs,
1313
checkAllValidationResults, createOrGetTokenForAdminUser,
14-
checkForAddedObjects, getFakeMongoDBid,
14+
checkForReturnedObjects, getFakeMongoDBid,
1515
} = require('../sharedTestFunctions.js')
1616

1717
const BASE_URL = '/api/problems'
@@ -298,7 +298,7 @@ describe('Problems API Tests' , () => {
298298
)
299299
.end((err, res) => {
300300
if (err) done(err)
301-
checkForAddedObject(res, done, prob)
301+
checkForReturnedObject(res, done, prob)
302302
})
303303
})
304304

@@ -422,7 +422,7 @@ describe('Problems API Tests' , () => {
422422
)
423423
.end((err, res) => {
424424
if (err) done(err)
425-
checkForAddedObject(res, done, toBeUpdatedProb)
425+
checkForReturnedObject(res, done, toBeUpdatedProb)
426426
})
427427
})
428428

@@ -437,7 +437,7 @@ describe('Problems API Tests' , () => {
437437
)
438438
.end((err, res) => {
439439
if (err) done(err)
440-
checkForAddedObject(res, done, toBeUpdatedProb)
440+
checkForReturnedObject(res, done, toBeUpdatedProb)
441441
})
442442
})
443443

@@ -452,7 +452,7 @@ describe('Problems API Tests' , () => {
452452
)
453453
.end((err, res) => {
454454
if (err) done(err)
455-
checkForAddedObject(res, done, toBeUpdatedProb)
455+
checkForReturnedObject(res, done, toBeUpdatedProb)
456456
})
457457
})
458458

@@ -467,7 +467,7 @@ describe('Problems API Tests' , () => {
467467
)
468468
.end((err, res) => {
469469
if (err) done(err)
470-
checkForAddedObject(res, done, toBeUpdatedProb)
470+
checkForReturnedObject(res, done, toBeUpdatedProb)
471471
})
472472
})
473473

@@ -482,7 +482,7 @@ describe('Problems API Tests' , () => {
482482
)
483483
.end((err, res) => {
484484
if (err) done(err)
485-
checkForAddedObject(res, done, toBeUpdatedProb)
485+
checkForReturnedObject(res, done, toBeUpdatedProb)
486486
})
487487
})
488488

@@ -497,7 +497,7 @@ describe('Problems API Tests' , () => {
497497
)
498498
.end((err, res) => {
499499
if (err) done(err)
500-
checkForAddedObject(res, done, toBeUpdatedProb)
500+
checkForReturnedObject(res, done, toBeUpdatedProb)
501501
})
502502
})
503503

@@ -570,7 +570,7 @@ describe('Problems API Tests' , () => {
570570
.get(BASE_URL + '/id/ab')
571571
.end((err, res) => {
572572
if (err) done(err)
573-
checkForAddedObject(res, done, {})
573+
checkForReturnedObject(res, done, {})
574574
})
575575
})
576576

@@ -586,7 +586,7 @@ describe('Problems API Tests' , () => {
586586
.get(BASE_URL + '/id/' + existingProbID)
587587
.end((err, res) => {
588588
if (err) done(err)
589-
checkForAddedObject(res, done, existingProb)
589+
checkForReturnedObject(res, done, existingProb)
590590
})
591591
})
592592

@@ -662,7 +662,7 @@ describe('Problems API Tests' , () => {
662662
})
663663
.end((err, res) => {
664664
if (err) done(err)
665-
checkForAddedObjects(res, 'problems', done, usedProbs)
665+
checkForReturnedObjects(res, 'problems', done, usedProbs)
666666
})
667667
})
668668
})
@@ -679,7 +679,7 @@ describe('Problems API Tests' , () => {
679679
.get(BASE_URL + '/?start=' + addedIdStart + '&end=' + addedIdEnd)
680680
.end((err, res) => {
681681
if (err) done(err)
682-
checkForAddedObjects(res, '', done, addedProblems)
682+
checkForReturnedObjects(res, '', done, addedProblems)
683683
})
684684
})
685685

@@ -690,7 +690,7 @@ describe('Problems API Tests' , () => {
690690
.get(BASE_URL + '/?start=' + addedIdStart)
691691
.end((err, res) => {
692692
if (err) done(err)
693-
checkForAddedObjects(res, '', done, addedProblems)
693+
checkForReturnedObjects(res, '', done, addedProblems)
694694
})
695695
})
696696

@@ -701,7 +701,7 @@ describe('Problems API Tests' , () => {
701701
.get(BASE_URL + '/?end=' + addedIdEnd)
702702
.end((err, res) => {
703703
if (err) done(err)
704-
checkForAddedObjects(res, '', done, addedProblems)
704+
checkForReturnedObjects(res, '', done, addedProblems)
705705
})
706706
})
707707

@@ -711,7 +711,7 @@ describe('Problems API Tests' , () => {
711711
.get(BASE_URL)
712712
.end((err, res) => {
713713
if (err) done(err)
714-
checkForAddedObjects(res, '', done, addedProblems)
714+
checkForReturnedObjects(res, '', done, addedProblems)
715715
})
716716
})
717717

@@ -735,7 +735,7 @@ describe('Problems API Tests' , () => {
735735
.get(BASE_URL + '/name/' + name)
736736
.end((err, res) => {
737737
if (err) done(err)
738-
checkForAddedObjects(res, 'problems', done, [prob])
738+
checkForReturnedObjects(res, 'problems', done, [prob])
739739
})
740740
})
741741

@@ -746,7 +746,7 @@ describe('Problems API Tests' , () => {
746746
.get(BASE_URL + '/name/' + text)
747747
.end((err, res) => {
748748
if (err) done(err)
749-
checkForAddedObjects(res, 'problems', done, [prob])
749+
checkForReturnedObjects(res, 'problems', done, [prob])
750750
})
751751
})
752752

‎server/tests/sharedTestFunctions.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ const checkForValidAddition = (res, done, addedId) => {
123123

124124
// Checks the response contains the provided object
125125
// Intended for use against a single response object, not an array of response objects
126-
const checkForAddedObject = (res, done, addedObj) => {
126+
const checkForReturnedObject = (res, done, addedObj) => {
127127
// Check response for a valid 200
128128
expect(res).to.have.status(200)
129129
const body = res.body
@@ -140,7 +140,7 @@ const checkForAddedObject = (res, done, addedObj) => {
140140

141141
// Checks that each object provided is contained in the response array
142142
// Assumes each object in the resArray follows the same key-value format
143-
const checkForAddedObjects = (res, resArrayName, done, addedObjArray) => {
143+
const checkForReturnedObjects = (res, resArrayName, done, addedObjArray) => {
144144
// Check response for a valid 200
145145
expect(res).to.have.status(200)
146146
const body = res.body
@@ -347,8 +347,8 @@ const getFakeMongoDBid = () => {
347347
}
348348

349349
module.exports = {checkForCorrectErrors, checkForValidAddition, checkForValidRemoval,
350-
checkSuccessfulLogin, checkValidationResult, checkForCorrectMessage, checkForAddedObject,
351-
checkForAddedObjects, checkForAddedIDs, checkAllValidationResults, checkRouteIsPrivate,
350+
checkSuccessfulLogin, checkValidationResult, checkForCorrectMessage, checkForReturnedObject,
351+
checkForReturnedObjects, checkForAddedIDs, checkAllValidationResults, checkRouteIsPrivate,
352352
checkRoutesArePrivate, createTestUser, convertLeetCodeResToOurObjects, createOrGetTokenForAdminUser,
353353
getFakeMongoDBid, checkForEmptyArray,
354354
}

0 commit comments

Comments
 (0)