]>
Commit | Line | Data |
---|---|---|
1 | /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */ | |
2 | ||
3 | import 'mocha' | |
4 | import * as chai from 'chai' | |
5 | import { | |
6 | cleanupTests, | |
7 | createSingleServer, | |
8 | killallServers, | |
9 | makeGetRequest, | |
10 | parallelTests, | |
11 | PeerTubeServer, | |
12 | setAccessTokensToServers | |
13 | } from '@shared/extra-utils' | |
14 | import { CustomConfig, HttpStatusCode } from '@shared/models' | |
15 | ||
16 | const expect = chai.expect | |
17 | ||
18 | function checkInitialConfig (server: PeerTubeServer, data: CustomConfig) { | |
19 | expect(data.instance.name).to.equal('PeerTube') | |
20 | expect(data.instance.shortDescription).to.equal( | |
21 | 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.' | |
22 | ) | |
23 | expect(data.instance.description).to.equal('Welcome to this PeerTube instance!') | |
24 | ||
25 | expect(data.instance.terms).to.equal('No terms for now.') | |
26 | expect(data.instance.creationReason).to.be.empty | |
27 | expect(data.instance.codeOfConduct).to.be.empty | |
28 | expect(data.instance.moderationInformation).to.be.empty | |
29 | expect(data.instance.administrator).to.be.empty | |
30 | expect(data.instance.maintenanceLifetime).to.be.empty | |
31 | expect(data.instance.businessModel).to.be.empty | |
32 | expect(data.instance.hardwareInformation).to.be.empty | |
33 | ||
34 | expect(data.instance.languages).to.have.lengthOf(0) | |
35 | expect(data.instance.categories).to.have.lengthOf(0) | |
36 | ||
37 | expect(data.instance.defaultClientRoute).to.equal('/videos/trending') | |
38 | expect(data.instance.isNSFW).to.be.false | |
39 | expect(data.instance.defaultNSFWPolicy).to.equal('display') | |
40 | expect(data.instance.customizations.css).to.be.empty | |
41 | expect(data.instance.customizations.javascript).to.be.empty | |
42 | ||
43 | expect(data.services.twitter.username).to.equal('@Chocobozzz') | |
44 | expect(data.services.twitter.whitelisted).to.be.false | |
45 | ||
46 | expect(data.cache.previews.size).to.equal(1) | |
47 | expect(data.cache.captions.size).to.equal(1) | |
48 | expect(data.cache.torrents.size).to.equal(1) | |
49 | ||
50 | expect(data.signup.enabled).to.be.true | |
51 | expect(data.signup.limit).to.equal(4) | |
52 | expect(data.signup.minimumAge).to.equal(16) | |
53 | expect(data.signup.requiresEmailVerification).to.be.false | |
54 | ||
55 | expect(data.admin.email).to.equal('admin' + server.internalServerNumber + '@example.com') | |
56 | expect(data.contactForm.enabled).to.be.true | |
57 | ||
58 | expect(data.user.videoQuota).to.equal(5242880) | |
59 | expect(data.user.videoQuotaDaily).to.equal(-1) | |
60 | ||
61 | expect(data.transcoding.enabled).to.be.false | |
62 | expect(data.transcoding.allowAdditionalExtensions).to.be.false | |
63 | expect(data.transcoding.allowAudioFiles).to.be.false | |
64 | expect(data.transcoding.threads).to.equal(2) | |
65 | expect(data.transcoding.concurrency).to.equal(2) | |
66 | expect(data.transcoding.profile).to.equal('default') | |
67 | expect(data.transcoding.resolutions['240p']).to.be.true | |
68 | expect(data.transcoding.resolutions['360p']).to.be.true | |
69 | expect(data.transcoding.resolutions['480p']).to.be.true | |
70 | expect(data.transcoding.resolutions['720p']).to.be.true | |
71 | expect(data.transcoding.resolutions['1080p']).to.be.true | |
72 | expect(data.transcoding.resolutions['1440p']).to.be.true | |
73 | expect(data.transcoding.resolutions['2160p']).to.be.true | |
74 | expect(data.transcoding.webtorrent.enabled).to.be.true | |
75 | expect(data.transcoding.hls.enabled).to.be.true | |
76 | ||
77 | expect(data.live.enabled).to.be.false | |
78 | expect(data.live.allowReplay).to.be.false | |
79 | expect(data.live.maxDuration).to.equal(-1) | |
80 | expect(data.live.maxInstanceLives).to.equal(20) | |
81 | expect(data.live.maxUserLives).to.equal(3) | |
82 | expect(data.live.transcoding.enabled).to.be.false | |
83 | expect(data.live.transcoding.threads).to.equal(2) | |
84 | expect(data.live.transcoding.profile).to.equal('default') | |
85 | expect(data.live.transcoding.resolutions['240p']).to.be.false | |
86 | expect(data.live.transcoding.resolutions['360p']).to.be.false | |
87 | expect(data.live.transcoding.resolutions['480p']).to.be.false | |
88 | expect(data.live.transcoding.resolutions['720p']).to.be.false | |
89 | expect(data.live.transcoding.resolutions['1080p']).to.be.false | |
90 | expect(data.live.transcoding.resolutions['1440p']).to.be.false | |
91 | expect(data.live.transcoding.resolutions['2160p']).to.be.false | |
92 | ||
93 | expect(data.import.videos.concurrency).to.equal(2) | |
94 | expect(data.import.videos.http.enabled).to.be.true | |
95 | expect(data.import.videos.torrent.enabled).to.be.true | |
96 | expect(data.autoBlacklist.videos.ofUsers.enabled).to.be.false | |
97 | ||
98 | expect(data.followers.instance.enabled).to.be.true | |
99 | expect(data.followers.instance.manualApproval).to.be.false | |
100 | ||
101 | expect(data.followings.instance.autoFollowBack.enabled).to.be.false | |
102 | expect(data.followings.instance.autoFollowIndex.enabled).to.be.false | |
103 | expect(data.followings.instance.autoFollowIndex.indexUrl).to.equal('') | |
104 | ||
105 | expect(data.broadcastMessage.enabled).to.be.false | |
106 | expect(data.broadcastMessage.level).to.equal('info') | |
107 | expect(data.broadcastMessage.message).to.equal('') | |
108 | expect(data.broadcastMessage.dismissable).to.be.false | |
109 | } | |
110 | ||
111 | function checkUpdatedConfig (data: CustomConfig) { | |
112 | expect(data.instance.name).to.equal('PeerTube updated') | |
113 | expect(data.instance.shortDescription).to.equal('my short description') | |
114 | expect(data.instance.description).to.equal('my super description') | |
115 | ||
116 | expect(data.instance.terms).to.equal('my super terms') | |
117 | expect(data.instance.creationReason).to.equal('my super creation reason') | |
118 | expect(data.instance.codeOfConduct).to.equal('my super coc') | |
119 | expect(data.instance.moderationInformation).to.equal('my super moderation information') | |
120 | expect(data.instance.administrator).to.equal('Kuja') | |
121 | expect(data.instance.maintenanceLifetime).to.equal('forever') | |
122 | expect(data.instance.businessModel).to.equal('my super business model') | |
123 | expect(data.instance.hardwareInformation).to.equal('2vCore 3GB RAM') | |
124 | ||
125 | expect(data.instance.languages).to.deep.equal([ 'en', 'es' ]) | |
126 | expect(data.instance.categories).to.deep.equal([ 1, 2 ]) | |
127 | ||
128 | expect(data.instance.defaultClientRoute).to.equal('/videos/recently-added') | |
129 | expect(data.instance.isNSFW).to.be.true | |
130 | expect(data.instance.defaultNSFWPolicy).to.equal('blur') | |
131 | expect(data.instance.customizations.javascript).to.equal('alert("coucou")') | |
132 | expect(data.instance.customizations.css).to.equal('body { background-color: red; }') | |
133 | ||
134 | expect(data.services.twitter.username).to.equal('@Kuja') | |
135 | expect(data.services.twitter.whitelisted).to.be.true | |
136 | ||
137 | expect(data.cache.previews.size).to.equal(2) | |
138 | expect(data.cache.captions.size).to.equal(3) | |
139 | expect(data.cache.torrents.size).to.equal(4) | |
140 | ||
141 | expect(data.signup.enabled).to.be.false | |
142 | expect(data.signup.limit).to.equal(5) | |
143 | expect(data.signup.requiresEmailVerification).to.be.false | |
144 | expect(data.signup.minimumAge).to.equal(10) | |
145 | ||
146 | // We override admin email in parallel tests, so skip this exception | |
147 | if (parallelTests() === false) { | |
148 | expect(data.admin.email).to.equal('superadmin1@example.com') | |
149 | } | |
150 | ||
151 | expect(data.contactForm.enabled).to.be.false | |
152 | ||
153 | expect(data.user.videoQuota).to.equal(5242881) | |
154 | expect(data.user.videoQuotaDaily).to.equal(318742) | |
155 | ||
156 | expect(data.transcoding.enabled).to.be.true | |
157 | expect(data.transcoding.threads).to.equal(1) | |
158 | expect(data.transcoding.concurrency).to.equal(3) | |
159 | expect(data.transcoding.allowAdditionalExtensions).to.be.true | |
160 | expect(data.transcoding.allowAudioFiles).to.be.true | |
161 | expect(data.transcoding.profile).to.equal('vod_profile') | |
162 | expect(data.transcoding.resolutions['240p']).to.be.false | |
163 | expect(data.transcoding.resolutions['360p']).to.be.true | |
164 | expect(data.transcoding.resolutions['480p']).to.be.true | |
165 | expect(data.transcoding.resolutions['720p']).to.be.false | |
166 | expect(data.transcoding.resolutions['1080p']).to.be.false | |
167 | expect(data.transcoding.resolutions['2160p']).to.be.false | |
168 | expect(data.transcoding.hls.enabled).to.be.false | |
169 | expect(data.transcoding.webtorrent.enabled).to.be.true | |
170 | ||
171 | expect(data.live.enabled).to.be.true | |
172 | expect(data.live.allowReplay).to.be.true | |
173 | expect(data.live.maxDuration).to.equal(5000) | |
174 | expect(data.live.maxInstanceLives).to.equal(-1) | |
175 | expect(data.live.maxUserLives).to.equal(10) | |
176 | expect(data.live.transcoding.enabled).to.be.true | |
177 | expect(data.live.transcoding.threads).to.equal(4) | |
178 | expect(data.live.transcoding.profile).to.equal('live_profile') | |
179 | expect(data.live.transcoding.resolutions['240p']).to.be.true | |
180 | expect(data.live.transcoding.resolutions['360p']).to.be.true | |
181 | expect(data.live.transcoding.resolutions['480p']).to.be.true | |
182 | expect(data.live.transcoding.resolutions['720p']).to.be.true | |
183 | expect(data.live.transcoding.resolutions['1080p']).to.be.true | |
184 | expect(data.live.transcoding.resolutions['2160p']).to.be.true | |
185 | ||
186 | expect(data.import.videos.concurrency).to.equal(4) | |
187 | expect(data.import.videos.http.enabled).to.be.false | |
188 | expect(data.import.videos.torrent.enabled).to.be.false | |
189 | expect(data.autoBlacklist.videos.ofUsers.enabled).to.be.true | |
190 | ||
191 | expect(data.followers.instance.enabled).to.be.false | |
192 | expect(data.followers.instance.manualApproval).to.be.true | |
193 | ||
194 | expect(data.followings.instance.autoFollowBack.enabled).to.be.true | |
195 | expect(data.followings.instance.autoFollowIndex.enabled).to.be.true | |
196 | expect(data.followings.instance.autoFollowIndex.indexUrl).to.equal('https://updated.example.com') | |
197 | ||
198 | expect(data.broadcastMessage.enabled).to.be.true | |
199 | expect(data.broadcastMessage.level).to.equal('error') | |
200 | expect(data.broadcastMessage.message).to.equal('super bad message') | |
201 | expect(data.broadcastMessage.dismissable).to.be.true | |
202 | } | |
203 | ||
204 | describe('Test config', function () { | |
205 | let server: PeerTubeServer = null | |
206 | ||
207 | before(async function () { | |
208 | this.timeout(30000) | |
209 | ||
210 | server = await createSingleServer(1) | |
211 | await setAccessTokensToServers([ server ]) | |
212 | }) | |
213 | ||
214 | it('Should have a correct config on a server with registration enabled', async function () { | |
215 | const data = await server.config.getConfig() | |
216 | ||
217 | expect(data.signup.allowed).to.be.true | |
218 | }) | |
219 | ||
220 | it('Should have a correct config on a server with registration enabled and a users limit', async function () { | |
221 | this.timeout(5000) | |
222 | ||
223 | await Promise.all([ | |
224 | server.users.register({ username: 'user1' }), | |
225 | server.users.register({ username: 'user2' }), | |
226 | server.users.register({ username: 'user3' }) | |
227 | ]) | |
228 | ||
229 | const data = await server.config.getConfig() | |
230 | ||
231 | expect(data.signup.allowed).to.be.false | |
232 | }) | |
233 | ||
234 | it('Should have the correct video allowed extensions', async function () { | |
235 | const data = await server.config.getConfig() | |
236 | ||
237 | expect(data.video.file.extensions).to.have.lengthOf(3) | |
238 | expect(data.video.file.extensions).to.contain('.mp4') | |
239 | expect(data.video.file.extensions).to.contain('.webm') | |
240 | expect(data.video.file.extensions).to.contain('.ogv') | |
241 | ||
242 | await server.videos.upload({ attributes: { fixture: 'video_short.mkv' }, expectedStatus: HttpStatusCode.UNSUPPORTED_MEDIA_TYPE_415 }) | |
243 | await server.videos.upload({ attributes: { fixture: 'sample.ogg' }, expectedStatus: HttpStatusCode.UNSUPPORTED_MEDIA_TYPE_415 }) | |
244 | ||
245 | expect(data.contactForm.enabled).to.be.true | |
246 | }) | |
247 | ||
248 | it('Should get the customized configuration', async function () { | |
249 | const data = await server.config.getCustomConfig() | |
250 | ||
251 | checkInitialConfig(server, data) | |
252 | }) | |
253 | ||
254 | it('Should update the customized configuration', async function () { | |
255 | const newCustomConfig: CustomConfig = { | |
256 | instance: { | |
257 | name: 'PeerTube updated', | |
258 | shortDescription: 'my short description', | |
259 | description: 'my super description', | |
260 | terms: 'my super terms', | |
261 | codeOfConduct: 'my super coc', | |
262 | ||
263 | creationReason: 'my super creation reason', | |
264 | moderationInformation: 'my super moderation information', | |
265 | administrator: 'Kuja', | |
266 | maintenanceLifetime: 'forever', | |
267 | businessModel: 'my super business model', | |
268 | hardwareInformation: '2vCore 3GB RAM', | |
269 | ||
270 | languages: [ 'en', 'es' ], | |
271 | categories: [ 1, 2 ], | |
272 | ||
273 | isNSFW: true, | |
274 | defaultNSFWPolicy: 'blur' as 'blur', | |
275 | ||
276 | defaultClientRoute: '/videos/recently-added', | |
277 | ||
278 | customizations: { | |
279 | javascript: 'alert("coucou")', | |
280 | css: 'body { background-color: red; }' | |
281 | } | |
282 | }, | |
283 | theme: { | |
284 | default: 'default' | |
285 | }, | |
286 | services: { | |
287 | twitter: { | |
288 | username: '@Kuja', | |
289 | whitelisted: true | |
290 | } | |
291 | }, | |
292 | cache: { | |
293 | previews: { | |
294 | size: 2 | |
295 | }, | |
296 | captions: { | |
297 | size: 3 | |
298 | }, | |
299 | torrents: { | |
300 | size: 4 | |
301 | } | |
302 | }, | |
303 | signup: { | |
304 | enabled: false, | |
305 | limit: 5, | |
306 | requiresEmailVerification: false, | |
307 | minimumAge: 10 | |
308 | }, | |
309 | admin: { | |
310 | email: 'superadmin1@example.com' | |
311 | }, | |
312 | contactForm: { | |
313 | enabled: false | |
314 | }, | |
315 | user: { | |
316 | videoQuota: 5242881, | |
317 | videoQuotaDaily: 318742 | |
318 | }, | |
319 | transcoding: { | |
320 | enabled: true, | |
321 | allowAdditionalExtensions: true, | |
322 | allowAudioFiles: true, | |
323 | threads: 1, | |
324 | concurrency: 3, | |
325 | profile: 'vod_profile', | |
326 | resolutions: { | |
327 | '0p': false, | |
328 | '240p': false, | |
329 | '360p': true, | |
330 | '480p': true, | |
331 | '720p': false, | |
332 | '1080p': false, | |
333 | '1440p': false, | |
334 | '2160p': false | |
335 | }, | |
336 | webtorrent: { | |
337 | enabled: true | |
338 | }, | |
339 | hls: { | |
340 | enabled: false | |
341 | } | |
342 | }, | |
343 | live: { | |
344 | enabled: true, | |
345 | allowReplay: true, | |
346 | maxDuration: 5000, | |
347 | maxInstanceLives: -1, | |
348 | maxUserLives: 10, | |
349 | transcoding: { | |
350 | enabled: true, | |
351 | threads: 4, | |
352 | profile: 'live_profile', | |
353 | resolutions: { | |
354 | '240p': true, | |
355 | '360p': true, | |
356 | '480p': true, | |
357 | '720p': true, | |
358 | '1080p': true, | |
359 | '1440p': true, | |
360 | '2160p': true | |
361 | } | |
362 | } | |
363 | }, | |
364 | import: { | |
365 | videos: { | |
366 | concurrency: 4, | |
367 | http: { | |
368 | enabled: false | |
369 | }, | |
370 | torrent: { | |
371 | enabled: false | |
372 | } | |
373 | } | |
374 | }, | |
375 | trending: { | |
376 | videos: { | |
377 | algorithms: { | |
378 | enabled: [ 'best', 'hot', 'most-viewed', 'most-liked' ], | |
379 | default: 'hot' | |
380 | } | |
381 | } | |
382 | }, | |
383 | autoBlacklist: { | |
384 | videos: { | |
385 | ofUsers: { | |
386 | enabled: true | |
387 | } | |
388 | } | |
389 | }, | |
390 | followers: { | |
391 | instance: { | |
392 | enabled: false, | |
393 | manualApproval: true | |
394 | } | |
395 | }, | |
396 | followings: { | |
397 | instance: { | |
398 | autoFollowBack: { | |
399 | enabled: true | |
400 | }, | |
401 | autoFollowIndex: { | |
402 | enabled: true, | |
403 | indexUrl: 'https://updated.example.com' | |
404 | } | |
405 | } | |
406 | }, | |
407 | broadcastMessage: { | |
408 | enabled: true, | |
409 | level: 'error', | |
410 | message: 'super bad message', | |
411 | dismissable: true | |
412 | }, | |
413 | search: { | |
414 | remoteUri: { | |
415 | anonymous: true, | |
416 | users: true | |
417 | }, | |
418 | searchIndex: { | |
419 | enabled: true, | |
420 | url: 'https://search.joinpeertube.org', | |
421 | disableLocalSearch: true, | |
422 | isDefaultSearch: true | |
423 | } | |
424 | } | |
425 | } | |
426 | await server.config.updateCustomConfig({ newCustomConfig }) | |
427 | ||
428 | const data = await server.config.getCustomConfig() | |
429 | checkUpdatedConfig(data) | |
430 | }) | |
431 | ||
432 | it('Should have the correct updated video allowed extensions', async function () { | |
433 | this.timeout(10000) | |
434 | ||
435 | const data = await server.config.getConfig() | |
436 | ||
437 | expect(data.video.file.extensions).to.have.length.above(4) | |
438 | expect(data.video.file.extensions).to.contain('.mp4') | |
439 | expect(data.video.file.extensions).to.contain('.webm') | |
440 | expect(data.video.file.extensions).to.contain('.ogv') | |
441 | expect(data.video.file.extensions).to.contain('.flv') | |
442 | expect(data.video.file.extensions).to.contain('.wmv') | |
443 | expect(data.video.file.extensions).to.contain('.mkv') | |
444 | expect(data.video.file.extensions).to.contain('.mp3') | |
445 | expect(data.video.file.extensions).to.contain('.ogg') | |
446 | expect(data.video.file.extensions).to.contain('.flac') | |
447 | ||
448 | await server.videos.upload({ attributes: { fixture: 'video_short.mkv' }, expectedStatus: HttpStatusCode.OK_200 }) | |
449 | await server.videos.upload({ attributes: { fixture: 'sample.ogg' }, expectedStatus: HttpStatusCode.OK_200 }) | |
450 | }) | |
451 | ||
452 | it('Should have the configuration updated after a restart', async function () { | |
453 | this.timeout(10000) | |
454 | ||
455 | await killallServers([ server ]) | |
456 | ||
457 | await server.run() | |
458 | ||
459 | const data = await server.config.getCustomConfig() | |
460 | ||
461 | checkUpdatedConfig(data) | |
462 | }) | |
463 | ||
464 | it('Should fetch the about information', async function () { | |
465 | const data = await server.config.getAbout() | |
466 | ||
467 | expect(data.instance.name).to.equal('PeerTube updated') | |
468 | expect(data.instance.shortDescription).to.equal('my short description') | |
469 | expect(data.instance.description).to.equal('my super description') | |
470 | expect(data.instance.terms).to.equal('my super terms') | |
471 | expect(data.instance.codeOfConduct).to.equal('my super coc') | |
472 | ||
473 | expect(data.instance.creationReason).to.equal('my super creation reason') | |
474 | expect(data.instance.moderationInformation).to.equal('my super moderation information') | |
475 | expect(data.instance.administrator).to.equal('Kuja') | |
476 | expect(data.instance.maintenanceLifetime).to.equal('forever') | |
477 | expect(data.instance.businessModel).to.equal('my super business model') | |
478 | expect(data.instance.hardwareInformation).to.equal('2vCore 3GB RAM') | |
479 | ||
480 | expect(data.instance.languages).to.deep.equal([ 'en', 'es' ]) | |
481 | expect(data.instance.categories).to.deep.equal([ 1, 2 ]) | |
482 | }) | |
483 | ||
484 | it('Should remove the custom configuration', async function () { | |
485 | this.timeout(10000) | |
486 | ||
487 | await server.config.deleteCustomConfig() | |
488 | ||
489 | const data = await server.config.getCustomConfig() | |
490 | checkInitialConfig(server, data) | |
491 | }) | |
492 | ||
493 | it('Should enable frameguard', async function () { | |
494 | this.timeout(25000) | |
495 | ||
496 | { | |
497 | const res = await makeGetRequest({ | |
498 | url: server.url, | |
499 | path: '/api/v1/config', | |
500 | expectedStatus: 200 | |
501 | }) | |
502 | ||
503 | expect(res.headers['x-frame-options']).to.exist | |
504 | } | |
505 | ||
506 | await killallServers([ server ]) | |
507 | ||
508 | const config = { | |
509 | security: { | |
510 | frameguard: { enabled: false } | |
511 | } | |
512 | } | |
513 | await server.run(config) | |
514 | ||
515 | { | |
516 | const res = await makeGetRequest({ | |
517 | url: server.url, | |
518 | path: '/api/v1/config', | |
519 | expectedStatus: 200 | |
520 | }) | |
521 | ||
522 | expect(res.headers['x-frame-options']).to.not.exist | |
523 | } | |
524 | }) | |
525 | ||
526 | after(async function () { | |
527 | await cleanupTests([ server ]) | |
528 | }) | |
529 | }) |