-
Notifications
You must be signed in to change notification settings - Fork 9
/
api.users.js
317 lines (292 loc) · 13.4 KB
/
api.users.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
const should = require('should');
const flow = require('nimble');
const httpStatus = require('http-status');
const superagent = require('superagent-ls');
const requireNew = require('require-new');
const wipe = require('./fixture-helpers/wipe');
const setup = require('./fixture-helpers/setup');
const config = require('../config');
const ESDR_API_ROOT_URL = config.get("esdr:apiRootUrl");
const ESDR_USERS_API_URL = ESDR_API_ROOT_URL + "/users";
describe("REST API", function() {
const client1 = requireNew('./fixtures/client1.json');
const user1 = requireNew('./fixtures/user1.json');
const userNoDisplayName = requireNew('./fixtures/user2.json');
const userNeedsTrimming = requireNew('./fixtures/user3-needs-trimming.json');
const userEmptyDisplayName = requireNew('./fixtures/user4-empty-displayName.json');
const userEmailTooShort = requireNew('./fixtures/user5-email-too-short.json');
const userEmailTooLong = requireNew('./fixtures/user6-email-too-long.json');
const userPasswordTooShort = requireNew('./fixtures/user7-password-too-short.json');
const userPasswordTooLong = requireNew('./fixtures/user8-password-too-long.json');
const userDisplayNameTooLong = requireNew('./fixtures/user9-displayName-too-long.json');
const userEmailInvalid = requireNew('./fixtures/user10-email-invalid.json');
const user11 = requireNew('./fixtures/user11.json');
before(function(initDone) {
flow.series(
[
wipe.wipeAllData,
function(done) {
setup.createClient(client1, done);
}
],
initDone
);
});
describe("Users", function() {
describe("Create", function() {
const creationTests = [
{
description : "Should be able to create a new user",
client : client1,
user : user1,
expectedHttpStatus : httpStatus.CREATED,
expectedStatusText : 'success',
expectedResponseData : {
email : user1['email'],
displayName : user1['displayName']
}
},
{
description : "Should trim the email and displayName when creating a new user",
client : client1,
user : userNeedsTrimming,
expectedHttpStatus : httpStatus.CREATED,
expectedStatusText : 'success',
expectedResponseData : {
email : userNeedsTrimming['email'].trim(),
displayName : userNeedsTrimming['displayName'].trim()
}
},
{
description : "Should be able to create a new user with no display name",
client : client1,
user : userNoDisplayName,
expectedHttpStatus : httpStatus.CREATED,
expectedStatusText : 'success',
expectedResponseData : {
email : userNoDisplayName['email']
}
},
{
description : "Should be able to create a new user with an empty display name",
client : client1,
user : userEmptyDisplayName,
expectedHttpStatus : httpStatus.CREATED,
expectedStatusText : 'success',
expectedResponseData : {
email : userEmptyDisplayName['email']
}
},
{
description : "Should fail to create the same user again",
client : client1,
user : user1,
expectedHttpStatus : httpStatus.CONFLICT,
expectedStatusText : 'error',
expectedResponseData : {
email : user1['email']
}
}
];
creationTests.forEach(function(test) {
it(test.description, function(done) {
superagent
.post(ESDR_USERS_API_URL)
.auth(test.client.clientName, test.client.clientSecret)
.send(test.user)
.end(function(err, res) {
should.not.exist(err);
should.exist(res);
res.should.have.property('status', test.expectedHttpStatus);
res.should.have.property('body');
res.body.should.have.properties({
code : test.expectedHttpStatus,
status : test.expectedStatusText
});
res.body.should.have.property('data');
res.body.data.should.have.properties(test.expectedResponseData);
if (test.expectedHttpStatus === httpStatus.CREATED) {
res.body.data.should.have.properties('id', 'verificationToken');
// remember the database ID and verificationToken
test.user.id = res.body.data.id;
test.user.verificationToken = res.body.data.verificationToken;
}
done();
});
});
});
const creationValidationTests = [
{
description : "Should fail to create a new user with missing user data",
user : {},
getExpectedValidationItems : function() {
return [
{
"keyword" : "required",
"params" : {
"missingProperty" : "email"
}
},
{
"keyword" : "required",
"params" : {
"missingProperty" : "password"
}
}
];
}
},
{
description : "Should fail to create a new user with an email address that's too short",
user : userEmailTooShort,
getExpectedValidationItems : function() {
return [{
"keyword" : "minLength",
"dataPath" : ".email",
"schemaPath" : "#/properties/email/minLength"
}];
}
},
{
description : "Should fail to create a new user with an email address that's too long",
user : userEmailTooLong,
getExpectedValidationItems : function() {
return [{
"keyword" : "maxLength",
"dataPath" : ".email",
"schemaPath" : "#/properties/email/maxLength"
}, {
"keyword" : "format",
"dataPath" : ".email",
"schemaPath" : "#/properties/email/format",
"params" : {
"format" : "email"
}
}];
}
},
{
description : "Should fail to create a new user with a password that's too short",
user : userPasswordTooShort,
getExpectedValidationItems : function() {
return [{
"keyword" : "minLength",
"dataPath" : ".password",
"schemaPath" : "#/properties/password/minLength"
}];
}
},
{
description : "Should fail to create a new user with a password that's too long",
user : userPasswordTooLong,
getExpectedValidationItems : function() {
return [{
"keyword" : "maxLength",
"dataPath" : ".password",
"schemaPath" : "#/properties/password/maxLength"
}];
}
},
{
description : "Should fail to create a new user with a display name that's too long",
user : userDisplayNameTooLong,
getExpectedValidationItems : function() {
return [{
"keyword" : "maxLength",
"dataPath" : ".displayName",
"schemaPath" : "#/properties/displayName/maxLength"
}];
}
},
{
description : "Should fail to create a new user with a email address that's invalid",
user : userEmailInvalid,
getExpectedValidationItems : function() {
return [{
"keyword" : "format",
"dataPath" : ".email",
"schemaPath" : "#/properties/email/format",
"params" : {
"format" : "email"
}
}];
}
}
];
creationValidationTests.forEach(function(test) {
it(test.description, function(done) {
const expectedValidationItems = test.getExpectedValidationItems();
superagent
.post(ESDR_USERS_API_URL)
.auth(client1['clientName'], client1['clientSecret'])
.send(test.user)
.end(function(err, res) {
should.not.exist(err);
should.exist(res);
res.should.have.property('status', httpStatus.UNPROCESSABLE_ENTITY);
res.should.have.property('body');
res.body.should.have.properties({
code : httpStatus.UNPROCESSABLE_ENTITY,
status : 'error'
});
res.body.should.have.property('data');
res.body.data.errors.should.have.length(expectedValidationItems.length);
res.body.data.errors.forEach(function(validationItem, index) {
validationItem.should.have.properties(expectedValidationItems[index]);
});
done();
});
});
});
it("Should fail to create a new user with missing user and client", function(done) {
superagent
.post(ESDR_USERS_API_URL)
.send({})
.end(function(err, res) {
should.not.exist(err);
should.exist(res);
res.should.have.property('status', httpStatus.UNPROCESSABLE_ENTITY);
res.should.have.property('body');
res.body.should.have.properties({
code : httpStatus.UNPROCESSABLE_ENTITY,
status : 'error'
});
res.body.should.have.property('data');
res.body.data.errors.should.have.length(2);
res.body.data.errors[0].should.have.properties({
"keyword" : "required",
"params" : {
"missingProperty" : "email"
}
});
res.body.data.errors[1].should.have.properties({
"keyword" : "required",
"params" : {
"missingProperty" : "password"
}
});
done();
});
});
it("Should be able to create a new user with no client specified", function(done) {
superagent
.post(ESDR_USERS_API_URL)
.send(user11)
.end(function(err, res) {
should.not.exist(err);
should.exist(res);
res.should.have.property('status', httpStatus.CREATED);
res.should.have.property('body');
res.body.should.have.properties({
code : httpStatus.CREATED,
status : 'success'
});
res.body.should.have.property('data');
res.body.data.should.have.property('email', user11.email);
res.body.data.should.have.properties('id', 'verificationToken');
done();
});
});
}); // End Create
}); // End Users
}); // End REST API