1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
4 import * as chai from 'chai'
12 setAccessTokensToServers
13 } from '@shared/extra-utils'
14 import { CustomConfig, HttpStatusCode } from '@shared/models'
16 const expect = chai.expect
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.'
23 expect(data.instance.description).to.equal('Welcome to this PeerTube instance!')
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
34 expect(data.instance.languages).to.have.lengthOf(0)
35 expect(data.instance.categories).to.have.lengthOf(0)
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
43 expect(data.services.twitter.username).to.equal('@Chocobozzz')
44 expect(data.services.twitter.whitelisted).to.be.false
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)
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
55 expect(data.admin.email).to.equal('admin' + server.internalServerNumber + '@example.com')
56 expect(data.contactForm.enabled).to.be.true
58 expect(data.user.videoQuota).to.equal(5242880)
59 expect(data.user.videoQuotaDaily).to.equal(-1)
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
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
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
98 expect(data.followers.instance.enabled).to.be.true
99 expect(data.followers.instance.manualApproval).to.be.false
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('')
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
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')
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')
125 expect(data.instance.languages).to.deep.equal([ 'en', 'es' ])
126 expect(data.instance.categories).to.deep.equal([ 1, 2 ])
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; }')
134 expect(data.services.twitter.username).to.equal('@Kuja')
135 expect(data.services.twitter.whitelisted).to.be.true
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)
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)
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')
151 expect(data.contactForm.enabled).to.be.false
153 expect(data.user.videoQuota).to.equal(5242881)
154 expect(data.user.videoQuotaDaily).to.equal(318742)
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
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
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
191 expect(data.followers.instance.enabled).to.be.false
192 expect(data.followers.instance.manualApproval).to.be.true
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')
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
204 const newCustomConfig: CustomConfig = {
206 name: 'PeerTube updated',
207 shortDescription: 'my short description',
208 description: 'my super description',
209 terms: 'my super terms',
210 codeOfConduct: 'my super coc',
212 creationReason: 'my super creation reason',
213 moderationInformation: 'my super moderation information',
214 administrator: 'Kuja',
215 maintenanceLifetime: 'forever',
216 businessModel: 'my super business model',
217 hardwareInformation: '2vCore 3GB RAM',
219 languages: [ 'en', 'es' ],
220 categories: [ 1, 2 ],
223 defaultNSFWPolicy: 'blur' as 'blur',
225 defaultClientRoute: '/videos/recently-added',
228 javascript: 'alert("coucou")',
229 css: 'body { background-color: red; }'
255 requiresEmailVerification: false,
259 email: 'superadmin1@example.com'
266 videoQuotaDaily: 318742
270 allowAdditionalExtensions: true,
271 allowAudioFiles: true,
274 profile: 'vod_profile',
296 maxInstanceLives: -1,
301 profile: 'live_profile',
327 enabled: [ 'best', 'hot', 'most-viewed', 'most-liked' ],
352 indexUrl: 'https://updated.example.com'
359 message: 'super bad message',
369 url: 'https://search.joinpeertube.org',
370 disableLocalSearch: true,
371 isDefaultSearch: true
376 describe('Test static config', function () {
377 let server: PeerTubeServer = null
379 before(async function () {
382 server = await createSingleServer(1, { webadmin: { configuration: { edition: { allowed: false } } } })
383 await setAccessTokensToServers([ server ])
386 it('Should tell the client that edits are not allowed', async function () {
387 const data = await server.config.getConfig()
389 expect(data.webadmin.configuration.edition.allowed).to.be.false
392 it('Should error when client tries to update', async function () {
393 await server.config.updateCustomConfig({ newCustomConfig, expectedStatus: 405 })
396 after(async function () {
397 await cleanupTests([ server ])
401 describe('Test config', function () {
402 let server: PeerTubeServer = null
404 before(async function () {
407 server = await createSingleServer(1)
408 await setAccessTokensToServers([ server ])
411 it('Should have a correct config on a server with registration enabled', async function () {
412 const data = await server.config.getConfig()
414 expect(data.signup.allowed).to.be.true
417 it('Should have a correct config on a server with registration enabled and a users limit', async function () {
421 server.users.register({ username: 'user1' }),
422 server.users.register({ username: 'user2' }),
423 server.users.register({ username: 'user3' })
426 const data = await server.config.getConfig()
428 expect(data.signup.allowed).to.be.false
431 it('Should have the correct video allowed extensions', async function () {
432 const data = await server.config.getConfig()
434 expect(data.video.file.extensions).to.have.lengthOf(3)
435 expect(data.video.file.extensions).to.contain('.mp4')
436 expect(data.video.file.extensions).to.contain('.webm')
437 expect(data.video.file.extensions).to.contain('.ogv')
439 await server.videos.upload({ attributes: { fixture: 'video_short.mkv' }, expectedStatus: HttpStatusCode.UNSUPPORTED_MEDIA_TYPE_415 })
440 await server.videos.upload({ attributes: { fixture: 'sample.ogg' }, expectedStatus: HttpStatusCode.UNSUPPORTED_MEDIA_TYPE_415 })
442 expect(data.contactForm.enabled).to.be.true
445 it('Should get the customized configuration', async function () {
446 const data = await server.config.getCustomConfig()
448 checkInitialConfig(server, data)
451 it('Should update the customized configuration', async function () {
452 await server.config.updateCustomConfig({ newCustomConfig })
454 const data = await server.config.getCustomConfig()
455 checkUpdatedConfig(data)
458 it('Should have the correct updated video allowed extensions', async function () {
461 const data = await server.config.getConfig()
463 expect(data.video.file.extensions).to.have.length.above(4)
464 expect(data.video.file.extensions).to.contain('.mp4')
465 expect(data.video.file.extensions).to.contain('.webm')
466 expect(data.video.file.extensions).to.contain('.ogv')
467 expect(data.video.file.extensions).to.contain('.flv')
468 expect(data.video.file.extensions).to.contain('.wmv')
469 expect(data.video.file.extensions).to.contain('.mkv')
470 expect(data.video.file.extensions).to.contain('.mp3')
471 expect(data.video.file.extensions).to.contain('.ogg')
472 expect(data.video.file.extensions).to.contain('.flac')
474 await server.videos.upload({ attributes: { fixture: 'video_short.mkv' }, expectedStatus: HttpStatusCode.OK_200 })
475 await server.videos.upload({ attributes: { fixture: 'sample.ogg' }, expectedStatus: HttpStatusCode.OK_200 })
478 it('Should have the configuration updated after a restart', async function () {
481 await killallServers([ server ])
485 const data = await server.config.getCustomConfig()
487 checkUpdatedConfig(data)
490 it('Should fetch the about information', async function () {
491 const data = await server.config.getAbout()
493 expect(data.instance.name).to.equal('PeerTube updated')
494 expect(data.instance.shortDescription).to.equal('my short description')
495 expect(data.instance.description).to.equal('my super description')
496 expect(data.instance.terms).to.equal('my super terms')
497 expect(data.instance.codeOfConduct).to.equal('my super coc')
499 expect(data.instance.creationReason).to.equal('my super creation reason')
500 expect(data.instance.moderationInformation).to.equal('my super moderation information')
501 expect(data.instance.administrator).to.equal('Kuja')
502 expect(data.instance.maintenanceLifetime).to.equal('forever')
503 expect(data.instance.businessModel).to.equal('my super business model')
504 expect(data.instance.hardwareInformation).to.equal('2vCore 3GB RAM')
506 expect(data.instance.languages).to.deep.equal([ 'en', 'es' ])
507 expect(data.instance.categories).to.deep.equal([ 1, 2 ])
510 it('Should remove the custom configuration', async function () {
513 await server.config.deleteCustomConfig()
515 const data = await server.config.getCustomConfig()
516 checkInitialConfig(server, data)
519 it('Should enable frameguard', async function () {
523 const res = await makeGetRequest({
525 path: '/api/v1/config',
529 expect(res.headers['x-frame-options']).to.exist
532 await killallServers([ server ])
536 frameguard: { enabled: false }
539 await server.run(config)
542 const res = await makeGetRequest({
544 path: '/api/v1/config',
548 expect(res.headers['x-frame-options']).to.not.exist
552 after(async function () {
553 await cleanupTests([ server ])