1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
4 import * as chai from 'chai'
5 import { MockSmtpServer } from '@server/tests/shared'
6 import { HttpStatusCode } from '@shared/models'
7 import { cleanupTests, createSingleServer, PeerTubeServer, setAccessTokensToServers, waitJobs } from '@shared/server-commands'
9 const expect = chai.expect
11 describe('Test emails', function () {
12 let server: PeerTubeServer
15 let userAccessToken: string
17 let videoShortUUID: string
20 let videoUserUUID: string
22 let verificationString: string
23 let verificationString2: string
25 const emails: object[] = []
28 password: 'super_password'
32 before(async function () {
35 emailPort = await MockSmtpServer.Instance.collectEmails(emails)
37 const overrideConfig = {
39 hostname: 'localhost',
43 server = await createSingleServer(1, overrideConfig)
44 await setAccessTokensToServers([ server ])
47 const created = await server.users.create({ username: user.username, password: user.password })
50 userAccessToken = await server.login.getAccessToken(user)
54 const attributes = { name: 'my super user video' }
55 const { uuid } = await server.videos.upload({ token: userAccessToken, attributes })
63 const { shortUUID, id } = await server.videos.upload({ attributes })
64 videoShortUUID = shortUUID
69 describe('When resetting user password', function () {
71 it('Should ask to reset the password', async function () {
74 await server.users.askResetPassword({ email: 'user_1@example.com' })
76 await waitJobs(server)
77 expect(emails).to.have.lengthOf(1)
79 const email = emails[0]
81 expect(email['from'][0]['name']).equal('PeerTube')
82 expect(email['from'][0]['address']).equal('test-admin@localhost')
83 expect(email['to'][0]['address']).equal('user_1@example.com')
84 expect(email['subject']).contains('password')
86 const verificationStringMatches = /verificationString=([a-z0-9]+)/.exec(email['text'])
87 expect(verificationStringMatches).not.to.be.null
89 verificationString = verificationStringMatches[1]
90 expect(verificationString).to.have.length.above(2)
92 const userIdMatches = /userId=([0-9]+)/.exec(email['text'])
93 expect(userIdMatches).not.to.be.null
95 userId = parseInt(userIdMatches[1], 10)
96 expect(verificationString).to.not.be.undefined
99 it('Should not reset the password with an invalid verification string', async function () {
100 await server.users.resetPassword({
102 verificationString: verificationString + 'b',
103 password: 'super_password2',
104 expectedStatus: HttpStatusCode.FORBIDDEN_403
108 it('Should reset the password', async function () {
109 await server.users.resetPassword({ userId, verificationString, password: 'super_password2' })
112 it('Should not reset the password with the same verification string', async function () {
113 await server.users.resetPassword({
116 password: 'super_password3',
117 expectedStatus: HttpStatusCode.FORBIDDEN_403
121 it('Should login with this new password', async function () {
122 user.password = 'super_password2'
124 await server.login.getAccessToken(user)
128 describe('When creating a user without password', function () {
130 it('Should send a create password email', async function () {
133 await server.users.create({ username: 'create_password', password: '' })
135 await waitJobs(server)
136 expect(emails).to.have.lengthOf(2)
138 const email = emails[1]
140 expect(email['from'][0]['name']).equal('PeerTube')
141 expect(email['from'][0]['address']).equal('test-admin@localhost')
142 expect(email['to'][0]['address']).equal('create_password@example.com')
143 expect(email['subject']).contains('account')
144 expect(email['subject']).contains('password')
146 const verificationStringMatches = /verificationString=([a-z0-9]+)/.exec(email['text'])
147 expect(verificationStringMatches).not.to.be.null
149 verificationString2 = verificationStringMatches[1]
150 expect(verificationString2).to.have.length.above(2)
152 const userIdMatches = /userId=([0-9]+)/.exec(email['text'])
153 expect(userIdMatches).not.to.be.null
155 userId2 = parseInt(userIdMatches[1], 10)
158 it('Should not reset the password with an invalid verification string', async function () {
159 await server.users.resetPassword({
161 verificationString: verificationString2 + 'c',
162 password: 'newly_created_password',
163 expectedStatus: HttpStatusCode.FORBIDDEN_403
167 it('Should reset the password', async function () {
168 await server.users.resetPassword({
170 verificationString: verificationString2,
171 password: 'newly_created_password'
175 it('Should login with this new password', async function () {
176 await server.login.getAccessToken({
177 username: 'create_password',
178 password: 'newly_created_password'
183 describe('When creating an abuse', function () {
185 it('Should send the notification email', async function () {
188 const reason = 'my super bad reason'
189 await server.abuses.report({ token: userAccessToken, videoId, reason })
191 await waitJobs(server)
192 expect(emails).to.have.lengthOf(3)
194 const email = emails[2]
196 expect(email['from'][0]['name']).equal('PeerTube')
197 expect(email['from'][0]['address']).equal('test-admin@localhost')
198 expect(email['to'][0]['address']).equal('admin' + server.internalServerNumber + '@example.com')
199 expect(email['subject']).contains('abuse')
200 expect(email['text']).contains(videoShortUUID)
204 describe('When blocking/unblocking user', function () {
206 it('Should send the notification email when blocking a user', async function () {
209 const reason = 'my super bad reason'
210 await server.users.banUser({ userId, reason })
212 await waitJobs(server)
213 expect(emails).to.have.lengthOf(4)
215 const email = emails[3]
217 expect(email['from'][0]['name']).equal('PeerTube')
218 expect(email['from'][0]['address']).equal('test-admin@localhost')
219 expect(email['to'][0]['address']).equal('user_1@example.com')
220 expect(email['subject']).contains(' blocked')
221 expect(email['text']).contains(' blocked')
222 expect(email['text']).contains('bad reason')
225 it('Should send the notification email when unblocking a user', async function () {
228 await server.users.unbanUser({ userId })
230 await waitJobs(server)
231 expect(emails).to.have.lengthOf(5)
233 const email = emails[4]
235 expect(email['from'][0]['name']).equal('PeerTube')
236 expect(email['from'][0]['address']).equal('test-admin@localhost')
237 expect(email['to'][0]['address']).equal('user_1@example.com')
238 expect(email['subject']).contains(' unblocked')
239 expect(email['text']).contains(' unblocked')
243 describe('When blacklisting a video', function () {
244 it('Should send the notification email', async function () {
247 const reason = 'my super reason'
248 await server.blacklist.add({ videoId: videoUserUUID, reason })
250 await waitJobs(server)
251 expect(emails).to.have.lengthOf(6)
253 const email = emails[5]
255 expect(email['from'][0]['name']).equal('PeerTube')
256 expect(email['from'][0]['address']).equal('test-admin@localhost')
257 expect(email['to'][0]['address']).equal('user_1@example.com')
258 expect(email['subject']).contains(' blacklisted')
259 expect(email['text']).contains('my super user video')
260 expect(email['text']).contains('my super reason')
263 it('Should send the notification email', async function () {
266 await server.blacklist.remove({ videoId: videoUserUUID })
268 await waitJobs(server)
269 expect(emails).to.have.lengthOf(7)
271 const email = emails[6]
273 expect(email['from'][0]['name']).equal('PeerTube')
274 expect(email['from'][0]['address']).equal('test-admin@localhost')
275 expect(email['to'][0]['address']).equal('user_1@example.com')
276 expect(email['subject']).contains(' unblacklisted')
277 expect(email['text']).contains('my super user video')
280 it('Should have the manage preferences link in the email', async function () {
281 const email = emails[6]
282 expect(email['text']).to.contain('Manage your notification preferences')
286 describe('When verifying a user email', function () {
288 it('Should ask to send the verification email', async function () {
291 await server.users.askSendVerifyEmail({ email: 'user_1@example.com' })
293 await waitJobs(server)
294 expect(emails).to.have.lengthOf(8)
296 const email = emails[7]
298 expect(email['from'][0]['name']).equal('PeerTube')
299 expect(email['from'][0]['address']).equal('test-admin@localhost')
300 expect(email['to'][0]['address']).equal('user_1@example.com')
301 expect(email['subject']).contains('Verify')
303 const verificationStringMatches = /verificationString=([a-z0-9]+)/.exec(email['text'])
304 expect(verificationStringMatches).not.to.be.null
306 verificationString = verificationStringMatches[1]
307 expect(verificationString).to.not.be.undefined
308 expect(verificationString).to.have.length.above(2)
310 const userIdMatches = /userId=([0-9]+)/.exec(email['text'])
311 expect(userIdMatches).not.to.be.null
313 userId = parseInt(userIdMatches[1], 10)
316 it('Should not verify the email with an invalid verification string', async function () {
317 await server.users.verifyEmail({
319 verificationString: verificationString + 'b',
320 isPendingEmail: false,
321 expectedStatus: HttpStatusCode.FORBIDDEN_403
325 it('Should verify the email', async function () {
326 await server.users.verifyEmail({ userId, verificationString })
330 after(async function () {
331 MockSmtpServer.Instance.kill()
333 await cleanupTests([ server ])